1 /******************************************************************************
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.
8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
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.
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.
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,
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
34 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
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
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.
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.
64 *****************************************************************************/
66 #ifndef __fw_api_scan_h__
67 #define __fw_api_scan_h__
71 /* Scan Commands, Responses, Notifications */
73 /* Masks for iwl_scan_channel.type flags */
74 #define SCAN_CHANNEL_TYPE_ACTIVE BIT(0)
75 #define SCAN_CHANNEL_NARROW_BAND BIT(22)
77 /* Max number of IEs for direct SSID scans in a command */
78 #define PROBE_OPTION_MAX 20
81 * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
82 * @channel: band is selected by iwl_scan_cmd "flags" field
83 * @tx_gain: gain for analog radio
84 * @dsp_atten: gain for DSP
85 * @active_dwell: dwell time for active scan in TU, typically 5-50
86 * @passive_dwell: dwell time for passive scan in TU, typically 20-500
87 * @type: type is broken down to these bits:
88 * bit 0: 0 = passive, 1 = active
89 * bits 1-20: SSID direct bit map. If any of these bits is set then
90 * the corresponding SSID IE is transmitted in probe request
91 * (bit i adds IE in position i to the probe request)
92 * bit 22: channel width, 0 = regular, 1 = TGj narrow channel
95 * @iteration_interval:
96 * This struct is used once for each channel in the scan list.
97 * Each channel can independently select:
98 * 1) SSID for directed active scans
99 * 2) Txpower setting (for rate specified within Tx command)
100 * 3) How long to stay on-channel (behavior may be modified by quiet_time,
101 * quiet_plcp_th, good_CRC_th)
103 * To avoid uCode errors, make sure the following are true (see comments
104 * under struct iwl_scan_cmd about max_out_time and quiet_time):
105 * 1) If using passive_dwell (i.e. passive_dwell != 0):
106 * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
107 * 2) quiet_time <= active_dwell
108 * 3) If restricting off-channel time (i.e. max_out_time !=0):
109 * passive_dwell < max_out_time
110 * active_dwell < max_out_time
112 struct iwl_scan_channel {
115 __le16 iteration_count;
116 __le32 iteration_interval;
118 __le16 passive_dwell;
119 } __packed; /* SCAN_CHANNEL_CONTROL_API_S_VER_1 */
122 * struct iwl_ssid_ie - directed scan network information element
124 * Up to 20 of these may appear in REPLY_SCAN_CMD,
125 * selected by "type" bit field in struct iwl_scan_channel;
126 * each channel may select different ssids from among the 20 entries.
127 * SSID IEs get transmitted in reverse order of entry.
132 u8 ssid[IEEE80211_MAX_SSID_LEN];
133 } __packed; /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
136 * iwl_scan_flags - masks for scan command flags
137 *@SCAN_FLAGS_PERIODIC_SCAN:
138 *@SCAN_FLAGS_P2P_PUBLIC_ACTION_FRAME_TX:
139 *@SCAN_FLAGS_DELAYED_SCAN_LOWBAND:
140 *@SCAN_FLAGS_DELAYED_SCAN_HIGHBAND:
141 *@SCAN_FLAGS_FRAGMENTED_SCAN:
142 *@SCAN_FLAGS_PASSIVE2ACTIVE: use active scan on channels that was active
143 * in the past hour, even if they are marked as passive.
145 enum iwl_scan_flags {
146 SCAN_FLAGS_PERIODIC_SCAN = BIT(0),
147 SCAN_FLAGS_P2P_PUBLIC_ACTION_FRAME_TX = BIT(1),
148 SCAN_FLAGS_DELAYED_SCAN_LOWBAND = BIT(2),
149 SCAN_FLAGS_DELAYED_SCAN_HIGHBAND = BIT(3),
150 SCAN_FLAGS_FRAGMENTED_SCAN = BIT(4),
151 SCAN_FLAGS_PASSIVE2ACTIVE = BIT(5),
155 * enum iwl_scan_type - Scan types for scan command
157 * @SCAN_TYPE_BACKGROUND:
159 * @SCAN_TYPE_ROAMING:
161 * @SCAN_TYPE_DISCOVERY:
162 * @SCAN_TYPE_DISCOVERY_FORCED:
165 SCAN_TYPE_FORCED = 0,
166 SCAN_TYPE_BACKGROUND = 1,
168 SCAN_TYPE_ROAMING = 3,
169 SCAN_TYPE_ACTION = 4,
170 SCAN_TYPE_DISCOVERY = 5,
171 SCAN_TYPE_DISCOVERY_FORCED = 6,
172 }; /* SCAN_ACTIVITY_TYPE_E_VER_1 */
175 * struct iwl_scan_cmd - scan request command
176 * ( SCAN_REQUEST_CMD = 0x80 )
177 * @len: command length in bytes
178 * @scan_flags: scan flags from SCAN_FLAGS_*
179 * @channel_count: num of channels in channel list
180 * (1 - ucode_capa.n_scan_channels)
181 * @quiet_time: in msecs, dwell this time for active scan on quiet channels
182 * @quiet_plcp_th: quiet PLCP threshold (channel is quiet if less than
183 * this number of packets were received (typically 1)
184 * @passive2active: is auto switching from passive to active during scan allowed
185 * @rxchain_sel_flags: RXON_RX_CHAIN_*
186 * @max_out_time: in TUs, max out of serving channel time
187 * @suspend_time: how long to pause scan when returning to service channel:
188 * bits 0-19: beacon interal in TUs (suspend before executing)
189 * bits 20-23: reserved
190 * bits 24-31: number of beacons (suspend between channels)
191 * @rxon_flags: RXON_FLG_*
192 * @filter_flags: RXON_FILTER_*
193 * @tx_cmd: for active scans (zero for passive), w/o payload,
194 * no RS so specify TX rate
195 * @direct_scan: direct scan SSIDs
196 * @type: one of SCAN_TYPE_*
197 * @repeats: how many time to repeat the scan
199 struct iwl_scan_cmd {
204 __le16 quiet_plcp_th;
205 __le16 passive2active;
206 __le16 rxchain_sel_flags;
209 /* RX_ON_FLAGS_API_S_VER_1 */
212 struct iwl_tx_cmd tx_cmd;
213 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
218 * Probe request frame, followed by channel list.
220 * Size of probe request frame is specified by byte count in tx_cmd.
221 * Channel list follows immediately after probe request frame.
222 * Number of channels in list is specified by channel_count.
223 * Each channel in list is of type:
225 * struct iwl_scan_channel channels[0];
227 * NOTE: Only one band of channels can be scanned per pass. You
228 * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
229 * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
230 * before requesting another scan.
233 } __packed; /* SCAN_REQUEST_FIXED_PART_API_S_VER_5 */
235 /* Response to scan request contains only status with one of these values */
236 #define SCAN_RESPONSE_OK 0x1
237 #define SCAN_RESPONSE_ERROR 0x2
240 * SCAN_ABORT_CMD = 0x81
241 * When scan abort is requested, the command has no fields except the common
242 * header. The response contains only a status with one of these values.
244 #define SCAN_ABORT_POSSIBLE 0x1
245 #define SCAN_ABORT_IGNORED 0x2 /* no pending scans */
247 /* TODO: complete documentation */
248 #define SCAN_OWNER_STATUS 0x1
249 #define MEASURE_OWNER_STATUS 0x2
252 * struct iwl_scan_start_notif - notifies start of scan in the device
253 * ( SCAN_START_NOTIFICATION = 0x82 )
254 * @tsf_low: TSF timer (lower half) in usecs
255 * @tsf_high: TSF timer (higher half) in usecs
256 * @beacon_timer: structured as follows:
257 * bits 0:19 - beacon interval in usecs
258 * bits 20:23 - reserved (0)
259 * bits 24:31 - number of beacons
260 * @channel: which channel is scanned
261 * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
262 * @status: one of *_OWNER_STATUS
264 struct iwl_scan_start_notif {
272 } __packed; /* SCAN_START_NTF_API_S_VER_1 */
274 /* scan results probe_status first bit indicates success */
275 #define SCAN_PROBE_STATUS_OK 0
276 #define SCAN_PROBE_STATUS_TX_FAILED BIT(0)
277 /* error statuses combined with TX_FAILED */
278 #define SCAN_PROBE_STATUS_FAIL_TTL BIT(1)
279 #define SCAN_PROBE_STATUS_FAIL_BT BIT(2)
281 /* How many statistics are gathered for each channel */
282 #define SCAN_RESULTS_STATISTICS 1
285 * enum iwl_scan_complete_status - status codes for scan complete notifications
286 * @SCAN_COMP_STATUS_OK: scan completed successfully
287 * @SCAN_COMP_STATUS_ABORT: scan was aborted by user
288 * @SCAN_COMP_STATUS_ERR_SLEEP: sending null sleep packet failed
289 * @SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT: timeout before channel is ready
290 * @SCAN_COMP_STATUS_ERR_PROBE: sending probe request failed
291 * @SCAN_COMP_STATUS_ERR_WAKEUP: sending null wakeup packet failed
292 * @SCAN_COMP_STATUS_ERR_ANTENNAS: invalid antennas chosen at scan command
293 * @SCAN_COMP_STATUS_ERR_INTERNAL: internal error caused scan abort
294 * @SCAN_COMP_STATUS_ERR_COEX: medium was lost ot WiMax
295 * @SCAN_COMP_STATUS_P2P_ACTION_OK: P2P public action frame TX was successful
297 * @SCAN_COMP_STATUS_ITERATION_END: indicates end of one repeatition the driver
299 * @SCAN_COMP_STATUS_ERR_ALLOC_TE: scan could not allocate time events
301 enum iwl_scan_complete_status {
302 SCAN_COMP_STATUS_OK = 0x1,
303 SCAN_COMP_STATUS_ABORT = 0x2,
304 SCAN_COMP_STATUS_ERR_SLEEP = 0x3,
305 SCAN_COMP_STATUS_ERR_CHAN_TIMEOUT = 0x4,
306 SCAN_COMP_STATUS_ERR_PROBE = 0x5,
307 SCAN_COMP_STATUS_ERR_WAKEUP = 0x6,
308 SCAN_COMP_STATUS_ERR_ANTENNAS = 0x7,
309 SCAN_COMP_STATUS_ERR_INTERNAL = 0x8,
310 SCAN_COMP_STATUS_ERR_COEX = 0x9,
311 SCAN_COMP_STATUS_P2P_ACTION_OK = 0xA,
312 SCAN_COMP_STATUS_ITERATION_END = 0x0B,
313 SCAN_COMP_STATUS_ERR_ALLOC_TE = 0x0C,
317 * struct iwl_scan_results_notif - scan results for one channel
318 * ( SCAN_RESULTS_NOTIFICATION = 0x83 )
319 * @channel: which channel the results are from
320 * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
321 * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
322 * @num_probe_not_sent: # of request that weren't sent due to not enough time
323 * @duration: duration spent in channel, in usecs
324 * @statistics: statistics gathered for this channel
326 struct iwl_scan_results_notif {
330 u8 num_probe_not_sent;
332 __le32 statistics[SCAN_RESULTS_STATISTICS];
333 } __packed; /* SCAN_RESULT_NTF_API_S_VER_2 */
336 * struct iwl_scan_complete_notif - notifies end of scanning (all channels)
337 * ( SCAN_COMPLETE_NOTIFICATION = 0x84 )
338 * @scanned_channels: number of channels scanned (and number of valid results)
339 * @status: one of SCAN_COMP_STATUS_*
340 * @bt_status: BT on/off status
341 * @last_channel: last channel that was scanned
342 * @tsf_low: TSF timer (lower half) in usecs
343 * @tsf_high: TSF timer (higher half) in usecs
344 * @results: array of scan results, only "scanned_channels" of them are valid
346 struct iwl_scan_complete_notif {
353 struct iwl_scan_results_notif results[];
354 } __packed; /* SCAN_COMPLETE_NTF_API_S_VER_2 */
357 #define IWL_SCAN_MAX_BLACKLIST_LEN 64
358 #define IWL_SCAN_SHORT_BLACKLIST_LEN 16
359 #define IWL_SCAN_MAX_PROFILES 11
360 #define SCAN_OFFLOAD_PROBE_REQ_SIZE 512
362 /* Default watchdog (in MS) for scheduled scan iteration */
363 #define IWL_SCHED_SCAN_WATCHDOG cpu_to_le16(15000)
365 #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
366 #define CAN_ABORT_STATUS 1
368 #define IWL_FULL_SCAN_MULTIPLIER 5
369 #define IWL_FAST_SCHED_SCAN_ITERATIONS 3
371 enum scan_framework_client {
372 SCAN_CLIENT_SCHED_SCAN = BIT(0),
373 SCAN_CLIENT_NETDETECT = BIT(1),
374 SCAN_CLIENT_ASSET_TRACKING = BIT(2),
378 * struct iwl_scan_offload_cmd - SCAN_REQUEST_FIXED_PART_API_S_VER_6
379 * @scan_flags: see enum iwl_scan_flags
380 * @channel_count: channels in channel list
381 * @quiet_time: dwell time, in milisiconds, on quiet channel
382 * @quiet_plcp_th: quiet channel num of packets threshold
383 * @good_CRC_th: passive to active promotion threshold
384 * @rx_chain: RXON rx chain.
385 * @max_out_time: max TUs to be out of assoceated channel
386 * @suspend_time: pause scan this TUs when returning to service channel
388 * @filter_flags: RXONfilter
389 * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz.
390 * @direct_scan: list of SSIDs for directed active scan
391 * @scan_type: see enum iwl_scan_type.
392 * @rep_count: repetition count for each scheduled scan iteration.
394 struct iwl_scan_offload_cmd {
399 __le16 quiet_plcp_th;
404 /* RX_ON_FLAGS_API_S_VER_1 */
407 struct iwl_tx_cmd tx_cmd[2];
408 /* SCAN_DIRECT_SSID_IE_API_S_VER_1 */
409 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
414 enum iwl_scan_offload_channel_flags {
415 IWL_SCAN_OFFLOAD_CHANNEL_ACTIVE = BIT(0),
416 IWL_SCAN_OFFLOAD_CHANNEL_NARROW = BIT(22),
417 IWL_SCAN_OFFLOAD_CHANNEL_FULL = BIT(24),
418 IWL_SCAN_OFFLOAD_CHANNEL_PARTIAL = BIT(25),
421 /* channel configuration for struct iwl_scan_offload_cfg. Each channels needs:
422 * __le32 type: bitmap; bits 1-20 are for directed scan to i'th ssid and
423 * see enum iwl_scan_offload_channel_flags.
424 * __le16 channel_number: channel number 1-13 etc.
425 * __le16 iter_count: repetition count for the channel.
426 * __le32 iter_interval: interval between two innteration on one channel.
430 #define IWL_SCAN_CHAN_SIZE 14
433 * iwl_scan_offload_cfg - SCAN_OFFLOAD_CONFIG_API_S
434 * @scan_cmd: scan command fixed part
435 * @data: scan channel configuration and probe request frames
437 struct iwl_scan_offload_cfg {
438 struct iwl_scan_offload_cmd scan_cmd;
443 * iwl_scan_offload_blacklist - SCAN_OFFLOAD_BLACKLIST_S
444 * @ssid: MAC address to filter out
445 * @reported_rssi: AP rssi reported to the host
446 * @client_bitmap: clients ignore this entry - enum scan_framework_client
448 struct iwl_scan_offload_blacklist {
454 enum iwl_scan_offload_network_type {
455 IWL_NETWORK_TYPE_BSS = 1,
456 IWL_NETWORK_TYPE_IBSS = 2,
457 IWL_NETWORK_TYPE_ANY = 3,
460 enum iwl_scan_offload_band_selection {
461 IWL_SCAN_OFFLOAD_SELECT_2_4 = 0x4,
462 IWL_SCAN_OFFLOAD_SELECT_5_2 = 0x8,
463 IWL_SCAN_OFFLOAD_SELECT_ANY = 0xc,
467 * iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
468 * @ssid_index: index to ssid list in fixed part
469 * @unicast_cipher: encryption olgorithm to match - bitmap
470 * @aut_alg: authentication olgorithm to match - bitmap
471 * @network_type: enum iwl_scan_offload_network_type
472 * @band_selection: enum iwl_scan_offload_band_selection
473 * @client_bitmap: clients waiting for match - enum scan_framework_client
475 struct iwl_scan_offload_profile {
486 * iwl_scan_offload_profile_cfg - SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1
487 * @blaclist: AP list to filter off from scan results
488 * @profiles: profiles to search for match
489 * @blacklist_len: length of blacklist
490 * @num_profiles: num of profiles in the list
491 * @match_notify: clients waiting for match found notification
492 * @pass_match: clients waiting for the results
493 * @active_clients: active clients bitmap - enum scan_framework_client
494 * @any_beacon_notify: clients waiting for match notification without match
496 struct iwl_scan_offload_profile_cfg {
497 struct iwl_scan_offload_profile profiles[IWL_SCAN_MAX_PROFILES];
503 u8 any_beacon_notify;
508 * iwl_scan_offload_schedule - schedule of scan offload
509 * @delay: delay between iterations, in seconds.
510 * @iterations: num of scan iterations
511 * @full_scan_mul: number of partial scans before each full scan
513 struct iwl_scan_offload_schedule {
520 * iwl_scan_offload_flags
522 * IWL_SCAN_OFFLOAD_FLAG_PASS_ALL: pass all results - no filtering.
523 * IWL_SCAN_OFFLOAD_FLAG_CACHED_CHANNEL: add cached channels to partial scan.
524 * IWL_SCAN_OFFLOAD_FLAG_EBS_QUICK_MODE: EBS duration is 100mSec - typical
525 * beacon period. Finding channel activity in this mode is not guaranteed.
526 * IWL_SCAN_OFFLOAD_FLAG_EBS_ACCURATE_MODE: EBS duration is 200mSec.
527 * Assuming beacon period is 100ms finding channel activity is guaranteed.
529 enum iwl_scan_offload_flags {
530 IWL_SCAN_OFFLOAD_FLAG_PASS_ALL = BIT(0),
531 IWL_SCAN_OFFLOAD_FLAG_CACHED_CHANNEL = BIT(2),
532 IWL_SCAN_OFFLOAD_FLAG_EBS_QUICK_MODE = BIT(5),
533 IWL_SCAN_OFFLOAD_FLAG_EBS_ACCURATE_MODE = BIT(6),
537 * iwl_scan_offload_req - scan offload request command
538 * @flags: bitmap - enum iwl_scan_offload_flags.
539 * @watchdog: maximum scan duration in TU.
540 * @delay: delay in seconds before first iteration.
541 * @schedule_line: scan offload schedule, for fast and regular scan.
543 struct iwl_scan_offload_req {
548 struct iwl_scan_offload_schedule schedule_line[2];
551 enum iwl_scan_offload_compleate_status {
552 IWL_SCAN_OFFLOAD_COMPLETED = 1,
553 IWL_SCAN_OFFLOAD_ABORTED = 2,
556 enum iwl_scan_ebs_status {
557 IWL_SCAN_EBS_SUCCESS,
559 IWL_SCAN_EBS_CHAN_NOT_FOUND,
563 * iwl_scan_offload_complete - SCAN_OFFLOAD_COMPLETE_NTF_API_S_VER_1
564 * @last_schedule_line: last schedule line executed (fast or regular)
565 * @last_schedule_iteration: last scan iteration executed before scan abort
566 * @status: enum iwl_scan_offload_compleate_status
567 * @ebs_status: last EBS status, see IWL_SCAN_EBS_*
569 struct iwl_scan_offload_complete {
570 u8 last_schedule_line;
571 u8 last_schedule_iteration;
577 * iwl_sched_scan_results - SCAN_OFFLOAD_MATCH_FOUND_NTF_API_S_VER_1
578 * @ssid_bitmap: SSIDs indexes found in this iteration
579 * @client_bitmap: clients that are active and wait for this notification
581 struct iwl_sched_scan_results {
587 /* Unified LMAC scan API */
589 #define IWL_MVM_BASIC_PASSIVE_DWELL 110
592 * iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
593 * @tx_flags: combination of TX_CMD_FLG_*
594 * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
595 * cleared. Combination of RATE_MCS_*
596 * @sta_id: index of destination station in FW station table
597 * @reserved: for alignment and future use
599 struct iwl_scan_req_tx_cmd {
606 enum iwl_scan_channel_flags_lmac {
607 IWL_UNIFIED_SCAN_CHANNEL_FULL = BIT(27),
608 IWL_UNIFIED_SCAN_CHANNEL_PARTIAL = BIT(28),
612 * iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
613 * @flags: bits 1-20: directed scan to i'th ssid
614 * other bits &enum iwl_scan_channel_flags_lmac
615 * @channel_number: channel number 1-13 etc
616 * @iter_count: scan iteration on this channel
617 * @iter_interval: interval in seconds between iterations on one channel
619 struct iwl_scan_channel_cfg_lmac {
623 __le32 iter_interval;
627 * iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
628 * @offset: offset in the data block
629 * @len: length of the segment
631 struct iwl_scan_probe_segment {
636 /* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_2
637 * @mac_header: first (and common) part of the probe
638 * @band_data: band specific data
639 * @common_data: last (and common) part of the probe
640 * @buf: raw data block
642 struct iwl_scan_probe_req {
643 struct iwl_scan_probe_segment mac_header;
644 struct iwl_scan_probe_segment band_data[2];
645 struct iwl_scan_probe_segment common_data;
646 u8 buf[SCAN_OFFLOAD_PROBE_REQ_SIZE];
649 enum iwl_scan_channel_flags {
650 IWL_SCAN_CHANNEL_FLAG_EBS = BIT(0),
651 IWL_SCAN_CHANNEL_FLAG_EBS_ACCURATE = BIT(1),
652 IWL_SCAN_CHANNEL_FLAG_CACHE_ADD = BIT(2),
655 /* iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
656 * @flags: enum iwl_scan_channel_flgs
657 * @non_ebs_ratio: how many regular scan iteration before EBS
659 struct iwl_scan_channel_opt {
661 __le16 non_ebs_ratio;
665 * iwl_mvm_lmac_scan_flags
666 * @IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL: pass all beacons and probe responses
668 * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
669 * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
670 * @IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE: send iteration complete notification
671 * @IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS multiple SSID matching
672 * @IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED: all passive scans will be fragmented
673 * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
674 * and DS parameter set IEs into probe requests.
675 * @IWL_MVM_LMAC_SCAN_FLAG_MATCH: Send match found notification on matches
677 enum iwl_mvm_lmac_scan_flags {
678 IWL_MVM_LMAC_SCAN_FLAG_PASS_ALL = BIT(0),
679 IWL_MVM_LMAC_SCAN_FLAG_PASSIVE = BIT(1),
680 IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION = BIT(2),
681 IWL_MVM_LMAC_SCAN_FLAG_ITER_COMPLETE = BIT(3),
682 IWL_MVM_LMAC_SCAN_FLAG_MULTIPLE_SSIDS = BIT(4),
683 IWL_MVM_LMAC_SCAN_FLAG_FRAGMENTED = BIT(5),
684 IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED = BIT(6),
685 IWL_MVM_LMAC_SCAN_FLAG_MATCH = BIT(9),
688 enum iwl_scan_priority {
689 IWL_SCAN_PRIORITY_LOW,
690 IWL_SCAN_PRIORITY_MEDIUM,
691 IWL_SCAN_PRIORITY_HIGH,
695 * iwl_scan_req_unified_lmac - SCAN_REQUEST_CMD_API_S_VER_1
696 * @reserved1: for alignment and future use
697 * @channel_num: num of channels to scan
698 * @active-dwell: dwell time for active channels
699 * @passive-dwell: dwell time for passive channels
700 * @fragmented-dwell: dwell time for fragmented passive scan
701 * @reserved2: for alignment and future use
702 * @rx_chain_selct: PHY_RX_CHAIN_* flags
703 * @scan_flags: &enum iwl_mvm_lmac_scan_flags
704 * @max_out_time: max time (in TU) to be out of associated channel
705 * @suspend_time: pause scan this long (TUs) when returning to service channel
707 * @filter_flags: RXON filter
708 * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
709 * @direct_scan: list of SSIDs for directed active scan
710 * @scan_prio: enum iwl_scan_priority
711 * @iter_num: number of scan iterations
712 * @delay: delay in seconds before first iteration
713 * @schedule: two scheduling plans. The first one is finite, the second one can
715 * @channel_opt: channel optimization options, for full and partial scan
716 * @data: channel configuration and probe request packet.
718 struct iwl_scan_req_unified_lmac {
719 /* SCAN_REQUEST_FIXED_PART_API_S_VER_7 */
726 __le16 rx_chain_select;
730 /* RX_ON_FLAGS_API_S_VER_1 */
733 struct iwl_scan_req_tx_cmd tx_cmd[2];
734 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
736 /* SCAN_REQ_PERIODIC_PARAMS_API_S */
739 struct iwl_scan_offload_schedule schedule[2];
740 struct iwl_scan_channel_opt channel_opt[2];
745 * struct iwl_lmac_scan_results_notif - scan results for one channel -
746 * SCAN_RESULT_NTF_API_S_VER_3
747 * @channel: which channel the results are from
748 * @band: 0 for 5.2 GHz, 1 for 2.4 GHz
749 * @probe_status: SCAN_PROBE_STATUS_*, indicates success of probe request
750 * @num_probe_not_sent: # of request that weren't sent due to not enough time
751 * @duration: duration spent in channel, in usecs
753 struct iwl_lmac_scan_results_notif {
757 u8 num_probe_not_sent;
762 * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
763 * SCAN_COMPLETE_NTF_API_S_VER_3
764 * @scanned_channels: number of channels scanned (and number of valid results)
765 * @status: one of SCAN_COMP_STATUS_*
766 * @bt_status: BT on/off status
767 * @last_channel: last channel that was scanned
768 * @tsf_low: TSF timer (lower half) in usecs
769 * @tsf_high: TSF timer (higher half) in usecs
770 * @results: an array of scan results, only "scanned_channels" of them are valid
772 struct iwl_lmac_scan_complete_notif {
779 struct iwl_scan_results_notif results[];
783 * iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
784 * @last_schedule_line: last schedule line executed (fast or regular)
785 * @last_schedule_iteration: last scan iteration executed before scan abort
786 * @status: enum iwl_scan_offload_complete_status
787 * @ebs_status: EBS success status &enum iwl_scan_ebs_status
788 * @time_after_last_iter; time in seconds elapsed after last iteration
790 struct iwl_periodic_scan_complete {
791 u8 last_schedule_line;
792 u8 last_schedule_iteration;
795 __le32 time_after_last_iter;
802 * struct iwl_mvm_umac_cmd_hdr - Command header for UMAC commands
803 * @size: size of the command (not including header)
804 * @reserved0: for future use and alignment
805 * @ver: API version number
807 struct iwl_mvm_umac_cmd_hdr {
813 #define IWL_MVM_MAX_SIMULTANEOUS_SCANS 8
815 enum scan_config_flags {
816 SCAN_CONFIG_FLAG_ACTIVATE = BIT(0),
817 SCAN_CONFIG_FLAG_DEACTIVATE = BIT(1),
818 SCAN_CONFIG_FLAG_FORBID_CHUB_REQS = BIT(2),
819 SCAN_CONFIG_FLAG_ALLOW_CHUB_REQS = BIT(3),
820 SCAN_CONFIG_FLAG_SET_TX_CHAINS = BIT(8),
821 SCAN_CONFIG_FLAG_SET_RX_CHAINS = BIT(9),
822 SCAN_CONFIG_FLAG_SET_AUX_STA_ID = BIT(10),
823 SCAN_CONFIG_FLAG_SET_ALL_TIMES = BIT(11),
824 SCAN_CONFIG_FLAG_SET_EFFECTIVE_TIMES = BIT(12),
825 SCAN_CONFIG_FLAG_SET_CHANNEL_FLAGS = BIT(13),
826 SCAN_CONFIG_FLAG_SET_LEGACY_RATES = BIT(14),
827 SCAN_CONFIG_FLAG_SET_MAC_ADDR = BIT(15),
828 SCAN_CONFIG_FLAG_SET_FRAGMENTED = BIT(16),
829 SCAN_CONFIG_FLAG_CLEAR_FRAGMENTED = BIT(17),
830 SCAN_CONFIG_FLAG_SET_CAM_MODE = BIT(18),
831 SCAN_CONFIG_FLAG_CLEAR_CAM_MODE = BIT(19),
832 SCAN_CONFIG_FLAG_SET_PROMISC_MODE = BIT(20),
833 SCAN_CONFIG_FLAG_CLEAR_PROMISC_MODE = BIT(21),
835 /* Bits 26-31 are for num of channels in channel_array */
836 #define SCAN_CONFIG_N_CHANNELS(n) ((n) << 26)
839 enum scan_config_rates {
840 /* OFDM basic rates */
841 SCAN_CONFIG_RATE_6M = BIT(0),
842 SCAN_CONFIG_RATE_9M = BIT(1),
843 SCAN_CONFIG_RATE_12M = BIT(2),
844 SCAN_CONFIG_RATE_18M = BIT(3),
845 SCAN_CONFIG_RATE_24M = BIT(4),
846 SCAN_CONFIG_RATE_36M = BIT(5),
847 SCAN_CONFIG_RATE_48M = BIT(6),
848 SCAN_CONFIG_RATE_54M = BIT(7),
849 /* CCK basic rates */
850 SCAN_CONFIG_RATE_1M = BIT(8),
851 SCAN_CONFIG_RATE_2M = BIT(9),
852 SCAN_CONFIG_RATE_5M = BIT(10),
853 SCAN_CONFIG_RATE_11M = BIT(11),
855 /* Bits 16-27 are for supported rates */
856 #define SCAN_CONFIG_SUPPORTED_RATE(rate) ((rate) << 16)
859 enum iwl_channel_flags {
860 IWL_CHANNEL_FLAG_EBS = BIT(0),
861 IWL_CHANNEL_FLAG_ACCURATE_EBS = BIT(1),
862 IWL_CHANNEL_FLAG_EBS_ADD = BIT(2),
863 IWL_CHANNEL_FLAG_PRE_SCAN_PASSIVE2ACTIVE = BIT(3),
867 * struct iwl_scan_config
868 * @hdr: umac command header
869 * @flags: enum scan_config_flags
870 * @tx_chains: valid_tx antenna - ANT_* definitions
871 * @rx_chains: valid_rx antenna - ANT_* definitions
872 * @legacy_rates: default legacy rates - enum scan_config_rates
873 * @out_of_channel_time: default max out of serving channel time
874 * @suspend_time: default max suspend time
875 * @dwell_active: default dwell time for active scan
876 * @dwell_passive: default dwell time for passive scan
877 * @dwell_fragmented: default dwell time for fragmented scan
878 * @reserved: for future use and alignment
879 * @mac_addr: default mac address to be used in probes
880 * @bcast_sta_id: the index of the station in the fw
881 * @channel_flags: default channel flags - enum iwl_channel_flags
882 * scan_config_channel_flag
883 * @channel_array: default supported channels
885 struct iwl_scan_config {
886 struct iwl_mvm_umac_cmd_hdr hdr;
891 __le32 out_of_channel_time;
897 u8 mac_addr[ETH_ALEN];
901 } __packed; /* SCAN_CONFIG_DB_CMD_API_S */
904 * iwl_umac_scan_flags
905 *@IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
906 * can be preempted by other scan requests with higher priority.
907 * The low priority scan is aborted.
908 *@IWL_UMAC_SCAN_FLAG_START_NOTIF: notification will be sent to the driver
911 enum iwl_umac_scan_flags {
912 IWL_UMAC_SCAN_FLAG_PREEMPTIVE = BIT(0),
913 IWL_UMAC_SCAN_FLAG_START_NOTIF = BIT(1),
916 enum iwl_umac_scan_uid_offsets {
917 IWL_UMAC_SCAN_UID_TYPE_OFFSET = 0,
918 IWL_UMAC_SCAN_UID_SEQ_OFFSET = 8,
921 enum iwl_umac_scan_general_flags {
922 IWL_UMAC_SCAN_GEN_FLAGS_PERIODIC = BIT(0),
923 IWL_UMAC_SCAN_GEN_FLAGS_OVER_BT = BIT(1),
924 IWL_UMAC_SCAN_GEN_FLAGS_PASS_ALL = BIT(2),
925 IWL_UMAC_SCAN_GEN_FLAGS_PASSIVE = BIT(3),
926 IWL_UMAC_SCAN_GEN_FLAGS_PRE_CONNECT = BIT(4),
927 IWL_UMAC_SCAN_GEN_FLAGS_ITER_COMPLETE = BIT(5),
928 IWL_UMAC_SCAN_GEN_FLAGS_MULTIPLE_SSID = BIT(6),
929 IWL_UMAC_SCAN_GEN_FLAGS_FRAGMENTED = BIT(7),
930 IWL_UMAC_SCAN_GEN_FLAGS_RRM_ENABLED = BIT(8),
931 IWL_UMAC_SCAN_GEN_FLAGS_MATCH = BIT(9)
935 * struct iwl_scan_channel_cfg_umac
936 * @flags: bitmap - 0-19: directed scan to i'th ssid.
937 * @channel_num: channel number 1-13 etc.
938 * @iter_count: repetition count for the channel.
939 * @iter_interval: interval between two scan interations on one channel.
941 struct iwl_scan_channel_cfg_umac {
945 __le16 iter_interval;
946 } __packed; /* SCAN_CHANNEL_CFG_S_VER2 */
949 * struct iwl_scan_umac_schedule
950 * @interval: interval in seconds between scan iterations
951 * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
952 * @reserved: for alignment and future use
954 struct iwl_scan_umac_schedule {
958 } __packed; /* SCAN_SCHED_PARAM_API_S_VER_1 */
961 * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
962 * parameters following channels configuration array.
963 * @schedule: two scheduling plans.
964 * @delay: delay in TUs before starting the first scan iteration
965 * @reserved: for future use and alignment
966 * @preq: probe request with IEs blocks
967 * @direct_scan: list of SSIDs for directed active scan
969 struct iwl_scan_req_umac_tail {
970 /* SCAN_PERIODIC_PARAMS_API_S_VER_1 */
971 struct iwl_scan_umac_schedule schedule[2];
974 /* SCAN_PROBE_PARAMS_API_S_VER_1 */
975 struct iwl_scan_probe_req preq;
976 struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
980 * struct iwl_scan_req_umac
981 * @hdr: umac command header
982 * @flags: &enum iwl_umac_scan_flags
983 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
984 * @ooc_priority: out of channel priority - &enum iwl_scan_priority
985 * @general_flags: &enum iwl_umac_scan_general_flags
986 * @reserved1: for future use and alignment
987 * @active_dwell: dwell time for active scan
988 * @passive_dwell: dwell time for passive scan
989 * @fragmented_dwell: dwell time for fragmented passive scan
990 * @max_out_time: max out of serving channel time
991 * @suspend_time: max suspend time
992 * @scan_priority: scan internal prioritization &enum iwl_scan_priority
993 * @channel_flags: &enum iwl_scan_channel_flags
994 * @n_channels: num of channels in scan request
995 * @reserved2: for future use and alignment
996 * @data: &struct iwl_scan_channel_cfg_umac and
997 * &struct iwl_scan_req_umac_tail
999 struct iwl_scan_req_umac {
1000 struct iwl_mvm_umac_cmd_hdr hdr;
1003 __le32 ooc_priority;
1004 /* SCAN_GENERAL_PARAMS_API_S_VER_1 */
1005 __le32 general_flags;
1009 u8 fragmented_dwell;
1010 __le32 max_out_time;
1011 __le32 suspend_time;
1012 __le32 scan_priority;
1013 /* SCAN_CHANNEL_PARAMS_API_S_VER_1 */
1018 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_1 */
1021 * struct iwl_umac_scan_abort
1022 * @hdr: umac command header
1023 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1026 struct iwl_umac_scan_abort {
1027 struct iwl_mvm_umac_cmd_hdr hdr;
1030 } __packed; /* SCAN_ABORT_CMD_UMAC_API_S_VER_1 */
1033 * struct iwl_umac_scan_complete
1034 * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1035 * @last_schedule: last scheduling line
1036 * @last_iter: last scan iteration number
1037 * @scan status: &enum iwl_scan_offload_complete_status
1038 * @ebs_status: &enum iwl_scan_ebs_status
1039 * @time_from_last_iter: time elapsed from last iteration
1040 * @reserved: for future use
1042 struct iwl_umac_scan_complete {
1048 __le32 time_from_last_iter;
1050 } __packed; /* SCAN_COMPLETE_NTF_UMAC_API_S_VER_1 */
1052 #define SCAN_OFFLOAD_MATCHING_CHANNELS_LEN 5
1054 * struct iwl_scan_offload_profile_match - match information
1055 * @bssid: matched bssid
1056 * @channel: channel where the match occurred
1058 * @matching_feature:
1059 * @matching_channels: bitmap of channels that matched, referencing
1060 * the channels passed in tue scan offload request
1062 struct iwl_scan_offload_profile_match {
1067 u8 matching_feature;
1068 u8 matching_channels[SCAN_OFFLOAD_MATCHING_CHANNELS_LEN];
1069 } __packed; /* SCAN_OFFLOAD_PROFILE_MATCH_RESULTS_S_VER_1 */
1072 * struct iwl_scan_offload_profiles_query - match results query response
1073 * @matched_profiles: bitmap of matched profiles, referencing the
1074 * matches passed in the scan offload request
1075 * @last_scan_age: age of the last offloaded scan
1076 * @n_scans_done: number of offloaded scans done
1077 * @gp2_d0u: GP2 when D0U occurred
1078 * @gp2_invoked: GP2 when scan offload was invoked
1079 * @resume_while_scanning: not used
1080 * @self_recovery: obsolete
1081 * @reserved: reserved
1082 * @matches: array of match information, one for each match
1084 struct iwl_scan_offload_profiles_query {
1085 __le32 matched_profiles;
1086 __le32 last_scan_age;
1087 __le32 n_scans_done;
1090 u8 resume_while_scanning;
1093 struct iwl_scan_offload_profile_match matches[IWL_SCAN_MAX_PROFILES];
1094 } __packed; /* SCAN_OFFLOAD_PROFILES_QUERY_RSP_S_VER_2 */