sys/dev/iwm/if_iwm_scan.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
  90 /*-
  91  * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
  92  *
  93  * Permission to use, copy, modify, and distribute this software for any
  94  * purpose with or without fee is hereby granted, provided that the above
  95  * copyright notice and this permission notice appear in all copies.
  96  *
  97  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  98  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  99  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 100  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 101  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 102  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 103  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 104  */
 105 #include <sys/cdefs.h>
 106 __FBSDID("$FreeBSD$");
 107
 108 #include "opt_wlan.h"
 109 #include "opt_iwm.h"
 110
 111 #include <sys/param.h>
 112 #include <sys/bus.h>
 113 #include <sys/conf.h>
 114 #include <sys/endian.h>
 115 #include <sys/firmware.h>
 116 #include <sys/kernel.h>
 117 #include <sys/malloc.h>
 118 #include <sys/mbuf.h>
 119 #include <sys/mutex.h>
 120 #include <sys/module.h>
 121 #include <sys/proc.h>
 122 #include <sys/rman.h>
 123 #include <sys/socket.h>
 124 #include <sys/sockio.h>
 125 #include <sys/sysctl.h>
 126 #include <sys/linker.h>
 127
 128 #include <machine/bus.h>
 129 #include <machine/endian.h>
 130 #include <machine/resource.h>
 131
 132 #include <dev/pci/pcivar.h>
 133 #include <dev/pci/pcireg.h>
 134
 135 #include <net/bpf.h>
 136
 137 #include <net/if.h>
 138 #include <net/if_var.h>
 139 #include <net/if_arp.h>
 140 #include <net/if_dl.h>
 141 #include <net/if_media.h>
 142 #include <net/if_types.h>
 143
 144 #include <netinet/in.h>
 145 #include <netinet/in_systm.h>
 146 #include <netinet/if_ether.h>
 147 #include <netinet/ip.h>
 148
 149 #include <net80211/ieee80211_var.h>
 150 #include <net80211/ieee80211_regdomain.h>
 151 #include <net80211/ieee80211_ratectl.h>
 152 #include <net80211/ieee80211_radiotap.h>
 153
 154 #include <dev/iwm/if_iwmreg.h>
 155 #include <dev/iwm/if_iwmvar.h>
 156 #include <dev/iwm/if_iwm_debug.h>
 157 #include <dev/iwm/if_iwm_notif_wait.h>
 158 #include <dev/iwm/if_iwm_util.h>
 159 #include <dev/iwm/if_iwm_scan.h>
 160
 161 /*
 162  * BEGIN mvm/scan.c
 163  */
 164
 165 #define IWM_DENSE_EBS_SCAN_RATIO 5
 166 #define IWM_SPARSE_EBS_SCAN_RATIO 1
 167
 168 static uint16_t
 169 iwm_mvm_scan_rx_chain(struct iwm_softc *sc)
 170 {
 171         uint16_t rx_chain;
 172         uint8_t rx_ant;
 173
 174         rx_ant = iwm_mvm_get_valid_rx_ant(sc);
 175         rx_chain = rx_ant << IWM_PHY_RX_CHAIN_VALID_POS;
 176         rx_chain |= rx_ant << IWM_PHY_RX_CHAIN_FORCE_MIMO_SEL_POS;
 177         rx_chain |= rx_ant << IWM_PHY_RX_CHAIN_FORCE_SEL_POS;
 178         rx_chain |= 0x1 << IWM_PHY_RX_CHAIN_DRIVER_FORCE_POS;
 179         return htole16(rx_chain);
 180 }
 181
 182 static uint32_t
 183 iwm_mvm_scan_rxon_flags(struct ieee80211_channel *c)
 184 {
 185         if (IEEE80211_IS_CHAN_2GHZ(c))
 186                 return htole32(IWM_PHY_BAND_24);
 187         else
 188                 return htole32(IWM_PHY_BAND_5);
 189 }
 190
 191 static uint32_t
 192 iwm_mvm_scan_rate_n_flags(struct iwm_softc *sc, int flags, int no_cck)
 193 {
 194         uint32_t tx_ant;
 195         int i, ind;
 196
 197         for (i = 0, ind = sc->sc_scan_last_antenna;
 198             i < IWM_RATE_MCS_ANT_NUM; i++) {
 199                 ind = (ind + 1) % IWM_RATE_MCS_ANT_NUM;
 200                 if (iwm_mvm_get_valid_tx_ant(sc) & (1 << ind)) {
 201                         sc->sc_scan_last_antenna = ind;
 202                         break;
 203                 }
 204         }
 205         tx_ant = (1 << sc->sc_scan_last_antenna) << IWM_RATE_MCS_ANT_POS;
 206
 207         if ((flags & IEEE80211_CHAN_2GHZ) && !no_cck)
 208                 return htole32(IWM_RATE_1M_PLCP | IWM_RATE_MCS_CCK_MSK |
 209                                    tx_ant);
 210         else
 211                 return htole32(IWM_RATE_6M_PLCP | tx_ant);
 212 }
 213
 214 static inline boolean_t
 215 iwm_mvm_rrm_scan_needed(struct iwm_softc *sc)
 216 {
 217         /* require rrm scan whenever the fw supports it */
 218         return fw_has_capa(&sc->ucode_capa,
 219                            IWM_UCODE_TLV_CAPA_DS_PARAM_SET_IE_SUPPORT);
 220 }
 221
 222 #ifdef IWM_DEBUG
 223 static const char *
 224 iwm_mvm_ebs_status_str(enum iwm_scan_ebs_status status)
 225 {
 226         switch (status) {
 227         case IWM_SCAN_EBS_SUCCESS:
 228                 return "successful";
 229         case IWM_SCAN_EBS_INACTIVE:
 230                 return "inactive";
 231         case IWM_SCAN_EBS_FAILED:
 232         case IWM_SCAN_EBS_CHAN_NOT_FOUND:
 233         default:
 234                 return "failed";
 235         }
 236 }
 237
 238 static const char *
 239 iwm_mvm_offload_status_str(enum iwm_scan_offload_complete_status status)
 240 {
 241         return (status == IWM_SCAN_OFFLOAD_ABORTED) ? "aborted" : "completed";
 242 }
 243 #endif
 244
 245 void
 246 iwm_mvm_rx_lmac_scan_complete_notif(struct iwm_softc *sc,
 247     struct iwm_rx_packet *pkt)
 248 {
 249         struct iwm_periodic_scan_complete *scan_notif = (void *)pkt->data;
 250
 251         /* If this happens, the firmware has mistakenly sent an LMAC
 252          * notification during UMAC scans -- warn and ignore it.
 253          */
 254         if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN)) {
 255                 device_printf(sc->sc_dev,
 256                     "%s: Mistakenly got LMAC notification during UMAC scan\n",
 257                     __func__);
 258                 return;
 259         }
 260
 261         IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Regular scan %s, EBS status %s (FW)\n",
 262             iwm_mvm_offload_status_str(scan_notif->status),
 263             iwm_mvm_ebs_status_str(scan_notif->ebs_status));
 264
 265         sc->last_ebs_successful =
 266                         scan_notif->ebs_status == IWM_SCAN_EBS_SUCCESS ||
 267                         scan_notif->ebs_status == IWM_SCAN_EBS_INACTIVE;
 268
 269 }
 270
 271 void
 272 iwm_mvm_rx_umac_scan_complete_notif(struct iwm_softc *sc,
 273     struct iwm_rx_packet *pkt)
 274 {
 275         struct iwm_umac_scan_complete *notif = (void *)pkt->data;
 276
 277         IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 278             "Scan completed, uid %u, status %s, EBS status %s\n",
 279             le32toh(notif->uid),
 280             iwm_mvm_offload_status_str(notif->status),
 281             iwm_mvm_ebs_status_str(notif->ebs_status));
 282
 283         if (notif->ebs_status != IWM_SCAN_EBS_SUCCESS &&
 284             notif->ebs_status != IWM_SCAN_EBS_INACTIVE)
 285                 sc->last_ebs_successful = FALSE;
 286 }
 287
 288 static int
 289 iwm_mvm_scan_skip_channel(struct ieee80211_channel *c)
 290 {
 291         if (IEEE80211_IS_CHAN_2GHZ(c) && IEEE80211_IS_CHAN_B(c))
 292                 return 0;
 293         else if (IEEE80211_IS_CHAN_5GHZ(c) && IEEE80211_IS_CHAN_A(c))
 294                 return 0;
 295         else
 296                 return 1;
 297 }
 298
 299 static uint8_t
 300 iwm_mvm_lmac_scan_fill_channels(struct iwm_softc *sc,
 301     struct iwm_scan_channel_cfg_lmac *chan, int n_ssids)
 302 {
 303         struct ieee80211com *ic = &sc->sc_ic;
 304         struct ieee80211_scan_state *ss = ic->ic_scan;
 305         struct ieee80211_channel *c;
 306         uint8_t nchan;
 307         int j;
 308
 309         for (nchan = j = 0;
 310             j < ss->ss_last && nchan < sc->ucode_capa.n_scan_channels; j++) {
 311                 c = ss->ss_chans[j];
 312                 /*
 313                  * Catch other channels, in case we have 900MHz channels or
 314                  * something in the chanlist.
 315                  */
 316                 if (!IEEE80211_IS_CHAN_2GHZ(c) && !IEEE80211_IS_CHAN_5GHZ(c)) {
 317                         IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
 318                             "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
 319                             __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
 320                         continue;
 321                 }
 322
 323                 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
 324                     "Adding channel %d (%d Mhz) to the list\n",
 325                     nchan, c->ic_freq);
 326                 chan->channel_num = htole16(ieee80211_mhz2ieee(c->ic_freq, 0));
 327                 chan->iter_count = htole16(1);
 328                 chan->iter_interval = htole32(0);
 329                 chan->flags = htole32(IWM_UNIFIED_SCAN_CHANNEL_PARTIAL);
 330                 chan->flags |= htole32(IWM_SCAN_CHANNEL_NSSIDS(n_ssids));
 331                 /* XXX IEEE80211_SCAN_NOBCAST flag is never set. */
 332                 if (!IEEE80211_IS_CHAN_PASSIVE(c) &&
 333                     (!(ss->ss_flags & IEEE80211_SCAN_NOBCAST) || n_ssids != 0))
 334                         chan->flags |= htole32(IWM_SCAN_CHANNEL_TYPE_ACTIVE);
 335                 chan++;
 336                 nchan++;
 337         }
 338
 339         return nchan;
 340 }
 341
 342 static uint8_t
 343 iwm_mvm_umac_scan_fill_channels(struct iwm_softc *sc,
 344     struct iwm_scan_channel_cfg_umac *chan, int n_ssids)
 345 {
 346         struct ieee80211com *ic = &sc->sc_ic;
 347         struct ieee80211_scan_state *ss = ic->ic_scan;
 348         struct ieee80211_channel *c;
 349         uint8_t nchan;
 350         int j;
 351
 352         for (nchan = j = 0;
 353             j < ss->ss_last && nchan < sc->ucode_capa.n_scan_channels; j++) {
 354                 c = ss->ss_chans[j];
 355                 /*
 356                  * Catch other channels, in case we have 900MHz channels or
 357                  * something in the chanlist.
 358                  */
 359                 if (!IEEE80211_IS_CHAN_2GHZ(c) && !IEEE80211_IS_CHAN_5GHZ(c)) {
 360                         IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
 361                             "%s: skipping channel (freq=%d, ieee=%d, flags=0x%08x)\n",
 362                             __func__, c->ic_freq, c->ic_ieee, c->ic_flags);
 363                         continue;
 364                 }
 365
 366                 IWM_DPRINTF(sc, IWM_DEBUG_RESET | IWM_DEBUG_EEPROM,
 367                     "Adding channel %d (%d Mhz) to the list\n",
 368                     nchan, c->ic_freq);
 369                 chan->channel_num = ieee80211_mhz2ieee(c->ic_freq, 0);
 370                 chan->iter_count = 1;
 371                 chan->iter_interval = htole16(0);
 372                 chan->flags = htole32(IWM_SCAN_CHANNEL_UMAC_NSSIDS(n_ssids));
 373                 chan++;
 374                 nchan++;
 375         }
 376
 377         return nchan;
 378 }
 379
 380 static int
 381 iwm_mvm_fill_probe_req(struct iwm_softc *sc, struct iwm_scan_probe_req *preq)
 382 {
 383         struct ieee80211com *ic = &sc->sc_ic;
 384         struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
 385         struct ieee80211_frame *wh = (struct ieee80211_frame *)preq->buf;
 386         struct ieee80211_rateset *rs;
 387         size_t remain = sizeof(preq->buf);
 388         uint8_t *frm, *pos;
 389
 390         memset(preq, 0, sizeof(*preq));
 391
 392         /* Ensure enough space for header and SSID IE. */
 393         if (remain < sizeof(*wh) + 2)
 394                 return ENOBUFS;
 395
 396         /*
 397          * Build a probe request frame.  Most of the following code is a
 398          * copy & paste of what is done in net80211.
 399          */
 400         wh->i_fc[0] = IEEE80211_FC0_VERSION_0 | IEEE80211_FC0_TYPE_MGT |
 401             IEEE80211_FC0_SUBTYPE_PROBE_REQ;
 402         wh->i_fc[1] = IEEE80211_FC1_DIR_NODS;
 403         IEEE80211_ADDR_COPY(wh->i_addr1, ieee80211broadcastaddr);
 404         IEEE80211_ADDR_COPY(wh->i_addr2, vap ? vap->iv_myaddr : ic->ic_macaddr);
 405         IEEE80211_ADDR_COPY(wh->i_addr3, ieee80211broadcastaddr);
 406         *(uint16_t *)&wh->i_dur[0] = 0; /* filled by HW */
 407         *(uint16_t *)&wh->i_seq[0] = 0; /* filled by HW */
 408
 409         frm = (uint8_t *)(wh + 1);
 410         frm = ieee80211_add_ssid(frm, NULL, 0);
 411
 412         /* Tell the firmware where the MAC header is. */
 413         preq->mac_header.offset = 0;
 414         preq->mac_header.len = htole16(frm - (uint8_t *)wh);
 415         remain -= frm - (uint8_t *)wh;
 416
 417         /* Fill in 2GHz IEs and tell firmware where they are. */
 418         rs = &ic->ic_sup_rates[IEEE80211_MODE_11G];
 419         if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
 420                 if (remain < 4 + rs->rs_nrates)
 421                         return ENOBUFS;
 422         } else if (remain < 2 + rs->rs_nrates) {
 423                 return ENOBUFS;
 424         }
 425         preq->band_data[0].offset = htole16(frm - (uint8_t *)wh);
 426         pos = frm;
 427         frm = ieee80211_add_rates(frm, rs);
 428         if (rs->rs_nrates > IEEE80211_RATE_SIZE)
 429                 frm = ieee80211_add_xrates(frm, rs);
 430         preq->band_data[0].len = htole16(frm - pos);
 431         remain -= frm - pos;
 432
 433         if (iwm_mvm_rrm_scan_needed(sc)) {
 434                 if (remain < 3)
 435                         return ENOBUFS;
 436                 *frm++ = IEEE80211_ELEMID_DSPARMS;
 437                 *frm++ = 1;
 438                 *frm++ = 0;
 439                 remain -= 3;
 440         }
 441
 442         if (sc->nvm_data->sku_cap_band_52GHz_enable) {
 443                 /* Fill in 5GHz IEs. */
 444                 rs = &ic->ic_sup_rates[IEEE80211_MODE_11A];
 445                 if (rs->rs_nrates > IEEE80211_RATE_SIZE) {
 446                         if (remain < 4 + rs->rs_nrates)
 447                                 return ENOBUFS;
 448                 } else if (remain < 2 + rs->rs_nrates) {
 449                         return ENOBUFS;
 450                 }
 451                 preq->band_data[1].offset = htole16(frm - (uint8_t *)wh);
 452                 pos = frm;
 453                 frm = ieee80211_add_rates(frm, rs);
 454                 if (rs->rs_nrates > IEEE80211_RATE_SIZE)
 455                         frm = ieee80211_add_xrates(frm, rs);
 456                 preq->band_data[1].len = htole16(frm - pos);
 457                 remain -= frm - pos;
 458         }
 459
 460         /* Send 11n IEs on both 2GHz and 5GHz bands. */
 461         preq->common_data.offset = htole16(frm - (uint8_t *)wh);
 462         pos = frm;
 463 #if 0
 464         if (ic->ic_flags & IEEE80211_F_HTON) {
 465                 if (remain < 28)
 466                         return ENOBUFS;
 467                 frm = ieee80211_add_htcaps(frm, ic);
 468                 /* XXX add WME info? */
 469         }
 470 #endif
 471         preq->common_data.len = htole16(frm - pos);
 472
 473         return 0;
 474 }
 475
 476 int
 477 iwm_mvm_config_umac_scan(struct iwm_softc *sc)
 478 {
 479         struct ieee80211com *ic = &sc->sc_ic;
 480         struct ieee80211vap *vap = TAILQ_FIRST(&ic->ic_vaps);
 481
 482         struct iwm_scan_config *scan_config;
 483         int ret, j, nchan;
 484         size_t cmd_size;
 485         struct ieee80211_channel *c;
 486         struct iwm_host_cmd hcmd = {
 487                 .id = iwm_cmd_id(IWM_SCAN_CFG_CMD, IWM_ALWAYS_LONG_GROUP, 0),
 488                 .flags = IWM_CMD_SYNC,
 489         };
 490         static const uint32_t rates = (IWM_SCAN_CONFIG_RATE_1M |
 491             IWM_SCAN_CONFIG_RATE_2M | IWM_SCAN_CONFIG_RATE_5M |
 492             IWM_SCAN_CONFIG_RATE_11M | IWM_SCAN_CONFIG_RATE_6M |
 493             IWM_SCAN_CONFIG_RATE_9M | IWM_SCAN_CONFIG_RATE_12M |
 494             IWM_SCAN_CONFIG_RATE_18M | IWM_SCAN_CONFIG_RATE_24M |
 495             IWM_SCAN_CONFIG_RATE_36M | IWM_SCAN_CONFIG_RATE_48M |
 496             IWM_SCAN_CONFIG_RATE_54M);
 497
 498         cmd_size = sizeof(*scan_config) + sc->ucode_capa.n_scan_channels;
 499
 500         scan_config = malloc(cmd_size, M_DEVBUF, M_NOWAIT | M_ZERO);
 501         if (scan_config == NULL)
 502                 return ENOMEM;
 503
 504         scan_config->tx_chains = htole32(iwm_mvm_get_valid_tx_ant(sc));
 505         scan_config->rx_chains = htole32(iwm_mvm_get_valid_rx_ant(sc));
 506         scan_config->legacy_rates = htole32(rates |
 507             IWM_SCAN_CONFIG_SUPPORTED_RATE(rates));
 508
 509         /* These timings correspond to iwlwifi's UNASSOC scan. */
 510         scan_config->dwell_active = 10;
 511         scan_config->dwell_passive = 110;
 512         scan_config->dwell_fragmented = 44;
 513         scan_config->dwell_extended = 90;
 514         scan_config->out_of_channel_time = htole32(0);
 515         scan_config->suspend_time = htole32(0);
 516
 517         IEEE80211_ADDR_COPY(scan_config->mac_addr,
 518             vap ? vap->iv_myaddr : ic->ic_macaddr);
 519
 520         scan_config->bcast_sta_id = sc->sc_aux_sta.sta_id;
 521         scan_config->channel_flags = IWM_CHANNEL_FLAG_EBS |
 522             IWM_CHANNEL_FLAG_ACCURATE_EBS | IWM_CHANNEL_FLAG_EBS_ADD |
 523             IWM_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE;
 524
 525         for (nchan = j = 0;
 526             j < ic->ic_nchans && nchan < sc->ucode_capa.n_scan_channels; j++) {
 527                 c = &ic->ic_channels[j];
 528                 /* For 2GHz, only populate 11b channels */
 529                 /* For 5GHz, only populate 11a channels */
 530                 /*
 531                  * Catch other channels, in case we have 900MHz channels or
 532                  * something in the chanlist.
 533                  */
 534                 if (iwm_mvm_scan_skip_channel(c))
 535                         continue;
 536                 scan_config->channel_array[nchan++] =
 537                     ieee80211_mhz2ieee(c->ic_freq, 0);
 538         }
 539
 540         scan_config->flags = htole32(IWM_SCAN_CONFIG_FLAG_ACTIVATE |
 541             IWM_SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS |
 542             IWM_SCAN_CONFIG_FLAG_SET_TX_CHAINS |
 543             IWM_SCAN_CONFIG_FLAG_SET_RX_CHAINS |
 544             IWM_SCAN_CONFIG_FLAG_SET_AUX_STA_ID |
 545             IWM_SCAN_CONFIG_FLAG_SET_ALL_TIMES |
 546             IWM_SCAN_CONFIG_FLAG_SET_LEGACY_RATES |
 547             IWM_SCAN_CONFIG_FLAG_SET_MAC_ADDR |
 548             IWM_SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS|
 549             IWM_SCAN_CONFIG_N_CHANNELS(nchan) |
 550             IWM_SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED);
 551
 552         hcmd.data[0] = scan_config;
 553         hcmd.len[0] = cmd_size;
 554
 555         IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending UMAC scan config\n");
 556
 557         ret = iwm_send_cmd(sc, &hcmd);
 558         if (!ret)
 559                 IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 560                     "UMAC scan config was sent successfully\n");
 561
 562         free(scan_config, M_DEVBUF);
 563         return ret;
 564 }
 565
 566 static boolean_t
 567 iwm_mvm_scan_use_ebs(struct iwm_softc *sc)
 568 {
 569         const struct iwm_ucode_capabilities *capa = &sc->ucode_capa;
 570
 571         /* We can only use EBS if:
 572          *      1. the feature is supported;
 573          *      2. the last EBS was successful;
 574          *      3. if only single scan, the single scan EBS API is supported;
 575          *      4. it's not a p2p find operation.
 576          */
 577         return ((capa->flags & IWM_UCODE_TLV_FLAGS_EBS_SUPPORT) &&
 578                 sc->last_ebs_successful);
 579 }
 580
 581 int
 582 iwm_mvm_umac_scan(struct iwm_softc *sc)
 583 {
 584         struct iwm_host_cmd hcmd = {
 585                 .id = iwm_cmd_id(IWM_SCAN_REQ_UMAC, IWM_ALWAYS_LONG_GROUP, 0),
 586                 .len = { 0, },
 587                 .data = { NULL, },
 588                 .flags = IWM_CMD_SYNC,
 589         };
 590         struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
 591         struct iwm_scan_req_umac *req;
 592         struct iwm_scan_req_umac_tail *tail;
 593         size_t req_len;
 594         uint8_t i, nssid;
 595         int ret;
 596
 597         req_len = sizeof(struct iwm_scan_req_umac) +
 598             (sizeof(struct iwm_scan_channel_cfg_umac) *
 599             sc->ucode_capa.n_scan_channels) +
 600             sizeof(struct iwm_scan_req_umac_tail);
 601         if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
 602                 return ENOMEM;
 603         req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
 604         if (req == NULL)
 605                 return ENOMEM;
 606
 607         hcmd.len[0] = (uint16_t)req_len;
 608         hcmd.data[0] = (void *)req;
 609
 610         IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Handling ieee80211 scan request\n");
 611
 612         /* These timings correspond to iwlwifi's UNASSOC scan. */
 613         req->active_dwell = 10;
 614         req->passive_dwell = 110;
 615         req->fragmented_dwell = 44;
 616         req->extended_dwell = 90;
 617         req->max_out_time = 0;
 618         req->suspend_time = 0;
 619
 620         req->scan_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
 621         req->ooc_priority = htole32(IWM_SCAN_PRIORITY_HIGH);
 622
 623         nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
 624         req->n_channels = iwm_mvm_umac_scan_fill_channels(sc,
 625             (struct iwm_scan_channel_cfg_umac *)req->data, nssid);
 626
 627         req->general_flags = htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASS_ALL |
 628             IWM_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE |
 629             IWM_UMAC_SCAN_GEN_FLAGS_EXTENDED_DWELL);
 630
 631         tail = (void *)((char *)&req->data +
 632                 sizeof(struct iwm_scan_channel_cfg_umac) *
 633                         sc->ucode_capa.n_scan_channels);
 634
 635         /* Check if we're doing an active directed scan. */
 636         for (i = 0; i < nssid; i++) {
 637                 tail->direct_scan[i].id = IEEE80211_ELEMID_SSID;
 638                 tail->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
 639                     IEEE80211_NWID_LEN);
 640                 memcpy(tail->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
 641                     tail->direct_scan[i].len);
 642                 /* XXX debug */
 643         }
 644         if (nssid != 0) {
 645                 req->general_flags |=
 646                     htole32(IWM_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT);
 647         } else
 648                 req->general_flags |= htole32(IWM_UMAC_SCAN_GEN_FLAGS_PASSIVE);
 649
 650         if (iwm_mvm_scan_use_ebs(sc))
 651                 req->channel_flags = IWM_SCAN_CHANNEL_FLAG_EBS |
 652                                      IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
 653                                      IWM_SCAN_CHANNEL_FLAG_CACHE_ADD;
 654
 655         if (iwm_mvm_rrm_scan_needed(sc))
 656                 req->general_flags |=
 657                     htole32(IWM_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED);
 658
 659         ret = iwm_mvm_fill_probe_req(sc, &tail->preq);
 660         if (ret) {
 661                 free(req, M_DEVBUF);
 662                 return ret;
 663         }
 664
 665         /* Specify the scan plan: We'll do one iteration. */
 666         tail->schedule[0].interval = 0;
 667         tail->schedule[0].iter_count = 1;
 668
 669         ret = iwm_send_cmd(sc, &hcmd);
 670         if (!ret)
 671                 IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 672                     "Scan request was sent successfully\n");
 673         free(req, M_DEVBUF);
 674         return ret;
 675 }
 676
 677 int
 678 iwm_mvm_lmac_scan(struct iwm_softc *sc)
 679 {
 680         struct iwm_host_cmd hcmd = {
 681                 .id = IWM_SCAN_OFFLOAD_REQUEST_CMD,
 682                 .len = { 0, },
 683                 .data = { NULL, },
 684                 .flags = IWM_CMD_SYNC,
 685         };
 686         struct ieee80211_scan_state *ss = sc->sc_ic.ic_scan;
 687         struct iwm_scan_req_lmac *req;
 688         size_t req_len;
 689         uint8_t i, nssid;
 690         int ret;
 691
 692         IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 693             "Handling ieee80211 scan request\n");
 694
 695         req_len = sizeof(struct iwm_scan_req_lmac) +
 696             (sizeof(struct iwm_scan_channel_cfg_lmac) *
 697             sc->ucode_capa.n_scan_channels) + sizeof(struct iwm_scan_probe_req);
 698         if (req_len > IWM_MAX_CMD_PAYLOAD_SIZE)
 699                 return ENOMEM;
 700         req = malloc(req_len, M_DEVBUF, M_NOWAIT | M_ZERO);
 701         if (req == NULL)
 702                 return ENOMEM;
 703
 704         hcmd.len[0] = (uint16_t)req_len;
 705         hcmd.data[0] = (void *)req;
 706
 707         /* These timings correspond to iwlwifi's UNASSOC scan. */
 708         req->active_dwell = 10;
 709         req->passive_dwell = 110;
 710         req->fragmented_dwell = 44;
 711         req->extended_dwell = 90;
 712         req->max_out_time = 0;
 713         req->suspend_time = 0;
 714
 715         req->scan_prio = htole32(IWM_SCAN_PRIORITY_HIGH);
 716         req->rx_chain_select = iwm_mvm_scan_rx_chain(sc);
 717         req->iter_num = htole32(1);
 718         req->delay = 0;
 719
 720         req->scan_flags = htole32(IWM_MVM_LMAC_SCAN_FLAG_PASS_ALL |
 721             IWM_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE |
 722             IWM_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL);
 723         if (iwm_mvm_rrm_scan_needed(sc))
 724                 req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED);
 725
 726         req->flags = iwm_mvm_scan_rxon_flags(sc->sc_ic.ic_scan->ss_chans[0]);
 727
 728         req->filter_flags =
 729             htole32(IWM_MAC_FILTER_ACCEPT_GRP | IWM_MAC_FILTER_IN_BEACON);
 730
 731         /* Tx flags 2 GHz. */
 732         req->tx_cmd[0].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
 733             IWM_TX_CMD_FLG_BT_DIS);
 734         req->tx_cmd[0].rate_n_flags =
 735             iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_2GHZ, 1/*XXX*/);
 736         req->tx_cmd[0].sta_id = sc->sc_aux_sta.sta_id;
 737
 738         /* Tx flags 5 GHz. */
 739         req->tx_cmd[1].tx_flags = htole32(IWM_TX_CMD_FLG_SEQ_CTL |
 740             IWM_TX_CMD_FLG_BT_DIS);
 741         req->tx_cmd[1].rate_n_flags =
 742             iwm_mvm_scan_rate_n_flags(sc, IEEE80211_CHAN_5GHZ, 1/*XXX*/);
 743         req->tx_cmd[1].sta_id = sc->sc_aux_sta.sta_id;
 744
 745         /* Check if we're doing an active directed scan. */
 746         nssid = MIN(ss->ss_nssid, IWM_PROBE_OPTION_MAX);
 747         for (i = 0; i < nssid; i++) {
 748                 req->direct_scan[i].id = IEEE80211_ELEMID_SSID;
 749                 req->direct_scan[i].len = MIN(ss->ss_ssid[i].len,
 750                     IEEE80211_NWID_LEN);
 751                 memcpy(req->direct_scan[i].ssid, ss->ss_ssid[i].ssid,
 752                     req->direct_scan[i].len);
 753                 /* XXX debug */
 754         }
 755         if (nssid != 0) {
 756                 req->scan_flags |=
 757                     htole32(IWM_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION);
 758         } else
 759                 req->scan_flags |= htole32(IWM_MVM_LMAC_SCAN_FLAG_PASSIVE);
 760
 761         req->n_channels = iwm_mvm_lmac_scan_fill_channels(sc,
 762             (struct iwm_scan_channel_cfg_lmac *)req->data, nssid);
 763
 764         ret = iwm_mvm_fill_probe_req(sc,
 765                             (struct iwm_scan_probe_req *)(req->data +
 766                             (sizeof(struct iwm_scan_channel_cfg_lmac) *
 767                             sc->ucode_capa.n_scan_channels)));
 768         if (ret) {
 769                 free(req, M_DEVBUF);
 770                 return ret;
 771         }
 772
 773         /* Specify the scan plan: We'll do one iteration. */
 774         req->schedule[0].iterations = 1;
 775         req->schedule[0].full_scan_mul = 1;
 776
 777         if (iwm_mvm_scan_use_ebs(sc)) {
 778                 req->channel_opt[0].flags =
 779                         htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
 780                                 IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
 781                                 IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
 782                 req->channel_opt[0].non_ebs_ratio =
 783                         htole16(IWM_DENSE_EBS_SCAN_RATIO);
 784                 req->channel_opt[1].flags =
 785                         htole16(IWM_SCAN_CHANNEL_FLAG_EBS |
 786                                 IWM_SCAN_CHANNEL_FLAG_EBS_ACCURATE |
 787                                 IWM_SCAN_CHANNEL_FLAG_CACHE_ADD);
 788                 req->channel_opt[1].non_ebs_ratio =
 789                         htole16(IWM_SPARSE_EBS_SCAN_RATIO);
 790         }
 791
 792         ret = iwm_send_cmd(sc, &hcmd);
 793         if (!ret) {
 794                 IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 795                     "Scan request was sent successfully\n");
 796         }
 797         free(req, M_DEVBUF);
 798         return ret;
 799 }
 800
 801 static int
 802 iwm_mvm_lmac_scan_abort(struct iwm_softc *sc)
 803 {
 804         int ret;
 805         struct iwm_host_cmd hcmd = {
 806                 .id = IWM_SCAN_OFFLOAD_ABORT_CMD,
 807                 .len = { 0, },
 808                 .data = { NULL, },
 809                 .flags = IWM_CMD_SYNC,
 810         };
 811         uint32_t status;
 812
 813         ret = iwm_mvm_send_cmd_status(sc, &hcmd, &status);
 814         if (ret)
 815                 return ret;
 816
 817         if (status != IWM_CAN_ABORT_STATUS) {
 818                 /*
 819                  * The scan abort will return 1 for success or
 820                  * 2 for "failure".  A failure condition can be
 821                  * due to simply not being in an active scan which
 822                  * can occur if we send the scan abort before the
 823                  * microcode has notified us that a scan is completed.
 824                  */
 825                 IWM_DPRINTF(sc, IWM_DEBUG_SCAN,
 826                     "SCAN OFFLOAD ABORT ret %d.\n", status);
 827                 ret = ENOENT;
 828         }
 829
 830         return ret;
 831 }
 832
 833 static int
 834 iwm_mvm_umac_scan_abort(struct iwm_softc *sc)
 835 {
 836         struct iwm_umac_scan_abort cmd = {};
 837         int uid, ret;
 838
 839         uid = 0;
 840         cmd.uid = htole32(uid);
 841
 842         IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Sending scan abort, uid %u\n", uid);
 843
 844         ret = iwm_mvm_send_cmd_pdu(sc,
 845                                    iwm_cmd_id(IWM_SCAN_ABORT_UMAC,
 846                                               IWM_ALWAYS_LONG_GROUP, 0),
 847                                    0, sizeof(cmd), &cmd);
 848
 849         return ret;
 850 }
 851
 852 int
 853 iwm_mvm_scan_stop_wait(struct iwm_softc *sc)
 854 {
 855         struct iwm_notification_wait wait_scan_done;
 856         static const uint16_t scan_done_notif[] = { IWM_SCAN_COMPLETE_UMAC,
 857                                                    IWM_SCAN_OFFLOAD_COMPLETE, };
 858         int ret;
 859
 860         iwm_init_notification_wait(sc->sc_notif_wait, &wait_scan_done,
 861                                    scan_done_notif, nitems(scan_done_notif),
 862                                    NULL, NULL);
 863
 864         IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "Preparing to stop scan\n");
 865
 866         if (fw_has_capa(&sc->ucode_capa, IWM_UCODE_TLV_CAPA_UMAC_SCAN))
 867                 ret = iwm_mvm_umac_scan_abort(sc);
 868         else
 869                 ret = iwm_mvm_lmac_scan_abort(sc);
 870
 871         if (ret) {
 872                 IWM_DPRINTF(sc, IWM_DEBUG_SCAN, "couldn't stop scan\n");
 873                 iwm_remove_notification(sc->sc_notif_wait, &wait_scan_done);
 874                 return ret;
 875         }
 876
 877         IWM_UNLOCK(sc);
 878         ret = iwm_wait_notification(sc->sc_notif_wait, &wait_scan_done, hz);
 879         IWM_LOCK(sc);
 880
 881         return ret;
 882 }