Skip to content

Commit

Permalink
SWDEV-450926 - Add doxygen in hipGetProcAddress API
Browse files Browse the repository at this point in the history
Change-Id: I3dc43b48f043df294ce0082133828e35b513e7e1
  • Loading branch information
jujiang-del committed May 13, 2024
1 parent 6967baf commit aa1a41d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions include/hip/hip_runtime_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -4234,14 +4234,23 @@ hipError_t hipGetSymbolAddress(void** devPtr, const void* symbol);
hipError_t hipGetSymbolSize(size_t* size, const void* symbol);

/**
* @brief Gets the symbol's function address
* @brief Gets the pointer of requested HIP driver function.
*
* @param[in] symbol symbol name in char*
* @param[out] pfn output pointer to symbol
* @param[in] hipVersion version of the function requested. Rocm 6.0.1 = 601
* @param[in] flags currently there is no flags other than default
* @param[out] symbolStatus optional enum returned to indicate what part failed
* @return #hipSuccess, #hipErrorInvalidValue
* @param[in] symbol The Symbol name of the driver function to request.
* @param[out] pfn Output pointer to the requested driver function.
* @param[in] hipVersion The HIP version for the requested driver function symbol.
* HIP version is defined as 100*version_major + version_minor. For example, in HIP 6.1, the
* hipversion is 601, for the symbol function "hipGetDeviceProperties", the specified hipVersion 601
* is greater or equal to the version 600, the symbol function will be handle properly as backend
* compatible function.
*
* @param[in] flags Currently only default flag is suppported.
* @param[out] symbolStatus Optional enumeration for returned status of searching for symbol driver
* function based on the input hipVersion.
*
* Returns hipSuccess if the returned pfn is addressed to the pointer of found driver function.
*
* @return #hipSuccess, #hipErrorInvalidValue.
*/
hipError_t hipGetProcAddress(const char* symbol, void** pfn, int hipVersion, uint64_t flags,
hipDriverProcAddressQueryResult* symbolStatus);
Expand Down

0 comments on commit aa1a41d

Please sign in to comment.