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 <alexander.deucher@amd.com>
Acked-by: Alex Deucher <alexander.deucher@amd.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Link: https://lore.kernel.org/dri-devel/20240715085918.68f5ecc9@canb.auug.org.au/
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

authored by

Rodrigo Siqueira and committed by

Alex Deucher 2 years ago 4cf300f6 5ae8fb97

+31 -14

3 changed files

expand all

Documentation

gpu

amdgpu

display

dcn-blocks.rst

drivers

gpu

drm

amd

display

link

hwss

link_hwss_dio.c

link_hwss_dio.h

+2 -5

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

··· 68 68 DIO 69 69 --- 70 70 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 72 72 :doc: overview 73 73 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 78 75 :internal:

+29

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

··· 26 26 #include "core_types.h" 27 27 #include "link_enc_cfg.h" 28 28 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 + 29 39 void set_dio_throttled_vcp_size(struct pipe_ctx *pipe_ctx, 30 40 struct fixed31_32 throttled_vcp_size) 31 41 { ··· 264 254 }, 265 255 }; 266 256 257 + /** 258 + * can_use_dio_link_hwss - Check if the link_hwss is accessible 259 + * 260 + * @link: Reference a link struct containing one or more sinks and the 261 + * connective status. 262 + * @link_res: Mappable hardware resource used to enable a link. 263 + * 264 + * Returns: 265 + * Return true if the link encoder is accessible from link. 266 + */ 267 267 bool can_use_dio_link_hwss(const struct dc_link *link, 268 268 const struct link_resource *link_res) 269 269 { 270 270 return link->link_enc != NULL; 271 271 } 272 272 273 + /** 274 + * get_dio_link_hwss - Return link_hwss reference 275 + * 276 + * This function behaves like a get function to return the link_hwss populated 277 + * in the link_hwss_dio.c file. 278 + * 279 + * Returns: 280 + * Return the reference to the filled struct of link_hwss. 281 + */ 273 282 const struct link_hwss *get_dio_link_hwss(void) 274 283 { 275 284 return &dio_link_hwss;

-9

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

··· 23 23 * 24 24 */ 25 25 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 - 35 26 #ifndef __LINK_HWSS_DIO_H__ 36 27 #define __LINK_HWSS_DIO_H__ 37 28

Configure Feed

Configure Feed