xref: /openbmc/linux/Documentation/gpu/vc4.rst (revision b787963a)
160c5d3b7SEric Anholt=====================================
260c5d3b7SEric Anholt drm/vc4 Broadcom VC4 Graphics Driver
360c5d3b7SEric Anholt=====================================
460c5d3b7SEric Anholt
5b787963aSEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_drv.c
6b787963aSEric Anholt   :doc: Broadcom VC4 Graphics Driver
7b787963aSEric Anholt
860c5d3b7SEric AnholtDisplay Hardware Handling
960c5d3b7SEric Anholt=========================
1060c5d3b7SEric Anholt
1160c5d3b7SEric AnholtThis section covers everything related to the display hardware including
1260c5d3b7SEric Anholtthe mode setting infrastructure, plane, sprite and cursor handling and
1360c5d3b7SEric Anholtdisplay, output probing and related topics.
1460c5d3b7SEric Anholt
1560c5d3b7SEric AnholtPixel Valve (DRM CRTC)
1660c5d3b7SEric Anholt----------------------
1760c5d3b7SEric Anholt
1860c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_crtc.c
1960c5d3b7SEric Anholt   :doc: VC4 CRTC module
2060c5d3b7SEric Anholt
2160c5d3b7SEric AnholtHVS
2260c5d3b7SEric Anholt---
2360c5d3b7SEric Anholt
2460c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hvs.c
2560c5d3b7SEric Anholt   :doc: VC4 HVS module.
2660c5d3b7SEric Anholt
2760c5d3b7SEric AnholtHVS planes
2860c5d3b7SEric Anholt----------
2960c5d3b7SEric Anholt
3060c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_plane.c
3160c5d3b7SEric Anholt   :doc: VC4 plane module
3260c5d3b7SEric Anholt
3360c5d3b7SEric AnholtHDMI encoder
3460c5d3b7SEric Anholt------------
3560c5d3b7SEric Anholt
3660c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hdmi.c
3760c5d3b7SEric Anholt   :doc: VC4 Falcon HDMI module
3860c5d3b7SEric Anholt
3960c5d3b7SEric AnholtDSI encoder
4060c5d3b7SEric Anholt-----------
4160c5d3b7SEric Anholt
4260c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dsi.c
4360c5d3b7SEric Anholt   :doc: VC4 DSI0/DSI1 module
4460c5d3b7SEric Anholt
4560c5d3b7SEric AnholtDPI encoder
4660c5d3b7SEric Anholt-----------
4760c5d3b7SEric Anholt
4860c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dpi.c
4960c5d3b7SEric Anholt   :doc: VC4 DPI module
5060c5d3b7SEric Anholt
5160c5d3b7SEric AnholtVEC (Composite TV out) encoder
5260c5d3b7SEric Anholt------------------------------
5360c5d3b7SEric Anholt
5460c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_vec.c
5560c5d3b7SEric Anholt   :doc: VC4 SDTV module
5660c5d3b7SEric Anholt
5760c5d3b7SEric AnholtMemory Management and 3D Command Submission
5860c5d3b7SEric Anholt===========================================
5960c5d3b7SEric Anholt
6060c5d3b7SEric AnholtThis section covers the GEM implementation in the vc4 driver.
6160c5d3b7SEric Anholt
6260c5d3b7SEric AnholtGPU buffer object (BO) management
6360c5d3b7SEric Anholt---------------------------------
6460c5d3b7SEric Anholt
6560c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_bo.c
6660c5d3b7SEric Anholt   :doc: VC4 GEM BO management support
6760c5d3b7SEric Anholt
6860c5d3b7SEric AnholtV3D binner command list (BCL) validation
6960c5d3b7SEric Anholt----------------------------------------
7060c5d3b7SEric Anholt
7160c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate.c
7260c5d3b7SEric Anholt   :doc: Command list validator for VC4.
7360c5d3b7SEric Anholt
7460c5d3b7SEric AnholtV3D render command list (RCL) generation
7560c5d3b7SEric Anholt----------------------------------------
7660c5d3b7SEric Anholt
7760c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_render_cl.c
7860c5d3b7SEric Anholt   :doc: Render command list generation
7960c5d3b7SEric Anholt
8060c5d3b7SEric AnholtShader validator for VC4
8160c5d3b7SEric Anholt---------------------------
8260c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate_shaders.c
8360c5d3b7SEric Anholt   :doc: Shader validator for VC4.
8460c5d3b7SEric Anholt
8560c5d3b7SEric AnholtV3D Interrupts
8660c5d3b7SEric Anholt--------------
8760c5d3b7SEric Anholt
8860c5d3b7SEric Anholt.. kernel-doc:: drivers/gpu/drm/vc4/vc4_irq.c
8960c5d3b7SEric Anholt   :doc: Interrupt management for the V3D engine
90