Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Aurabindo Pillai <aurabindo.pillai@amd.com>
To: <igt-dev@lists.freedesktop.org>
Subject: [igt-dev] [PATCH i-g-t 3/4] lib/amd: Update function documentation
Date: Thu, 2 Nov 2023 15:59:59 -0400	[thread overview]
Message-ID: <20231102200000.969208-3-aurabindo.pillai@amd.com> (raw)
In-Reply-To: <20231102200000.969208-1-aurabindo.pillai@amd.com>

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@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

  parent reply	other threads:[~2023-11-02 20:00 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-02 19:59 [igt-dev] [PATCH i-g-t 1/4] lib/amd: improve MALL capabilities checking logic Aurabindo Pillai
2023-11-02 19:59 ` [igt-dev] [PATCH i-g-t 2/4] lib/amd: Add check for SubVP feature status Aurabindo Pillai
2023-11-02 19:59 ` Aurabindo Pillai [this message]
2023-11-02 20:00 ` [igt-dev] [PATCH i-g-t 4/4] test/amdgpu: Add test for Sub-viewport Aurabindo Pillai
2023-11-03  9:21   ` Kamil Konieczny
2023-11-03 18:23     ` Aurabindo Pillai
2023-11-02 20:55 ` [igt-dev] ✓ Fi.CI.BAT: success for series starting with [i-g-t,1/4] lib/amd: improve MALL capabilities checking logic Patchwork
2023-11-02 21:32 ` [igt-dev] ✓ CI.xeBAT: " Patchwork
2023-11-03 17:11 ` [igt-dev] ✗ Fi.CI.IGT: failure " Patchwork

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231102200000.969208-3-aurabindo.pillai@amd.com \
    --to=aurabindo.pillai@amd.com \
    --cc=igt-dev@lists.freedesktop.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox