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 94 #include <sys/param.h> 95 #include <sys/bus.h> 96 #include <sys/conf.h> 97 #include <sys/endian.h> 98 #include <sys/firmware.h> 99 #include <sys/kernel.h> 100 #include <sys/malloc.h> 101 #include <sys/mbuf.h> 102 #include <sys/mutex.h> 103 #include <sys/module.h> 104 #include <sys/proc.h> 105 #include <sys/rman.h> 106 #include <sys/socket.h> 107 #include <sys/sockio.h> 108 #include <sys/sysctl.h> 109 #include <sys/linker.h> 110 111 #include <machine/bus.h> 112 #include <machine/endian.h> 113 #include <machine/resource.h> 114 115 #include <dev/pci/pcivar.h> 116 #include <dev/pci/pcireg.h> 117 118 #include <net/bpf.h> 119 120 #include <net/if.h> 121 #include <net/if_var.h> 122 #include <net/if_arp.h> 123 #include <net/if_dl.h> 124 #include <net/if_media.h> 125 #include <net/if_types.h> 126 127 #include <netinet/in.h> 128 #include <netinet/in_systm.h> 129 #include <netinet/if_ether.h> 130 #include <netinet/ip.h> 131 132 #include <net80211/ieee80211_var.h> 133 #include <net80211/ieee80211_regdomain.h> 134 #include <net80211/ieee80211_ratectl.h> 135 #include <net80211/ieee80211_radiotap.h> 136 137 #include <dev/iwm/if_iwmreg.h> 138 #include <dev/iwm/if_iwmvar.h> 139 #include <dev/iwm/if_iwm_debug.h> 140 #include <dev/iwm/if_iwm_util.h> 141 #include <dev/iwm/if_iwm_power.h> 142 143 /* 144 * BEGIN mvm/power.c 145 */ 146 147 #define IWM_POWER_KEEP_ALIVE_PERIOD_SEC 25 148 149 static int 150 iwm_mvm_beacon_filter_send_cmd(struct iwm_softc *sc, 151 struct iwm_beacon_filter_cmd *cmd) 152 { 153 int ret; 154 155 ret = iwm_mvm_send_cmd_pdu(sc, IWM_REPLY_BEACON_FILTERING_CMD, 156 IWM_CMD_SYNC, sizeof(struct iwm_beacon_filter_cmd), cmd); 157 158 if (!ret) { 159 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 160 "ba_enable_beacon_abort is: %d\n", 161 le32toh(cmd->ba_enable_beacon_abort)); 162 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 163 "ba_escape_timer is: %d\n", 164 le32toh(cmd->ba_escape_timer)); 165 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 166 "bf_debug_flag is: %d\n", 167 le32toh(cmd->bf_debug_flag)); 168 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 169 "bf_enable_beacon_filter is: %d\n", 170 le32toh(cmd->bf_enable_beacon_filter)); 171 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 172 "bf_energy_delta is: %d\n", 173 le32toh(cmd->bf_energy_delta)); 174 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 175 "bf_escape_timer is: %d\n", 176 le32toh(cmd->bf_escape_timer)); 177 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 178 "bf_roaming_energy_delta is: %d\n", 179 le32toh(cmd->bf_roaming_energy_delta)); 180 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 181 "bf_roaming_state is: %d\n", 182 le32toh(cmd->bf_roaming_state)); 183 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 184 "bf_temp_threshold is: %d\n", 185 le32toh(cmd->bf_temp_threshold)); 186 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 187 "bf_temp_fast_filter is: %d\n", 188 le32toh(cmd->bf_temp_fast_filter)); 189 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 190 "bf_temp_slow_filter is: %d\n", 191 le32toh(cmd->bf_temp_slow_filter)); 192 } 193 return ret; 194 } 195 196 static void 197 iwm_mvm_beacon_filter_set_cqm_params(struct iwm_softc *sc, 198 struct iwm_node *in, struct iwm_beacon_filter_cmd *cmd) 199 { 200 cmd->ba_enable_beacon_abort = htole32(sc->sc_bf.ba_enabled); 201 } 202 203 static int 204 iwm_mvm_update_beacon_abort(struct iwm_softc *sc, struct iwm_node *in, 205 int enable) 206 { 207 struct iwm_beacon_filter_cmd cmd = { 208 IWM_BF_CMD_CONFIG_DEFAULTS, 209 .bf_enable_beacon_filter = htole32(1), 210 .ba_enable_beacon_abort = htole32(enable), 211 }; 212 213 if (!sc->sc_bf.bf_enabled) 214 return 0; 215 216 sc->sc_bf.ba_enabled = enable; 217 iwm_mvm_beacon_filter_set_cqm_params(sc, in, &cmd); 218 return iwm_mvm_beacon_filter_send_cmd(sc, &cmd); 219 } 220 221 static void 222 iwm_mvm_power_log(struct iwm_softc *sc, struct iwm_mac_power_cmd *cmd) 223 { 224 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 225 "Sending power table command on mac id 0x%X for " 226 "power level %d, flags = 0x%X\n", 227 cmd->id_and_color, IWM_POWER_SCHEME_CAM, le16toh(cmd->flags)); 228 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 229 "Keep alive = %u sec\n", le16toh(cmd->keep_alive_seconds)); 230 231 if (!(cmd->flags & htole16(IWM_POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK))) { 232 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 233 "Disable power management\n"); 234 return; 235 } 236 KASSERT(0, ("unhandled power management")); 237 238 #if 0 239 DPRINTF(mvm, "Rx timeout = %u usec\n", 240 le32_to_cpu(cmd->rx_data_timeout)); 241 DPRINTF(mvm, "Tx timeout = %u usec\n", 242 le32_to_cpu(cmd->tx_data_timeout)); 243 if (cmd->flags & cpu_to_le16(IWM_POWER_FLAGS_SKIP_OVER_DTIM_MSK)) 244 DPRINTF(mvm, "DTIM periods to skip = %u\n", 245 cmd->skip_dtim_periods); 246 if (cmd->flags & cpu_to_le16(IWM_POWER_FLAGS_LPRX_ENA_MSK)) 247 DPRINTF(mvm, "LP RX RSSI threshold = %u\n", 248 cmd->lprx_rssi_threshold); 249 if (cmd->flags & cpu_to_le16(IWM_POWER_FLAGS_ADVANCE_PM_ENA_MSK)) { 250 DPRINTF(mvm, "uAPSD enabled\n"); 251 DPRINTF(mvm, "Rx timeout (uAPSD) = %u usec\n", 252 le32_to_cpu(cmd->rx_data_timeout_uapsd)); 253 DPRINTF(mvm, "Tx timeout (uAPSD) = %u usec\n", 254 le32_to_cpu(cmd->tx_data_timeout_uapsd)); 255 DPRINTF(mvm, "QNDP TID = %d\n", cmd->qndp_tid); 256 DPRINTF(mvm, "ACs flags = 0x%x\n", cmd->uapsd_ac_flags); 257 DPRINTF(mvm, "Max SP = %d\n", cmd->uapsd_max_sp); 258 } 259 #endif 260 } 261 262 static void 263 iwm_mvm_power_build_cmd(struct iwm_softc *sc, struct iwm_node *in, 264 struct iwm_mac_power_cmd *cmd) 265 { 266 struct ieee80211_node *ni = &in->in_ni; 267 int dtimper, dtimper_msec; 268 int keep_alive; 269 struct ieee80211com *ic = &sc->sc_ic; 270 struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps); 271 272 cmd->id_and_color = htole32(IWM_FW_CMD_ID_AND_COLOR(IWM_DEFAULT_MACID, 273 IWM_DEFAULT_COLOR)); 274 dtimper = vap->iv_dtim_period ?: 1; 275 276 /* 277 * Regardless of power management state the driver must set 278 * keep alive period. FW will use it for sending keep alive NDPs 279 * immediately after association. Check that keep alive period 280 * is at least 3 * DTIM 281 */ 282 dtimper_msec = dtimper * ni->ni_intval; 283 keep_alive 284 = MAX(3 * dtimper_msec, 1000 * IWM_POWER_KEEP_ALIVE_PERIOD_SEC); 285 keep_alive = roundup(keep_alive, 1000) / 1000; 286 cmd->keep_alive_seconds = htole16(keep_alive); 287 } 288 289 int 290 iwm_mvm_power_mac_update_mode(struct iwm_softc *sc, struct iwm_node *in) 291 { 292 int ret; 293 int ba_enable; 294 struct iwm_mac_power_cmd cmd; 295 296 memset(&cmd, 0, sizeof(cmd)); 297 298 iwm_mvm_power_build_cmd(sc, in, &cmd); 299 iwm_mvm_power_log(sc, &cmd); 300 301 if ((ret = iwm_mvm_send_cmd_pdu(sc, IWM_MAC_PM_POWER_TABLE, 302 IWM_CMD_SYNC, sizeof(cmd), &cmd)) != 0) 303 return ret; 304 305 ba_enable = !!(cmd.flags & 306 htole16(IWM_POWER_FLAGS_POWER_MANAGEMENT_ENA_MSK)); 307 return iwm_mvm_update_beacon_abort(sc, in, ba_enable); 308 } 309 310 int 311 iwm_mvm_power_update_device(struct iwm_softc *sc) 312 { 313 struct iwm_device_power_cmd cmd = { 314 .flags = htole16(IWM_DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK), 315 }; 316 317 if (!(sc->sc_capaflags & IWM_UCODE_TLV_FLAGS_DEVICE_PS_CMD)) 318 return 0; 319 320 cmd.flags |= htole16(IWM_DEVICE_POWER_FLAGS_CAM_MSK); 321 IWM_DPRINTF(sc, IWM_DEBUG_PWRSAVE | IWM_DEBUG_CMD, 322 "Sending device power command with flags = 0x%X\n", cmd.flags); 323 324 return iwm_mvm_send_cmd_pdu(sc, 325 IWM_POWER_TABLE_CMD, IWM_CMD_SYNC, sizeof(cmd), &cmd); 326 } 327 328 int 329 iwm_mvm_enable_beacon_filter(struct iwm_softc *sc, struct iwm_node *in) 330 { 331 struct iwm_beacon_filter_cmd cmd = { 332 IWM_BF_CMD_CONFIG_DEFAULTS, 333 .bf_enable_beacon_filter = htole32(1), 334 }; 335 int ret; 336 337 iwm_mvm_beacon_filter_set_cqm_params(sc, in, &cmd); 338 ret = iwm_mvm_beacon_filter_send_cmd(sc, &cmd); 339 340 if (ret == 0) 341 sc->sc_bf.bf_enabled = 1; 342 343 return ret; 344 } 345 346 int 347 iwm_mvm_disable_beacon_filter(struct iwm_softc *sc) 348 { 349 struct iwm_beacon_filter_cmd cmd; 350 int ret; 351 352 memset(&cmd, 0, sizeof(cmd)); 353 if ((sc->sc_capaflags & IWM_UCODE_TLV_FLAGS_BF_UPDATED) == 0) 354 return 0; 355 356 ret = iwm_mvm_beacon_filter_send_cmd(sc, &cmd); 357 if (ret == 0) 358 sc->sc_bf.bf_enabled = 0; 359 360 return ret; 361 } 362 363 #if 0 364 static int 365 iwm_mvm_update_beacon_filter(struct iwm_softc *sc, struct iwm_node *in) 366 { 367 if (!sc->sc_bf.bf_enabled) 368 return 0; 369 370 return iwm_mvm_enable_beacon_filter(sc, in); 371 } 372 #endif 373