1=============================
2Mode Setting Helper Functions
3=============================
4
5The DRM subsystem aims for a strong separation between core code and helper
6libraries. Core code takes care of general setup and teardown and decoding
7userspace requests to kernel internal objects. Everything else is handled by a
8large set of helper libraries, which can be combined freely to pick and choose
9for each driver what fits, and avoid shared code where special behaviour is
10needed.
11
12This distinction between core code and helpers is especially strong in the
13modesetting code, where there's a shared userspace ABI for all drivers. This is
14in contrast to the render side, where pretty much everything (with very few
15exceptions) can be considered optional helper code.
16
17There 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
36Modeset 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
47Atomic Modeset Helper Functions Reference
48=========================================
49
50Overview
51--------
52
53.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
54   :doc: overview
55
56Implementing Asynchronous Atomic Commit
57---------------------------------------
58
59.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
60   :doc: implementing nonblocking commit
61
62Helper 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
71Atomic 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
77Atomic State Helper Reference
78-----------------------------
79
80.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
81   :export:
82
83GEM Atomic Helper Reference
84---------------------------
85
86.. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c
87   :doc: overview
88
89.. kernel-doc:: include/drm/drm_gem_atomic_helper.h
90   :internal:
91
92.. kernel-doc:: drivers/gpu/drm/drm_gem_atomic_helper.c
93   :export:
94
95Simple KMS Helper Reference
96===========================
97
98.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
99   :doc: overview
100
101.. kernel-doc:: include/drm/drm_simple_kms_helper.h
102   :internal:
103
104.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
105   :export:
106
107fbdev Helper Functions Reference
108================================
109
110.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
111   :doc: fbdev helpers
112
113.. kernel-doc:: include/drm/drm_fb_helper.h
114   :internal:
115
116.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
117   :export:
118
119format Helper Functions Reference
120=================================
121
122.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
123   :export:
124
125Framebuffer CMA Helper Functions Reference
126==========================================
127
128.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
129   :doc: framebuffer cma helper functions
130
131.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
132   :export:
133
134Framebuffer GEM Helper Reference
135================================
136
137.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
138   :doc: overview
139
140.. kernel-doc:: drivers/gpu/drm/drm_gem_framebuffer_helper.c
141   :export:
142
143.. _drm_bridges:
144
145Bridges
146=======
147
148Overview
149--------
150
151.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
152   :doc: overview
153
154Bridge Operations
155-----------------
156
157.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
158   :doc: bridge operations
159
160Bridge Connector Helper
161-----------------------
162
163.. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
164   :doc: overview
165
166
167Bridge Helper Reference
168-------------------------
169
170.. kernel-doc:: include/drm/drm_bridge.h
171   :internal:
172
173.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
174   :export:
175
176Bridge Connector Helper Reference
177---------------------------------
178
179.. kernel-doc:: drivers/gpu/drm/drm_bridge_connector.c
180   :export:
181
182Panel-Bridge Helper Reference
183-----------------------------
184
185.. kernel-doc:: drivers/gpu/drm/bridge/panel.c
186   :export:
187
188.. _drm_panel_helper:
189
190Panel Helper Reference
191======================
192
193.. kernel-doc:: drivers/gpu/drm/drm_panel.c
194   :doc: drm panel
195
196.. kernel-doc:: include/drm/drm_panel.h
197   :internal:
198
199.. kernel-doc:: drivers/gpu/drm/drm_panel.c
200   :export:
201
202.. kernel-doc:: drivers/gpu/drm/drm_panel_orientation_quirks.c
203   :export:
204
205Panel Self Refresh Helper Reference
206===================================
207
208.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
209   :doc: overview
210
211.. kernel-doc:: drivers/gpu/drm/drm_self_refresh_helper.c
212   :export:
213
214HDCP Helper Functions Reference
215===============================
216
217.. kernel-doc:: drivers/gpu/drm/drm_hdcp.c
218   :export:
219
220Display Port Helper Functions Reference
221=======================================
222
223.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
224   :doc: dp helpers
225
226.. kernel-doc:: include/drm/drm_dp_helper.h
227   :internal:
228
229.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
230   :export:
231
232Display Port CEC Helper Functions Reference
233===========================================
234
235.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
236   :doc: dp cec helpers
237
238.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
239   :export:
240
241Display Port Dual Mode Adaptor Helper Functions Reference
242=========================================================
243
244.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
245   :doc: dp dual mode helpers
246
247.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
248   :internal:
249
250.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
251   :export:
252
253Display Port MST Helpers
254========================
255
256Overview
257--------
258
259.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
260   :doc: dp mst helper
261
262.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
263   :doc: Branch device and port refcounting
264
265Functions Reference
266-------------------
267
268.. kernel-doc:: include/drm/drm_dp_mst_helper.h
269   :internal:
270
271.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
272   :export:
273
274Topology Lifetime Internals
275---------------------------
276
277These functions aren't exported to drivers, but are documented here to help make
278the MST topology helpers easier to understand
279
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
286
287MIPI DBI Helper Functions Reference
288===================================
289
290.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
291   :doc: overview
292
293.. kernel-doc:: include/drm/drm_mipi_dbi.h
294   :internal:
295
296.. kernel-doc:: drivers/gpu/drm/drm_mipi_dbi.c
297   :export:
298
299MIPI DSI Helper Functions Reference
300===================================
301
302.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
303   :doc: dsi helpers
304
305.. kernel-doc:: include/drm/drm_mipi_dsi.h
306   :internal:
307
308.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
309   :export:
310
311Display Stream Compression Helper Functions Reference
312=====================================================
313
314.. kernel-doc:: drivers/gpu/drm/drm_dsc.c
315   :doc: dsc helpers
316
317.. kernel-doc:: include/drm/drm_dsc.h
318   :internal:
319
320.. kernel-doc:: drivers/gpu/drm/drm_dsc.c
321   :export:
322
323Output Probing Helper Functions Reference
324=========================================
325
326.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
327   :doc: output probing helper overview
328
329.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
330   :export:
331
332EDID Helper Functions Reference
333===============================
334
335.. kernel-doc:: include/drm/drm_edid.h
336   :internal:
337
338.. kernel-doc:: drivers/gpu/drm/drm_edid.c
339   :export:
340
341SCDC Helper Functions Reference
342===============================
343
344.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
345   :doc: scdc helpers
346
347.. kernel-doc:: include/drm/drm_scdc_helper.h
348   :internal:
349
350.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
351   :export:
352
353HDMI Infoframes Helper Reference
354================================
355
356Strictly speaking this is not a DRM helper library but generally useable
357by any driver interfacing with HDMI outputs like v4l or alsa drivers.
358But it nicely fits into the overall topic of mode setting helper
359libraries and hence is also included here.
360
361.. kernel-doc:: include/linux/hdmi.h
362   :internal:
363
364.. kernel-doc:: drivers/video/hdmi.c
365   :export:
366
367Rectangle Utilities Reference
368=============================
369
370.. kernel-doc:: include/drm/drm_rect.h
371   :doc: rect utils
372
373.. kernel-doc:: include/drm/drm_rect.h
374   :internal:
375
376.. kernel-doc:: drivers/gpu/drm/drm_rect.c
377   :export:
378
379Flip-work Helper Reference
380==========================
381
382.. kernel-doc:: include/drm/drm_flip_work.h
383   :doc: flip utils
384
385.. kernel-doc:: include/drm/drm_flip_work.h
386   :internal:
387
388.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
389   :export:
390
391Auxiliary Modeset Helpers
392=========================
393
394.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
395   :doc: aux kms helpers
396
397.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
398   :export:
399
400OF/DT Helpers
401=============
402
403.. kernel-doc:: drivers/gpu/drm/drm_of.c
404   :doc: overview
405
406.. kernel-doc:: drivers/gpu/drm/drm_of.c
407   :export:
408
409Legacy Plane Helper Reference
410=============================
411
412.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
413   :doc: overview
414
415.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
416   :export:
417
418Legacy CRTC/Modeset Helper Functions Reference
419==============================================
420
421.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
422   :doc: overview
423
424.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
425   :export:
426