tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

accel/rocket: rocket_accel.h: fix kernel-doc warnings

Fix all kernel-doc warnings in rocket_accel.h:

Warning: include/uapi/drm/rocket_accel.h:35 Incorrect use of kernel-doc
format: * Output: DMA address for the BO in the NPU address space.
This address

and 22 warnings like these:

Warning: include/uapi/drm/rocket_accel.h:43 struct member 'size'
not described in 'drm_rocket_create_bo'
Warning: include/uapi/drm/rocket_accel.h:60 struct member 'handle'
not described in 'drm_rocket_prep_bo'
Warning: include/uapi/drm/rocket_accel.h:73 struct member 'handle'
not described in 'drm_rocket_fini_bo'
Warning: include/uapi/drm/rocket_accel.h:86 struct member 'regcmd'
not described in 'drm_rocket_task'
Warning: include/uapi/drm/rocket_accel.h:116 struct member 'tasks'
not described in 'drm_rocket_job'
Warning: include/uapi/drm/rocket_accel.h:135 struct member 'jobs'
not described in 'drm_rocket_submit'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Tomeu Vizoso <tomeu@tomeuvizoso.net>
Signed-off-by: Tomeu Vizoso <tomeu@tomeuvizoso.net>
Link: https://patch.msgid.link/20251023062440.4093661-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Tomeu Vizoso 38feb171 57d8ae15

+74 -24
+74 -24
include/uapi/drm/rocket_accel.h
··· 26 26 * 27 27 */ 28 28 struct drm_rocket_create_bo { 29 - /** Input: Size of the requested BO. */ 29 + /** 30 + * @size: Input: Size of the requested BO. 31 + */ 30 32 __u32 size; 31 33 32 - /** Output: GEM handle for the BO. */ 34 + /** 35 + * @handle: Output: GEM handle for the BO. 36 + */ 33 37 __u32 handle; 34 38 35 39 /** 36 - * Output: DMA address for the BO in the NPU address space. This address 37 - * is private to the DRM fd and is valid for the lifetime of the GEM 38 - * handle. 40 + * @dma_address: Output: DMA address for the BO in the NPU address 41 + * space. This address is private to the DRM fd and is valid for 42 + * the lifetime of the GEM handle. 39 43 */ 40 44 __u64 dma_address; 41 45 42 - /** Output: Offset into the drm node to use for subsequent mmap call. */ 46 + /** 47 + * @offset: Output: Offset into the drm node to use for subsequent 48 + * mmap call. 49 + */ 43 50 __u64 offset; 44 51 }; 45 52 ··· 57 50 * synchronization. 58 51 */ 59 52 struct drm_rocket_prep_bo { 60 - /** Input: GEM handle of the buffer object. */ 53 + /** 54 + * @handle: Input: GEM handle of the buffer object. 55 + */ 61 56 __u32 handle; 62 57 63 - /** Reserved, must be zero. */ 58 + /** 59 + * @reserved: Reserved, must be zero. 60 + */ 64 61 __u32 reserved; 65 62 66 - /** Input: Amount of time to wait for NPU jobs. */ 63 + /** 64 + * @timeout_ns: Input: Amount of time to wait for NPU jobs. 65 + */ 67 66 __s64 timeout_ns; 68 67 }; 69 68 ··· 79 66 * Synchronize caches for NPU access. 80 67 */ 81 68 struct drm_rocket_fini_bo { 82 - /** Input: GEM handle of the buffer object. */ 69 + /** 70 + * @handle: Input: GEM handle of the buffer object. 71 + */ 83 72 __u32 handle; 84 73 85 - /** Reserved, must be zero. */ 74 + /** 75 + * @reserved: Reserved, must be zero. 76 + */ 86 77 __u32 reserved; 87 78 }; 88 79 ··· 96 79 * A task is the smallest unit of work that can be run on the NPU. 97 80 */ 98 81 struct drm_rocket_task { 99 - /** Input: DMA address to NPU mapping of register command buffer */ 82 + /** 83 + * @regcmd: Input: DMA address to NPU mapping of register command buffer 84 + */ 100 85 __u32 regcmd; 101 86 102 - /** Input: Number of commands in the register command buffer */ 87 + /** 88 + * @regcmd_count: Input: Number of commands in the register command 89 + * buffer 90 + */ 103 91 __u32 regcmd_count; 104 92 }; 105 93 ··· 116 94 * sequentially on the same core, to benefit from memory residency in SRAM. 117 95 */ 118 96 struct drm_rocket_job { 119 - /** Input: Pointer to an array of struct drm_rocket_task. */ 97 + /** 98 + * @tasks: Input: Pointer to an array of struct drm_rocket_task. 99 + */ 120 100 __u64 tasks; 121 101 122 - /** Input: Pointer to a u32 array of the BOs that are read by the job. */ 102 + /** 103 + * @in_bo_handles: Input: Pointer to a u32 array of the BOs that 104 + * are read by the job. 105 + */ 123 106 __u64 in_bo_handles; 124 107 125 - /** Input: Pointer to a u32 array of the BOs that are written to by the job. */ 108 + /** 109 + * @out_bo_handles: Input: Pointer to a u32 array of the BOs that 110 + * are written to by the job. 111 + */ 126 112 __u64 out_bo_handles; 127 113 128 - /** Input: Number of tasks passed in. */ 114 + /** 115 + * @task_count: Input: Number of tasks passed in. 116 + */ 129 117 __u32 task_count; 130 118 131 - /** Input: Size in bytes of the structs in the @tasks field. */ 119 + /** 120 + * @task_struct_size: Input: Size in bytes of the structs in the 121 + * @tasks field. 122 + */ 132 123 __u32 task_struct_size; 133 124 134 - /** Input: Number of input BO handles passed in (size is that times 4). */ 125 + /** 126 + * @in_bo_handle_count: Input: Number of input BO handles passed in 127 + * (size is that times 4). 128 + */ 135 129 __u32 in_bo_handle_count; 136 130 137 - /** Input: Number of output BO handles passed in (size is that times 4). */ 131 + /** 132 + * @out_bo_handle_count: Input: Number of output BO handles passed in 133 + * (size is that times 4). 134 + */ 138 135 __u32 out_bo_handle_count; 139 136 }; 140 137 ··· 163 122 * The kernel will schedule the execution of these jobs in dependency order. 164 123 */ 165 124 struct drm_rocket_submit { 166 - /** Input: Pointer to an array of struct drm_rocket_job. */ 125 + /** 126 + * @jobs: Input: Pointer to an array of struct drm_rocket_job. 127 + */ 167 128 __u64 jobs; 168 129 169 - /** Input: Number of jobs passed in. */ 130 + /** 131 + * @job_count: Input: Number of jobs passed in. 132 + */ 170 133 __u32 job_count; 171 134 172 - /** Input: Size in bytes of the structs in the @jobs field. */ 135 + /** 136 + * @job_struct_size: Input: Size in bytes of the structs in the 137 + * @jobs field. 138 + */ 173 139 __u32 job_struct_size; 174 140 175 - /** Reserved, must be zero. */ 141 + /** 142 + * @reserved: Reserved, must be zero. 143 + */ 176 144 __u64 reserved; 177 145 }; 178 146