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
304304 * struct drm_tegra_reloc - GEM object relocation structure
305305 */
306306 struct drm_tegra_reloc {
307+ /** @cmdbuf: cmd information */
307308 struct {
308309 /**
309310 * @cmdbuf.handle:
@@ -321,6 +322,7 @@ struct drm_tegra_reloc { · 11 unmodified lines
321322 */
322323 __u32 offset;
323324 } cmdbuf;
325+ /** @target: relocate target information */
324326 struct {
325327 /**
326328 * @target.handle:
@@ -778,6 +780,9 @@ struct drm_tegra_channel_unmap { · 451 unmodified lines
778780 /* Submission */
779781
780782 /**
783+ * define DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT - \
784+ * Select sector layout swizzling for in-memory buffers.
785+ *
781786 * Specify that bit 39 of the patched-in address should be set to switch
782787 * swizzling between Tegra and non-Tegra sector layout on systems that store
783788 * surfaces in system memory in non-Tegra sector layout.
@@ -830,16 +835,27 @@ struct drm_tegra_submit_buf { · 46 unmodified lines
830835 };
831836
832837 /**
838+ * define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR - \
839+ * Execute Host1x opcodes from user pointer.
840+ *
833841 * Execute `words` words of Host1x opcodes specified in the `gather_data_ptr`
834842 * buffer. Each GATHER_UPTR command uses successive words from the buffer.
835843 */
836844 #define DRM_TEGRA_SUBMIT_CMD_GATHER_UPTR 0
845+
837846 /**
847+ * define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT - \
848+ * Wait for syncpoint (absolute).
849+ *
838850 * Wait for a syncpoint to reach a value before continuing with further
839851 * commands.
840852 */
841853 #define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT 1
854+
842855 /**
856+ * define DRM_TEGRA_SUBMIT_CMD_WAIT_SYNCPT_RELATIVE - \
857+ * Wait for syncpoint (relative).
858+ *
843859 * Wait for a syncpoint to reach a value before continuing with further
844860 * commands. The threshold is calculated relative to the start of the job.
845861 */

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