SWDEV-292523 - Marking streamOperations as a Beta feature in documentation

Change-Id: Ib7323ff92df1bd111891b0c7c5e69b31e8ad8e68


[ROCm/hip commit: 8dfb12b6d2]
This commit is contained in:
Sourabh Betigeri
2021-07-29 11:18:59 -07:00
committed by Sourabh Betigeri
orang tua 6c8eeb09d7
melakukan 7b495c34e0
+16 -4
Melihat File
@@ -1659,7 +1659,7 @@ hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback
* This section describes Stream Memory Wait and Write functions of HIP runtime API.
*/
/**
* @brief Enqueues a wait command to the stream.
* @brief Enqueues a wait command to the stream.[BETA]
*
* @param [in] stream - Stream identifier
* @param [in] ptr - Pointer to memory object allocated using 'hipMallocSignalMemory' flag
@@ -1684,13 +1684,16 @@ hipError_t hipStreamAddCallback(hipStream_t stream, hipStreamCallback_t callback
* @note Support for hipStreamWaitValue32 can be queried using 'hipDeviceGetAttribute()' and
* 'hipDeviceAttributeCanUseStreamWaitValue' flag.
*
* @beta This API is marked as beta, meaning, while this is feature complete,
* it is still open to changes and may have outstanding issues.
*
* @see hipExtMallocWithFlags, hipFree, hipStreamWaitValue64, hipStreamWriteValue64,
* hipStreamWriteValue32, hipDeviceGetAttribute
*/
hipError_t hipStreamWaitValue32(hipStream_t stream, void* ptr, uint32_t value, unsigned int flags,
uint32_t mask __dparm(0xFFFFFFFF));
/**
* @brief Enqueues a wait command to the stream.
* @brief Enqueues a wait command to the stream.[BETA]
*
* @param [in] stream - Stream identifier
* @param [in] ptr - Pointer to memory object allocated using 'hipMallocSignalMemory' flag
@@ -1715,13 +1718,16 @@ hipError_t hipStreamWaitValue32(hipStream_t stream, void* ptr, uint32_t value, u
* @note Support for hipStreamWaitValue64 can be queried using 'hipDeviceGetAttribute()' and
* 'hipDeviceAttributeCanUseStreamWaitValue' flag.
*
* @beta This API is marked as beta, meaning, while this is feature complete,
* it is still open to changes and may have outstanding issues.
*
* @see hipExtMallocWithFlags, hipFree, hipStreamWaitValue32, hipStreamWriteValue64,
* hipStreamWriteValue32, hipDeviceGetAttribute
*/
hipError_t hipStreamWaitValue64(hipStream_t stream, void* ptr, uint64_t value, unsigned int flags,
uint64_t mask __dparm(0xFFFFFFFFFFFFFFFF));
/**
* @brief Enqueues a write command to the stream.
* @brief Enqueues a write command to the stream.[BETA]
*
* @param [in] stream - Stream identifier
* @param [in] ptr - Pointer to a GPU accessible memory object
@@ -1733,12 +1739,15 @@ hipError_t hipStreamWaitValue64(hipStream_t stream, void* ptr, uint64_t value, u
* Enqueues a write command to the stream, write operation is performed after all earlier commands
* on this stream have completed the execution.
*
* @beta This API is marked as beta, meaning, while this is feature complete,
* it is still open to changes and may have outstanding issues.
*
* @see hipExtMallocWithFlags, hipFree, hipStreamWriteValue32, hipStreamWaitValue32,
* hipStreamWaitValue64
*/
hipError_t hipStreamWriteValue32(hipStream_t stream, void* ptr, uint32_t value, unsigned int flags);
/**
* @brief Enqueues a write command to the stream.
* @brief Enqueues a write command to the stream.[BETA]
*
* @param [in] stream - Stream identifier
* @param [in] ptr - Pointer to a GPU accessible memory object
@@ -1750,6 +1759,9 @@ hipError_t hipStreamWriteValue32(hipStream_t stream, void* ptr, uint32_t value,
* Enqueues a write command to the stream, write operation is performed after all earlier commands
* on this stream have completed the execution.
*
* @beta This API is marked as beta, meaning, while this is feature complete,
* it is still open to changes and may have outstanding issues.
*
* @see hipExtMallocWithFlags, hipFree, hipStreamWriteValue32, hipStreamWaitValue32,
* hipStreamWaitValue64
*/