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 .. _drm_atomic_helper:
47 Atomic Modeset Helper Functions Reference
48 =========================================
53 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
56 Implementing Asynchronous Atomic Commit
57 ---------------------------------------
59 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
60 :doc: implementing nonblocking commit
62 Helper Functions Reference
63 --------------------------
65 .. kernel-doc:: include/drm/drm_atomic_helper.h
68 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
71 Atomic State Reset and Initialization
72 -------------------------------------
74 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
75 :doc: atomic state reset and initialization
77 Atomic State Helper Reference
78 -----------------------------
80 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
83 GEM Atomic Helper Reference
84 ---------------------------
86 .. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c
89 .. kernel-doc:: include/drm/drm_gem_atomic_helper.h
92 .. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c
95 Simple KMS Helper Reference
96 ===========================
98 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
101 .. kernel-doc:: include/drm/drm_simple_kms_helper.h
104 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
107 fbdev Helper Functions Reference
108 ================================
110 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
113 .. kernel-doc:: include/drm/drm_fb_helper.h
116 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
119 format Helper Functions Reference
120 =================================
122 .. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
125 Framebuffer CMA Helper Functions Reference
126 ==========================================
128 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
129 :doc: framebuffer cma helper functions
131 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
134 Framebuffer GEM Helper Reference
135 ================================
137 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
140 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
151 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
157 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
158 :doc: bridge operations
160 Bridge Connector Helper
161 -----------------------
163 .. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
167 Bridge Helper Reference
168 -------------------------
170 .. kernel-doc:: include/drm/drm_bridge.h
173 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
176 Bridge Connector Helper Reference
177 ---------------------------------
179 .. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
182 Panel-Bridge Helper Reference
183 -----------------------------
185 .. kernel-doc:: drivers/gpu/drm/bridge/panel.c
188 .. _drm_panel_helper:
190 Panel Helper Reference
191 ======================
193 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
196 .. kernel-doc:: include/drm/drm_panel.h
199 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
202 .. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
205 Panel Self Refresh Helper Reference
206 ===================================
208 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
211 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
214 HDCP Helper Functions Reference
215 ===============================
217 .. kernel-doc:: drivers/gpu/drm/drm_hdcp.c
220 Display Port Helper Functions Reference
221 =======================================
223 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
226 .. kernel-doc:: include/drm/drm_dp_helper.h
229 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
232 Display Port CEC Helper Functions Reference
233 ===========================================
235 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
238 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
241 Display Port Dual Mode Adaptor Helper Functions Reference
242 =========================================================
244 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
245 :doc: dp dual mode helpers
247 .. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
250 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
253 Display Port MST Helpers
254 ========================
259 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
262 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
263 :doc: Branch device and port refcounting
268 .. kernel-doc:: include/drm/drm_dp_mst_helper.h
271 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
274 Topology Lifetime Internals
275 ---------------------------
277 These functions aren't exported to drivers, but are documented here to help make
278 the MST topology helpers easier to understand
280 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
281 :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
282 drm_dp_mst_topology_put_mstb
283 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
284 drm_dp_mst_topology_put_port
285 drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
287 MIPI DBI Helper Functions Reference
288 ===================================
290 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
293 .. kernel-doc:: include/drm/drm_mipi_dbi.h
296 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
299 MIPI DSI Helper Functions Reference
300 ===================================
302 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
305 .. kernel-doc:: include/drm/drm_mipi_dsi.h
308 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
311 Display Stream Compression Helper Functions Reference
312 =====================================================
314 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
317 .. kernel-doc:: include/drm/drm_dsc.h
320 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
323 Output Probing Helper Functions Reference
324 =========================================
326 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
327 :doc: output probing helper overview
329 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
332 EDID Helper Functions Reference
333 ===============================
335 .. kernel-doc:: include/drm/drm_edid.h
338 .. kernel-doc:: drivers/gpu/drm/drm_edid.c
341 SCDC Helper Functions Reference
342 ===============================
344 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
347 .. kernel-doc:: include/drm/drm_scdc_helper.h
350 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
353 HDMI Infoframes Helper Reference
354 ================================
356 Strictly speaking this is not a DRM helper library but generally useable
357 by any driver interfacing with HDMI outputs like v4l or alsa drivers.
358 But it nicely fits into the overall topic of mode setting helper
359 libraries and hence is also included here.
361 .. kernel-doc:: include/linux/hdmi.h
364 .. kernel-doc:: drivers/video/hdmi.c
367 Rectangle Utilities Reference
368 =============================
370 .. kernel-doc:: include/drm/drm_rect.h
373 .. kernel-doc:: include/drm/drm_rect.h
376 .. kernel-doc:: drivers/gpu/drm/drm_rect.c
379 Flip-work Helper Reference
380 ==========================
382 .. kernel-doc:: include/drm/drm_flip_work.h
385 .. kernel-doc:: include/drm/drm_flip_work.h
388 .. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
391 Auxiliary Modeset Helpers
392 =========================
394 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
395 :doc: aux kms helpers
397 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
403 .. kernel-doc:: drivers/gpu/drm/drm_of.c
406 .. kernel-doc:: drivers/gpu/drm/drm_of.c
409 Legacy Plane Helper Reference
410 =============================
412 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
415 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
418 Legacy CRTC/Modeset Helper Functions Reference
419 ==============================================
421 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
424 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c