sys/dev/iwm/if_iwm_sta.c

   1 /*-
   2  * Based on BSD-licensed source modules in the Linux iwlwifi driver,
   3  * which were used as the reference documentation for this implementation.
   4  *
   5  * Driver version we are currently based off of is
   6  * Linux 4.7.3 (tag id d7f6728f57e3ecbb7ef34eb7d9f564d514775d75)
   7  *
   8  ***********************************************************************
   9  *
  10  * This file is provided under a dual BSD/GPLv2 license.  When using or
  11  * redistributing this file, you may do so under either license.
  12  *
  13  * GPL LICENSE SUMMARY
  14  *
  15  * Copyright(c) 2012 - 2015 Intel Corporation. All rights reserved.
  16  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  17  * Copyright(c) 2016 Intel Deutschland GmbH
  18  *
  19  * This program is free software; you can redistribute it and/or modify
  20  * it under the terms of version 2 of the GNU General Public License as
  21  * published by the Free Software Foundation.
  22  *
  23  * This program is distributed in the hope that it will be useful, but
  24  * WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  26  * General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program; if not, write to the Free Software
  30  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  31  * USA
  32  *
  33  * The full GNU General Public License is included in this distribution
  34  * in the file called COPYING.
  35  *
  36  * Contact Information:
  37  *  Intel Linux Wireless <linuxwifi@intel.com>
  38  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  39  *
  40  * BSD LICENSE
  41  *
  42  * Copyright(c) 2012 - 2015 Intel Corporation. All rights reserved.
  43  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  44  * Copyright(c) 2016 Intel Deutschland GmbH
  45  * All rights reserved.
  46  *
  47  * Redistribution and use in source and binary forms, with or without
  48  * modification, are permitted provided that the following conditions
  49  * are met:
  50  *
  51  *  * Redistributions of source code must retain the above copyright
  52  *    notice, this list of conditions and the following disclaimer.
  53  *  * Redistributions in binary form must reproduce the above copyright
  54  *    notice, this list of conditions and the following disclaimer in
  55  *    the documentation and/or other materials provided with the
  56  *    distribution.
  57  *  * Neither the name Intel Corporation nor the names of its
  58  *    contributors may be used to endorse or promote products derived
  59  *    from this software without specific prior written permission.
  60  *
  61  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  62  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  63  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  64  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  65  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  66  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  67  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  68  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  69  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  70  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  71  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  72  *
  73  *****************************************************************************/
  74
  75 #include <sys/cdefs.h>
  76 __FBSDID("$FreeBSD$");
  77
  78 #include "opt_wlan.h"
  79 #include "opt_iwm.h"
  80
  81 #include <sys/param.h>
  82 #include <sys/bus.h>
  83 #include <sys/conf.h>
  84 #include <sys/endian.h>
  85 #include <sys/firmware.h>
  86 #include <sys/kernel.h>
  87 #include <sys/malloc.h>
  88 #include <sys/mbuf.h>
  89 #include <sys/mutex.h>
  90 #include <sys/module.h>
  91 #include <sys/proc.h>
  92 #include <sys/rman.h>
  93 #include <sys/socket.h>
  94 #include <sys/sockio.h>
  95 #include <sys/sysctl.h>
  96 #include <sys/linker.h>
  97
  98 #include <machine/bus.h>
  99 #include <machine/endian.h>
 100 #include <machine/resource.h>
 101
 102 #include <dev/pci/pcivar.h>
 103 #include <dev/pci/pcireg.h>
 104
 105 #include <net/bpf.h>
 106
 107 #include <net/if.h>
 108 #include <net/if_var.h>
 109 #include <net/if_arp.h>
 110 #include <net/if_dl.h>
 111 #include <net/if_media.h>
 112 #include <net/if_types.h>
 113
 114 #include <netinet/in.h>
 115 #include <netinet/in_systm.h>
 116 #include <netinet/if_ether.h>
 117 #include <netinet/ip.h>
 118
 119 #include <net80211/ieee80211_var.h>
 120 #include <net80211/ieee80211_regdomain.h>
 121 #include <net80211/ieee80211_ratectl.h>
 122 #include <net80211/ieee80211_radiotap.h>
 123
 124 #include <dev/iwm/if_iwmreg.h>
 125 #include <dev/iwm/if_iwmvar.h>
 126 #include <dev/iwm/if_iwm_config.h>
 127 #include <dev/iwm/if_iwm_debug.h>
 128 #include <dev/iwm/if_iwm_constants.h>
 129 #include <dev/iwm/if_iwm_util.h>
 130 #include <dev/iwm/if_iwm_mac_ctxt.h>
 131 #include <dev/iwm/if_iwm_sta.h>
 132
 133 /*
 134  * New version of ADD_STA_sta command added new fields at the end of the
 135  * structure, so sending the size of the relevant API's structure is enough to
 136  * support both API versions.
 137  */
 138 static inline int
 139 iwm_add_sta_cmd_size(struct iwm_softc *sc)
 140 {
 141         return sc->cfg->mqrx_supported ? sizeof(struct iwm_add_sta_cmd) :
 142             sizeof(struct iwm_add_sta_cmd_v7);
 143 }
 144
 145 /* send station add/update command to firmware */
 146 int
 147 iwm_sta_send_to_fw(struct iwm_softc *sc, struct iwm_node *in,
 148         boolean_t update)
 149 {
 150         struct iwm_vap *ivp = IWM_VAP(in->in_ni.ni_vap);
 151         struct iwm_add_sta_cmd add_sta_cmd = {
 152                 .sta_id = IWM_STATION_ID,
 153                 .mac_id_n_color =
 154                     htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)),
 155                 .add_modify = update ? 1 : 0,
 156                 .station_flags_msk = htole32(IWM_STA_FLG_FAT_EN_MSK |
 157                                              IWM_STA_FLG_MIMO_EN_MSK),
 158                 .tid_disable_tx = htole16(0xffff),
 159         };
 160         int ret;
 161         uint32_t status;
 162         uint32_t agg_size = 0, mpdu_dens = 0;
 163
 164         if (!update) {
 165                 int ac;
 166                 for (ac = 0; ac < WME_NUM_AC; ac++) {
 167                         add_sta_cmd.tfd_queue_msk |=
 168                             htole32(1 << iwm_ac_to_tx_fifo[ac]);
 169                 }
 170                 IEEE80211_ADDR_COPY(&add_sta_cmd.addr, in->in_ni.ni_bssid);
 171         }
 172
 173         add_sta_cmd.station_flags |=
 174                 htole32(agg_size << IWM_STA_FLG_MAX_AGG_SIZE_SHIFT);
 175         add_sta_cmd.station_flags |=
 176                 htole32(mpdu_dens << IWM_STA_FLG_AGG_MPDU_DENS_SHIFT);
 177
 178         status = IWM_ADD_STA_SUCCESS;
 179         ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 180                                           iwm_add_sta_cmd_size(sc),
 181                                           &add_sta_cmd, &status);
 182         if (ret)
 183                 return ret;
 184
 185         switch (status & IWM_ADD_STA_STATUS_MASK) {
 186         case IWM_ADD_STA_SUCCESS:
 187                 IWM_DPRINTF(sc, IWM_DEBUG_NODE, "IWM_ADD_STA PASSED\n");
 188                 break;
 189         default:
 190                 ret = EIO;
 191                 device_printf(sc->sc_dev, "IWM_ADD_STA failed\n");
 192                 break;
 193         }
 194
 195         return ret;
 196 }
 197
 198 int
 199 iwm_add_sta(struct iwm_softc *sc, struct iwm_node *in)
 200 {
 201         return iwm_sta_send_to_fw(sc, in, FALSE);
 202 }
 203
 204 int
 205 iwm_update_sta(struct iwm_softc *sc, struct iwm_node *in)
 206 {
 207         return iwm_sta_send_to_fw(sc, in, TRUE);
 208 }
 209
 210 int
 211 iwm_drain_sta(struct iwm_softc *sc, struct iwm_vap *ivp, boolean_t drain)
 212 {
 213         struct iwm_add_sta_cmd cmd = {};
 214         int ret;
 215         uint32_t status;
 216
 217         cmd.mac_id_n_color =
 218             htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color));
 219         cmd.sta_id = IWM_STATION_ID;
 220         cmd.add_modify = IWM_STA_MODE_MODIFY;
 221         cmd.station_flags = drain ? htole32(IWM_STA_FLG_DRAIN_FLOW) : 0;
 222         cmd.station_flags_msk = htole32(IWM_STA_FLG_DRAIN_FLOW);
 223
 224         status = IWM_ADD_STA_SUCCESS;
 225         ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 226                                           iwm_add_sta_cmd_size(sc),
 227                                           &cmd, &status);
 228         if (ret)
 229                 return ret;
 230
 231         switch (status & IWM_ADD_STA_STATUS_MASK) {
 232         case IWM_ADD_STA_SUCCESS:
 233                 IWM_DPRINTF(sc, IWM_DEBUG_NODE,
 234                     "Frames for staid %d will drained in fw\n", IWM_STATION_ID);
 235                 break;
 236         default:
 237                 ret = EIO;
 238                 device_printf(sc->sc_dev,
 239                     "Couldn't drain frames for staid %d\n", IWM_STATION_ID);
 240                 break;
 241         }
 242
 243         return ret;
 244 }
 245
 246 /*
 247  * Remove a station from the FW table. Before sending the command to remove
 248  * the station validate that the station is indeed known to the driver (sanity
 249  * only).
 250  */
 251 static int
 252 iwm_rm_sta_common(struct iwm_softc *sc)
 253 {
 254         struct iwm_rm_sta_cmd rm_sta_cmd = {
 255                 .sta_id = IWM_STATION_ID,
 256         };
 257         int ret;
 258
 259         ret = iwm_send_cmd_pdu(sc, IWM_REMOVE_STA, 0,
 260                                    sizeof(rm_sta_cmd), &rm_sta_cmd);
 261         if (ret) {
 262                 device_printf(sc->sc_dev,
 263                     "Failed to remove station. Id=%d\n", IWM_STATION_ID);
 264                 return ret;
 265         }
 266
 267         return 0;
 268 }
 269
 270 int
 271 iwm_rm_sta(struct iwm_softc *sc, struct ieee80211vap *vap,
 272         boolean_t is_assoc)
 273 {
 274         uint32_t tfd_queue_msk = 0;
 275         int ret;
 276         int ac;
 277
 278         ret = iwm_drain_sta(sc, IWM_VAP(vap), TRUE);
 279         if (ret)
 280                 return ret;
 281         for (ac = 0; ac < WME_NUM_AC; ac++) {
 282                 tfd_queue_msk |= htole32(1 << iwm_ac_to_tx_fifo[ac]);
 283         }
 284         ret = iwm_flush_tx_path(sc, tfd_queue_msk, IWM_CMD_SYNC);
 285         if (ret)
 286                 return ret;
 287 #ifdef notyet /* function not yet implemented */
 288         ret = iwl_trans_wait_tx_queue_empty(mvm->trans,
 289                                             mvm_sta->tfd_queue_msk);
 290         if (ret)
 291                 return ret;
 292 #endif
 293         ret = iwm_drain_sta(sc, IWM_VAP(vap), FALSE);
 294
 295         /* if we are associated - we can't remove the AP STA now */
 296         if (is_assoc)
 297                 return ret;
 298
 299         /* XXX wait until STA is drained */
 300
 301         ret = iwm_rm_sta_common(sc);
 302
 303         return ret;
 304 }
 305
 306 int
 307 iwm_rm_sta_id(struct iwm_softc *sc, struct ieee80211vap *vap)
 308 {
 309         /* XXX wait until STA is drained */
 310
 311         return iwm_rm_sta_common(sc);
 312 }
 313
 314 static int
 315 iwm_add_int_sta_common(struct iwm_softc *sc, struct iwm_int_sta *sta,
 316     const uint8_t *addr, uint16_t mac_id, uint16_t color)
 317 {
 318         struct iwm_add_sta_cmd cmd;
 319         int ret;
 320         uint32_t status;
 321
 322         memset(&cmd, 0, sizeof(cmd));
 323         cmd.sta_id = sta->sta_id;
 324         cmd.mac_id_n_color = htole32(IWM_FW_CMD_ID_AND_COLOR(mac_id, color));
 325         if (sta->sta_id == IWM_AUX_STA_ID && sc->cfg->mqrx_supported)
 326                 cmd.station_type = IWM_STA_AUX_ACTIVITY;
 327
 328         cmd.tfd_queue_msk = htole32(sta->tfd_queue_msk);
 329         cmd.tid_disable_tx = htole16(0xffff);
 330
 331         if (addr)
 332                 IEEE80211_ADDR_COPY(cmd.addr, addr);
 333
 334         ret = iwm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 335                                           iwm_add_sta_cmd_size(sc),
 336                                           &cmd, &status);
 337         if (ret)
 338                 return ret;
 339
 340         switch (status & IWM_ADD_STA_STATUS_MASK) {
 341         case IWM_ADD_STA_SUCCESS:
 342                 IWM_DPRINTF(sc, IWM_DEBUG_NODE, "Internal station added.\n");
 343                 return 0;
 344         default:
 345                 ret = EIO;
 346                 device_printf(sc->sc_dev,
 347                     "Add internal station failed, status=0x%x\n", status);
 348                 break;
 349         }
 350         return ret;
 351 }
 352
 353 int
 354 iwm_add_aux_sta(struct iwm_softc *sc)
 355 {
 356         int ret;
 357
 358         sc->sc_aux_sta.sta_id = IWM_AUX_STA_ID;
 359         sc->sc_aux_sta.tfd_queue_msk = (1 << IWM_AUX_QUEUE);
 360
 361         /* Map Aux queue to fifo - needs to happen before adding Aux station */
 362         ret = iwm_enable_txq(sc, IWM_AUX_STA_ID, IWM_AUX_QUEUE,
 363             IWM_TX_FIFO_MCAST);
 364         if (ret)
 365                 return ret;
 366
 367         ret = iwm_add_int_sta_common(sc, &sc->sc_aux_sta, NULL,
 368                                          IWM_MAC_INDEX_AUX, 0);
 369
 370         if (ret) {
 371                 memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
 372                 sc->sc_aux_sta.sta_id = IWM_STATION_COUNT;
 373         }
 374         return ret;
 375 }
 376
 377 void iwm_del_aux_sta(struct iwm_softc *sc)
 378 {
 379         memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
 380         sc->sc_aux_sta.sta_id = IWM_STATION_COUNT;
 381 }