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 - 2014 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 COPYING.
  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 - 2014 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-drv.h"
  67 #include "iwl-notif-wait.h"
  68
  69
  70 void iwl_notification_wait_init(struct iwl_notif_wait_data *notif_wait)
  71 {
  72         spin_lock_init(&notif_wait->notif_wait_lock);
  73         INIT_LIST_HEAD(&notif_wait->notif_waits);
  74         init_waitqueue_head(&notif_wait->notif_waitq);
  75 }
  76 IWL_EXPORT_SYMBOL(iwl_notification_wait_init);
  77
  78 void iwl_notification_wait_notify(struct iwl_notif_wait_data *notif_wait,
  79                                   struct iwl_rx_packet *pkt)
  80 {
  81         bool triggered = false;
  82
  83         if (!list_empty(&notif_wait->notif_waits)) {
  84                 struct iwl_notification_wait *w;
  85
  86                 spin_lock(&notif_wait->notif_wait_lock);
  87                 list_for_each_entry(w, &notif_wait->notif_waits, list) {
  88                         int i;
  89                         bool found = false;
  90
  91                         /*
  92                          * If it already finished (triggered) or has been
  93                          * aborted then don't evaluate it again to avoid races,
  94                          * Otherwise the function could be called again even
  95                          * though it returned true before
  96                          */
  97                         if (w->triggered || w->aborted)
  98                                 continue;
  99
 100                         for (i = 0; i < w->n_cmds; i++) {
 101                                 if (w->cmds[i] == pkt->hdr.cmd) {
 102                                         found = true;
 103                                         break;
 104                                 }
 105                         }
 106                         if (!found)
 107                                 continue;
 108
 109                         if (!w->fn || w->fn(notif_wait, pkt, w->fn_data)) {
 110                                 w->triggered = true;
 111                                 triggered = true;
 112                         }
 113                 }
 114                 spin_unlock(&notif_wait->notif_wait_lock);
 115
 116         }
 117
 118         if (triggered)
 119                 wake_up_all(&notif_wait->notif_waitq);
 120 }
 121 IWL_EXPORT_SYMBOL(iwl_notification_wait_notify);
 122
 123 void iwl_abort_notification_waits(struct iwl_notif_wait_data *notif_wait)
 124 {
 125         struct iwl_notification_wait *wait_entry;
 126
 127         spin_lock(&notif_wait->notif_wait_lock);
 128         list_for_each_entry(wait_entry, &notif_wait->notif_waits, list)
 129                 wait_entry->aborted = true;
 130         spin_unlock(&notif_wait->notif_wait_lock);
 131
 132         wake_up_all(&notif_wait->notif_waitq);
 133 }
 134 IWL_EXPORT_SYMBOL(iwl_abort_notification_waits);
 135
 136 void
 137 iwl_init_notification_wait(struct iwl_notif_wait_data *notif_wait,
 138                            struct iwl_notification_wait *wait_entry,
 139                            const u8 *cmds, int n_cmds,
 140                            bool (*fn)(struct iwl_notif_wait_data *notif_wait,
 141                                       struct iwl_rx_packet *pkt, void *data),
 142                            void *fn_data)
 143 {
 144         if (WARN_ON(n_cmds > MAX_NOTIF_CMDS))
 145                 n_cmds = MAX_NOTIF_CMDS;
 146
 147         wait_entry->fn = fn;
 148         wait_entry->fn_data = fn_data;
 149         wait_entry->n_cmds = n_cmds;
 150         memcpy(wait_entry->cmds, cmds, n_cmds);
 151         wait_entry->triggered = false;
 152         wait_entry->aborted = false;
 153
 154         spin_lock_bh(&notif_wait->notif_wait_lock);
 155         list_add(&wait_entry->list, &notif_wait->notif_waits);
 156         spin_unlock_bh(&notif_wait->notif_wait_lock);
 157 }
 158 IWL_EXPORT_SYMBOL(iwl_init_notification_wait);
 159
 160 int iwl_wait_notification(struct iwl_notif_wait_data *notif_wait,
 161                           struct iwl_notification_wait *wait_entry,
 162                           unsigned long timeout)
 163 {
 164         int ret;
 165
 166         ret = wait_event_timeout(notif_wait->notif_waitq,
 167                                  wait_entry->triggered || wait_entry->aborted,
 168                                  timeout);
 169
 170         spin_lock_bh(&notif_wait->notif_wait_lock);
 171         list_del(&wait_entry->list);
 172         spin_unlock_bh(&notif_wait->notif_wait_lock);
 173
 174         if (wait_entry->aborted)
 175                 return -EIO;
 176
 177         /* return value is always >= 0 */
 178         if (ret <= 0)
 179                 return -ETIMEDOUT;
 180         return 0;
 181 }
 182 IWL_EXPORT_SYMBOL(iwl_wait_notification);
 183
 184 void iwl_remove_notification(struct iwl_notif_wait_data *notif_wait,
 185                              struct iwl_notification_wait *wait_entry)
 186 {
 187         spin_lock_bh(&notif_wait->notif_wait_lock);
 188         list_del(&wait_entry->list);
 189         spin_unlock_bh(&notif_wait->notif_wait_lock);
 190 }
 191 IWL_EXPORT_SYMBOL(iwl_remove_notification);