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:: include/drm/drm_atomic_state_helper.h
81   :internal:
82
83.. kernel-doc:: drivers/gpu/drm/drm_atomic_state_helper.c
84   :export:
85
86Simple 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
98fbdev 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
110format Helper Functions Reference
111=================================
112
113.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
114   :export:
115
116Framebuffer 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
125Framebuffer 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
136Bridges
137=======
138
139Overview
140--------
141
142.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
143   :doc: overview
144
145Default bridge callback sequence
146--------------------------------
147
148.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
149   :doc: bridge callbacks
150
151
152Bridge 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
161Panel-Bridge Helper Reference
162-----------------------------
163
164.. kernel-doc:: drivers/gpu/drm/bridge/panel.c
165   :export:
166
167.. _drm_panel_helper:
168
169Panel 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
184HDCP Helper Functions Reference
185===============================
186
187.. kernel-doc:: drivers/gpu/drm/drm_hdcp.c
188   :export:
189
190Display Port Helper Functions Reference
191=======================================
192
193.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
194   :doc: dp helpers
195
196.. kernel-doc:: include/drm/drm_dp_helper.h
197   :internal:
198
199.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
200   :export:
201
202Display Port CEC Helper Functions Reference
203===========================================
204
205.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
206   :doc: dp cec helpers
207
208.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
209   :export:
210
211Display Port Dual Mode Adaptor Helper Functions Reference
212=========================================================
213
214.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
215   :doc: dp dual mode helpers
216
217.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
218   :internal:
219
220.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
221   :export:
222
223Display Port MST Helpers
224========================
225
226Overview
227--------
228
229.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
230   :doc: dp mst helper
231
232.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
233   :doc: Branch device and port refcounting
234
235Functions Reference
236-------------------
237
238.. kernel-doc:: include/drm/drm_dp_mst_helper.h
239   :internal:
240
241.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
242   :export:
243
244Topology Lifetime Internals
245---------------------------
246
247These functions aren't exported to drivers, but are documented here to help make
248the MST topology helpers easier to understand
249
250.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
251   :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
252               drm_dp_mst_topology_put_mstb
253               drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
254               drm_dp_mst_topology_put_port
255               drm_dp_mst_get_mstb_malloc drm_dp_mst_put_mstb_malloc
256
257MIPI DSI Helper Functions Reference
258===================================
259
260.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
261   :doc: dsi helpers
262
263.. kernel-doc:: include/drm/drm_mipi_dsi.h
264   :internal:
265
266.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
267   :export:
268
269Display Stream Compression Helper Functions Reference
270=====================================================
271
272.. kernel-doc:: drivers/gpu/drm/drm_dsc.c
273   :doc: dsc helpers
274
275.. kernel-doc:: include/drm/drm_dsc.h
276   :internal:
277
278.. kernel-doc:: drivers/gpu/drm/drm_dsc.c
279   :export:
280
281Output Probing Helper Functions Reference
282=========================================
283
284.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
285   :doc: output probing helper overview
286
287.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
288   :export:
289
290EDID Helper Functions Reference
291===============================
292
293.. kernel-doc:: include/drm/drm_edid.h
294   :internal:
295
296.. kernel-doc:: drivers/gpu/drm/drm_edid.c
297   :export:
298
299SCDC Helper Functions Reference
300===============================
301
302.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
303   :doc: scdc helpers
304
305.. kernel-doc:: include/drm/drm_scdc_helper.h
306   :internal:
307
308.. kernel-doc:: drivers/gpu/drm/drm_scdc_helper.c
309   :export:
310
311HDMI Infoframes Helper Reference
312================================
313
314Strictly speaking this is not a DRM helper library but generally useable
315by any driver interfacing with HDMI outputs like v4l or alsa drivers.
316But it nicely fits into the overall topic of mode setting helper
317libraries and hence is also included here.
318
319.. kernel-doc:: include/linux/hdmi.h
320   :internal:
321
322.. kernel-doc:: drivers/video/hdmi.c
323   :export:
324
325Rectangle Utilities Reference
326=============================
327
328.. kernel-doc:: include/drm/drm_rect.h
329   :doc: rect utils
330
331.. kernel-doc:: include/drm/drm_rect.h
332   :internal:
333
334.. kernel-doc:: drivers/gpu/drm/drm_rect.c
335   :export:
336
337Flip-work Helper Reference
338==========================
339
340.. kernel-doc:: include/drm/drm_flip_work.h
341   :doc: flip utils
342
343.. kernel-doc:: include/drm/drm_flip_work.h
344   :internal:
345
346.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
347   :export:
348
349Auxiliary Modeset Helpers
350=========================
351
352.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
353   :doc: aux kms helpers
354
355.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
356   :export:
357
358OF/DT Helpers
359=============
360
361.. kernel-doc:: drivers/gpu/drm/drm_of.c
362   :doc: overview
363
364.. kernel-doc:: drivers/gpu/drm/drm_of.c
365   :export:
366
367Legacy Plane Helper Reference
368=============================
369
370.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
371   :doc: overview
372
373.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
374   :export:
375
376Legacy CRTC/Modeset Helper Functions Reference
377==============================================
378
379.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
380   :doc: overview
381
382.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
383   :export:
384
385SHMEM GEM Helper Reference
386==========================
387
388.. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c
389   :doc: overview
390
391.. kernel-doc:: include/drm/drm_gem_shmem_helper.h
392   :internal:
393
394.. kernel-doc:: drivers/gpu/drm/drm_gem_shmem_helper.c
395   :export:
396