1 /* $OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $ */
4 * Copyright (c) 2014 genua mbh <info@genua.de>
5 * Copyright (c) 2014 Fixup Software Ltd.
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.
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.
21 * Based on BSD-licensed source modules in the Linux iwlwifi driver,
22 * which were used as the reference documentation for this implementation.
24 * Driver version we are currently based off of is
25 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd)
27 ***********************************************************************
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.
34 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
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.
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.
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,
50 * The full GNU General Public License is included in this distribution
51 * in the file called COPYING.
53 * Contact Information:
54 * Intel Linux Wireless <ilw@linux.intel.com>
55 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
60 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
61 * All rights reserved.
63 * Redistribution and use in source and binary forms, with or without
64 * modification, are permitted provided that the following conditions
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
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.
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.
91 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
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.
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.
105 #include <sys/cdefs.h>
106 __FBSDID("$FreeBSD$");
108 #include "opt_wlan.h"
111 #include <sys/param.h>
113 #include <sys/conf.h>
114 #include <sys/endian.h>
115 #include <sys/firmware.h>
116 #include <sys/kernel.h>
117 #include <sys/malloc.h>
118 #include <sys/mbuf.h>
119 #include <sys/mutex.h>
120 #include <sys/module.h>
121 #include <sys/proc.h>
122 #include <sys/rman.h>
123 #include <sys/socket.h>
124 #include <sys/sockio.h>
125 #include <sys/sysctl.h>
126 #include <sys/linker.h>
128 #include <machine/bus.h>
129 #include <machine/endian.h>
130 #include <machine/resource.h>
132 #include <dev/pci/pcivar.h>
133 #include <dev/pci/pcireg.h>
138 #include <net/if_var.h>
139 #include <net/if_arp.h>
140 #include <net/if_dl.h>
141 #include <net/if_media.h>
142 #include <net/if_types.h>
144 #include <netinet/in.h>
145 #include <netinet/in_systm.h>
146 #include <netinet/if_ether.h>
147 #include <netinet/ip.h>
149 #include <net80211/ieee80211_var.h>
150 #include <net80211/ieee80211_regdomain.h>
151 #include <net80211/ieee80211_ratectl.h>
152 #include <net80211/ieee80211_radiotap.h>
154 #include <dev/iwm/if_iwmreg.h>
155 #include <dev/iwm/if_iwmvar.h>
156 #include <dev/iwm/if_iwm_config.h>
157 #include <dev/iwm/if_iwm_debug.h>
158 #include <dev/iwm/if_iwm_pcie_trans.h>
161 * This is a subset of what's in linux iwlwifi/pcie/trans.c.
162 * The rest can be migrated out into here once they're no longer in
167 * basic device access
171 iwm_read_prph(struct iwm_softc *sc, uint32_t addr)
174 IWM_HBUS_TARG_PRPH_RADDR, ((addr & 0x000fffff) | (3 << 24)));
175 IWM_BARRIER_READ_WRITE(sc);
176 return IWM_READ(sc, IWM_HBUS_TARG_PRPH_RDAT);
180 iwm_write_prph(struct iwm_softc *sc, uint32_t addr, uint32_t val)
183 IWM_HBUS_TARG_PRPH_WADDR, ((addr & 0x000fffff) | (3 << 24)));
184 IWM_BARRIER_WRITE(sc);
185 IWM_WRITE(sc, IWM_HBUS_TARG_PRPH_WDAT, val);
189 /* iwlwifi: pcie/trans.c */
191 iwm_read_mem(struct iwm_softc *sc, uint32_t addr, void *buf, int dwords)
194 uint32_t *vals = buf;
196 if (iwm_nic_lock(sc)) {
197 IWM_WRITE(sc, IWM_HBUS_TARG_MEM_RADDR, addr);
198 for (offs = 0; offs < dwords; offs++)
199 vals[offs] = IWM_READ(sc, IWM_HBUS_TARG_MEM_RDAT);
208 /* iwlwifi: pcie/trans.c */
210 iwm_write_mem(struct iwm_softc *sc, uint32_t addr, const void *buf, int dwords)
213 const uint32_t *vals = buf;
215 if (iwm_nic_lock(sc)) {
216 IWM_WRITE(sc, IWM_HBUS_TARG_MEM_WADDR, addr);
217 /* WADDR auto-increments */
218 for (offs = 0; offs < dwords; offs++) {
219 uint32_t val = vals ? vals[offs] : 0;
220 IWM_WRITE(sc, IWM_HBUS_TARG_MEM_WDAT, val);
224 IWM_DPRINTF(sc, IWM_DEBUG_TRANS,
225 "%s: write_mem failed\n", __func__);
232 iwm_write_mem32(struct iwm_softc *sc, uint32_t addr, uint32_t val)
234 return iwm_write_mem(sc, addr, &val, 1);
238 iwm_poll_bit(struct iwm_softc *sc, int reg,
239 uint32_t bits, uint32_t mask, int timo)
242 if ((IWM_READ(sc, reg) & mask) == (bits & mask)) {
254 iwm_nic_lock(struct iwm_softc *sc)
258 if (sc->cmd_hold_nic_awake)
261 IWM_SETBITS(sc, IWM_CSR_GP_CNTRL,
262 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
264 if (sc->cfg->device_family == IWM_DEVICE_FAMILY_8000)
267 if (iwm_poll_bit(sc, IWM_CSR_GP_CNTRL,
268 IWM_CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN,
269 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY
270 | IWM_CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP, 15000)) {
274 IWM_DPRINTF(sc, IWM_DEBUG_RESET,
275 "%s: resetting device via NMI\n", __func__);
276 IWM_WRITE(sc, IWM_CSR_RESET, IWM_CSR_RESET_REG_FLAG_FORCE_NMI);
283 iwm_nic_unlock(struct iwm_softc *sc)
285 if (sc->cmd_hold_nic_awake)
288 IWM_CLRBITS(sc, IWM_CSR_GP_CNTRL,
289 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
293 iwm_set_bits_mask_prph(struct iwm_softc *sc,
294 uint32_t reg, uint32_t bits, uint32_t mask)
298 /* XXX: no error path? */
299 if (iwm_nic_lock(sc)) {
300 val = iwm_read_prph(sc, reg) & mask;
302 iwm_write_prph(sc, reg, val);
308 iwm_set_bits_prph(struct iwm_softc *sc, uint32_t reg, uint32_t bits)
310 iwm_set_bits_mask_prph(sc, reg, bits, ~0);
314 iwm_clear_bits_prph(struct iwm_softc *sc, uint32_t reg, uint32_t bits)
316 iwm_set_bits_mask_prph(sc, reg, 0, ~bits);
320 * High-level hardware frobbing routines
324 iwm_enable_rfkill_int(struct iwm_softc *sc)
326 sc->sc_intmask = IWM_CSR_INT_BIT_RF_KILL;
327 IWM_WRITE(sc, IWM_CSR_INT_MASK, sc->sc_intmask);
331 iwm_check_rfkill(struct iwm_softc *sc)
337 * "documentation" is not really helpful here:
339 * Indicates state of (platform's) hardware RF-Kill switch
341 * But apparently when it's off, it's on ...
343 v = IWM_READ(sc, IWM_CSR_GP_CNTRL);
344 rv = (v & IWM_CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW) == 0;
346 sc->sc_flags |= IWM_FLAG_RFKILL;
348 sc->sc_flags &= ~IWM_FLAG_RFKILL;
355 #define IWM_HW_READY_TIMEOUT 50
357 iwm_set_hw_ready(struct iwm_softc *sc)
361 IWM_SETBITS(sc, IWM_CSR_HW_IF_CONFIG_REG,
362 IWM_CSR_HW_IF_CONFIG_REG_BIT_NIC_READY);
364 ready = iwm_poll_bit(sc, IWM_CSR_HW_IF_CONFIG_REG,
365 IWM_CSR_HW_IF_CONFIG_REG_BIT_NIC_READY,
366 IWM_CSR_HW_IF_CONFIG_REG_BIT_NIC_READY,
367 IWM_HW_READY_TIMEOUT);
369 IWM_SETBITS(sc, IWM_CSR_MBOX_SET_REG,
370 IWM_CSR_MBOX_SET_REG_OS_ALIVE);
374 #undef IWM_HW_READY_TIMEOUT
377 iwm_prepare_card_hw(struct iwm_softc *sc)
382 IWM_DPRINTF(sc, IWM_DEBUG_RESET, "->%s\n", __func__);
383 if (iwm_set_hw_ready(sc))
388 /* If HW is not ready, prepare the conditions to check again */
389 IWM_SETBITS(sc, IWM_CSR_HW_IF_CONFIG_REG,
390 IWM_CSR_HW_IF_CONFIG_REG_PREPARE);
393 if (iwm_set_hw_ready(sc))
397 } while (t < 150000);
402 IWM_DPRINTF(sc, IWM_DEBUG_RESET, "<-%s\n", __func__);
407 iwm_apm_config(struct iwm_softc *sc)
411 reg = pci_read_config(sc->sc_dev, PCIER_LINK_CTL, sizeof(reg));
412 if (reg & PCIEM_LINK_CTL_ASPMC_L1) {
413 /* Um the Linux driver prints "Disabling L0S for this one ... */
414 IWM_SETBITS(sc, IWM_CSR_GIO_REG,
415 IWM_CSR_GIO_REG_VAL_L0S_ENABLED);
417 /* ... and "Enabling" here */
418 IWM_CLRBITS(sc, IWM_CSR_GIO_REG,
419 IWM_CSR_GIO_REG_VAL_L0S_ENABLED);
424 * Start up NIC's basic functionality after it has been reset
425 * (e.g. after platform boot, or shutdown via iwm_pcie_apm_stop())
426 * NOTE: This does not load uCode nor start the embedded processor
429 iwm_apm_init(struct iwm_softc *sc)
433 IWM_DPRINTF(sc, IWM_DEBUG_RESET, "iwm apm start\n");
435 /* Disable L0S exit timer (platform NMI Work/Around) */
436 if (sc->cfg->device_family != IWM_DEVICE_FAMILY_8000) {
437 IWM_SETBITS(sc, IWM_CSR_GIO_CHICKEN_BITS,
438 IWM_CSR_GIO_CHICKEN_BITS_REG_BIT_DIS_L0S_EXIT_TIMER);
442 * Disable L0s without affecting L1;
443 * don't wait for ICH L0s (ICH bug W/A)
445 IWM_SETBITS(sc, IWM_CSR_GIO_CHICKEN_BITS,
446 IWM_CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX);
448 /* Set FH wait threshold to maximum (HW error during stress W/A) */
449 IWM_SETBITS(sc, IWM_CSR_DBG_HPET_MEM_REG, IWM_CSR_DBG_HPET_MEM_REG_VAL);
452 * Enable HAP INTA (interrupt from management bus) to
453 * wake device's PCI Express link L1a -> L0s
455 IWM_SETBITS(sc, IWM_CSR_HW_IF_CONFIG_REG,
456 IWM_CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A);
460 #if 0 /* not for 7k/8k */
461 /* Configure analog phase-lock-loop before activating to D0A */
462 if (trans->cfg->base_params->pll_cfg_val)
463 IWM_SETBITS(trans, IWM_CSR_ANA_PLL_CFG,
464 trans->cfg->base_params->pll_cfg_val);
468 * Set "initialization complete" bit to move adapter from
469 * D0U* --> D0A* (powered-up active) state.
471 IWM_SETBITS(sc, IWM_CSR_GP_CNTRL, IWM_CSR_GP_CNTRL_REG_FLAG_INIT_DONE);
474 * Wait for clock stabilization; once stabilized, access to
475 * device-internal resources is supported, e.g. iwm_write_prph()
476 * and accesses to uCode SRAM.
478 if (!iwm_poll_bit(sc, IWM_CSR_GP_CNTRL,
479 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY,
480 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY, 25000)) {
481 device_printf(sc->sc_dev,
482 "timeout waiting for clock stabilization\n");
487 if (sc->cfg->host_interrupt_operation_mode) {
489 * This is a bit of an abuse - This is needed for 7260 / 3160
490 * only check host_interrupt_operation_mode even if this is
491 * not related to host_interrupt_operation_mode.
493 * Enable the oscillator to count wake up time for L1 exit. This
494 * consumes slightly more power (100uA) - but allows to be sure
495 * that we wake up from L1 on time.
497 * This looks weird: read twice the same register, discard the
498 * value, set a bit, and yet again, read that same register
499 * just to discard the value. But that's the way the hardware
502 if (iwm_nic_lock(sc)) {
503 iwm_read_prph(sc, IWM_OSC_CLK);
504 iwm_read_prph(sc, IWM_OSC_CLK);
507 iwm_set_bits_prph(sc, IWM_OSC_CLK, IWM_OSC_CLK_FORCE_CONTROL);
508 if (iwm_nic_lock(sc)) {
509 iwm_read_prph(sc, IWM_OSC_CLK);
510 iwm_read_prph(sc, IWM_OSC_CLK);
516 * Enable DMA clock and wait for it to stabilize.
518 * Write to "CLK_EN_REG"; "1" bits enable clocks, while "0" bits
519 * do not disable clocks. This preserves any hardware bits already
520 * set by default in "CLK_CTRL_REG" after reset.
522 if (sc->cfg->device_family == IWM_DEVICE_FAMILY_7000) {
523 if (iwm_nic_lock(sc)) {
524 iwm_write_prph(sc, IWM_APMG_CLK_EN_REG,
525 IWM_APMG_CLK_VAL_DMA_CLK_RQT);
530 /* Disable L1-Active */
531 iwm_set_bits_prph(sc, IWM_APMG_PCIDEV_STT_REG,
532 IWM_APMG_PCIDEV_STT_VAL_L1_ACT_DIS);
534 /* Clear the interrupt in APMG if the NIC is in RFKILL */
535 if (iwm_nic_lock(sc)) {
536 iwm_write_prph(sc, IWM_APMG_RTC_INT_STT_REG,
537 IWM_APMG_RTC_INT_STT_RFKILL);
543 device_printf(sc->sc_dev, "apm init error %d\n", error);
547 /* iwlwifi/pcie/trans.c */
549 iwm_apm_stop(struct iwm_softc *sc)
551 /* stop device's busmaster DMA activity */
552 IWM_SETBITS(sc, IWM_CSR_RESET, IWM_CSR_RESET_REG_FLAG_STOP_MASTER);
554 if (!iwm_poll_bit(sc, IWM_CSR_RESET,
555 IWM_CSR_RESET_REG_FLAG_MASTER_DISABLED,
556 IWM_CSR_RESET_REG_FLAG_MASTER_DISABLED, 100))
557 device_printf(sc->sc_dev, "timeout waiting for master\n");
558 IWM_DPRINTF(sc, IWM_DEBUG_TRANS, "%s: iwm apm stop\n", __func__);
561 /* iwlwifi pcie/trans.c */
563 iwm_start_hw(struct iwm_softc *sc)
567 if ((error = iwm_prepare_card_hw(sc)) != 0)
570 /* Reset the entire device */
571 IWM_WRITE(sc, IWM_CSR_RESET, IWM_CSR_RESET_REG_FLAG_SW_RESET);
574 if ((error = iwm_apm_init(sc)) != 0)
577 iwm_enable_rfkill_int(sc);
578 iwm_check_rfkill(sc);
583 /* iwlwifi pcie/trans.c (always main power) */
585 iwm_set_pwr(struct iwm_softc *sc)
587 iwm_set_bits_mask_prph(sc, IWM_APMG_PS_CTRL_REG,
588 IWM_APMG_PS_CTRL_VAL_PWR_SRC_VMAIN, ~IWM_APMG_PS_CTRL_MSK_PWR_SRC);
591 /* iwlwifi pcie/rx.c */
593 iwm_pcie_rx_stop(struct iwm_softc *sc)
596 if (iwm_nic_lock(sc)) {
597 IWM_WRITE(sc, IWM_FH_MEM_RCSR_CHNL0_CONFIG_REG, 0);
598 ret = iwm_poll_bit(sc, IWM_FH_MEM_RSSR_RX_STATUS_REG,
599 IWM_FH_RSSR_CHNL0_RX_STATUS_CHNL_IDLE,
600 IWM_FH_RSSR_CHNL0_RX_STATUS_CHNL_IDLE,
608 iwm_pcie_clear_cmd_in_flight(struct iwm_softc *sc)
610 if (!sc->cfg->apmg_wake_up_wa)
613 if (!sc->cmd_hold_nic_awake) {
614 device_printf(sc->sc_dev,
615 "%s: cmd_hold_nic_awake not set\n", __func__);
619 sc->cmd_hold_nic_awake = 0;
620 IWM_CLRBITS(sc, IWM_CSR_GP_CNTRL,
621 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
625 iwm_pcie_set_cmd_in_flight(struct iwm_softc *sc)
630 * wake up the NIC to make sure that the firmware will see the host
631 * command - we will let the NIC sleep once all the host commands
632 * returned. This needs to be done only on NICs that have
633 * apmg_wake_up_wa set.
635 if (sc->cfg->apmg_wake_up_wa &&
636 !sc->cmd_hold_nic_awake) {
638 IWM_SETBITS(sc, IWM_CSR_GP_CNTRL,
639 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
641 ret = iwm_poll_bit(sc, IWM_CSR_GP_CNTRL,
642 IWM_CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN,
643 (IWM_CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY |
644 IWM_CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP),
647 IWM_CLRBITS(sc, IWM_CSR_GP_CNTRL,
648 IWM_CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
649 device_printf(sc->sc_dev,
650 "%s: Failed to wake NIC for hcmd\n", __func__);
653 sc->cmd_hold_nic_awake = 1;