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 <sys/param.h>
110 #include <sys/conf.h>
111 #include <sys/endian.h>
112 #include <sys/firmware.h>
113 #include <sys/kernel.h>
114 #include <sys/malloc.h>
115 #include <sys/mbuf.h>
116 #include <sys/mutex.h>
117 #include <sys/module.h>
118 #include <sys/proc.h>
119 #include <sys/rman.h>
120 #include <sys/socket.h>
121 #include <sys/sockio.h>
122 #include <sys/sysctl.h>
123 #include <sys/linker.h>
125 #include <machine/bus.h>
126 #include <machine/endian.h>
127 #include <machine/resource.h>
129 #include <dev/pci/pcivar.h>
130 #include <dev/pci/pcireg.h>
135 #include <net/if_var.h>
136 #include <net/if_arp.h>
137 #include <net/if_dl.h>
138 #include <net/if_media.h>
139 #include <net/if_types.h>
141 #include <netinet/in.h>
142 #include <netinet/in_systm.h>
143 #include <netinet/if_ether.h>
144 #include <netinet/ip.h>
146 #include <net80211/ieee80211_var.h>
147 #include <net80211/ieee80211_regdomain.h>
148 #include <net80211/ieee80211_ratectl.h>
149 #include <net80211/ieee80211_radiotap.h>
151 #include <dev/iwm/if_iwmreg.h>
152 #include <dev/iwm/if_iwmvar.h>
153 #include <dev/iwm/if_iwm_debug.h>
154 #include <dev/iwm/if_iwm_util.h>
155 #include <dev/iwm/if_iwm_mac_ctxt.h>
158 * BEGIN mvm/mac-ctxt.c
162 iwm_mvm_ack_rates(struct iwm_softc *sc, int is2ghz,
163 int *cck_rates, int *ofdm_rates)
165 int lowest_present_ofdm = 100;
166 int lowest_present_cck = 100;
172 for (i = 0; i <= IWM_LAST_CCK_RATE; i++) {
174 if (lowest_present_cck > i)
175 lowest_present_cck = i;
178 for (i = IWM_FIRST_OFDM_RATE; i <= IWM_LAST_NON_HT_RATE; i++) {
179 int adj = i - IWM_FIRST_OFDM_RATE;
181 if (lowest_present_ofdm > i)
182 lowest_present_ofdm = i;
186 * Now we've got the basic rates as bitmaps in the ofdm and cck
187 * variables. This isn't sufficient though, as there might not
188 * be all the right rates in the bitmap. E.g. if the only basic
189 * rates are 5.5 Mbps and 11 Mbps, we still need to add 1 Mbps
190 * and 6 Mbps because the 802.11-2007 standard says in 9.6:
192 * [...] a STA responding to a received frame shall transmit
193 * its Control Response frame [...] at the highest rate in the
194 * BSSBasicRateSet parameter that is less than or equal to the
195 * rate of the immediately previous frame in the frame exchange
196 * sequence ([...]) and that is of the same modulation class
197 * ([...]) as the received frame. If no rate contained in the
198 * BSSBasicRateSet parameter meets these conditions, then the
199 * control frame sent in response to a received frame shall be
200 * transmitted at the highest mandatory rate of the PHY that is
201 * less than or equal to the rate of the received frame, and
202 * that is of the same modulation class as the received frame.
204 * As a consequence, we need to add all mandatory rates that are
205 * lower than all of the basic rates to these bitmaps.
208 if (IWM_RATE_24M_INDEX < lowest_present_ofdm)
209 ofdm |= IWM_RATE_BIT_MSK(24) >> IWM_FIRST_OFDM_RATE;
210 if (IWM_RATE_12M_INDEX < lowest_present_ofdm)
211 ofdm |= IWM_RATE_BIT_MSK(12) >> IWM_FIRST_OFDM_RATE;
212 /* 6M already there or needed so always add */
213 ofdm |= IWM_RATE_BIT_MSK(6) >> IWM_FIRST_OFDM_RATE;
216 * CCK is a bit more complex with DSSS vs. HR/DSSS vs. ERP.
218 * - if no CCK rates are basic, it must be ERP since there must
219 * be some basic rates at all, so they're OFDM => ERP PHY
220 * (or we're in 5 GHz, and the cck bitmap will never be used)
221 * - if 11M is a basic rate, it must be ERP as well, so add 5.5M
222 * - if 5.5M is basic, 1M and 2M are mandatory
223 * - if 2M is basic, 1M is mandatory
224 * - if 1M is basic, that's the only valid ACK rate.
225 * As a consequence, it's not as complicated as it sounds, just add
226 * any lower rates to the ACK rate bitmap.
228 if (IWM_RATE_11M_INDEX < lowest_present_cck)
229 cck |= IWM_RATE_BIT_MSK(11) >> IWM_FIRST_CCK_RATE;
230 if (IWM_RATE_5M_INDEX < lowest_present_cck)
231 cck |= IWM_RATE_BIT_MSK(5) >> IWM_FIRST_CCK_RATE;
232 if (IWM_RATE_2M_INDEX < lowest_present_cck)
233 cck |= IWM_RATE_BIT_MSK(2) >> IWM_FIRST_CCK_RATE;
234 /* 1M already there or needed so always add */
235 cck |= IWM_RATE_BIT_MSK(1) >> IWM_FIRST_CCK_RATE;
242 iwm_mvm_mac_ctxt_cmd_common(struct iwm_softc *sc, struct iwm_node *in,
243 struct iwm_mac_ctx_cmd *cmd, uint32_t action)
245 struct ieee80211com *ic = &sc->sc_ic;
246 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
247 struct ieee80211_node *ni = vap->iv_bss;
248 int cck_ack_rates, ofdm_ack_rates;
253 * id is the MAC address ID - something to do with MAC filtering.
256 * These are both functions of the vap, not of the node.
257 * So, for now, hard-code both to 0 (default).
259 cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(IWM_DEFAULT_MACID,
261 cmd->action = htole32(action);
263 cmd->mac_type = htole32(IWM_FW_MAC_TYPE_BSS_STA);
266 * The TSF ID is one of four TSF tracking resources in the firmware.
267 * Read the iwlwifi/mvm code for more details.
269 * For now, just hard-code it to TSF tracking ID 0; we only support
270 * a single STA mode VAP.
272 * It's per-vap, not per-node.
274 cmd->tsf_id = htole32(IWM_DEFAULT_TSFID);
276 IEEE80211_ADDR_COPY(cmd->node_addr, ic->ic_macaddr);
279 * XXX should we error out if in_assoc is 1 and ni == NULL?
282 IEEE80211_ADDR_COPY(cmd->bssid_addr, ni->ni_bssid);
284 /* eth broadcast address */
285 memset(cmd->bssid_addr, 0xff, sizeof(cmd->bssid_addr));
289 * Default to 2ghz if no node information is given.
292 is2ghz = !! IEEE80211_IS_CHAN_2GHZ(in->in_ni.ni_chan);
296 iwm_mvm_ack_rates(sc, is2ghz, &cck_ack_rates, &ofdm_ack_rates);
297 cmd->cck_rates = htole32(cck_ack_rates);
298 cmd->ofdm_rates = htole32(ofdm_ack_rates);
300 cmd->cck_short_preamble
301 = htole32((ic->ic_flags & IEEE80211_F_SHPREAMBLE)
302 ? IWM_MAC_FLG_SHORT_PREAMBLE : 0);
304 = htole32((ic->ic_flags & IEEE80211_F_SHSLOT)
305 ? IWM_MAC_FLG_SHORT_SLOT : 0);
307 /* XXX TODO: set wme parameters; also handle getting updated wme parameters */
308 for (i = 0; i < IWM_AC_NUM+1; i++) {
311 cmd->ac[txf].cw_min = htole16(0x0f);
312 cmd->ac[txf].cw_max = htole16(0x3f);
313 cmd->ac[txf].aifsn = 1;
314 cmd->ac[txf].fifos_mask = (1 << txf);
315 cmd->ac[txf].edca_txop = 0;
318 if (ic->ic_flags & IEEE80211_F_USEPROT)
319 cmd->protection_flags |= htole32(IWM_MAC_PROT_FLG_TGG_PROTECT);
321 cmd->filter_flags = htole32(IWM_MAC_FILTER_ACCEPT_GRP);
325 iwm_mvm_mac_ctxt_send_cmd(struct iwm_softc *sc, struct iwm_mac_ctx_cmd *cmd)
327 int ret = iwm_mvm_send_cmd_pdu(sc, IWM_MAC_CONTEXT_CMD, IWM_CMD_SYNC,
330 device_printf(sc->sc_dev,
331 "%s: Failed to send MAC context (action:%d): %d\n",
332 __func__, le32toh(cmd->action), ret);
337 * Fill the specific data for mac context of type station or p2p client
340 iwm_mvm_mac_ctxt_cmd_fill_sta(struct iwm_softc *sc, struct iwm_node *in,
341 struct iwm_mac_data_sta *ctxt_sta, int force_assoc_off)
343 struct ieee80211_node *ni = &in->in_ni;
344 unsigned dtim_period, dtim_count;
345 struct ieee80211com *ic = &sc->sc_ic;
346 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
348 /* will this work? */
349 dtim_period = vap->iv_dtim_period;
350 dtim_count = vap->iv_dtim_count;
351 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
352 "%s: force_assoc_off=%d\n", __func__, force_assoc_off);
353 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
354 "DTIM: period=%d count=%d\n", dtim_period, dtim_count);
355 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
356 "BEACON: tsf: %llu, ni_intval=%d\n",
357 (unsigned long long) le64toh(ni->ni_tstamp.tsf),
360 /* We need the dtim_period to set the MAC as associated */
361 if (in->in_assoc && dtim_period && !force_assoc_off) {
366 * The DTIM count counts down, so when it is N that means N
367 * more beacon intervals happen until the DTIM TBTT. Therefore
368 * add this to the current time. If that ends up being in the
369 * future, the firmware will handle it.
371 * Also note that the system_timestamp (which we get here as
372 * "sync_device_ts") and TSF timestamp aren't at exactly the
373 * same offset in the frame -- the TSF is at the first symbol
374 * of the TSF, the system timestamp is at signal acquisition
375 * time. This means there's an offset between them of at most
376 * a few hundred microseconds (24 * 8 bits + PLCP time gives
377 * 384us in the longest case), this is currently not relevant
378 * as the firmware wakes up around 2ms before the TBTT.
380 dtim_offs = dtim_count * ni->ni_intval;
381 /* convert TU to usecs */
385 * net80211: TSF is in 802.11 order, so convert up to local
386 * ordering before we manipulate things.
388 tsf = le64toh(ni->ni_tstamp.tsf);
390 ctxt_sta->dtim_tsf = htole64(tsf + dtim_offs);
391 ctxt_sta->dtim_time = htole32(tsf + dtim_offs);
393 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_BEACON | IWM_DEBUG_CMD,
394 "DTIM TBTT is 0x%llx/0x%x, offset %d\n",
395 (long long)le64toh(ctxt_sta->dtim_tsf),
396 le32toh(ctxt_sta->dtim_time), dtim_offs);
398 ctxt_sta->is_assoc = htole32(1);
400 ctxt_sta->is_assoc = htole32(0);
403 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD | IWM_DEBUG_BEACON,
404 "%s: ni_intval: %d, bi_reciprocal: %d, dtim_interval: %d, dtim_reciprocal: %d\n",
407 iwm_mvm_reciprocal(ni->ni_intval),
408 ni->ni_intval * dtim_period,
409 iwm_mvm_reciprocal(ni->ni_intval * dtim_period));
411 ctxt_sta->bi = htole32(ni->ni_intval);
412 ctxt_sta->bi_reciprocal = htole32(iwm_mvm_reciprocal(ni->ni_intval));
413 ctxt_sta->dtim_interval = htole32(ni->ni_intval * dtim_period);
414 ctxt_sta->dtim_reciprocal =
415 htole32(iwm_mvm_reciprocal(ni->ni_intval * dtim_period));
417 /* 10 = CONN_MAX_LISTEN_INTERVAL */
418 ctxt_sta->listen_interval = htole32(10);
419 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_CMD | IWM_DEBUG_BEACON,
420 "%s: associd=%d\n", __func__, IEEE80211_AID(ni->ni_associd));
421 ctxt_sta->assoc_id = htole32(IEEE80211_AID(ni->ni_associd));
425 iwm_mvm_mac_ctxt_cmd_station(struct iwm_softc *sc, struct ieee80211vap *vap,
428 struct ieee80211_node *ni = vap->iv_bss;
429 struct iwm_node *in = (struct iwm_node *) ni;
430 struct iwm_mac_ctx_cmd cmd;
432 IWM_DPRINTF(sc, IWM_DEBUG_RESET,
433 "%s: called; action=%d\n", __func__, action);
435 memset(&cmd, 0, sizeof(cmd));
437 /* Fill the common data for all mac context types */
438 iwm_mvm_mac_ctxt_cmd_common(sc, in, &cmd, action);
440 /* Allow beacons to pass through as long as we are not associated,or we
441 * do not have dtim period information */
442 if (!in->in_assoc || !vap->iv_dtim_period)
443 cmd.filter_flags |= htole32(IWM_MAC_FILTER_IN_BEACON);
445 cmd.filter_flags &= ~htole32(IWM_MAC_FILTER_IN_BEACON);
447 /* Fill the data specific for station mode */
448 iwm_mvm_mac_ctxt_cmd_fill_sta(sc, in,
449 &cmd.sta, action == IWM_FW_CTXT_ACTION_ADD);
451 return iwm_mvm_mac_ctxt_send_cmd(sc, &cmd);
455 iwm_mvm_mac_ctx_send(struct iwm_softc *sc, struct ieee80211vap *vap,
460 ret = iwm_mvm_mac_ctxt_cmd_station(sc, vap, action);
468 iwm_mvm_mac_ctxt_add(struct iwm_softc *sc, struct ieee80211vap *vap)
470 struct iwm_vap *iv = IWM_VAP(vap);
473 if (iv->is_uploaded != 0) {
474 device_printf(sc->sc_dev, "%s: called; uploaded != 0\n",
479 ret = iwm_mvm_mac_ctx_send(sc, vap, IWM_FW_CTXT_ACTION_ADD);
487 iwm_mvm_mac_ctxt_changed(struct iwm_softc *sc, struct ieee80211vap *vap)
489 struct iwm_vap *iv = IWM_VAP(vap);
492 if (iv->is_uploaded == 0) {
493 device_printf(sc->sc_dev, "%s: called; uploaded = 0\n",
497 ret = iwm_mvm_mac_ctx_send(sc, vap, IWM_FW_CTXT_ACTION_MODIFY);
505 iwm_mvm_mac_ctxt_remove(struct iwm_softc *sc, struct iwm_node *in)
507 struct iwm_mac_ctx_cmd cmd;
510 if (!in->in_uploaded) {
511 device_printf(sc->sc_dev,
512 "attempt to remove !uploaded node %p", in);
516 memset(&cmd, 0, sizeof(cmd));
518 cmd.id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(IWM_DEFAULT_MACID,
520 cmd.action = htole32(IWM_FW_CTXT_ACTION_REMOVE);
522 ret = iwm_mvm_send_cmd_pdu(sc,
523 IWM_MAC_CONTEXT_CMD, IWM_CMD_SYNC, sizeof(cmd), &cmd);
525 device_printf(sc->sc_dev,
526 "Failed to remove MAC context: %d\n", ret);