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   :internal:
41
42.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h
43   :doc: overview
44
45Atomic Modeset Helper Functions Reference
46=========================================
47
48Overview
49--------
50
51.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
52   :doc: overview
53
54Implementing Asynchronous Atomic Commit
55---------------------------------------
56
57.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
58   :doc: implementing nonblocking commit
59
60Atomic State Reset and Initialization
61-------------------------------------
62
63.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
64   :doc: atomic state reset and initialization
65
66.. kernel-doc:: include/drm/drm_atomic_helper.h
67   :internal:
68
69.. kernel-doc:: drivers/gpu/drm/drm_atomic_helper.c
70   :export:
71
72Legacy CRTC/Modeset Helper Functions Reference
73==============================================
74
75.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
76   :doc: overview
77
78.. kernel-doc:: drivers/gpu/drm/drm_crtc_helper.c
79   :export:
80
81Simple KMS Helper Reference
82===========================
83
84.. kernel-doc:: include/drm/drm_simple_kms_helper.h
85   :internal:
86
87.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
88   :export:
89
90.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c
91   :doc: overview
92
93fbdev Helper Functions Reference
94================================
95
96.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
97   :doc: fbdev helpers
98
99.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
100   :export:
101
102.. kernel-doc:: include/drm/drm_fb_helper.h
103   :internal:
104
105Framebuffer CMA Helper Functions Reference
106==========================================
107
108.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
109   :doc: framebuffer cma helper functions
110
111.. kernel-doc:: drivers/gpu/drm/drm_fb_cma_helper.c
112   :export:
113
114Bridges
115=======
116
117Overview
118--------
119
120.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
121   :doc: overview
122
123Default bridge callback sequence
124--------------------------------
125
126.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
127   :doc: bridge callbacks
128
129
130Bridge Helper Reference
131-------------------------
132
133.. kernel-doc:: include/drm/drm_bridge.h
134   :internal:
135
136.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
137   :export:
138
139Panel Helper Reference
140======================
141
142.. kernel-doc:: include/drm/drm_panel.h
143   :internal:
144
145.. kernel-doc:: drivers/gpu/drm/drm_panel.c
146   :export:
147
148.. kernel-doc:: drivers/gpu/drm/drm_panel.c
149   :doc: drm panel
150
151Display Port Helper Functions Reference
152=======================================
153
154.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
155   :doc: dp helpers
156
157.. kernel-doc:: include/drm/drm_dp_helper.h
158   :internal:
159
160.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
161   :export:
162
163Display Port Dual Mode Adaptor Helper Functions Reference
164=========================================================
165
166.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
167   :doc: dp dual mode helpers
168
169.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
170   :internal:
171
172.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
173   :export:
174
175Display Port MST Helper Functions Reference
176===========================================
177
178.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
179   :doc: dp mst helper
180
181.. kernel-doc:: include/drm/drm_dp_mst_helper.h
182   :internal:
183
184.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
185   :export:
186
187MIPI DSI Helper Functions Reference
188===================================
189
190.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
191   :doc: dsi helpers
192
193.. kernel-doc:: include/drm/drm_mipi_dsi.h
194   :internal:
195
196.. kernel-doc:: drivers/gpu/drm/drm_mipi_dsi.c
197   :export:
198
199Output Probing Helper Functions Reference
200=========================================
201
202.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
203   :doc: output probing helper overview
204
205.. kernel-doc:: drivers/gpu/drm/drm_probe_helper.c
206   :export:
207
208EDID Helper Functions Reference
209===============================
210
211.. kernel-doc:: include/drm/drm_edid.h
212   :internal:
213
214.. kernel-doc:: drivers/gpu/drm/drm_edid.c
215   :export:
216
217Rectangle Utilities Reference
218=============================
219
220.. kernel-doc:: include/drm/drm_rect.h
221   :doc: rect utils
222
223.. kernel-doc:: include/drm/drm_rect.h
224   :internal:
225
226.. kernel-doc:: drivers/gpu/drm/drm_rect.c
227   :export:
228
229HDMI Infoframes Helper Reference
230================================
231
232Strictly speaking this is not a DRM helper library but generally useable
233by any driver interfacing with HDMI outputs like v4l or alsa drivers.
234But it nicely fits into the overall topic of mode setting helper
235libraries and hence is also included here.
236
237.. kernel-doc:: include/linux/hdmi.h
238   :internal:
239
240.. kernel-doc:: drivers/video/hdmi.c
241   :export:
242
243Flip-work Helper Reference
244==========================
245
246.. kernel-doc:: include/drm/drm_flip_work.h
247   :doc: flip utils
248
249.. kernel-doc:: include/drm/drm_flip_work.h
250   :internal:
251
252.. kernel-doc:: drivers/gpu/drm/drm_flip_work.c
253   :export:
254
255Plane Helper Reference
256======================
257
258.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
259   :doc: overview
260
261.. kernel-doc:: drivers/gpu/drm/drm_plane_helper.c
262   :export:
263
264Tile group
265==========
266
267# FIXME: This should probably be moved into a property documentation section
268
269.. kernel-doc:: drivers/gpu/drm/drm_crtc.c
270   :doc: Tile group
271
272Auxiliary Modeset Helpers
273=========================
274
275.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
276   :doc: aux kms helpers
277
278.. kernel-doc:: drivers/gpu/drm/drm_modeset_helper.c
279   :export:
280