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
13  * enum iwl_scan_subcmd_ids - scan commands
33  * struct iwl_ssid_ie - directed scan network information element
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
134  * @num_profiles:	num of profiles in the list
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
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
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
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
300  * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
302  * @IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL: use extended dwell time on channels
336  * struct iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
338  * @n_channels: num of channels to scan
339  * @active_dwell: dwell time for active channels
340  * @passive_dwell: dwell time for passive channels
342  * @extended_dwell: dwell time for channels 1, 6 and 11 (in certain cases)
388  * struct iwl_scan_results_notif - scan results for one channel -
405  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
407  * @scanned_channels: number of channels scanned (and number of valid results)
426  * struct iwl_periodic_scan_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
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 */
514  * @extended:		default dwell time for channels 1, 6 and 11
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
534  * @channel_flags:		default channel flags - enum iwl_channel_flags
536  * @channel_array:		default supported channels
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
567  * @channel_flags:		default channel flags - enum iwl_channel_flags
569  * @channel_array:		default supported channels
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
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
679  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FORCE_PASSIVE: all the channels scanned
686  *      6GHz PSC channels in order to discover country information.
689  *      activated over 6GHz PSC channels, filter in beacons and probe responses.
715  * enum iwl_umac_scan_general_params_flags2 - UMAC scan general flags2
732  * @flags:		bitmap - 0-19:	directed scan to i'th ssid.
733  * @channel_num:	channel number 1-13 etc.
737  * @v2:			command versions 2-4
779  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
799  * struct iwl_scan_req_umac_tail_v2 - the rest of the UMAC scan request command
800  *      parameters following channels configuration array.
820  * @count: num of channels in scan request
833  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
836  * @extended_dwell: dwell time for channels 1, 6 and 11
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
988  * @count: num of channels in scan request
1011  * @count: num of channels in scan request
1036  *                        for 5GHz channels
1095  * struct iwl_scan_req_params_v17 - scan request parameters (v17)
1106 } __packed; /* SCAN_REQUEST_PARAMS_API_S_VER_17 - 14 */
1111  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1121  * struct iwl_scan_req_umac_v17 - scan request command (v17)
1123  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1130 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_17 - 14 */
1179  * struct iwl_scan_offload_profile_match_v1 - match information
1185  * @matching_channels: bitmap of channels that matched, referencing
1186  *	the channels passed in the scan offload request.
1198  * struct iwl_scan_offload_profiles_query_v1 - match results query response
1223  * struct iwl_scan_offload_profile_match - match information
1229  * @matching_channels: bitmap of channels that matched, referencing
1230  *	the channels passed in the scan offload request.
1242  * struct iwl_scan_offload_match_info - match results information
1269  * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
1271  * @scanned_channels: number of channels scanned and number of valid elements in
1291  * struct iwl_umac_scan_channel_survey_notif - data for survey