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#include "opt_wlan.h" 107#include "opt_iwm.h" 108 109#include <sys/param.h> 110#include <sys/bus.h> 111#include <sys/conf.h> 112#include <sys/endian.h> 113#include <sys/firmware.h> 114#include <sys/kernel.h> 115#include <sys/malloc.h> 116#include <sys/mbuf.h> 117#include <sys/mutex.h> 118#include <sys/module.h> 119#include <sys/proc.h> 120#include <sys/rman.h> 121#include <sys/socket.h> 122#include <sys/sockio.h> 123#include <sys/sysctl.h> 124#include <sys/linker.h> 125 126#include <machine/bus.h> 127#include <machine/endian.h> 128#include <machine/resource.h> 129 130#include <dev/pci/pcivar.h> 131#include <dev/pci/pcireg.h> 132 133#include <net/bpf.h> 134 135#include <net/if.h> 136#include <net/if_var.h> 137#include <net/if_arp.h> 138#include <net/if_dl.h> 139#include <net/if_media.h> 140#include <net/if_types.h> 141 142#include <netinet/in.h> 143#include <netinet/in_systm.h> 144#include <netinet/if_ether.h> 145#include <netinet/ip.h> 146 147#include <net80211/ieee80211_var.h> 148#include <net80211/ieee80211_regdomain.h> 149#include <net80211/ieee80211_ratectl.h> 150#include <net80211/ieee80211_radiotap.h> 151 152#include <dev/iwm/if_iwmreg.h> 153#include <dev/iwm/if_iwmvar.h> 154#include <dev/iwm/if_iwm_debug.h> 155#include <dev/iwm/if_iwm_util.h> 156#include <dev/iwm/if_iwm_notif_wait.h> 157#include <dev/iwm/if_iwm_pcie_trans.h> 158#include <dev/iwm/if_iwm_time_event.h> 159 160#define TU_TO_HZ(tu) (((uint64_t)(tu) * 1024 * hz) / 1000000) 161 162static void 163iwm_te_clear_data(struct iwm_softc *sc) 164{ 165 sc->sc_time_event_uid = 0; 166 sc->sc_time_event_duration = 0; 167 sc->sc_time_event_end_ticks = 0; 168 sc->sc_flags &= ~IWM_FLAG_TE_ACTIVE; 169} 170 171/* 172 * Handles a FW notification for an event that is known to the driver. 173 * 174 * @mvm: the mvm component 175 * @te_data: the time event data 176 * @notif: the notification data corresponding the time event data. 177 */ 178static void 179iwm_te_handle_notif(struct iwm_softc *sc, 180 struct iwm_time_event_notif *notif) 181{ 182 IWM_DPRINTF(sc, IWM_DEBUG_TE, 183 "Handle time event notif - UID = 0x%x action %d\n", 184 le32toh(notif->unique_id), 185 le32toh(notif->action)); 186 187 if (!le32toh(notif->status)) { 188#ifdef IWM_DEBUG 189 const char *msg; 190 191 if (notif->action & htole32(IWM_TE_V2_NOTIF_HOST_EVENT_START)) 192 msg = "Time Event start notification failure"; 193 else 194 msg = "Time Event end notification failure"; 195 196 IWM_DPRINTF(sc, IWM_DEBUG_TE, "%s\n", msg); 197#endif 198 } 199 200 if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_END) { 201 IWM_DPRINTF(sc, IWM_DEBUG_TE, 202 "TE ended - current time %d, estimated end %d\n", 203 ticks, sc->sc_time_event_end_ticks); 204 205 iwm_te_clear_data(sc); 206 } else if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_START) { 207 sc->sc_time_event_end_ticks = 208 ticks + TU_TO_HZ(sc->sc_time_event_duration); 209 } else { 210 device_printf(sc->sc_dev, "Got TE with unknown action\n"); 211 } 212} 213 214/* 215 * The Rx handler for time event notifications 216 */ 217void 218iwm_rx_time_event_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt) 219{ 220 struct iwm_time_event_notif *notif = (void *)pkt->data; 221 222 IWM_DPRINTF(sc, IWM_DEBUG_TE, 223 "Time event notification - UID = 0x%x action %d\n", 224 le32toh(notif->unique_id), 225 le32toh(notif->action)); 226 227 iwm_te_handle_notif(sc, notif); 228} 229 230static int 231iwm_te_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt, 232 void *data) 233{ 234 struct iwm_time_event_notif *resp; 235 int resp_len = iwm_rx_packet_payload_len(pkt); 236 237 if (pkt->hdr.code != IWM_TIME_EVENT_NOTIFICATION || 238 resp_len != sizeof(*resp)) { 239 IWM_DPRINTF(sc, IWM_DEBUG_TE, 240 "Invalid TIME_EVENT_NOTIFICATION response\n"); 241 return 1; 242 } 243 244 resp = (void *)pkt->data; 245 246 /* te_data->uid is already set in the TIME_EVENT_CMD response */ 247 if (le32toh(resp->unique_id) != sc->sc_time_event_uid) 248 return false; 249 250 IWM_DPRINTF(sc, IWM_DEBUG_TE, 251 "TIME_EVENT_NOTIFICATION response - UID = 0x%x\n", 252 sc->sc_time_event_uid); 253 if (!resp->status) { 254 IWM_DPRINTF(sc, IWM_DEBUG_TE, 255 "TIME_EVENT_NOTIFICATION received but not executed\n"); 256 } 257 258 return 1; 259} 260 261static int 262iwm_time_event_response(struct iwm_softc *sc, struct iwm_rx_packet *pkt, 263 void *data) 264{ 265 struct iwm_time_event_resp *resp; 266 int resp_len = iwm_rx_packet_payload_len(pkt); 267 268 if (pkt->hdr.code != IWM_TIME_EVENT_CMD || 269 resp_len != sizeof(*resp)) { 270 IWM_DPRINTF(sc, IWM_DEBUG_TE, 271 "Invalid TIME_EVENT_CMD response\n"); 272 return 1; 273 } 274 275 resp = (void *)pkt->data; 276 277 /* we should never get a response to another TIME_EVENT_CMD here */ 278 if (le32toh(resp->id) != IWM_TE_BSS_STA_AGGRESSIVE_ASSOC) { 279 IWM_DPRINTF(sc, IWM_DEBUG_TE, 280 "Got TIME_EVENT_CMD response with wrong id: %d\n", 281 le32toh(resp->id)); 282 return 0; 283 } 284 285 sc->sc_time_event_uid = le32toh(resp->unique_id); 286 IWM_DPRINTF(sc, IWM_DEBUG_TE, 287 "TIME_EVENT_CMD response - UID = 0x%x\n", sc->sc_time_event_uid); 288 return 1; 289} 290 291 292/* XXX Use the te_data function argument properly, like in iwlwifi's code. */ 293 294static int 295iwm_time_event_send_add(struct iwm_softc *sc, struct iwm_vap *ivp, 296 void *te_data, struct iwm_time_event_cmd *te_cmd) 297{ 298 static const uint16_t time_event_response[] = { IWM_TIME_EVENT_CMD }; 299 struct iwm_notification_wait wait_time_event; 300 int ret; 301 302 IWM_DPRINTF(sc, IWM_DEBUG_TE, 303 "Add new TE, duration %d TU\n", le32toh(te_cmd->duration)); 304 305 sc->sc_time_event_duration = le32toh(te_cmd->duration); 306 307 /* 308 * Use a notification wait, which really just processes the 309 * command response and doesn't wait for anything, in order 310 * to be able to process the response and get the UID inside 311 * the RX path. Using CMD_WANT_SKB doesn't work because it 312 * stores the buffer and then wakes up this thread, by which 313 * time another notification (that the time event started) 314 * might already be processed unsuccessfully. 315 */ 316 iwm_init_notification_wait(sc->sc_notif_wait, &wait_time_event, 317 time_event_response, 318 nitems(time_event_response), 319 iwm_time_event_response, /*te_data*/NULL); 320 321 ret = iwm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(*te_cmd), 322 te_cmd); 323 if (ret) { 324 IWM_DPRINTF(sc, IWM_DEBUG_TE, 325 "%s: Couldn't send IWM_TIME_EVENT_CMD: %d\n", 326 __func__, ret); 327 iwm_remove_notification(sc->sc_notif_wait, &wait_time_event); 328 return ret; 329 } 330 331 /* No need to wait for anything, so just pass 1 (0 isn't valid) */ 332 IWM_UNLOCK(sc); 333 ret = iwm_wait_notification(sc->sc_notif_wait, &wait_time_event, 1); 334 IWM_LOCK(sc); 335 /* should never fail */ 336 if (ret) { 337 IWM_DPRINTF(sc, IWM_DEBUG_TE, 338 "%s: Failed to get response for IWM_TIME_EVENT_CMD: %d\n", 339 __func__, ret); 340 } 341 342 return ret; 343} 344 345void 346iwm_protect_session(struct iwm_softc *sc, struct iwm_vap *ivp, 347 uint32_t duration, uint32_t max_delay, boolean_t wait_for_notif) 348{ 349 const uint16_t te_notif_response[] = { IWM_TIME_EVENT_NOTIFICATION }; 350 struct iwm_notification_wait wait_te_notif; 351 struct iwm_time_event_cmd time_cmd = {}; 352 353 /* Do nothing if a time event is already scheduled. */ 354 if (sc->sc_flags & IWM_FLAG_TE_ACTIVE) 355 return; 356 357 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_ADD); 358 time_cmd.id_and_color = 359 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)); 360 time_cmd.id = htole32(IWM_TE_BSS_STA_AGGRESSIVE_ASSOC); 361 362 time_cmd.apply_time = htole32(0); 363 364 time_cmd.max_frags = IWM_TE_V2_FRAG_NONE; 365 time_cmd.max_delay = htole32(max_delay); 366 /* TODO: why do we need to interval = bi if it is not periodic? */ 367 time_cmd.interval = htole32(1); 368 time_cmd.duration = htole32(duration); 369 time_cmd.repeat = 1; 370 time_cmd.policy 371 = htole16(IWM_TE_V2_NOTIF_HOST_EVENT_START | 372 IWM_TE_V2_NOTIF_HOST_EVENT_END | 373 IWM_T2_V2_START_IMMEDIATELY); 374 375 if (!wait_for_notif) { 376 iwm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd); 377 DELAY(100); 378 sc->sc_flags |= IWM_FLAG_TE_ACTIVE; 379 return; 380 } 381 382 /* 383 * Create notification_wait for the TIME_EVENT_NOTIFICATION to use 384 * right after we send the time event 385 */ 386 iwm_init_notification_wait(sc->sc_notif_wait, &wait_te_notif, 387 te_notif_response, nitems(te_notif_response), 388 iwm_te_notif, /*te_data*/NULL); 389 390 /* If TE was sent OK - wait for the notification that started */ 391 if (iwm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd)) { 392 IWM_DPRINTF(sc, IWM_DEBUG_TE, 393 "%s: Failed to add TE to protect session\n", __func__); 394 iwm_remove_notification(sc->sc_notif_wait, &wait_te_notif); 395 } else { 396 sc->sc_flags |= IWM_FLAG_TE_ACTIVE; 397 IWM_UNLOCK(sc); 398 if (iwm_wait_notification(sc->sc_notif_wait, &wait_te_notif, 399 TU_TO_HZ(max_delay))) { 400 IWM_DPRINTF(sc, IWM_DEBUG_TE, 401 "%s: Failed to protect session until TE\n", 402 __func__); 403 } 404 IWM_LOCK(sc); 405 } 406} 407 408void 409iwm_stop_session_protection(struct iwm_softc *sc, struct iwm_vap *ivp) 410{ 411 struct iwm_time_event_cmd time_cmd = {}; 412 413 /* Do nothing if the time event has already ended. */ 414 if ((sc->sc_flags & IWM_FLAG_TE_ACTIVE) == 0) 415 return; 416 417 time_cmd.id = htole32(sc->sc_time_event_uid); 418 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_REMOVE); 419 time_cmd.id_and_color = 420 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)); 421 422 IWM_DPRINTF(sc, IWM_DEBUG_TE, 423 "%s: Removing TE 0x%x\n", __func__, le32toh(time_cmd.id)); 424 if (iwm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(time_cmd), 425 &time_cmd) == 0) 426 iwm_te_clear_data(sc); 427 428 DELAY(100); 429} 430