From cca158588dec94f164f03ceb75cbfd62e8993326 Mon Sep 17 00:00:00 2001 From: ROCm CI Service Account <66695075+rocm-ci@users.noreply.github.com> Date: Wed, 15 Feb 2023 05:18:44 +0530 Subject: [PATCH] SWDEV-336460 - Update description for scratch allocation API (#3165) Change-Id: I95479cbebdbf41145b039b31caf4c6ddadb94bf5 [ROCm/hip commit: c604c1cb5625111d9fd20d321c14adb6c0427105] --- projects/hip/include/hip/hip_runtime_api.h | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/projects/hip/include/hip/hip_runtime_api.h b/projects/hip/include/hip/hip_runtime_api.h index 870f3ec5dd..55cda2d3f1 100644 --- a/projects/hip/include/hip/hip_runtime_api.h +++ b/projects/hip/include/hip/hip_runtime_api.h @@ -1705,21 +1705,25 @@ hipError_t hipDeviceSetCacheConfig(hipFuncCache_t cacheConfig); */ hipError_t hipDeviceGetCacheConfig(hipFuncCache_t* cacheConfig); /** - * @brief Get Resource limits of current device + * @brief Gets resource limits of current device + * The funtion querys the size of limit value, as required input enum hipLimit_t, can be either + * hipLimitStackSize, or hipLimitMallocHeapSize. * - * @param [out] pValue - * @param [in] limit + * @param [out] pValue returns the size of the limit in bytes + * @param [in] limit the limit to query * * @returns #hipSuccess, #hipErrorUnsupportedLimit, #hipErrorInvalidValue - * Note: Currently, only hipLimitMallocHeapSize is available * */ hipError_t hipDeviceGetLimit(size_t* pValue, enum hipLimit_t limit); /** - * @brief Set Resource limits of current device - * - * @param [in] limit - * @param [in] value + * @brief Sets resource limits of current device + * As the input enum limit, hipLimitStackSize sets the limit value of the stack size on current + * GPU devie, hipLimitMallocHeapSize sets the limit value of the heap used by the malloc()/free() + * calls. + * + * @param [in] limit enum of hipLimit_t to set + * @param [in] value the size of limit value in bytes * * @returns #hipSuccess, #hipErrorUnsupportedLimit, #hipErrorInvalidValue *