Remove MemImageFill MemImageMap from the spec.

Previously these were "hidden" entry points excluded from generating any code by setting their versions to "9999.0". Issue oneapi-src#50 goes into detail about why this was done, and concludes that the entry points should be removed but we never got around to it at the time.
aarongreig · Nov 22, 2023 · 4392e20 · 4392e20
1 parent 04799e7
commit 4392e20
Showing 1 changed file with 0 additions and 115 deletions.
diff --git a/scripts/core/enqueue.yml b/scripts/core/enqueue.yml
@@ -738,58 +738,6 @@ returns:
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES
 --- #--------------------------------------------------------------------------
-type: function
-desc: "Enqueue a command to fill an image object with specified color" 
-class: $xEnqueue
-name: MemImageFill
-ordinal: "0"
-version: "9999.0" # see #50
-details:
-    - "Currently not implemented in Level Zero"
-    - "TODO: add a driver function in Level Zero?"
-analogue:
-    - "**clEnqueueFillImage**"
-params:
-    - type: $x_queue_handle_t
-      name: hQueue
-      desc: "[in] handle of the queue object"
-    - type: $x_mem_handle_t
-      name: hImage
-      desc: "[in] handle of the image object"
-    - type: "const void*"
-      name: pFillColor
-      desc: |
-            [in] the color used to fill the image: single floating point value if the channel order is DEPTH,
-            otherwise, a four components RGBA values of various types depending on the image channel data type.
-    - type: "const size_t*"
-      name: pOrigin
-      desc: "[in] TODO change the type to $x_rect_offset_t"
-    - type: "const size_t*"
-      name: pRegion
-      desc: "[in] TODO: change the type to $x_rect_region_t"
-    - type: uint32_t
-      name: numEventsInWaitList
-      desc: "[in] size of the event wait list"
-    - type: "const $x_event_handle_t*"
-      name: phEventWaitList
-      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 this command does not wait on any event to complete.
-    - type: $x_event_handle_t*
-      name: phEvent
-      desc: |
-            [out][optional] return an event object that identifies this particular command instance.
-returns:      
-    - $X_RESULT_ERROR_INVALID_QUEUE
-    - $X_RESULT_ERROR_INVALID_EVENT
-    - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
-        - "`phEventWaitList == NULL && numEventsInWaitList > 0`"
-        - "`phEventWaitList != NULL && numEventsInWaitList == 0`"
-        - "If event objects in phEventWaitList are not valid events."
-    - $X_RESULT_ERROR_INVALID_MEM_OBJECT
-    - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
-    - $X_RESULT_ERROR_OUT_OF_RESOURCES
---- #--------------------------------------------------------------------------
 type: enum
 desc: "Map flags"
 class: $xDevice
@@ -873,69 +821,6 @@ 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" 
-class: $xEnqueue
-name: MemImageMap
-version: "9999.0" # See #50
-ordinal: "0"
-details:
-    - "Input parameter blockingMap indicates if the map is blocking or non-blocking."
-    - "TODO: Not implemented in PI and no direct support in Leverl Zero."
-    - "TODO: add a driver function in Level Zero?"
-analogue:
-    - "**clEnqueueMapImage**"
-params:
-    - type: $x_queue_handle_t
-      name: hQueue
-      desc: "[in] handle of the queue object"
-    - type: $x_mem_handle_t
-      name: hImage
-      desc: "[in] handle of the image object"
-    - type: bool
-      name: blockingMap
-      desc: "[in] indicates blocking (true), non-blocking (false)"
-    - type: $x_map_flags_t
-      name: mapFlags
-      desc: "[in] flags for read, write, readwrite mapping"
-    - type: $x_rect_offset_t
-      name: origin
-      desc: "[in] defines the (x,y,z) offset in pixels in the 1D, 2D, or 3D image"
-    - type: $x_rect_region_t
-      name: region
-      desc: "[in] defines the (width, height, depth) in pixels of the 1D, 2D, or 3D image"
-    - type: size_t
-      name: imageRowPitch
-      desc: "[in] length of each row in bytes"
-    - type: size_t
-      name: imageSlicePitch
-      desc: "[in] length of each 2D slice of the 3D image"
-    - type: void**
-      name: ppRetMap
-      desc: "[in,out] return mapped pointer"
-    - type: uint32_t
-      name: numEventsInWaitList
-      desc: "[in] size of the event wait list"
-    - type: "const $x_event_handle_t*"
-      name: phEventWaitList
-      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 this command does not wait on any event to complete.
-    - type: $x_event_handle_t*
-      name: phEvent
-      desc: |
-            [out][optional] return an event object that identifies this particular command instance.
-returns:      
-    - $X_RESULT_ERROR_INVALID_QUEUE
-    - $X_RESULT_ERROR_INVALID_EVENT
-    - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
-        - "`phEventWaitList == NULL && numEventsInWaitList > 0`"
-        - "`phEventWaitList != NULL && numEventsInWaitList == 0`"
-        - "If event objects in phEventWaitList are not valid events."
-    - $X_RESULT_ERROR_INVALID_MEM_OBJECT
-    - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
-    - $X_RESULT_ERROR_OUT_OF_RESOURCES
---- #--------------------------------------------------------------------------
-type: function
 desc: "Enqueue a command to unmap a previously mapped region of a memory object" 
 class: $xEnqueue
 name: MemUnmap