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