SWDEV-456287 - clarify behavior of hipLaunchHostFunc

Change-Id: Ib86ff0abfd95881e5c0a9aae4a1e4da46de9b317
This commit is contained in:
Julia Jiang
2024-04-25 15:04:53 -04:00
committed by Julia Jiang
orang tua 5d99ac9045
melakukan 0c3d2a5e3f
+11 -2
Melihat File
@@ -5774,13 +5774,22 @@ hipError_t hipLaunchKernel(const void* function_address,
/**
* @brief Enqueues a host function call in a stream.
*
* @param [in] stream - stream to enqueue work to.
* @param [in] fn - function to call once operations enqueued preceeding are complete.
* @param [in] stream - The stream to enqueue work in.
* @param [in] fn - The function to call once enqueued preceeding operations are complete.
* @param [in] userData - User-specified data to be passed to the function.
*
* @returns #hipSuccess, #hipErrorInvalidResourceHandle, #hipErrorInvalidValue,
* #hipErrorNotSupported
*
* @warning : This API is marked as beta, meaning, while this is feature complete,
* it is still open to changes and may have outstanding issues.
*
* @note The function to call in this API will be executed after the preceding operations in the
* stream are complete. The function is a blocking operation that blocks operations in the stream
* that follow it, until the function is returned.
* Event synchronization and internal callback functions make sure enqueued operations will
* execute in order, in the stream.
*
*/
hipError_t hipLaunchHostFunc(hipStream_t stream, hipHostFn_t fn, void* userData);