Commit 0c912045 authored by Johannes Berg's avatar Johannes Berg Committed by Luca Coelho
Browse files

iwlwifi: fw: fix some scan kernel-doc 



Some devices also use iwl_scan_config_v2 struct, so link it in
the documentation for SCAN_CFG_CMD. Fix a bunch of kernel-doc
as well.

Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
Link: https://lore.kernel.org/r/iwlwifi.20211219132536.3331df94b106.If6c96b0d386e1c5988c8da6b69257e8f2e737f07@changeid


Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
parent 459fc0f2

drivers/net/wireless/intel/iwlwifi/fw/api/commands.h

+2 −1
Original line number Diff line number Diff line
@@ -91,7 +91,8 @@ enum iwl_legacy_cmds { 


	/**

	 * @SCAN_CFG_CMD:

	 * uses &struct iwl_scan_config_v1 or &struct iwl_scan_config

	 * uses &struct iwl_scan_config_v1, &struct iwl_scan_config_v2

	 * or &struct iwl_scan_config

	 */

	SCAN_CFG_CMD = 0xc,

drivers/net/wireless/intel/iwlwifi/fw/api/scan.h

+24 −6
Original line number Diff line number Diff line
@@ -211,7 +211,7 @@ struct iwl_scan_channel_cfg_lmac { 
	__le32 iter_interval;

} __packed;



/*

/**

 * struct iwl_scan_probe_segment - PROBE_SEGMENT_API_S_VER_1

 * @offset: offset in the data block

 * @len: length of the segment
@@ -221,7 +221,8 @@ struct iwl_scan_probe_segment { 
	__le16 len;

} __packed;



/* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_2

/**

 * struct iwl_scan_probe_req_v1 - PROBE_REQUEST_FRAME_API_S_VER_2

 * @mac_header: first (and common) part of the probe

 * @band_data: band specific data

 * @common_data: last (and common) part of the probe
@@ -234,7 +235,8 @@ struct iwl_scan_probe_req_v1 { 
	u8 buf[SCAN_OFFLOAD_PROBE_REQ_SIZE];

} __packed;



/* iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_v2

/**

 * struct iwl_scan_probe_req - PROBE_REQUEST_FRAME_API_S_VER_v2

 * @mac_header: first (and common) part of the probe

 * @band_data: band specific data

 * @common_data: last (and common) part of the probe
@@ -257,7 +259,8 @@ enum iwl_scan_channel_flags { 
	IWL_SCAN_CHANNEL_FLAG_6G_PSC_NO_FILTER  = BIT(6),

};



/* struct iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S

/**

 * struct iwl_scan_channel_opt - CHANNEL_OPTIMIZATION_API_S

 * @flags: enum iwl_scan_channel_flags

 * @non_ebs_ratio: defines the ratio of number of scan iterations where EBS is

 *	involved.
@@ -502,7 +505,7 @@ struct iwl_scan_dwell { 
} __packed;



/**

 * struct iwl_scan_config_v1

 * struct iwl_scan_config_v1 - scan configuration command

 * @flags:			enum scan_config_flags

 * @tx_chains:			valid_tx antenna - ANT_* definitions

 * @rx_chains:			valid_rx antenna - ANT_* definitions
@@ -534,6 +537,21 @@ struct iwl_scan_config_v1 { 
#define SCAN_LB_LMAC_IDX 0

#define SCAN_HB_LMAC_IDX 1



/**

 * struct iwl_scan_config_v2 - scan configuration command

 * @flags:			enum scan_config_flags

 * @tx_chains:			valid_tx antenna - ANT_* definitions

 * @rx_chains:			valid_rx antenna - ANT_* definitions

 * @legacy_rates:		default legacy rates - enum scan_config_rates

 * @out_of_channel_time:	default max out of serving channel time

 * @suspend_time:		default max suspend time

 * @dwell:			dwells for the scan

 * @mac_addr:			default mac address to be used in probes

 * @bcast_sta_id:		the index of the station in the fw

 * @channel_flags:		default channel flags - enum iwl_channel_flags

 *				scan_config_channel_flag

 * @channel_array:		default supported channels

 */

struct iwl_scan_config_v2 {

	__le32 flags;

	__le32 tx_chains;
@@ -549,7 +567,7 @@ struct iwl_scan_config_v2 { 
} __packed; /* SCAN_CONFIG_DB_CMD_API_S_2 */



/**

 * struct iwl_scan_config

 * struct iwl_scan_config - scan configuration command

 * @enable_cam_mode: whether to enable CAM mode.

 * @enable_promiscouos_mode: whether to enable promiscouos mode

 * @bcast_sta_id: the index of the station in the fw. Deprecated starting with