wifi: ath12k: Fix hal_reo_cmd_status kernel-doc
authorJeff Johnson <jeff.johnson@oss.qualcomm.com>
Thu, 5 Jun 2025 17:27:22 +0000 (10:27 -0700)
committerJeff Johnson <jeff.johnson@oss.qualcomm.com>
Sat, 7 Jun 2025 14:41:50 +0000 (07:41 -0700)
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.

Link: https://patch.msgid.link/20250605-hal_reo_cmd_status-kdoc-v1-1-e59f4b814b88@oss.qualcomm.com
Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com>
drivers/net/wireless/ath/ath12k/hal.h

index 0ee9c6b26dab4ef597c95fea6fdb58d9cf1a0941..c1750b5dc03cbc9e7038df2fc81d0b576165e89b 100644 (file)
@@ -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 {