summaryrefslogtreecommitdiff
path: root/include/uapi/misc
diff options
context:
space:
mode:
authorOded Gabbay <oded.gabbay@gmail.com>2019-02-28 11:55:44 +0200
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2019-02-28 13:06:09 +0100
commit541664d360d1fdaa116473410265b2cb8a806b50 (patch)
tree25d5fa690b64e5a90cdc5fd18dd52c00f1b0a118 /include/uapi/misc
parent3dccd18787b84d111133794c8076c69e8fb6d84e (diff)
habanalabs: add comments in uapi/misc/habanalabs.h
Add comment about minimum and maximum size of command buffer. Add some text about the expected input of CS IOCTL. Signed-off-by: Oded Gabbay <oded.gabbay@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'include/uapi/misc')
-rw-r--r--include/uapi/misc/habanalabs.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/include/uapi/misc/habanalabs.h b/include/uapi/misc/habanalabs.h
index 23d6ad3459cb..7fd6f633534c 100644
--- a/include/uapi/misc/habanalabs.h
+++ b/include/uapi/misc/habanalabs.h
@@ -112,7 +112,9 @@ struct hl_cb_in {
__u64 cb_handle;
/* HL_CB_OP_* */
__u32 op;
- /* Size of CB. Minimum requested size must be PAGE_SIZE */
+ /* Size of CB. Maximum size is 2MB. The minimum size that will be
+ * allocated, regardless of this parameter's value, is PAGE_SIZE
+ */
__u32 cb_size;
/* Context ID - Currently not in use */
__u32 ctx_id;
@@ -364,6 +366,12 @@ union hl_mem_args {
* internal. The driver will get completion notifications from the device only
* on JOBS which are enqueued in the external queues.
*
+ * For jobs on external queues, the user needs to create command buffers
+ * through the CB ioctl and give the CB's handle to the CS ioctl. For jobs on
+ * internal queues, the user needs to prepare a "command buffer" with packets
+ * on either the SRAM or DRAM, and give the device address of that buffer to
+ * the CS ioctl.
+ *
* This IOCTL is asynchronous in regard to the actual execution of the CS. This
* means it returns immediately after ALL the JOBS were enqueued on their
* relevant queues. Therefore, the user mustn't assume the CS has been completed