SWDEV-368819 - Add information on HIP APIs (#3135)

Change-Id: I0677280d14c3b813b4288682360824a20995eaf1

[ROCm/hip commit: 644456d438]
This commit is contained in:
ROCm CI Service Account
2023-02-11 00:02:01 +05:30
committad av GitHub
förälder cfe5794cd0
incheckning beccdec280
+7 -2
Visa fil
@@ -2594,12 +2594,16 @@ hipError_t hipEventQuery(hipEvent_t event);
hipError_t hipPointerSetAttribute(const void* value, hipPointer_attribute attribute, hipError_t hipPointerSetAttribute(const void* value, hipPointer_attribute attribute,
hipDeviceptr_t ptr); hipDeviceptr_t ptr);
/** /**
* @brief Return attributes for the specified pointer * @brief Return attributes for the specified pointer
* *
* @param [out] attributes attributes for the specified pointer * @param [out] attributes attributes for the specified pointer
* @param [in] ptr pointer to get attributes for * @param [in] ptr pointer to get attributes for
* *
* Note: To get pointer's memory type, the parameter attributes has 'type' as member variable.
* The 'type' indicates input pointer is allocated on device or host.
*
* @return #hipSuccess, #hipErrorInvalidDevice, #hipErrorInvalidValue * @return #hipSuccess, #hipErrorInvalidDevice, #hipErrorInvalidValue
* *
* @see hipPointerGetAttribute * @see hipPointerGetAttribute
@@ -2786,10 +2790,11 @@ hipError_t hipMemAllocHost(void** ptr, size_t size);
* @brief Allocate device accessible page locked host memory * @brief Allocate device accessible page locked host memory
* *
* @param[out] ptr Pointer to the allocated host pinned memory * @param[out] ptr Pointer to the allocated host pinned memory
* @param[in] size Requested memory size * @param[in] size Requested memory size in bytes
* @param[in] flags Type of host memory allocation * @param[in] flags Type of host memory allocation
* *
* If size is 0, no memory is allocated, *ptr returns nullptr, and hipSuccess is returned. * If size is 0, no memory is allocated, *ptr returns nullptr, and hipSuccess is returned.
* If no input for flags, it will be the default pinned memory allocation on the host.
* *
* @return #hipSuccess, #hipErrorOutOfMemory * @return #hipSuccess, #hipErrorOutOfMemory
* *
@@ -3304,7 +3309,7 @@ hipError_t hipMemPoolImportPointer(
* @brief Allocate device accessible page locked host memory [Deprecated] * @brief Allocate device accessible page locked host memory [Deprecated]
* *
* @param[out] ptr Pointer to the allocated host pinned memory * @param[out] ptr Pointer to the allocated host pinned memory
* @param[in] size Requested memory size * @param[in] size Requested memory size in bytes
* @param[in] flags Type of host memory allocation * @param[in] flags Type of host memory allocation
* *
* If size is 0, no memory is allocated, *ptr returns nullptr, and hipSuccess is returned. * If size is 0, no memory is allocated, *ptr returns nullptr, and hipSuccess is returned.