Skip to content

Commit 4cf300f

Browse files
Rodrigo Siqueiraalexdeucher
authored andcommitted
drm/amd/display: Move DIO documentation to the right place
When building the kernel-doc, it complains with the below warning: ./drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h:1: warning: no structured comments found ./drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h:1: warning: no structured comments found This warning was caused by the wrong use of the ':export:' and the lack of function documentation in the file pointed under the ':internal:'. This commit addresses those issues by relocating the overview documentation to the correct C file, removing the ':export:' options, and adding two simple kernel-doc to ensure that ':internal:' does not have any warning. Cc: Alex Deucher <[email protected]> Acked-by: Alex Deucher <[email protected]> Reported-by: Stephen Rothwell <[email protected]> Link: https://lore.kernel.org/dri-devel/[email protected]/ Signed-off-by: Rodrigo Siqueira <[email protected]> Signed-off-by: Alex Deucher <[email protected]>
1 parent 5ae8fb9 commit 4cf300f

File tree

3 files changed

+31
-14
lines changed

3 files changed

+31
-14
lines changed

Documentation/gpu/amdgpu/display/dcn-blocks.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,8 @@ OPP
6868
DIO
6969
---
7070

71-
.. kernel-doc:: drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h
71+
.. kernel-doc:: drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.c
7272
:doc: overview
7373

74-
.. kernel-doc:: drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h
75-
:export:
76-
77-
.. kernel-doc:: drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h
74+
.. kernel-doc:: drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.c
7875
:internal:

drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.c

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@
2626
#include "core_types.h"
2727
#include "link_enc_cfg.h"
2828

29+
/**
30+
* DOC: overview
31+
*
32+
* Display Input Output (DIO), is the display input and output unit in DCN. It
33+
* includes output encoders to support different display output, like
34+
* DisplayPort, HDMI, DVI interface, and others. It also includes the control
35+
* and status channels for these interfaces.
36+
*/
37+
38+
2939
void set_dio_throttled_vcp_size(struct pipe_ctx *pipe_ctx,
3040
struct fixed31_32 throttled_vcp_size)
3141
{
@@ -254,12 +264,31 @@ static const struct link_hwss dio_link_hwss = {
254264
},
255265
};
256266

267+
/**
268+
* can_use_dio_link_hwss - Check if the link_hwss is accessible
269+
*
270+
* @link: Reference a link struct containing one or more sinks and the
271+
* connective status.
272+
* @link_res: Mappable hardware resource used to enable a link.
273+
*
274+
* Returns:
275+
* Return true if the link encoder is accessible from link.
276+
*/
257277
bool can_use_dio_link_hwss(const struct dc_link *link,
258278
const struct link_resource *link_res)
259279
{
260280
return link->link_enc != NULL;
261281
}
262282

283+
/**
284+
* get_dio_link_hwss - Return link_hwss reference
285+
*
286+
* This function behaves like a get function to return the link_hwss populated
287+
* in the link_hwss_dio.c file.
288+
*
289+
* Returns:
290+
* Return the reference to the filled struct of link_hwss.
291+
*/
263292
const struct link_hwss *get_dio_link_hwss(void)
264293
{
265294
return &dio_link_hwss;

drivers/gpu/drm/amd/display/dc/link/hwss/link_hwss_dio.h

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,6 @@
2323
*
2424
*/
2525

26-
/**
27-
* DOC: overview
28-
*
29-
* Display Input Output (DIO), is the display input and output unit in DCN. It
30-
* includes output encoders to support different display output, like
31-
* DisplayPort, HDMI, DVI interface, and others. It also includes the control
32-
* and status channels for these interfaces.
33-
*/
34-
3526
#ifndef __LINK_HWSS_DIO_H__
3627
#define __LINK_HWSS_DIO_H__
3728

0 commit comments

Comments
 (0)