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