1 /*- 2 * Based on BSD-licensed source modules in the Linux iwlwifi driver, 3 * which were used as the reference documentation for this implementation. 4 * 5 ****************************************************************************** 6 * 7 * This file is provided under a dual BSD/GPLv2 license. When using or 8 * redistributing this file, you may do so under either license. 9 * 10 * GPL LICENSE SUMMARY 11 * 12 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved. 13 * Copyright(c) 2015 Intel Deutschland GmbH 14 * 15 * This program is free software; you can redistribute it and/or modify 16 * it under the terms of version 2 of the GNU General Public License as 17 * published by the Free Software Foundation. 18 * 19 * This program is distributed in the hope that it will be useful, but 20 * WITHOUT ANY WARRANTY; without even the implied warranty of 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 22 * General Public License for more details. 23 * 24 * You should have received a copy of the GNU General Public License 25 * along with this program; if not, write to the Free Software 26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 27 * USA 28 * 29 * The full GNU General Public License is included in this distribution 30 * in the file called COPYING. 31 * 32 * Contact Information: 33 * Intel Linux Wireless <linuxwifi@intel.com> 34 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 35 * 36 * BSD LICENSE 37 * 38 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved. 39 * All rights reserved. 40 * 41 * Redistribution and use in source and binary forms, with or without 42 * modification, are permitted provided that the following conditions 43 * are met: 44 * 45 * * Redistributions of source code must retain the above copyright 46 * notice, this list of conditions and the following disclaimer. 47 * * Redistributions in binary form must reproduce the above copyright 48 * notice, this list of conditions and the following disclaimer in 49 * the documentation and/or other materials provided with the 50 * distribution. 51 * * Neither the name Intel Corporation nor the names of its 52 * contributors may be used to endorse or promote products derived 53 * from this software without specific prior written permission. 54 * 55 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 56 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 57 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 58 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 59 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 60 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 61 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 62 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 63 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 64 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 65 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 66 * 67 *****************************************************************************/ 68 69 #include <sys/cdefs.h> 70 __FBSDID("$FreeBSD$"); 71 72 #include "opt_wlan.h" 73 #include "opt_iwm.h" 74 75 #include <sys/param.h> 76 #include <sys/systm.h> 77 #include <sys/bus.h> 78 #include <sys/kernel.h> 79 #include <sys/lock.h> 80 #include <sys/malloc.h> 81 #include <sys/mutex.h> 82 #include <sys/queue.h> 83 84 #include <dev/iwm/if_iwm_notif_wait.h> 85 86 #define IWM_WAIT_LOCK_INIT(_n, _s) \ 87 mtx_init(&(_n)->lk_mtx, (_s), "iwm wait_notif", MTX_DEF); 88 #define IWM_WAIT_LOCK(_n) mtx_lock(&(_n)->lk_mtx) 89 #define IWM_WAIT_UNLOCK(_n) mtx_unlock(&(_n)->lk_mtx) 90 #define IWM_WAIT_LOCK_DESTROY(_n) mtx_destroy(&(_n)->lk_mtx) 91 92 struct iwm_notif_wait_data { 93 struct mtx lk_mtx; 94 char lk_buf[32]; 95 STAILQ_HEAD(, iwm_notification_wait) list; 96 struct iwm_softc *sc; 97 }; 98 99 struct iwm_notif_wait_data * 100 iwm_notification_wait_init(struct iwm_softc *sc) 101 { 102 struct iwm_notif_wait_data *data; 103 104 data = malloc(sizeof(*data), M_DEVBUF, M_NOWAIT | M_ZERO); 105 if (data != NULL) { 106 snprintf(data->lk_buf, 32, "iwm wait_notif"); 107 IWM_WAIT_LOCK_INIT(data, data->lk_buf); 108 STAILQ_INIT(&data->list); 109 data->sc = sc; 110 } 111 112 return data; 113 } 114 115 void 116 iwm_notification_wait_free(struct iwm_notif_wait_data *notif_data) 117 { 118 KASSERT(STAILQ_EMPTY(¬if_data->list), ("notif list isn't empty")); 119 IWM_WAIT_LOCK_DESTROY(notif_data); 120 free(notif_data, M_DEVBUF); 121 } 122 123 /* XXX Get rid of separate cmd argument, like in iwlwifi's code */ 124 void 125 iwm_notification_wait_notify(struct iwm_notif_wait_data *notif_data, 126 uint16_t cmd, struct iwm_rx_packet *pkt) 127 { 128 struct iwm_notification_wait *wait_entry; 129 130 IWM_WAIT_LOCK(notif_data); 131 STAILQ_FOREACH(wait_entry, ¬if_data->list, entry) { 132 int found = FALSE; 133 int i; 134 135 /* 136 * If it already finished (triggered) or has been 137 * aborted then don't evaluate it again to avoid races, 138 * Otherwise the function could be called again even 139 * though it returned true before 140 */ 141 if (wait_entry->triggered || wait_entry->aborted) 142 continue; 143 144 for (i = 0; i < wait_entry->n_cmds; i++) { 145 if (cmd == wait_entry->cmds[i]) { 146 found = TRUE; 147 break; 148 } 149 } 150 if (!found) 151 continue; 152 153 if (!wait_entry->fn || 154 wait_entry->fn(notif_data->sc, pkt, wait_entry->fn_data)) { 155 wait_entry->triggered = 1; 156 wakeup(wait_entry); 157 } 158 } 159 IWM_WAIT_UNLOCK(notif_data); 160 } 161 162 void 163 iwm_abort_notification_waits(struct iwm_notif_wait_data *notif_data) 164 { 165 struct iwm_notification_wait *wait_entry; 166 167 IWM_WAIT_LOCK(notif_data); 168 STAILQ_FOREACH(wait_entry, ¬if_data->list, entry) { 169 wait_entry->aborted = 1; 170 wakeup(wait_entry); 171 } 172 IWM_WAIT_UNLOCK(notif_data); 173 } 174 175 void 176 iwm_init_notification_wait(struct iwm_notif_wait_data *notif_data, 177 struct iwm_notification_wait *wait_entry, const uint16_t *cmds, int n_cmds, 178 int (*fn)(struct iwm_softc *sc, struct iwm_rx_packet *pkt, void *data), 179 void *fn_data) 180 { 181 KASSERT(n_cmds <= IWM_MAX_NOTIF_CMDS, 182 ("n_cmds %d is too large", n_cmds)); 183 wait_entry->fn = fn; 184 wait_entry->fn_data = fn_data; 185 wait_entry->n_cmds = n_cmds; 186 memcpy(wait_entry->cmds, cmds, n_cmds * sizeof(uint16_t)); 187 wait_entry->triggered = 0; 188 wait_entry->aborted = 0; 189 190 IWM_WAIT_LOCK(notif_data); 191 STAILQ_INSERT_TAIL(¬if_data->list, wait_entry, entry); 192 IWM_WAIT_UNLOCK(notif_data); 193 } 194 195 int 196 iwm_wait_notification(struct iwm_notif_wait_data *notif_data, 197 struct iwm_notification_wait *wait_entry, int timeout) 198 { 199 int ret = 0; 200 201 IWM_WAIT_LOCK(notif_data); 202 if (!wait_entry->triggered && !wait_entry->aborted) { 203 ret = msleep(wait_entry, ¬if_data->lk_mtx, 0, "iwm_notif", 204 timeout); 205 } 206 STAILQ_REMOVE(¬if_data->list, wait_entry, iwm_notification_wait, 207 entry); 208 IWM_WAIT_UNLOCK(notif_data); 209 210 return ret; 211 } 212 213 void 214 iwm_remove_notification(struct iwm_notif_wait_data *notif_data, 215 struct iwm_notification_wait *wait_entry) 216 { 217 IWM_WAIT_LOCK(notif_data); 218 STAILQ_REMOVE(¬if_data->list, wait_entry, iwm_notification_wait, 219 entry); 220 IWM_WAIT_UNLOCK(notif_data); 221 } 222