drivers/net/wireless/iwlwifi/iwl-notif-wait.c

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #include <linux/sched.h>
  64 #include <linux/export.h>
  65
  66 #include "iwl-notif-wait.h"
  67
  68
  69 void iwl_notification_wait_init(struct iwl_notif_wait_data *notif_wait)
  70 {
  71         spin_lock_init(&notif_wait->notif_wait_lock);
  72         INIT_LIST_HEAD(&notif_wait->notif_waits);
  73         init_waitqueue_head(&notif_wait->notif_waitq);
  74 }
  75 EXPORT_SYMBOL_GPL(iwl_notification_wait_init);
  76
  77 void iwl_notification_wait_notify(struct iwl_notif_wait_data *notif_wait,
  78                                   struct iwl_rx_packet *pkt)
  79 {
  80         bool triggered = false;
  81
  82         if (!list_empty(&notif_wait->notif_waits)) {
  83                 struct iwl_notification_wait *w;
  84
  85                 spin_lock(&notif_wait->notif_wait_lock);
  86                 list_for_each_entry(w, &notif_wait->notif_waits, list) {
  87                         int i;
  88                         bool found = false;
  89
  90                         /*
  91                          * If it already finished (triggered) or has been
  92                          * aborted then don't evaluate it again to avoid races,
  93                          * Otherwise the function could be called again even
  94                          * though it returned true before
  95                          */
  96                         if (w->triggered || w->aborted)
  97                                 continue;
  98
  99                         for (i = 0; i < w->n_cmds; i++) {
 100                                 if (w->cmds[i] == pkt->hdr.cmd) {
 101                                         found = true;
 102                                         break;
 103                                 }
 104                         }
 105                         if (!found)
 106                                 continue;
 107
 108                         if (!w->fn || w->fn(notif_wait, pkt, w->fn_data)) {
 109                                 w->triggered = true;
 110                                 triggered = true;
 111                         }
 112                 }
 113                 spin_unlock(&notif_wait->notif_wait_lock);
 114
 115         }
 116
 117         if (triggered)
 118                 wake_up_all(&notif_wait->notif_waitq);
 119 }
 120 EXPORT_SYMBOL_GPL(iwl_notification_wait_notify);
 121
 122 void iwl_abort_notification_waits(struct iwl_notif_wait_data *notif_wait)
 123 {
 124         struct iwl_notification_wait *wait_entry;
 125
 126         spin_lock(&notif_wait->notif_wait_lock);
 127         list_for_each_entry(wait_entry, &notif_wait->notif_waits, list)
 128                 wait_entry->aborted = true;
 129         spin_unlock(&notif_wait->notif_wait_lock);
 130
 131         wake_up_all(&notif_wait->notif_waitq);
 132 }
 133 EXPORT_SYMBOL_GPL(iwl_abort_notification_waits);
 134
 135 void
 136 iwl_init_notification_wait(struct iwl_notif_wait_data *notif_wait,
 137                            struct iwl_notification_wait *wait_entry,
 138                            const u8 *cmds, int n_cmds,
 139                            bool (*fn)(struct iwl_notif_wait_data *notif_wait,
 140                                       struct iwl_rx_packet *pkt, void *data),
 141                            void *fn_data)
 142 {
 143         if (WARN_ON(n_cmds > MAX_NOTIF_CMDS))
 144                 n_cmds = MAX_NOTIF_CMDS;
 145
 146         wait_entry->fn = fn;
 147         wait_entry->fn_data = fn_data;
 148         wait_entry->n_cmds = n_cmds;
 149         memcpy(wait_entry->cmds, cmds, n_cmds);
 150         wait_entry->triggered = false;
 151         wait_entry->aborted = false;
 152
 153         spin_lock_bh(&notif_wait->notif_wait_lock);
 154         list_add(&wait_entry->list, &notif_wait->notif_waits);
 155         spin_unlock_bh(&notif_wait->notif_wait_lock);
 156 }
 157 EXPORT_SYMBOL_GPL(iwl_init_notification_wait);
 158
 159 int iwl_wait_notification(struct iwl_notif_wait_data *notif_wait,
 160                           struct iwl_notification_wait *wait_entry,
 161                           unsigned long timeout)
 162 {
 163         int ret;
 164
 165         ret = wait_event_timeout(notif_wait->notif_waitq,
 166                                  wait_entry->triggered || wait_entry->aborted,
 167                                  timeout);
 168
 169         spin_lock_bh(&notif_wait->notif_wait_lock);
 170         list_del(&wait_entry->list);
 171         spin_unlock_bh(&notif_wait->notif_wait_lock);
 172
 173         if (wait_entry->aborted)
 174                 return -EIO;
 175
 176         /* return value is always >= 0 */
 177         if (ret <= 0)
 178                 return -ETIMEDOUT;
 179         return 0;
 180 }
 181 EXPORT_SYMBOL_GPL(iwl_wait_notification);
 182
 183 void iwl_remove_notification(struct iwl_notif_wait_data *notif_wait,
 184                              struct iwl_notification_wait *wait_entry)
 185 {
 186         spin_lock_bh(&notif_wait->notif_wait_lock);
 187         list_del(&wait_entry->list);
 188         spin_unlock_bh(&notif_wait->notif_wait_lock);
 189 }
 190 EXPORT_SYMBOL_GPL(iwl_remove_notification);