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
154 Display Driver Integration
155 --------------------------
157 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
158 :doc: display driver integration
160 Special Care with MIPI-DSI bridges
161 ----------------------------------
163 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
164 :doc: special care dsi
169 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
170 :doc: bridge operations
172 Bridge Connector Helper
173 -----------------------
175 .. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
179 Bridge Helper Reference
180 -------------------------
182 .. kernel-doc:: include/drm/drm_bridge.h
185 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
188 Bridge Connector Helper Reference
189 ---------------------------------
191 .. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
194 Panel-Bridge Helper Reference
195 -----------------------------
197 .. kernel-doc:: drivers/gpu/drm/bridge/panel.c
200 .. _drm_panel_helper:
202 Panel Helper Reference
203 ======================
205 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
208 .. kernel-doc:: include/drm/drm_panel.h
211 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
214 .. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
217 Panel Self Refresh Helper Reference
218 ===================================
220 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
223 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
226 HDCP Helper Functions Reference
227 ===============================
229 .. kernel-doc:: drivers/gpu/drm/display/drm_hdcp_helper.c
232 Display Port Helper Functions Reference
233 =======================================
235 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_helper.c
238 .. kernel-doc:: include/drm/display/drm_dp.h
241 .. kernel-doc:: include/drm/display/drm_dp_helper.h
244 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_helper.c
247 Display Port CEC Helper Functions Reference
248 ===========================================
250 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_cec.c
253 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_cec.c
256 Display Port Dual Mode Adaptor Helper Functions Reference
257 =========================================================
259 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_dual_mode_helper.c
260 :doc: dp dual mode helpers
262 .. kernel-doc:: include/drm/display/drm_dp_dual_mode_helper.h
265 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_dual_mode_helper.c
268 Display Port MST Helpers
269 ========================
274 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c
277 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c
278 :doc: Branch device and port refcounting
283 .. kernel-doc:: include/drm/display/drm_dp_mst_helper.h
286 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c
289 Topology Lifetime Internals
290 ---------------------------
292 These functions aren't exported to drivers, but are documented here to help make
293 the MST topology helpers easier to understand
295 .. kernel-doc:: drivers/gpu/drm/display/drm_dp_mst_topology.c
296 :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
297 drm_dp_mst_topology_put_mstb
298 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
299 drm_dp_mst_topology_put_port
300 drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
302 MIPI DBI Helper Functions Reference
303 ===================================
305 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
308 .. kernel-doc:: include/drm/drm_mipi_dbi.h
311 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
314 MIPI DSI Helper Functions Reference
315 ===================================
317 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
320 .. kernel-doc:: include/drm/drm_mipi_dsi.h
323 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
326 Display Stream Compression Helper Functions Reference
327 =====================================================
329 .. kernel-doc:: drivers/gpu/drm/display/drm_dsc_helper.c
332 .. kernel-doc:: include/drm/display/drm_dsc.h
335 .. kernel-doc:: drivers/gpu/drm/display/drm_dsc_helper.c
338 Output Probing Helper Functions Reference
339 =========================================
341 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
342 :doc: output probing helper overview
344 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
347 EDID Helper Functions Reference
348 ===============================
350 .. kernel-doc:: include/drm/drm_edid.h
353 .. kernel-doc:: drivers/gpu/drm/drm_edid.c
356 SCDC Helper Functions Reference
357 ===============================
359 .. kernel-doc:: drivers/gpu/drm/display/drm_scdc_helper.c
362 .. kernel-doc:: include/drm/display/drm_scdc_helper.h
365 .. kernel-doc:: drivers/gpu/drm/display/drm_scdc_helper.c
368 HDMI Infoframes Helper Reference
369 ================================
371 Strictly speaking this is not a DRM helper library but generally useable
372 by any driver interfacing with HDMI outputs like v4l or alsa drivers.
373 But it nicely fits into the overall topic of mode setting helper
374 libraries and hence is also included here.
376 .. kernel-doc:: include/linux/hdmi.h
379 .. kernel-doc:: drivers/video/hdmi.c
382 Rectangle Utilities Reference
383 =============================
385 .. kernel-doc:: include/drm/drm_rect.h
388 .. kernel-doc:: include/drm/drm_rect.h
391 .. kernel-doc:: drivers/gpu/drm/drm_rect.c
394 Flip-work Helper Reference
395 ==========================
397 .. kernel-doc:: include/drm/drm_flip_work.h
400 .. kernel-doc:: include/drm/drm_flip_work.h
403 .. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
406 Auxiliary Modeset Helpers
407 =========================
409 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
410 :doc: aux kms helpers
412 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
418 .. kernel-doc:: drivers/gpu/drm/drm_of.c
421 .. kernel-doc:: drivers/gpu/drm/drm_of.c
424 Legacy Plane Helper Reference
425 =============================
427 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
430 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
433 Legacy CRTC/Modeset Helper Functions Reference
434 ==============================================
436 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
439 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
445 .. kernel-doc:: drivers/gpu/drm/drm_privacy_screen.c
448 .. kernel-doc:: include/drm/drm_privacy_screen_driver.h
451 .. kernel-doc:: include/drm/drm_privacy_screen_machine.h
454 .. kernel-doc:: drivers/gpu/drm/drm_privacy_screen.c