[PATCHv2 1/3] firmware: stratix10-svc: fix make htmldocs warning

[PATCHv2 1/3] firmware: stratix10-svc: fix make htmldocs warning

[Dinh Nguyen]

Fix this warning that was generated from "make htmldocs":

WARNING: drivers/firmware/stratix10-svc.c:58 struct member 'intel_svc_fcs'
not described in 'stratix10_svc'

Fixes: e6281c26674e ("firmware: stratix10-svc: Add support for FCS")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251106145941.37920e97@canb.auug.org.au/
Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
---
v2: add Reported by: and Closes:
---
 drivers/firmware/stratix10-svc.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index b91f68d9ae98..ebf3a591efc6 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -105,6 +105,7 @@ struct stratix10_svc_chan;
 /**
  * struct stratix10_svc - svc private data
  * @stratix10_svc_rsu: pointer to stratix10 RSU device
+ * @intel_svc_fcs: pointer to the FCS device
  */
 struct stratix10_svc {
 	struct platform_device *stratix10_svc_rsu;
-- 
2.42.0.411.g813d9a9188

[PATCH 2/3] firmware: stratix-svc: fix make htmldocs warning

[Dinh Nguyen]

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

WARNING: drivers/firmware/stratix10-svc.c:58 This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Total number of transaction IDs, which is a combination of

WARNING: drivers/firmware/stratix10-svc.c:302 This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * svc_mem_lock protects access to the svc_data_mem list for

Fixes: bcb9f4f07061 ("firmware: stratix10-svc: Add support for async communication")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251114153347.16001109@canb.auug.org.au/
Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
---
 drivers/firmware/stratix10-svc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index ebf3a591efc6..515b948ff320 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -55,7 +55,7 @@
 #define MAX_SDM_JOB_IDS				16
 /* Number of bits used for asynchronous transaction hashing. */
 #define ASYNC_TRX_HASH_BITS			3
-/**
+/*
  * Total number of transaction IDs, which is a combination of
  * client ID and job ID.
  */
@@ -300,7 +300,7 @@ struct stratix10_svc_chan {
 static LIST_HEAD(svc_ctrl);
 static LIST_HEAD(svc_data_mem);
 
-/**
+/*
  * svc_mem_lock protects access to the svc_data_mem list for
  * concurrent multi-client operations
  */
-- 
2.42.0.411.g813d9a9188

[PATCH 3/3] firmware: stratix10-svc: fix make htmldocs warning

[Dinh Nguyen]

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>
---
 include/linux/firmware/intel/stratix10-svc-client.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
index 1bcc56d14080..d290060f4c73 100644
--- a/include/linux/firmware/intel/stratix10-svc-client.h
+++ b/include/linux/firmware/intel/stratix10-svc-client.h
@@ -19,7 +19,7 @@
 #define SVC_CLIENT_FCS			"fcs"
 #define SVC_CLIENT_HWMON		"hwmon"
 
-/**
+/*
  * Status of the sent command, in bit number
  *
  * SVC_STATUS_OK:
@@ -148,6 +148,12 @@ struct stratix10_svc_chan;
  *
  * @COMMAND_FCS_RANDOM_NUMBER_GEN: generate a random number, return status
  * is SVC_STATUS_OK, SVC_STATUS_ERROR
+ *
+ * @COMMAND_HWMON_READTEMP: query the temperature from the hardware monitor,
+ * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
+ *
+ * @COMMAND_HWMON_READVOLT: query the voltage from the hardware monitor,
+ * return status is SVC_STATUS_OK or SVC_STATUS_ERROR
  */
 enum stratix10_svc_command_code {
 	/* for FPGA */
@@ -303,7 +309,7 @@ void stratix10_svc_done(struct stratix10_svc_chan *chan);
  * The callback function takes a single argument, which is a pointer to
  * user-defined data.
  *
- * @param cb_arg A pointer to user-defined data passed to the callback function.
+ * @cb_arg: Argument to be passed to the callback function.
  */
 typedef void (*async_callback_t)(void *cb_arg);
 
-- 
2.42.0.411.g813d9a9188

Re: [PATCH 3/3] firmware: stratix10-svc: fix make htmldocs warning

[Greg KH]

On Fri, Nov 14, 2025 at 12:58:15PM -0600, Dinh Nguyen wrote:
> 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>
> ---
>  include/linux/firmware/intel/stratix10-svc-client.h | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)

This is the same subject line as patch 1/3.  Please don't do that.  I'll
try to fix this up...

thanks,

greg k-h