<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<style type="text/css" style="display:none;"> P {margin-top:0;margin-bottom:0;} </style>
</head>
<body dir="ltr">
<p style="font-family:Calibri;font-size:10pt;color:#0000FF;margin:5pt;font-style:normal;font-weight:normal;text-decoration:none;" align="Left">
[AMD Official Use Only - AMD Internal Distribution Only]<br>
</p>
<br>
<div>
<div class="elementToProof" style="font-family: Aptos, Aptos_EmbeddedFont, Aptos_MSFontService, Calibri, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
Reviewed-by: Aurabindo Pillai <aurabindo.pillai@amd.com></div>
<div id="Signature" class="elementToProof">
<div class="elementToProof" style="font-family: Aptos, Aptos_EmbeddedFont, Aptos_MSFontService, Calibri, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
<br>
</div>
<div class="elementToProof" style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
--</div>
<div class="elementToProof" style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
<br>
</div>
<div class="elementToProof" style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
Regards,</div>
<div class="elementToProof" style="font-family: Calibri, Arial, Helvetica, sans-serif; font-size: 12pt; color: rgb(0, 0, 0);">
Jay<br>
</div>
</div>
<div id="appendonsend"></div>
<hr style="display:inline-block;width:98%" tabindex="-1">
<div id="divRplyFwdMsg" dir="ltr"><font face="Calibri, sans-serif" style="font-size:11pt" color="#000000"><b>From:</b> SHANMUGAM, SRINIVASAN <SRINIVASAN.SHANMUGAM@amd.com><br>
<b>Sent:</b> Thursday, June 12, 2025 11:10 AM<br>
<b>To:</b> Pillai, Aurabindo <Aurabindo.Pillai@amd.com><br>
<b>Cc:</b> amd-gfx@lists.freedesktop.org <amd-gfx@lists.freedesktop.org>; SHANMUGAM, SRINIVASAN <SRINIVASAN.SHANMUGAM@amd.com>; Chung, ChiaHsuan (Tom) <ChiaHsuan.Chung@amd.com>; Li, Roman <Roman.Li@amd.com>; Hung, Alex <Alex.Hung@amd.com>; Wentland, Harry <Harry.Wentland@amd.com><br>
<b>Subject:</b> [PATCH] drm/amd/display: Fix annotations for dc state functions</font>
<div> </div>
</div>
<div class="BodyFragment"><font size="2"><span style="font-size:11pt;">
<div class="PlainText">This patch addresses inconsistencies in the annotations for the<br>
following functions:<br>
<br>
- **dc_get_power_profile_for_dc_state**: Standardized parameter and<br>
return value annotations.<br>
- **dc_get_det_buffer_size_from_state**: Clarified parameter<br>
documentation for better understanding.<br>
- **dc_get_host_router_index**: Corrected parameter descriptions to<br>
follow documentation conventions.<br>
<br>
Fixes the below:<br>
drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:6386: warning: Cannot understand ***************<br>
<br>
Cc: Tom Chung <chiahsuan.chung@amd.com><br>
Cc: Roman Li <roman.li@amd.com><br>
Cc: Alex Hung <alex.hung@amd.com><br>
Cc: Aurabindo Pillai <aurabindo.pillai@amd.com><br>
Cc: Harry Wentland <harry.wentland@amd.com><br>
Signed-off-by: Srinivasan Shanmugam <srinivasan.shanmugam@amd.com><br>
---<br>
drivers/gpu/drm/amd/display/dc/core/dc.c | 25 ++++++++++++------------<br>
1 file changed, 13 insertions(+), 12 deletions(-)<br>
<br>
diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c b/drivers/gpu/drm/amd/display/dc/core/dc.c<br>
index eaf44e6046b5..0146ad4e23c8 100644<br>
--- a/drivers/gpu/drm/amd/display/dc/core/dc.c<br>
+++ b/drivers/gpu/drm/amd/display/dc/core/dc.c<br>
@@ -6343,13 +6343,14 @@ void dc_set_edp_power(const struct dc *dc, struct dc_link *edp_link,<br>
edp_link->dc->link_srv->edp_set_panel_power(edp_link, powerOn);<br>
}<br>
<br>
-/*<br>
- *****************************************************************************<br>
+/**<br>
* dc_get_power_profile_for_dc_state() - extracts power profile from dc state<br>
*<br>
* Called when DM wants to make power policy decisions based on dc_state<br>
*<br>
- *****************************************************************************<br>
+ * @context: Pointer to the dc_state from which the power profile is extracted.<br>
+ *<br>
+ * Return: The power profile structure containing the power level information.<br>
*/<br>
struct dc_power_profile dc_get_power_profile_for_dc_state(const struct dc_state *context)<br>
{<br>
@@ -6365,13 +6366,14 @@ struct dc_power_profile dc_get_power_profile_for_dc_state(const struct dc_state<br>
return profile;<br>
}<br>
<br>
-/*<br>
- **********************************************************************************<br>
+/**<br>
* dc_get_det_buffer_size_from_state() - extracts detile buffer size from dc state<br>
*<br>
- * Called when DM wants to log detile buffer size from dc_state<br>
+ * This function is called to log the detile buffer size from the dc_state.<br>
+ *<br>
+ * @context: a pointer to the dc_state from which the detile buffer size is extracted.<br>
*<br>
- **********************************************************************************<br>
+ * Return: the size of the detile buffer, or 0 if not available.<br>
*/<br>
unsigned int dc_get_det_buffer_size_from_state(const struct dc_state *context)<br>
{<br>
@@ -6382,18 +6384,17 @@ unsigned int dc_get_det_buffer_size_from_state(const struct dc_state *context)<br>
else<br>
return 0;<br>
}<br>
+<br>
/**<br>
- ***********************************************************************************************<br>
* dc_get_host_router_index: Get index of host router from a dpia link<br>
*<br>
* This function return a host router index of the target link. If the target link is dpia link.<br>
*<br>
- * @param [in] link: target link<br>
- * @param [out] host_router_index: host router index of the target link<br>
+ * @link: Pointer to the target link (input)<br>
+ * @host_router_index: Pointer to store the host router index of the target link (output).<br>
*<br>
- * @return: true if the host router index is found and valid.<br>
+ * Return: true if the host router index is found and valid.<br>
*<br>
- ***********************************************************************************************<br>
*/<br>
bool dc_get_host_router_index(const struct dc_link *link, unsigned int *host_router_index)<br>
{<br>
-- <br>
2.34.1<br>
<br>
</div>
</span></font></div>
</div>
</body>
</html>