Merge pull request #230 from AMD-ROCm-Internal/amd/dev/todli/6.4.2/SWDEV-541096_addEventWaitExternal

Auto-submit by Jenkins

Author: rocm-devops

include/hip/hip_runtime_api.h

@@ -692,6 +692,13 @@ enum hipLimit_t {
 /** Event is captured in the graph as an external event node when performing stream capture. */
 #define hipEventRecordExternal 0x01
 
+//Flags that can be used with hipStreamWaitEvent.
+/** Default flag. */
+#define hipEventWaitDefault 0x00
+
+/** Wait is captured in the graph as an external event node when performing stream capture. */
+#define hipEventWaitExternal 0x01
+
 /** Disable performing a system scope sequentially consistent memory fence when the event
  * transitions from recording to recorded.  This can be used for events that are only being
  * used to measure timing, and do not require the event inspection operations
@@ -2645,16 +2652,22 @@ hipError_t hipStreamSynchronize(hipStream_t stream);
 /**
  * @brief Make the specified compute stream wait for an event
  *
- * @param[in] stream stream to make wait.
- * @param[in] event event to wait on
- * @param[in] flags control operation [must be 0]
+ * @param[in] stream  Stream to make wait
+ * @param[in] event  Event to wait on
+ * @param[in] flags  Parameters to control the operation
  *
- * @returns #hipSuccess, #hipErrorInvalidHandle
+ * @returns #hipSuccess, #hipErrorInvalidHandle, #hipErrorInvalidValue,
+ * #hipErrorStreamCaptureIsolation
  *
  * This function inserts a wait operation into the specified stream.
  * All future work submitted to @p stream will wait until @p event reports completion before
  * beginning execution.
  *
+ * Flags include:
+ *   hipEventWaitDefault: Default event creation flag.
+ *   hipEventWaitExternal: Wait is captured in the graph as an external event node when
+ *                           performing stream capture
+ *
  * This function only waits for commands in the current stream to complete.  Notably, this function
  * does not implicitly wait for commands in the default stream to complete, even if the specified
  * stream is created with hipStreamNonBlocking = 0.