1 /* $OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $ */ 2 3 /* 4 * Copyright (c) 2014 genua mbh <info@genua.de> 5 * Copyright (c) 2014 Fixup Software Ltd. 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /*- 21 * Based on BSD-licensed source modules in the Linux iwlwifi driver, 22 * which were used as the reference documentation for this implementation. 23 * 24 * Driver version we are currently based off of is 25 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd) 26 * 27 *********************************************************************** 28 * 29 * This file is provided under a dual BSD/GPLv2 license. When using or 30 * redistributing this file, you may do so under either license. 31 * 32 * GPL LICENSE SUMMARY 33 * 34 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved. 35 * 36 * This program is free software; you can redistribute it and/or modify 37 * it under the terms of version 2 of the GNU General Public License as 38 * published by the Free Software Foundation. 39 * 40 * This program is distributed in the hope that it will be useful, but 41 * WITHOUT ANY WARRANTY; without even the implied warranty of 42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 43 * General Public License for more details. 44 * 45 * You should have received a copy of the GNU General Public License 46 * along with this program; if not, write to the Free Software 47 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 48 * USA 49 * 50 * The full GNU General Public License is included in this distribution 51 * in the file called COPYING. 52 * 53 * Contact Information: 54 * Intel Linux Wireless <ilw@linux.intel.com> 55 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 56 * 57 * 58 * BSD LICENSE 59 * 60 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved. 61 * All rights reserved. 62 * 63 * Redistribution and use in source and binary forms, with or without 64 * modification, are permitted provided that the following conditions 65 * are met: 66 * 67 * * Redistributions of source code must retain the above copyright 68 * notice, this list of conditions and the following disclaimer. 69 * * Redistributions in binary form must reproduce the above copyright 70 * notice, this list of conditions and the following disclaimer in 71 * the documentation and/or other materials provided with the 72 * distribution. 73 * * Neither the name Intel Corporation nor the names of its 74 * contributors may be used to endorse or promote products derived 75 * from this software without specific prior written permission. 76 * 77 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 78 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 79 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 80 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 81 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 82 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 83 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 84 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 85 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 86 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 87 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 88 */ 89 90 /*- 91 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr> 92 * 93 * Permission to use, copy, modify, and distribute this software for any 94 * purpose with or without fee is hereby granted, provided that the above 95 * copyright notice and this permission notice appear in all copies. 96 * 97 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 98 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 99 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 100 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 101 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 102 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 103 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 104 */ 105 #include <sys/cdefs.h> 106 __FBSDID("$FreeBSD$"); 107 108 #include <sys/param.h> 109 #include <sys/bus.h> 110 #include <sys/endian.h> 111 #include <sys/firmware.h> 112 #include <sys/kernel.h> 113 #include <sys/malloc.h> 114 #include <sys/mbuf.h> 115 #include <sys/rman.h> 116 #include <sys/sysctl.h> 117 #include <sys/linker.h> 118 119 #include <machine/endian.h> 120 121 #include <bus/pci/pcivar.h> 122 #include <bus/pci/pcireg.h> 123 124 #include <net/bpf.h> 125 126 #include <net/if.h> 127 #include <net/if_var.h> 128 #include <net/if_arp.h> 129 #include <net/if_dl.h> 130 #include <net/if_media.h> 131 #include <net/if_types.h> 132 133 #include <netinet/in.h> 134 #include <netinet/in_systm.h> 135 #include <netinet/if_ether.h> 136 #include <netinet/ip.h> 137 138 #include <netproto/802_11/ieee80211_var.h> 139 #include <netproto/802_11/ieee80211_regdomain.h> 140 #include <netproto/802_11/ieee80211_ratectl.h> 141 #include <netproto/802_11/ieee80211_radiotap.h> 142 143 #include "if_iwmreg.h" 144 #include "if_iwmvar.h" 145 #include "if_iwm_debug.h" 146 #include "if_iwm_util.h" 147 #include "if_iwm_notif_wait.h" 148 #include "if_iwm_pcie_trans.h" 149 #include "if_iwm_time_event.h" 150 151 #define TU_TO_HZ(tu) (((uint64_t)(tu) * 1024 * hz) / 1000000) 152 153 static void 154 iwm_mvm_te_clear_data(struct iwm_softc *sc) 155 { 156 sc->sc_time_event_uid = 0; 157 sc->sc_time_event_duration = 0; 158 sc->sc_time_event_end_ticks = 0; 159 sc->sc_flags &= ~IWM_FLAG_TE_ACTIVE; 160 } 161 162 /* 163 * Handles a FW notification for an event that is known to the driver. 164 * 165 * @mvm: the mvm component 166 * @te_data: the time event data 167 * @notif: the notification data corresponding the time event data. 168 */ 169 static void 170 iwm_mvm_te_handle_notif(struct iwm_softc *sc, 171 struct iwm_time_event_notif *notif) 172 { 173 IWM_DPRINTF(sc, IWM_DEBUG_TE, 174 "Handle time event notif - UID = 0x%x action %d\n", 175 le32toh(notif->unique_id), 176 le32toh(notif->action)); 177 178 if (!le32toh(notif->status)) { 179 const char *msg; 180 181 if (notif->action & htole32(IWM_TE_V2_NOTIF_HOST_EVENT_START)) 182 msg = "Time Event start notification failure"; 183 else 184 msg = "Time Event end notification failure"; 185 186 IWM_DPRINTF(sc, IWM_DEBUG_TE, "%s\n", msg); 187 } 188 189 if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_END) { 190 IWM_DPRINTF(sc, IWM_DEBUG_TE, 191 "TE ended - current time %d, estimated end %d\n", 192 ticks, sc->sc_time_event_end_ticks); 193 194 iwm_mvm_te_clear_data(sc); 195 } else if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_START) { 196 sc->sc_time_event_end_ticks = 197 ticks + TU_TO_HZ(sc->sc_time_event_duration); 198 } else { 199 device_printf(sc->sc_dev, "Got TE with unknown action\n"); 200 } 201 } 202 203 /* 204 * The Rx handler for time event notifications 205 */ 206 void 207 iwm_mvm_rx_time_event_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt) 208 { 209 struct iwm_time_event_notif *notif = (void *)pkt->data; 210 211 IWM_DPRINTF(sc, IWM_DEBUG_TE, 212 "Time event notification - UID = 0x%x action %d\n", 213 le32toh(notif->unique_id), 214 le32toh(notif->action)); 215 216 iwm_mvm_te_handle_notif(sc, notif); 217 } 218 219 static int 220 iwm_mvm_te_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt, 221 void *data) 222 { 223 struct iwm_time_event_notif *resp; 224 int resp_len = iwm_rx_packet_payload_len(pkt); 225 226 if (pkt->hdr.code != IWM_TIME_EVENT_NOTIFICATION || 227 resp_len != sizeof(*resp)) { 228 IWM_DPRINTF(sc, IWM_DEBUG_TE, 229 "Invalid TIME_EVENT_NOTIFICATION response\n"); 230 return 1; 231 } 232 233 resp = (void *)pkt->data; 234 235 /* te_data->uid is already set in the TIME_EVENT_CMD response */ 236 if (le32toh(resp->unique_id) != sc->sc_time_event_uid) 237 return false; 238 239 IWM_DPRINTF(sc, IWM_DEBUG_TE, 240 "TIME_EVENT_NOTIFICATION response - UID = 0x%x\n", 241 sc->sc_time_event_uid); 242 if (!resp->status) { 243 IWM_DPRINTF(sc, IWM_DEBUG_TE, 244 "TIME_EVENT_NOTIFICATION received but not executed\n"); 245 } 246 247 return 1; 248 } 249 250 static int 251 iwm_mvm_time_event_response(struct iwm_softc *sc, struct iwm_rx_packet *pkt, 252 void *data) 253 { 254 struct iwm_time_event_resp *resp; 255 int resp_len = iwm_rx_packet_payload_len(pkt); 256 257 if (pkt->hdr.code != IWM_TIME_EVENT_CMD || 258 resp_len != sizeof(*resp)) { 259 IWM_DPRINTF(sc, IWM_DEBUG_TE, 260 "Invalid TIME_EVENT_CMD response\n"); 261 return 1; 262 } 263 264 resp = (void *)pkt->data; 265 266 /* we should never get a response to another TIME_EVENT_CMD here */ 267 if (le32toh(resp->id) != IWM_TE_BSS_STA_AGGRESSIVE_ASSOC) { 268 IWM_DPRINTF(sc, IWM_DEBUG_TE, 269 "Got TIME_EVENT_CMD response with wrong id: %d\n", 270 le32toh(resp->id)); 271 return 0; 272 } 273 274 sc->sc_time_event_uid = le32toh(resp->unique_id); 275 IWM_DPRINTF(sc, IWM_DEBUG_TE, 276 "TIME_EVENT_CMD response - UID = 0x%x\n", sc->sc_time_event_uid); 277 return 1; 278 } 279 280 281 /* XXX Use the te_data function argument properly, like in iwlwifi's code. */ 282 283 static int 284 iwm_mvm_time_event_send_add(struct iwm_softc *sc, struct iwm_vap *ivp, 285 void *te_data, struct iwm_time_event_cmd *te_cmd) 286 { 287 static const uint16_t time_event_response[] = { IWM_TIME_EVENT_CMD }; 288 struct iwm_notification_wait wait_time_event; 289 int ret; 290 291 IWM_DPRINTF(sc, IWM_DEBUG_TE, 292 "Add new TE, duration %d TU\n", le32toh(te_cmd->duration)); 293 294 sc->sc_time_event_duration = le32toh(te_cmd->duration); 295 296 /* 297 * Use a notification wait, which really just processes the 298 * command response and doesn't wait for anything, in order 299 * to be able to process the response and get the UID inside 300 * the RX path. Using CMD_WANT_SKB doesn't work because it 301 * stores the buffer and then wakes up this thread, by which 302 * time another notification (that the time event started) 303 * might already be processed unsuccessfully. 304 */ 305 iwm_init_notification_wait(sc->sc_notif_wait, &wait_time_event, 306 time_event_response, 307 NELEM(time_event_response), 308 iwm_mvm_time_event_response, /*te_data*/NULL); 309 310 ret = iwm_mvm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(*te_cmd), 311 te_cmd); 312 if (ret) { 313 IWM_DPRINTF(sc, IWM_DEBUG_TE, 314 "%s: Couldn't send IWM_TIME_EVENT_CMD: %d\n", 315 __func__, ret); 316 iwm_remove_notification(sc->sc_notif_wait, &wait_time_event); 317 return ret; 318 } 319 320 /* No need to wait for anything, so just pass 1 (0 isn't valid) */ 321 IWM_UNLOCK(sc); 322 ret = iwm_wait_notification(sc->sc_notif_wait, &wait_time_event, 1); 323 IWM_LOCK(sc); 324 /* should never fail */ 325 if (ret) { 326 IWM_DPRINTF(sc, IWM_DEBUG_TE, 327 "%s: Failed to get response for IWM_TIME_EVENT_CMD: %d\n", 328 __func__, ret); 329 } 330 331 return ret; 332 } 333 334 void 335 iwm_mvm_protect_session(struct iwm_softc *sc, struct iwm_vap *ivp, 336 uint32_t duration, uint32_t max_delay, boolean_t wait_for_notif) 337 { 338 const uint16_t te_notif_response[] = { IWM_TIME_EVENT_NOTIFICATION }; 339 struct iwm_notification_wait wait_te_notif; 340 struct iwm_time_event_cmd time_cmd = {}; 341 342 /* Do nothing if a time event is already scheduled. */ 343 if (sc->sc_flags & IWM_FLAG_TE_ACTIVE) 344 return; 345 346 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_ADD); 347 time_cmd.id_and_color = 348 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)); 349 time_cmd.id = htole32(IWM_TE_BSS_STA_AGGRESSIVE_ASSOC); 350 351 time_cmd.apply_time = htole32(0); 352 353 time_cmd.max_frags = IWM_TE_V2_FRAG_NONE; 354 time_cmd.max_delay = htole32(max_delay); 355 /* TODO: why do we need to interval = bi if it is not periodic? */ 356 time_cmd.interval = htole32(1); 357 time_cmd.duration = htole32(duration); 358 time_cmd.repeat = 1; 359 time_cmd.policy = htole16(IWM_TE_V2_NOTIF_HOST_EVENT_START | 360 IWM_TE_V2_NOTIF_HOST_EVENT_END | 361 IWM_T2_V2_START_IMMEDIATELY); 362 363 if (!wait_for_notif) { 364 iwm_mvm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd); 365 DELAY(100); 366 sc->sc_flags |= IWM_FLAG_TE_ACTIVE; 367 return; 368 } 369 370 /* 371 * Create notification_wait for the TIME_EVENT_NOTIFICATION to use 372 * right after we send the time event 373 */ 374 iwm_init_notification_wait(sc->sc_notif_wait, &wait_te_notif, 375 te_notif_response, NELEM(te_notif_response), 376 iwm_mvm_te_notif, /*te_data*/NULL); 377 378 /* If TE was sent OK - wait for the notification that started */ 379 if (iwm_mvm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd)) { 380 IWM_DPRINTF(sc, IWM_DEBUG_TE, 381 "%s: Failed to add TE to protect session\n", __func__); 382 iwm_remove_notification(sc->sc_notif_wait, &wait_te_notif); 383 } else { 384 sc->sc_flags |= IWM_FLAG_TE_ACTIVE; 385 IWM_UNLOCK(sc); 386 if (iwm_wait_notification(sc->sc_notif_wait, &wait_te_notif, 387 TU_TO_HZ(max_delay))) { 388 IWM_DPRINTF(sc, IWM_DEBUG_TE, 389 "%s: Failed to protect session until TE\n", 390 __func__); 391 } 392 IWM_LOCK(sc); 393 } 394 } 395 396 void 397 iwm_mvm_stop_session_protection(struct iwm_softc *sc, struct iwm_vap *ivp) 398 { 399 struct iwm_time_event_cmd time_cmd = {}; 400 401 /* Do nothing if the time event has already ended. */ 402 if ((sc->sc_flags & IWM_FLAG_TE_ACTIVE) == 0) 403 return; 404 405 time_cmd.id = htole32(sc->sc_time_event_uid); 406 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_REMOVE); 407 time_cmd.id_and_color = 408 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)); 409 410 IWM_DPRINTF(sc, IWM_DEBUG_TE, 411 "%s: Removing TE 0x%x\n", __func__, le32toh(time_cmd.id)); 412 if (iwm_mvm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(time_cmd), 413 &time_cmd) == 0) 414 iwm_mvm_te_clear_data(sc); 415 416 DELAY(100); 417 } 418