drm/amd/display: Start documentation of DC
authorDavid Francis <David.Francis@amd.com>
Tue, 9 Oct 2018 13:45:28 +0000 (09:45 -0400)
committerAlex Deucher <alexander.deucher@amd.com>
Fri, 30 Nov 2018 17:01:56 +0000 (12:01 -0500)
commit2119aa17c963e59710617c70bb7b59e89c5ff447
tree7096966f5a3afae3be4508770ad9dda51246a35a
parentc452de15cfe561b1af56dbf040c4006f43a6ec35
drm/amd/display: Start documentation of DC

[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>
drivers/gpu/drm/amd/display/dc/core/dc.c
drivers/gpu/drm/amd/display/dc/core/dc_link.c
drivers/gpu/drm/amd/display/dc/core/dc_resource.c
drivers/gpu/drm/amd/display/dc/core/dc_stream.c
drivers/gpu/drm/amd/display/dc/dc_link.h
drivers/gpu/drm/amd/display/dc/inc/core_types.h