]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - Documentation/gpu/vc4.rst
drm/vc4: Extend and edit documentation for output from the RST
[thirdparty/kernel/stable.git] / Documentation / gpu / vc4.rst
CommitLineData
60c5d3b7
EA
1=====================================
2 drm/vc4 Broadcom VC4 Graphics Driver
3=====================================
4
5Display Hardware Handling
6=========================
7
8This section covers everything related to the display hardware including
9the mode setting infrastructure, plane, sprite and cursor handling and
10display, output probing and related topics.
11
12Pixel Valve (DRM CRTC)
13----------------------
14
15.. kernel-doc:: drivers/gpu/drm/vc4/vc4_crtc.c
16 :doc: VC4 CRTC module
17
18HVS
19---
20
21.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hvs.c
22 :doc: VC4 HVS module.
23
24HVS planes
25----------
26
27.. kernel-doc:: drivers/gpu/drm/vc4/vc4_plane.c
28 :doc: VC4 plane module
29
30HDMI encoder
31------------
32
33.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hdmi.c
34 :doc: VC4 Falcon HDMI module
35
36DSI encoder
37-----------
38
39.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dsi.c
40 :doc: VC4 DSI0/DSI1 module
41
42DPI encoder
43-----------
44
45.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dpi.c
46 :doc: VC4 DPI module
47
48VEC (Composite TV out) encoder
49------------------------------
50
51.. kernel-doc:: drivers/gpu/drm/vc4/vc4_vec.c
52 :doc: VC4 SDTV module
53
54Memory Management and 3D Command Submission
55===========================================
56
57This section covers the GEM implementation in the vc4 driver.
58
59GPU buffer object (BO) management
60---------------------------------
61
62.. kernel-doc:: drivers/gpu/drm/vc4/vc4_bo.c
63 :doc: VC4 GEM BO management support
64
65V3D binner command list (BCL) validation
66----------------------------------------
67
68.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate.c
69 :doc: Command list validator for VC4.
70
71V3D render command list (RCL) generation
72----------------------------------------
73
74.. kernel-doc:: drivers/gpu/drm/vc4/vc4_render_cl.c
75 :doc: Render command list generation
76
77Shader validator for VC4
78---------------------------
79.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate_shaders.c
80 :doc: Shader validator for VC4.
81
82V3D Interrupts
83--------------
84
85.. kernel-doc:: drivers/gpu/drm/vc4/vc4_irq.c
86 :doc: Interrupt management for the V3D engine