Merge pull request #396 from veselypeta/petr/small-spec-fixes

[ur] Fix yaml problems
oneapi-src · Mar 30, 2023 · dfb0d75 · dfb0d75
2 parents cdca7c1 + 9f00a5b
commit dfb0d75
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/include/ur.py b/include/ur.py
@@ -1017,7 +1017,10 @@ class ur_usm_desc_t(Structure):
         ("pNext", c_void_p),                                            ## [in][optional] pointer to extension-specific structure
         ("flags", ur_usm_flags_t),                                      ## [in] memory allocation flags.
         ("hints", ur_usm_advice_t),                                     ## [in] Memory advice hints
-        ("align", c_ulong)                                              ## [in] memory advice hints.
+        ("align", c_ulong)                                              ## [in] alignment of the USM memory object
+                                                                        ## 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`.
     ]
 
 ###############################################################################

diff --git a/include/ur_api.h b/include/ur_api.h
@@ -1108,7 +1108,7 @@ urDeviceCreateWithNativeHandle(
 );
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief static
+/// @brief Returns synchronized Host and Device global timestamps.
 ///
 /// @details
 ///     - The application may call this function from simultaneous threads for
@@ -2226,7 +2226,10 @@ typedef struct ur_usm_desc_t {
     const void *pNext;         ///< [in][optional] pointer to extension-specific structure
     ur_usm_flags_t flags;      ///< [in] memory allocation flags.
     ur_usm_advice_t hints;     ///< [in] Memory advice hints
-    uint32_t align;            ///< [in] memory advice hints.
+    uint32_t align;            ///< [in] alignment of the USM memory object
+                               ///< 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`.
 
 } ur_usm_desc_t;
 

diff --git a/scripts/core/device.yml b/scripts/core/device.yml
@@ -664,7 +664,7 @@ type: function
 desc: "Returns synchronized Host and Device global timestamps."
 class: $xDevice
 name: GetGlobalTimestamps
-desc: static
+decl: static
 ordinal: "0"
 analogue:
     - "**clGetDeviceAndHostTimer**"

diff --git a/scripts/core/usm.yml b/scripts/core/usm.yml
@@ -132,7 +132,6 @@ members:
             [in] alignment of the USM memory object
             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`.
-      desc: "[in] memory advice hints."
 --- #--------------------------------------------------------------------------
 type: struct 
 desc: "USM host allocation descriptor type."

diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -604,7 +604,7 @@ ur_result_t UR_APICALL urDeviceCreateWithNativeHandle(
 }
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief static
+/// @brief Returns synchronized Host and Device global timestamps.
 ///
 /// @details
 ///     - The application may call this function from simultaneous threads for

diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -521,7 +521,7 @@ ur_result_t UR_APICALL urDeviceCreateWithNativeHandle(
 }
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief static
+/// @brief Returns synchronized Host and Device global timestamps.
 ///
 /// @details
 ///     - The application may call this function from simultaneous threads for