sys/dev/netif/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/param.h>
  76 #include <sys/bus.h>
  77 #include <sys/endian.h>
  78 #include <sys/kernel.h>
  79 #include <sys/malloc.h>
  80
  81 #include <machine/endian.h>
  82
  83 #include <net/bpf.h>
  84
  85 #include <net/if.h>
  86 #include <net/if_var.h>
  87 #include <net/if_arp.h>
  88 #include <net/if_dl.h>
  89 #include <net/if_media.h>
  90 #include <net/if_types.h>
  91
  92 #include <netinet/in.h>
  93 #include <netinet/in_systm.h>
  94 #include <netinet/if_ether.h>
  95 #include <netinet/ip.h>
  96
  97 #include <netproto/802_11/ieee80211_var.h>
  98 #include <netproto/802_11/ieee80211_regdomain.h>
  99 #include <netproto/802_11/ieee80211_ratectl.h>
 100 #include <netproto/802_11/ieee80211_radiotap.h>
 101
 102 #include "if_iwmreg.h"
 103 #include "if_iwmvar.h"
 104 #include "if_iwm_config.h"
 105 #include "if_iwm_debug.h"
 106 #include "if_iwm_constants.h"
 107 #include "if_iwm_util.h"
 108 #include "if_iwm_mac_ctxt.h"
 109 #include "if_iwm_sta.h"
 110
 111 /*
 112  * New version of ADD_STA_sta command added new fields at the end of the
 113  * structure, so sending the size of the relevant API's structure is enough to
 114  * support both API versions.
 115  */
 116 static inline int
 117 iwm_mvm_add_sta_cmd_size(struct iwm_softc *sc)
 118 {
 119 #ifdef notyet
 120         return iwm_mvm_has_new_rx_api(mvm) ?
 121                 sizeof(struct iwm_mvm_add_sta_cmd) :
 122                 sizeof(struct iwm_mvm_add_sta_cmd_v7);
 123 #else
 124         return sizeof(struct iwm_mvm_add_sta_cmd);
 125 #endif
 126 }
 127
 128 /* send station add/update command to firmware */
 129 int
 130 iwm_mvm_sta_send_to_fw(struct iwm_softc *sc, struct iwm_node *in,
 131         boolean_t update)
 132 {
 133         struct iwm_vap *ivp = IWM_VAP(in->in_ni.ni_vap);
 134         struct iwm_mvm_add_sta_cmd add_sta_cmd = {
 135                 .sta_id = IWM_STATION_ID,
 136                 .mac_id_n_color =
 137                     htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color)),
 138                 .add_modify = update ? 1 : 0,
 139                 .station_flags_msk = htole32(IWM_STA_FLG_FAT_EN_MSK |
 140                                              IWM_STA_FLG_MIMO_EN_MSK),
 141                 .tid_disable_tx = htole16(0xffff),
 142         };
 143         int ret;
 144         uint32_t status;
 145         uint32_t agg_size = 0, mpdu_dens = 0;
 146
 147         if (!update) {
 148                 int ac;
 149                 for (ac = 0; ac < WME_NUM_AC; ac++) {
 150                         add_sta_cmd.tfd_queue_msk |=
 151                             htole32(1 << iwm_mvm_ac_to_tx_fifo[ac]);
 152                 }
 153                 IEEE80211_ADDR_COPY(&add_sta_cmd.addr, in->in_ni.ni_bssid);
 154         }
 155
 156         add_sta_cmd.station_flags |=
 157                 htole32(agg_size << IWM_STA_FLG_MAX_AGG_SIZE_SHIFT);
 158         add_sta_cmd.station_flags |=
 159                 htole32(mpdu_dens << IWM_STA_FLG_AGG_MPDU_DENS_SHIFT);
 160
 161         status = IWM_ADD_STA_SUCCESS;
 162         ret = iwm_mvm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 163                                           iwm_mvm_add_sta_cmd_size(sc),
 164                                           &add_sta_cmd, &status);
 165         if (ret)
 166                 return ret;
 167
 168         switch (status & IWM_ADD_STA_STATUS_MASK) {
 169         case IWM_ADD_STA_SUCCESS:
 170                 IWM_DPRINTF(sc, IWM_DEBUG_NODE, "IWM_ADD_STA PASSED\n");
 171                 break;
 172         default:
 173                 ret = EIO;
 174                 device_printf(sc->sc_dev, "IWM_ADD_STA failed\n");
 175                 break;
 176         }
 177
 178         return ret;
 179 }
 180
 181 int
 182 iwm_mvm_add_sta(struct iwm_softc *sc, struct iwm_node *in)
 183 {
 184         return iwm_mvm_sta_send_to_fw(sc, in, FALSE);
 185 }
 186
 187 int
 188 iwm_mvm_update_sta(struct iwm_softc *sc, struct iwm_node *in)
 189 {
 190         return iwm_mvm_sta_send_to_fw(sc, in, TRUE);
 191 }
 192
 193 int
 194 iwm_mvm_drain_sta(struct iwm_softc *sc, struct iwm_vap *ivp, boolean_t drain)
 195 {
 196         struct iwm_mvm_add_sta_cmd cmd = {};
 197         int ret;
 198         uint32_t status;
 199
 200         cmd.mac_id_n_color =
 201             htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color));
 202         cmd.sta_id = IWM_STATION_ID;
 203         cmd.add_modify = IWM_STA_MODE_MODIFY;
 204         cmd.station_flags = drain ? htole32(IWM_STA_FLG_DRAIN_FLOW) : 0;
 205         cmd.station_flags_msk = htole32(IWM_STA_FLG_DRAIN_FLOW);
 206
 207         status = IWM_ADD_STA_SUCCESS;
 208         ret = iwm_mvm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 209                                           iwm_mvm_add_sta_cmd_size(sc),
 210                                           &cmd, &status);
 211         if (ret)
 212                 return ret;
 213
 214         switch (status & IWM_ADD_STA_STATUS_MASK) {
 215         case IWM_ADD_STA_SUCCESS:
 216                 IWM_DPRINTF(sc, IWM_DEBUG_NODE,
 217                     "Frames for staid %d will drained in fw\n", IWM_STATION_ID);
 218                 break;
 219         default:
 220                 ret = EIO;
 221                 device_printf(sc->sc_dev,
 222                     "Couldn't drain frames for staid %d\n", IWM_STATION_ID);
 223                 break;
 224         }
 225
 226         return ret;
 227 }
 228
 229 /*
 230  * Remove a station from the FW table. Before sending the command to remove
 231  * the station validate that the station is indeed known to the driver (sanity
 232  * only).
 233  */
 234 static int
 235 iwm_mvm_rm_sta_common(struct iwm_softc *sc)
 236 {
 237         struct iwm_mvm_rm_sta_cmd rm_sta_cmd = {
 238                 .sta_id = IWM_STATION_ID,
 239         };
 240         int ret;
 241
 242         ret = iwm_mvm_send_cmd_pdu(sc, IWM_REMOVE_STA, 0,
 243                                    sizeof(rm_sta_cmd), &rm_sta_cmd);
 244         if (ret) {
 245                 device_printf(sc->sc_dev,
 246                     "Failed to remove station. Id=%d\n", IWM_STATION_ID);
 247                 return ret;
 248         }
 249
 250         return 0;
 251 }
 252
 253 int
 254 iwm_mvm_rm_sta(struct iwm_softc *sc, struct ieee80211vap *vap,
 255         boolean_t is_assoc)
 256 {
 257         uint32_t tfd_queue_msk = 0;
 258         int ret;
 259         int ac;
 260
 261         ret = iwm_mvm_drain_sta(sc, IWM_VAP(vap), TRUE);
 262         if (ret)
 263                 return ret;
 264         for (ac = 0; ac < WME_NUM_AC; ac++) {
 265                 tfd_queue_msk |= htole32(1 << iwm_mvm_ac_to_tx_fifo[ac]);
 266         }
 267         ret = iwm_mvm_flush_tx_path(sc, tfd_queue_msk, 0);
 268         if (ret)
 269                 return ret;
 270 #ifdef notyet /* function not yet implemented */
 271         ret = iwl_trans_wait_tx_queue_empty(mvm->trans,
 272                                             mvm_sta->tfd_queue_msk);
 273         if (ret)
 274                 return ret;
 275 #endif
 276         ret = iwm_mvm_drain_sta(sc, IWM_VAP(vap), FALSE);
 277
 278         /* if we are associated - we can't remove the AP STA now */
 279         if (is_assoc)
 280                 return ret;
 281
 282         /* XXX wait until STA is drained */
 283
 284         ret = iwm_mvm_rm_sta_common(sc);
 285
 286         return ret;
 287 }
 288
 289 int
 290 iwm_mvm_rm_sta_id(struct iwm_softc *sc, struct ieee80211vap *vap)
 291 {
 292         /* XXX wait until STA is drained */
 293
 294         return iwm_mvm_rm_sta_common(sc);
 295 }
 296
 297 static int
 298 iwm_mvm_add_int_sta_common(struct iwm_softc *sc, struct iwm_int_sta *sta,
 299         const uint8_t *addr, uint16_t mac_id, uint16_t color)
 300 {
 301         struct iwm_mvm_add_sta_cmd cmd;
 302         int ret;
 303         uint32_t status;
 304
 305         memset(&cmd, 0, sizeof(cmd));
 306         cmd.sta_id = sta->sta_id;
 307         cmd.mac_id_n_color = htole32(IWM_FW_CMD_ID_AND_COLOR(mac_id, color));
 308
 309         cmd.tfd_queue_msk = htole32(sta->tfd_queue_msk);
 310         cmd.tid_disable_tx = htole16(0xffff);
 311
 312         if (addr)
 313                 IEEE80211_ADDR_COPY(cmd.addr, addr);
 314
 315         ret = iwm_mvm_send_cmd_pdu_status(sc, IWM_ADD_STA,
 316                                           iwm_mvm_add_sta_cmd_size(sc),
 317                                           &cmd, &status);
 318         if (ret)
 319                 return ret;
 320
 321         switch (status & IWM_ADD_STA_STATUS_MASK) {
 322         case IWM_ADD_STA_SUCCESS:
 323                 IWM_DPRINTF(sc, IWM_DEBUG_NODE, "Internal station added.\n");
 324                 return 0;
 325         default:
 326                 ret = EIO;
 327                 device_printf(sc->sc_dev,
 328                     "Add internal station failed, status=0x%x\n", status);
 329                 break;
 330         }
 331         return ret;
 332 }
 333
 334 int
 335 iwm_mvm_add_aux_sta(struct iwm_softc *sc)
 336 {
 337         int ret;
 338
 339         sc->sc_aux_sta.sta_id = IWM_AUX_STA_ID;
 340         sc->sc_aux_sta.tfd_queue_msk = (1 << IWM_MVM_AUX_QUEUE);
 341
 342         /* Map Aux queue to fifo - needs to happen before adding Aux station */
 343         ret = iwm_enable_txq(sc, 0, IWM_MVM_AUX_QUEUE, IWM_MVM_TX_FIFO_MCAST);
 344         if (ret)
 345                 return ret;
 346
 347         ret = iwm_mvm_add_int_sta_common(sc, &sc->sc_aux_sta, NULL,
 348                                          IWM_MAC_INDEX_AUX, 0);
 349
 350         if (ret) {
 351                 memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
 352                 sc->sc_aux_sta.sta_id = IWM_MVM_STATION_COUNT;
 353         }
 354         return ret;
 355 }
 356
 357 void iwm_mvm_del_aux_sta(struct iwm_softc *sc)
 358 {
 359         memset(&sc->sc_aux_sta, 0, sizeof(sc->sc_aux_sta));
 360         sc->sc_aux_sta.sta_id = IWM_MVM_STATION_COUNT;
 361 }