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"
110 #include <sys/param.h>
112 #include <sys/conf.h>
113 #include <sys/endian.h>
114 #include <sys/firmware.h>
115 #include <sys/kernel.h>
116 #include <sys/malloc.h>
117 #include <sys/mbuf.h>
118 #include <sys/mutex.h>
119 #include <sys/module.h>
120 #include <sys/proc.h>
121 #include <sys/rman.h>
122 #include <sys/socket.h>
123 #include <sys/sockio.h>
124 #include <sys/sysctl.h>
125 #include <sys/linker.h>
127 #include <machine/bus.h>
128 #include <machine/endian.h>
129 #include <machine/resource.h>
131 #include <dev/pci/pcivar.h>
132 #include <dev/pci/pcireg.h>
137 #include <net/if_var.h>
138 #include <net/if_arp.h>
139 #include <net/if_dl.h>
140 #include <net/if_media.h>
141 #include <net/if_types.h>
143 #include <netinet/in.h>
144 #include <netinet/in_systm.h>
145 #include <netinet/if_ether.h>
146 #include <netinet/ip.h>
148 #include <net80211/ieee80211_var.h>
149 #include <net80211/ieee80211_regdomain.h>
150 #include <net80211/ieee80211_ratectl.h>
151 #include <net80211/ieee80211_radiotap.h>
153 #include <dev/iwm/if_iwmreg.h>
154 #include <dev/iwm/if_iwmvar.h>
155 #include <dev/iwm/if_iwm_debug.h>
156 #include <dev/iwm/if_iwm_util.h>
157 #include <dev/iwm/if_iwm_mac_ctxt.h>
160 * BEGIN mvm/mac-ctxt.c
163 const uint8_t iwm_mvm_ac_to_tx_fifo[] = {
171 iwm_mvm_ack_rates(struct iwm_softc *sc, int is2ghz,
172 int *cck_rates, int *ofdm_rates, struct iwm_node *in)
174 int lowest_present_ofdm = 100;
175 int lowest_present_cck = 100;
179 struct ieee80211_rateset *rs = &in->in_ni.ni_rates;
182 for (i = IWM_FIRST_CCK_RATE; i <= IWM_LAST_CCK_RATE; i++) {
183 if ((iwm_ridx2rate(rs, i) & IEEE80211_RATE_BASIC) == 0)
186 if (lowest_present_cck > i)
187 lowest_present_cck = i;
190 for (i = IWM_FIRST_OFDM_RATE; i <= IWM_LAST_NON_HT_RATE; i++) {
191 if ((iwm_ridx2rate(rs, i) & IEEE80211_RATE_BASIC) == 0)
193 ofdm |= (1 << (i - IWM_FIRST_OFDM_RATE));
194 if (lowest_present_ofdm > i)
195 lowest_present_ofdm = i;
199 * Now we've got the basic rates as bitmaps in the ofdm and cck
200 * variables. This isn't sufficient though, as there might not
201 * be all the right rates in the bitmap. E.g. if the only basic
202 * rates are 5.5 Mbps and 11 Mbps, we still need to add 1 Mbps
203 * and 6 Mbps because the 802.11-2007 standard says in 9.6:
205 * [...] a STA responding to a received frame shall transmit
206 * its Control Response frame [...] at the highest rate in the
207 * BSSBasicRateSet parameter that is less than or equal to the
208 * rate of the immediately previous frame in the frame exchange
209 * sequence ([...]) and that is of the same modulation class
210 * ([...]) as the received frame. If no rate contained in the
211 * BSSBasicRateSet parameter meets these conditions, then the
212 * control frame sent in response to a received frame shall be
213 * transmitted at the highest mandatory rate of the PHY that is
214 * less than or equal to the rate of the received frame, and
215 * that is of the same modulation class as the received frame.
217 * As a consequence, we need to add all mandatory rates that are
218 * lower than all of the basic rates to these bitmaps.
221 if (IWM_RATE_24M_INDEX < lowest_present_ofdm)
222 ofdm |= IWM_RATE_BIT_MSK(24) >> IWM_FIRST_OFDM_RATE;
223 if (IWM_RATE_12M_INDEX < lowest_present_ofdm)
224 ofdm |= IWM_RATE_BIT_MSK(12) >> IWM_FIRST_OFDM_RATE;
225 /* 6M already there or needed so always add */
226 ofdm |= IWM_RATE_BIT_MSK(6) >> IWM_FIRST_OFDM_RATE;
229 * CCK is a bit more complex with DSSS vs. HR/DSSS vs. ERP.
231 * - if no CCK rates are basic, it must be ERP since there must
232 * be some basic rates at all, so they're OFDM => ERP PHY
233 * (or we're in 5 GHz, and the cck bitmap will never be used)
234 * - if 11M is a basic rate, it must be ERP as well, so add 5.5M
235 * - if 5.5M is basic, 1M and 2M are mandatory
236 * - if 2M is basic, 1M is mandatory
237 * - if 1M is basic, that's the only valid ACK rate.
238 * As a consequence, it's not as complicated as it sounds, just add
239 * any lower rates to the ACK rate bitmap.
241 if (IWM_RATE_11M_INDEX < lowest_present_cck)
242 cck |= IWM_RATE_BIT_MSK(11) >> IWM_FIRST_CCK_RATE;
243 if (IWM_RATE_5M_INDEX < lowest_present_cck)
244 cck |= IWM_RATE_BIT_MSK(5) >> IWM_FIRST_CCK_RATE;
245 if (IWM_RATE_2M_INDEX < lowest_present_cck)
246 cck |= IWM_RATE_BIT_MSK(2) >> IWM_FIRST_CCK_RATE;
247 /* 1M already there or needed so always add */
248 cck |= IWM_RATE_BIT_MSK(1) >> IWM_FIRST_CCK_RATE;
255 iwm_mvm_mac_ctxt_cmd_common(struct iwm_softc *sc, struct iwm_node *in,
256 struct iwm_mac_ctx_cmd *cmd, uint32_t action)
258 struct ieee80211com *ic = &sc->sc_ic;
259 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
260 struct ieee80211_node *ni = vap->iv_bss;
261 struct iwm_vap *ivp = IWM_VAP(vap);
262 int cck_ack_rates, ofdm_ack_rates;
267 * id is the MAC address ID - something to do with MAC filtering.
270 * These are both functions of the vap, not of the node.
271 * So, for now, hard-code both to 0 (default).
273 cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id,
275 cmd->action = htole32(action);
277 cmd->mac_type = htole32(IWM_FW_MAC_TYPE_BSS_STA);
280 * The TSF ID is one of four TSF tracking resources in the firmware.
281 * Read the iwlwifi/mvm code for more details.
283 * For now, just hard-code it to TSF tracking ID 0; we only support
284 * a single STA mode VAP.
286 * It's per-vap, not per-node.
288 cmd->tsf_id = htole32(IWM_DEFAULT_TSFID);
290 IEEE80211_ADDR_COPY(cmd->node_addr, vap->iv_myaddr);
293 * XXX should we error out if in_assoc is 1 and ni == NULL?
297 IEEE80211_ADDR_COPY(cmd->bssid_addr, ni->ni_bssid);
299 /* eth broadcast address */
300 IEEE80211_ADDR_COPY(cmd->bssid_addr, ieee80211broadcastaddr);
304 * XXX This workaround makes the firmware behave more correctly once
305 * we are associated, regularly giving us statistics notifications,
306 * as well as signaling missed beacons to us.
307 * Since we only call iwm_mvm_mac_ctxt_add() and
308 * iwm_mvm_mac_ctxt_changed() when already authenticating or
309 * associating, ni->ni_bssid should always make sense here.
311 IEEE80211_ADDR_COPY(cmd->bssid_addr, ni->ni_bssid);
315 * Default to 2ghz if no node information is given.
317 if (in && in->in_ni.ni_chan != IEEE80211_CHAN_ANYC) {
318 is2ghz = !! IEEE80211_IS_CHAN_2GHZ(in->in_ni.ni_chan);
322 iwm_mvm_ack_rates(sc, is2ghz, &cck_ack_rates, &ofdm_ack_rates, in);
323 cmd->cck_rates = htole32(cck_ack_rates);
324 cmd->ofdm_rates = htole32(ofdm_ack_rates);
326 cmd->cck_short_preamble
327 = htole32((ic->ic_flags & IEEE80211_F_SHPREAMBLE)
328 ? IWM_MAC_FLG_SHORT_PREAMBLE : 0);
330 = htole32((ic->ic_flags & IEEE80211_F_SHSLOT)
331 ? IWM_MAC_FLG_SHORT_SLOT : 0);
334 * XXX TODO: if we're doing QOS..
335 * cmd->qos_flags |= cpu_to_le32(MAC_QOS_FLG_UPDATE_EDCA)
338 for (i = 0; i < WME_NUM_AC; i++) {
339 uint8_t txf = iwm_mvm_ac_to_tx_fifo[i];
341 cmd->ac[txf].cw_min = htole16(ivp->queue_params[i].cw_min);
342 cmd->ac[txf].cw_max = htole16(ivp->queue_params[i].cw_max);
343 cmd->ac[txf].edca_txop =
344 htole16(ivp->queue_params[i].edca_txop);
345 cmd->ac[txf].aifsn = ivp->queue_params[i].aifsn;
346 cmd->ac[txf].fifos_mask = (1 << txf);
350 cmd->qos_flags |= htole32(IWM_MAC_QOS_FLG_UPDATE_EDCA);
352 if (ic->ic_flags & IEEE80211_F_USEPROT)
353 cmd->protection_flags |= htole32(IWM_MAC_PROT_FLG_TGG_PROTECT);
355 cmd->filter_flags = htole32(IWM_MAC_FILTER_ACCEPT_GRP);
359 iwm_mvm_mac_ctxt_send_cmd(struct iwm_softc *sc, struct iwm_mac_ctx_cmd *cmd)
361 int ret = iwm_mvm_send_cmd_pdu(sc, IWM_MAC_CONTEXT_CMD, IWM_CMD_SYNC,
364 device_printf(sc->sc_dev,
365 "%s: Failed to send MAC context (action:%d): %d\n",
366 __func__, le32toh(cmd->action), ret);
371 * Fill the specific data for mac context of type station or p2p client
374 iwm_mvm_mac_ctxt_cmd_fill_sta(struct iwm_softc *sc, struct iwm_node *in,
375 struct iwm_mac_data_sta *ctxt_sta, int force_assoc_off)
377 struct ieee80211_node *ni = &in->in_ni;
378 unsigned dtim_period, dtim_count;
379 struct ieee80211com *ic = &sc->sc_ic;
380 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
382 /* will this work? */
383 dtim_period = vap->iv_dtim_period;
384 dtim_count = vap->iv_dtim_count;
385 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
386 "%s: force_assoc_off=%d\n", __func__, force_assoc_off);
387 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
388 "DTIM: period=%d count=%d\n", dtim_period, dtim_count);
389 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
390 "BEACON: tsf: %llu, ni_intval=%d\n",
391 (unsigned long long) le64toh(ni->ni_tstamp.tsf),
394 /* We need the dtim_period to set the MAC as associated */
395 if (in->in_assoc && dtim_period && !force_assoc_off) {
400 * The DTIM count counts down, so when it is N that means N
401 * more beacon intervals happen until the DTIM TBTT. Therefore
402 * add this to the current time. If that ends up being in the
403 * future, the firmware will handle it.
405 * Also note that the system_timestamp (which we get here as
406 * "sync_device_ts") and TSF timestamp aren't at exactly the
407 * same offset in the frame -- the TSF is at the first symbol
408 * of the TSF, the system timestamp is at signal acquisition
409 * time. This means there's an offset between them of at most
410 * a few hundred microseconds (24 * 8 bits + PLCP time gives
411 * 384us in the longest case), this is currently not relevant
412 * as the firmware wakes up around 2ms before the TBTT.
414 dtim_offs = dtim_count * ni->ni_intval;
415 /* convert TU to usecs */
419 * net80211: TSF is in 802.11 order, so convert up to local
420 * ordering before we manipulate things.
422 tsf = le64toh(ni->ni_tstamp.tsf);
424 ctxt_sta->dtim_tsf = htole64(tsf + dtim_offs);
425 ctxt_sta->dtim_time = htole32(tsf + dtim_offs);
427 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
428 "DTIM TBTT is 0x%llx/0x%x, offset %d\n",
429 (long long)le64toh(ctxt_sta->dtim_tsf),
430 le32toh(ctxt_sta->dtim_time), dtim_offs);
432 ctxt_sta->is_assoc = htole32(1);
434 ctxt_sta->is_assoc = htole32(0);
437 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD | IWM_DEBUG_BEACON,
438 "%s: ni_intval: %d, bi_reciprocal: %d, dtim_interval: %d, dtim_reciprocal: %d\n",
441 iwm_mvm_reciprocal(ni->ni_intval),
442 ni->ni_intval * dtim_period,
443 iwm_mvm_reciprocal(ni->ni_intval * dtim_period));
445 ctxt_sta->bi = htole32(ni->ni_intval);
446 ctxt_sta->bi_reciprocal = htole32(iwm_mvm_reciprocal(ni->ni_intval));
447 ctxt_sta->dtim_interval = htole32(ni->ni_intval * dtim_period);
448 ctxt_sta->dtim_reciprocal =
449 htole32(iwm_mvm_reciprocal(ni->ni_intval * dtim_period));
451 /* 10 = CONN_MAX_LISTEN_INTERVAL */
452 ctxt_sta->listen_interval = htole32(10);
453 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD | IWM_DEBUG_BEACON,
454 "%s: associd=%d\n", __func__, IEEE80211_AID(ni->ni_associd));
455 ctxt_sta->assoc_id = htole32(IEEE80211_AID(ni->ni_associd));
459 iwm_mvm_mac_ctxt_cmd_station(struct iwm_softc *sc, struct ieee80211vap *vap,
462 struct ieee80211_node *ni = vap->iv_bss;
463 struct iwm_node *in = IWM_NODE(ni);
464 struct iwm_mac_ctx_cmd cmd = {};
466 IWM_DPRINTF(sc, IWM_DEBUG_RESET,
467 "%s: called; action=%d\n", __func__, action);
469 /* Fill the common data for all mac context types */
470 iwm_mvm_mac_ctxt_cmd_common(sc, in, &cmd, action);
472 /* Allow beacons to pass through as long as we are not associated,or we
473 * do not have dtim period information */
474 if (!in->in_assoc || !vap->iv_dtim_period)
475 cmd.filter_flags |= htole32(IWM_MAC_FILTER_IN_BEACON);
477 cmd.filter_flags &= ~htole32(IWM_MAC_FILTER_IN_BEACON);
479 /* Fill the data specific for station mode */
480 iwm_mvm_mac_ctxt_cmd_fill_sta(sc, in,
481 &cmd.sta, action == IWM_FW_CTXT_ACTION_ADD);
483 return iwm_mvm_mac_ctxt_send_cmd(sc, &cmd);
487 iwm_mvm_mac_ctx_send(struct iwm_softc *sc, struct ieee80211vap *vap,
490 return iwm_mvm_mac_ctxt_cmd_station(sc, vap, action);
494 iwm_mvm_mac_ctxt_add(struct iwm_softc *sc, struct ieee80211vap *vap)
496 struct iwm_vap *iv = IWM_VAP(vap);
499 if (iv->is_uploaded != 0) {
500 device_printf(sc->sc_dev, "%s: called; uploaded != 0\n",
505 ret = iwm_mvm_mac_ctx_send(sc, vap, IWM_FW_CTXT_ACTION_ADD);
513 iwm_mvm_mac_ctxt_changed(struct iwm_softc *sc, struct ieee80211vap *vap)
515 struct iwm_vap *iv = IWM_VAP(vap);
517 if (iv->is_uploaded == 0) {
518 device_printf(sc->sc_dev, "%s: called; uploaded = 0\n",
522 return iwm_mvm_mac_ctx_send(sc, vap, IWM_FW_CTXT_ACTION_MODIFY);
527 iwm_mvm_mac_ctxt_remove(struct iwm_softc *sc, struct iwm_node *in)
529 struct iwm_mac_ctx_cmd cmd;
532 if (!in->in_uploaded) {
533 device_printf(sc->sc_dev,
534 "attempt to remove !uploaded node %p", in);
538 memset(&cmd, 0, sizeof(cmd));
540 cmd.id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(IWM_DEFAULT_MACID,
542 cmd.action = htole32(IWM_FW_CTXT_ACTION_REMOVE);
544 ret = iwm_mvm_send_cmd_pdu(sc,
545 IWM_MAC_CONTEXT_CMD, IWM_CMD_SYNC, sizeof(cmd), &cmd);
547 device_printf(sc->sc_dev,
548 "Failed to remove MAC context: %d\n", ret);