diff options
| author | Maulik Shah <maulik.shah@oss.qualcomm.com> | 2026-08-02 18:58:54 +0530 |
|---|---|---|
| committer | Bjorn Andersson <andersson@kernel.org> | 2026-10-05 09:10:43 +0200 |
| commit | 5e1fccb482a9b92e465fe1fd689f4e8cefd15a08 (patch) | |
| tree | 68842bef31b4e8042da9c0572c2a088e91ca1c67 /include | |
| parent | b2370c0f8960dbe9bc0b5169944c58239964a738 (diff) | |
soc: qcom: rpmh: fix kernel-doc issues in rpmh.c
Six documentation issues in rpmh.c:
- struct batch_cache_req has a typo in its title: 'batch catch'
should be 'batch cache'. Fix it.
- __rpmh_write(), rpmh_write_async(), rpmh_write(), rpmh_write_batch()
and rpmh_invalidate() use 'name: title' format instead of the
'name() - title' format documented in
Documentation/doc-guide/kernel-doc.rst. Fix all of them.
- rpmh_tx_done() has no kernel-doc comment. Add one describing its
purpose as the RSC driver callback for active-only transfer
completion.
- __rpmh_write(), rpmh_write_async(), rpmh_write() and
rpmh_write_batch() are missing Return: tags. Add them.
- struct cache_req uses 'struct name:' format instead of the
'struct name -' format documented in
Documentation/doc-guide/kernel-doc.rst. Fix it.
- rpmh_write_batch() has an inaccurate description: it says requests
are sent 'without caching' and that SLEEP/WAKE_ONLY requests are
sent as fire-and-forget. In reality, SLEEP/WAKE_ONLY requests are
cached in batch_cache and returned immediately; they are only sent
to the controller later by rpmh_flush(). Fix the description.
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-2-0f5026293d9a@oss.qualcomm.com
Signed-off-by: Bjorn Andersson <andersson@kernel.org>
Diffstat (limited to 'include')
0 files changed, 0 insertions, 0 deletions
