linux/drivers/net/wireless/intel/iwlwifi/mvm/fw-api-scan.h
<<
>>
Prefs
   1/******************************************************************************
   2 *
   3 * This file is provided under a dual BSD/GPLv2 license.  When using or
   4 * redistributing this file, you may do so under either license.
   5 *
   6 * GPL LICENSE SUMMARY
   7 *
   8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
   9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  10 *
  11 * This program is free software; you can redistribute it and/or modify
  12 * it under the terms of version 2 of the GNU General Public License as
  13 * published by the Free Software Foundation.
  14 *
  15 * This program is distributed in the hope that it will be useful, but
  16 * WITHOUT ANY WARRANTY; without even the implied warranty of
  17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 * General Public License for more details.
  19 *
  20 * You should have received a copy of the GNU General Public License
  21 * along with this program; if not, write to the Free Software
  22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23 * USA
  24 *
  25 * The full GNU General Public License is included in this distribution
  26 * in the file called COPYING.
  27 *
  28 * Contact Information:
  29 *  Intel Linux Wireless <linuxwifi@intel.com>
  30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31 *
  32 * BSD LICENSE
  33 *
  34 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  35 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  36 * All rights reserved.
  37 *
  38 * Redistribution and use in source and binary forms, with or without
  39 * modification, are permitted provided that the following conditions
  40 * are met:
  41 *
  42 *  * Redistributions of source code must retain the above copyright
  43 *    notice, this list of conditions and the following disclaimer.
  44 *  * Redistributions in binary form must reproduce the above copyright
  45 *    notice, this list of conditions and the following disclaimer in
  46 *    the documentation and/or other materials provided with the
  47 *    distribution.
  48 *  * Neither the name Intel Corporation nor the names of its
  49 *    contributors may be used to endorse or promote products derived
  50 *    from this software without specific prior written permission.
  51 *
  52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63 *
  64 *****************************************************************************/
  65
  66#ifndef __fw_api_scan_h__
  67#define __fw_api_scan_h__
  68
  69#include "fw-api.h"
  70
  71/* Scan Commands, Responses, Notifications */
  72
  73/* Max number of IEs for direct SSID scans in a command */
  74#define PROBE_OPTION_MAX                20
  75
  76/**
  77 * struct iwl_ssid_ie - directed scan network information element
  78 *
  79 * Up to 20 of these may appear in REPLY_SCAN_CMD,
  80 * selected by "type" bit field in struct iwl_scan_channel;
  81 * each channel may select different ssids from among the 20 entries.
  82 * SSID IEs get transmitted in reverse order of entry.
  83 */
  84struct iwl_ssid_ie {
  85        u8 id;
  86        u8 len;
  87        u8 ssid[IEEE80211_MAX_SSID_LEN];
  88} __packed; /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
  89
  90/* scan offload */
  91#define IWL_SCAN_MAX_BLACKLIST_LEN      64
  92#define IWL_SCAN_SHORT_BLACKLIST_LEN    16
  93#define IWL_SCAN_MAX_PROFILES           11
  94#define SCAN_OFFLOAD_PROBE_REQ_SIZE     512
  95
  96/* Default watchdog (in MS) for scheduled scan iteration */
  97#define IWL_SCHED_SCAN_WATCHDOG cpu_to_le16(15000)
  98
  99#define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
 100#define CAN_ABORT_STATUS 1
 101
 102#define IWL_FULL_SCAN_MULTIPLIER 5
 103#define IWL_FAST_SCHED_SCAN_ITERATIONS 3
 104#define IWL_MAX_SCHED_SCAN_PLANS 2
 105
 106enum scan_framework_client {
 107        SCAN_CLIENT_SCHED_SCAN          = BIT(0),
 108        SCAN_CLIENT_NETDETECT           = BIT(1),
 109        SCAN_CLIENT_ASSET_TRACKING      = BIT(2),
 110};
 111
 112/**
 113 * iwl_scan_offload_blacklist - SCAN_OFFLOAD_BLACKLIST_S
 114 * @ssid:               MAC address to filter out
 115 * @reported_rssi:      AP rssi reported to the host
 116 * @client_bitmap: clients ignore this entry  - enum scan_framework_client
 117 */
 118struct iwl_scan_offload_blacklist {
 119        u8 ssid[ETH_ALEN];
 120        u8 reported_rssi;
 121        u8 client_bitmap;
 122} __packed;
 123
 124enum iwl_scan_offload_network_type {
 125        IWL_NETWORK_TYPE_BSS    = 1,
 126        IWL_NETWORK_TYPE_IBSS   = 2,
 127        IWL_NETWORK_TYPE_ANY    = 3,
 128};
 129
 130enum iwl_scan_offload_band_selection {
 131        IWL_SCAN_OFFLOAD_SELECT_2_4     = 0x4,
 132        IWL_SCAN_OFFLOAD_SELECT_5_2     = 0x8,
 133        IWL_SCAN_OFFLOAD_SELECT_ANY     = 0xc,
 134};
 135
 136/**
 137 * iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
 138 * @ssid_index:         index to ssid list in fixed part
 139 * @unicast_cipher:     encryption algorithm to match - bitmap
 140 * @aut_alg:            authentication algorithm to match - bitmap
 141 * @network_type:       enum iwl_scan_offload_network_type
 142 * @band_selection:     enum iwl_scan_offload_band_selection
 143 * @client_bitmap:      clients waiting for match - enum scan_framework_client
 144 */
 145struct iwl_scan_offload_profile {
 146        u8 ssid_index;
 147        u8 unicast_cipher;
 148        u8 auth_alg;
 149        u8 network_type;
 150        u8 band_selection;
 151        u8 client_bitmap;
 152        u8 reserved[2];
 153} __packed;
 154
 155/**
 156 * iwl_scan_offload_profile_cfg - SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1
 157 * @blaclist:           AP list to filter off from scan results
 158 * @profiles:           profiles to search for match
 159 * @blacklist_len:      length of blacklist
 160 * @num_profiles:       num of profiles in the list
 161 * @match_notify:       clients waiting for match found notification
 162 * @pass_match:         clients waiting for the results
 163 * @active_clients:     active clients bitmap - enum scan_framework_client
 164 * @any_beacon_notify:  clients waiting for match notification without match
 165 */
 166struct iwl_scan_offload_profile_cfg {
 167        struct iwl_scan_offload_profile profiles[IWL_SCAN_MAX_PROFILES];
 168        u8 blacklist_len;
 169        u8 num_profiles;
 170        u8 match_notify;
 171        u8 pass_match;
 172        u8 active_clients;
 173        u8 any_beacon_notify;
 174        u8 reserved[2];
 175} __packed;
 176
 177/**
 178 * iwl_scan_schedule_lmac - schedule of scan offload
 179 * @delay:              delay between iterations, in seconds.
 180 * @iterations:         num of scan iterations
 181 * @full_scan_mul:      number of partial scans before each full scan
 182 */
 183struct iwl_scan_schedule_lmac {
 184        __le16 delay;
 185        u8 iterations;
 186        u8 full_scan_mul;
 187} __packed; /* SCAN_SCHEDULE_API_S */
 188
 189enum iwl_scan_offload_complete_status {
 190        IWL_SCAN_OFFLOAD_COMPLETED      = 1,
 191        IWL_SCAN_OFFLOAD_ABORTED        = 2,
 192};
 193
 194enum iwl_scan_ebs_status {
 195        IWL_SCAN_EBS_SUCCESS,
 196        IWL_SCAN_EBS_FAILED,
 197        IWL_SCAN_EBS_CHAN_NOT_FOUND,
 198        IWL_SCAN_EBS_INACTIVE,
 199};
 200
 201/**
 202 * iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
 203 * @tx_flags: combination of TX_CMD_FLG_*
 204 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
 205 *      cleared. Combination of RATE_MCS_*
 206 * @sta_id: index of destination station in FW station table
 207 * @reserved: for alignment and future use
 208 */
 209struct iwl_scan_req_tx_cmd {
 210        __le32 tx_flags;
 211        __le32 rate_n_flags;
 212        u8 sta_id;
 213        u8 reserved[3];
 214} __packed;
 215
 216enum iwl_scan_channel_flags_lmac {
 217        IWL_UNIFIED_SCAN_CHANNEL_FULL           = BIT(27),
 218        IWL_UNIFIED_SCAN_CHANNEL_PARTIAL        = BIT(28),
 219};
 220
 221/**
 222 * iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
 223 * @flags:              bits 1-20: directed scan to i'th ssid
 224 *                      other bits &enum iwl_scan_channel_flags_lmac
 225 * @channel_number:     channel number 1-13 etc
 226 * @iter_count:         scan iteration on this channel
 227 * @iter_interval:      interval in seconds between iterations on one channel
 228 */
 229struct iwl_scan_channel_cfg_lmac {
 230        __le32 flags;
 231        __le16 channel_num;
 232        __le16 iter_count;
 233        __le32 iter_interval;
 234} __packed;
 235
 236/*
 237 * iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
 238 * @offset: offset in the data block
 239 * @len: length of the segment
 240 */
 241struct iwl_scan_probe_segment {
 242        __le16 offset;
 243        __le16 len;
 244} __packed;
 245
 246/* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_2
 247 * @mac_header: first (and common) part of the probe
 248 * @band_data: band specific data
 249 * @common_data: last (and common) part of the probe
 250 * @buf: raw data block
 251 */
 252struct iwl_scan_probe_req {
 253        struct iwl_scan_probe_segment mac_header;
 254        struct iwl_scan_probe_segment band_data[2];
 255        struct iwl_scan_probe_segment common_data;
 256        u8 buf[SCAN_OFFLOAD_PROBE_REQ_SIZE];
 257} __packed;
 258
 259enum iwl_scan_channel_flags {
 260        IWL_SCAN_CHANNEL_FLAG_EBS               = BIT(0),
 261        IWL_SCAN_CHANNEL_FLAG_EBS_ACCURATE      = BIT(1),
 262        IWL_SCAN_CHANNEL_FLAG_CACHE_ADD         = BIT(2),
 263};
 264
 265/* iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
 266 * @flags: enum iwl_scan_channel_flags
 267 * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is
 268 *      involved.
 269 *      1 - EBS is disabled.
 270 *      2 - every second scan will be full scan(and so on).
 271 */
 272struct iwl_scan_channel_opt {
 273        __le16 flags;
 274        __le16 non_ebs_ratio;
 275} __packed;
 276
 277/**
 278 * iwl_mvm_lmac_scan_flags
 279 * @IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL: pass all beacons and probe responses
 280 *      without filtering.
 281 * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
 282 * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
 283 * @IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE: send iteration complete notification
 284 * @IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS multiple SSID matching
 285 * @IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED: all passive scans will be fragmented
 286 * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
 287 *      and DS parameter set IEs into probe requests.
 288 * @IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL: use extended dwell time on channels
 289 *      1, 6 and 11.
 290 * @IWL_MVM_LMAC_SCAN_FLAG_MATCH: Send match found notification on matches
 291 */
 292enum iwl_mvm_lmac_scan_flags {
 293        IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL         = BIT(0),
 294        IWL_MVM_LMAC_SCAN_FLAG_PASSIVE          = BIT(1),
 295        IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION   = BIT(2),
 296        IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE    = BIT(3),
 297        IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS   = BIT(4),
 298        IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED       = BIT(5),
 299        IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED     = BIT(6),
 300        IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL   = BIT(7),
 301        IWL_MVM_LMAC_SCAN_FLAG_MATCH            = BIT(9),
 302};
 303
 304enum iwl_scan_priority {
 305        IWL_SCAN_PRIORITY_LOW,
 306        IWL_SCAN_PRIORITY_MEDIUM,
 307        IWL_SCAN_PRIORITY_HIGH,
 308};
 309
 310enum iwl_scan_priority_ext {
 311        IWL_SCAN_PRIORITY_EXT_0_LOWEST,
 312        IWL_SCAN_PRIORITY_EXT_1,
 313        IWL_SCAN_PRIORITY_EXT_2,
 314        IWL_SCAN_PRIORITY_EXT_3,
 315        IWL_SCAN_PRIORITY_EXT_4,
 316        IWL_SCAN_PRIORITY_EXT_5,
 317        IWL_SCAN_PRIORITY_EXT_6,
 318        IWL_SCAN_PRIORITY_EXT_7_HIGHEST,
 319};
 320
 321/**
 322 * iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
 323 * @reserved1: for alignment and future use
 324 * @channel_num: num of channels to scan
 325 * @active-dwell: dwell time for active channels
 326 * @passive-dwell: dwell time for passive channels
 327 * @fragmented-dwell: dwell time for fragmented passive scan
 328 * @extended_dwell: dwell time for channels 1, 6 and 11 (in certain cases)
 329 * @reserved2: for alignment and future use
 330 * @rx_chain_selct: PHY_RX_CHAIN_* flags
 331 * @scan_flags: &enum iwl_mvm_lmac_scan_flags
 332 * @max_out_time: max time (in TU) to be out of associated channel
 333 * @suspend_time: pause scan this long (TUs) when returning to service channel
 334 * @flags: RXON flags
 335 * @filter_flags: RXON filter
 336 * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
 337 * @direct_scan: list of SSIDs for directed active scan
 338 * @scan_prio: enum iwl_scan_priority
 339 * @iter_num: number of scan iterations
 340 * @delay: delay in seconds before first iteration
 341 * @schedule: two scheduling plans. The first one is finite, the second one can
 342 *      be infinite.
 343 * @channel_opt: channel optimization options, for full and partial scan
 344 * @data: channel configuration and probe request packet.
 345 */
 346struct iwl_scan_req_lmac {
 347        /* SCAN_REQUEST_FIXED_PART_API_S_VER_7 */
 348        __le32 reserved1;
 349        u8 n_channels;
 350        u8 active_dwell;
 351        u8 passive_dwell;
 352        u8 fragmented_dwell;
 353        u8 extended_dwell;
 354        u8 reserved2;
 355        __le16 rx_chain_select;
 356        __le32 scan_flags;
 357        __le32 max_out_time;
 358        __le32 suspend_time;
 359        /* RX_ON_FLAGS_API_S_VER_1 */
 360        __le32 flags;
 361        __le32 filter_flags;
 362        struct iwl_scan_req_tx_cmd tx_cmd[2];
 363        struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 364        __le32 scan_prio;
 365        /* SCAN_REQ_PERIODIC_PARAMS_API_S */
 366        __le32 iter_num;
 367        __le32 delay;
 368        struct iwl_scan_schedule_lmac schedule[IWL_MAX_SCHED_SCAN_PLANS];
 369        struct iwl_scan_channel_opt channel_opt[2];
 370        u8 data[];
 371} __packed;
 372
 373/**
 374 * struct iwl_scan_results_notif - scan results for one channel -
 375 *      SCAN_RESULT_NTF_API_S_VER_3
 376 * @channel: which channel the results are from
 377 * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
 378 * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
 379 * @num_probe_not_sent: # of request that weren't sent due to not enough time
 380 * @duration: duration spent in channel, in usecs
 381 */
 382struct iwl_scan_results_notif {
 383        u8 channel;
 384        u8 band;
 385        u8 probe_status;
 386        u8 num_probe_not_sent;
 387        __le32 duration;
 388} __packed;
 389
 390/**
 391 * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
 392 *      SCAN_COMPLETE_NTF_API_S_VER_3
 393 * @scanned_channels: number of channels scanned (and number of valid results)
 394 * @status: one of SCAN_COMP_STATUS_*
 395 * @bt_status: BT on/off status
 396 * @last_channel: last channel that was scanned
 397 * @tsf_low: TSF timer (lower half) in usecs
 398 * @tsf_high: TSF timer (higher half) in usecs
 399 * @results: an array of scan results, only "scanned_channels" of them are valid
 400 */
 401struct iwl_lmac_scan_complete_notif {
 402        u8 scanned_channels;
 403        u8 status;
 404        u8 bt_status;
 405        u8 last_channel;
 406        __le32 tsf_low;
 407        __le32 tsf_high;
 408        struct iwl_scan_results_notif results[];
 409} __packed;
 410
 411/**
 412 * iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
 413 * @last_schedule_line: last schedule line executed (fast or regular)
 414 * @last_schedule_iteration: last scan iteration executed before scan abort
 415 * @status: enum iwl_scan_offload_complete_status
 416 * @ebs_status: EBS success status &enum iwl_scan_ebs_status
 417 * @time_after_last_iter; time in seconds elapsed after last iteration
 418 */
 419struct iwl_periodic_scan_complete {
 420        u8 last_schedule_line;
 421        u8 last_schedule_iteration;
 422        u8 status;
 423        u8 ebs_status;
 424        __le32 time_after_last_iter;
 425        __le32 reserved;
 426} __packed;
 427
 428/* UMAC Scan API */
 429
 430/* The maximum of either of these cannot exceed 8, because we use an
 431 * 8-bit mask (see IWL_MVM_SCAN_MASK in mvm.h).
 432 */
 433#define IWL_MVM_MAX_UMAC_SCANS 8
 434#define IWL_MVM_MAX_LMAC_SCANS 1
 435
 436enum scan_config_flags {
 437        SCAN_CONFIG_FLAG_ACTIVATE                       = BIT(0),
 438        SCAN_CONFIG_FLAG_DEACTIVATE                     = BIT(1),
 439        SCAN_CONFIG_FLAG_FORBID_CHUB_REQS               = BIT(2),
 440        SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS                = BIT(3),
 441        SCAN_CONFIG_FLAG_SET_TX_CHAINS                  = BIT(8),
 442        SCAN_CONFIG_FLAG_SET_RX_CHAINS                  = BIT(9),
 443        SCAN_CONFIG_FLAG_SET_AUX_STA_ID                 = BIT(10),
 444        SCAN_CONFIG_FLAG_SET_ALL_TIMES                  = BIT(11),
 445        SCAN_CONFIG_FLAG_SET_EFFECTIVE_TIMES            = BIT(12),
 446        SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS              = BIT(13),
 447        SCAN_CONFIG_FLAG_SET_LEGACY_RATES               = BIT(14),
 448        SCAN_CONFIG_FLAG_SET_MAC_ADDR                   = BIT(15),
 449        SCAN_CONFIG_FLAG_SET_FRAGMENTED                 = BIT(16),
 450        SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED               = BIT(17),
 451        SCAN_CONFIG_FLAG_SET_CAM_MODE                   = BIT(18),
 452        SCAN_CONFIG_FLAG_CLEAR_CAM_MODE                 = BIT(19),
 453        SCAN_CONFIG_FLAG_SET_PROMISC_MODE               = BIT(20),
 454        SCAN_CONFIG_FLAG_CLEAR_PROMISC_MODE             = BIT(21),
 455
 456        /* Bits 26-31 are for num of channels in channel_array */
 457#define SCAN_CONFIG_N_CHANNELS(n) ((n) << 26)
 458};
 459
 460enum scan_config_rates {
 461        /* OFDM basic rates */
 462        SCAN_CONFIG_RATE_6M     = BIT(0),
 463        SCAN_CONFIG_RATE_9M     = BIT(1),
 464        SCAN_CONFIG_RATE_12M    = BIT(2),
 465        SCAN_CONFIG_RATE_18M    = BIT(3),
 466        SCAN_CONFIG_RATE_24M    = BIT(4),
 467        SCAN_CONFIG_RATE_36M    = BIT(5),
 468        SCAN_CONFIG_RATE_48M    = BIT(6),
 469        SCAN_CONFIG_RATE_54M    = BIT(7),
 470        /* CCK basic rates */
 471        SCAN_CONFIG_RATE_1M     = BIT(8),
 472        SCAN_CONFIG_RATE_2M     = BIT(9),
 473        SCAN_CONFIG_RATE_5M     = BIT(10),
 474        SCAN_CONFIG_RATE_11M    = BIT(11),
 475
 476        /* Bits 16-27 are for supported rates */
 477#define SCAN_CONFIG_SUPPORTED_RATE(rate)        ((rate) << 16)
 478};
 479
 480enum iwl_channel_flags {
 481        IWL_CHANNEL_FLAG_EBS                            = BIT(0),
 482        IWL_CHANNEL_FLAG_ACCURATE_EBS                   = BIT(1),
 483        IWL_CHANNEL_FLAG_EBS_ADD                        = BIT(2),
 484        IWL_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE        = BIT(3),
 485};
 486
 487/**
 488 * struct iwl_scan_config
 489 * @flags:                      enum scan_config_flags
 490 * @tx_chains:                  valid_tx antenna - ANT_* definitions
 491 * @rx_chains:                  valid_rx antenna - ANT_* definitions
 492 * @legacy_rates:               default legacy rates - enum scan_config_rates
 493 * @out_of_channel_time:        default max out of serving channel time
 494 * @suspend_time:               default max suspend time
 495 * @dwell_active:               default dwell time for active scan
 496 * @dwell_passive:              default dwell time for passive scan
 497 * @dwell_fragmented:           default dwell time for fragmented scan
 498 * @dwell_extended:             default dwell time for channels 1, 6 and 11
 499 * @mac_addr:                   default mac address to be used in probes
 500 * @bcast_sta_id:               the index of the station in the fw
 501 * @channel_flags:              default channel flags - enum iwl_channel_flags
 502 *                              scan_config_channel_flag
 503 * @channel_array:              default supported channels
 504 */
 505struct iwl_scan_config {
 506        __le32 flags;
 507        __le32 tx_chains;
 508        __le32 rx_chains;
 509        __le32 legacy_rates;
 510        __le32 out_of_channel_time;
 511        __le32 suspend_time;
 512        u8 dwell_active;
 513        u8 dwell_passive;
 514        u8 dwell_fragmented;
 515        u8 dwell_extended;
 516        u8 mac_addr[ETH_ALEN];
 517        u8 bcast_sta_id;
 518        u8 channel_flags;
 519        u8 channel_array[];
 520} __packed; /* SCAN_CONFIG_DB_CMD_API_S */
 521
 522/**
 523 * iwl_umac_scan_flags
 524 *@IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
 525 *      can be preempted by other scan requests with higher priority.
 526 *      The low priority scan will be resumed when the higher proirity scan is
 527 *      completed.
 528 *@IWL_UMAC_SCAN_FLAG_START_NOTIF: notification will be sent to the driver
 529 *      when scan starts.
 530 */
 531enum iwl_umac_scan_flags {
 532        IWL_UMAC_SCAN_FLAG_PREEMPTIVE           = BIT(0),
 533        IWL_UMAC_SCAN_FLAG_START_NOTIF          = BIT(1),
 534};
 535
 536enum iwl_umac_scan_uid_offsets {
 537        IWL_UMAC_SCAN_UID_TYPE_OFFSET           = 0,
 538        IWL_UMAC_SCAN_UID_SEQ_OFFSET            = 8,
 539};
 540
 541enum iwl_umac_scan_general_flags {
 542        IWL_UMAC_SCAN_GEN_FLAGS_PERIODIC        = BIT(0),
 543        IWL_UMAC_SCAN_GEN_FLAGS_OVER_BT         = BIT(1),
 544        IWL_UMAC_SCAN_GEN_FLAGS_PASS_ALL        = BIT(2),
 545        IWL_UMAC_SCAN_GEN_FLAGS_PASSIVE         = BIT(3),
 546        IWL_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT     = BIT(4),
 547        IWL_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE   = BIT(5),
 548        IWL_UMAC_SCAN_GEN_FLAGS_MULTIPLE_SSID   = BIT(6),
 549        IWL_UMAC_SCAN_GEN_FLAGS_FRAGMENTED      = BIT(7),
 550        IWL_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED     = BIT(8),
 551        IWL_UMAC_SCAN_GEN_FLAGS_MATCH           = BIT(9),
 552        IWL_UMAC_SCAN_GEN_FLAGS_EXTENDED_DWELL  = BIT(10),
 553};
 554
 555/**
 556 * struct iwl_scan_channel_cfg_umac
 557 * @flags:              bitmap - 0-19:  directed scan to i'th ssid.
 558 * @channel_num:        channel number 1-13 etc.
 559 * @iter_count:         repetition count for the channel.
 560 * @iter_interval:      interval between two scan iterations on one channel.
 561 */
 562struct iwl_scan_channel_cfg_umac {
 563        __le32 flags;
 564        u8 channel_num;
 565        u8 iter_count;
 566        __le16 iter_interval;
 567} __packed; /* SCAN_CHANNEL_CFG_S_VER2 */
 568
 569/**
 570 * struct iwl_scan_umac_schedule
 571 * @interval: interval in seconds between scan iterations
 572 * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
 573 * @reserved: for alignment and future use
 574 */
 575struct iwl_scan_umac_schedule {
 576        __le16 interval;
 577        u8 iter_count;
 578        u8 reserved;
 579} __packed; /* SCAN_SCHED_PARAM_API_S_VER_1 */
 580
 581/**
 582 * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
 583 *      parameters following channels configuration array.
 584 * @schedule: two scheduling plans.
 585 * @delay: delay in TUs before starting the first scan iteration
 586 * @reserved: for future use and alignment
 587 * @preq: probe request with IEs blocks
 588 * @direct_scan: list of SSIDs for directed active scan
 589 */
 590struct iwl_scan_req_umac_tail {
 591        /* SCAN_PERIODIC_PARAMS_API_S_VER_1 */
 592        struct iwl_scan_umac_schedule schedule[IWL_MAX_SCHED_SCAN_PLANS];
 593        __le16 delay;
 594        __le16 reserved;
 595        /* SCAN_PROBE_PARAMS_API_S_VER_1 */
 596        struct iwl_scan_probe_req preq;
 597        struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 598} __packed;
 599
 600/**
 601 * struct iwl_scan_req_umac
 602 * @flags: &enum iwl_umac_scan_flags
 603 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 604 * @ooc_priority: out of channel priority - &enum iwl_scan_priority
 605 * @general_flags: &enum iwl_umac_scan_general_flags
 606 * @extended_dwell: dwell time for channels 1, 6 and 11
 607 * @active_dwell: dwell time for active scan
 608 * @passive_dwell: dwell time for passive scan
 609 * @fragmented_dwell: dwell time for fragmented passive scan
 610 * @max_out_time: max out of serving channel time
 611 * @suspend_time: max suspend time
 612 * @scan_priority: scan internal prioritization &enum iwl_scan_priority
 613 * @channel_flags: &enum iwl_scan_channel_flags
 614 * @n_channels: num of channels in scan request
 615 * @reserved: for future use and alignment
 616 * @data: &struct iwl_scan_channel_cfg_umac and
 617 *      &struct iwl_scan_req_umac_tail
 618 */
 619struct iwl_scan_req_umac {
 620        __le32 flags;
 621        __le32 uid;
 622        __le32 ooc_priority;
 623        /* SCAN_GENERAL_PARAMS_API_S_VER_1 */
 624        __le32 general_flags;
 625        u8 extended_dwell;
 626        u8 active_dwell;
 627        u8 passive_dwell;
 628        u8 fragmented_dwell;
 629        __le32 max_out_time;
 630        __le32 suspend_time;
 631        __le32 scan_priority;
 632        /* SCAN_CHANNEL_PARAMS_API_S_VER_1 */
 633        u8 channel_flags;
 634        u8 n_channels;
 635        __le16 reserved;
 636        u8 data[];
 637} __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_1 */
 638
 639/**
 640 * struct iwl_umac_scan_abort
 641 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 642 * @flags: reserved
 643 */
 644struct iwl_umac_scan_abort {
 645        __le32 uid;
 646        __le32 flags;
 647} __packed; /* SCAN_ABORT_CMD_UMAC_API_S_VER_1 */
 648
 649/**
 650 * struct iwl_umac_scan_complete
 651 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 652 * @last_schedule: last scheduling line
 653 * @last_iter:  last scan iteration number
 654 * @scan status: &enum iwl_scan_offload_complete_status
 655 * @ebs_status: &enum iwl_scan_ebs_status
 656 * @time_from_last_iter: time elapsed from last iteration
 657 * @reserved: for future use
 658 */
 659struct iwl_umac_scan_complete {
 660        __le32 uid;
 661        u8 last_schedule;
 662        u8 last_iter;
 663        u8 status;
 664        u8 ebs_status;
 665        __le32 time_from_last_iter;
 666        __le32 reserved;
 667} __packed; /* SCAN_COMPLETE_NTF_UMAC_API_S_VER_1 */
 668
 669#define SCAN_OFFLOAD_MATCHING_CHANNELS_LEN 5
 670/**
 671 * struct iwl_scan_offload_profile_match - match information
 672 * @bssid: matched bssid
 673 * @channel: channel where the match occurred
 674 * @energy:
 675 * @matching_feature:
 676 * @matching_channels: bitmap of channels that matched, referencing
 677 *      the channels passed in tue scan offload request
 678 */
 679struct iwl_scan_offload_profile_match {
 680        u8 bssid[ETH_ALEN];
 681        __le16 reserved;
 682        u8 channel;
 683        u8 energy;
 684        u8 matching_feature;
 685        u8 matching_channels[SCAN_OFFLOAD_MATCHING_CHANNELS_LEN];
 686} __packed; /* SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S_VER_1 */
 687
 688/**
 689 * struct iwl_scan_offload_profiles_query - match results query response
 690 * @matched_profiles: bitmap of matched profiles, referencing the
 691 *      matches passed in the scan offload request
 692 * @last_scan_age: age of the last offloaded scan
 693 * @n_scans_done: number of offloaded scans done
 694 * @gp2_d0u: GP2 when D0U occurred
 695 * @gp2_invoked: GP2 when scan offload was invoked
 696 * @resume_while_scanning: not used
 697 * @self_recovery: obsolete
 698 * @reserved: reserved
 699 * @matches: array of match information, one for each match
 700 */
 701struct iwl_scan_offload_profiles_query {
 702        __le32 matched_profiles;
 703        __le32 last_scan_age;
 704        __le32 n_scans_done;
 705        __le32 gp2_d0u;
 706        __le32 gp2_invoked;
 707        u8 resume_while_scanning;
 708        u8 self_recovery;
 709        __le16 reserved;
 710        struct iwl_scan_offload_profile_match matches[IWL_SCAN_MAX_PROFILES];
 711} __packed; /* SCAN_OFFLOAD_PROFILES_QUERY_RSP_S_VER_2 */
 712
 713/**
 714 * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
 715 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 716 * @scanned_channels: number of channels scanned and number of valid elements in
 717 *      results array
 718 * @status: one of SCAN_COMP_STATUS_*
 719 * @bt_status: BT on/off status
 720 * @last_channel: last channel that was scanned
 721 * @tsf_low: TSF timer (lower half) in usecs
 722 * @tsf_high: TSF timer (higher half) in usecs
 723 * @results: array of scan results, only "scanned_channels" of them are valid
 724 */
 725struct iwl_umac_scan_iter_complete_notif {
 726        __le32 uid;
 727        u8 scanned_channels;
 728        u8 status;
 729        u8 bt_status;
 730        u8 last_channel;
 731        __le32 tsf_low;
 732        __le32 tsf_high;
 733        struct iwl_scan_results_notif results[];
 734} __packed; /* SCAN_ITER_COMPLETE_NTF_UMAC_API_S_VER_1 */
 735
 736#endif
 737