Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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: Yann Dirson <ydirson@free.fr>
Reviewed-by: Harry Wentland <harry.wentland@amd.com>
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
e91f8401
6ff7fddb
+91
-79
-74
Documentation/gpu/amdgpu-dc.rst
-74
Documentation/gpu/amdgpu-dc.rst
···
1
-
===================================
2
-
drm/amd/display - Display Core (DC)
3
-
===================================
4
-
5
-
*placeholder - general description of supported platforms, what dc is, etc.*
6
-
7
-
Because it is partially shared with other operating systems, the Display Core
8
-
Driver is divided in two pieces.
9
-
10
-
1. **Display Core (DC)** contains the OS-agnostic components. Things like
11
-
hardware programming and resource management are handled here.
12
-
2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the
13
-
amdgpu base driver and DRM are implemented here.
14
-
15
-
It doesn't help that the entire package is frequently referred to as DC. But
16
-
with the context in mind, it should be clear.
17
-
18
-
When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for
19
-
supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line.
20
-
Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`.
21
-
22
-
To determine if DC is loaded, search dmesg for the following entry:
23
-
24
-
``Display Core initialized with <version number here>``
25
-
26
-
AMDgpu Display Manager
27
-
======================
28
-
29
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
30
-
:doc: overview
31
-
32
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
33
-
:internal:
34
-
35
-
Lifecycle
36
-
---------
37
-
38
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
39
-
:doc: DM Lifecycle
40
-
41
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
42
-
:functions: dm_hw_init dm_hw_fini
43
-
44
-
Interrupts
45
-
----------
46
-
47
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
48
-
:doc: overview
49
-
50
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
51
-
:internal:
52
-
53
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
54
-
:functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq
55
-
56
-
Atomic Implementation
57
-
---------------------
58
-
59
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
60
-
:doc: atomic
61
-
62
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
63
-
:functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail
64
-
65
-
Display Core
66
-
============
67
-
68
-
**WIP**
69
-
70
-
FreeSync Video
71
-
--------------
72
-
73
-
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
74
-
:doc: FreeSync Video
+15
-3
Documentation/gpu/amdgpu.rst
Documentation/gpu/amdgpu/index.rst
+15
-3
Documentation/gpu/amdgpu.rst
Documentation/gpu/amdgpu/index.rst
···
1
-
=========================
1
+
==========================
2
2
drm/amdgpu AMDgpu driver
3
-
=========================
3
+
==========================
4
4
5
5
The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
6
6
Next (GCN) architecture.
···
71
71
:internal:
72
72
73
73
IP Blocks
74
-
------------------
74
+
---------
75
75
76
76
.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h
77
77
:doc: IP Blocks
78
78
79
79
.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h
80
80
:identifiers: amd_ip_block_type amd_ip_funcs
81
+
82
+
Display Core
83
+
============
84
+
85
+
This section covers Display core.
86
+
87
+
.. toctree::
88
+
89
+
display/index
90
+
91
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
92
+
:doc: overview
81
93
82
94
AMDGPU XGMI Support
83
95
===================
+4
Documentation/gpu/amdgpu/display/dc-debug.rst
+4
Documentation/gpu/amdgpu/display/dc-debug.rst
+42
Documentation/gpu/amdgpu/display/display-manager.rst
+42
Documentation/gpu/amdgpu/display/display-manager.rst
···
1
+
======================
2
+
AMDgpu Display Manager
3
+
======================
4
+
5
+
.. contents:: Table of Contents
6
+
:depth: 3
7
+
8
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
9
+
:doc: overview
10
+
11
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
12
+
:internal:
13
+
14
+
Lifecycle
15
+
=========
16
+
17
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
18
+
:doc: DM Lifecycle
19
+
20
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
21
+
:functions: dm_hw_init dm_hw_fini
22
+
23
+
Interrupts
24
+
==========
25
+
26
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
27
+
:doc: overview
28
+
29
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_irq.c
30
+
:internal:
31
+
32
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
33
+
:functions: register_hpd_handlers dm_crtc_high_irq dm_pflip_high_irq
34
+
35
+
Atomic Implementation
36
+
=====================
37
+
38
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
39
+
:doc: atomic
40
+
41
+
.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
42
+
:functions: amdgpu_dm_atomic_check amdgpu_dm_atomic_commit_tail
+29
Documentation/gpu/amdgpu/display/index.rst
+29
Documentation/gpu/amdgpu/display/index.rst
···
1
+
===================================
2
+
drm/amd/display - Display Core (DC)
3
+
===================================
4
+
5
+
*placeholder - general description of supported platforms, what dc is, etc.*
6
+
7
+
Because it is partially shared with other operating systems, the Display Core
8
+
Driver is divided in two pieces.
9
+
10
+
1. **Display Core (DC)** contains the OS-agnostic components. Things like
11
+
hardware programming and resource management are handled here.
12
+
2. **Display Manager (DM)** contains the OS-dependent components. Hooks to the
13
+
amdgpu base driver and DRM are implemented here.
14
+
15
+
It doesn't help that the entire package is frequently referred to as DC. But
16
+
with the context in mind, it should be clear.
17
+
18
+
When CONFIG_DRM_AMD_DC is enabled, DC will be initialized by default for
19
+
supported ASICs. To force disable, set `amdgpu.dc=0` on kernel command line.
20
+
Likewise, to force enable on unsupported ASICs, set `amdgpu.dc=1`.
21
+
22
+
To determine if DC is loaded, search dmesg for the following entry:
23
+
24
+
.. toctree::
25
+
26
+
display-manager.rst
27
+
dc-debug.rst
28
+
29
+
``Display Core initialized with <version number here>``