diff options
Diffstat (limited to 'offload/liboffload/API/Kernel.td')
| -rw-r--r-- | offload/liboffload/API/Kernel.td | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/offload/liboffload/API/Kernel.td b/offload/liboffload/API/Kernel.td index 247f9c1bf5b6..45e3d8112791 100644 --- a/offload/liboffload/API/Kernel.td +++ b/offload/liboffload/API/Kernel.td @@ -43,19 +43,21 @@ def : Function { let name = "olLaunchKernel"; let desc = "Enqueue a kernel launch with the specified size and parameters."; let details = [ - "If a queue is not specified, kernel execution happens synchronously" + "If a queue is not specified, kernel execution happens synchronously", + "ArgumentsData may be set to NULL (to indicate no parameters)" ]; let params = [ Param<"ol_queue_handle_t", "Queue", "handle of the queue", PARAM_IN_OPTIONAL>, Param<"ol_device_handle_t", "Device", "handle of the device to execute on", PARAM_IN>, Param<"ol_kernel_handle_t", "Kernel", "handle of the kernel", PARAM_IN>, - Param<"const void*", "ArgumentsData", "pointer to the kernel argument struct", PARAM_IN>, + Param<"const void*", "ArgumentsData", "pointer to the kernel argument struct", PARAM_IN_OPTIONAL>, Param<"size_t", "ArgumentsSize", "size of the kernel argument struct", PARAM_IN>, Param<"const ol_kernel_launch_size_args_t*", "LaunchSizeArgs", "pointer to the struct containing launch size parameters", PARAM_IN>, Param<"ol_event_handle_t*", "EventOut", "optional recorded event for the enqueued operation", PARAM_OUT_OPTIONAL> ]; let returns = [ Return<"OL_ERRC_INVALID_ARGUMENT", ["`Queue == NULL && EventOut != NULL`"]>, + Return<"OL_ERRC_INVALID_ARGUMENT", ["`ArgumentsSize > 0 && ArgumentsData == NULL`"]>, Return<"OL_ERRC_INVALID_DEVICE", ["If Queue is non-null but does not belong to Device"]>, ]; } |