diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2025-11-27 21:57:31 -0800 |
|---|---|---|
| committer | Nishanth Menon <nm@ti.com> | 2025-12-15 07:16:51 -0600 |
| commit | fdce161afe29b40e84853ec821cbd7bbd727bf58 (patch) | |
| tree | a46d39a47227ef1517f18491a68ffb2377cff6ab /tools/perf/lib/Documentation/tutorial/git@git.tavy.me:linux.git | |
| parent | 8f0b4cce4481fb22653697cced8d0d04027cb1e8 (diff) | |
firmware: ti_sci.h: fix all kernel-doc warnings
Modify kernel-doc comments in ti_sci.h to eliminate all kernel-doc
warnings:
* use correct/matching struct names in kdoc comments
* use correct struct member names in kdoc comments
* add a ':' after struct member names where needed
* change a blank kdoc line to " *"
* convert 3 structs to kernel-doc comments:
struct ti_sci_msg_rm_udmap_tx_ch_cfg_req
struct ti_sci_msg_rm_udmap_rx_ch_cfg_req
struct ti_sci_msg_rm_udmap_flow_cfg_req
Fixes 13 kernel-doc warnings:
Warning: drivers/firmware/ti_sci.h:609 expecting prototype for struct
tisci_msg_req_prepare_sleep. Prototype was for struct
ti_sci_msg_req_prepare_sleep instead
Warning: drivers/firmware/ti_sci.h:609 struct member 'hdr' not described
in 'ti_sci_msg_req_prepare_sleep'
Warning: drivers/firmware/ti_sci.h:609 struct member 'mode' not described
in 'ti_sci_msg_req_prepare_sleep'
Warning: drivers/firmware/ti_sci.h:609 struct member 'ctx_lo' not described
in 'ti_sci_msg_req_prepare_sleep'
Warning: drivers/firmware/ti_sci.h:609 struct member 'ctx_hi' not described
in 'ti_sci_msg_req_prepare_sleep'
Warning: drivers/firmware/ti_sci.h:609 struct member 'debug_flags' not
described in 'ti_sci_msg_req_prepare_sleep'
Warning: drivers/firmware/ti_sci.h:623 expecting prototype for struct
tisci_msg_set_io_isolation_req. Prototype was for struct
ti_sci_msg_req_set_io_isolation instead
Warning: drivers/firmware/ti_sci.h:696 struct member 'latency' not
described in 'ti_sci_msg_req_lpm_set_latency_constraint'
Warning: drivers/firmware/ti_sci.h:857 bad line:
Warning: drivers/firmware/ti_sci.h:1002 This comment starts with '/**', but
isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
* Configures a Navigator Subsystem UDMAP transmit channel
Warning: drivers/firmware/ti_sci.h:1130 This comment starts with '/**', but
isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
* Configures a Navigator Subsystem UDMAP receive channel
Warning: drivers/firmware/ti_sci.h:1249 This comment starts with '/**', but
isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
* Configures a Navigator Subsystem UDMAP receive flow
Warning: drivers/firmware/ti_sci.h:1421 struct member 'valid_params'
not described in 'ti_sci_msg_rm_udmap_flow_cfg_req'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20251128055731.812460-1-rdunlap@infradead.org
Signed-off-by: Nishanth Menon <nm@ti.com>
Diffstat (limited to 'tools/perf/lib/Documentation/tutorial/git@git.tavy.me:linux.git')
0 files changed, 0 insertions, 0 deletions
