Commit | Line | Data |
---|---|---|
f453ba04 DA |
1 | /* |
2 | * Copyright © 2006 Keith Packard | |
3 | * Copyright © 2007-2008 Dave Airlie | |
4 | * Copyright © 2007-2008 Intel Corporation | |
5 | * Jesse Barnes <jesse.barnes@intel.com> | |
6 | * | |
7 | * Permission is hereby granted, free of charge, to any person obtaining a | |
8 | * copy of this software and associated documentation files (the "Software"), | |
9 | * to deal in the Software without restriction, including without limitation | |
10 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
11 | * and/or sell copies of the Software, and to permit persons to whom the | |
12 | * Software is furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
20 | * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR | |
21 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | |
22 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
23 | * OTHER DEALINGS IN THE SOFTWARE. | |
24 | */ | |
25 | #ifndef __DRM_CRTC_H__ | |
26 | #define __DRM_CRTC_H__ | |
27 | ||
28 | #include <linux/i2c.h> | |
29 | #include <linux/spinlock.h> | |
30 | #include <linux/types.h> | |
f453ba04 | 31 | #include <linux/fb.h> |
985e5dc2 | 32 | #include <linux/hdmi.h> |
b5571e9d | 33 | #include <linux/media-bus-format.h> |
d7d2c48e DH |
34 | #include <uapi/drm/drm_mode.h> |
35 | #include <uapi/drm/drm_fourcc.h> | |
51fd371b | 36 | #include <drm/drm_modeset_lock.h> |
d7da824d | 37 | #include <drm/drm_rect.h> |
949619f3 | 38 | #include <drm/drm_mode_object.h> |
7520a277 DV |
39 | #include <drm/drm_framebuffer.h> |
40 | #include <drm/drm_modes.h> | |
52217195 | 41 | #include <drm/drm_connector.h> |
59e71ee7 | 42 | #include <drm/drm_property.h> |
199e4e96 | 43 | #include <drm/drm_bridge.h> |
cdc3d09f | 44 | #include <drm/drm_edid.h> |
43968d7b | 45 | #include <drm/drm_plane.h> |
18733802 | 46 | #include <drm/drm_blend.h> |
f1e2f66c | 47 | #include <drm/drm_color_mgmt.h> |
9edbf1fa | 48 | #include <drm/drm_debugfs_crc.h> |
28575f16 | 49 | #include <drm/drm_mode_config.h> |
308e5bcb | 50 | |
f453ba04 DA |
51 | struct drm_device; |
52 | struct drm_mode_set; | |
595887eb TR |
53 | struct drm_file; |
54 | struct drm_clip_rect; | |
fceffb32 | 55 | struct drm_printer; |
7e435aad | 56 | struct device_node; |
f54d1867 | 57 | struct dma_fence; |
81065548 | 58 | struct edid; |
f453ba04 | 59 | |
ebc44cf3 RC |
60 | static inline int64_t U642I64(uint64_t val) |
61 | { | |
62 | return (int64_t)*((int64_t *)&val); | |
63 | } | |
64 | static inline uint64_t I642U64(int64_t val) | |
65 | { | |
66 | return (uint64_t)*((uint64_t *)&val); | |
67 | } | |
68 | ||
f453ba04 | 69 | struct drm_crtc; |
d91d8a3f | 70 | struct drm_pending_vblank_event; |
8cf5c917 | 71 | struct drm_plane; |
3b336ec4 | 72 | struct drm_bridge; |
144ecb97 DV |
73 | struct drm_atomic_state; |
74 | ||
4490d4c7 | 75 | struct drm_crtc_helper_funcs; |
4490d4c7 DV |
76 | struct drm_plane_helper_funcs; |
77 | ||
144ecb97 | 78 | /** |
cc4ceb48 | 79 | * struct drm_crtc_state - mutable CRTC state |
07cc0ef6 | 80 | * @crtc: backpointer to the CRTC |
144ecb97 | 81 | * @enable: whether the CRTC should be enabled, gates all other state |
d9b13620 | 82 | * @active: whether the CRTC is actively displaying (used for DPMS) |
fc596660 | 83 | * @planes_changed: planes on this crtc are updated |
d574528a DV |
84 | * @mode_changed: @mode or @enable has been changed |
85 | * @active_changed: @active has been toggled. | |
fc596660 | 86 | * @connectors_changed: connectors to this crtc have been updated |
44d1240d | 87 | * @zpos_changed: zpos values of planes on this crtc have been updated |
5488dc16 LL |
88 | * @color_mgmt_changed: color management properties have changed (degamma or |
89 | * gamma LUT or CSC matrix) | |
6ddd388a | 90 | * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes |
4cd9fa52 | 91 | * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors |
e87a52b3 | 92 | * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders |
ac3ba4a5 | 93 | * @mode_blob: &drm_property_blob for @mode |
144ecb97 | 94 | * @state: backpointer to global drm_atomic_state |
d9b13620 DV |
95 | * |
96 | * Note that the distinction between @enable and @active is rather subtile: | |
97 | * Flipping @active while @enable is set without changing anything else may | |
d574528a DV |
98 | * never return in a failure from the &drm_mode_config_funcs.atomic_check |
99 | * callback. Userspace assumes that a DPMS On will always succeed. In other | |
100 | * words: @enable controls resource assignment, @active controls the actual | |
101 | * hardware state. | |
d807ed1c BS |
102 | * |
103 | * The three booleans active_changed, connectors_changed and mode_changed are | |
104 | * intended to indicate whether a full modeset is needed, rather than strictly | |
105 | * describing what has changed in a commit. | |
106 | * See also: drm_atomic_crtc_needs_modeset() | |
144ecb97 DV |
107 | */ |
108 | struct drm_crtc_state { | |
07cc0ef6 DV |
109 | struct drm_crtc *crtc; |
110 | ||
cc4ceb48 | 111 | bool enable; |
d9b13620 | 112 | bool active; |
144ecb97 | 113 | |
c2fcd274 DV |
114 | /* computed state bits used by helpers and drivers */ |
115 | bool planes_changed : 1; | |
623369e5 | 116 | bool mode_changed : 1; |
eab3bbef | 117 | bool active_changed : 1; |
fc596660 | 118 | bool connectors_changed : 1; |
44d1240d | 119 | bool zpos_changed : 1; |
5488dc16 | 120 | bool color_mgmt_changed : 1; |
623369e5 | 121 | |
6ddd388a RC |
122 | /* attached planes bitmask: |
123 | * WARNING: transitional helpers do not maintain plane_mask so | |
124 | * drivers not converted over to atomic helpers should not rely | |
125 | * on plane_mask being accurate! | |
126 | */ | |
127 | u32 plane_mask; | |
128 | ||
4cd9fa52 | 129 | u32 connector_mask; |
e87a52b3 | 130 | u32 encoder_mask; |
4cd9fa52 | 131 | |
9de5d4a6 DV |
132 | /** |
133 | * @adjusted_mode: | |
134 | * | |
135 | * Internal display timings which can be used by the driver to handle | |
136 | * differences between the mode requested by userspace in @mode and what | |
137 | * is actually programmed into the hardware. It is purely driver | |
138 | * implementation defined what exactly this adjusted mode means. Usually | |
139 | * it is used to store the hardware display timings used between the | |
140 | * CRTC and encoder blocks. | |
141 | */ | |
2f324b42 DV |
142 | struct drm_display_mode adjusted_mode; |
143 | ||
9de5d4a6 DV |
144 | /** |
145 | * @mode: | |
146 | * | |
147 | * Display timings requested by userspace. The driver should try to | |
148 | * match the refresh rate as close as possible (but note that it's | |
149 | * undefined what exactly is close enough, e.g. some of the HDMI modes | |
150 | * only differ in less than 1% of the refresh rate). The active width | |
151 | * and height as observed by userspace for positioning planes must match | |
152 | * exactly. | |
153 | * | |
154 | * For external connectors where the sink isn't fixed (like with a | |
155 | * built-in panel), this mode here should match the physical mode on the | |
156 | * wire to the last details (i.e. including sync polarities and | |
157 | * everything). | |
158 | */ | |
144ecb97 DV |
159 | struct drm_display_mode mode; |
160 | ||
99cf4a29 DS |
161 | /* blob property to expose current mode to atomic userspace */ |
162 | struct drm_property_blob *mode_blob; | |
163 | ||
2e38178e DV |
164 | /** |
165 | * @degamma_lut: | |
166 | * | |
167 | * Lookup table for converting framebuffer pixel data before apply the | |
168 | * color conversion matrix @ctm. See drm_crtc_enable_color_mgmt(). The | |
169 | * blob (if not NULL) is an array of &struct drm_color_lut. | |
170 | */ | |
5488dc16 | 171 | struct drm_property_blob *degamma_lut; |
2e38178e DV |
172 | |
173 | /** | |
174 | * @ctm: | |
175 | * | |
176 | * Color transformation matrix. See drm_crtc_enable_color_mgmt(). The | |
177 | * blob (if not NULL) is a &struct drm_color_ctm. | |
178 | */ | |
5488dc16 | 179 | struct drm_property_blob *ctm; |
2e38178e DV |
180 | |
181 | /** | |
182 | * @gamma_lut: | |
183 | * | |
184 | * Lookup table for converting pixel data after the color conversion | |
185 | * matrix @ctm. See drm_crtc_enable_color_mgmt(). The blob (if not | |
186 | * NULL) is an array of &struct drm_color_lut. | |
187 | */ | |
5488dc16 LL |
188 | struct drm_property_blob *gamma_lut; |
189 | ||
f869a6ec AG |
190 | /** |
191 | * @target_vblank: | |
192 | * | |
193 | * Target vertical blank period when a page flip | |
194 | * should take effect. | |
195 | */ | |
f869a6ec AG |
196 | u32 target_vblank; |
197 | ||
6cbe5c46 AG |
198 | /** |
199 | * @pageflip_flags: | |
200 | * | |
201 | * DRM_MODE_PAGE_FLIP_* flags, as passed to the page flip ioctl. | |
202 | * Zero in any other case. | |
203 | */ | |
204 | u32 pageflip_flags; | |
205 | ||
61802130 DV |
206 | /** |
207 | * @event: | |
208 | * | |
209 | * Optional pointer to a DRM event to signal upon completion of the | |
210 | * state update. The driver must send out the event when the atomic | |
211 | * commit operation completes. There are two cases: | |
212 | * | |
213 | * - The event is for a CRTC which is being disabled through this | |
214 | * atomic commit. In that case the event can be send out any time | |
215 | * after the hardware has stopped scanning out the current | |
216 | * framebuffers. It should contain the timestamp and counter for the | |
8938d135 DV |
217 | * last vblank before the display pipeline was shut off. The simplest |
218 | * way to achieve that is calling drm_crtc_send_vblank_event() | |
219 | * somewhen after drm_crtc_vblank_off() has been called. | |
61802130 DV |
220 | * |
221 | * - For a CRTC which is enabled at the end of the commit (even when it | |
222 | * undergoes an full modeset) the vblank timestamp and counter must | |
223 | * be for the vblank right before the first frame that scans out the | |
224 | * new set of buffers. Again the event can only be sent out after the | |
225 | * hardware has stopped scanning out the old buffers. | |
226 | * | |
227 | * - Events for disabled CRTCs are not allowed, and drivers can ignore | |
228 | * that case. | |
229 | * | |
230 | * This can be handled by the drm_crtc_send_vblank_event() function, | |
231 | * which the driver should call on the provided event upon completion of | |
232 | * the atomic commit. Note that if the driver supports vblank signalling | |
233 | * and timestamping the vblank counters and timestamps must agree with | |
234 | * the ones returned from page flip events. With the current vblank | |
235 | * helper infrastructure this can be achieved by holding a vblank | |
236 | * reference while the page flip is pending, acquired through | |
237 | * drm_crtc_vblank_get() and released with drm_crtc_vblank_put(). | |
238 | * Drivers are free to implement their own vblank counter and timestamp | |
239 | * tracking though, e.g. if they have accurate timestamp registers in | |
240 | * hardware. | |
241 | * | |
242 | * For hardware which supports some means to synchronize vblank | |
243 | * interrupt delivery with committing display state there's also | |
244 | * drm_crtc_arm_vblank_event(). See the documentation of that function | |
245 | * for a detailed discussion of the constraints it needs to be used | |
246 | * safely. | |
66f8c100 DV |
247 | * |
248 | * If the device can't notify of flip completion in a race-free way | |
249 | * at all, then the event should be armed just after the page flip is | |
250 | * committed. In the worst case the driver will send the event to | |
251 | * userspace one frame too late. This doesn't allow for a real atomic | |
252 | * update, but it should avoid tearing. | |
61802130 | 253 | */ |
144ecb97 DV |
254 | struct drm_pending_vblank_event *event; |
255 | ||
256 | struct drm_atomic_state *state; | |
257 | }; | |
f453ba04 DA |
258 | |
259 | /** | |
3bf0401c | 260 | * struct drm_crtc_funcs - control CRTCs for a given device |
f453ba04 DA |
261 | * |
262 | * The drm_crtc_funcs structure is the central CRTC management structure | |
263 | * in the DRM. Each CRTC controls one or more connectors (note that the name | |
264 | * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc. | |
265 | * connectors, not just CRTs). | |
266 | * | |
267 | * Each driver is responsible for filling out this structure at startup time, | |
268 | * in addition to providing other modesetting features, like i2c and DDC | |
269 | * bus accessors. | |
270 | */ | |
271 | struct drm_crtc_funcs { | |
88548636 DV |
272 | /** |
273 | * @reset: | |
274 | * | |
275 | * Reset CRTC hardware and software state to off. This function isn't | |
276 | * called by the core directly, only through drm_mode_config_reset(). | |
277 | * It's not a helper hook only for historical reasons. | |
278 | * | |
279 | * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset | |
280 | * atomic state using this hook. | |
281 | */ | |
eb033556 | 282 | void (*reset)(struct drm_crtc *crtc); |
f453ba04 | 283 | |
f6da8c6e DV |
284 | /** |
285 | * @cursor_set: | |
286 | * | |
287 | * Update the cursor image. The cursor position is relative to the CRTC | |
288 | * and can be partially or fully outside of the visible area. | |
289 | * | |
290 | * Note that contrary to all other KMS functions the legacy cursor entry | |
291 | * points don't take a framebuffer object, but instead take directly a | |
292 | * raw buffer object id from the driver's buffer manager (which is | |
293 | * either GEM or TTM for current drivers). | |
294 | * | |
295 | * This entry point is deprecated, drivers should instead implement | |
296 | * universal plane support and register a proper cursor plane using | |
297 | * drm_crtc_init_with_planes(). | |
298 | * | |
299 | * This callback is optional | |
300 | * | |
301 | * RETURNS: | |
302 | * | |
303 | * 0 on success or a negative error code on failure. | |
304 | */ | |
f453ba04 DA |
305 | int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv, |
306 | uint32_t handle, uint32_t width, uint32_t height); | |
f6da8c6e DV |
307 | |
308 | /** | |
309 | * @cursor_set2: | |
310 | * | |
311 | * Update the cursor image, including hotspot information. The hotspot | |
312 | * must not affect the cursor position in CRTC coordinates, but is only | |
313 | * meant as a hint for virtualized display hardware to coordinate the | |
314 | * guests and hosts cursor position. The cursor hotspot is relative to | |
315 | * the cursor image. Otherwise this works exactly like @cursor_set. | |
316 | * | |
317 | * This entry point is deprecated, drivers should instead implement | |
318 | * universal plane support and register a proper cursor plane using | |
319 | * drm_crtc_init_with_planes(). | |
320 | * | |
321 | * This callback is optional. | |
322 | * | |
323 | * RETURNS: | |
324 | * | |
325 | * 0 on success or a negative error code on failure. | |
326 | */ | |
4c813d4d DA |
327 | int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv, |
328 | uint32_t handle, uint32_t width, uint32_t height, | |
329 | int32_t hot_x, int32_t hot_y); | |
f6da8c6e DV |
330 | |
331 | /** | |
332 | * @cursor_move: | |
333 | * | |
334 | * Update the cursor position. The cursor does not need to be visible | |
335 | * when this hook is called. | |
336 | * | |
337 | * This entry point is deprecated, drivers should instead implement | |
338 | * universal plane support and register a proper cursor plane using | |
339 | * drm_crtc_init_with_planes(). | |
340 | * | |
341 | * This callback is optional. | |
342 | * | |
343 | * RETURNS: | |
344 | * | |
345 | * 0 on success or a negative error code on failure. | |
346 | */ | |
f453ba04 DA |
347 | int (*cursor_move)(struct drm_crtc *crtc, int x, int y); |
348 | ||
f6da8c6e DV |
349 | /** |
350 | * @gamma_set: | |
351 | * | |
352 | * Set gamma on the CRTC. | |
353 | * | |
354 | * This callback is optional. | |
355 | * | |
2e38178e DV |
356 | * Atomic drivers who want to support gamma tables should implement the |
357 | * atomic color management support, enabled by calling | |
358 | * drm_crtc_enable_color_mgmt(), which then supports the legacy gamma | |
359 | * interface through the drm_atomic_helper_legacy_gamma_set() | |
360 | * compatibility implementation. | |
f6da8c6e | 361 | */ |
7ea77283 | 362 | int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b, |
6d124ff8 DV |
363 | uint32_t size, |
364 | struct drm_modeset_acquire_ctx *ctx); | |
88548636 DV |
365 | |
366 | /** | |
367 | * @destroy: | |
368 | * | |
369 | * Clean up plane resources. This is only called at driver unload time | |
370 | * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged | |
371 | * in DRM. | |
372 | */ | |
f453ba04 DA |
373 | void (*destroy)(struct drm_crtc *crtc); |
374 | ||
f6da8c6e DV |
375 | /** |
376 | * @set_config: | |
377 | * | |
378 | * This is the main legacy entry point to change the modeset state on a | |
379 | * CRTC. All the details of the desired configuration are passed in a | |
ea0dd85a | 380 | * &struct drm_mode_set - see there for details. |
f6da8c6e DV |
381 | * |
382 | * Drivers implementing atomic modeset should use | |
383 | * drm_atomic_helper_set_config() to implement this hook. | |
384 | * | |
385 | * RETURNS: | |
386 | * | |
387 | * 0 on success or a negative error code on failure. | |
388 | */ | |
a4eff9aa DV |
389 | int (*set_config)(struct drm_mode_set *set, |
390 | struct drm_modeset_acquire_ctx *ctx); | |
d91d8a3f | 391 | |
f6da8c6e DV |
392 | /** |
393 | * @page_flip: | |
394 | * | |
395 | * Legacy entry point to schedule a flip to the given framebuffer. | |
396 | * | |
397 | * Page flipping is a synchronization mechanism that replaces the frame | |
398 | * buffer being scanned out by the CRTC with a new frame buffer during | |
399 | * vertical blanking, avoiding tearing (except when requested otherwise | |
400 | * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application | |
401 | * requests a page flip the DRM core verifies that the new frame buffer | |
402 | * is large enough to be scanned out by the CRTC in the currently | |
d574528a DV |
403 | * configured mode and then calls this hook with a pointer to the new |
404 | * frame buffer. | |
f6da8c6e DV |
405 | * |
406 | * The driver must wait for any pending rendering to the new framebuffer | |
407 | * to complete before executing the flip. It should also wait for any | |
408 | * pending rendering from other drivers if the underlying buffer is a | |
409 | * shared dma-buf. | |
410 | * | |
411 | * An application can request to be notified when the page flip has | |
ea0dd85a | 412 | * completed. The drm core will supply a &struct drm_event in the event |
f6da8c6e DV |
413 | * parameter in this case. This can be handled by the |
414 | * drm_crtc_send_vblank_event() function, which the driver should call on | |
415 | * the provided event upon completion of the flip. Note that if | |
416 | * the driver supports vblank signalling and timestamping the vblank | |
417 | * counters and timestamps must agree with the ones returned from page | |
418 | * flip events. With the current vblank helper infrastructure this can | |
419 | * be achieved by holding a vblank reference while the page flip is | |
420 | * pending, acquired through drm_crtc_vblank_get() and released with | |
421 | * drm_crtc_vblank_put(). Drivers are free to implement their own vblank | |
422 | * counter and timestamp tracking though, e.g. if they have accurate | |
423 | * timestamp registers in hardware. | |
424 | * | |
f6da8c6e DV |
425 | * This callback is optional. |
426 | * | |
427 | * NOTE: | |
428 | * | |
429 | * Very early versions of the KMS ABI mandated that the driver must | |
430 | * block (but not reject) any rendering to the old framebuffer until the | |
431 | * flip operation has completed and the old framebuffer is no longer | |
432 | * visible. This requirement has been lifted, and userspace is instead | |
433 | * expected to request delivery of an event and wait with recycling old | |
434 | * buffers until such has been received. | |
435 | * | |
436 | * RETURNS: | |
437 | * | |
438 | * 0 on success or a negative error code on failure. Note that if a | |
d574528a | 439 | * page flip operation is already pending the callback should return |
f6da8c6e DV |
440 | * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode |
441 | * or just runtime disabled through DPMS respectively the new atomic | |
4cba6850 DV |
442 | * "ACTIVE" state) should result in an -EINVAL error code. Note that |
443 | * drm_atomic_helper_page_flip() checks this already for atomic drivers. | |
d91d8a3f KH |
444 | */ |
445 | int (*page_flip)(struct drm_crtc *crtc, | |
446 | struct drm_framebuffer *fb, | |
ed8d1975 | 447 | struct drm_pending_vblank_event *event, |
41292b1f DV |
448 | uint32_t flags, |
449 | struct drm_modeset_acquire_ctx *ctx); | |
bffd9de0 | 450 | |
c229bfbb MD |
451 | /** |
452 | * @page_flip_target: | |
453 | * | |
454 | * Same as @page_flip but with an additional parameter specifying the | |
455 | * absolute target vertical blank period (as reported by | |
456 | * drm_crtc_vblank_count()) when the flip should take effect. | |
457 | * | |
458 | * Note that the core code calls drm_crtc_vblank_get before this entry | |
459 | * point, and will call drm_crtc_vblank_put if this entry point returns | |
460 | * any non-0 error code. It's the driver's responsibility to call | |
461 | * drm_crtc_vblank_put after this entry point returns 0, typically when | |
462 | * the flip completes. | |
463 | */ | |
464 | int (*page_flip_target)(struct drm_crtc *crtc, | |
465 | struct drm_framebuffer *fb, | |
466 | struct drm_pending_vblank_event *event, | |
41292b1f DV |
467 | uint32_t flags, uint32_t target, |
468 | struct drm_modeset_acquire_ctx *ctx); | |
c229bfbb | 469 | |
88548636 DV |
470 | /** |
471 | * @set_property: | |
472 | * | |
473 | * This is the legacy entry point to update a property attached to the | |
474 | * CRTC. | |
475 | * | |
476 | * Drivers implementing atomic modeset should use | |
477 | * drm_atomic_helper_crtc_set_property() to implement this hook. | |
478 | * | |
479 | * This callback is optional if the driver does not support any legacy | |
480 | * driver-private properties. | |
481 | * | |
482 | * RETURNS: | |
483 | * | |
484 | * 0 on success or a negative error code on failure. | |
485 | */ | |
bffd9de0 PZ |
486 | int (*set_property)(struct drm_crtc *crtc, |
487 | struct drm_property *property, uint64_t val); | |
144ecb97 | 488 | |
88548636 DV |
489 | /** |
490 | * @atomic_duplicate_state: | |
491 | * | |
492 | * Duplicate the current atomic state for this CRTC and return it. | |
d574528a | 493 | * The core and helpers guarantee that any atomic state duplicated with |
88548636 | 494 | * this hook and still owned by the caller (i.e. not transferred to the |
d574528a DV |
495 | * driver by calling &drm_mode_config_funcs.atomic_commit) will be |
496 | * cleaned up by calling the @atomic_destroy_state hook in this | |
497 | * structure. | |
88548636 | 498 | * |
d574528a | 499 | * Atomic drivers which don't subclass &struct drm_crtc_state should use |
88548636 DV |
500 | * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the |
501 | * state structure to extend it with driver-private state should use | |
502 | * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is | |
503 | * duplicated in a consistent fashion across drivers. | |
504 | * | |
d574528a | 505 | * It is an error to call this hook before &drm_crtc.state has been |
88548636 DV |
506 | * initialized correctly. |
507 | * | |
508 | * NOTE: | |
509 | * | |
510 | * If the duplicate state references refcounted resources this hook must | |
511 | * acquire a reference for each of them. The driver must release these | |
512 | * references again in @atomic_destroy_state. | |
513 | * | |
514 | * RETURNS: | |
515 | * | |
516 | * Duplicated atomic state or NULL when the allocation failed. | |
517 | */ | |
144ecb97 | 518 | struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc); |
88548636 DV |
519 | |
520 | /** | |
521 | * @atomic_destroy_state: | |
522 | * | |
523 | * Destroy a state duplicated with @atomic_duplicate_state and release | |
524 | * or unreference all resources it references | |
525 | */ | |
144ecb97 | 526 | void (*atomic_destroy_state)(struct drm_crtc *crtc, |
cc4ceb48 | 527 | struct drm_crtc_state *state); |
88548636 DV |
528 | |
529 | /** | |
530 | * @atomic_set_property: | |
531 | * | |
532 | * Decode a driver-private property value and store the decoded value | |
533 | * into the passed-in state structure. Since the atomic core decodes all | |
534 | * standardized properties (even for extensions beyond the core set of | |
535 | * properties which might not be implemented by all drivers) this | |
536 | * requires drivers to subclass the state structure. | |
537 | * | |
538 | * Such driver-private properties should really only be implemented for | |
539 | * truly hardware/vendor specific state. Instead it is preferred to | |
540 | * standardize atomic extension and decode the properties used to expose | |
541 | * such an extension in the core. | |
542 | * | |
543 | * Do not call this function directly, use | |
544 | * drm_atomic_crtc_set_property() instead. | |
545 | * | |
546 | * This callback is optional if the driver does not support any | |
547 | * driver-private atomic properties. | |
548 | * | |
549 | * NOTE: | |
550 | * | |
551 | * This function is called in the state assembly phase of atomic | |
552 | * modesets, which can be aborted for any reason (including on | |
553 | * userspace's request to just check whether a configuration would be | |
554 | * possible). Drivers MUST NOT touch any persistent state (hardware or | |
555 | * software) or data structures except the passed in @state parameter. | |
556 | * | |
557 | * Also since userspace controls in which order properties are set this | |
558 | * function must not do any input validation (since the state update is | |
559 | * incomplete and hence likely inconsistent). Instead any such input | |
560 | * validation must be done in the various atomic_check callbacks. | |
561 | * | |
562 | * RETURNS: | |
563 | * | |
564 | * 0 if the property has been found, -EINVAL if the property isn't | |
565 | * implemented by the driver (which should never happen, the core only | |
566 | * asks for properties attached to this CRTC). No other validation is | |
567 | * allowed by the driver. The core already checks that the property | |
568 | * value is within the range (integer, valid enum value, ...) the driver | |
569 | * set when registering the property. | |
570 | */ | |
144ecb97 DV |
571 | int (*atomic_set_property)(struct drm_crtc *crtc, |
572 | struct drm_crtc_state *state, | |
573 | struct drm_property *property, | |
574 | uint64_t val); | |
88548636 DV |
575 | /** |
576 | * @atomic_get_property: | |
577 | * | |
578 | * Reads out the decoded driver-private property. This is used to | |
c6b0ca3e | 579 | * implement the GETCRTC IOCTL. |
88548636 DV |
580 | * |
581 | * Do not call this function directly, use | |
582 | * drm_atomic_crtc_get_property() instead. | |
583 | * | |
584 | * This callback is optional if the driver does not support any | |
585 | * driver-private atomic properties. | |
586 | * | |
587 | * RETURNS: | |
588 | * | |
589 | * 0 on success, -EINVAL if the property isn't implemented by the | |
590 | * driver (which should never happen, the core only asks for | |
591 | * properties attached to this CRTC). | |
592 | */ | |
ac9c9256 RC |
593 | int (*atomic_get_property)(struct drm_crtc *crtc, |
594 | const struct drm_crtc_state *state, | |
595 | struct drm_property *property, | |
596 | uint64_t *val); | |
79190ea2 BG |
597 | |
598 | /** | |
599 | * @late_register: | |
600 | * | |
601 | * This optional hook can be used to register additional userspace | |
602 | * interfaces attached to the crtc like debugfs interfaces. | |
603 | * It is called late in the driver load sequence from drm_dev_register(). | |
604 | * Everything added from this callback should be unregistered in | |
605 | * the early_unregister callback. | |
606 | * | |
607 | * Returns: | |
608 | * | |
609 | * 0 on success, or a negative error code on failure. | |
610 | */ | |
611 | int (*late_register)(struct drm_crtc *crtc); | |
612 | ||
613 | /** | |
614 | * @early_unregister: | |
615 | * | |
616 | * This optional hook should be used to unregister the additional | |
617 | * userspace interfaces attached to the crtc from | |
559bdaf7 | 618 | * @late_register. It is called from drm_dev_unregister(), |
79190ea2 BG |
619 | * early in the driver unload sequence to disable userspace access |
620 | * before data structures are torndown. | |
621 | */ | |
622 | void (*early_unregister)(struct drm_crtc *crtc); | |
9edbf1fa TV |
623 | |
624 | /** | |
625 | * @set_crc_source: | |
626 | * | |
627 | * Changes the source of CRC checksums of frames at the request of | |
628 | * userspace, typically for testing purposes. The sources available are | |
629 | * specific of each driver and a %NULL value indicates that CRC | |
630 | * generation is to be switched off. | |
631 | * | |
632 | * When CRC generation is enabled, the driver should call | |
633 | * drm_crtc_add_crc_entry() at each frame, providing any information | |
634 | * that characterizes the frame contents in the crcN arguments, as | |
760f71e7 | 635 | * provided from the configured source. Drivers must accept an "auto" |
9edbf1fa TV |
636 | * source name that will select a default source for this CRTC. |
637 | * | |
760f71e7 DV |
638 | * Note that "auto" can depend upon the current modeset configuration, |
639 | * e.g. it could pick an encoder or output specific CRC sampling point. | |
640 | * | |
9edbf1fa TV |
641 | * This callback is optional if the driver does not support any CRC |
642 | * generation functionality. | |
643 | * | |
644 | * RETURNS: | |
645 | * | |
646 | * 0 on success or a negative error code on failure. | |
647 | */ | |
648 | int (*set_crc_source)(struct drm_crtc *crtc, const char *source, | |
649 | size_t *values_cnt); | |
fceffb32 RC |
650 | |
651 | /** | |
652 | * @atomic_print_state: | |
653 | * | |
ea0dd85a | 654 | * If driver subclasses &struct drm_crtc_state, it should implement |
fceffb32 RC |
655 | * this optional hook for printing additional driver specific state. |
656 | * | |
657 | * Do not call this directly, use drm_atomic_crtc_print_state() | |
658 | * instead. | |
659 | */ | |
660 | void (*atomic_print_state)(struct drm_printer *p, | |
661 | const struct drm_crtc_state *state); | |
84e35483 SG |
662 | |
663 | /** | |
664 | * @get_vblank_counter: | |
665 | * | |
666 | * Driver callback for fetching a raw hardware vblank counter for the | |
667 | * CRTC. It's meant to be used by new drivers as the replacement of | |
668 | * &drm_driver.get_vblank_counter hook. | |
669 | * | |
670 | * This callback is optional. If a device doesn't have a hardware | |
671 | * counter, the driver can simply leave the hook as NULL. The DRM core | |
672 | * will account for missed vblank events while interrupts where disabled | |
673 | * based on system timestamps. | |
674 | * | |
675 | * Wraparound handling and loss of events due to modesetting is dealt | |
676 | * with in the DRM core code, as long as drivers call | |
677 | * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or | |
678 | * enabling a CRTC. | |
679 | * | |
57d30230 DV |
680 | * See also &drm_device.vblank_disable_immediate and |
681 | * &drm_device.max_vblank_count. | |
682 | * | |
84e35483 SG |
683 | * Returns: |
684 | * | |
685 | * Raw vblank counter value. | |
686 | */ | |
687 | u32 (*get_vblank_counter)(struct drm_crtc *crtc); | |
688 | ||
689 | /** | |
690 | * @enable_vblank: | |
691 | * | |
692 | * Enable vblank interrupts for the CRTC. It's meant to be used by | |
693 | * new drivers as the replacement of &drm_driver.enable_vblank hook. | |
694 | * | |
695 | * Returns: | |
696 | * | |
697 | * Zero on success, appropriate errno if the vblank interrupt cannot | |
698 | * be enabled. | |
699 | */ | |
700 | int (*enable_vblank)(struct drm_crtc *crtc); | |
701 | ||
702 | /** | |
703 | * @disable_vblank: | |
704 | * | |
705 | * Disable vblank interrupts for the CRTC. It's meant to be used by | |
706 | * new drivers as the replacement of &drm_driver.disable_vblank hook. | |
707 | */ | |
708 | void (*disable_vblank)(struct drm_crtc *crtc); | |
f453ba04 DA |
709 | }; |
710 | ||
711 | /** | |
3bf0401c | 712 | * struct drm_crtc - central CRTC control structure |
7749163e | 713 | * @dev: parent DRM device |
2c0c33d4 | 714 | * @port: OF node used by drm_of_find_possible_crtcs() |
7749163e | 715 | * @head: list management |
ac3ba4a5 | 716 | * @name: human readable name, can be overwritten by the driver |
51fd371b | 717 | * @mutex: per-CRTC locking |
7749163e | 718 | * @base: base KMS object for ID tracking etc. |
e13161af MR |
719 | * @primary: primary plane for this CRTC |
720 | * @cursor: cursor plane for this CRTC | |
2c0c33d4 DV |
721 | * @cursor_x: current x position of the cursor, used for universal cursor planes |
722 | * @cursor_y: current y position of the cursor, used for universal cursor planes | |
f453ba04 | 723 | * @enabled: is this CRTC enabled? |
7749163e JB |
724 | * @mode: current mode timings |
725 | * @hwmode: mode timings as programmed to hw regs | |
f453ba04 DA |
726 | * @x: x position on screen |
727 | * @y: y position on screen | |
f453ba04 | 728 | * @funcs: CRTC control functions |
7749163e JB |
729 | * @gamma_size: size of gamma ramp |
730 | * @gamma_store: gamma ramp values | |
7749163e | 731 | * @helper_private: mid-layer private data |
bffd9de0 | 732 | * @properties: property tracking for this CRTC |
f453ba04 DA |
733 | * |
734 | * Each CRTC may have one or more connectors associated with it. This structure | |
735 | * allows the CRTC to be controlled. | |
736 | */ | |
737 | struct drm_crtc { | |
738 | struct drm_device *dev; | |
7e435aad | 739 | struct device_node *port; |
f453ba04 DA |
740 | struct list_head head; |
741 | ||
fa3ab4c2 VS |
742 | char *name; |
743 | ||
ac3ba4a5 DV |
744 | /** |
745 | * @mutex: | |
29494c17 | 746 | * |
c9e42b72 | 747 | * This provides a read lock for the overall CRTC state (mode, dpms |
29494c17 | 748 | * state, ...) and a write lock for everything which can be update |
c9e42b72 | 749 | * without a full modeset (fb, cursor data, CRTC properties ...). A full |
d574528a | 750 | * modeset also need to grab &drm_mode_config.connection_mutex. |
c9e42b72 DV |
751 | * |
752 | * For atomic drivers specifically this protects @state. | |
29494c17 | 753 | */ |
51fd371b | 754 | struct drm_modeset_lock mutex; |
29494c17 | 755 | |
f453ba04 DA |
756 | struct drm_mode_object base; |
757 | ||
e13161af MR |
758 | /* primary and cursor planes for CRTC */ |
759 | struct drm_plane *primary; | |
760 | struct drm_plane *cursor; | |
761 | ||
96094081 DV |
762 | /** |
763 | * @index: Position inside the mode_config.list, can be used as an array | |
764 | * index. It is invariant over the lifetime of the CRTC. | |
765 | */ | |
490d3d1b CW |
766 | unsigned index; |
767 | ||
161d0dc1 MR |
768 | /* position of cursor plane on crtc */ |
769 | int cursor_x; | |
770 | int cursor_y; | |
771 | ||
f453ba04 DA |
772 | bool enabled; |
773 | ||
27641c3f | 774 | /* Requested mode from modesetting. */ |
f453ba04 DA |
775 | struct drm_display_mode mode; |
776 | ||
27641c3f MK |
777 | /* Programmed mode in hw, after adjustments for encoders, |
778 | * crtc, panel scaling etc. Needed for timestamping etc. | |
779 | */ | |
780 | struct drm_display_mode hwmode; | |
781 | ||
f453ba04 | 782 | int x, y; |
f453ba04 DA |
783 | const struct drm_crtc_funcs *funcs; |
784 | ||
5488dc16 | 785 | /* Legacy FB CRTC gamma size for reporting to userspace */ |
f453ba04 DA |
786 | uint32_t gamma_size; |
787 | uint16_t *gamma_store; | |
788 | ||
789 | /* if you are using the helper */ | |
4490d4c7 | 790 | const struct drm_crtc_helper_funcs *helper_private; |
bffd9de0 PZ |
791 | |
792 | struct drm_object_properties properties; | |
d059f652 | 793 | |
3b24f7d6 DV |
794 | /** |
795 | * @state: | |
796 | * | |
797 | * Current atomic state for this CRTC. | |
c9e42b72 DV |
798 | * |
799 | * This is protected by @mutex. Note that nonblocking atomic commits | |
800 | * access the current CRTC state without taking locks. Either by going | |
801 | * through the &struct drm_atomic_state pointers, see | |
802 | * for_each_crtc_in_state(), for_each_oldnew_crtc_in_state(), | |
803 | * for_each_old_crtc_in_state() and for_each_new_crtc_in_state(). Or | |
804 | * through careful ordering of atomic commit operations as implemented | |
805 | * in the atomic helpers, see &struct drm_crtc_commit. | |
3b24f7d6 | 806 | */ |
144ecb97 DV |
807 | struct drm_crtc_state *state; |
808 | ||
3b24f7d6 DV |
809 | /** |
810 | * @commit_list: | |
811 | * | |
812 | * List of &drm_crtc_commit structures tracking pending commits. | |
813 | * Protected by @commit_lock. This list doesn't hold its own full | |
814 | * reference, but burrows it from the ongoing commit. Commit entries | |
815 | * must be removed from this list once the commit is fully completed, | |
816 | * but before it's correspoding &drm_atomic_state gets destroyed. | |
817 | */ | |
818 | struct list_head commit_list; | |
819 | ||
820 | /** | |
821 | * @commit_lock: | |
822 | * | |
823 | * Spinlock to protect @commit_list. | |
824 | */ | |
825 | spinlock_t commit_lock; | |
826 | ||
9edbf1fa TV |
827 | #ifdef CONFIG_DEBUG_FS |
828 | /** | |
829 | * @debugfs_entry: | |
830 | * | |
831 | * Debugfs directory for this CRTC. | |
832 | */ | |
833 | struct dentry *debugfs_entry; | |
47f6cdd2 | 834 | #endif |
9edbf1fa TV |
835 | |
836 | /** | |
837 | * @crc: | |
838 | * | |
839 | * Configuration settings of CRC capture. | |
840 | */ | |
841 | struct drm_crtc_crc crc; | |
6d6003c4 GP |
842 | |
843 | /** | |
844 | * @fence_context: | |
845 | * | |
846 | * timeline context used for fence operations. | |
847 | */ | |
848 | unsigned int fence_context; | |
849 | ||
850 | /** | |
851 | * @fence_lock: | |
852 | * | |
853 | * spinlock to protect the fences in the fence_context. | |
854 | */ | |
855 | ||
856 | spinlock_t fence_lock; | |
857 | /** | |
858 | * @fence_seqno: | |
859 | * | |
860 | * Seqno variable used as monotonic counter for the fences | |
861 | * created on the CRTC's timeline. | |
862 | */ | |
863 | unsigned long fence_seqno; | |
864 | ||
865 | /** | |
866 | * @timeline_name: | |
867 | * | |
868 | * The name of the CRTC's fence timeline. | |
869 | */ | |
870 | char timeline_name[32]; | |
f453ba04 DA |
871 | }; |
872 | ||
f453ba04 | 873 | /** |
3bf0401c | 874 | * struct drm_mode_set - new values for a CRTC config change |
ef27351a JB |
875 | * @fb: framebuffer to use for new config |
876 | * @crtc: CRTC whose configuration we're about to change | |
877 | * @mode: mode timings to use | |
878 | * @x: position of this CRTC relative to @fb | |
879 | * @y: position of this CRTC relative to @fb | |
880 | * @connectors: array of connectors to drive with this CRTC if possible | |
881 | * @num_connectors: size of @connectors array | |
f453ba04 | 882 | * |
d5d487eb DV |
883 | * This represents a modeset configuration for the legacy SETCRTC ioctl and is |
884 | * also used internally. Atomic drivers instead use &drm_atomic_state. | |
f453ba04 DA |
885 | */ |
886 | struct drm_mode_set { | |
f453ba04 DA |
887 | struct drm_framebuffer *fb; |
888 | struct drm_crtc *crtc; | |
889 | struct drm_display_mode *mode; | |
890 | ||
891 | uint32_t x; | |
892 | uint32_t y; | |
893 | ||
894 | struct drm_connector **connectors; | |
895 | size_t num_connectors; | |
896 | }; | |
897 | ||
f453ba04 | 898 | #define obj_to_crtc(x) container_of(x, struct drm_crtc, base) |
f453ba04 | 899 | |
edd420ea | 900 | __printf(6, 7) |
f9882876 VS |
901 | int drm_crtc_init_with_planes(struct drm_device *dev, |
902 | struct drm_crtc *crtc, | |
903 | struct drm_plane *primary, | |
904 | struct drm_plane *cursor, | |
905 | const struct drm_crtc_funcs *funcs, | |
906 | const char *name, ...); | |
edd420ea | 907 | void drm_crtc_cleanup(struct drm_crtc *crtc); |
490d3d1b CW |
908 | |
909 | /** | |
910 | * drm_crtc_index - find the index of a registered CRTC | |
911 | * @crtc: CRTC to find index for | |
912 | * | |
913 | * Given a registered CRTC, return the index of that CRTC within a DRM | |
914 | * device's list of CRTCs. | |
915 | */ | |
a5bd451b | 916 | static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc) |
490d3d1b CW |
917 | { |
918 | return crtc->index; | |
919 | } | |
db5f7a6e RK |
920 | |
921 | /** | |
922 | * drm_crtc_mask - find the mask of a registered CRTC | |
923 | * @crtc: CRTC to find mask for | |
924 | * | |
925 | * Given a registered CRTC, return the mask bit of that CRTC for an | |
926 | * encoder's possible_crtcs field. | |
927 | */ | |
1dfdb0ed | 928 | static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc) |
db5f7a6e RK |
929 | { |
930 | return 1 << drm_crtc_index(crtc); | |
931 | } | |
f453ba04 | 932 | |
edd420ea DV |
933 | int drm_crtc_force_disable(struct drm_crtc *crtc); |
934 | int drm_crtc_force_disable_all(struct drm_device *dev); | |
8cf5c917 | 935 | |
edd420ea | 936 | int drm_mode_set_config_internal(struct drm_mode_set *set); |
6d1b81d8 | 937 | struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx); |
81065548 | 938 | |
d5d487eb DV |
939 | /** |
940 | * drm_crtc_find - look up a CRTC object from its ID | |
941 | * @dev: DRM device | |
942 | * @id: &drm_mode_object ID | |
943 | * | |
944 | * This can be used to look up a CRTC from its userspace ID. Only used by | |
945 | * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS | |
946 | * userspace interface should be done using &drm_property. | |
947 | */ | |
96f60e37 RK |
948 | static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev, |
949 | uint32_t id) | |
950 | { | |
951 | struct drm_mode_object *mo; | |
952 | mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC); | |
953 | return mo ? obj_to_crtc(mo) : NULL; | |
954 | } | |
955 | ||
d5d487eb DV |
956 | /** |
957 | * drm_for_each_crtc - iterate over all CRTCs | |
958 | * @crtc: a &struct drm_crtc as the loop cursor | |
959 | * @dev: the &struct drm_device | |
960 | * | |
961 | * Iterate over all CRTCs of @dev. | |
962 | */ | |
6295d607 DV |
963 | #define drm_for_each_crtc(crtc, dev) \ |
964 | list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head) | |
965 | ||
f453ba04 | 966 | #endif /* __DRM_CRTC_H__ */ |