drm/tegra: tegra_drm.h: fix all uapi kernel-doc warnings
PATCH v3 1/1 drm/tegra: tegra_drm.h: fix all uapi kernel-doc warnings
Add 2 struct member descriptions and convert #define macro constants comments to kernel-doc comments to eliminate all kernel-doc warnings:
Warning: include/uapi/drm/tegra_drm.h:353 struct member 'cmdbuf' not
described in 'drm_tegra_reloc'
Warning: include/uapi/drm/tegra_drm.h:353 struct member 'target' not
described in 'drm_tegra_reloc'
Warning: include/uapi/drm/tegra_drm.h:780 This comment starts with '/**',
but isn't a kernel-doc comment.
* Specify that bit 39 of the patched-in address should be set to switch
Warning: include/uapi/drm/tegra_drm.h:832 This comment starts with '/**',
but isn't a kernel-doc comment.
* Execute words words of Host1x opcodes specified in the gather_data_ptr
Warning: include/uapi/drm/tegra_drm.h:837 This comment starts with '/**',
but isn't a kernel-doc comment.
* Wait for a syncpoint to reach a value before continuing with further
Warning: include/uapi/drm/tegra_drm.h:842 This comment starts with '/**',
but isn't a kernel-doc comment.
* Wait for a syncpoint to reach a value before continuing with further
---
v2: add kernel-doc comments for #define constants (thanks, Mikko)
v3: rebase & resend
include/uapi/drm/tegra_drm.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
include/uapi/drm/tegra_drm.h +16 -0
@@ -304,6 +304,7 @@ struct drm_tegra_cmdbuf {* struct drm_tegra_reloc - GEM object relocation structure */ struct drm_tegra_reloc { +/** @cmdbuf: cmd information */ struct {/** * @cmdbuf.handle:
@@ -321,6 +322,7 @@ struct drm_tegra_reloc {*/ __u32 offset; } cmdbuf; +/** @target: relocate target information */ struct {/** * @target.handle:
@@ -778,6 +780,9 @@ struct drm_tegra_channel_unmap {/* Submission */ /** +* define DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT - \ +* Select sector layout swizzling for in-memory buffers. +* * Specify that bit 39 of the patched-in address should be set to switch * swizzling between Tegra and non-Tegra sector layout on systems that store * surfaces in system memory in non-Tegra sector layout.
@@ -830,16 +835,27 @@ struct drm_tegra_submit_buf { };/** +* define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR - \ +* Execute Host1x opcodes from user pointer. +* * Execute `words` words of Host1x opcodes specified in the `gather_data_ptr` * buffer. Each GATHER_UPTR command uses successive words from the buffer. */ #define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR 0 +/** +* define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT - \ +* Wait for syncpoint (absolute). +* * Wait for a syncpoint to reach a value before continuing with further * commands. */ #define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT 1 +/** +* define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT_RELATIVE - \ +* Wait for syncpoint (relative). +* * Wait for a syncpoint to reach a value before continuing with further * commands. The threshold is calculated relative to the start of the job. */
Quoted 37 lines · Randy Dunlap
Add 2 struct member descriptions and convert #define macro constants comments to kernel-doc comments to eliminate all kernel-doc warnings:
Warning:
include/uapi/drm/tegra_drm.h:353struct member 'cmdbuf' not
described in 'drm_tegra_reloc'
Warning:include/uapi/drm/tegra_drm.h:353struct member 'target' not
described in 'drm_tegra_reloc'Warning:
include/uapi/drm/tegra_drm.h:780This comment starts with '/**',
but isn't a kernel-doc comment.
* Specify that bit 39 of the patched-in address should be set to switch
Warning:include/uapi/drm/tegra_drm.h:832This comment starts with '/**',
but isn't a kernel-doc comment.
* Executewordswords of Host1x opcodes specified in thegather_data_ptr
Warning:include/uapi/drm/tegra_drm.h:837This comment starts with '/**',
but isn't a kernel-doc comment.
* Wait for a syncpoint to reach a value before continuing with further
Warning:include/uapi/drm/tegra_drm.h:842This comment starts with '/**',
but isn't a kernel-doc comment.
* Wait for a syncpoint to reach a value before continuing with furtherSigned-off-by Randy Dunlap <[email protected]>Acked-by Mikko Perttunen <[email protected]>---
v2: add kernel-doc comments for #define constants (thanks, Mikko)
v3: rebase & resendCc Thierry Reding <[email protected]>Cc Mikko Perttunen <[email protected]>Cc Maarten Lankhorst <[email protected]>Cc Maxime Ripard <[email protected]>Cc Thomas Zimmermann <[email protected]>Cc David Airlie <[email protected]>Cc Simona Vetter <[email protected]>
Quoted 2 lines
include/uapi/drm/tegra_drm.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
Applied, thanks.
Thierry