fw/api/scan.h

1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
3  * Copyright (C) 2012-2014, 2018-2023 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
29  * struct iwl_ssid_ie - directed scan network information element
46 /* scan offload */
55 /* Default watchdog (in MS) for scheduled scan iteration */
72  * struct iwl_scan_offload_blocklist - SCAN_OFFLOAD_BLACKLIST_S
75  * @client_bitmap: clients ignore this entry  - enum scan_framework_client
106  * struct iwl_scan_offload_profile - SCAN_OFFLOAD_PROFILE_S
108  * @unicast_cipher:	encryption algorithm to match - bitmap
109  * @auth_alg:		authentication algorithm to match - bitmap
112  * @client_bitmap:	clients waiting for match - enum scan_framework_client
131  * @active_clients:	active clients bitmap - enum scan_framework_client
153 } __packed; /* SCAN_OFFLOAD_PROFILES_CFG_API_S_VER_1-2*/
166  * struct iwl_scan_schedule_lmac - schedule of scan offload
167  * @delay:		delay between iterations, in seconds.
168  * @iterations:		num of scan iterations
169  * @full_scan_mul:	number of partial scans before each full scan
172 	__le16 delay;  member
190  * struct iwl_scan_req_tx_cmd - SCAN_REQ_TX_CMD_API_S
210  * struct iwl_scan_channel_cfg_lmac - SCAN_CHANNEL_CFG_S_VER2
211  * @flags:		bits 1-20: directed scan to i'th ssid
213  * @channel_num:	channel number 1-13 etc
214  * @iter_count:		scan iteration on this channel
225  * struct iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1
235  * struct iwl_scan_probe_req_v1 - PROBE_REQUEST_FRAME_API_S_VER_2
249  * struct iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_v2
273  * struct iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S
275  * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is
277  *	1 - EBS is disabled.
278  *	2 - every second scan will be full scan(and so on).
286  * enum iwl_mvm_lmac_scan_flags - LMAC scan flags
289  * @IWL_MVM_LMAC_SCAN_FLAG_PASSIVE: force passive scan on all channels
290  * @IWL_MVM_LMAC_SCAN_FLAG_PRE_CONNECTION: single channel scan
294  * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
330  * struct iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
332  * @n_channels: num of channels to scan
335  * @fragmented_dwell: dwell time for fragmented passive scan
341  * @suspend_time: pause scan this long (TUs) when returning to service channel
344  * @tx_cmd: tx command for active scan; for 2GHz and for 5GHz
345  * @direct_scan: list of SSIDs for directed active scan
347  * @iter_num: number of scan iterations
348  * @delay: delay in seconds before first iteration
351  * @channel_opt: channel optimization options, for full and partial scan
375 	__le32 delay;  member
382  * struct iwl_scan_results_notif - scan results for one channel -
399  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
407  * @results: an array of scan results, only "scanned_channels" of them are valid
420  * struct iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
422  * @last_schedule_iteration: last scan iteration executed before scan abort
437 /* UMAC Scan API */
440  * 8-bit mask (see IWL_MVM_SCAN_MASK in mvm.h).
467 	/* Bits 26-31 are for num of channels in channel_array */
487 	/* Bits 16-27 are for supported rates */
505  * @active:		default dwell time for active scan
506  * @passive:		default dwell time for passive scan
507  * @fragmented:		default dwell time for fragmented scan
518  * struct iwl_scan_config_v1 - scan configuration command
520  * @tx_chains:			valid_tx antenna - ANT_* definitions
521  * @rx_chains:			valid_rx antenna - ANT_* definitions
522  * @legacy_rates:		default legacy rates - enum scan_config_rates
525  * @dwell:			dwells for the scan
528  * @channel_flags:		default channel flags - enum iwl_channel_flags
551  * struct iwl_scan_config_v2 - scan configuration command
553  * @tx_chains:			valid_tx antenna - ANT_* definitions
554  * @rx_chains:			valid_rx antenna - ANT_* definitions
555  * @legacy_rates:		default legacy rates - enum scan_config_rates
558  * @dwell:			dwells for the scan
561  * @channel_flags:		default channel flags - enum iwl_channel_flags
580  * struct iwl_scan_config - scan configuration command
586  * @tx_chains: valid_tx antenna - ANT_* definitions
587  * @rx_chains: valid_rx antenna - ANT_* definitions
599  * enum iwl_umac_scan_flags - UMAC scan flags
600  * @IWL_UMAC_SCAN_FLAG_PREEMPTIVE: scan process triggered by this scan request
601  *	can be preempted by other scan requests with higher priority.
602  *	The low priority scan will be resumed when the higher proirity scan is
605  *	when scan starts.
640  * enum iwl_umac_scan_general_flags2 - UMAC scan general flags #2
652  * enum iwl_umac_scan_general_flags_v2 - UMAC scan general flags version 2
658  *                                       during scan iterations
661  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FRAGMENTED_LMAC1: fragmented scan LMAC1
662  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FRAGMENTED_LMAC2: fragmented scan LMAC2
663  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_MATCH: does this scan check for profile matching
668  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_NTF_START: send notification of scan start
673  *		5.2Ghz bands scan, trigger scan on 6GHz band to discover
676  *      bands scan, if not APs were discovered, allow scan to conitnue and scan
679  *      &IWL_UMAC_SCAN_GEN_FLAGS_V2_6GHZ_PASSIVE_SCAN is enabled and scan is
706  * enum iwl_umac_scan_general_params_flags2 - UMAC scan general flags2
708  * @IWL_UMAC_SCAN_GEN_PARAMS_FLAGS2_RESPECT_P2P_GO_LB: scan event scheduling
710  * @IWL_UMAC_SCAN_GEN_PARAMS_FLAGS2_RESPECT_P2P_GO_HB: scan event scheduling
713  *     valid antennas, and use the same antenna as in previous scan
723  * @flags:		bitmap - 0-19:	directed scan to i'th ssid.
724  * @channel_num:	channel number 1-13 etc.
727  * @iter_interval:	interval between two scan iterations on one channel.
762  * @interval: interval in seconds between scan iterations
763  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
775 	__le16 delay;  member
783  * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
786  * @delay: delay in TUs before starting the first scan iteration
789  * @direct_scan: list of SSIDs for directed active scan
794 	__le16 delay;  member
804  * @count: num of channels in scan request
816  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
817  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
819  * @scan_start_mac_id: report the scan start TSF time according to this mac TSF
821  * @active_dwell: dwell time for active scan per LMAC
822  * @passive_dwell: dwell time for passive scan per LMAC
823  * @fragmented_dwell: dwell time for fragmented passive scan
830  *	to total scan time
831  * @max_out_time: max out of serving channel time, per LMAC - for CDB there
833  * @suspend_time: max suspend time, per LMAC - for CDB there are 2 LMACs
834  * @scan_priority: scan internal prioritization &enum iwl_scan_priority
836  *	Relevant only for fragmented scan.
927  * @preq: scan probe request params
928  * @ssid_num: number of valid SSIDs in direct scan array
949  * @preq: scan probe request params
972  * @count: num of channels in scan request
995  * @count: num of channels in scan request
1014  * @scan_start_mac_or_link_id: report the scan start TSF time according to this
1016  * @active_dwell: dwell time for active scan per LMAC
1026  *                     can add to the total scan time
1033  *                    scan coverage.
1055  * @delay: initial delay of the periodic scan in seconds
1060 	__le16 delay;  member
1090 } __packed; /* SCAN_REQUEST_PARAMS_API_S_VER_17 - 14 */
1094  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1095  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1096  * @scan_params: scan parameters
1106  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1107  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1108  * @scan_params: scan parameters
1114 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_17 - 14 */
1118  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1128  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1130  * @last_iter: last scan iteration number
1150  * struct iwl_scan_offload_profile_match_v1 - match information
1157  *	the channels passed in the scan offload request.
1169  * struct iwl_scan_offload_profiles_query_v1 - match results query response
1171  *	matches passed in the scan offload request
1172  * @last_scan_age: age of the last offloaded scan
1175  * @gp2_invoked: GP2 when scan offload was invoked
1194  * struct iwl_scan_offload_profile_match - match information
1201  *	the channels passed in the scan offload request.
1213  * struct iwl_scan_offload_match_info - match results information
1215  *	matches passed in the scan offload request
1216  * @last_scan_age: age of the last offloaded scan
1219  * @gp2_invoked: GP2 when scan offload was invoked
1240  * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
1241  * @uid: scan id, &enum iwl_umac_scan_uid_offsets
1247  * @start_tsf: TSF timer in usecs of the scan start time for the mac specified
1249  * @results: array of scan results, length in @scanned_channels