diff --git a/include/ur_api.h b/include/ur_api.h index 526d846f35..70213d4738 100644 --- a/include/ur_api.h +++ b/include/ur_api.h @@ -1299,10 +1299,8 @@ typedef enum ur_platform_backend_t { #endif /////////////////////////////////////////////////////////////////////////////// #ifndef UR_DEVICE_BINARY_TARGET_UNKNOWN -/// @brief Target identification strings for -/// ::ur_device_binary_t.pDeviceTargetSpec -/// A device type represented by a particular target triple requires -/// specific +/// @brief Target identification strings for ::ur_device_binary_t.pDeviceTargetSpec +/// A device type represented by a particular target triple requires specific /// binary images. We need to map the image type onto the device target triple #define UR_DEVICE_BINARY_TARGET_UNKNOWN "" #endif // UR_DEVICE_BINARY_TARGET_UNKNOWN @@ -1825,8 +1823,7 @@ typedef enum ur_device_affinity_domain_flag_t { ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, - ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, - ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE, + ///< ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, ::UR_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE, ///< and partition the device into sub devices comprised of compute units ///< that share memory subsystems at this level. /// @cond @@ -2611,8 +2608,7 @@ typedef struct ur_image_desc_t { /// /// @details /// - The primary ::ur_image_format_t that must be supported by all the -/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, -/// UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, +/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, @@ -6152,13 +6148,11 @@ urEnqueueKernelLaunch( const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -7161,8 +7155,7 @@ urEnqueueUSMFill2D( uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -7212,8 +7205,7 @@ urEnqueueUSMMemcpy2D( uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -7251,8 +7243,7 @@ urEnqueueDeviceGlobalVariableWrite( uint32_t numEventsInWaitList, ///< [in] size of the event wait list. const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -7290,8 +7281,7 @@ urEnqueueDeviceGlobalVariableRead( uint32_t numEventsInWaitList, ///< [in] size of the event wait list. const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -7331,8 +7321,7 @@ urEnqueueReadHostPipe( const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - ur_event_handle_t *phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + ur_event_handle_t *phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ); @@ -9128,13 +9117,11 @@ urEnqueueCooperativeKernelLaunchExp( const size_t *pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t *phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. ); @@ -9193,8 +9180,7 @@ urEnqueueTimestampRecordingExp( uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t *phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t *phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried ///< from this event as if `hQueue` had profiling enabled. Querying diff --git a/scripts/core/adapter.yml b/scripts/core/adapter.yml index f7c94fcbb3..a4eddd823c 100644 --- a/scripts/core/adapter.yml +++ b/scripts/core/adapter.yml @@ -28,7 +28,7 @@ params: - type: "uint32_t" name: NumEntries desc: | - [in] the number of adapters to be added to phAdapters. + [in] the number of adapters to be added to phAdapters. If phAdapters is not NULL, then NumEntries should be greater than zero, otherwise $X_RESULT_ERROR_INVALID_SIZE, will be returned. - type: "$x_adapter_handle_t*" @@ -39,7 +39,7 @@ params: - type: "uint32_t*" name: "pNumAdapters" desc: | - [out][optional] returns the total number of adapters available. + [out][optional] returns the total number of adapters available. returns: - $X_RESULT_ERROR_INVALID_SIZE: - "`NumEntries == 0 && phAdapters != NULL`" diff --git a/scripts/core/context.yml b/scripts/core/context.yml index 6568a485ae..e45c93010d 100644 --- a/scripts/core/context.yml +++ b/scripts/core/context.yml @@ -95,7 +95,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the context object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: USM_MEMCPY2D_SUPPORT desc: "[$x_bool_t] to indicate if the $xEnqueueUSMMemcpy2D entrypoint is supported." @@ -107,11 +107,11 @@ etors: desc: "[$x_memory_scope_capability_flags_t] return a bit-field of atomic memory scope capabilities." - name: ATOMIC_FENCE_ORDER_CAPABILITIES desc: | - [$x_memory_order_capability_flags_t] return a bit-field of atomic memory fence order capabilities. + [$x_memory_order_capability_flags_t] return a bit-field of atomic memory fence order capabilities. Zero is returned if the backend does not support context-level fences. - name: ATOMIC_FENCE_SCOPE_CAPABILITIES desc: | - [$x_memory_scope_capability_flags_t] return a bit-field of atomic memory fence scope capabilities. + [$x_memory_scope_capability_flags_t] return a bit-field of atomic memory fence scope capabilities. Zero is returned if the backend does not support context-level fences. --- #-------------------------------------------------------------------------- type: function @@ -122,7 +122,7 @@ decl: static ordinal: "0" analogue: - "**clReleaseContext**" -details: +details: - "The application may call this function from simultaneous threads for the same context." - "The implementation of this function should be thread-safe." params: @@ -157,7 +157,7 @@ params: name: pPropValue desc: | [out][optional][typename(propName, propSize)] array of bytes holding the info. - if propSize is not equal to or greater than the real number of bytes needed to return + if propSize is not equal to or greater than the real number of bytes needed to return the info then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used. - type: "size_t*" name: pPropSizeRet diff --git a/scripts/core/device.yml b/scripts/core/device.yml index c063466b22..6641d8bb2b 100644 --- a/scripts/core/device.yml +++ b/scripts/core/device.yml @@ -15,8 +15,8 @@ ordinal: "2" --- #-------------------------------------------------------------------------- type: macro desc: | - Target identification strings for $x_device_binary_t.pDeviceTargetSpec - A device type represented by a particular target triple requires specific + Target identification strings for $x_device_binary_t.pDeviceTargetSpec + A device type represented by a particular target triple requires specific binary images. We need to map the image type onto the device target triple name: "$X_DEVICE_BINARY_TARGET_UNKNOWN" value: "\"\"" @@ -35,7 +35,7 @@ value: "\"spir64\"" --- #-------------------------------------------------------------------------- type: macro desc: | - Device-specific binary images produced from SPIR-V 64-bit <-> various + Device-specific binary images produced from SPIR-V 64-bit <-> various "spir64_*" triples for specific 64-bit OpenCL CPU devices name: "$X_DEVICE_BINARY_TARGET_SPIRV64_X86_64" value: "\"spir64_x86_64\"" @@ -75,7 +75,7 @@ members: name: pDeviceTargetSpec desc: | [in] null-terminated string representation of the device's target architecture. - For example: + For example: + $X_DEVICE_BINARY_TARGET_UNKNOWN + $X_DEVICE_BINARY_TARGET_SPIRV32 + $X_DEVICE_BINARY_TARGET_SPIRV64 @@ -326,7 +326,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the device object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: IL_VERSION desc: "[char[]] IL version" @@ -356,7 +356,7 @@ etors: desc: "[uint32_t] maximum number of sub-devices when the device is partitioned" - name: PARTITION_AFFINITY_DOMAIN desc: | - [$x_device_affinity_domain_flags_t] Returns a bit-field of the supported affinity domains for partitioning. + [$x_device_affinity_domain_flags_t] Returns a bit-field of the supported affinity domains for partitioning. If the device does not support any affinity domains, then 0 will be returned. - name: PARTITION_TYPE desc: "[$x_device_partition_property_t[]] return an array of $x_device_partition_property_t for properties specified in $xDevicePartition" @@ -412,7 +412,7 @@ etors: desc: "[$x_bool_t] support for bfloat16" - name: MAX_COMPUTE_QUEUE_INDICES desc: | - [uint32_t] Returns 1 if the device doesn't have a notion of a + [uint32_t] Returns 1 if the device doesn't have a notion of a queue index. Otherwise, returns the number of queue indices that are available for this device. - name: KERNEL_SET_SPECIALIZATION_CONSTANTS @@ -548,10 +548,10 @@ etors: value: "$X_BIT(4)" - name: NEXT_PARTITIONABLE desc: | - Split the device along the next partitionable affinity domain. + Split the device along the next partitionable affinity domain. The implementation shall find the first level along which the device - or sub device may be further subdivided in the order: - $X_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE, + or sub device may be further subdivided in the order: + $X_DEVICE_AFFINITY_DOMAIN_FLAG_NUMA, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L4_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L3_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L2_CACHE, $X_DEVICE_AFFINITY_DOMAIN_FLAG_L1_CACHE, and partition the device into sub devices comprised of compute units that share memory subsystems at this level. value: "$X_BIT(5)" --- #-------------------------------------------------------------------------- @@ -679,7 +679,7 @@ params: - type: "uint32_t" name: NumBinaries desc: | - [in] the number of binaries passed in ppBinaries. + [in] the number of binaries passed in ppBinaries. Must greater than or equal to zero otherwise $X_RESULT_ERROR_INVALID_VALUE is returned. - type: "uint32_t*" name: pSelectedBinary @@ -850,13 +850,13 @@ params: desc: "[in] handle of the device instance" - type: "uint64_t*" name: pDeviceTimestamp - desc: | - [out][optional] pointer to the Device's global timestamp that + desc: | + [out][optional] pointer to the Device's global timestamp that correlates with the Host's global timestamp value - type: "uint64_t*" name: pHostTimestamp desc: | - [out][optional] pointer to the Host's global timestamp that + [out][optional] pointer to the Host's global timestamp that correlates with the Device's global timestamp value --- #-------------------------------------------------------------------------- type: enum diff --git a/scripts/core/enqueue.yml b/scripts/core/enqueue.yml index edf655318a..f925009050 100644 --- a/scripts/core/enqueue.yml +++ b/scripts/core/enqueue.yml @@ -33,13 +33,13 @@ params: name: pGlobalWorkOffset desc: "[in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item" - type: "const size_t*" - name: pGlobalWorkSize + name: pGlobalWorkSize desc: "[in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function" - type: "const size_t*" name: pLocalWorkSize desc: | [in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. - If nullptr, the runtime implementation will choose the work-group size. + If nullptr, the runtime implementation will choose the work-group size. - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -47,12 +47,12 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | [out][optional] return an event object that identifies this particular kernel execution instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_KERNEL - $X_RESULT_ERROR_INVALID_EVENT @@ -71,7 +71,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command which waits a list of events to complete before it completes" +desc: "Enqueue a command which waits a list of events to complete before it completes" class: $xEnqueue name: EventsWait ordinal: "0" @@ -92,12 +92,12 @@ params: desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands - must be complete. + must be complete. - type: $x_event_handle_t* name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -111,7 +111,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a barrier command which waits a list of events to complete before it completes" +desc: "Enqueue a barrier command which waits a list of events to complete before it completes" class: $xEnqueue name: EventsWaitWithBarrier ordinal: "0" @@ -133,12 +133,12 @@ params: desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before this command can be executed. If nullptr, the numEventsInWaitList must be 0, indicating that all previously enqueued commands - must be complete. + must be complete. - type: $x_event_handle_t* name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -152,7 +152,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to read from a buffer object to host memory" +desc: "Enqueue a command to read from a buffer object to host memory" class: $xEnqueue name: MemBufferRead ordinal: "0" @@ -178,7 +178,7 @@ params: desc: "[in] size in bytes of data being read" - type: void* name: pDst - desc: "[in] pointer to host memory where data is to be read into" + desc: "[in] pointer to host memory where data is to be read into" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -191,7 +191,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -207,11 +207,11 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to write into a buffer object from host memory" +desc: "Enqueue a command to write into a buffer object from host memory" class: $xEnqueue name: MemBufferWrite ordinal: "0" -details: +details: - "Input parameter blockingWrite indicates if the write is blocking or non-blocking." analogue: - "**clEnqueueWriteBuffer**" @@ -233,7 +233,7 @@ params: desc: "[in] size in bytes of data being written" - type: "const void*" name: pSrc - desc: "[in] pointer to host memory where data is to be written from" + desc: "[in] pointer to host memory where data is to be written from" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -246,7 +246,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -262,7 +262,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to read a 2D or 3D rectangular region from a buffer object to host memory" +desc: "Enqueue a command to read a 2D or 3D rectangular region from a buffer object to host memory" class: $xEnqueue name: MemBufferReadRect ordinal: "0" @@ -301,10 +301,10 @@ params: desc: "[in] length of each row in bytes in the host memory region pointed by dst" - type: size_t name: hostSlicePitch - desc: "[in] length of each 2D slice in bytes in the host memory region pointed by dst" + desc: "[in] length of each 2D slice in bytes in the host memory region pointed by dst" - type: void* name: pDst - desc: "[in] pointer to host memory where data is to be read into" + desc: "[in] pointer to host memory where data is to be read into" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -317,7 +317,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -340,7 +340,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to write a 2D or 3D rectangular region in a buffer object from host memory" +desc: "Enqueue a command to write a 2D or 3D rectangular region in a buffer object from host memory" class: $xEnqueue name: MemBufferWriteRect ordinal: "0" @@ -379,10 +379,10 @@ params: desc: "[in] length of each row in bytes in the host memory region pointed by src" - type: size_t name: hostSlicePitch - desc: "[in] length of each 2D slice in bytes in the host memory region pointed by src" + desc: "[in] length of each 2D slice in bytes in the host memory region pointed by src" - type: void* name: pSrc - desc: "[in] pointer to host memory where data is to be written from" + desc: "[in] pointer to host memory where data is to be written from" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -395,7 +395,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -418,7 +418,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to copy from a buffer object to another" +desc: "Enqueue a command to copy from a buffer object to another" class: $xEnqueue name: MemBufferCopy ordinal: "0" @@ -437,7 +437,7 @@ params: - type: size_t name: srcOffset desc: "[in] offset into hBufferSrc to begin copying from" - - type: size_t + - type: size_t name: dstOffset desc: "[in] offset info hBufferDst to begin copying into" - type: size_t @@ -455,7 +455,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -472,7 +472,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to copy a 2D or 3D rectangular region from one buffer object to another" +desc: "Enqueue a command to copy a 2D or 3D rectangular region from one buffer object to another" class: $xEnqueue name: MemBufferCopyRect ordinal: "0" @@ -508,7 +508,7 @@ params: desc: "[in] length of each row in bytes in the destination buffer object" - type: size_t name: dstSlicePitch - desc: "[in] length of each 2D slice in bytes in the destination buffer object" + desc: "[in] length of each 2D slice in bytes in the destination buffer object" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -521,7 +521,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -545,7 +545,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to fill a buffer object with a pattern of a given size" +desc: "Enqueue a command to fill a buffer object with a pattern of a given size" class: $xEnqueue name: MemBufferFill ordinal: "0" @@ -582,7 +582,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -603,7 +603,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to read from an image or image array object to host memory" +desc: "Enqueue a command to read from an image or image array object to host memory" class: $xEnqueue name: MemImageRead ordinal: "0" @@ -635,7 +635,7 @@ params: desc: "[in] length of each 2D slice of the 3D image" - type: void* name: pDst - desc: "[in] pointer to host memory where image is to be read into" + desc: "[in] pointer to host memory where image is to be read into" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -648,7 +648,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -664,7 +664,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to write an image or image array object from host memory" +desc: "Enqueue a command to write an image or image array object from host memory" class: $xEnqueue name: MemImageWrite ordinal: "0" @@ -696,7 +696,7 @@ params: desc: "[in] length of each 2D slice of the 3D image" - type: void* name: pSrc - desc: "[in] pointer to host memory where image is to be read into" + desc: "[in] pointer to host memory where image is to be read into" - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -709,7 +709,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -725,7 +725,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to copy from an image object to another" +desc: "Enqueue a command to copy from an image object to another" class: $xEnqueue name: MemImageCopy ordinal: "0" @@ -762,7 +762,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -778,7 +778,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to fill an image object with specified color" +desc: "Enqueue a command to fill an image object with specified color" class: $xEnqueue name: MemImageFill ordinal: "0" @@ -818,7 +818,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -839,10 +839,10 @@ etors: - name: READ desc: "Map for read access" value: "$X_BIT(0)" - - name: WRITE + - name: WRITE desc: "Map for write access" value: "$X_BIT(1)" - - name: WRITE_INVALIDATE_REGION + - name: WRITE_INVALIDATE_REGION desc: "Map for discard_write access" value: "$X_BIT(2)" --- #-------------------------------------------------------------------------- @@ -856,11 +856,11 @@ etors: value: "$X_BIT(0)" --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to map a region of the buffer object into the host address space and return a pointer to the mapped region" +desc: "Enqueue a command to map a region of the buffer object into the host address space and return a pointer to the mapped region" class: $xEnqueue name: MemBufferMap ordinal: "0" -details: +details: - "Input parameter blockingMap indicates if the map is blocking or non-blocking." - "Currently, no direct support in Level Zero. Implemented as a shared allocation followed by copying on discrete GPU" - "TODO: add a driver function in Level Zero?" @@ -900,7 +900,7 @@ params: - type: void** name: ppRetMap desc: "[out] return mapped pointer. TODO: move it before numEventsInWaitList?" -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -916,7 +916,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to map a region of the image object into the host address space and return a pointer to the mapped region" +desc: "Enqueue a command to map a region of the image object into the host address space and return a pointer to the mapped region" class: $xEnqueue name: MemImageMap version: "9999.0" # See #50 @@ -967,7 +967,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -981,7 +981,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to unmap a previously mapped region of a memory object" +desc: "Enqueue a command to unmap a previously mapped region of a memory object" class: $xEnqueue name: MemUnmap ordinal: "0" @@ -1009,7 +1009,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -1074,7 +1074,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to copy USM memory" +desc: "Enqueue a command to copy USM memory" class: $xEnqueue name: USMMemcpy ordinal: "0" @@ -1106,7 +1106,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_SIZE: @@ -1123,7 +1123,7 @@ returns: - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function -desc: "Enqueue a command to prefetch USM memory" +desc: "Enqueue a command to prefetch USM memory" class: $xEnqueue name: USMPrefetch ordinal: "0" @@ -1154,7 +1154,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_SIZE: @@ -1194,7 +1194,7 @@ params: name: phEvent desc: | [out][optional] return an event object that identifies this particular command instance. -returns: +returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_INVALID_EVENT - $X_RESULT_ERROR_INVALID_SIZE: @@ -1238,7 +1238,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | @@ -1302,7 +1302,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | @@ -1361,7 +1361,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | @@ -1408,7 +1408,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | @@ -1428,28 +1428,28 @@ name: ReadHostPipe ordinal: "0" params: - type: $x_queue_handle_t - name: hQueue + name: hQueue desc: | [in] a valid host command-queue in which the read command will be queued. hQueue and hProgram must be created with the same UR context. - type: $x_program_handle_t - name: hProgram + name: hProgram desc: "[in] a program object with a successfully built executable." - type: const char* - name: pipe_symbol + name: pipe_symbol desc: "[in] the name of the program scope pipe global variable." - type: bool - name: blocking + name: blocking desc: "[in] indicate if the read operation is blocking or non-blocking." - type: void* - name: pDst + name: pDst desc: "[in] a pointer to buffer in host memory that will hold resulting data from pipe." - type: size_t - name: size + name: size desc: "[in] size of the memory region to read, in bytes." - type: uint32_t - name: numEventsInWaitList + name: numEventsInWaitList desc: "[in] number of events in the wait list." - type: const $x_event_handle_t* name: phEventWaitList @@ -1457,9 +1457,9 @@ params: [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the host pipe read. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* - name: phEvent + name: phEvent desc: | - [out][optional] returns an event object that identifies this read command + [out][optional] returns an event object that identifies this read command and can be used to query or queue a wait for this command to complete. returns: - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST: @@ -1476,28 +1476,28 @@ name: WriteHostPipe ordinal: "0" params: - type: $x_queue_handle_t - name: hQueue + name: hQueue desc: | [in] a valid host command-queue in which the write command will be queued. hQueue and hProgram must be created with the same UR context. - type: $x_program_handle_t - name: hProgram + name: hProgram desc: "[in] a program object with a successfully built executable." - type: const char* - name: pipe_symbol + name: pipe_symbol desc: "[in] the name of the program scope pipe global variable." - type: bool - name: blocking + name: blocking desc: "[in] indicate if the read and write operations are blocking or non-blocking." - type: void* - name: pSrc + name: pSrc desc: "[in] a pointer to buffer in host memory that holds data to be written to the host pipe." - type: size_t - name: size + name: size desc: "[in] size of the memory region to read or write, in bytes." - type: uint32_t - name: numEventsInWaitList + name: numEventsInWaitList desc: "[in] number of events in the wait list." - type: const $x_event_handle_t* name: phEventWaitList @@ -1505,7 +1505,7 @@ params: [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the host pipe write. If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* - name: phEvent + name: phEvent desc: | [out][optional] returns an event object that identifies this write command and can be used to query or queue a wait for this command to complete. diff --git a/scripts/core/event.yml b/scripts/core/event.yml index 45bcbf7d40..2f42cb7122 100644 --- a/scripts/core/event.yml +++ b/scripts/core/event.yml @@ -107,7 +107,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the event object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. --- #-------------------------------------------------------------------------- type: enum @@ -210,7 +210,7 @@ params: - type: "const $x_event_handle_t*" name: phEventWaitList desc: "[in][range(0, numEvents)] pointer to a list of events to wait for completion" -returns: +returns: - $X_RESULT_ERROR_INVALID_VALUE: - "`numEvents == 0`" - $X_RESULT_ERROR_IN_EVENT_LIST_EXEC_STATUS: diff --git a/scripts/core/exp-bindless-images.yml b/scripts/core/exp-bindless-images.yml index d78583ac39..575dd74796 100644 --- a/scripts/core/exp-bindless-images.yml +++ b/scripts/core/exp-bindless-images.yml @@ -37,7 +37,7 @@ extend: true typed_etors: true desc: "Extension enums to $x_device_info_t to support bindless images." name: $x_device_info_t -etors: +etors: - name: BINDLESS_IMAGES_SUPPORT_EXP value: "0x2000" desc: "[$x_bool_t] returns true if the device supports the creation of bindless images" @@ -118,7 +118,7 @@ type: enum extend: true desc: "Structure Type experimental enumerations." name: $x_structure_type_t -etors: +etors: - name: EXP_SAMPLER_MIP_PROPERTIES desc: $x_exp_sampler_mip_properties_t value: "0x2000" @@ -891,7 +891,7 @@ params: desc: "[in] external semaphore handle" - type: bool name: hasSignalValue - desc: | + desc: | [in] indicates whether the samephore is capable and should signal on a certain value. Otherwise the semaphore is treated like a binary state, and `signalValue` is ignored. - type: uint64_t diff --git a/scripts/core/exp-cooperative-kernels.yml b/scripts/core/exp-cooperative-kernels.yml index 2262f9433b..170ec4bea0 100644 --- a/scripts/core/exp-cooperative-kernels.yml +++ b/scripts/core/exp-cooperative-kernels.yml @@ -37,13 +37,13 @@ params: name: pGlobalWorkOffset desc: "[in] pointer to an array of workDim unsigned values that specify the offset used to calculate the global ID of a work-item" - type: "const size_t*" - name: pGlobalWorkSize + name: pGlobalWorkSize desc: "[in] pointer to an array of workDim unsigned values that specify the number of global work-items in workDim that will execute the kernel function" - type: "const size_t*" name: pLocalWorkSize desc: | [in][optional] pointer to an array of workDim unsigned values that specify the number of local work-items forming a work-group that will execute the kernel function. - If nullptr, the runtime implementation will choose the work-group size. + If nullptr, the runtime implementation will choose the work-group size. - type: uint32_t name: numEventsInWaitList desc: "[in] size of the event wait list" @@ -51,7 +51,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. + If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. - type: $x_event_handle_t* name: phEvent desc: | @@ -87,5 +87,5 @@ params: - type: "uint32_t*" name: "pGroupCountRet" desc: "[out] pointer to maximum number of groups" -returns: +returns: - $X_RESULT_ERROR_INVALID_KERNEL diff --git a/scripts/core/exp-enqueue-timestamp-recording.yml b/scripts/core/exp-enqueue-timestamp-recording.yml index d8eff2a6cc..c0d96df482 100644 --- a/scripts/core/exp-enqueue-timestamp-recording.yml +++ b/scripts/core/exp-enqueue-timestamp-recording.yml @@ -17,7 +17,7 @@ extend: true typed_etors: true desc: "Extension enums to $x_device_info_t to support timestamp recordings." name: $x_device_info_t -etors: +etors: - name: TIMESTAMP_RECORDING_SUPPORT_EXP value: "0x2018" desc: "[$x_bool_t] returns true if the device supports timestamp recording" @@ -52,7 +52,7 @@ params: name: phEventWaitList desc: | [in][optional][range(0, numEventsInWaitList)] pointer to a list of events that must be complete before the kernel execution. - If nullptr, the numEventsInWaitList must be 0, indicating no wait events. + If nullptr, the numEventsInWaitList must be 0, indicating no wait events. - type: $x_event_handle_t* name: phEvent desc: | diff --git a/scripts/core/exp-launch-properties.yml b/scripts/core/exp-launch-properties.yml index aef4b2844a..12a0b4d1bb 100644 --- a/scripts/core/exp-launch-properties.yml +++ b/scripts/core/exp-launch-properties.yml @@ -138,4 +138,3 @@ etors: - name: CLUSTER_LAUNCH_EXP value: "0x1111" desc: "[$x_bool_t] return true if enqueue Cluster Launch is supported" - diff --git a/scripts/core/exp-multi-device-compile.yml b/scripts/core/exp-multi-device-compile.yml index 8ccba8c623..ddd1fcf541 100644 --- a/scripts/core/exp-multi-device-compile.yml +++ b/scripts/core/exp-multi-device-compile.yml @@ -41,7 +41,7 @@ params: desc: "[in] number of devices" - type: $x_device_handle_t* name: phDevices - desc: "[in][range(0, numDevices)] pointer to array of device handles" + desc: "[in][range(0, numDevices)] pointer to array of device handles" - type: const char* name: pOptions desc: "[in][optional] pointer to build options null-terminated string." @@ -72,7 +72,7 @@ params: desc: "[in] number of devices" - type: $x_device_handle_t* name: phDevices - desc: "[in][range(0, numDevices)] pointer to array of device handles" + desc: "[in][range(0, numDevices)] pointer to array of device handles" - type: const char* name: pOptions desc: "[in][optional] pointer to build options null-terminated string." @@ -104,7 +104,7 @@ params: desc: "[in] number of devices" - type: $x_device_handle_t* name: phDevices - desc: "[in][range(0, numDevices)] pointer to array of device handles" + desc: "[in][range(0, numDevices)] pointer to array of device handles" - type: uint32_t name: count desc: "[in] number of program handles in `phPrograms`." diff --git a/scripts/core/kernel.yml b/scripts/core/kernel.yml index 2414c74933..5bd95e1847 100644 --- a/scripts/core/kernel.yml +++ b/scripts/core/kernel.yml @@ -115,7 +115,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the kernel object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: CONTEXT desc: "[$x_context_handle_t] Return Context object associated with Kernel." @@ -210,12 +210,12 @@ params: - type: "size_t" name: propSize desc: | - [in] the size of the Kernel property value. + [in] the size of the Kernel property value. - type: "void*" name: pPropValue desc: | [in,out][optional][typename(propName, propSize)] array of bytes holding the kernel info property. - If propSize is not equal to or greater than the real number of bytes needed to return + If propSize is not equal to or greater than the real number of bytes needed to return the info then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used. - type: "size_t*" name: "pPropSizeRet" @@ -581,10 +581,10 @@ params: [in] pointer to an array of numWorkDim unsigned values that specify the offset used to calculate the global ID of a work-item - type: const size_t* - name: pGlobalWorkSize + name: pGlobalWorkSize desc: | [in] pointer to an array of numWorkDim unsigned values that specify - the number of global work-items in workDim that will execute the + the number of global work-items in workDim that will execute the kernel function - type: size_t* name: pSuggestedLocalWorkSize diff --git a/scripts/core/loader.yml b/scripts/core/loader.yml index 3a2a7c284c..8b0caf3b67 100644 --- a/scripts/core/loader.yml +++ b/scripts/core/loader.yml @@ -210,7 +210,7 @@ loader_only: True name: Init decl: static ordinal: "0" -details: +details: - "The application must call this function before calling any other function." - "If this function is not called then all other functions will return $X_RESULT_ERROR_UNINITIALIZED." - "Only one instance of the loader will be initialized per process." diff --git a/scripts/core/memory.yml b/scripts/core/memory.yml index 4df4ae0d0b..0fde537f37 100644 --- a/scripts/core/memory.yml +++ b/scripts/core/memory.yml @@ -211,12 +211,12 @@ analogue: - "**clCreateImage**" details: - | - The primary $x_image_format_t that must be supported by all the adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, - {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, - {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT8}, - {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT32}, - {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16}, - {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_HALF_FLOAT}, + The primary $x_image_format_t that must be supported by all the adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, + {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, + {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT8}, + {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT16}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SIGNED_INT32}, + {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT16}, + {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_HALF_FLOAT}, {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_FLOAT}. params: - type: $x_context_handle_t diff --git a/scripts/core/platform.yml b/scripts/core/platform.yml index e5c6bfa938..a1aa0dc7ca 100644 --- a/scripts/core/platform.yml +++ b/scripts/core/platform.yml @@ -33,7 +33,7 @@ params: - type: "uint32_t" name: NumEntries desc: | - [in] the number of platforms to be added to phPlatforms. + [in] the number of platforms to be added to phPlatforms. If phPlatforms is not NULL, then NumEntries should be greater than zero, otherwise $X_RESULT_ERROR_INVALID_SIZE, will be returned. - type: "$x_platform_handle_t*" @@ -44,7 +44,7 @@ params: - type: "uint32_t*" name: "pNumPlatforms" desc: | - [out][optional] returns the total number of platforms available. + [out][optional] returns the total number of platforms available. returns: - $X_RESULT_ERROR_INVALID_SIZE: - "`NumEntries == 0 && phPlatforms != NULL`" diff --git a/scripts/core/program.yml b/scripts/core/program.yml index 17c1abaf94..23f07d4287 100644 --- a/scripts/core/program.yml +++ b/scripts/core/program.yml @@ -366,7 +366,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the program object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: CONTEXT desc: "[$x_context_handle_t] Program context info." @@ -409,7 +409,7 @@ params: name: pPropValue desc: | [in,out][optional][typename(propName, propSize)] array of bytes of holding the program info property. - If propSize is not equal to or greater than the real number of bytes needed to return + If propSize is not equal to or greater than the real number of bytes needed to return the info then the $X_RESULT_ERROR_INVALID_SIZE error is returned and pPropValue is not used. - type: "size_t*" name: "pPropSizeRet" diff --git a/scripts/core/queue.yml b/scripts/core/queue.yml index 263685d1aa..c8a6528fbd 100644 --- a/scripts/core/queue.yml +++ b/scripts/core/queue.yml @@ -29,7 +29,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the queue object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: SIZE desc: | @@ -208,7 +208,7 @@ params: returns: - $X_RESULT_ERROR_INVALID_QUEUE - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY - - $X_RESULT_ERROR_OUT_OF_RESOURCES + - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: struct desc: "Descriptor for $xQueueGetNativeHandle and $xQueueCreateWithNativeHandle." diff --git a/scripts/core/sampler.yml b/scripts/core/sampler.yml index 6459277c6f..7e555386b0 100644 --- a/scripts/core/sampler.yml +++ b/scripts/core/sampler.yml @@ -52,7 +52,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the sampler object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: CONTEXT desc: "[$x_context_handle_t] Sampler context info" @@ -136,7 +136,7 @@ params: returns: - $X_RESULT_ERROR_INVALID_SAMPLER - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY - - $X_RESULT_ERROR_OUT_OF_RESOURCES + - $X_RESULT_ERROR_OUT_OF_RESOURCES --- #-------------------------------------------------------------------------- type: function desc: "Query information about a sampler object" diff --git a/scripts/core/usm.yml b/scripts/core/usm.yml index da5cd8c578..22f975a65d 100644 --- a/scripts/core/usm.yml +++ b/scripts/core/usm.yml @@ -154,7 +154,7 @@ members: Must be zero or a power of 2. Must be equal to or smaller than the size of the largest data type supported by `hDevice`. --- #-------------------------------------------------------------------------- -type: struct +type: struct desc: "USM host allocation descriptor type." details: - Specify these properties in $xUSMHostAlloc and $xUSMSharedAlloc via $x_usm_desc_t @@ -252,10 +252,10 @@ params: - type: void** name: ppMem desc: "[out] pointer to USM host memory object" -returns: +returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_OPERATION: - - "If $X_DEVICE_INFO_USM_HOST_SUPPORT is false." + - "If $X_DEVICE_INFO_USM_HOST_SUPPORT is false." - $X_RESULT_ERROR_INVALID_VALUE: - "`pUSMDesc && pUSMDesc->align != 0 && ((pUSMDesc->align & (pUSMDesc->align-1)) != 0)`" # alignment must be power of two - "If `align` is greater that the size of the largest data type supported by `hDevice`." @@ -297,7 +297,7 @@ params: - type: void** name: ppMem desc: "[out] pointer to USM device memory object" -returns: +returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_OPERATION: - "If $X_DEVICE_INFO_USM_HOST_SUPPORT is false." @@ -343,7 +343,7 @@ params: - type: void** name: ppMem desc: "[out] pointer to USM shared memory object" -returns: +returns: - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_VALUE: - "`pUSMDesc && pUSMDesc->align != 0 && ((pUSMDesc->align & (pUSMDesc->align-1)) != 0)`" # alignment must be power of two @@ -462,7 +462,7 @@ etors: - name: REFERENCE_COUNT desc: | [uint32_t] Reference count of the pool object. - The reference count returned should be considered immediately stale. + The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks. - name: CONTEXT desc: "[$x_context_handle_t] USM memory pool context info" diff --git a/scripts/core/virtual_memory.yml b/scripts/core/virtual_memory.yml index 5b12e1761e..133266de64 100644 --- a/scripts/core/virtual_memory.yml +++ b/scripts/core/virtual_memory.yml @@ -220,7 +220,7 @@ params: name: size desc: "[in] size in bytes of the virtual memory range." - type: $x_virtual_mem_info_t - name: propName + name: propName desc: "[in] type of the info to query." - type: size_t name: propSize diff --git a/source/adapters/mock/ur_mockddi.cpp b/source/adapters/mock/ur_mockddi.cpp index 7c38f5dd1c..6621b1ebc2 100644 --- a/source/adapters/mock/ur_mockddi.cpp +++ b/source/adapters/mock/ur_mockddi.cpp @@ -5377,14 +5377,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6677,8 +6675,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6747,8 +6744,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6815,8 +6811,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6885,8 +6880,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6961,8 +6955,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) try { ur_result_t result = UR_RESULT_SUCCESS; @@ -9513,14 +9506,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -9643,8 +9634,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried diff --git a/source/loader/layers/tracing/ur_trcddi.cpp b/source/loader/layers/tracing/ur_trcddi.cpp index 4381fea33e..f5c78fbb80 100644 --- a/source/loader/layers/tracing/ur_trcddi.cpp +++ b/source/loader/layers/tracing/ur_trcddi.cpp @@ -4538,14 +4538,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5660,8 +5658,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5720,8 +5717,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5779,8 +5775,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5840,8 +5835,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5906,8 +5900,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) { auto pfnReadHostPipe = getContext()->urDdiTable.Enqueue.pfnReadHostPipe; @@ -8208,14 +8201,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -8327,8 +8318,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried diff --git a/source/loader/layers/validation/ur_valddi.cpp b/source/loader/layers/validation/ur_valddi.cpp index 48663282df..2e16d7436d 100644 --- a/source/loader/layers/validation/ur_valddi.cpp +++ b/source/loader/layers/validation/ur_valddi.cpp @@ -4608,14 +4608,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6316,8 +6314,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6429,8 +6426,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6534,8 +6530,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6615,8 +6610,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6702,8 +6696,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) { auto pfnReadHostPipe = getContext()->urDdiTable.Enqueue.pfnReadHostPipe; @@ -9089,14 +9082,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -9212,8 +9203,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried diff --git a/source/loader/ur_ldrddi.cpp b/source/loader/ur_ldrddi.cpp index 4d384dbb52..1e172b26bd 100644 --- a/source/loader/ur_ldrddi.cpp +++ b/source/loader/ur_ldrddi.cpp @@ -4331,14 +4331,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5676,8 +5674,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5748,8 +5745,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5817,8 +5813,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5890,8 +5885,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5969,8 +5963,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -8024,14 +8017,12 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -8133,8 +8124,7 @@ __urdlllocal ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp index b4529320cd..a04cdb6490 100644 --- a/source/loader/ur_libapi.cpp +++ b/source/loader/ur_libapi.cpp @@ -1506,8 +1506,7 @@ ur_result_t UR_APICALL urContextSetExtendedDeleter( /// /// @details /// - The primary ::ur_image_format_t that must be supported by all the -/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, -/// UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, +/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, @@ -4939,14 +4938,12 @@ ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6208,8 +6205,7 @@ ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6274,8 +6270,7 @@ ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6329,8 +6324,7 @@ ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6384,8 +6378,7 @@ ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -6444,8 +6437,7 @@ ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) try { auto pfnReadHostPipe = @@ -8496,14 +8488,12 @@ ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -8583,8 +8573,7 @@ ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried diff --git a/source/ur_api.cpp b/source/ur_api.cpp index 6f0432ddb5..f7f7c3f3c3 100644 --- a/source/ur_api.cpp +++ b/source/ur_api.cpp @@ -1307,8 +1307,7 @@ ur_result_t UR_APICALL urContextSetExtendedDeleter( /// /// @details /// - The primary ::ur_image_format_t that must be supported by all the -/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, -/// UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, +/// adapters are {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_UNORM_INT16}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT8}, /// {UR_IMAGE_CHANNEL_ORDER_RGBA, UR_IMAGE_CHANNEL_TYPE_SNORM_INT16}, @@ -4195,14 +4194,12 @@ ur_result_t UR_APICALL urEnqueueKernelLaunch( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5306,8 +5303,7 @@ ur_result_t UR_APICALL urEnqueueUSMFill2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5365,8 +5361,7 @@ ur_result_t UR_APICALL urEnqueueUSMMemcpy2D( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5411,8 +5406,7 @@ ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableWrite( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5457,8 +5451,7 @@ ur_result_t UR_APICALL urEnqueueDeviceGlobalVariableRead( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -5508,8 +5501,7 @@ ur_result_t UR_APICALL urEnqueueReadHostPipe( ///< events that must be complete before the host pipe read. ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * - phEvent ///< [out][optional] returns an event object that identifies this read - ///< command + phEvent ///< [out][optional] returns an event object that identifies this read command ///< and can be used to query or queue a wait for this command to complete. ) { ur_result_t result = UR_RESULT_SUCCESS; @@ -7185,14 +7177,12 @@ ur_result_t UR_APICALL urEnqueueCooperativeKernelLaunchExp( pLocalWorkSize, ///< [in][optional] pointer to an array of workDim unsigned values that ///< specify the number of local work-items forming a work-group that will ///< execute the kernel function. - ///< If nullptr, the runtime implementation will choose the work-group - ///< size. + ///< If nullptr, the runtime implementation will choose the work-group size. uint32_t numEventsInWaitList, ///< [in] size of the event wait list const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait - ///< event. + ///< If nullptr, the numEventsInWaitList must be 0, indicating that no wait event. ur_event_handle_t * phEvent ///< [out][optional] return an event object that identifies this particular ///< kernel execution instance. @@ -7253,8 +7243,7 @@ ur_result_t UR_APICALL urEnqueueTimestampRecordingExp( const ur_event_handle_t * phEventWaitList, ///< [in][optional][range(0, numEventsInWaitList)] pointer to a list of ///< events that must be complete before the kernel execution. - ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait - ///< events. + ///< If nullptr, the numEventsInWaitList must be 0, indicating no wait events. ur_event_handle_t * phEvent ///< [in,out] return an event object that identifies this particular kernel ///< execution instance. Profiling information can be queried