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