History

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

Randy Dunlap committed 6 months ago

Commit b397cc41 parent 011c4b61 file · +16 −0Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/drm/tegra_drm.h+16−0
@@ -304,6 +304,7 @@ struct drm_tegra_cmdbuf { · 303 unmodified lines
304 * struct drm_tegra_reloc - GEM object relocation structure304 * struct drm_tegra_reloc - GEM object relocation structure
305 */305 */
306struct drm_tegra_reloc {306struct drm_tegra_reloc {
307 /** @cmdbuf: cmd information */
307 struct {308 struct {
308 /**309 /**
309 * @cmdbuf.handle:310 * @cmdbuf.handle:
@@ -321,6 +322,7 @@ struct drm_tegra_reloc { · 11 unmodified lines
321 */322 */
322 __u32 offset;323 __u32 offset;
323 } cmdbuf;324 } cmdbuf;
325 /** @target: relocate target information */
324 struct {326 struct {
325 /**327 /**
326 * @target.handle:328 * @target.handle:
@@ -778,6 +780,9 @@ struct drm_tegra_channel_unmap { · 451 unmodified lines
778/* Submission */780/* Submission */
779 781
780/**782/**
783 * define DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT - \
784 * Select sector layout swizzling for in-memory buffers.
785 *
781 * Specify that bit 39 of the patched-in address should be set to switch786 * Specify that bit 39 of the patched-in address should be set to switch
782 * swizzling between Tegra and non-Tegra sector layout on systems that store787 * swizzling between Tegra and non-Tegra sector layout on systems that store
783 * surfaces in system memory in non-Tegra sector layout.788 * surfaces in system memory in non-Tegra sector layout.
@@ -830,16 +835,27 @@ struct drm_tegra_submit_buf { · 46 unmodified lines
830};835};
831 836
832/**837/**
838 * define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR - \
839 * Execute Host1x opcodes from user pointer.
840 *
833 * Execute `words` words of Host1x opcodes specified in the `gather_data_ptr`841 * Execute `words` words of Host1x opcodes specified in the `gather_data_ptr`
834 * buffer. Each GATHER_UPTR command uses successive words from the buffer.842 * buffer. Each GATHER_UPTR command uses successive words from the buffer.
835 */843 */
836#define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR 0844#define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR 0
845
837/**846/**
847 * define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT - \
848 * Wait for syncpoint (absolute).
849 *
838 * Wait for a syncpoint to reach a value before continuing with further850 * Wait for a syncpoint to reach a value before continuing with further
839 * commands.851 * commands.
840 */852 */
841#define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT 1853#define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT 1
854
842/**855/**
856 * define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT_RELATIVE - \
857 * Wait for syncpoint (relative).
858 *
843 * Wait for a syncpoint to reach a value before continuing with further859 * Wait for a syncpoint to reach a value before continuing with further
844 * commands. The threshold is calculated relative to the start of the job.860 * commands. The threshold is calculated relative to the start of the job.
845 */861 */

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t