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.
89 #include <sys/cdefs.h>
90 __FBSDID("$FreeBSD$");
95 #include <sys/param.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>
112 #include <machine/bus.h>
113 #include <machine/endian.h>
114 #include <machine/resource.h>
116 #include <dev/pci/pcivar.h>
117 #include <dev/pci/pcireg.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>
128 #include <netinet/in.h>
129 #include <netinet/in_systm.h>
130 #include <netinet/if_ether.h>
131 #include <netinet/ip.h>
133 #include <net80211/ieee80211_var.h>
134 #include <net80211/ieee80211_regdomain.h>
135 #include <net80211/ieee80211_ratectl.h>
136 #include <net80211/ieee80211_radiotap.h>
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>
145 static int iwm_power_scheme = IWM_POWER_SCHEME_BPS;
147 TUNABLE_INT("hw.iwm.power_scheme", &iwm_power_scheme);
153 #define IWM_POWER_KEEP_ALIVE_PERIOD_SEC 25
156 iwm_beacon_filter_send_cmd(struct iwm_softc *sc,
157 struct iwm_beacon_filter_cmd *cmd)
161 ret = iwm_send_cmd_pdu(sc, IWM_REPLY_BEACON_FILTERING_CMD,
162 0, sizeof(struct iwm_beacon_filter_cmd), cmd);
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));
203 iwm_beacon_filter_set_cqm_params(struct iwm_softc *sc,
204 struct iwm_vap *ivp, struct iwm_beacon_filter_cmd *cmd)
206 cmd->ba_enable_beacon_abort = htole32(sc->sc_bf.ba_enabled);
210 iwm_power_log(struct iwm_softc *sc, struct iwm_mac_power_cmd *cmd)
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, le16toh(cmd->flags));
216 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
217 "Keep alive = %u sec\n", le16toh(cmd->keep_alive_seconds));
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");
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);
235 iwm_power_is_radar(struct iwm_softc *sc)
237 struct ieee80211com *ic = &sc->sc_ic;
238 struct ieee80211_channel *chan;
239 boolean_t radar_detect = FALSE;
241 chan = ic->ic_bsschan;
242 if (chan == IEEE80211_CHAN_ANYC ||
243 (chan->ic_flags & IEEE80211_CHAN_DFS) != 0) {
251 iwm_power_config_skip_dtim(struct iwm_softc *sc,
252 struct iwm_mac_power_cmd *cmd)
254 struct ieee80211com *ic = &sc->sc_ic;
255 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
256 int dtimper = vap->iv_dtim_period ?: 1;
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);
263 if (iwm_power_is_radar(sc))
269 /* TODO: check that multicast wake lock is off */
271 if (iwm_power_scheme != IWM_POWER_SCHEME_LP)
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);
281 iwm_power_build_cmd(struct iwm_softc *sc, struct iwm_vap *ivp,
282 struct iwm_mac_power_cmd *cmd)
284 struct ieee80211vap *vap = &ivp->iv_vap;
285 struct ieee80211_node *ni = vap->iv_bss;
286 int dtimper, dtimper_msec;
288 boolean_t bss_conf_ps = FALSE;
290 cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id,
292 dtimper = vap->iv_dtim_period ?: 1;
295 * Regardless of power management state the driver must set
296 * keep alive period. FW will use it for sending keep alive NDPs
297 * immediately after association. Check that keep alive period
298 * is at least 3 * DTIM
300 dtimper_msec = dtimper * ni->ni_intval;
302 = imax(3 * dtimper_msec, 1000 * IWM_POWER_KEEP_ALIVE_PERIOD_SEC);
303 keep_alive = roundup(keep_alive, 1000) / 1000;
304 cmd->keep_alive_seconds = htole16(keep_alive);
306 if (sc->sc_ps_disabled)
309 cmd->flags |= htole16(IWM_POWER_FLAGS_POWER_SAVE_ENA_MSK);
311 if (IWM_NODE(ni)->in_assoc &&
312 (vap->iv_flags & IEEE80211_F_PMGTON) != 0) {
318 cmd->flags |= htole16(IWM_POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK);
320 iwm_power_config_skip_dtim(sc, cmd);
322 cmd->rx_data_timeout =
323 htole32(IWM_DEFAULT_PS_RX_DATA_TIMEOUT);
324 cmd->tx_data_timeout =
325 htole32(IWM_DEFAULT_PS_TX_DATA_TIMEOUT);
329 iwm_power_send_cmd(struct iwm_softc *sc, struct iwm_vap *ivp)
331 struct iwm_mac_power_cmd cmd = {};
333 iwm_power_build_cmd(sc, ivp, &cmd);
334 iwm_power_log(sc, &cmd);
336 return iwm_send_cmd_pdu(sc, IWM_MAC_PM_POWER_TABLE, 0,
341 _iwm_enable_beacon_filter(struct iwm_softc *sc, struct iwm_vap *ivp,
342 struct iwm_beacon_filter_cmd *cmd)
346 iwm_beacon_filter_set_cqm_params(sc, ivp, cmd);
347 ret = iwm_beacon_filter_send_cmd(sc, cmd);
350 sc->sc_bf.bf_enabled = 1;
356 iwm_enable_beacon_filter(struct iwm_softc *sc, struct iwm_vap *ivp)
358 struct iwm_beacon_filter_cmd cmd = {
359 IWM_BF_CMD_CONFIG_DEFAULTS,
360 .bf_enable_beacon_filter = htole32(1),
363 return _iwm_enable_beacon_filter(sc, ivp, &cmd);
367 iwm_disable_beacon_filter(struct iwm_softc *sc)
369 struct iwm_beacon_filter_cmd cmd = {};
372 ret = iwm_beacon_filter_send_cmd(sc, &cmd);
374 sc->sc_bf.bf_enabled = 0;
380 iwm_power_set_ps(struct iwm_softc *sc)
382 struct ieee80211vap *vap;
383 boolean_t disable_ps;
386 /* disable PS if CAM */
387 disable_ps = (iwm_power_scheme == IWM_POWER_SCHEME_CAM);
388 /* ...or if any of the vifs require PS to be off */
389 TAILQ_FOREACH(vap, &sc->sc_ic.ic_vaps, iv_next) {
390 struct iwm_vap *ivp = IWM_VAP(vap);
391 if (ivp->phy_ctxt != NULL && ivp->ps_disabled)
395 /* update device power state if it has changed */
396 if (sc->sc_ps_disabled != disable_ps) {
397 boolean_t old_ps_disabled = sc->sc_ps_disabled;
399 sc->sc_ps_disabled = disable_ps;
400 ret = iwm_power_update_device(sc);
402 sc->sc_ps_disabled = old_ps_disabled;
411 iwm_power_set_ba(struct iwm_softc *sc, struct iwm_vap *ivp)
413 struct iwm_beacon_filter_cmd cmd = {
414 IWM_BF_CMD_CONFIG_DEFAULTS,
415 .bf_enable_beacon_filter = htole32(1),
417 struct ieee80211vap *vap = &ivp->iv_vap;
418 struct ieee80211_node *ni = vap->iv_bss;
419 boolean_t bss_conf_ps = FALSE;
421 if (!sc->sc_bf.bf_enabled)
424 if (ni != NULL && IWM_NODE(ni)->in_assoc &&
425 (vap->iv_flags & IEEE80211_F_PMGTON) != 0) {
428 sc->sc_bf.ba_enabled = !sc->sc_ps_disabled && bss_conf_ps;
430 return _iwm_enable_beacon_filter(sc, ivp, &cmd);
434 iwm_power_update_ps(struct iwm_softc *sc)
436 struct ieee80211vap *vap = TAILQ_FIRST(&sc->sc_ic.ic_vaps);
439 ret = iwm_power_set_ps(sc);
444 return iwm_power_set_ba(sc, IWM_VAP(vap));
450 iwm_power_update_mac(struct iwm_softc *sc)
452 struct ieee80211vap *vap = TAILQ_FIRST(&sc->sc_ic.ic_vaps);
455 ret = iwm_power_set_ps(sc);
460 ret = iwm_power_send_cmd(sc, IWM_VAP(vap));
466 return iwm_power_set_ba(sc, IWM_VAP(vap));
472 iwm_power_update_device(struct iwm_softc *sc)
474 struct iwm_device_power_cmd cmd = {
478 if (iwm_power_scheme == IWM_POWER_SCHEME_CAM)
479 sc->sc_ps_disabled = TRUE;
481 if (!sc->sc_ps_disabled)
482 cmd.flags |= htole16(IWM_DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK);
484 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD,
485 "Sending device power command with flags = 0x%X\n", cmd.flags);
487 return iwm_send_cmd_pdu(sc,
488 IWM_POWER_TABLE_CMD, 0, sizeof(cmd), &cmd);