accel/ivpu/vpu_jsm_api.h

1 /* SPDX-License-Identifier: MIT */
3  * Copyright (c) 2020-2024, Intel Corporation.
74 /* Job status returned when the job was preempted mid-inference */
79  * Host <-> VPU IPC channels.
80  * ASYNC commands use a high priority channel, other messages use low-priority ones.
132 	 *      does not need per-job fence signalling. Other inline commands objects can be
160  * same process with a relative in-process priority. Valid values for relative
161  * priority are given below - max and min.
164 #define VPU_HWS_COMMAND_QUEUE_MIN_IN_PROCESS_PRIORITY -7
207  * present in the queue prior to them, and in-order relative to each other in the queue.
208  * But jobs in-between them may be processed concurrently and may complete out-of-order.
213  * Job scheduling priority bands for both hardware scheduling and OS scheduling.
273 			/* User VA of the monitored fence value (read-only). */
351 	 * It is written by host before passing buffer to VPU. VPU should consider it read-only.
366 	 *     0 - context state change
367 	 *     1 - queue new work
368 	 *     2 - queue unwait sync object
369 	 *     3 - queue no more work
370 	 *     4 - queue wait sync object
435  * Host <-> VPU IPC messages types.
440 	/* IPC Host -> Device, Async commands */
538 	/* IPC Host -> Device, General commands */
551 	/* IPC Device -> Host, Job completion */
553 	/* IPC Device -> Host, Fence signalled */
556 	/* IPC Device -> Host, Async command completion */
624 	/* IPC Device -> Host, HWS notify index entry of log buffer written */
626 	/* IPC Device -> Host, HWS completion of a context suspend request */
642 	/* IPC Device -> Host, General command completion */
648 	 * Acknowledgment of completion of the save procedure initiated by
657  * Host <-> LRT IPC message payload definitions
675  * This structure supports doorbell registration for only OS scheduling.
687 	/* Host sub-stream ID for the context assigned to the doorbell. */
693  * Request structure to unregister a doorbell for both HW and OS scheduling.
713 	 * range [0, power_level_count-1] where power_level_count
717 	 * power_level_count-1 corresponds to the minimum possible
727 	/* Host sub-stream ID for the context to be released. */
766 	 * send a notification to the host driver if @notify_sample_count is non-zero.
809 	 * Case 2. is identified by the address being non-zero and differs from the
822 	 * are non-zero in same update request. It is the host's responsibility to ensure
891  * Response structure for register doorbell command for both OS
904  * Response structure for unregister doorbell command for both OS
935 	 * [0-100%] range relative to power level 0.
1056  * This structure supports doorbell registration for both HW and OS scheduling.
1058  * OS scheduling and HW scheduling. For OS scheduling, cmdq_id will be ignored
1066 	/* Host sub-stream ID for the context assigned to the doorbell. */
1077  * @brief Structure to set another buffer to be used for scheduling-related logging.
1081  *   - header:     32 bytes in size, as shown in 'struct vpu_hws_log_buffer_header'.
1083  *   - log entry:  0 to n-1, each log entry is 32 bytes in size, as shown in
1138  *   - Suspend all work on this context
1139  *   - Preempt any running work
1140  *   - Asynchronously perform the above and return success immediately once
1142  *   - Notify the host of completion of these operations via
1144  *   - Reject any other context operations on a context with an in-flight
1162 	 * Suspend fence value - reported by the VPU suspend context
1171  *  - VPU will resume all work on this context
1172  *  - Scheduler will allow this context to be scheduled
1205  * - For VPU_JSM_MSG_TRACE_SET_CONFIG, the payload specifies the desired
1208  * - For VPU_JSM_MSG_TRACE_SET_CONFIG_RSP, the payload reports the logging
1214  * - VPU_JSM_MSG_TRACE_GET_CONFIG_RSP, the payload reports the current logging
1298 	 * Size in bytes of single sample - total size of all enabled counters.
1334 	 * Offset to the next metric group (8-byte aligned). If this offset is 0 this
1337 	 * + description_string_size and must be 8-byte aligned.
1341 	 * Offset to the first metric counter description record (8-byte aligned).
1378 	 * Offset to the next counter in a group (8-byte aligned). If this offset is
1422  * (https://www.kernel.org/doc/html/latest/admin-guide/dynamic-debug-howto.html)
1437 	 * Dyndbg command (same format as Linux dyndbg); must be a NULL-terminated
1446  * This is a bi-directional payload.
1517  * Host <-> LRT IPC message base structure.