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