drm/amd/display: Start documentation of DC

Browse source

[Why]
There are a lot of unintuitive parts of the dm-dc interface.
It would help us if these were documented to provide
a common understanding of what they are supposed to do

[How]
Most of this documentation is stubs, to be filled out more
thoroughly by the experts

Not every dm-accessible function and struct is mentioned.
Simple functions like getters, setters, retain, release,
create, destroy can be left unadorned.

Signed-off-by: David Francis <David.Francis@amd.com>
Reviewed-by: Harry Wentland <Harry.Wentland@amd.com>
Acked-by: Leo Li <sunpeng.li@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>

...

This commit is contained in:

David Francis 2018-10-09 09:45:28 -04:00 • committed by Alex Deucher

parent c452de15cf

commit 2119aa17c9

6 changed files with 135 additions and 13 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

72

drivers/gpu/drm/amd/display/dc/core/dc.c

View file

21

drivers/gpu/drm/amd/display/dc/core/dc_link.c

View file

35

drivers/gpu/drm/amd/display/dc/core/dc_resource.c

View file

2

drivers/gpu/drm/amd/display/dc/core/dc_stream.c

View file

6

drivers/gpu/drm/amd/display/dc/dc_link.h

View file

12

drivers/gpu/drm/amd/display/dc/inc/core_types.h

View file