2 * Copyright (c) 2014 genua mbh <info@genua.de>
3 * Copyright (c) 2014 Fixup Software Ltd.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 * Based on BSD-licensed source modules in the Linux iwlwifi driver,
20 * which were used as the reference documentation for this implementation.
22 * Driver version we are currently based off of is
23 * Linux 4.7.3 (tag id d7f6728f57e3ecbb7ef34eb7d9f564d514775d75)
25 ******************************************************************************
27 * This file is provided under a dual BSD/GPLv2 license. When using or
28 * redistributing this file, you may do so under either license.
32 * Copyright(c) 2013 - 2014 Intel Corporation. All rights reserved.
33 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
35 * This program is free software; you can redistribute it and/or modify
36 * it under the terms of version 2 of the GNU General Public License as
37 * published by the Free Software Foundation.
39 * This program is distributed in the hope that it will be useful, but
40 * WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 * General Public License for more details.
44 * You should have received a copy of the GNU General Public License
45 * along with this program; if not, write to the Free Software
46 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
49 * The full GNU General Public License is included in this distribution
50 * in the file called COPYING.
52 * Contact Information:
53 * Intel Linux Wireless <linuxwifi@intel.com>
54 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
58 * Copyright(c) 2013 - 2014 Intel Corporation. All rights reserved.
59 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
60 * All rights reserved.
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions
66 * * Redistributions of source code must retain the above copyright
67 * notice, this list of conditions and the following disclaimer.
68 * * Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
72 * * Neither the name Intel Corporation nor the names of its
73 * contributors may be used to endorse or promote products derived
74 * from this software without specific prior written permission.
76 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
77 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
78 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
79 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
80 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
81 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
82 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
83 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
84 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
85 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
86 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
88 *****************************************************************************/
90 #include <sys/cdefs.h>
91 __FBSDID("$FreeBSD$");
96 #include <sys/param.h>
99 #include <sys/endian.h>
100 #include <sys/firmware.h>
101 #include <sys/kernel.h>
102 #include <sys/malloc.h>
103 #include <sys/mbuf.h>
104 #include <sys/mutex.h>
105 #include <sys/module.h>
106 #include <sys/proc.h>
107 #include <sys/rman.h>
108 #include <sys/socket.h>
109 #include <sys/sockio.h>
110 #include <sys/sysctl.h>
111 #include <sys/linker.h>
113 #include <machine/bus.h>
114 #include <machine/endian.h>
115 #include <machine/resource.h>
118 #include <net/if_var.h>
119 #include <net/if_arp.h>
120 #include <net/if_dl.h>
121 #include <net/if_media.h>
122 #include <net/if_types.h>
125 #include <netinet/in.h>
126 #include <netinet/in_systm.h>
127 #include <netinet/if_ether.h>
128 #include <netinet/ip.h>
130 #include <net80211/ieee80211_var.h>
131 #include <net80211/ieee80211_regdomain.h>
132 #include <net80211/ieee80211_ratectl.h>
133 #include <net80211/ieee80211_radiotap.h>
135 #include <dev/iwm/if_iwmreg.h>
136 #include <dev/iwm/if_iwmvar.h>
137 #include <dev/iwm/if_iwm_config.h>
138 #include <dev/iwm/if_iwm_debug.h>
139 #include <dev/iwm/if_iwm_util.h>
140 #include <dev/iwm/if_iwm_sf.h>
143 * Aging and idle timeouts for the different possible scenarios
144 * in default configuration
146 static const uint32_t
147 sf_full_timeout_def[IWM_SF_NUM_SCENARIO][IWM_SF_NUM_TIMEOUT_TYPES] = {
149 htole32(IWM_SF_SINGLE_UNICAST_AGING_TIMER_DEF),
150 htole32(IWM_SF_SINGLE_UNICAST_IDLE_TIMER_DEF)
153 htole32(IWM_SF_AGG_UNICAST_AGING_TIMER_DEF),
154 htole32(IWM_SF_AGG_UNICAST_IDLE_TIMER_DEF)
157 htole32(IWM_SF_MCAST_AGING_TIMER_DEF),
158 htole32(IWM_SF_MCAST_IDLE_TIMER_DEF)
161 htole32(IWM_SF_BA_AGING_TIMER_DEF),
162 htole32(IWM_SF_BA_IDLE_TIMER_DEF)
165 htole32(IWM_SF_TX_RE_AGING_TIMER_DEF),
166 htole32(IWM_SF_TX_RE_IDLE_TIMER_DEF)
171 * Aging and idle timeouts for the different possible scenarios
172 * in single BSS MAC configuration.
174 static const uint32_t
175 sf_full_timeout[IWM_SF_NUM_SCENARIO][IWM_SF_NUM_TIMEOUT_TYPES] = {
177 htole32(IWM_SF_SINGLE_UNICAST_AGING_TIMER),
178 htole32(IWM_SF_SINGLE_UNICAST_IDLE_TIMER)
181 htole32(IWM_SF_AGG_UNICAST_AGING_TIMER),
182 htole32(IWM_SF_AGG_UNICAST_IDLE_TIMER)
185 htole32(IWM_SF_MCAST_AGING_TIMER),
186 htole32(IWM_SF_MCAST_IDLE_TIMER)
189 htole32(IWM_SF_BA_AGING_TIMER),
190 htole32(IWM_SF_BA_IDLE_TIMER)
193 htole32(IWM_SF_TX_RE_AGING_TIMER),
194 htole32(IWM_SF_TX_RE_IDLE_TIMER)
199 iwm_fill_sf_command(struct iwm_softc *sc, struct iwm_sf_cfg_cmd *sf_cmd,
200 struct ieee80211_node *ni)
204 sf_cmd->watermark[IWM_SF_LONG_DELAY_ON] = htole32(IWM_SF_W_MARK_SCAN);
207 * If we are in association flow - check antenna configuration
208 * capabilities of the AP station, and choose the watermark accordingly.
211 if (ni->ni_flags & IEEE80211_NODE_HT) {
212 watermark = IWM_SF_W_MARK_SISO;
214 watermark = IWM_SF_W_MARK_LEGACY;
216 /* default watermark value for unassociated mode. */
218 watermark = IWM_SF_W_MARK_MIMO2;
220 sf_cmd->watermark[IWM_SF_FULL_ON] = htole32(watermark);
222 for (i = 0; i < IWM_SF_NUM_SCENARIO; i++) {
223 for (j = 0; j < IWM_SF_NUM_TIMEOUT_TYPES; j++) {
224 sf_cmd->long_delay_timeouts[i][j] =
225 htole32(IWM_SF_LONG_DELAY_AGING_TIMER);
230 _Static_assert(sizeof(sf_full_timeout) == sizeof(uint32_t) *
231 IWM_SF_NUM_SCENARIO * IWM_SF_NUM_TIMEOUT_TYPES,
232 "sf_full_timeout has wrong size");
234 memcpy(sf_cmd->full_on_timeouts, sf_full_timeout,
235 sizeof(sf_full_timeout));
237 _Static_assert(sizeof(sf_full_timeout_def) == sizeof(uint32_t) *
238 IWM_SF_NUM_SCENARIO * IWM_SF_NUM_TIMEOUT_TYPES,
239 "sf_full_timeout_def has wrong size");
241 memcpy(sf_cmd->full_on_timeouts, sf_full_timeout_def,
242 sizeof(sf_full_timeout_def));
247 iwm_sf_config(struct iwm_softc *sc, struct ieee80211_node *ni,
248 enum iwm_sf_state new_state)
250 struct iwm_sf_cfg_cmd sf_cmd = {
251 .state = htole32(new_state),
255 #ifdef notyet /* only relevant for sdio variants */
256 if (sc->cfg->disable_dummy_notification)
257 sf_cmd.state |= htole32(IWM_SF_CFG_DUMMY_NOTIF_OFF);
261 * If an associated AP sta changed its antenna configuration, the state
262 * will remain FULL_ON but SF parameters need to be reconsidered.
264 if (new_state != IWM_SF_FULL_ON && sc->sf_state == new_state)
269 iwm_fill_sf_command(sc, &sf_cmd, NULL);
272 iwm_fill_sf_command(sc, &sf_cmd, ni);
274 case IWM_SF_INIT_OFF:
275 iwm_fill_sf_command(sc, &sf_cmd, NULL);
278 device_printf(sc->sc_dev,
279 "Invalid state: %d. not sending Smart Fifo cmd\n",
284 ret = iwm_send_cmd_pdu(sc, IWM_REPLY_SF_CFG_CMD, IWM_CMD_ASYNC,
285 sizeof(sf_cmd), &sf_cmd);
287 sc->sf_state = new_state;
294 * Count bound interfaces that are not to be removed, ignoring p2p devices,
295 * and set new state accordingly.
298 iwm_sf_update(struct iwm_softc *sc, struct ieee80211vap *changed_vif,
299 boolean_t remove_vif)
301 enum iwm_sf_state new_state;
302 struct ieee80211_node *ni = NULL;
303 int num_active_macs = 0;
305 /* If changed_vif exists and is not to be removed, add to the count */
306 if (changed_vif && !remove_vif)
309 switch (num_active_macs) {
311 /* If there are no active macs - change state to SF_INIT_OFF */
312 new_state = IWM_SF_INIT_OFF;
317 ni = changed_vif->iv_bss;
318 if (ni != NULL && IWM_NODE(ni)->in_assoc &&
319 changed_vif->iv_dtim_period) {
320 new_state = IWM_SF_FULL_ON;
322 new_state = IWM_SF_INIT_OFF;
326 /* If there are multiple active macs - change to SF_UNINIT */
327 new_state = IWM_SF_UNINIT;
329 return iwm_sf_config(sc, ni, new_state);