From 1d9eaae944c8760c73be7909694538a1cba29b7d Mon Sep 17 00:00:00 2001 From: David Yat Sin Date: Mon, 5 Feb 2024 22:39:19 +0000 Subject: [PATCH] Improve documentation for set_async_scratch_limit API Change-Id: I03ca986cdd468c7b167e119bd2f25d5c79ff2142 [ROCm/ROCR-Runtime commit: 0f30da58a7654c17999a1f32441c6d5b50dad533] --- .../rocr-runtime/runtime/hsa-runtime/inc/hsa_ext_amd.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/projects/rocr-runtime/runtime/hsa-runtime/inc/hsa_ext_amd.h b/projects/rocr-runtime/runtime/hsa-runtime/inc/hsa_ext_amd.h index 5117108f28..187bcd9587 100644 --- a/projects/rocr-runtime/runtime/hsa-runtime/inc/hsa_ext_amd.h +++ b/projects/rocr-runtime/runtime/hsa-runtime/inc/hsa_ext_amd.h @@ -3060,8 +3060,13 @@ hsa_status_t hsa_amd_vmem_get_alloc_properties_from_handle( /** * @brief Set the asynchronous scratch limit threshold on all the queues for this agent. * Dispatches that are enqueued on HW queues on this agent that are smaller than threshold will not - * result in a scratch use-once method. This API is only supported on devices that support - * asynchronous scratch reclaim. + * result in a scratch use-once method. + * + * Increasing this threshold will only increase the internal limit and not cause immediate allocation + * of additional scratch memory. Decreasing this threshold will result in a release in scratch memory + * on queues where the current amount of allocated scratch exceeds the new limit. + * + * This API is only supported on devices that support asynchronous scratch reclaim. * * @param[in] agent A valid agent. *