| Message ID | 20240118-ath10k-kerneldoc-v1-5-99c7e8d95aad@quicinc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | f020c30299323c206b9041dd478ac040dd828ec0 |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | wifi: ath10k: fix ath10k kerneldoc issues | expand |
On 1/18/24 08:12, Jeff Johnson wrote: > The kernel-doc script currently reports: > drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_REGISTERS' not described in enum 'ath10k_fw_crash_dump_type' > drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_CE_DATA' not described in enum 'ath10k_fw_crash_dump_type' > drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_RAM_DATA' not described in enum 'ath10k_fw_crash_dump_type' > drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_MAX' not described in enum 'ath10k_fw_crash_dump_type' > drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Excess enum value 'ATH10K_FW_CRASH_DUMP_REGDUMP' description in 'ath10k_fw_crash_dump_type' > > Fix these issues with the enum ath10k_fw_crash_dump_type kernel-doc. > > No functional changes, compile tested only. > > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/net/wireless/ath/ath10k/coredump.h | 8 ++++++-- > 1 file changed, 6 insertions(+), 2 deletions(-) > > diff --git a/drivers/net/wireless/ath/ath10k/coredump.h b/drivers/net/wireless/ath/ath10k/coredump.h > index e5ef0352e319..8d274e0f374b 100644 > --- a/drivers/net/wireless/ath/ath10k/coredump.h > +++ b/drivers/net/wireless/ath/ath10k/coredump.h > @@ -1,7 +1,7 @@ > /* SPDX-License-Identifier: ISC */ > /* > * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. > - * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. > + * Copyright (c) 2022, 2024 Qualcomm Innovation Center, Inc. All rights reserved. > */ > > #ifndef _COREDUMP_H_ > @@ -13,7 +13,11 @@ > > /** > * enum ath10k_fw_crash_dump_type - types of data in the dump file > - * @ATH10K_FW_CRASH_DUMP_REGDUMP: Register crash dump in binary format > + * @ATH10K_FW_CRASH_DUMP_REGISTERS: Register crash dump in binary format > + * @ATH10K_FW_CRASH_DUMP_CE_DATA: Copy Engine crash dump data > + * @ATH10K_FW_CRASH_DUMP_RAM_DATA: RAM crash dump data, contains multiple > + * struct ath10k_dump_ram_data_hdr > + * @ATH10K_FW_CRASH_DUMP_MAX: Maximum enumeration > */ > enum ath10k_fw_crash_dump_type { > ATH10K_FW_CRASH_DUMP_REGISTERS = 0, >
diff --git a/drivers/net/wireless/ath/ath10k/coredump.h b/drivers/net/wireless/ath/ath10k/coredump.h index e5ef0352e319..8d274e0f374b 100644 --- a/drivers/net/wireless/ath/ath10k/coredump.h +++ b/drivers/net/wireless/ath/ath10k/coredump.h @@ -1,7 +1,7 @@ /* SPDX-License-Identifier: ISC */ /* * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. - * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. + * Copyright (c) 2022, 2024 Qualcomm Innovation Center, Inc. All rights reserved. */ #ifndef _COREDUMP_H_ @@ -13,7 +13,11 @@ /** * enum ath10k_fw_crash_dump_type - types of data in the dump file - * @ATH10K_FW_CRASH_DUMP_REGDUMP: Register crash dump in binary format + * @ATH10K_FW_CRASH_DUMP_REGISTERS: Register crash dump in binary format + * @ATH10K_FW_CRASH_DUMP_CE_DATA: Copy Engine crash dump data + * @ATH10K_FW_CRASH_DUMP_RAM_DATA: RAM crash dump data, contains multiple + * struct ath10k_dump_ram_data_hdr + * @ATH10K_FW_CRASH_DUMP_MAX: Maximum enumeration */ enum ath10k_fw_crash_dump_type { ATH10K_FW_CRASH_DUMP_REGISTERS = 0,
The kernel-doc script currently reports: drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_REGISTERS' not described in enum 'ath10k_fw_crash_dump_type' drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_CE_DATA' not described in enum 'ath10k_fw_crash_dump_type' drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_RAM_DATA' not described in enum 'ath10k_fw_crash_dump_type' drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Enum value 'ATH10K_FW_CRASH_DUMP_MAX' not described in enum 'ath10k_fw_crash_dump_type' drivers/net/wireless/ath/ath10k/coredump.h:27: warning: Excess enum value 'ATH10K_FW_CRASH_DUMP_REGDUMP' description in 'ath10k_fw_crash_dump_type' Fix these issues with the enum ath10k_fw_crash_dump_type kernel-doc. No functional changes, compile tested only. Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> --- drivers/net/wireless/ath/ath10k/coredump.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-)