Skip to content

Commit 9f56275

Browse files
Andrzej Kacprowskikwachows
authored andcommitted
accel/ivpu: Fix doc description of job structure
Fix doc description of job structure as it is improperly formatted. Align order of job structure's fields according to the documentation. Fixes: 0bf37f4 ("accel/ivpu: Add support for user-managed preemption buffer") Signed-off-by: Andrzej Kacprowski <andrzej.kacprowski@linux.intel.com> Signed-off-by: Maciej Falkowski <maciej.falkowski@linux.intel.com> Reviewed-by: Karol Wachowski <karol.wachowski@linux.intel.com> Signed-off-by: Karol Wachowski <karol.wachowski@linux.intel.com> Link: https://lore.kernel.org/r/20250925145131.1446323-1-maciej.falkowski@linux.intel.com
1 parent 8b694b4 commit 9f56275

1 file changed

Lines changed: 27 additions & 17 deletions

File tree

drivers/accel/ivpu/ivpu_job.h

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,17 @@ struct ivpu_device;
1515
struct ivpu_file_priv;
1616

1717
/**
18-
* struct ivpu_cmdq - Object representing device queue used to send jobs.
19-
* @jobq: Pointer to job queue memory shared with the device
20-
* @mem: Memory allocated for the job queue, shared with device
21-
* @entry_count Number of job entries in the queue
22-
* @db_id: Doorbell assigned to this job queue
23-
* @db_registered: True if doorbell is registered in device
18+
* struct ivpu_cmdq - Represents a command queue for submitting jobs to the VPU.
19+
* Tracks queue memory, preemption buffers, and metadata for job management.
20+
* @jobq: Pointer to job queue memory shared with the device
21+
* @primary_preempt_buf: Primary preemption buffer for this queue (optional)
22+
* @secondary_preempt_buf: Secondary preemption buffer for this queue (optional)
23+
* @mem: Memory allocated for the job queue, shared with device
24+
* @entry_count: Number of job entries in the queue
25+
* @id: Unique command queue ID
26+
* @db_id: Doorbell ID assigned to this job queue
27+
* @priority: Priority level of the command queue
28+
* @is_legacy: True if this is a legacy command queue
2429
*/
2530
struct ivpu_cmdq {
2631
struct vpu_job_queue *jobq;
@@ -35,16 +40,21 @@ struct ivpu_cmdq {
3540
};
3641

3742
/**
38-
* struct ivpu_job - KMD object that represents batchbuffer / DMA buffer.
39-
* Each batch / DMA buffer is a job to be submitted and executed by the VPU FW.
40-
* This is a unit of execution, and be tracked by the job_id for
41-
* any status reporting from VPU FW through IPC JOB RET/DONE message.
42-
* @file_priv: The client that submitted this job
43-
* @job_id: Job ID for KMD tracking and job status reporting from VPU FW
44-
* @status: Status of the Job from IPC JOB RET/DONE message
45-
* @batch_buffer: CPU vaddr points to the batch buffer memory allocated for the job
46-
* @submit_status_offset: Offset within batch buffer where job completion handler
47-
will update the job status
43+
* struct ivpu_job - Representing a batch or DMA buffer submitted to the VPU.
44+
* Each job is a unit of execution, tracked by job_id for status reporting from VPU FW.
45+
* The structure holds all resources and metadata needed for job submission, execution,
46+
* and completion handling.
47+
* @vdev: Pointer to the VPU device
48+
* @file_priv: The client context that submitted this job
49+
* @done_fence: Fence signaled when job completes
50+
* @cmd_buf_vpu_addr: VPU address of the command buffer for this job
51+
* @cmdq_id: Command queue ID used for submission
52+
* @job_id: Unique job ID for tracking and status reporting
53+
* @engine_idx: Engine index for job execution
54+
* @primary_preempt_buf: Primary preemption buffer for job
55+
* @secondary_preempt_buf: Secondary preemption buffer for job (optional)
56+
* @bo_count: Number of buffer objects associated with this job
57+
* @bos: Array of buffer objects used by the job (batch buffer is at index 0)
4858
*/
4959
struct ivpu_job {
5060
struct ivpu_device *vdev;
@@ -54,9 +64,9 @@ struct ivpu_job {
5464
u32 cmdq_id;
5565
u32 job_id;
5666
u32 engine_idx;
57-
size_t bo_count;
5867
struct ivpu_bo *primary_preempt_buf;
5968
struct ivpu_bo *secondary_preempt_buf;
69+
size_t bo_count;
6070
struct ivpu_bo *bos[] __counted_by(bo_count);
6171
};
6272

0 commit comments

Comments
 (0)