Linux 5.3-rc8
[sfrench/cifs-2.6.git] / Documentation / gpu / drm-kms-helpers.rst
1 =============================
2 Mode Setting Helper Functions
3 =============================
4
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
10 needed.
11
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.
16
17 There are a few areas these helpers can grouped into:
18
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.
24
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
30   EDIDs.
31
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.
35
36 Modeset Helper Reference for Common Vtables
37 ===========================================
38
39 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
40    :doc: overview
41
42 .. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
43    :internal:
44
45 .. _drm_atomic_helper:
46
47 Atomic Modeset Helper Functions Reference
48 =========================================
49
50 Overview
51 --------
52
53 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
54    :doc: overview
55
56 Implementing Asynchronous Atomic Commit
57 ---------------------------------------
58
59 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
60    :doc: implementing nonblocking commit
61
62 Helper Functions Reference
63 --------------------------
64
65 .. kernel-doc:: include/drm/drm_atomic_helper.h
66    :internal:
67
68 .. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
69    :export:
70
71 Atomic State Reset and Initialization
72 -------------------------------------
73
74 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
75    :doc: atomic state reset and initialization
76
77 Atomic State Helper Reference
78 -----------------------------
79
80 .. kernel-doc:: include/drm/drm_atomic_state_helper.h
81    :internal:
82
83 .. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
84    :export:
85
86 Simple KMS Helper Reference
87 ===========================
88
89 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
90    :doc: overview
91
92 .. kernel-doc:: include/drm/drm_simple_kms_helper.h
93    :internal:
94
95 .. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
96    :export:
97
98 fbdev Helper Functions Reference
99 ================================
100
101 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
102    :doc: fbdev helpers
103
104 .. kernel-doc:: include/drm/drm_fb_helper.h
105    :internal:
106
107 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
108    :export:
109
110 format Helper Functions Reference
111 =================================
112
113 .. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
114    :export:
115
116 Framebuffer CMA Helper Functions Reference
117 ==========================================
118
119 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
120    :doc: framebuffer cma helper functions
121
122 .. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
123    :export:
124
125 Framebuffer GEM Helper Reference
126 ================================
127
128 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
129    :doc: overview
130
131 .. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
132    :export:
133
134 .. _drm_bridges:
135
136 Bridges
137 =======
138
139 Overview
140 --------
141
142 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
143    :doc: overview
144
145 Default bridge callback sequence
146 --------------------------------
147
148 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
149    :doc: bridge callbacks
150
151
152 Bridge Helper Reference
153 -------------------------
154
155 .. kernel-doc:: include/drm/drm_bridge.h
156    :internal:
157
158 .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
159    :export:
160
161 Panel-Bridge Helper Reference
162 -----------------------------
163
164 .. kernel-doc:: drivers/gpu/drm/bridge/panel.c
165    :export:
166
167 .. _drm_panel_helper:
168
169 Panel Helper Reference
170 ======================
171
172 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
173    :doc: drm panel
174
175 .. kernel-doc:: include/drm/drm_panel.h
176    :internal:
177
178 .. kernel-doc:: drivers/gpu/drm/drm_panel.c
179    :export:
180
181 .. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
182    :export:
183
184 Panel Self Refresh Helper Reference
185 ===================================
186
187 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
188    :doc: overview
189
190 .. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
191    :export:
192
193 HDCP Helper Functions Reference
194 ===============================
195
196 .. kernel-doc:: drivers/gpu/drm/drm_hdcp.c
197    :export:
198
199 Display Port Helper Functions Reference
200 =======================================
201
202 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
203    :doc: dp helpers
204
205 .. kernel-doc:: include/drm/drm_dp_helper.h
206    :internal:
207
208 .. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
209    :export:
210
211 Display Port CEC Helper Functions Reference
212 ===========================================
213
214 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
215    :doc: dp cec helpers
216
217 .. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
218    :export:
219
220 Display Port Dual Mode Adaptor Helper Functions Reference
221 =========================================================
222
223 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
224    :doc: dp dual mode helpers
225
226 .. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
227    :internal:
228
229 .. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
230    :export:
231
232 Display Port MST Helpers
233 ========================
234
235 Overview
236 --------
237
238 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
239    :doc: dp mst helper
240
241 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
242    :doc: Branch device and port refcounting
243
244 Functions Reference
245 -------------------
246
247 .. kernel-doc:: include/drm/drm_dp_mst_helper.h
248    :internal:
249
250 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
251    :export:
252
253 Topology Lifetime Internals
254 ---------------------------
255
256 These functions aren't exported to drivers, but are documented here to help make
257 the MST topology helpers easier to understand
258
259 .. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
260    :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
261                drm_dp_mst_topology_put_mstb
262                drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
263                drm_dp_mst_topology_put_port
264                drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
265
266 MIPI DSI Helper Functions Reference
267 ===================================
268
269 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
270    :doc: dsi helpers
271
272 .. kernel-doc:: include/drm/drm_mipi_dsi.h
273    :internal:
274
275 .. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
276    :export:
277
278 Display Stream Compression Helper Functions Reference
279 =====================================================
280
281 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
282    :doc: dsc helpers
283
284 .. kernel-doc:: include/drm/drm_dsc.h
285    :internal:
286
287 .. kernel-doc:: drivers/gpu/drm/drm_dsc.c
288    :export:
289
290 Output Probing Helper Functions Reference
291 =========================================
292
293 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
294    :doc: output probing helper overview
295
296 .. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
297    :export:
298
299 EDID Helper Functions Reference
300 ===============================
301
302 .. kernel-doc:: include/drm/drm_edid.h
303    :internal:
304
305 .. kernel-doc:: drivers/gpu/drm/drm_edid.c
306    :export:
307
308 SCDC Helper Functions Reference
309 ===============================
310
311 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
312    :doc: scdc helpers
313
314 .. kernel-doc:: include/drm/drm_scdc_helper.h
315    :internal:
316
317 .. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
318    :export:
319
320 HDMI Infoframes Helper Reference
321 ================================
322
323 Strictly speaking this is not a DRM helper library but generally useable
324 by any driver interfacing with HDMI outputs like v4l or alsa drivers.
325 But it nicely fits into the overall topic of mode setting helper
326 libraries and hence is also included here.
327
328 .. kernel-doc:: include/linux/hdmi.h
329    :internal:
330
331 .. kernel-doc:: drivers/video/hdmi.c
332    :export:
333
334 Rectangle Utilities Reference
335 =============================
336
337 .. kernel-doc:: include/drm/drm_rect.h
338    :doc: rect utils
339
340 .. kernel-doc:: include/drm/drm_rect.h
341    :internal:
342
343 .. kernel-doc:: drivers/gpu/drm/drm_rect.c
344    :export:
345
346 Flip-work Helper Reference
347 ==========================
348
349 .. kernel-doc:: include/drm/drm_flip_work.h
350    :doc: flip utils
351
352 .. kernel-doc:: include/drm/drm_flip_work.h
353    :internal:
354
355 .. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
356    :export:
357
358 Auxiliary Modeset Helpers
359 =========================
360
361 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
362    :doc: aux kms helpers
363
364 .. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
365    :export:
366
367 OF/DT Helpers
368 =============
369
370 .. kernel-doc:: drivers/gpu/drm/drm_of.c
371    :doc: overview
372
373 .. kernel-doc:: drivers/gpu/drm/drm_of.c
374    :export:
375
376 Legacy Plane Helper Reference
377 =============================
378
379 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
380    :doc: overview
381
382 .. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
383    :export:
384
385 Legacy CRTC/Modeset Helper Functions Reference
386 ==============================================
387
388 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
389    :doc: overview
390
391 .. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
392    :export:
393
394 SHMEM GEM Helper Reference
395 ==========================
396
397 .. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c
398    :doc: overview
399
400 .. kernel-doc:: include/drm/drm_gem_shmem_helper.h
401    :internal:
402
403 .. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c
404    :export: