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
13  * enum iwl_scan_subcmd_ids - scan commands
29  * struct iwl_ssid_ie - directed scan network information element
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
128  * @num_profiles:	num of profiles in the list
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
168  * @iterations:		num of scan iterations
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
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
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
294  * @IWL_MVM_LMAC_SCAN_FLAGS_RRM_ENABLED: insert WFA vendor-specific TPC report
296  * @IWL_MVM_LMAC_SCAN_FLAG_EXTENDED_DWELL: use extended dwell time on channels
330  * struct iwl_scan_req_lmac - SCAN_REQUEST_CMD_API_S_VER_1
332  * @n_channels: num of channels to scan
333  * @active_dwell: dwell time for active channels
334  * @passive_dwell: dwell time for passive channels
336  * @extended_dwell: dwell time for channels 1, 6 and 11 (in certain cases)
382  * struct iwl_scan_results_notif - scan results for one channel -
399  * struct iwl_lmac_scan_complete_notif - notifies end of scanning (all channels)
401  * @scanned_channels: number of channels scanned (and number of valid results)
420  * struct iwl_scan_offload_complete - PERIODIC_SCAN_COMPLETE_NTF_API_S_VER_2
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 */
508  * @extended:		default dwell time for channels 1, 6 and 11
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
528  * @channel_flags:		default channel flags - enum iwl_channel_flags
530  * @channel_array:		default supported channels
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
561  * @channel_flags:		default channel flags - enum iwl_channel_flags
563  * @channel_array:		default supported channels
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
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
670  * @IWL_UMAC_SCAN_GEN_FLAGS_V2_FORCE_PASSIVE: all the channels scanned
677  *      6GHz PSC channels in order to discover country information.
680  *      activated over 6GHz PSC channels, filter in beacons and probe responses.
706  * enum iwl_umac_scan_general_params_flags2 - UMAC scan general flags2
723  * @flags:		bitmap - 0-19:	directed scan to i'th ssid.
724  * @channel_num:	channel number 1-13 etc.
763  * @iter_count: num of scan iterations for schedule plan, 0xff for infinite loop
783  * struct iwl_scan_req_umac_tail - the rest of the UMAC scan request command
784  *      parameters following channels configuration array.
804  * @count: num of channels in scan request
817  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
820  * @extended_dwell: dwell time for channels 1, 6 and 11
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
972  * @count: num of channels in scan request
995  * @count: num of channels in scan request
1020  *                        for 5GHz channels
1090 } __packed; /* SCAN_REQUEST_PARAMS_API_S_VER_17 - 14 */
1095  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1107  * @ooc_priority: out of channel priority - &enum iwl_scan_priority
1114 } __packed; /* SCAN_REQUEST_CMD_UMAC_API_S_VER_17 - 14 */
1150  * struct iwl_scan_offload_profile_match_v1 - match information
1156  * @matching_channels: bitmap of channels that matched, referencing
1157  *	the channels passed in the scan offload request.
1169  * struct iwl_scan_offload_profiles_query_v1 - match results query response
1194  * struct iwl_scan_offload_profile_match - match information
1200  * @matching_channels: bitmap of channels that matched, referencing
1201  *	the channels passed in the scan offload request.
1213  * struct iwl_scan_offload_match_info - match results information
1240  * struct iwl_umac_scan_iter_complete_notif - notifies end of scanning iteration
1242  * @scanned_channels: number of channels scanned and number of valid elements in