Add new function definition to exp-multi-device-compile extension

Author: againull

scripts/core/EXP-MULTI-DEVICE-COMPILE.rst

@@ -38,15 +38,19 @@ Functions
 * ${x}ProgramBuildExp
 * ${x}ProgramCompileExp
 * ${x}ProgramLinkExp
+* ${x}ProgramCreateWithBinaryExp
 
 Changelog
 --------------------------------------------------------------------------------
 
-+-----------+------------------------+
-| Revision  | Changes                |
-+===========+========================+
-| 1.0       | Initial Draft           |
-+-----------+------------------------+
++-----------+-----------------------------------------------+
+| Revision  | Changes                                       |
++===========+===============================================+
+| 1.0       | Initial Draft                                 |
++-----------+-----------------------------------------------+
+| 1.1       | Add function definition for program creation  |
+|           | from multiple device binaries                 |
++-----------+-----------------------------------------------+
 
 Support
 --------------------------------------------------------------------------------

scripts/core/exp-multi-device-compile.yml

@@ -124,3 +124,47 @@ returns:
       - "`count == 0`"
     - $X_RESULT_ERROR_PROGRAM_LINK_FAILURE:
       - "If an error occurred while linking `phPrograms`."
+
+--- #--------------------------------------------------------------------------
+type: function
+desc: "Create a program object from native binaries for the specified devices."
+class: $xProgram
+name: CreateWithBinaryExp
+decl: static
+ordinal: "5"
+analogue:
+    - "**clCreateProgramWithBinary**"
+details:
+    - "The application may call this function from simultaneous threads."
+    - "Following a successful call to this entry point, `phProgram` will contain binaries of type $X_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or $X_PROGRAM_BINARY_TYPE_LIBRARY for the specified devices in `phDevices`."
+    - "The devices specified by `phDevices` must be associated with the context."
+    - "The adapter may (but is not required to) perform validation of the provided modules during this call."
+params:
+    - type: $x_context_handle_t
+      name: hContext
+      desc: "[in] handle of the context instance"
+    - type: uint32_t
+      name: numDevices
+      desc: "[in] number of devices"
+    - type: $x_device_handle_t*
+      name: phDevices
+      desc: "[in][range(0, numDevices)] a pointer to a list of device handles. The binaries are loaded for devices specified in this list."
+    - type: size_t*
+      name: pLengths
+      desc: "[in][range(0, numDevices)] array of sizes of program binaries specified by `pBinaries` (in bytes)."
+    - type: const uint8_t**
+      name: ppBinaries
+      desc: "[in][range(0, numDevices)] pointer to program binaries to be loaded for devices specified by `phDevices`."
+    - type: const $x_program_properties_t*
+      name: pProperties
+      desc: "[in][optional] pointer to program creation properties."
+    - type: $x_program_handle_t*
+      name: phProgram
+      desc: "[out] pointer to handle of Program object created."
+returns:
+    - $X_RESULT_ERROR_INVALID_NULL_POINTER:
+        - "`NULL != pProperties && pProperties->count > 0 && NULL == pProperties->pMetadatas`"
+    - $X_RESULT_ERROR_INVALID_SIZE:
+        - "`NULL != pProperties && NULL != pProperties->pMetadatas && pProperties->count == 0`"
+    - $X_RESULT_ERROR_INVALID_NATIVE_BINARY:
+        - "If any binary in `ppBinaries` isn't a valid binary for the corresponding device in `phDevices.`"