forked from Minki/linux
drm/vc4: Add RST to bring together vc4 kerneldoc.
This doesn't yet produce coherent documentation of the module, but at least gets the kerneldoc built and somewhat glued together. Signed-off-by: Eric Anholt <eric@anholt.net> Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: http://patchwork.freedesktop.org/patch/msgid/20170227201144.10970-3-eric@anholt.net
This commit is contained in:
parent
72f793f14a
commit
60c5d3b729
@ -12,6 +12,7 @@ Linux GPU Driver Developer's Guide
|
|||||||
drm-uapi
|
drm-uapi
|
||||||
i915
|
i915
|
||||||
tinydrm
|
tinydrm
|
||||||
|
vc4
|
||||||
vga-switcheroo
|
vga-switcheroo
|
||||||
vgaarbiter
|
vgaarbiter
|
||||||
todo
|
todo
|
||||||
|
86
Documentation/gpu/vc4.rst
Normal file
86
Documentation/gpu/vc4.rst
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
=====================================
|
||||||
|
drm/vc4 Broadcom VC4 Graphics Driver
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
Display Hardware Handling
|
||||||
|
=========================
|
||||||
|
|
||||||
|
This section covers everything related to the display hardware including
|
||||||
|
the mode setting infrastructure, plane, sprite and cursor handling and
|
||||||
|
display, output probing and related topics.
|
||||||
|
|
||||||
|
Pixel Valve (DRM CRTC)
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_crtc.c
|
||||||
|
:doc: VC4 CRTC module
|
||||||
|
|
||||||
|
HVS
|
||||||
|
---
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hvs.c
|
||||||
|
:doc: VC4 HVS module.
|
||||||
|
|
||||||
|
HVS planes
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_plane.c
|
||||||
|
:doc: VC4 plane module
|
||||||
|
|
||||||
|
HDMI encoder
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_hdmi.c
|
||||||
|
:doc: VC4 Falcon HDMI module
|
||||||
|
|
||||||
|
DSI encoder
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dsi.c
|
||||||
|
:doc: VC4 DSI0/DSI1 module
|
||||||
|
|
||||||
|
DPI encoder
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_dpi.c
|
||||||
|
:doc: VC4 DPI module
|
||||||
|
|
||||||
|
VEC (Composite TV out) encoder
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_vec.c
|
||||||
|
:doc: VC4 SDTV module
|
||||||
|
|
||||||
|
Memory Management and 3D Command Submission
|
||||||
|
===========================================
|
||||||
|
|
||||||
|
This section covers the GEM implementation in the vc4 driver.
|
||||||
|
|
||||||
|
GPU buffer object (BO) management
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_bo.c
|
||||||
|
:doc: VC4 GEM BO management support
|
||||||
|
|
||||||
|
V3D binner command list (BCL) validation
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate.c
|
||||||
|
:doc: Command list validator for VC4.
|
||||||
|
|
||||||
|
V3D render command list (RCL) generation
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_render_cl.c
|
||||||
|
:doc: Render command list generation
|
||||||
|
|
||||||
|
Shader validator for VC4
|
||||||
|
---------------------------
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_validate_shaders.c
|
||||||
|
:doc: Shader validator for VC4.
|
||||||
|
|
||||||
|
V3D Interrupts
|
||||||
|
--------------
|
||||||
|
|
||||||
|
.. kernel-doc:: drivers/gpu/drm/vc4/vc4_irq.c
|
||||||
|
:doc: Interrupt management for the V3D engine
|
Loading…
Reference in New Issue
Block a user