Improve documentation for set_async_scratch_limit API

Change-Id: I03ca986cdd468c7b167e119bd2f25d5c79ff2142


[ROCm/ROCR-Runtime commit: 0f30da58a7]
This commit is contained in:
David Yat Sin
2024-02-05 22:39:19 +00:00
parent e5d4513c7b
commit 1d9eaae944
@@ -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.
*