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 #include <sys/cdefs.h>
90 __FBSDID("$FreeBSD$");
91
92 #include "opt_wlan.h"
93 #include "opt_iwm.h"
94
95 #include <sys/param.h>
96 #include <sys/bus.h>
97 #include <sys/conf.h>
98 #include <sys/endian.h>
99 #include <sys/firmware.h>
100 #include <sys/kernel.h>
101 #include <sys/malloc.h>
102 #include <sys/mbuf.h>
103 #include <sys/mutex.h>
104 #include <sys/module.h>
105 #include <sys/proc.h>
106 #include <sys/rman.h>
107 #include <sys/socket.h>
108 #include <sys/sockio.h>
109 #include <sys/sysctl.h>
110 #include <sys/linker.h>
111
112 #include <machine/bus.h>
113 #include <machine/endian.h>
114 #include <machine/resource.h>
115
116 #include <dev/pci/pcivar.h>
117 #include <dev/pci/pcireg.h>
118
119 #include <net/bpf.h>
120
121 #include <net/if.h>
122 #include <net/if_var.h>
123 #include <net/if_arp.h>
124 #include <net/if_dl.h>
125 #include <net/if_media.h>
126 #include <net/if_types.h>
127
128 #include <netinet/in.h>
129 #include <netinet/in_systm.h>
130 #include <netinet/if_ether.h>
131 #include <netinet/ip.h>
132
133 #include <net80211/ieee80211_var.h>
134 #include <net80211/ieee80211_regdomain.h>
135 #include <net80211/ieee80211_ratectl.h>
136 #include <net80211/ieee80211_radiotap.h>
137
138 #include <dev/iwm/if_iwmreg.h>
139 #include <dev/iwm/if_iwmvar.h>
140 #include <dev/iwm/if_iwm_debug.h>
141 #include <dev/iwm/if_iwm_constants.h>
142 #include <dev/iwm/if_iwm_util.h>
143 #include <dev/iwm/if_iwm_power.h>
144
145 static int iwm_power_scheme = IWM_POWER_SCHEME_BPS;
146
147 TUNABLE_INT("hw.iwm.power_scheme", &iwm_power_scheme);
148
149 /*
150 * BEGIN mvm/power.c
151 */
152
153 #define IWM_POWER_KEEP_ALIVE_PERIOD_SEC 25
154
155 static int
iwm_mvm_beacon_filter_send_cmd(struct iwm_softc * sc,struct iwm_beacon_filter_cmd * cmd)156 iwm_mvm_beacon_filter_send_cmd(struct iwm_softc *sc,
157 struct iwm_beacon_filter_cmd *cmd)
158 {
159 int ret;
160
161 ret = iwm_mvm_send_cmd_pdu(sc, IWM_REPLY_BEACON_FILTERING_CMD,
162 0, sizeof(struct iwm_beacon_filter_cmd), cmd);
163
164 if (!ret) {
165 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
166 "ba_enable_beacon_abort is: %d\n",
167 le32toh(cmd->ba_enable_beacon_abort));
168 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
169 "ba_escape_timer is: %d\n",
170 le32toh(cmd->ba_escape_timer));
171 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
172 "bf_debug_flag is: %d\n",
173 le32toh(cmd->bf_debug_flag));
174 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
175 "bf_enable_beacon_filter is: %d\n",
176 le32toh(cmd->bf_enable_beacon_filter));
177 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
178 "bf_energy_delta is: %d\n",
179 le32toh(cmd->bf_energy_delta));
180 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
181 "bf_escape_timer is: %d\n",
182 le32toh(cmd->bf_escape_timer));
183 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
184 "bf_roaming_energy_delta is: %d\n",
185 le32toh(cmd->bf_roaming_energy_delta));
186 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
187 "bf_roaming_state is: %d\n",
188 le32toh(cmd->bf_roaming_state));
189 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
190 "bf_temp_threshold is: %d\n",
191 le32toh(cmd->bf_temp_threshold));
192 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
193 "bf_temp_fast_filter is: %d\n",
194 le32toh(cmd->bf_temp_fast_filter));
195 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
196 "bf_temp_slow_filter is: %d\n",
197 le32toh(cmd->bf_temp_slow_filter));
198 }
199 return ret;
200 }
201
202 static void
iwm_mvm_beacon_filter_set_cqm_params(struct iwm_softc * sc,struct iwm_node * in,struct iwm_beacon_filter_cmd * cmd)203 iwm_mvm_beacon_filter_set_cqm_params(struct iwm_softc *sc,
204 struct iwm_node *in, struct iwm_beacon_filter_cmd *cmd)
205 {
206 cmd->ba_enable_beacon_abort = htole32(sc->sc_bf.ba_enabled);
207 }
208
209 static void
iwm_mvm_power_log(struct iwm_softc * sc,struct iwm_mac_power_cmd * cmd)210 iwm_mvm_power_log(struct iwm_softc *sc, struct iwm_mac_power_cmd *cmd)
211 {
212 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
213 "Sending power table command on mac id 0x%X for "
214 "power level %d, flags = 0x%X\n",
215 cmd->id_and_color, IWM_POWER_SCHEME_CAM, le16toh(cmd->flags));
216 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
217 "Keep alive = %u sec\n", le16toh(cmd->keep_alive_seconds));
218
219 if (!(cmd->flags & htole16(IWM_POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK))) {
220 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
221 "Disable power management\n");
222 return;
223 }
224
225 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
226 "Rx timeout = %u usec\n", le32toh(cmd->rx_data_timeout));
227 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
228 "Tx timeout = %u usec\n", le32toh(cmd->tx_data_timeout));
229 if (cmd->flags & htole16(IWM_POWER_FLAGS_SKIP_OVER_DTIM_MSK))
230 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
231 "DTIM periods to skip = %u\n", cmd->skip_dtim_periods);
232 }
233
234 static boolean_t
iwm_mvm_power_is_radar(struct iwm_softc * sc)235 iwm_mvm_power_is_radar(struct iwm_softc *sc)
236 {
237 struct ieee80211com *ic = &sc->sc_ic;
238 struct ieee80211_channel *chan;
239 boolean_t radar_detect = FALSE;
240
241 chan = ic->ic_bsschan;
242 if (chan == IEEE80211_CHAN_ANYC ||
243 (chan->ic_flags & IEEE80211_CHAN_DFS) != 0) {
244 radar_detect = TRUE;
245 }
246
247 return radar_detect;
248 }
249
250 static void
iwm_mvm_power_config_skip_dtim(struct iwm_softc * sc,struct iwm_mac_power_cmd * cmd)251 iwm_mvm_power_config_skip_dtim(struct iwm_softc *sc,
252 struct iwm_mac_power_cmd *cmd)
253 {
254 struct ieee80211com *ic = &sc->sc_ic;
255 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
256 int dtimper = vap->iv_dtim_period ?: 1;
257 int skip;
258
259 /* disable, in case we're supposed to override */
260 cmd->skip_dtim_periods = 0;
261 cmd->flags &= ~htole16(IWM_POWER_FLAGS_SKIP_OVER_DTIM_MSK);
262
263 if (iwm_mvm_power_is_radar(sc))
264 return;
265
266 if (dtimper >= 10)
267 return;
268
269 /* TODO: check that multicast wake lock is off */
270
271 if (iwm_power_scheme != IWM_POWER_SCHEME_LP)
272 return;
273 skip = 2;
274
275 /* the firmware really expects "look at every X DTIMs", so add 1 */
276 cmd->skip_dtim_periods = 1 + skip;
277 cmd->flags |= htole16(IWM_POWER_FLAGS_SKIP_OVER_DTIM_MSK);
278 }
279
280 static void
iwm_mvm_power_build_cmd(struct iwm_softc * sc,struct iwm_node * in,struct iwm_mac_power_cmd * cmd)281 iwm_mvm_power_build_cmd(struct iwm_softc *sc, struct iwm_node *in,
282 struct iwm_mac_power_cmd *cmd)
283 {
284 struct ieee80211_node *ni = &in->in_ni;
285 int dtimper, dtimper_msec;
286 int keep_alive;
287 struct ieee80211com *ic = &sc->sc_ic;
288 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
289 struct iwm_vap *ivp = IWM_VAP(vap);
290
291 cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id,
292 ivp->color));
293 dtimper = vap->iv_dtim_period ?: 1;
294
295 /*
296 * Regardless of power management state the driver must set
297 * keep alive period. FW will use it for sending keep alive NDPs
298 * immediately after association. Check that keep alive period
299 * is at least 3 * DTIM
300 */
301 dtimper_msec = dtimper * ni->ni_intval;
302 keep_alive
303 = imax(3 * dtimper_msec, 1000 * IWM_POWER_KEEP_ALIVE_PERIOD_SEC);
304 keep_alive = roundup(keep_alive, 1000) / 1000;
305 cmd->keep_alive_seconds = htole16(keep_alive);
306
307 if (sc->sc_ps_disabled)
308 return;
309
310 cmd->flags |= htole16(IWM_POWER_FLAGS_POWER_SAVE_ENA_MSK);
311 cmd->flags |= htole16(IWM_POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK);
312
313 iwm_mvm_power_config_skip_dtim(sc, cmd);
314
315 cmd->rx_data_timeout =
316 htole32(IWM_MVM_DEFAULT_PS_RX_DATA_TIMEOUT);
317 cmd->tx_data_timeout =
318 htole32(IWM_MVM_DEFAULT_PS_TX_DATA_TIMEOUT);
319 }
320
321 static int
iwm_mvm_power_send_cmd(struct iwm_softc * sc,struct iwm_node * in)322 iwm_mvm_power_send_cmd(struct iwm_softc *sc, struct iwm_node *in)
323 {
324 struct iwm_mac_power_cmd cmd = {};
325
326 iwm_mvm_power_build_cmd(sc, in, &cmd);
327 iwm_mvm_power_log(sc, &cmd);
328
329 return iwm_mvm_send_cmd_pdu(sc, IWM_MAC_PM_POWER_TABLE, 0,
330 sizeof(cmd), &cmd);
331 }
332
333 static int
_iwm_mvm_enable_beacon_filter(struct iwm_softc * sc,struct iwm_node * in,struct iwm_beacon_filter_cmd * cmd)334 _iwm_mvm_enable_beacon_filter(struct iwm_softc *sc, struct iwm_node *in,
335 struct iwm_beacon_filter_cmd *cmd)
336 {
337 int ret;
338
339 iwm_mvm_beacon_filter_set_cqm_params(sc, in, cmd);
340 ret = iwm_mvm_beacon_filter_send_cmd(sc, cmd);
341
342 if (!ret)
343 sc->sc_bf.bf_enabled = 1;
344
345 return ret;
346 }
347
348 int
iwm_mvm_enable_beacon_filter(struct iwm_softc * sc,struct iwm_node * in)349 iwm_mvm_enable_beacon_filter(struct iwm_softc *sc, struct iwm_node *in)
350 {
351 struct iwm_beacon_filter_cmd cmd = {
352 IWM_BF_CMD_CONFIG_DEFAULTS,
353 .bf_enable_beacon_filter = htole32(1),
354 };
355
356 return _iwm_mvm_enable_beacon_filter(sc, in, &cmd);
357 }
358
359 int
iwm_mvm_disable_beacon_filter(struct iwm_softc * sc)360 iwm_mvm_disable_beacon_filter(struct iwm_softc *sc)
361 {
362 struct iwm_beacon_filter_cmd cmd = {};
363 int ret;
364
365 ret = iwm_mvm_beacon_filter_send_cmd(sc, &cmd);
366 if (ret == 0)
367 sc->sc_bf.bf_enabled = 0;
368
369 return ret;
370 }
371
372 static int
iwm_mvm_power_set_ps(struct iwm_softc * sc)373 iwm_mvm_power_set_ps(struct iwm_softc *sc)
374 {
375 struct ieee80211vap *vap = TAILQ_FIRST(&sc->sc_ic.ic_vaps);
376 boolean_t disable_ps;
377 int ret;
378
379 /* disable PS if CAM */
380 disable_ps = (iwm_power_scheme == IWM_POWER_SCHEME_CAM);
381 /* ...or if any of the vifs require PS to be off */
382 if (vap != NULL && (vap->iv_flags & IEEE80211_F_PMGTON) == 0)
383 disable_ps = TRUE;
384
385 /* update device power state if it has changed */
386 if (sc->sc_ps_disabled != disable_ps) {
387 boolean_t old_ps_disabled = sc->sc_ps_disabled;
388
389 sc->sc_ps_disabled = disable_ps;
390 ret = iwm_mvm_power_update_device(sc);
391 if (ret) {
392 sc->sc_ps_disabled = old_ps_disabled;
393 return ret;
394 }
395 }
396
397 return 0;
398 }
399
400 static int
iwm_mvm_power_set_ba(struct iwm_softc * sc,struct iwm_node * in)401 iwm_mvm_power_set_ba(struct iwm_softc *sc, struct iwm_node *in)
402 {
403 struct iwm_beacon_filter_cmd cmd = {
404 IWM_BF_CMD_CONFIG_DEFAULTS,
405 .bf_enable_beacon_filter = htole32(1),
406 };
407
408 if (!sc->sc_bf.bf_enabled)
409 return 0;
410
411 sc->sc_bf.ba_enabled = !sc->sc_ps_disabled;
412
413 return _iwm_mvm_enable_beacon_filter(sc, in, &cmd);
414 }
415
416 int
iwm_mvm_power_update_ps(struct iwm_softc * sc)417 iwm_mvm_power_update_ps(struct iwm_softc *sc)
418 {
419 struct ieee80211vap *vap = TAILQ_FIRST(&sc->sc_ic.ic_vaps);
420 int ret;
421
422 ret = iwm_mvm_power_set_ps(sc);
423 if (ret)
424 return ret;
425
426 if (vap != NULL)
427 return iwm_mvm_power_set_ba(sc, IWM_NODE(vap->iv_bss));
428
429 return 0;
430 }
431
432 int
iwm_mvm_power_update_mac(struct iwm_softc * sc)433 iwm_mvm_power_update_mac(struct iwm_softc *sc)
434 {
435 struct ieee80211vap *vap = TAILQ_FIRST(&sc->sc_ic.ic_vaps);
436 int ret;
437
438 ret = iwm_mvm_power_set_ps(sc);
439 if (ret)
440 return ret;
441
442 if (vap != NULL) {
443 ret = iwm_mvm_power_send_cmd(sc, IWM_NODE(vap->iv_bss));
444 if (ret)
445 return ret;
446 }
447
448 if (vap != NULL)
449 return iwm_mvm_power_set_ba(sc, IWM_NODE(vap->iv_bss));
450
451 return 0;
452 }
453
454 int
iwm_mvm_power_update_device(struct iwm_softc * sc)455 iwm_mvm_power_update_device(struct iwm_softc *sc)
456 {
457 struct iwm_device_power_cmd cmd = {
458 .flags = 0,
459 };
460
461 if (iwm_power_scheme == IWM_POWER_SCHEME_CAM)
462 sc->sc_ps_disabled = TRUE;
463
464 if (!sc->sc_ps_disabled)
465 cmd.flags |= htole16(IWM_DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK);
466
467 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
468 "Sending device power command with flags = 0x%X\n", cmd.flags);
469
470 return iwm_mvm_send_cmd_pdu(sc,
471 IWM_POWER_TABLE_CMD, 0, sizeof(cmd), &cmd);
472 }
473