accel/rocket: rocket_accel.h: fix kernel-doc warnings (38feb171) · Commits · git / linux-net

include/uapi/drm/rocket_accel.h

+74 −24

Original line number	Diff line number	Diff line
		@@ -26,20 +26,27 @@ extern "C" {
		*
		*/
		struct drm_rocket_create_bo {
		/** Input: Size of the requested BO. */
		/**
		* @size: Input: Size of the requested BO.
		*/
		__u32 size;

		/** Output: GEM handle for the BO. */
		/**
		* @handle: Output: GEM handle for the BO.
		*/
		__u32 handle;

		/**
		* Output: DMA address for the BO in the NPU address space. This address
		* is private to the DRM fd and is valid for the lifetime of the GEM
		* handle.
		* @dma_address: Output: DMA address for the BO in the NPU address
		* space. This address is private to the DRM fd and is valid for
		* the lifetime of the GEM handle.
		*/
		__u64 dma_address;

		/** Output: Offset into the drm node to use for subsequent mmap call. */
		/**
		* @offset: Output: Offset into the drm node to use for subsequent
		* mmap call.
		*/
		__u64 offset;
		};

		@@ -50,13 +57,19 @@ struct drm_rocket_create_bo {
		* synchronization.
		*/
		struct drm_rocket_prep_bo {
		/** Input: GEM handle of the buffer object. */
		/**
		* @handle: Input: GEM handle of the buffer object.
		*/
		__u32 handle;

		/** Reserved, must be zero. */
		/**
		* @reserved: Reserved, must be zero.
		*/
		__u32 reserved;

		/** Input: Amount of time to wait for NPU jobs. */
		/**
		* @timeout_ns: Input: Amount of time to wait for NPU jobs.
		*/
		__s64 timeout_ns;
		};

		@@ -66,10 +79,14 @@ struct drm_rocket_prep_bo {
		* Synchronize caches for NPU access.
		*/
		struct drm_rocket_fini_bo {
		/** Input: GEM handle of the buffer object. */
		/**
		* @handle: Input: GEM handle of the buffer object.
		*/
		__u32 handle;

		/** Reserved, must be zero. */
		/**
		* @reserved: Reserved, must be zero.
		*/
		__u32 reserved;
		};

		@@ -79,10 +96,15 @@ struct drm_rocket_fini_bo {
		* A task is the smallest unit of work that can be run on the NPU.
		*/
		struct drm_rocket_task {
		/** Input: DMA address to NPU mapping of register command buffer */
		/**
		* @regcmd: Input: DMA address to NPU mapping of register command buffer
		*/
		__u32 regcmd;

		/** Input: Number of commands in the register command buffer */
		/**
		* @regcmd_count: Input: Number of commands in the register command
		* buffer
		*/
		__u32 regcmd_count;
		};

		@@ -94,25 +116,44 @@ struct drm_rocket_task {
		* sequentially on the same core, to benefit from memory residency in SRAM.
		*/
		struct drm_rocket_job {
		/** Input: Pointer to an array of struct drm_rocket_task. */
		/**
		* @tasks: Input: Pointer to an array of struct drm_rocket_task.
		*/
		__u64 tasks;

		/** Input: Pointer to a u32 array of the BOs that are read by the job. */
		/**
		* @in_bo_handles: Input: Pointer to a u32 array of the BOs that
		* are read by the job.
		*/
		__u64 in_bo_handles;

		/** Input: Pointer to a u32 array of the BOs that are written to by the job. */
		/**
		* @out_bo_handles: Input: Pointer to a u32 array of the BOs that
		* are written to by the job.
		*/
		__u64 out_bo_handles;

		/** Input: Number of tasks passed in. */
		/**
		* @task_count: Input: Number of tasks passed in.
		*/
		__u32 task_count;

		/** Input: Size in bytes of the structs in the @tasks field. */
		/**
		* @task_struct_size: Input: Size in bytes of the structs in the
		* @tasks field.
		*/
		__u32 task_struct_size;

		/** Input: Number of input BO handles passed in (size is that times 4). */
		/**
		* @in_bo_handle_count: Input: Number of input BO handles passed in
		* (size is that times 4).
		*/
		__u32 in_bo_handle_count;

		/** Input: Number of output BO handles passed in (size is that times 4). */
		/**
		* @out_bo_handle_count: Input: Number of output BO handles passed in
		* (size is that times 4).
		*/
		__u32 out_bo_handle_count;
		};

		@@ -122,16 +163,25 @@ struct drm_rocket_job {
		* The kernel will schedule the execution of these jobs in dependency order.
		*/
		struct drm_rocket_submit {
		/** Input: Pointer to an array of struct drm_rocket_job. */
		/**
		* @jobs: Input: Pointer to an array of struct drm_rocket_job.
		*/
		__u64 jobs;

		/** Input: Number of jobs passed in. */
		/**
		* @job_count: Input: Number of jobs passed in.
		*/
		__u32 job_count;

		/** Input: Size in bytes of the structs in the @jobs field. */
		/**
		* @job_struct_size: Input: Size in bytes of the structs in the
		* @jobs field.
		*/
		__u32 job_struct_size;

		/** Reserved, must be zero. */
		/**
		* @reserved: Reserved, must be zero.
		*/
		__u64 reserved;
		};