1 =============================
2 Mode Setting Helper Functions
3 =============================
5 The DRM subsystem aims for a strong separation between core code and helper
6 libraries. Core code takes care of general setup and teardown and decoding
7 userspace requests to kernel internal objects. Everything else is handled by a
8 large set of helper libraries, which can be combined freely to pick and choose
9 for each driver what fits, and avoid shared code where special behaviour is
12 This distinction between core code and helpers is especially strong in the
13 modesetting code, where there's a shared userspace ABI for all drivers. This is
14 in contrast to the render side, where pretty much everything (with very few
15 exceptions) can be considered optional helper code.
17 There are a few areas these helpers can grouped into:
19 * Helpers to implement modesetting. The important ones here are the atomic
20 helpers. Old drivers still often use the legacy CRTC helpers. They both share
21 the same set of common helper vtables. For really simple drivers (anything
22 that would have been a great fit in the deprecated fbdev subsystem) there's
23 also the simple display pipe helpers.
25 * There's a big pile of helpers for handling outputs. First the generic bridge
26 helpers for handling encoder and transcoder IP blocks. Second the panel helpers
27 for handling panel-related information and logic. Plus then a big set of
28 helpers for the various sink standards (DisplayPort, HDMI, MIPI DSI). Finally
29 there's also generic helpers for handling output probing, and for dealing with
32 * The last group of helpers concerns itself with the frontend side of a display
33 pipeline: Planes, handling rectangles for visibility checking and scissoring,
34 flip queues and assorted bits.
36 Modeset Helper Reference for Common Vtables
37 ===========================================
39 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
42 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
45 Atomic Modeset Helper Functions Reference
46 =========================================
51 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
54 Implementing Asynchronous Atomic Commit
55 ---------------------------------------
57 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
58 :doc: implementing nonblocking commit
60 Atomic State Reset and Initialization
61 -------------------------------------
63 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
64 :doc: atomic state reset and initialization
66 .. kernel-doc:: include/drm/drm_atomic_helper.h
69 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
72 Legacy CRTC/Modeset Helper Functions Reference
73 ==============================================
75 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
78 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
81 Simple KMS Helper Reference
82 ===========================
84 .. kernel-doc:: include/drm/drm_simple_kms_helper.h
87 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
90 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
93 fbdev Helper Functions Reference
94 ================================
96 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
99 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
102 .. kernel-doc:: include/drm/drm_fb_helper.h
105 Framebuffer CMA Helper Functions Reference
106 ==========================================
108 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
109 :doc: framebuffer cma helper functions
111 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
120 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
123 Default bridge callback sequence
124 --------------------------------
126 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
127 :doc: bridge callbacks
130 Bridge Helper Reference
131 -------------------------
133 .. kernel-doc:: include/drm/drm_bridge.h
136 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
139 Panel Helper Reference
140 ======================
142 .. kernel-doc:: include/drm/drm_panel.h
145 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
148 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
151 Display Port Helper Functions Reference
152 =======================================
154 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
157 .. kernel-doc:: include/drm/drm_dp_helper.h
160 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
163 Display Port Dual Mode Adaptor Helper Functions Reference
164 =========================================================
166 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
167 :doc: dp dual mode helpers
169 .. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
172 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
175 Display Port MST Helper Functions Reference
176 ===========================================
178 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
181 .. kernel-doc:: include/drm/drm_dp_mst_helper.h
184 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
187 MIPI DSI Helper Functions Reference
188 ===================================
190 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
193 .. kernel-doc:: include/drm/drm_mipi_dsi.h
196 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
199 Output Probing Helper Functions Reference
200 =========================================
202 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
203 :doc: output probing helper overview
205 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
208 EDID Helper Functions Reference
209 ===============================
211 .. kernel-doc:: include/drm/drm_edid.h
214 .. kernel-doc:: drivers/gpu/drm/drm_edid.c
217 Rectangle Utilities Reference
218 =============================
220 .. kernel-doc:: include/drm/drm_rect.h
223 .. kernel-doc:: include/drm/drm_rect.h
226 .. kernel-doc:: drivers/gpu/drm/drm_rect.c
229 HDMI Infoframes Helper Reference
230 ================================
232 Strictly speaking this is not a DRM helper library but generally useable
233 by any driver interfacing with HDMI outputs like v4l or alsa drivers.
234 But it nicely fits into the overall topic of mode setting helper
235 libraries and hence is also included here.
237 .. kernel-doc:: include/linux/hdmi.h
240 .. kernel-doc:: drivers/video/hdmi.c
243 Flip-work Helper Reference
244 ==========================
246 .. kernel-doc:: include/drm/drm_flip_work.h
249 .. kernel-doc:: include/drm/drm_flip_work.h
252 .. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
255 Plane Helper Reference
256 ======================
258 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
261 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
267 # FIXME: This should probably be moved into a property documentation section
269 .. kernel-doc:: drivers/gpu/drm/drm_crtc.c
272 Auxiliary Modeset Helpers
273 =========================
275 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
276 :doc: aux kms helpers
278 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c