| Message ID | 20240118-ath10k-kerneldoc-v1-3-99c7e8d95aad@quicinc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 75dd17fdef110d99a2613d1284d2863cfc7cf6e9 |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | wifi: ath10k: fix ath10k kerneldoc issues | expand |
On 1/18/24 08:12, Jeff Johnson wrote: > Currently kernel-doc reports: > drivers/net/wireless/ath/ath10k/htt.h:1488: warning: cannot understand function prototype: 'struct htt_q_state_conf ' > drivers/net/wireless/ath/ath10k/htt.h:1542: warning: cannot understand function prototype: 'struct htt_q_state ' > > Update the kernel-doc for these two structs to resolve the warnings. > > No functional changes, compile tested only. > > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> > --- > drivers/net/wireless/ath/ath10k/htt.h | 10 +++++++--- > 1 file changed, 7 insertions(+), 3 deletions(-) > > diff --git a/drivers/net/wireless/ath/ath10k/htt.h b/drivers/net/wireless/ath/ath10k/htt.h > index 4a9270e2a4c8..eb0ce2f49315 100644 > --- a/drivers/net/wireless/ath/ath10k/htt.h > +++ b/drivers/net/wireless/ath/ath10k/htt.h > @@ -3,7 +3,7 @@ > * Copyright (c) 2005-2011 Atheros Communications Inc. > * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. > * Copyright (c) 2018, The Linux Foundation. All rights reserved. > - * Copyright (c) 2021, 2023 Qualcomm Innovation Center, Inc. All rights reserved. > + * Copyright (c) 2021, 2023-2024 Qualcomm Innovation Center, Inc. All rights reserved. > */ > > #ifndef _HTT_H_ > @@ -1474,15 +1474,19 @@ enum htt_q_depth_type { > #define HTT_TX_Q_STATE_ENTRY_MULTIPLIER 0 > > /** > - * htt_q_state_conf - part of htt_frag_desc_bank_cfg for host q state config > + * struct htt_q_state_conf - part of htt_frag_desc_bank_cfg for host q state config > * > * Defines host q state format and behavior. See htt_q_state. > * > + * @paddr: Queue physical address > + * @num_peers: Number of supported peers > + * @num_tids: Number of supported TIDs > * @record_size: Defines the size of each host q entry in bytes. In practice > * however firmware (at least 10.4.3-00191) ignores this host > * configuration value and uses hardcoded value of 1. > * @record_multiplier: This is valid only when q depth type is MSDUs. It > * defines the exponent for the power of 2 multiplication. > + * @pad: struct padding for 32-bit alignment > */ > struct htt_q_state_conf { > __le32 paddr; > @@ -1518,7 +1522,7 @@ struct htt_frag_desc_bank_cfg64 { > #define HTT_TX_Q_STATE_ENTRY_EXP_LSB 6 > > /** > - * htt_q_state - shared between host and firmware via DMA > + * struct htt_q_state - shared between host and firmware via DMA > * > * This structure is used for the host to expose it's software queue state to its fwiw. > * firmware so that its rate control can schedule fetch requests for optimized >
diff --git a/drivers/net/wireless/ath/ath10k/htt.h b/drivers/net/wireless/ath/ath10k/htt.h index 4a9270e2a4c8..eb0ce2f49315 100644 --- a/drivers/net/wireless/ath/ath10k/htt.h +++ b/drivers/net/wireless/ath/ath10k/htt.h @@ -3,7 +3,7 @@ * Copyright (c) 2005-2011 Atheros Communications Inc. * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. * Copyright (c) 2018, The Linux Foundation. All rights reserved. - * Copyright (c) 2021, 2023 Qualcomm Innovation Center, Inc. All rights reserved. + * Copyright (c) 2021, 2023-2024 Qualcomm Innovation Center, Inc. All rights reserved. */ #ifndef _HTT_H_ @@ -1474,15 +1474,19 @@ enum htt_q_depth_type { #define HTT_TX_Q_STATE_ENTRY_MULTIPLIER 0 /** - * htt_q_state_conf - part of htt_frag_desc_bank_cfg for host q state config + * struct htt_q_state_conf - part of htt_frag_desc_bank_cfg for host q state config * * Defines host q state format and behavior. See htt_q_state. * + * @paddr: Queue physical address + * @num_peers: Number of supported peers + * @num_tids: Number of supported TIDs * @record_size: Defines the size of each host q entry in bytes. In practice * however firmware (at least 10.4.3-00191) ignores this host * configuration value and uses hardcoded value of 1. * @record_multiplier: This is valid only when q depth type is MSDUs. It * defines the exponent for the power of 2 multiplication. + * @pad: struct padding for 32-bit alignment */ struct htt_q_state_conf { __le32 paddr; @@ -1518,7 +1522,7 @@ struct htt_frag_desc_bank_cfg64 { #define HTT_TX_Q_STATE_ENTRY_EXP_LSB 6 /** - * htt_q_state - shared between host and firmware via DMA + * struct htt_q_state - shared between host and firmware via DMA * * This structure is used for the host to expose it's software queue state to * firmware so that its rate control can schedule fetch requests for optimized
Currently kernel-doc reports: drivers/net/wireless/ath/ath10k/htt.h:1488: warning: cannot understand function prototype: 'struct htt_q_state_conf ' drivers/net/wireless/ath/ath10k/htt.h:1542: warning: cannot understand function prototype: 'struct htt_q_state ' Update the kernel-doc for these two structs to resolve the warnings. No functional changes, compile tested only. Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> --- drivers/net/wireless/ath/ath10k/htt.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-)