diff mbox series

[ath-next] wifi: ath12k: Fix hal_reo_cmd_status kernel-doc

Message ID 20250605-hal_reo_cmd_status-kdoc-v1-1-e59f4b814b88@oss.qualcomm.com
State New
Headers show
Series [ath-next] wifi: ath12k: Fix hal_reo_cmd_status kernel-doc | expand

Commit Message

Jeff Johnson June 5, 2025, 5:27 p.m. UTC 
Currently a warning is reported when running:

% scripts/kernel-doc -Wall -Werror -none drivers/net/wireless/ath/ath12k/hal.h
Warning: drivers/net/wireless/ath/ath12k/hal.h:596 Enum value 'HAL_REO_CMD_RESOURCE_BLOCKED' not described in enum 'hal_reo_cmd_status'

Add the missing description of HAL_REO_CMD_RESOURCE_BLOCKED.

Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
---
Note that although HAL_REO_CMD_DRAIN also does not have a description,
kernel-doc isn't complaining. Furthermore, my analysis indicates that
HAL_REO_CMD_DRAIN may actually not be required, so after that analysis
completes I'll either remove HAL_REO_CMD_DRAIN or document it.
---
 drivers/net/wireless/ath/ath12k/hal.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


---
base-commit: c3910de7bab78afbc106206aed5ec8e79458fbee
change-id: 20250604-hal_reo_cmd_status-kdoc-c3f3a25237c5
diff mbox series

Patch

diff --git a/drivers/net/wireless/ath/ath12k/hal.h b/drivers/net/wireless/ath/ath12k/hal.h
index 0ee9c6b26dab..c1750b5dc03c 100644
--- a/drivers/net/wireless/ath/ath12k/hal.h
+++ b/drivers/net/wireless/ath/ath12k/hal.h
@@ -585,7 +585,8 @@  enum hal_reo_cmd_type {
  *			 or cache was blocked
  * @HAL_REO_CMD_FAILED: Command execution failed, could be due to
  *			invalid queue desc
- * @HAL_REO_CMD_RESOURCE_BLOCKED:
+ * @HAL_REO_CMD_RESOURCE_BLOCKED: Command could not be executed because
+ *				  one or more descriptors were blocked
  * @HAL_REO_CMD_DRAIN:
  */
 enum hal_reo_cmd_status {