Commit e91f8401 authored by Rodrigo Siqueira's avatar Rodrigo Siqueira Committed by Alex Deucher
Browse files

Documentation/gpu: Reorganize DC documentation 



Display core documentation is not well organized, and it is hard to find
information due to the lack of sections. This commit reorganizes the
documentation layout, and it is preparation work for future changes.

Changes since V1:
- Christian: Group amdgpu documentation together.
- Daniel: Drop redundant amdgpu prefix.
- Jani: Create index pages.
- Yann: Mirror display folder in the documentation.

Reviewed-by: default avatarYann Dirson <ydirson@free.fr>
Reviewed-by: default avatarHarry Wentland <harry.wentland@amd.com>
Signed-off-by: default avatarRodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Signed-off-by: default avatarAlex Deucher <alexander.deucher@amd.com>
parent 6ff7fddb

Documentation/gpu/amdgpu/display/dc-debug.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
Display Core Debug tools

========================



TODO

Documentation/gpu/amdgpu/display/display-manager.rst

0 → 100644
+42 −0
Original line number Diff line number Diff line 
======================

AMDgpu Display Manager

======================



.. contents:: Table of Contents

    :depth: 3



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: overview



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h

   :internal:



Lifecycle

=========



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: DM Lifecycle



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: dm_hw_init dm_hw_fini



Interrupts

==========



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c

   :doc: overview



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c

   :internal:



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq



Atomic Implementation

=====================



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: atomic



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail

Documentation/gpu/amdgpu-dc.rst→Documentation/gpu/amdgpu/display/index.rst

+29 −0
Original line number Diff line number Diff line
@@ -21,54 +21,9 @@ Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`. 


To determine if DC is loaded, search dmesg for the following entry:



``Display Core initialized with <version number here>``



AMDgpu Display Manager

======================



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: overview



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h

   :internal:



Lifecycle

---------



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: DM Lifecycle



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: dm_hw_init dm_hw_fini



Interrupts

----------



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c

   :doc: overview

.. toctree::



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c

   :internal:

   display-manager.rst

   dc-debug.rst



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq



Atomic Implementation

---------------------



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: atomic



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail



Display Core

============



**WIP**



FreeSync Video

--------------



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: FreeSync Video
 
``Display Core initialized with <version number here>``

Documentation/gpu/amdgpu.rst→Documentation/gpu/amdgpu/index.rst

+15 −3
Original line number Diff line number Diff line 
=========================

==========================

 drm/amdgpu AMDgpu driver

=========================

==========================



The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core

Next (GCN) architecture.
@@ -71,7 +71,7 @@ Interrupt Handling 
   :internal:



IP Blocks

------------------

---------



.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h

   :doc: IP Blocks
@@ -79,6 +79,18 @@ IP Blocks 
.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h

   :identifiers: amd_ip_block_type amd_ip_funcs



Display Core

============



This section covers Display core.



.. toctree::



  display/index



.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c

   :doc: overview



AMDGPU XGMI Support

===================

Documentation/gpu/drivers.rst

+1 −2
Original line number Diff line number Diff line
@@ -4,8 +4,7 @@ GPU Driver Documentation 


.. toctree::



   amdgpu

   amdgpu-dc

   amdgpu/index

   i915

   mcde

   meson