linux-toradex.git/Documentation/gpu/amdgpu/display, branch v6.16-rc6

Documentation: Remove repeated word in docs

2025-04-07T19:18:35+00:00

Remove the repeated word "the" in docs.

Signed-off-by: Charles Han 
Signed-off-by: Alex Deucher

Documentation/gpu: remove duplicate entries in different glossaries

2025-02-27T21:50:04+00:00

Some items were defined in both the general and DC glossaries.
Remove the duplicate entries.

Fixes: 2df30ae0ba0b ("Documentation/gpu: Add acronyms for some firmware components")
Reported-by: Stephen Rothwell 
Cc: Rodrigo Siqueira 
Reviewed-by: Rodrigo Siqueira 
Signed-off-by: Alex Deucher

Documentation/gpu/amdgpu: Add programming model for DCN

2024-10-24T22:07:05+00:00

One of the challenges to contributing to the display code is the
complexity of the DC component. This commit adds a documentation page
that discusses the programming model used by DCN and an overview of how
the display code is organized.

Cc: Leo Li 
Cc: Aurabindo Pillai 
Cc: Hamza Mahfooz 
Cc: Harry Wentland 
Cc: Mario Limonciello 
Cc: Christian Konig 
Cc: Alex Deucher 
Signed-off-by: Rodrigo Siqueira 
Reviewed-by: Harry Wentland 
Signed-off-by: Alex Deucher

Documentation/gpu: Document how to narrow down display issues

2024-10-24T22:06:57+00:00

The amdgpu driver is composed of multiple components, each of which can
be a source of some specific problem that the user/developer can see.
This commit introduces steps to narrow down and collect display
information.

Cc: Leo Li 
Cc: Aurabindo Pillai 
Cc: Hamza Mahfooz 
Cc: Harry Wentland 
Cc: Mario Limonciello 
Cc: Christian Konig 
Cc: Alex Deucher 
Signed-off-by: Rodrigo Siqueira 
Reviewed-by: Mario Limonciello 
Signed-off-by: Alex Deucher

Documentation/amdgpu: Fix duplicate declaration

2024-07-16T15:45:22+00:00

Address the below kernel doc warning:

Documentation/gpu/amdgpu/display/display-manager:134:
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:3: WARNING: Duplicate C
declaration, also defined at gpu/amdgpu/display/dcn-blocks:101.
Declaration is '.. c:struct:: mpcc_blnd_cfg'.
Documentation/gpu/amdgpu/display/display-manager:146:
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:3: WARNING: Duplicate C
declaration, also defined at gpu/amdgpu/display/dcn-blocks:3.
Declaration is '.. c:enum:: mpcc_alpha_blend_mode'.

To address the above warnings, this commit uses the 'no-identifiers'
option in the dcn-blocks to avoid duplication with the previous use of
this function doc in the display-manager file. Finally, replaces the
deprecated ':function:' in favor of ':identifiers:'.

Cc: Alex Deucher 
Acked-by: Alex Deucher 
Reported-by: Stephen Rothwell 
Signed-off-by: Rodrigo Siqueira 
Signed-off-by: Alex Deucher

Documentation/gpu: Remove undocumented files from dcn-blockshubbub.h

2024-07-16T15:45:16+00:00

The dchubbub.h and hubp.h do not have any meaningful documentation; for
this reason, this commit removes those files from the dcn-blocks
documentation.

Cc: Alex Deucher 
Acked-by: Alex Deucher 
Reported-by: Stephen Rothwell 
Signed-off-by: Rodrigo Siqueira 
Signed-off-by: Alex Deucher

Documentation/gpu: Adjust DCN documentation paths

2024-07-16T15:45:02+00:00

When building the kernel-doc, it has the following complaints:

Documentation/gpu/amdgpu/display/dcn-blocks:23:
drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h:3: WARNING: Duplicate C
declaration, also defined at gpu/amdgpu/display/dcn-blocks:3.

Declaration is '.. c:struct:: surface_flip_registers'.

Documentation/gpu/amdgpu/display/dcn-blocks:35:
drivers/gpu/drm/amd/display/dc/inc/hw/hubp.h:3: WARNING: Duplicate C
declaration, also defined at gpu/amdgpu/display/dcn-blocks:3.
Declaration is '.. c:struct:: surface_flip_registers'.

This error happened due to a copy-and-paste where the same file path was
duplicated multiple times to a different set of blocks. This commit
addresses this issue by using the correct file path.

Cc: Alex Deucher 
Acked-by: Alex Deucher 
Reported-by: Stephen Rothwell 
Signed-off-by: Rodrigo Siqueira 
Signed-off-by: Alex Deucher

Documentation/gpu: Remove ':export:' option from DCN documentation

2024-07-16T15:44:56+00:00

This commit reduces, but does not fix, all the occurrences and some of
the documentation warnings related to the 'no structured comments.' This
was caused by the wrong use of the ':export:' option in the DCN
kernel-doc, so this commit drops the usage of those options.

Acked-by: Alex Deucher 
Reported-by: Stephen Rothwell 
Signed-off-by: Rodrigo Siqueira 
Signed-off-by: Alex Deucher

drm/amd/display: Move DIO documentation to the right place

2024-07-16T15:44:49+00:00

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

Documentation/gpu: correct path of reference

2024-04-10T02:19:47+00:00

The path to GPU documentation is Documentation/gpu
rather than Documentation/GPU

This appears to have been introduced by commit ba162ae749a5
("Documentation/gpu: Introduce a simple contribution list for display code")

Flagged by make htmldocs.

Signed-off-by: Simon Horman 
Signed-off-by: Alex Deucher