Skip to content

Commit

Permalink
Fix hsa_amd_agents_allow_access documentation
Browse files Browse the repository at this point in the history
 - Update the documentation comment in hsa_ext_amd.h, which contained
   contradictory and incorrect information about an argument to the
   hsa_amd_agents_allow_access function.
  • Loading branch information
Nathan O authored and Nathan O committed Apr 3, 2020
1 parent e252867 commit 6973bd4
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/inc/hsa_ext_amd.h
Original file line number Diff line number Diff line change
Expand Up @@ -1167,8 +1167,7 @@ hsa_status_t HSA_API hsa_amd_agent_memory_pool_get_info(
* ignored.
*
* @param[in] flags A list of bit-field that is used to specify access
* information in a per-agent basis. The size of this list must match that of @p
* agents. Must be NULL.
* information in a per-agent basis. This is currently reserved and must be NULL.
*
* @param[in] ptr A buffer previously allocated using ::hsa_amd_memory_pool_allocate.
*
Expand All @@ -1178,8 +1177,8 @@ hsa_status_t HSA_API hsa_amd_agent_memory_pool_get_info(
* initialized.
*
* @retval ::HSA_STATUS_ERROR_INVALID_ARGUMENT @p num_agents is 0, or @p agents
* is NULL, @p flags is NULL, or attempting to enable access to agent(s) because
* @p ptr is allocated from an inaccessible pool.
* is NULL, @p flags is not NULL, or attempting to enable access to agent(s)
* because @p ptr is allocated from an inaccessible pool.
*
*/
hsa_status_t HSA_API
Expand Down

0 comments on commit 6973bd4

Please sign in to comment.