[igt-dev] [PATCH i-g-t v2 2/5] llib/amd: Update function documentation

[Alex Hung]

Reviewed-by: Alex Hung <alex.hung at amd.com>

On 2023-11-03 12:22, Aurabindo Pillai wrote:
> The existing documetation incorrectly specifies the return value.
> Update the doc entry for functions that check MALL status
> 
> Signed-off-by: Aurabindo Pillai <aurabindo.pillai at amd.com>
> ---
>   lib/igt_amd.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/lib/igt_amd.c b/lib/igt_amd.c
> index f0fbe97ef..8c736b3e2 100644
> --- a/lib/igt_amd.c
> +++ b/lib/igt_amd.c
> @@ -1178,8 +1178,8 @@ static bool get_dm_capabilities(int drm_fd, char *buf, size_t size)
>    * @brief check if AMDGPU mall_capable interface entry exist and defined
>    *
>    * @param drm_fd DRM file descriptor
> - * @return true if dm capabilities interface exists and MALL is supported
> - * @return false if capabilities could not be read.
> + * @param supported will be set to true if hardware supports MALL
> + * @param enabled will be set to true if MALL is currently in use
>    */
>   void igt_amd_get_mall_status(int drm_fd, bool *supported, bool *enabled)
>   {