[igt-dev] [PATCH i-g-t 3/4] lib/amd: Update function documentation

Aurabindo Pillai aurabindo.pillai at amd.com
Thu Nov 2 19:59:59 UTC 2023


The existing documetation incorrectly specifies the return value.
Update the doc entry for functions that check MALL and SubVP status

Signed-off-by: Aurabindo Pillai <aurabindo.pillai at amd.com>
---
 lib/igt_amd.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/lib/igt_amd.c b/lib/igt_amd.c
index e0c9d6a6d..355daf26f 100644
--- a/lib/igt_amd.c
+++ b/lib/igt_amd.c
@@ -1192,8 +1192,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)
 {
@@ -1219,8 +1219,8 @@ void igt_amd_get_mall_status(int drm_fd, bool *supported, bool *enabled)
  * @brief check if AMDGPU sub-viewport support exists
  *
  * @param drm_fd DRM file descriptor
- * @return true if dm capabilities interface exists and SubVP is supported
- * @return false if capabilities could not be read.
+ * @param supported set to true if harwdare supports subviewport
+ * @param enabled set tot true if subviewport is currently in use
  */
 void igt_amd_get_subvp_status(int drm_fd, bool *supported, bool *enabled)
 {
-- 
2.39.2



More information about the igt-dev mailing list