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:: include/drm/drm_atomic_state_helper.h
83 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
86 Simple KMS Helper Reference
87 ===========================
89 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
92 .. kernel-doc:: include/drm/drm_simple_kms_helper.h
95 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
98 fbdev Helper Functions Reference
99 ================================
101 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
104 .. kernel-doc:: include/drm/drm_fb_helper.h
107 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
110 format Helper Functions Reference
111 =================================
113 .. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
116 Framebuffer CMA Helper Functions Reference
117 ==========================================
119 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
120 :doc: framebuffer cma helper functions
122 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
125 Framebuffer GEM Helper Reference
126 ================================
128 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
131 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
142 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
145 Default bridge callback sequence
146 --------------------------------
148 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
149 :doc: bridge callbacks
152 Bridge Helper Reference
153 -------------------------
155 .. kernel-doc:: include/drm/drm_bridge.h
158 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
161 Panel-Bridge Helper Reference
162 -----------------------------
164 .. kernel-doc:: drivers/gpu/drm/bridge/panel.c
167 .. _drm_panel_helper:
169 Panel Helper Reference
170 ======================
172 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
175 .. kernel-doc:: include/drm/drm_panel.h
178 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
181 .. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
184 Display Port Helper Functions Reference
185 =======================================
187 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
190 .. kernel-doc:: include/drm/drm_dp_helper.h
193 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
196 Display Port CEC Helper Functions Reference
197 ===========================================
199 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
202 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
205 Display Port Dual Mode Adaptor Helper Functions Reference
206 =========================================================
208 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
209 :doc: dp dual mode helpers
211 .. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
214 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
217 Display Port MST Helpers
218 ========================
223 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
226 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
227 :doc: Branch device and port refcounting
232 .. kernel-doc:: include/drm/drm_dp_mst_helper.h
235 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
238 Topology Lifetime Internals
239 ---------------------------
241 These functions aren't exported to drivers, but are documented here to help make
242 the MST topology helpers easier to understand
244 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
245 :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
246 drm_dp_mst_topology_put_mstb
247 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
248 drm_dp_mst_topology_put_port
249 drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
251 MIPI DSI Helper Functions Reference
252 ===================================
254 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
257 .. kernel-doc:: include/drm/drm_mipi_dsi.h
260 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
263 Display Stream Compression Helper Functions Reference
264 =====================================================
266 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
269 .. kernel-doc:: include/drm/drm_dsc.h
272 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
275 Output Probing Helper Functions Reference
276 =========================================
278 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
279 :doc: output probing helper overview
281 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
284 EDID Helper Functions Reference
285 ===============================
287 .. kernel-doc:: include/drm/drm_edid.h
290 .. kernel-doc:: drivers/gpu/drm/drm_edid.c
293 SCDC Helper Functions Reference
294 ===============================
296 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
299 .. kernel-doc:: include/drm/drm_scdc_helper.h
302 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
305 HDMI Infoframes Helper Reference
306 ================================
308 Strictly speaking this is not a DRM helper library but generally useable
309 by any driver interfacing with HDMI outputs like v4l or alsa drivers.
310 But it nicely fits into the overall topic of mode setting helper
311 libraries and hence is also included here.
313 .. kernel-doc:: include/linux/hdmi.h
316 .. kernel-doc:: drivers/video/hdmi.c
319 Rectangle Utilities Reference
320 =============================
322 .. kernel-doc:: include/drm/drm_rect.h
325 .. kernel-doc:: include/drm/drm_rect.h
328 .. kernel-doc:: drivers/gpu/drm/drm_rect.c
331 Flip-work Helper Reference
332 ==========================
334 .. kernel-doc:: include/drm/drm_flip_work.h
337 .. kernel-doc:: include/drm/drm_flip_work.h
340 .. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
343 Auxiliary Modeset Helpers
344 =========================
346 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
347 :doc: aux kms helpers
349 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
355 .. kernel-doc:: drivers/gpu/drm/drm_of.c
358 .. kernel-doc:: drivers/gpu/drm/drm_of.c
361 Legacy Plane Helper Reference
362 =============================
364 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
367 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
370 Legacy CRTC/Modeset Helper Functions Reference
371 ==============================================
373 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
376 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
379 SHMEM GEM Helper Reference
380 ==========================
382 .. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c
385 .. kernel-doc:: include/drm/drm_gem_shmem_helper.h
388 .. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c