tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

firmware: stratix10-svc: fix make htmldocs warning

Stephen Rothwell reports htmldocs warnings when merging char-misc tree:

WARNING: include/linux/firmware/intel/stratix10-svc-client.h:22 This comment
starts with '/**', but isn't a kernel-doc comment.

WARNING: include/linux/firmware/intel/stratix10-svc-client.h:184 Enum value
'COMMAND_HWMON_READTEMP' not described in enum 'stratix10_svc_command_code'

WARNING: include/linux/firmware/intel/stratix10-svc-client.h:184 Enum value
'COMMAND_HWMON_READVOLT' not described in enum 'stratix10_svc_command_code'

WARNING: include/linux/firmware/intel/stratix10-svc-client.h:307 function
parameter 'cb_arg' not described in 'async_callback_t'

Fixes: 4f49088c1625 ("firmware: stratix10-svc: Add definition for voltage and temperature sensor")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251114153920.1c5df700@canb.auug.org.au/
Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
Link: https://patch.msgid.link/20251114185815.358423-3-dinguyen@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Dinh Nguyen and committed by
Greg Kroah-Hartman 935419b9 36b1cb4f

+8 -2
+8 -2
include/linux/firmware/intel/stratix10-svc-client.h
··· 19 19 #define SVC_CLIENT_FCS "fcs" 20 20 #define SVC_CLIENT_HWMON "hwmon" 21 21 22 - /** 22 + /* 23 23 * Status of the sent command, in bit number 24 24 * 25 25 * SVC_STATUS_OK: ··· 148 148 * 149 149 * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status 150 150 * is SVC_STATUS_OK, SVC_STATUS_ERROR 151 + * 152 + * @COMMAND_HWMON_READTEMP: query the temperature from the hardware monitor, 153 + * return status is SVC_STATUS_OK or SVC_STATUS_ERROR 154 + * 155 + * @COMMAND_HWMON_READVOLT: query the voltage from the hardware monitor, 156 + * return status is SVC_STATUS_OK or SVC_STATUS_ERROR 151 157 */ 152 158 enum stratix10_svc_command_code { 153 159 /* for FPGA */ ··· 309 303 * The callback function takes a single argument, which is a pointer to 310 304 * user-defined data. 311 305 * 312 - * @param cb_arg A pointer to user-defined data passed to the callback function. 306 + * @cb_arg: Argument to be passed to the callback function. 313 307 */ 314 308 typedef void (*async_callback_t)(void *cb_arg); 315 309