github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

soc: qcom: rpmh-internal: fix kernel-doc issues in rpmh-internal.h

Browse Source 
kernel-doc emits two warnings for rpmh-internal.h:

  Warning: drivers/soc/qcom/rpmh-internal.h:136 struct member 'ver' not described in 'rsc_drv'
  Warning: drivers/soc/qcom/rpmh-internal.h:136 struct member 'regs' not described in 'rsc_drv'

Fix them by adding @ver and @regs entries to the struct rsc_drv
documentation.

While at it, add a missing kernel-doc block for struct rsc_ver, and
update the remaining struct kernel-doc comments (struct tcs_group,
struct rpmh_request, struct rpmh_ctrlr, struct rsc_drv) to use the
'struct name -' format documented in
Documentation/doc-guide/kernel-doc.rst.

No functional impact.

Assisted-by: Claude:claude-sonnet-5
Signed-off-by: Maulik Shah <maulik.shah@oss.qualcomm.com>
Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
Link: https://lore.kernel.org/r/20260802-b4b4-rpmh-kdoc-v1-1-0f5026293d9a@oss.qualcomm.com
Signed-off-by: Bjorn Andersson <andersson@kernel.org>
This commit is contained in:
Maulik Shah 2026-08-02 18:58:53 +05:30 committed by Bjorn Andersson
parent c7c56b6ec0
commit b2370c0f89
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
drivers/soc/qcom/rpmh-internal.h
View File

@ -20,7 +20,7 @@
struct rsc_drv;
/**
* struct tcs_group: group of Trigger Command Sets (TCS) to send state requests
* struct tcs_group - group of Trigger Command Sets (TCS) to send state requests
* to the controller
*
* @drv: The controller.
@ -53,7 +53,7 @@ struct tcs_group {
};
/**
* struct rpmh_request: the message to be sent to rpmh-rsc
* struct rpmh_request - the message to be sent to rpmh-rsc
*
* @msg: the request
* @cmd: the payload that will be part of the @msg
@ -70,7 +70,7 @@ struct rpmh_request {
};
/**
* struct rpmh_ctrlr: our representation of the controller
* struct rpmh_ctrlr - our representation of the controller
*
* @cache: the list of cached requests
* @cache_lock: synchronize access to the cache data
@ -84,13 +84,19 @@ struct rpmh_ctrlr {
struct list_head batch_cache;
};
/**
* struct rsc_ver - Hardware version of the RSC controller.
*
* @major: Major version number.
* @minor: Minor version number.
*/
struct rsc_ver {
u32 major;
u32 minor;
};
/**
* struct rsc_drv: the Direct Resource Voter (DRV) of the
* struct rsc_drv - the Direct Resource Voter (DRV) of the
* Resource State Coordinator controller (RSC)
*
* @name: Controller identifier.
@ -116,6 +122,8 @@ struct rsc_ver {
* slot
* @client: Handle to the DRV's client.
* @dev: RSC device.
* @ver: HW version of the RSC controller.
* @regs: Pointer to the register offset table for this version.
*/
struct rsc_drv {
const char *name;