drivers/net/wireless/iwlwifi/mvm/fw-api-scan.h

   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 <ilw@linux.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  */
  84 struct 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 /* How many statistics are gathered for each channel */
  91 #define SCAN_RESULTS_STATISTICS 1
  92
  93 /**
  94  * enum iwl_scan_complete_status - status codes for scan complete notifications
  95  * @SCAN_COMP_STATUS_OK:  scan completed successfully
  96  * @SCAN_COMP_STATUS_ABORT: scan was aborted by user
  97  * @SCAN_COMP_STATUS_ERR_SLEEP: sending null sleep packet failed
  98  * @SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT: timeout before channel is ready
  99  * @SCAN_COMP_STATUS_ERR_PROBE: sending probe request failed
 100  * @SCAN_COMP_STATUS_ERR_WAKEUP: sending null wakeup packet failed
 101  * @SCAN_COMP_STATUS_ERR_ANTENNAS: invalid antennas chosen at scan command
 102  * @SCAN_COMP_STATUS_ERR_INTERNAL: internal error caused scan abort
 103  * @SCAN_COMP_STATUS_ERR_COEX: medium was lost ot WiMax
 104  * @SCAN_COMP_STATUS_P2P_ACTION_OK: P2P public action frame TX was successful
 105  *      (not an error!)
 106  * @SCAN_COMP_STATUS_ITERATION_END: indicates end of one repetition the driver
 107  *      asked for
 108  * @SCAN_COMP_STATUS_ERR_ALLOC_TE: scan could not allocate time events
 109 */
 110 enum iwl_scan_complete_status {
 111         SCAN_COMP_STATUS_OK = 0x1,
 112         SCAN_COMP_STATUS_ABORT = 0x2,
 113         SCAN_COMP_STATUS_ERR_SLEEP = 0x3,
 114         SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT = 0x4,
 115         SCAN_COMP_STATUS_ERR_PROBE = 0x5,
 116         SCAN_COMP_STATUS_ERR_WAKEUP = 0x6,
 117         SCAN_COMP_STATUS_ERR_ANTENNAS = 0x7,
 118         SCAN_COMP_STATUS_ERR_INTERNAL = 0x8,
 119         SCAN_COMP_STATUS_ERR_COEX = 0x9,
 120         SCAN_COMP_STATUS_P2P_ACTION_OK = 0xA,
 121         SCAN_COMP_STATUS_ITERATION_END = 0x0B,
 122         SCAN_COMP_STATUS_ERR_ALLOC_TE = 0x0C,
 123 };
 124
 125 /* scan offload */
 126 #define IWL_SCAN_MAX_BLACKLIST_LEN      64
 127 #define IWL_SCAN_SHORT_BLACKLIST_LEN    16
 128 #define IWL_SCAN_MAX_PROFILES           11
 129 #define SCAN_OFFLOAD_PROBE_REQ_SIZE     512
 130
 131 /* Default watchdog (in MS) for scheduled scan iteration */
 132 #define IWL_SCHED_SCAN_WATCHDOG cpu_to_le16(15000)
 133
 134 #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
 135 #define CAN_ABORT_STATUS 1
 136
 137 #define IWL_FULL_SCAN_MULTIPLIER 5
 138 #define IWL_FAST_SCHED_SCAN_ITERATIONS 3
 139
 140 enum scan_framework_client {
 141         SCAN_CLIENT_SCHED_SCAN          = BIT(0),
 142         SCAN_CLIENT_NETDETECT           = BIT(1),
 143         SCAN_CLIENT_ASSET_TRACKING      = BIT(2),
 144 };
 145
 146 /**
 147  * struct iwl_scan_offload_cmd - SCAN_REQUEST_FIXED_PART_API_S_VER_6
 148  * @scan_flags:         see enum iwl_scan_flags
 149  * @channel_count:      channels in channel list
 150  * @quiet_time:         dwell time, in milliseconds, on quiet channel
 151  * @quiet_plcp_th:      quiet channel num of packets threshold
 152  * @good_CRC_th:        passive to active promotion threshold
 153  * @rx_chain:           RXON rx chain.
 154  * @max_out_time:       max TUs to be out of associated channel
 155  * @suspend_time:       pause scan this TUs when returning to service channel
 156  * @flags:              RXON flags
 157  * @filter_flags:       RXONfilter
 158  * @tx_cmd:             tx command for active scan; for 2GHz and for 5GHz.
 159  * @direct_scan:        list of SSIDs for directed active scan
 160  * @scan_type:          see enum iwl_scan_type.
 161  * @rep_count:          repetition count for each scheduled scan iteration.
 162  */
 163 struct iwl_scan_offload_cmd {
 164         __le16 len;
 165         u8 scan_flags;
 166         u8 channel_count;
 167         __le16 quiet_time;
 168         __le16 quiet_plcp_th;
 169         __le16 good_CRC_th;
 170         __le16 rx_chain;
 171         __le32 max_out_time;
 172         __le32 suspend_time;
 173         /* RX_ON_FLAGS_API_S_VER_1 */
 174         __le32 flags;
 175         __le32 filter_flags;
 176         struct iwl_tx_cmd tx_cmd[2];
 177         /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
 178         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 179         __le32 scan_type;
 180         __le32 rep_count;
 181 } __packed;
 182
 183 enum iwl_scan_offload_channel_flags {
 184         IWL_SCAN_OFFLOAD_CHANNEL_ACTIVE         = BIT(0),
 185         IWL_SCAN_OFFLOAD_CHANNEL_NARROW         = BIT(22),
 186         IWL_SCAN_OFFLOAD_CHANNEL_FULL           = BIT(24),
 187         IWL_SCAN_OFFLOAD_CHANNEL_PARTIAL        = BIT(25),
 188 };
 189
 190 /* channel configuration for struct iwl_scan_offload_cfg. Each channels needs:
 191  * __le32 type: bitmap; bits 1-20 are for directed scan to i'th ssid and
 192  *      see enum iwl_scan_offload_channel_flags.
 193  * __le16 channel_number: channel number 1-13 etc.
 194  * __le16 iter_count: repetition count for the channel.
 195  * __le32 iter_interval: interval between two iterations on one channel.
 196  * u8 active_dwell.
 197  * u8 passive_dwell.
 198  */
 199 #define IWL_SCAN_CHAN_SIZE 14
 200
 201 /**
 202  * iwl_scan_offload_cfg - SCAN_OFFLOAD_CONFIG_API_S
 203  * @scan_cmd:           scan command fixed part
 204  * @data:               scan channel configuration and probe request frames
 205  */
 206 struct iwl_scan_offload_cfg {
 207         struct iwl_scan_offload_cmd scan_cmd;
 208         u8 data[0];
 209 } __packed;
 210
 211 /**
 212  * iwl_scan_offload_blacklist - SCAN_OFFLOAD_BLACKLIST_S
 213  * @ssid:               MAC address to filter out
 214  * @reported_rssi:      AP rssi reported to the host
 215  * @client_bitmap: clients ignore this entry  - enum scan_framework_client
 216  */
 217 struct iwl_scan_offload_blacklist {
 218         u8 ssid[ETH_ALEN];
 219         u8 reported_rssi;
 220         u8 client_bitmap;
 221 } __packed;
 222
 223 enum iwl_scan_offload_network_type {
 224         IWL_NETWORK_TYPE_BSS    = 1,
 225         IWL_NETWORK_TYPE_IBSS   = 2,
 226         IWL_NETWORK_TYPE_ANY    = 3,
 227 };
 228
 229 enum iwl_scan_offload_band_selection {
 230         IWL_SCAN_OFFLOAD_SELECT_2_4     = 0x4,
 231         IWL_SCAN_OFFLOAD_SELECT_5_2     = 0x8,
 232         IWL_SCAN_OFFLOAD_SELECT_ANY     = 0xc,
 233 };
 234
 235 /**
 236  * iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
 237  * @ssid_index:         index to ssid list in fixed part
 238  * @unicast_cipher:     encryption algorithm to match - bitmap
 239  * @aut_alg:            authentication algorithm to match - bitmap
 240  * @network_type:       enum iwl_scan_offload_network_type
 241  * @band_selection:     enum iwl_scan_offload_band_selection
 242  * @client_bitmap:      clients waiting for match - enum scan_framework_client
 243  */
 244 struct iwl_scan_offload_profile {
 245         u8 ssid_index;
 246         u8 unicast_cipher;
 247         u8 auth_alg;
 248         u8 network_type;
 249         u8 band_selection;
 250         u8 client_bitmap;
 251         u8 reserved[2];
 252 } __packed;
 253
 254 /**
 255  * iwl_scan_offload_profile_cfg - SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1
 256  * @blaclist:           AP list to filter off from scan results
 257  * @profiles:           profiles to search for match
 258  * @blacklist_len:      length of blacklist
 259  * @num_profiles:       num of profiles in the list
 260  * @match_notify:       clients waiting for match found notification
 261  * @pass_match:         clients waiting for the results
 262  * @active_clients:     active clients bitmap - enum scan_framework_client
 263  * @any_beacon_notify:  clients waiting for match notification without match
 264  */
 265 struct iwl_scan_offload_profile_cfg {
 266         struct iwl_scan_offload_profile profiles[IWL_SCAN_MAX_PROFILES];
 267         u8 blacklist_len;
 268         u8 num_profiles;
 269         u8 match_notify;
 270         u8 pass_match;
 271         u8 active_clients;
 272         u8 any_beacon_notify;
 273         u8 reserved[2];
 274 } __packed;
 275
 276 /**
 277  * iwl_scan_schedule_lmac - schedule of scan offload
 278  * @delay:              delay between iterations, in seconds.
 279  * @iterations:         num of scan iterations
 280  * @full_scan_mul:      number of partial scans before each full scan
 281  */
 282 struct iwl_scan_schedule_lmac {
 283         __le16 delay;
 284         u8 iterations;
 285         u8 full_scan_mul;
 286 } __packed; /* SCAN_SCHEDULE_API_S */
 287
 288 enum iwl_scan_offload_complete_status {
 289         IWL_SCAN_OFFLOAD_COMPLETED      = 1,
 290         IWL_SCAN_OFFLOAD_ABORTED        = 2,
 291 };
 292
 293 enum iwl_scan_ebs_status {
 294         IWL_SCAN_EBS_SUCCESS,
 295         IWL_SCAN_EBS_FAILED,
 296         IWL_SCAN_EBS_CHAN_NOT_FOUND,
 297 };
 298
 299 /**
 300  * iwl_scan_offload_complete - SCAN_OFFLOAD_COMPLETE_NTF_API_S_VER_1
 301  * @last_schedule_line:         last schedule line executed (fast or regular)
 302  * @last_schedule_iteration:    last scan iteration executed before scan abort
 303  * @status:                     enum iwl_scan_offload_compleate_status
 304  * @ebs_status: last EBS status, see IWL_SCAN_EBS_*
 305  */
 306 struct iwl_scan_offload_complete {
 307         u8 last_schedule_line;
 308         u8 last_schedule_iteration;
 309         u8 status;
 310         u8 ebs_status;
 311 } __packed;
 312
 313 /**
 314  * iwl_sched_scan_results - SCAN_OFFLOAD_MATCH_FOUND_NTF_API_S_VER_1
 315  * @ssid_bitmap:        SSIDs indexes found in this iteration
 316  * @client_bitmap:      clients that are active and wait for this notification
 317  */
 318 struct iwl_sched_scan_results {
 319         __le16 ssid_bitmap;
 320         u8 client_bitmap;
 321         u8 reserved;
 322 };
 323
 324 /* Unified LMAC scan API */
 325
 326 #define IWL_MVM_BASIC_PASSIVE_DWELL 110
 327
 328 /**
 329  * iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
 330  * @tx_flags: combination of TX_CMD_FLG_*
 331  * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
 332  *      cleared. Combination of RATE_MCS_*
 333  * @sta_id: index of destination station in FW station table
 334  * @reserved: for alignment and future use
 335  */
 336 struct iwl_scan_req_tx_cmd {
 337         __le32 tx_flags;
 338         __le32 rate_n_flags;
 339         u8 sta_id;
 340         u8 reserved[3];
 341 } __packed;
 342
 343 enum iwl_scan_channel_flags_lmac {
 344         IWL_UNIFIED_SCAN_CHANNEL_FULL           = BIT(27),
 345         IWL_UNIFIED_SCAN_CHANNEL_PARTIAL        = BIT(28),
 346 };
 347
 348 /**
 349  * iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
 350  * @flags:              bits 1-20: directed scan to i'th ssid
 351  *                      other bits &enum iwl_scan_channel_flags_lmac
 352  * @channel_number:     channel number 1-13 etc
 353  * @iter_count:         scan iteration on this channel
 354  * @iter_interval:      interval in seconds between iterations on one channel
 355  */
 356 struct iwl_scan_channel_cfg_lmac {
 357         __le32 flags;
 358         __le16 channel_num;
 359         __le16 iter_count;
 360         __le32 iter_interval;
 361 } __packed;
 362
 363 /*
 364  * iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
 365  * @offset: offset in the data block
 366  * @len: length of the segment
 367  */
 368 struct iwl_scan_probe_segment {
 369         __le16 offset;
 370         __le16 len;
 371 } __packed;
 372
 373 /* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_2
 374  * @mac_header: first (and common) part of the probe
 375  * @band_data: band specific data
 376  * @common_data: last (and common) part of the probe
 377  * @buf: raw data block
 378  */
 379 struct iwl_scan_probe_req {
 380         struct iwl_scan_probe_segment mac_header;
 381         struct iwl_scan_probe_segment band_data[2];
 382         struct iwl_scan_probe_segment common_data;
 383         u8 buf[SCAN_OFFLOAD_PROBE_REQ_SIZE];
 384 } __packed;
 385
 386 enum iwl_scan_channel_flags {
 387         IWL_SCAN_CHANNEL_FLAG_EBS               = BIT(0),
 388         IWL_SCAN_CHANNEL_FLAG_EBS_ACCURATE      = BIT(1),
 389         IWL_SCAN_CHANNEL_FLAG_CACHE_ADD         = BIT(2),
 390 };
 391
 392 /* iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
 393  * @flags: enum iwl_scan_channel_flags
 394  * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is
 395  *      involved.
 396  *      1 - EBS is disabled.
 397  *      2 - every second scan will be full scan(and so on).
 398  */
 399 struct iwl_scan_channel_opt {
 400         __le16 flags;
 401         __le16 non_ebs_ratio;
 402 } __packed;
 403
 404 /**
 405  * iwl_mvm_lmac_scan_flags
 406  * @IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL: pass all beacons and probe responses
 407  *      without filtering.
 408  * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
 409  * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
 410  * @IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE: send iteration complete notification
 411  * @IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS multiple SSID matching
 412  * @IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED: all passive scans will be fragmented
 413  * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
 414  *      and DS parameter set IEs into probe requests.
 415  * @IWL_MVM_LMAC_SCAN_FLAG_MATCH: Send match found notification on matches
 416  */
 417 enum iwl_mvm_lmac_scan_flags {
 418         IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL         = BIT(0),
 419         IWL_MVM_LMAC_SCAN_FLAG_PASSIVE          = BIT(1),
 420         IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION   = BIT(2),
 421         IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE    = BIT(3),
 422         IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS   = BIT(4),
 423         IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED       = BIT(5),
 424         IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED     = BIT(6),
 425         IWL_MVM_LMAC_SCAN_FLAG_MATCH            = BIT(9),
 426 };
 427
 428 enum iwl_scan_priority {
 429         IWL_SCAN_PRIORITY_LOW,
 430         IWL_SCAN_PRIORITY_MEDIUM,
 431         IWL_SCAN_PRIORITY_HIGH,
 432 };
 433
 434 /**
 435  * iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
 436  * @reserved1: for alignment and future use
 437  * @channel_num: num of channels to scan
 438  * @active-dwell: dwell time for active channels
 439  * @passive-dwell: dwell time for passive channels
 440  * @fragmented-dwell: dwell time for fragmented passive scan
 441  * @reserved2: for alignment and future use
 442  * @rx_chain_selct: PHY_RX_CHAIN_* flags
 443  * @scan_flags: &enum iwl_mvm_lmac_scan_flags
 444  * @max_out_time: max time (in TU) to be out of associated channel
 445  * @suspend_time: pause scan this long (TUs) when returning to service channel
 446  * @flags: RXON flags
 447  * @filter_flags: RXON filter
 448  * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
 449  * @direct_scan: list of SSIDs for directed active scan
 450  * @scan_prio: enum iwl_scan_priority
 451  * @iter_num: number of scan iterations
 452  * @delay: delay in seconds before first iteration
 453  * @schedule: two scheduling plans. The first one is finite, the second one can
 454  *      be infinite.
 455  * @channel_opt: channel optimization options, for full and partial scan
 456  * @data: channel configuration and probe request packet.
 457  */
 458 struct iwl_scan_req_lmac {
 459         /* SCAN_REQUEST_FIXED_PART_API_S_VER_7 */
 460         __le32 reserved1;
 461         u8 n_channels;
 462         u8 active_dwell;
 463         u8 passive_dwell;
 464         u8 fragmented_dwell;
 465         __le16 reserved2;
 466         __le16 rx_chain_select;
 467         __le32 scan_flags;
 468         __le32 max_out_time;
 469         __le32 suspend_time;
 470         /* RX_ON_FLAGS_API_S_VER_1 */
 471         __le32 flags;
 472         __le32 filter_flags;
 473         struct iwl_scan_req_tx_cmd tx_cmd[2];
 474         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 475         __le32 scan_prio;
 476         /* SCAN_REQ_PERIODIC_PARAMS_API_S */
 477         __le32 iter_num;
 478         __le32 delay;
 479         struct iwl_scan_schedule_lmac schedule[2];
 480         struct iwl_scan_channel_opt channel_opt[2];
 481         u8 data[];
 482 } __packed;
 483
 484 /**
 485  * struct iwl_scan_results_notif - scan results for one channel -
 486  *      SCAN_RESULT_NTF_API_S_VER_3
 487  * @channel: which channel the results are from
 488  * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
 489  * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
 490  * @num_probe_not_sent: # of request that weren't sent due to not enough time
 491  * @duration: duration spent in channel, in usecs
 492  */
 493 struct iwl_scan_results_notif {
 494         u8 channel;
 495         u8 band;
 496         u8 probe_status;
 497         u8 num_probe_not_sent;
 498         __le32 duration;
 499 } __packed;
 500
 501 /**
 502  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
 503  *      SCAN_COMPLETE_NTF_API_S_VER_3
 504  * @scanned_channels: number of channels scanned (and number of valid results)
 505  * @status: one of SCAN_COMP_STATUS_*
 506  * @bt_status: BT on/off status
 507  * @last_channel: last channel that was scanned
 508  * @tsf_low: TSF timer (lower half) in usecs
 509  * @tsf_high: TSF timer (higher half) in usecs
 510  * @results: an array of scan results, only "scanned_channels" of them are valid
 511  */
 512 struct iwl_lmac_scan_complete_notif {
 513         u8 scanned_channels;
 514         u8 status;
 515         u8 bt_status;
 516         u8 last_channel;
 517         __le32 tsf_low;
 518         __le32 tsf_high;
 519         struct iwl_scan_results_notif results[];
 520 } __packed;
 521
 522 /**
 523  * iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
 524  * @last_schedule_line: last schedule line executed (fast or regular)
 525  * @last_schedule_iteration: last scan iteration executed before scan abort
 526  * @status: enum iwl_scan_offload_complete_status
 527  * @ebs_status: EBS success status &enum iwl_scan_ebs_status
 528  * @time_after_last_iter; time in seconds elapsed after last iteration
 529  */
 530 struct iwl_periodic_scan_complete {
 531         u8 last_schedule_line;
 532         u8 last_schedule_iteration;
 533         u8 status;
 534         u8 ebs_status;
 535         __le32 time_after_last_iter;
 536         __le32 reserved;
 537 } __packed;
 538
 539 /* UMAC Scan API */
 540
 541 /**
 542  * struct iwl_mvm_umac_cmd_hdr - Command header for UMAC commands
 543  * @size:       size of the command (not including header)
 544  * @reserved0:  for future use and alignment
 545  * @ver:        API version number
 546  */
 547 struct iwl_mvm_umac_cmd_hdr {
 548         __le16 size;
 549         u8 reserved0;
 550         u8 ver;
 551 } __packed;
 552
 553 /* The maximum of either of these cannot exceed 8, because we use an
 554  * 8-bit mask (see IWL_MVM_SCAN_MASK in mvm.h).
 555  */
 556 #define IWL_MVM_MAX_UMAC_SCANS 8
 557 #define IWL_MVM_MAX_LMAC_SCANS 1
 558
 559 enum scan_config_flags {
 560         SCAN_CONFIG_FLAG_ACTIVATE                       = BIT(0),
 561         SCAN_CONFIG_FLAG_DEACTIVATE                     = BIT(1),
 562         SCAN_CONFIG_FLAG_FORBID_CHUB_REQS               = BIT(2),
 563         SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS                = BIT(3),
 564         SCAN_CONFIG_FLAG_SET_TX_CHAINS                  = BIT(8),
 565         SCAN_CONFIG_FLAG_SET_RX_CHAINS                  = BIT(9),
 566         SCAN_CONFIG_FLAG_SET_AUX_STA_ID                 = BIT(10),
 567         SCAN_CONFIG_FLAG_SET_ALL_TIMES                  = BIT(11),
 568         SCAN_CONFIG_FLAG_SET_EFFECTIVE_TIMES            = BIT(12),
 569         SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS              = BIT(13),
 570         SCAN_CONFIG_FLAG_SET_LEGACY_RATES               = BIT(14),
 571         SCAN_CONFIG_FLAG_SET_MAC_ADDR                   = BIT(15),
 572         SCAN_CONFIG_FLAG_SET_FRAGMENTED                 = BIT(16),
 573         SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED               = BIT(17),
 574         SCAN_CONFIG_FLAG_SET_CAM_MODE                   = BIT(18),
 575         SCAN_CONFIG_FLAG_CLEAR_CAM_MODE                 = BIT(19),
 576         SCAN_CONFIG_FLAG_SET_PROMISC_MODE               = BIT(20),
 577         SCAN_CONFIG_FLAG_CLEAR_PROMISC_MODE             = BIT(21),
 578
 579         /* Bits 26-31 are for num of channels in channel_array */
 580 #define SCAN_CONFIG_N_CHANNELS(n) ((n) << 26)
 581 };
 582
 583 enum scan_config_rates {
 584         /* OFDM basic rates */
 585         SCAN_CONFIG_RATE_6M     = BIT(0),
 586         SCAN_CONFIG_RATE_9M     = BIT(1),
 587         SCAN_CONFIG_RATE_12M    = BIT(2),
 588         SCAN_CONFIG_RATE_18M    = BIT(3),
 589         SCAN_CONFIG_RATE_24M    = BIT(4),
 590         SCAN_CONFIG_RATE_36M    = BIT(5),
 591         SCAN_CONFIG_RATE_48M    = BIT(6),
 592         SCAN_CONFIG_RATE_54M    = BIT(7),
 593         /* CCK basic rates */
 594         SCAN_CONFIG_RATE_1M     = BIT(8),
 595         SCAN_CONFIG_RATE_2M     = BIT(9),
 596         SCAN_CONFIG_RATE_5M     = BIT(10),
 597         SCAN_CONFIG_RATE_11M    = BIT(11),
 598
 599         /* Bits 16-27 are for supported rates */
 600 #define SCAN_CONFIG_SUPPORTED_RATE(rate)        ((rate) << 16)
 601 };
 602
 603 enum iwl_channel_flags {
 604         IWL_CHANNEL_FLAG_EBS                            = BIT(0),
 605         IWL_CHANNEL_FLAG_ACCURATE_EBS                   = BIT(1),
 606         IWL_CHANNEL_FLAG_EBS_ADD                        = BIT(2),
 607         IWL_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE        = BIT(3),
 608 };
 609
 610 /**
 611  * struct iwl_scan_config
 612  * @hdr: umac command header
 613  * @flags:                      enum scan_config_flags
 614  * @tx_chains:                  valid_tx antenna - ANT_* definitions
 615  * @rx_chains:                  valid_rx antenna - ANT_* definitions
 616  * @legacy_rates:               default legacy rates - enum scan_config_rates
 617  * @out_of_channel_time:        default max out of serving channel time
 618  * @suspend_time:               default max suspend time
 619  * @dwell_active:               default dwell time for active scan
 620  * @dwell_passive:              default dwell time for passive scan
 621  * @dwell_fragmented:           default dwell time for fragmented scan
 622  * @reserved:                   for future use and alignment
 623  * @mac_addr:                   default mac address to be used in probes
 624  * @bcast_sta_id:               the index of the station in the fw
 625  * @channel_flags:              default channel flags - enum iwl_channel_flags
 626  *                              scan_config_channel_flag
 627  * @channel_array:              default supported channels
 628  */
 629 struct iwl_scan_config {
 630         struct iwl_mvm_umac_cmd_hdr hdr;
 631         __le32 flags;
 632         __le32 tx_chains;
 633         __le32 rx_chains;
 634         __le32 legacy_rates;
 635         __le32 out_of_channel_time;
 636         __le32 suspend_time;
 637         u8 dwell_active;
 638         u8 dwell_passive;
 639         u8 dwell_fragmented;
 640         u8 reserved;
 641         u8 mac_addr[ETH_ALEN];
 642         u8 bcast_sta_id;
 643         u8 channel_flags;
 644         u8 channel_array[];
 645 } __packed; /* SCAN_CONFIG_DB_CMD_API_S */
 646
 647 /**
 648  * iwl_umac_scan_flags
 649  *@IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
 650  *      can be preempted by other scan requests with higher priority.
 651  *      The low priority scan is aborted.
 652  *@IWL_UMAC_SCAN_FLAG_START_NOTIF: notification will be sent to the driver
 653  *      when scan starts.
 654  */
 655 enum iwl_umac_scan_flags {
 656         IWL_UMAC_SCAN_FLAG_PREEMPTIVE           = BIT(0),
 657         IWL_UMAC_SCAN_FLAG_START_NOTIF          = BIT(1),
 658 };
 659
 660 enum iwl_umac_scan_uid_offsets {
 661         IWL_UMAC_SCAN_UID_TYPE_OFFSET           = 0,
 662         IWL_UMAC_SCAN_UID_SEQ_OFFSET            = 8,
 663 };
 664
 665 enum iwl_umac_scan_general_flags {
 666         IWL_UMAC_SCAN_GEN_FLAGS_PERIODIC        = BIT(0),
 667         IWL_UMAC_SCAN_GEN_FLAGS_OVER_BT         = BIT(1),
 668         IWL_UMAC_SCAN_GEN_FLAGS_PASS_ALL        = BIT(2),
 669         IWL_UMAC_SCAN_GEN_FLAGS_PASSIVE         = BIT(3),
 670         IWL_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT     = BIT(4),
 671         IWL_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE   = BIT(5),
 672         IWL_UMAC_SCAN_GEN_FLAGS_MULTIPLE_SSID   = BIT(6),
 673         IWL_UMAC_SCAN_GEN_FLAGS_FRAGMENTED      = BIT(7),
 674         IWL_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED     = BIT(8),
 675         IWL_UMAC_SCAN_GEN_FLAGS_MATCH           = BIT(9)
 676 };
 677
 678 /**
 679  * struct iwl_scan_channel_cfg_umac
 680  * @flags:              bitmap - 0-19:  directed scan to i'th ssid.
 681  * @channel_num:        channel number 1-13 etc.
 682  * @iter_count:         repetition count for the channel.
 683  * @iter_interval:      interval between two scan iterations on one channel.
 684  */
 685 struct iwl_scan_channel_cfg_umac {
 686         __le32 flags;
 687         u8 channel_num;
 688         u8 iter_count;
 689         __le16 iter_interval;
 690 } __packed; /* SCAN_CHANNEL_CFG_S_VER2 */
 691
 692 /**
 693  * struct iwl_scan_umac_schedule
 694  * @interval: interval in seconds between scan iterations
 695  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
 696  * @reserved: for alignment and future use
 697  */
 698 struct iwl_scan_umac_schedule {
 699         __le16 interval;
 700         u8 iter_count;
 701         u8 reserved;
 702 } __packed; /* SCAN_SCHED_PARAM_API_S_VER_1 */
 703
 704 /**
 705  * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
 706  *      parameters following channels configuration array.
 707  * @schedule: two scheduling plans.
 708  * @delay: delay in TUs before starting the first scan iteration
 709  * @reserved: for future use and alignment
 710  * @preq: probe request with IEs blocks
 711  * @direct_scan: list of SSIDs for directed active scan
 712  */
 713 struct iwl_scan_req_umac_tail {
 714         /* SCAN_PERIODIC_PARAMS_API_S_VER_1 */
 715         struct iwl_scan_umac_schedule schedule[2];
 716         __le16 delay;
 717         __le16 reserved;
 718         /* SCAN_PROBE_PARAMS_API_S_VER_1 */
 719         struct iwl_scan_probe_req preq;
 720         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 721 } __packed;
 722
 723 /**
 724  * struct iwl_scan_req_umac
 725  * @hdr: umac command header
 726  * @flags: &enum iwl_umac_scan_flags
 727  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 728  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
 729  * @general_flags: &enum iwl_umac_scan_general_flags
 730  * @reserved1: for future use and alignment
 731  * @active_dwell: dwell time for active scan
 732  * @passive_dwell: dwell time for passive scan
 733  * @fragmented_dwell: dwell time for fragmented passive scan
 734  * @max_out_time: max out of serving channel time
 735  * @suspend_time: max suspend time
 736  * @scan_priority: scan internal prioritization &enum iwl_scan_priority
 737  * @channel_flags: &enum iwl_scan_channel_flags
 738  * @n_channels: num of channels in scan request
 739  * @reserved2: for future use and alignment
 740  * @data: &struct iwl_scan_channel_cfg_umac and
 741  *      &struct iwl_scan_req_umac_tail
 742  */
 743 struct iwl_scan_req_umac {
 744         struct iwl_mvm_umac_cmd_hdr hdr;
 745         __le32 flags;
 746         __le32 uid;
 747         __le32 ooc_priority;
 748         /* SCAN_GENERAL_PARAMS_API_S_VER_1 */
 749         __le32 general_flags;
 750         u8 reserved1;
 751         u8 active_dwell;
 752         u8 passive_dwell;
 753         u8 fragmented_dwell;
 754         __le32 max_out_time;
 755         __le32 suspend_time;
 756         __le32 scan_priority;
 757         /* SCAN_CHANNEL_PARAMS_API_S_VER_1 */
 758         u8 channel_flags;
 759         u8 n_channels;
 760         __le16 reserved2;
 761         u8 data[];
 762 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_1 */
 763
 764 /**
 765  * struct iwl_umac_scan_abort
 766  * @hdr: umac command header
 767  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 768  * @flags: reserved
 769  */
 770 struct iwl_umac_scan_abort {
 771         struct iwl_mvm_umac_cmd_hdr hdr;
 772         __le32 uid;
 773         __le32 flags;
 774 } __packed; /* SCAN_ABORT_CMD_UMAC_API_S_VER_1 */
 775
 776 /**
 777  * struct iwl_umac_scan_complete
 778  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 779  * @last_schedule: last scheduling line
 780  * @last_iter:  last scan iteration number
 781  * @scan status: &enum iwl_scan_offload_complete_status
 782  * @ebs_status: &enum iwl_scan_ebs_status
 783  * @time_from_last_iter: time elapsed from last iteration
 784  * @reserved: for future use
 785  */
 786 struct iwl_umac_scan_complete {
 787         __le32 uid;
 788         u8 last_schedule;
 789         u8 last_iter;
 790         u8 status;
 791         u8 ebs_status;
 792         __le32 time_from_last_iter;
 793         __le32 reserved;
 794 } __packed; /* SCAN_COMPLETE_NTF_UMAC_API_S_VER_1 */
 795
 796 #define SCAN_OFFLOAD_MATCHING_CHANNELS_LEN 5
 797 /**
 798  * struct iwl_scan_offload_profile_match - match information
 799  * @bssid: matched bssid
 800  * @channel: channel where the match occurred
 801  * @energy:
 802  * @matching_feature:
 803  * @matching_channels: bitmap of channels that matched, referencing
 804  *      the channels passed in tue scan offload request
 805  */
 806 struct iwl_scan_offload_profile_match {
 807         u8 bssid[ETH_ALEN];
 808         __le16 reserved;
 809         u8 channel;
 810         u8 energy;
 811         u8 matching_feature;
 812         u8 matching_channels[SCAN_OFFLOAD_MATCHING_CHANNELS_LEN];
 813 } __packed; /* SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S_VER_1 */
 814
 815 /**
 816  * struct iwl_scan_offload_profiles_query - match results query response
 817  * @matched_profiles: bitmap of matched profiles, referencing the
 818  *      matches passed in the scan offload request
 819  * @last_scan_age: age of the last offloaded scan
 820  * @n_scans_done: number of offloaded scans done
 821  * @gp2_d0u: GP2 when D0U occurred
 822  * @gp2_invoked: GP2 when scan offload was invoked
 823  * @resume_while_scanning: not used
 824  * @self_recovery: obsolete
 825  * @reserved: reserved
 826  * @matches: array of match information, one for each match
 827  */
 828 struct iwl_scan_offload_profiles_query {
 829         __le32 matched_profiles;
 830         __le32 last_scan_age;
 831         __le32 n_scans_done;
 832         __le32 gp2_d0u;
 833         __le32 gp2_invoked;
 834         u8 resume_while_scanning;
 835         u8 self_recovery;
 836         __le16 reserved;
 837         struct iwl_scan_offload_profile_match matches[IWL_SCAN_MAX_PROFILES];
 838 } __packed; /* SCAN_OFFLOAD_PROFILES_QUERY_RSP_S_VER_2 */
 839
 840 #endif