fw/api/scan.h

1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
3  * Copyright (C) 2012-2014, 2018-2024 Intel Corporation
4  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5  * Copyright (C) 2016-2017 Intel Deutschland GmbH
10 /* Scan Commands, Responses, Notifications */
13  * enum iwl_scan_subcmd_ids - scan commands
33  * struct iwl_ssid_ie - directed scan network information element
50 /* scan offload */
59 /* Default watchdog (in MS) for scheduled scan iteration */
78  * struct iwl_scan_offload_blocklist - SCAN_OFFLOAD_BLACKLIST_S
81  * @client_bitmap: clients ignore this entry  - enum scan_framework_client
112  * struct iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
114  * @unicast_cipher:	encryption algorithm to match - bitmap
115  * @auth_alg:		authentication algorithm to match - bitmap
118  * @client_bitmap:	clients waiting for match - enum scan_framework_client
137  * @active_clients:	active clients bitmap - enum scan_framework_client
152  * struct iwl_scan_offload_profile_cfg_v1 - scan offload profile config
159 } __packed; /* SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1-2*/
172  * struct iwl_scan_schedule_lmac - schedule of scan offload
174  * @iterations:		num of scan iterations
175  * @full_scan_mul:	number of partial scans before each full scan
196  * struct iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
216  * struct iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
217  * @flags:		bits 1-20: directed scan to i'th ssid
219  * @channel_num:	channel number 1-13 etc
220  * @iter_count:		scan iteration on this channel
221  * @iter_interval:	interval in seconds between iterations on one channel
231  * struct iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
241  * struct iwl_scan_probe_req_v1 - PROBE_REQUEST_FRAME_API_S_VER_2
255  * struct iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_v2
279  * struct iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
281  * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is
283  *	1 - EBS is disabled.
284  *	2 - every second scan will be full scan(and so on).
292  * enum iwl_mvm_lmac_scan_flags - LMAC scan flags
295  * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
296  * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
300  * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
336  * struct iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
338  * @n_channels: num of channels to scan
341  * @fragmented_dwell: dwell time for fragmented passive scan
347  * @suspend_time: pause scan this long (TUs) when returning to service channel
350  * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
351  * @direct_scan: list of SSIDs for directed active scan
353  * @iter_num: number of scan iterations
357  * @channel_opt: channel optimization options, for full and partial scan
388  * struct iwl_scan_results_notif - scan results for one channel -
405  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
413  * @results: an array of scan results, only "scanned_channels" of them are valid
426  * struct iwl_periodic_scan_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
428  * @last_schedule_iteration: last scan iteration executed before scan abort
443 /* UMAC Scan API */
446  * 8-bit mask (see enum iwl_scan_status).
473 	/* Bits 26-31 are for num of channels in channel_array */
493 	/* Bits 16-27 are for supported rates */
511  * @active:		default dwell time for active scan
512  * @passive:		default dwell time for passive scan
513  * @fragmented:		default dwell time for fragmented scan
524  * struct iwl_scan_config_v1 - scan configuration command
526  * @tx_chains:			valid_tx antenna - ANT_* definitions
527  * @rx_chains:			valid_rx antenna - ANT_* definitions
528  * @legacy_rates:		default legacy rates - enum scan_config_rates
531  * @dwell:			dwells for the scan
534  * @channel_flags:		default channel flags - enum iwl_channel_flags
557  * struct iwl_scan_config_v2 - scan configuration command
559  * @tx_chains:			valid_tx antenna - ANT_* definitions
560  * @rx_chains:			valid_rx antenna - ANT_* definitions
561  * @legacy_rates:		default legacy rates - enum scan_config_rates
564  * @dwell:			dwells for the scan
567  * @channel_flags:		default channel flags - enum iwl_channel_flags
586  * struct iwl_scan_config - scan configuration command
592  * @tx_chains: valid_tx antenna - ANT_* definitions
593  * @rx_chains: valid_rx antenna - ANT_* definitions
605  * enum iwl_umac_scan_flags - UMAC scan flags
606  * @IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
607  *	can be preempted by other scan requests with higher priority.
608  *	The low priority scan will be resumed when the higher proirity scan is
611  *	when scan starts.
646  * enum iwl_umac_scan_general_flags2 - UMAC scan general flags #2
661  * enum iwl_umac_scan_general_flags_v2 - UMAC scan general flags version 2
667  *                                       during scan iterations
670  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FRAGMENTED_LMAC1: fragmented scan LMAC1
671  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FRAGMENTED_LMAC2: fragmented scan LMAC2
672  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_MATCH: does this scan check for profile matching
677  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_NTF_START: send notification of scan start
682  *		5.2Ghz bands scan, trigger scan on 6GHz band to discover
685  *      bands scan, if not APs were discovered, allow scan to conitnue and scan
688  *      &IWL_UMAC_SCAN_GEN_FLAGS_V2_6GHZ_PASSIVE_SCAN is enabled and scan is
715  * enum iwl_umac_scan_general_params_flags2 - UMAC scan general flags2
717  * @IWL_UMAC_SCAN_GEN_PARAMS_FLAGS2_RESPECT_P2P_GO_LB: scan event scheduling
719  * @IWL_UMAC_SCAN_GEN_PARAMS_FLAGS2_RESPECT_P2P_GO_HB: scan event scheduling
722  *     valid antennas, and use the same antenna as in previous scan
732  * @flags:		bitmap - 0-19:	directed scan to i'th ssid.
733  * @channel_num:	channel number 1-13 etc.
736  * @v1.iter_interval:	interval between two scan iterations on one channel.
737  * @v2:			command versions 2-4
740  * @v2.iter_interval:	interval between two scan iterations on one channel.
743  * @v5.iter_interval:	interval between two scan iterations on one channel.
778  * @interval: interval in seconds between scan iterations
779  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
783 	__le16 interval;  member
799  * struct iwl_scan_req_umac_tail_v2 - the rest of the UMAC scan request command
802  * @delay: delay in TUs before starting the first scan iteration
805  * @direct_scan: list of SSIDs for directed active scan
820  * @count: num of channels in scan request
832  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
833  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
835  * @scan_start_mac_id: report the scan start TSF time according to this mac TSF
837  * @active_dwell: dwell time for active scan per LMAC
838  * @passive_dwell: dwell time for passive scan per LMAC
839  * @fragmented_dwell: dwell time for fragmented passive scan
846  *	to total scan time
847  * @max_out_time: max out of serving channel time, per LMAC - for CDB there
849  * @suspend_time: max suspend time, per LMAC - for CDB there are 2 LMACs
850  * @scan_priority: scan internal prioritization &enum iwl_scan_priority
852  *	Relevant only for fragmented scan.
943  * @preq: scan probe request params
944  * @ssid_num: number of valid SSIDs in direct scan array
965  * @preq: scan probe request params
988  * @count: num of channels in scan request
1011  * @count: num of channels in scan request
1030  * @scan_start_mac_or_link_id: report the scan start TSF time according to this
1032  * @active_dwell: dwell time for active scan per LMAC
1042  *                     can add to the total scan time
1049  *                    scan coverage.
1071  * @delay: initial delay of the periodic scan in seconds
1095  * struct iwl_scan_req_params_v17 - scan request parameters (v17)
1106 } __packed; /* SCAN_REQUEST_PARAMS_API_S_VER_17 - 14 */
1110  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1111  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1112  * @scan_params: scan parameters
1121  * struct iwl_scan_req_umac_v17 - scan request command (v17)
1122  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1123  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1124  * @scan_params: scan parameters
1130 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_17 - 14 */
1134  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1145  * @IWL_UMAC_SCAN_ABORT_STATUS_SUCCESS: scan was successfully aborted
1146  * @IWL_UMAC_SCAN_ABORT_STATUS_IN_PROGRESS: scan abort is in progress
1157  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1159  * @last_iter: last scan iteration number
1179  * struct iwl_scan_offload_profile_match_v1 - match information
1186  *	the channels passed in the scan offload request.
1198  * struct iwl_scan_offload_profiles_query_v1 - match results query response
1200  *	matches passed in the scan offload request
1201  * @last_scan_age: age of the last offloaded scan
1204  * @gp2_invoked: GP2 when scan offload was invoked
1223  * struct iwl_scan_offload_profile_match - match information
1230  *	the channels passed in the scan offload request.
1242  * struct iwl_scan_offload_match_info - match results information
1244  *	matches passed in the scan offload request
1245  * @last_scan_age: age of the last offloaded scan
1248  * @gp2_invoked: GP2 when scan offload was invoked
1269  * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
1270  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1276  * @start_tsf: TSF timer in usecs of the scan start time for the mac specified
1278  * @results: array of scan results, length in @scanned_channels
1291  * struct iwl_umac_scan_channel_survey_notif - data for survey