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 /* 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
 106 enum 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  */
 118 struct iwl_scan_offload_blacklist {
 119         u8 ssid[ETH_ALEN];
 120         u8 reported_rssi;
 121         u8 client_bitmap;
 122 } __packed;
 123
 124 enum 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
 130 enum 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  */
 145 struct 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  */
 166 struct 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  */
 183 struct iwl_scan_schedule_lmac {
 184         __le16 delay;
 185         u8 iterations;
 186         u8 full_scan_mul;
 187 } __packed; /* SCAN_SCHEDULE_API_S */
 188
 189 enum iwl_scan_offload_complete_status {
 190         IWL_SCAN_OFFLOAD_COMPLETED      = 1,
 191         IWL_SCAN_OFFLOAD_ABORTED        = 2,
 192 };
 193
 194 enum 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  */
 209 struct 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
 216 enum 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  */
 229 struct 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  */
 241 struct 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  */
 252 struct 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
 259 enum 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  */
 272 struct 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_MATCH: Send match found notification on matches
 289  */
 290 enum iwl_mvm_lmac_scan_flags {
 291         IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL         = BIT(0),
 292         IWL_MVM_LMAC_SCAN_FLAG_PASSIVE          = BIT(1),
 293         IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION   = BIT(2),
 294         IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE    = BIT(3),
 295         IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS   = BIT(4),
 296         IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED       = BIT(5),
 297         IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED     = BIT(6),
 298         IWL_MVM_LMAC_SCAN_FLAG_MATCH            = BIT(9),
 299 };
 300
 301 enum iwl_scan_priority {
 302         IWL_SCAN_PRIORITY_LOW,
 303         IWL_SCAN_PRIORITY_MEDIUM,
 304         IWL_SCAN_PRIORITY_HIGH,
 305 };
 306
 307 enum iwl_scan_priority_ext {
 308         IWL_SCAN_PRIORITY_EXT_0_LOWEST,
 309         IWL_SCAN_PRIORITY_EXT_1,
 310         IWL_SCAN_PRIORITY_EXT_2,
 311         IWL_SCAN_PRIORITY_EXT_3,
 312         IWL_SCAN_PRIORITY_EXT_4,
 313         IWL_SCAN_PRIORITY_EXT_5,
 314         IWL_SCAN_PRIORITY_EXT_6,
 315         IWL_SCAN_PRIORITY_EXT_7_HIGHEST,
 316 };
 317
 318 /**
 319  * iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
 320  * @reserved1: for alignment and future use
 321  * @channel_num: num of channels to scan
 322  * @active-dwell: dwell time for active channels
 323  * @passive-dwell: dwell time for passive channels
 324  * @fragmented-dwell: dwell time for fragmented passive scan
 325  * @reserved2: for alignment and future use
 326  * @rx_chain_selct: PHY_RX_CHAIN_* flags
 327  * @scan_flags: &enum iwl_mvm_lmac_scan_flags
 328  * @max_out_time: max time (in TU) to be out of associated channel
 329  * @suspend_time: pause scan this long (TUs) when returning to service channel
 330  * @flags: RXON flags
 331  * @filter_flags: RXON filter
 332  * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
 333  * @direct_scan: list of SSIDs for directed active scan
 334  * @scan_prio: enum iwl_scan_priority
 335  * @iter_num: number of scan iterations
 336  * @delay: delay in seconds before first iteration
 337  * @schedule: two scheduling plans. The first one is finite, the second one can
 338  *      be infinite.
 339  * @channel_opt: channel optimization options, for full and partial scan
 340  * @data: channel configuration and probe request packet.
 341  */
 342 struct iwl_scan_req_lmac {
 343         /* SCAN_REQUEST_FIXED_PART_API_S_VER_7 */
 344         __le32 reserved1;
 345         u8 n_channels;
 346         u8 active_dwell;
 347         u8 passive_dwell;
 348         u8 fragmented_dwell;
 349         __le16 reserved2;
 350         __le16 rx_chain_select;
 351         __le32 scan_flags;
 352         __le32 max_out_time;
 353         __le32 suspend_time;
 354         /* RX_ON_FLAGS_API_S_VER_1 */
 355         __le32 flags;
 356         __le32 filter_flags;
 357         struct iwl_scan_req_tx_cmd tx_cmd[2];
 358         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 359         __le32 scan_prio;
 360         /* SCAN_REQ_PERIODIC_PARAMS_API_S */
 361         __le32 iter_num;
 362         __le32 delay;
 363         struct iwl_scan_schedule_lmac schedule[IWL_MAX_SCHED_SCAN_PLANS];
 364         struct iwl_scan_channel_opt channel_opt[2];
 365         u8 data[];
 366 } __packed;
 367
 368 /**
 369  * struct iwl_scan_results_notif - scan results for one channel -
 370  *      SCAN_RESULT_NTF_API_S_VER_3
 371  * @channel: which channel the results are from
 372  * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
 373  * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
 374  * @num_probe_not_sent: # of request that weren't sent due to not enough time
 375  * @duration: duration spent in channel, in usecs
 376  */
 377 struct iwl_scan_results_notif {
 378         u8 channel;
 379         u8 band;
 380         u8 probe_status;
 381         u8 num_probe_not_sent;
 382         __le32 duration;
 383 } __packed;
 384
 385 /**
 386  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
 387  *      SCAN_COMPLETE_NTF_API_S_VER_3
 388  * @scanned_channels: number of channels scanned (and number of valid results)
 389  * @status: one of SCAN_COMP_STATUS_*
 390  * @bt_status: BT on/off status
 391  * @last_channel: last channel that was scanned
 392  * @tsf_low: TSF timer (lower half) in usecs
 393  * @tsf_high: TSF timer (higher half) in usecs
 394  * @results: an array of scan results, only "scanned_channels" of them are valid
 395  */
 396 struct iwl_lmac_scan_complete_notif {
 397         u8 scanned_channels;
 398         u8 status;
 399         u8 bt_status;
 400         u8 last_channel;
 401         __le32 tsf_low;
 402         __le32 tsf_high;
 403         struct iwl_scan_results_notif results[];
 404 } __packed;
 405
 406 /**
 407  * iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
 408  * @last_schedule_line: last schedule line executed (fast or regular)
 409  * @last_schedule_iteration: last scan iteration executed before scan abort
 410  * @status: enum iwl_scan_offload_complete_status
 411  * @ebs_status: EBS success status &enum iwl_scan_ebs_status
 412  * @time_after_last_iter; time in seconds elapsed after last iteration
 413  */
 414 struct iwl_periodic_scan_complete {
 415         u8 last_schedule_line;
 416         u8 last_schedule_iteration;
 417         u8 status;
 418         u8 ebs_status;
 419         __le32 time_after_last_iter;
 420         __le32 reserved;
 421 } __packed;
 422
 423 /* UMAC Scan API */
 424
 425 /* The maximum of either of these cannot exceed 8, because we use an
 426  * 8-bit mask (see IWL_MVM_SCAN_MASK in mvm.h).
 427  */
 428 #define IWL_MVM_MAX_UMAC_SCANS 8
 429 #define IWL_MVM_MAX_LMAC_SCANS 1
 430
 431 enum scan_config_flags {
 432         SCAN_CONFIG_FLAG_ACTIVATE                       = BIT(0),
 433         SCAN_CONFIG_FLAG_DEACTIVATE                     = BIT(1),
 434         SCAN_CONFIG_FLAG_FORBID_CHUB_REQS               = BIT(2),
 435         SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS                = BIT(3),
 436         SCAN_CONFIG_FLAG_SET_TX_CHAINS                  = BIT(8),
 437         SCAN_CONFIG_FLAG_SET_RX_CHAINS                  = BIT(9),
 438         SCAN_CONFIG_FLAG_SET_AUX_STA_ID                 = BIT(10),
 439         SCAN_CONFIG_FLAG_SET_ALL_TIMES                  = BIT(11),
 440         SCAN_CONFIG_FLAG_SET_EFFECTIVE_TIMES            = BIT(12),
 441         SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS              = BIT(13),
 442         SCAN_CONFIG_FLAG_SET_LEGACY_RATES               = BIT(14),
 443         SCAN_CONFIG_FLAG_SET_MAC_ADDR                   = BIT(15),
 444         SCAN_CONFIG_FLAG_SET_FRAGMENTED                 = BIT(16),
 445         SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED               = BIT(17),
 446         SCAN_CONFIG_FLAG_SET_CAM_MODE                   = BIT(18),
 447         SCAN_CONFIG_FLAG_CLEAR_CAM_MODE                 = BIT(19),
 448         SCAN_CONFIG_FLAG_SET_PROMISC_MODE               = BIT(20),
 449         SCAN_CONFIG_FLAG_CLEAR_PROMISC_MODE             = BIT(21),
 450
 451         /* Bits 26-31 are for num of channels in channel_array */
 452 #define SCAN_CONFIG_N_CHANNELS(n) ((n) << 26)
 453 };
 454
 455 enum scan_config_rates {
 456         /* OFDM basic rates */
 457         SCAN_CONFIG_RATE_6M     = BIT(0),
 458         SCAN_CONFIG_RATE_9M     = BIT(1),
 459         SCAN_CONFIG_RATE_12M    = BIT(2),
 460         SCAN_CONFIG_RATE_18M    = BIT(3),
 461         SCAN_CONFIG_RATE_24M    = BIT(4),
 462         SCAN_CONFIG_RATE_36M    = BIT(5),
 463         SCAN_CONFIG_RATE_48M    = BIT(6),
 464         SCAN_CONFIG_RATE_54M    = BIT(7),
 465         /* CCK basic rates */
 466         SCAN_CONFIG_RATE_1M     = BIT(8),
 467         SCAN_CONFIG_RATE_2M     = BIT(9),
 468         SCAN_CONFIG_RATE_5M     = BIT(10),
 469         SCAN_CONFIG_RATE_11M    = BIT(11),
 470
 471         /* Bits 16-27 are for supported rates */
 472 #define SCAN_CONFIG_SUPPORTED_RATE(rate)        ((rate) << 16)
 473 };
 474
 475 enum iwl_channel_flags {
 476         IWL_CHANNEL_FLAG_EBS                            = BIT(0),
 477         IWL_CHANNEL_FLAG_ACCURATE_EBS                   = BIT(1),
 478         IWL_CHANNEL_FLAG_EBS_ADD                        = BIT(2),
 479         IWL_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE        = BIT(3),
 480 };
 481
 482 /**
 483  * struct iwl_scan_config
 484  * @flags:                      enum scan_config_flags
 485  * @tx_chains:                  valid_tx antenna - ANT_* definitions
 486  * @rx_chains:                  valid_rx antenna - ANT_* definitions
 487  * @legacy_rates:               default legacy rates - enum scan_config_rates
 488  * @out_of_channel_time:        default max out of serving channel time
 489  * @suspend_time:               default max suspend time
 490  * @dwell_active:               default dwell time for active scan
 491  * @dwell_passive:              default dwell time for passive scan
 492  * @dwell_fragmented:           default dwell time for fragmented scan
 493  * @reserved:                   for future use and alignment
 494  * @mac_addr:                   default mac address to be used in probes
 495  * @bcast_sta_id:               the index of the station in the fw
 496  * @channel_flags:              default channel flags - enum iwl_channel_flags
 497  *                              scan_config_channel_flag
 498  * @channel_array:              default supported channels
 499  */
 500 struct iwl_scan_config {
 501         __le32 flags;
 502         __le32 tx_chains;
 503         __le32 rx_chains;
 504         __le32 legacy_rates;
 505         __le32 out_of_channel_time;
 506         __le32 suspend_time;
 507         u8 dwell_active;
 508         u8 dwell_passive;
 509         u8 dwell_fragmented;
 510         u8 reserved;
 511         u8 mac_addr[ETH_ALEN];
 512         u8 bcast_sta_id;
 513         u8 channel_flags;
 514         u8 channel_array[];
 515 } __packed; /* SCAN_CONFIG_DB_CMD_API_S */
 516
 517 /**
 518  * iwl_umac_scan_flags
 519  *@IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
 520  *      can be preempted by other scan requests with higher priority.
 521  *      The low priority scan will be resumed when the higher proirity scan is
 522  *      completed.
 523  *@IWL_UMAC_SCAN_FLAG_START_NOTIF: notification will be sent to the driver
 524  *      when scan starts.
 525  */
 526 enum iwl_umac_scan_flags {
 527         IWL_UMAC_SCAN_FLAG_PREEMPTIVE           = BIT(0),
 528         IWL_UMAC_SCAN_FLAG_START_NOTIF          = BIT(1),
 529 };
 530
 531 enum iwl_umac_scan_uid_offsets {
 532         IWL_UMAC_SCAN_UID_TYPE_OFFSET           = 0,
 533         IWL_UMAC_SCAN_UID_SEQ_OFFSET            = 8,
 534 };
 535
 536 enum iwl_umac_scan_general_flags {
 537         IWL_UMAC_SCAN_GEN_FLAGS_PERIODIC        = BIT(0),
 538         IWL_UMAC_SCAN_GEN_FLAGS_OVER_BT         = BIT(1),
 539         IWL_UMAC_SCAN_GEN_FLAGS_PASS_ALL        = BIT(2),
 540         IWL_UMAC_SCAN_GEN_FLAGS_PASSIVE         = BIT(3),
 541         IWL_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT     = BIT(4),
 542         IWL_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE   = BIT(5),
 543         IWL_UMAC_SCAN_GEN_FLAGS_MULTIPLE_SSID   = BIT(6),
 544         IWL_UMAC_SCAN_GEN_FLAGS_FRAGMENTED      = BIT(7),
 545         IWL_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED     = BIT(8),
 546         IWL_UMAC_SCAN_GEN_FLAGS_MATCH           = BIT(9)
 547 };
 548
 549 /**
 550  * struct iwl_scan_channel_cfg_umac
 551  * @flags:              bitmap - 0-19:  directed scan to i'th ssid.
 552  * @channel_num:        channel number 1-13 etc.
 553  * @iter_count:         repetition count for the channel.
 554  * @iter_interval:      interval between two scan iterations on one channel.
 555  */
 556 struct iwl_scan_channel_cfg_umac {
 557         __le32 flags;
 558         u8 channel_num;
 559         u8 iter_count;
 560         __le16 iter_interval;
 561 } __packed; /* SCAN_CHANNEL_CFG_S_VER2 */
 562
 563 /**
 564  * struct iwl_scan_umac_schedule
 565  * @interval: interval in seconds between scan iterations
 566  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
 567  * @reserved: for alignment and future use
 568  */
 569 struct iwl_scan_umac_schedule {
 570         __le16 interval;
 571         u8 iter_count;
 572         u8 reserved;
 573 } __packed; /* SCAN_SCHED_PARAM_API_S_VER_1 */
 574
 575 /**
 576  * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
 577  *      parameters following channels configuration array.
 578  * @schedule: two scheduling plans.
 579  * @delay: delay in TUs before starting the first scan iteration
 580  * @reserved: for future use and alignment
 581  * @preq: probe request with IEs blocks
 582  * @direct_scan: list of SSIDs for directed active scan
 583  */
 584 struct iwl_scan_req_umac_tail {
 585         /* SCAN_PERIODIC_PARAMS_API_S_VER_1 */
 586         struct iwl_scan_umac_schedule schedule[IWL_MAX_SCHED_SCAN_PLANS];
 587         __le16 delay;
 588         __le16 reserved;
 589         /* SCAN_PROBE_PARAMS_API_S_VER_1 */
 590         struct iwl_scan_probe_req preq;
 591         struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
 592 } __packed;
 593
 594 /**
 595  * struct iwl_scan_req_umac
 596  * @flags: &enum iwl_umac_scan_flags
 597  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 598  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
 599  * @general_flags: &enum iwl_umac_scan_general_flags
 600  * @reserved1: for future use and alignment
 601  * @active_dwell: dwell time for active scan
 602  * @passive_dwell: dwell time for passive scan
 603  * @fragmented_dwell: dwell time for fragmented passive scan
 604  * @max_out_time: max out of serving channel time
 605  * @suspend_time: max suspend time
 606  * @scan_priority: scan internal prioritization &enum iwl_scan_priority
 607  * @channel_flags: &enum iwl_scan_channel_flags
 608  * @n_channels: num of channels in scan request
 609  * @reserved2: for future use and alignment
 610  * @data: &struct iwl_scan_channel_cfg_umac and
 611  *      &struct iwl_scan_req_umac_tail
 612  */
 613 struct iwl_scan_req_umac {
 614         __le32 flags;
 615         __le32 uid;
 616         __le32 ooc_priority;
 617         /* SCAN_GENERAL_PARAMS_API_S_VER_1 */
 618         __le32 general_flags;
 619         u8 reserved1;
 620         u8 active_dwell;
 621         u8 passive_dwell;
 622         u8 fragmented_dwell;
 623         __le32 max_out_time;
 624         __le32 suspend_time;
 625         __le32 scan_priority;
 626         /* SCAN_CHANNEL_PARAMS_API_S_VER_1 */
 627         u8 channel_flags;
 628         u8 n_channels;
 629         __le16 reserved2;
 630         u8 data[];
 631 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_1 */
 632
 633 /**
 634  * struct iwl_umac_scan_abort
 635  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 636  * @flags: reserved
 637  */
 638 struct iwl_umac_scan_abort {
 639         __le32 uid;
 640         __le32 flags;
 641 } __packed; /* SCAN_ABORT_CMD_UMAC_API_S_VER_1 */
 642
 643 /**
 644  * struct iwl_umac_scan_complete
 645  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 646  * @last_schedule: last scheduling line
 647  * @last_iter:  last scan iteration number
 648  * @scan status: &enum iwl_scan_offload_complete_status
 649  * @ebs_status: &enum iwl_scan_ebs_status
 650  * @time_from_last_iter: time elapsed from last iteration
 651  * @reserved: for future use
 652  */
 653 struct iwl_umac_scan_complete {
 654         __le32 uid;
 655         u8 last_schedule;
 656         u8 last_iter;
 657         u8 status;
 658         u8 ebs_status;
 659         __le32 time_from_last_iter;
 660         __le32 reserved;
 661 } __packed; /* SCAN_COMPLETE_NTF_UMAC_API_S_VER_1 */
 662
 663 #define SCAN_OFFLOAD_MATCHING_CHANNELS_LEN 5
 664 /**
 665  * struct iwl_scan_offload_profile_match - match information
 666  * @bssid: matched bssid
 667  * @channel: channel where the match occurred
 668  * @energy:
 669  * @matching_feature:
 670  * @matching_channels: bitmap of channels that matched, referencing
 671  *      the channels passed in tue scan offload request
 672  */
 673 struct iwl_scan_offload_profile_match {
 674         u8 bssid[ETH_ALEN];
 675         __le16 reserved;
 676         u8 channel;
 677         u8 energy;
 678         u8 matching_feature;
 679         u8 matching_channels[SCAN_OFFLOAD_MATCHING_CHANNELS_LEN];
 680 } __packed; /* SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S_VER_1 */
 681
 682 /**
 683  * struct iwl_scan_offload_profiles_query - match results query response
 684  * @matched_profiles: bitmap of matched profiles, referencing the
 685  *      matches passed in the scan offload request
 686  * @last_scan_age: age of the last offloaded scan
 687  * @n_scans_done: number of offloaded scans done
 688  * @gp2_d0u: GP2 when D0U occurred
 689  * @gp2_invoked: GP2 when scan offload was invoked
 690  * @resume_while_scanning: not used
 691  * @self_recovery: obsolete
 692  * @reserved: reserved
 693  * @matches: array of match information, one for each match
 694  */
 695 struct iwl_scan_offload_profiles_query {
 696         __le32 matched_profiles;
 697         __le32 last_scan_age;
 698         __le32 n_scans_done;
 699         __le32 gp2_d0u;
 700         __le32 gp2_invoked;
 701         u8 resume_while_scanning;
 702         u8 self_recovery;
 703         __le16 reserved;
 704         struct iwl_scan_offload_profile_match matches[IWL_SCAN_MAX_PROFILES];
 705 } __packed; /* SCAN_OFFLOAD_PROFILES_QUERY_RSP_S_VER_2 */
 706
 707 /**
 708  * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
 709  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
 710  * @scanned_channels: number of channels scanned and number of valid elements in
 711  *      results array
 712  * @status: one of SCAN_COMP_STATUS_*
 713  * @bt_status: BT on/off status
 714  * @last_channel: last channel that was scanned
 715  * @tsf_low: TSF timer (lower half) in usecs
 716  * @tsf_high: TSF timer (higher half) in usecs
 717  * @results: array of scan results, only "scanned_channels" of them are valid
 718  */
 719 struct iwl_umac_scan_iter_complete_notif {
 720         __le32 uid;
 721         u8 scanned_channels;
 722         u8 status;
 723         u8 bt_status;
 724         u8 last_channel;
 725         __le32 tsf_low;
 726         __le32 tsf_high;
 727         struct iwl_scan_results_notif results[];
 728 } __packed; /* SCAN_ITER_COMPLETE_NTF_UMAC_API_S_VER_1 */
 729
 730 #endif