sys/dev/iwm/if_iwm_power.c

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