Commit 3f505a30 authored by Jeff Johnson's avatar Jeff Johnson Committed by Kalle Valo
Browse files

wifi: ath11k: Fix kernel-doc issues 



Fix documentation issues reported by kernel-doc:
- Incorrect use of /** for non-kernel-doc comments
- Mismatch between documented and actual identifiers
- Incorrect identifier syntax

Signed-off-by: default avatarJeff Johnson <quic_jjohnson@quicinc.com>
Signed-off-by: default avatarKalle Valo <quic_kvalo@quicinc.com>
Link: https://lore.kernel.org/r/20220909151246.22961-1-quic_jjohnson@quicinc.com
parent 3fecca0e

drivers/net/wireless/ath/ath11k/dp.h

+4 −8
Original line number Diff line number Diff line
@@ -997,8 +997,7 @@ struct htt_rx_ring_tlv_filter { 
#define HTT_RX_FULL_MON_MODE_CFG_CMD_CFG_NON_ZERO_MPDUS_END	BIT(2)

#define HTT_RX_FULL_MON_MODE_CFG_CMD_CFG_RELEASE_RING		GENMASK(10, 3)



/**

 * Enumeration for full monitor mode destination ring select

/* Enumeration for full monitor mode destination ring select

 * 0 - REO destination ring select

 * 1 - FW destination ring select

 * 2 - SW destination ring select
@@ -1395,8 +1394,7 @@ struct htt_ppdu_stats_info { 
	struct list_head list;

};



/**

 * @brief target -> host packet log message

/* @brief target -> host packet log message

 *

 * @details

 * The following field definitions describe the format of the packet log
@@ -1434,8 +1432,7 @@ struct htt_pktlog_msg { 
	u8 payload[];

};



/**

 * @brief host -> target FW extended statistics retrieve

/* @brief host -> target FW extended statistics retrieve

 *

 * @details

 * The following field definitions describe the format of the HTT host
@@ -1570,8 +1567,7 @@ struct htt_ext_stats_cfg_params { 
	u32 cfg3;

};



/**

 * @brief target -> host extended statistics upload

/* @brief target -> host extended statistics upload

 *

 * @details

 * The following field definitions describe the format of the HTT target

drivers/net/wireless/ath/ath11k/hal.h

+7 −8
Original line number Diff line number Diff line
@@ -451,13 +451,13 @@ enum hal_ring_type { 


/**

 * enum hal_reo_cmd_type: Enum for REO command type

 * @CMD_GET_QUEUE_STATS: Get REO queue status/stats

 * @CMD_FLUSH_QUEUE: Flush all frames in REO queue

 * @CMD_FLUSH_CACHE: Flush descriptor entries in the cache

 * @CMD_UNBLOCK_CACHE: Unblock a descriptor's address that was blocked

 * @HAL_REO_CMD_GET_QUEUE_STATS: Get REO queue status/stats

 * @HAL_REO_CMD_FLUSH_QUEUE: Flush all frames in REO queue

 * @HAL_REO_CMD_FLUSH_CACHE: Flush descriptor entries in the cache

 * @HAL_REO_CMD_UNBLOCK_CACHE: Unblock a descriptor's address that was blocked

 *      earlier with a 'REO_FLUSH_CACHE' command

 * @CMD_FLUSH_TIMEOUT_LIST: Flush buffers/descriptors from timeout list

 * @CMD_UPDATE_RX_REO_QUEUE: Update REO queue settings

 * @HAL_REO_CMD_FLUSH_TIMEOUT_LIST: Flush buffers/descriptors from timeout list

 * @HAL_REO_CMD_UPDATE_RX_QUEUE: Update REO queue settings

 */

enum hal_reo_cmd_type {

	HAL_REO_CMD_GET_QUEUE_STATS     = 0,
@@ -875,8 +875,7 @@ struct hal_reo_status { 
	} u;

};



/**

 * HAL context to be used to access SRNG APIs (currently used by data path

/* HAL context to be used to access SRNG APIs (currently used by data path

 * and transport (CE) modules)

 */

struct ath11k_hal {

drivers/net/wireless/ath/ath11k/wmi.h

+10 −10
Original line number Diff line number Diff line
@@ -4833,13 +4833,13 @@ enum wmi_rtscts_prot_mode { 
/**

 * enum wmi_rtscts_profile - Selection of RTS CTS profile along with enabling

 *                           protection mode.

 * @WMI_RTSCTS_FOR_NO_RATESERIES - Neither of rate-series should use RTS-CTS

 * @WMI_RTSCTS_FOR_SECOND_RATESERIES - Only second rate-series will use RTS-CTS

 * @WMI_RTSCTS_ACROSS_SW_RETRIES - Only the second rate-series will use RTS-CTS,

 * @WMI_RTSCTS_FOR_NO_RATESERIES: Neither of rate-series should use RTS-CTS

 * @WMI_RTSCTS_FOR_SECOND_RATESERIES: Only second rate-series will use RTS-CTS

 * @WMI_RTSCTS_ACROSS_SW_RETRIES: Only the second rate-series will use RTS-CTS,

 *                                but if there's a sw retry, both the rate

 *                                series will use RTS-CTS.

 * @WMI_RTSCTS_ERP - RTS/CTS used for ERP protection for every PPDU.

 * @WMI_RTSCTS_FOR_ALL_RATESERIES - Enable RTS-CTS for all rate series.

 * @WMI_RTSCTS_ERP: RTS/CTS used for ERP protection for every PPDU.

 * @WMI_RTSCTS_FOR_ALL_RATESERIES: Enable RTS-CTS for all rate series.

 */

enum wmi_rtscts_profile {

	WMI_RTSCTS_FOR_NO_RATESERIES = 0,