xref: /linux/include/drm/drm_crtc.h (revision 13c072b8e91a5ccb5855ca1ba6fe3ea467dbf94d)
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/spinlock.h>
29 #include <linux/types.h>
30 #include <drm/drm_modeset_lock.h>
31 #include <drm/drm_mode_object.h>
32 #include <drm/drm_modes.h>
33 #include <drm/drm_device.h>
34 #include <drm/drm_plane.h>
35 #include <drm/drm_debugfs_crc.h>
36 #include <drm/drm_mode_config.h>
37 
38 struct drm_connector;
39 struct drm_device;
40 struct drm_framebuffer;
41 struct drm_mode_set;
42 struct drm_file;
43 struct drm_printer;
44 struct drm_self_refresh_data;
45 struct device_node;
46 struct edid;
47 
48 static inline int64_t U642I64(uint64_t val)
49 {
50 	return (int64_t)*((int64_t *)&val);
51 }
52 static inline uint64_t I642U64(int64_t val)
53 {
54 	return (uint64_t)*((uint64_t *)&val);
55 }
56 
57 struct drm_crtc;
58 struct drm_pending_vblank_event;
59 struct drm_plane;
60 struct drm_bridge;
61 struct drm_atomic_state;
62 
63 struct drm_crtc_helper_funcs;
64 struct drm_plane_helper_funcs;
65 
66 /**
67  * struct drm_crtc_state - mutable CRTC state
68  *
69  * Note that the distinction between @enable and @active is rather subtle:
70  * Flipping @active while @enable is set without changing anything else may
71  * never return in a failure from the &drm_mode_config_funcs.atomic_check
72  * callback. Userspace assumes that a DPMS On will always succeed. In other
73  * words: @enable controls resource assignment, @active controls the actual
74  * hardware state.
75  *
76  * The three booleans active_changed, connectors_changed and mode_changed are
77  * intended to indicate whether a full modeset is needed, rather than strictly
78  * describing what has changed in a commit. See also:
79  * drm_atomic_crtc_needs_modeset()
80  */
81 struct drm_crtc_state {
82 	/** @crtc: backpointer to the CRTC */
83 	struct drm_crtc *crtc;
84 
85 	/**
86 	 * @enable: Whether the CRTC should be enabled, gates all other state.
87 	 * This controls reservations of shared resources. Actual hardware state
88 	 * is controlled by @active.
89 	 */
90 	bool enable;
91 
92 	/**
93 	 * @active: Whether the CRTC is actively displaying (used for DPMS).
94 	 * Implies that @enable is set. The driver must not release any shared
95 	 * resources if @active is set to false but @enable still true, because
96 	 * userspace expects that a DPMS ON always succeeds.
97 	 *
98 	 * Hence drivers must not consult @active in their various
99 	 * &drm_mode_config_funcs.atomic_check callback to reject an atomic
100 	 * commit. They can consult it to aid in the computation of derived
101 	 * hardware state, since even in the DPMS OFF state the display hardware
102 	 * should be as much powered down as when the CRTC is completely
103 	 * disabled through setting @enable to false.
104 	 */
105 	bool active;
106 
107 	/**
108 	 * @planes_changed: Planes on this crtc are updated. Used by the atomic
109 	 * helpers and drivers to steer the atomic commit control flow.
110 	 */
111 	bool planes_changed : 1;
112 
113 	/**
114 	 * @mode_changed: @mode or @enable has been changed. Used by the atomic
115 	 * helpers and drivers to steer the atomic commit control flow. See also
116 	 * drm_atomic_crtc_needs_modeset().
117 	 *
118 	 * Drivers are supposed to set this for any CRTC state changes that
119 	 * require a full modeset. They can also reset it to false if e.g. a
120 	 * @mode change can be done without a full modeset by only changing
121 	 * scaler settings.
122 	 */
123 	bool mode_changed : 1;
124 
125 	/**
126 	 * @active_changed: @active has been toggled. Used by the atomic
127 	 * helpers and drivers to steer the atomic commit control flow. See also
128 	 * drm_atomic_crtc_needs_modeset().
129 	 */
130 	bool active_changed : 1;
131 
132 	/**
133 	 * @connectors_changed: Connectors to this crtc have been updated,
134 	 * either in their state or routing. Used by the atomic
135 	 * helpers and drivers to steer the atomic commit control flow. See also
136 	 * drm_atomic_crtc_needs_modeset().
137 	 *
138 	 * Drivers are supposed to set this as-needed from their own atomic
139 	 * check code, e.g. from &drm_encoder_helper_funcs.atomic_check
140 	 */
141 	bool connectors_changed : 1;
142 	/**
143 	 * @zpos_changed: zpos values of planes on this crtc have been updated.
144 	 * Used by the atomic helpers and drivers to steer the atomic commit
145 	 * control flow.
146 	 */
147 	bool zpos_changed : 1;
148 	/**
149 	 * @color_mgmt_changed: Color management properties have changed
150 	 * (@gamma_lut, @degamma_lut or @ctm). Used by the atomic helpers and
151 	 * drivers to steer the atomic commit control flow.
152 	 */
153 	bool color_mgmt_changed : 1;
154 
155 	/**
156 	 * @no_vblank:
157 	 *
158 	 * Reflects the ability of a CRTC to send VBLANK events. This state
159 	 * usually depends on the pipeline configuration. If set to true, DRM
160 	 * atomic helpers will send out a fake VBLANK event during display
161 	 * updates after all hardware changes have been committed. This is
162 	 * implemented in drm_atomic_helper_fake_vblank().
163 	 *
164 	 * One usage is for drivers and/or hardware without support for VBLANK
165 	 * interrupts. Such drivers typically do not initialize vblanking
166 	 * (i.e., call drm_vblank_init() with the number of CRTCs). For CRTCs
167 	 * without initialized vblanking, this field is set to true in
168 	 * drm_atomic_helper_check_modeset(), and a fake VBLANK event will be
169 	 * send out on each update of the display pipeline by
170 	 * drm_atomic_helper_fake_vblank().
171 	 *
172 	 * Another usage is CRTCs feeding a writeback connector operating in
173 	 * oneshot mode. In this case the fake VBLANK event is only generated
174 	 * when a job is queued to the writeback connector, and we want the
175 	 * core to fake VBLANK events when this part of the pipeline hasn't
176 	 * changed but others had or when the CRTC and connectors are being
177 	 * disabled.
178 	 *
179 	 * __drm_atomic_helper_crtc_duplicate_state() will not reset the value
180 	 * from the current state, the CRTC driver is then responsible for
181 	 * updating this field when needed.
182 	 *
183 	 * Note that the combination of &drm_crtc_state.event == NULL and
184 	 * &drm_crtc_state.no_blank == true is valid and usually used when the
185 	 * writeback connector attached to the CRTC has a new job queued. In
186 	 * this case the driver will send the VBLANK event on its own when the
187 	 * writeback job is complete.
188 	 */
189 	bool no_vblank;
190 
191 	/**
192 	 * @plane_mask: Bitmask of drm_plane_mask(plane) of planes attached to
193 	 * this CRTC.
194 	 */
195 	u32 plane_mask;
196 
197 	/**
198 	 * @connector_mask: Bitmask of drm_connector_mask(connector) of
199 	 * connectors attached to this CRTC.
200 	 */
201 	u32 connector_mask;
202 
203 	/**
204 	 * @encoder_mask: Bitmask of drm_encoder_mask(encoder) of encoders
205 	 * attached to this CRTC.
206 	 */
207 	u32 encoder_mask;
208 
209 	/**
210 	 * @adjusted_mode:
211 	 *
212 	 * Internal display timings which can be used by the driver to handle
213 	 * differences between the mode requested by userspace in @mode and what
214 	 * is actually programmed into the hardware.
215 	 *
216 	 * For drivers using &drm_bridge, this stores hardware display timings
217 	 * used between the CRTC and the first bridge. For other drivers, the
218 	 * meaning of the adjusted_mode field is purely driver implementation
219 	 * defined information, and will usually be used to store the hardware
220 	 * display timings used between the CRTC and encoder blocks.
221 	 */
222 	struct drm_display_mode adjusted_mode;
223 
224 	/**
225 	 * @mode:
226 	 *
227 	 * Display timings requested by userspace. The driver should try to
228 	 * match the refresh rate as close as possible (but note that it's
229 	 * undefined what exactly is close enough, e.g. some of the HDMI modes
230 	 * only differ in less than 1% of the refresh rate). The active width
231 	 * and height as observed by userspace for positioning planes must match
232 	 * exactly.
233 	 *
234 	 * For external connectors where the sink isn't fixed (like with a
235 	 * built-in panel), this mode here should match the physical mode on the
236 	 * wire to the last details (i.e. including sync polarities and
237 	 * everything).
238 	 */
239 	struct drm_display_mode mode;
240 
241 	/**
242 	 * @mode_blob: &drm_property_blob for @mode, for exposing the mode to
243 	 * atomic userspace.
244 	 */
245 	struct drm_property_blob *mode_blob;
246 
247 	/**
248 	 * @degamma_lut:
249 	 *
250 	 * Lookup table for converting framebuffer pixel data before apply the
251 	 * color conversion matrix @ctm. See drm_crtc_enable_color_mgmt(). The
252 	 * blob (if not NULL) is an array of &struct drm_color_lut.
253 	 */
254 	struct drm_property_blob *degamma_lut;
255 
256 	/**
257 	 * @ctm:
258 	 *
259 	 * Color transformation matrix. See drm_crtc_enable_color_mgmt(). The
260 	 * blob (if not NULL) is a &struct drm_color_ctm.
261 	 */
262 	struct drm_property_blob *ctm;
263 
264 	/**
265 	 * @gamma_lut:
266 	 *
267 	 * Lookup table for converting pixel data after the color conversion
268 	 * matrix @ctm.  See drm_crtc_enable_color_mgmt(). The blob (if not
269 	 * NULL) is an array of &struct drm_color_lut.
270 	 *
271 	 * Note that for mostly historical reasons stemming from Xorg heritage,
272 	 * this is also used to store the color map (also sometimes color lut,
273 	 * CLUT or color palette) for indexed formats like DRM_FORMAT_C8.
274 	 */
275 	struct drm_property_blob *gamma_lut;
276 
277 	/**
278 	 * @background_color:
279 	 *
280 	 * RGB value representing the CRTC's background color.  The background
281 	 * color (aka "canvas color") of a CRTC is the color that will be used
282 	 * for pixels not covered by a plane, or covered by transparent pixels
283 	 * of a plane.  The value here should be built using DRM_ARGB64_PREP*()
284 	 * helpers, while the individual color components can be extracted with
285 	 * desired precision via the DRM_ARGB64_GET*() macros.
286 	 */
287 	u64 background_color;
288 
289 	/**
290 	 * @target_vblank:
291 	 *
292 	 * Target vertical blank period when a page flip
293 	 * should take effect.
294 	 */
295 	u32 target_vblank;
296 
297 	/**
298 	 * @async_flip:
299 	 *
300 	 * This is set when DRM_MODE_PAGE_FLIP_ASYNC is set in the legacy
301 	 * PAGE_FLIP IOCTL. It's not wired up for the atomic IOCTL itself yet.
302 	 */
303 	bool async_flip;
304 
305 	/**
306 	 * @vrr_enabled:
307 	 *
308 	 * Indicates if variable refresh rate should be enabled for the CRTC.
309 	 * Support for the requested vrr state will depend on driver and
310 	 * hardware capabiltiy - lacking support is not treated as failure.
311 	 */
312 	bool vrr_enabled;
313 
314 	/**
315 	 * @self_refresh_active:
316 	 *
317 	 * Used by the self refresh helpers to denote when a self refresh
318 	 * transition is occurring. This will be set on enable/disable callbacks
319 	 * when self refresh is being enabled or disabled. In some cases, it may
320 	 * not be desirable to fully shut off the crtc during self refresh.
321 	 * CRTC's can inspect this flag and determine the best course of action.
322 	 */
323 	bool self_refresh_active;
324 
325 	/**
326 	 * @scaling_filter:
327 	 *
328 	 * Scaling filter to be applied
329 	 */
330 	enum drm_scaling_filter scaling_filter;
331 
332 	/**
333 	 * @sharpness_strength:
334 	 *
335 	 * Used by the user to set the sharpness intensity.
336 	 * The value ranges from 0-255.
337 	 * Default value is 0 which disable the sharpness feature.
338 	 * Any value greater than 0 enables sharpening with the
339 	 * specified strength.
340 	 */
341 	u8 sharpness_strength;
342 
343 	/**
344 	 * @event:
345 	 *
346 	 * Optional pointer to a DRM event to signal upon completion of the
347 	 * state update. The driver must send out the event when the atomic
348 	 * commit operation completes. There are two cases:
349 	 *
350 	 *  - The event is for a CRTC which is being disabled through this
351 	 *    atomic commit. In that case the event can be send out any time
352 	 *    after the hardware has stopped scanning out the current
353 	 *    framebuffers. It should contain the timestamp and counter for the
354 	 *    last vblank before the display pipeline was shut off. The simplest
355 	 *    way to achieve that is calling drm_crtc_send_vblank_event()
356 	 *    somewhen after drm_crtc_vblank_off() has been called.
357 	 *
358 	 *  - For a CRTC which is enabled at the end of the commit (even when it
359 	 *    undergoes an full modeset) the vblank timestamp and counter must
360 	 *    be for the vblank right before the first frame that scans out the
361 	 *    new set of buffers. Again the event can only be sent out after the
362 	 *    hardware has stopped scanning out the old buffers.
363 	 *
364 	 *  - Events for disabled CRTCs are not allowed, and drivers can ignore
365 	 *    that case.
366 	 *
367 	 * For very simple hardware without VBLANK interrupt, enabling
368 	 * &struct drm_crtc_state.no_vblank makes DRM's atomic commit helpers
369 	 * send a fake VBLANK event at the end of the display update after all
370 	 * hardware changes have been applied. See
371 	 * drm_atomic_helper_fake_vblank().
372 	 *
373 	 * For more complex hardware this
374 	 * can be handled by the drm_crtc_send_vblank_event() function,
375 	 * which the driver should call on the provided event upon completion of
376 	 * the atomic commit. Note that if the driver supports vblank signalling
377 	 * and timestamping the vblank counters and timestamps must agree with
378 	 * the ones returned from page flip events. With the current vblank
379 	 * helper infrastructure this can be achieved by holding a vblank
380 	 * reference while the page flip is pending, acquired through
381 	 * drm_crtc_vblank_get() and released with drm_crtc_vblank_put().
382 	 * Drivers are free to implement their own vblank counter and timestamp
383 	 * tracking though, e.g. if they have accurate timestamp registers in
384 	 * hardware.
385 	 *
386 	 * For hardware which supports some means to synchronize vblank
387 	 * interrupt delivery with committing display state there's also
388 	 * drm_crtc_arm_vblank_event(). See the documentation of that function
389 	 * for a detailed discussion of the constraints it needs to be used
390 	 * safely.
391 	 *
392 	 * If the device can't notify of flip completion in a race-free way
393 	 * at all, then the event should be armed just after the page flip is
394 	 * committed. In the worst case the driver will send the event to
395 	 * userspace one frame too late. This doesn't allow for a real atomic
396 	 * update, but it should avoid tearing.
397 	 */
398 	struct drm_pending_vblank_event *event;
399 
400 	/**
401 	 * @commit:
402 	 *
403 	 * This tracks how the commit for this update proceeds through the
404 	 * various phases. This is never cleared, except when we destroy the
405 	 * state, so that subsequent commits can synchronize with previous ones.
406 	 */
407 	struct drm_crtc_commit *commit;
408 
409 	/** @state: backpointer to global drm_atomic_state */
410 	struct drm_atomic_state *state;
411 };
412 
413 /**
414  * struct drm_crtc_funcs - control CRTCs for a given device
415  *
416  * The drm_crtc_funcs structure is the central CRTC management structure
417  * in the DRM.  Each CRTC controls one or more connectors (note that the name
418  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
419  * connectors, not just CRTs).
420  *
421  * Each driver is responsible for filling out this structure at startup time,
422  * in addition to providing other modesetting features, like i2c and DDC
423  * bus accessors.
424  */
425 struct drm_crtc_funcs {
426 	/**
427 	 * @reset:
428 	 *
429 	 * Reset CRTC hardware and software state to off. This function isn't
430 	 * called by the core directly, only through drm_mode_config_reset().
431 	 * It's not a helper hook only for historical reasons.
432 	 *
433 	 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
434 	 * atomic state using this hook.
435 	 */
436 	void (*reset)(struct drm_crtc *crtc);
437 
438 	/**
439 	 * @cursor_set:
440 	 *
441 	 * Update the cursor image. The cursor position is relative to the CRTC
442 	 * and can be partially or fully outside of the visible area.
443 	 *
444 	 * Note that contrary to all other KMS functions the legacy cursor entry
445 	 * points don't take a framebuffer object, but instead take directly a
446 	 * raw buffer object id from the driver's buffer manager (which is
447 	 * either GEM or TTM for current drivers).
448 	 *
449 	 * This entry point is deprecated, drivers should instead implement
450 	 * universal plane support and register a proper cursor plane using
451 	 * drm_crtc_init_with_planes().
452 	 *
453 	 * This callback is optional
454 	 *
455 	 * RETURNS:
456 	 *
457 	 * 0 on success or a negative error code on failure.
458 	 */
459 	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
460 			  uint32_t handle, uint32_t width, uint32_t height);
461 
462 	/**
463 	 * @cursor_set2:
464 	 *
465 	 * Update the cursor image, including hotspot information. The hotspot
466 	 * must not affect the cursor position in CRTC coordinates, but is only
467 	 * meant as a hint for virtualized display hardware to coordinate the
468 	 * guests and hosts cursor position. The cursor hotspot is relative to
469 	 * the cursor image. Otherwise this works exactly like @cursor_set.
470 	 *
471 	 * This entry point is deprecated, drivers should instead implement
472 	 * universal plane support and register a proper cursor plane using
473 	 * drm_crtc_init_with_planes().
474 	 *
475 	 * This callback is optional.
476 	 *
477 	 * RETURNS:
478 	 *
479 	 * 0 on success or a negative error code on failure.
480 	 */
481 	int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
482 			   uint32_t handle, uint32_t width, uint32_t height,
483 			   int32_t hot_x, int32_t hot_y);
484 
485 	/**
486 	 * @cursor_move:
487 	 *
488 	 * Update the cursor position. The cursor does not need to be visible
489 	 * when this hook is called.
490 	 *
491 	 * This entry point is deprecated, drivers should instead implement
492 	 * universal plane support and register a proper cursor plane using
493 	 * drm_crtc_init_with_planes().
494 	 *
495 	 * This callback is optional.
496 	 *
497 	 * RETURNS:
498 	 *
499 	 * 0 on success or a negative error code on failure.
500 	 */
501 	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
502 
503 	/**
504 	 * @gamma_set:
505 	 *
506 	 * Set gamma on the CRTC.
507 	 *
508 	 * This callback is optional.
509 	 *
510 	 * Atomic drivers who want to support gamma tables should implement the
511 	 * atomic color management support, enabled by calling
512 	 * drm_crtc_enable_color_mgmt(), which then supports the legacy gamma
513 	 * interface through the drm_atomic_helper_legacy_gamma_set()
514 	 * compatibility implementation.
515 	 */
516 	int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
517 			 uint32_t size,
518 			 struct drm_modeset_acquire_ctx *ctx);
519 
520 	/**
521 	 * @destroy:
522 	 *
523 	 * Clean up CRTC resources. This is only called at driver unload time
524 	 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
525 	 * in DRM.
526 	 */
527 	void (*destroy)(struct drm_crtc *crtc);
528 
529 	/**
530 	 * @set_config:
531 	 *
532 	 * This is the main legacy entry point to change the modeset state on a
533 	 * CRTC. All the details of the desired configuration are passed in a
534 	 * &struct drm_mode_set - see there for details.
535 	 *
536 	 * Drivers implementing atomic modeset should use
537 	 * drm_atomic_helper_set_config() to implement this hook.
538 	 *
539 	 * RETURNS:
540 	 *
541 	 * 0 on success or a negative error code on failure.
542 	 */
543 	int (*set_config)(struct drm_mode_set *set,
544 			  struct drm_modeset_acquire_ctx *ctx);
545 
546 	/**
547 	 * @page_flip:
548 	 *
549 	 * Legacy entry point to schedule a flip to the given framebuffer.
550 	 *
551 	 * Page flipping is a synchronization mechanism that replaces the frame
552 	 * buffer being scanned out by the CRTC with a new frame buffer during
553 	 * vertical blanking, avoiding tearing (except when requested otherwise
554 	 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
555 	 * requests a page flip the DRM core verifies that the new frame buffer
556 	 * is large enough to be scanned out by the CRTC in the currently
557 	 * configured mode and then calls this hook with a pointer to the new
558 	 * frame buffer.
559 	 *
560 	 * The driver must wait for any pending rendering to the new framebuffer
561 	 * to complete before executing the flip. It should also wait for any
562 	 * pending rendering from other drivers if the underlying buffer is a
563 	 * shared dma-buf.
564 	 *
565 	 * An application can request to be notified when the page flip has
566 	 * completed. The drm core will supply a &struct drm_event in the event
567 	 * parameter in this case. This can be handled by the
568 	 * drm_crtc_send_vblank_event() function, which the driver should call on
569 	 * the provided event upon completion of the flip. Note that if
570 	 * the driver supports vblank signalling and timestamping the vblank
571 	 * counters and timestamps must agree with the ones returned from page
572 	 * flip events. With the current vblank helper infrastructure this can
573 	 * be achieved by holding a vblank reference while the page flip is
574 	 * pending, acquired through drm_crtc_vblank_get() and released with
575 	 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
576 	 * counter and timestamp tracking though, e.g. if they have accurate
577 	 * timestamp registers in hardware.
578 	 *
579 	 * This callback is optional.
580 	 *
581 	 * NOTE:
582 	 *
583 	 * Very early versions of the KMS ABI mandated that the driver must
584 	 * block (but not reject) any rendering to the old framebuffer until the
585 	 * flip operation has completed and the old framebuffer is no longer
586 	 * visible. This requirement has been lifted, and userspace is instead
587 	 * expected to request delivery of an event and wait with recycling old
588 	 * buffers until such has been received.
589 	 *
590 	 * RETURNS:
591 	 *
592 	 * 0 on success or a negative error code on failure. Note that if a
593 	 * page flip operation is already pending the callback should return
594 	 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
595 	 * or just runtime disabled through DPMS respectively the new atomic
596 	 * "ACTIVE" state) should result in an -EINVAL error code. Note that
597 	 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
598 	 */
599 	int (*page_flip)(struct drm_crtc *crtc,
600 			 struct drm_framebuffer *fb,
601 			 struct drm_pending_vblank_event *event,
602 			 uint32_t flags,
603 			 struct drm_modeset_acquire_ctx *ctx);
604 
605 	/**
606 	 * @page_flip_target:
607 	 *
608 	 * Same as @page_flip but with an additional parameter specifying the
609 	 * absolute target vertical blank period (as reported by
610 	 * drm_crtc_vblank_count()) when the flip should take effect.
611 	 *
612 	 * Note that the core code calls drm_crtc_vblank_get before this entry
613 	 * point, and will call drm_crtc_vblank_put if this entry point returns
614 	 * any non-0 error code. It's the driver's responsibility to call
615 	 * drm_crtc_vblank_put after this entry point returns 0, typically when
616 	 * the flip completes.
617 	 */
618 	int (*page_flip_target)(struct drm_crtc *crtc,
619 				struct drm_framebuffer *fb,
620 				struct drm_pending_vblank_event *event,
621 				uint32_t flags, uint32_t target,
622 				struct drm_modeset_acquire_ctx *ctx);
623 
624 	/**
625 	 * @set_property:
626 	 *
627 	 * This is the legacy entry point to update a property attached to the
628 	 * CRTC.
629 	 *
630 	 * This callback is optional if the driver does not support any legacy
631 	 * driver-private properties. For atomic drivers it is not used because
632 	 * property handling is done entirely in the DRM core.
633 	 *
634 	 * RETURNS:
635 	 *
636 	 * 0 on success or a negative error code on failure.
637 	 */
638 	int (*set_property)(struct drm_crtc *crtc,
639 			    struct drm_property *property, uint64_t val);
640 
641 	/**
642 	 * @atomic_duplicate_state:
643 	 *
644 	 * Duplicate the current atomic state for this CRTC and return it.
645 	 * The core and helpers guarantee that any atomic state duplicated with
646 	 * this hook and still owned by the caller (i.e. not transferred to the
647 	 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
648 	 * cleaned up by calling the @atomic_destroy_state hook in this
649 	 * structure.
650 	 *
651 	 * This callback is mandatory for atomic drivers.
652 	 *
653 	 * Atomic drivers which don't subclass &struct drm_crtc_state should use
654 	 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
655 	 * state structure to extend it with driver-private state should use
656 	 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
657 	 * duplicated in a consistent fashion across drivers.
658 	 *
659 	 * It is an error to call this hook before &drm_crtc.state has been
660 	 * initialized correctly.
661 	 *
662 	 * NOTE:
663 	 *
664 	 * If the duplicate state references refcounted resources this hook must
665 	 * acquire a reference for each of them. The driver must release these
666 	 * references again in @atomic_destroy_state.
667 	 *
668 	 * RETURNS:
669 	 *
670 	 * Duplicated atomic state or NULL when the allocation failed.
671 	 */
672 	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
673 
674 	/**
675 	 * @atomic_destroy_state:
676 	 *
677 	 * Destroy a state duplicated with @atomic_duplicate_state and release
678 	 * or unreference all resources it references
679 	 *
680 	 * This callback is mandatory for atomic drivers.
681 	 */
682 	void (*atomic_destroy_state)(struct drm_crtc *crtc,
683 				     struct drm_crtc_state *state);
684 
685 	/**
686 	 * @atomic_set_property:
687 	 *
688 	 * Decode a driver-private property value and store the decoded value
689 	 * into the passed-in state structure. Since the atomic core decodes all
690 	 * standardized properties (even for extensions beyond the core set of
691 	 * properties which might not be implemented by all drivers) this
692 	 * requires drivers to subclass the state structure.
693 	 *
694 	 * Such driver-private properties should really only be implemented for
695 	 * truly hardware/vendor specific state. Instead it is preferred to
696 	 * standardize atomic extension and decode the properties used to expose
697 	 * such an extension in the core.
698 	 *
699 	 * Do not call this function directly, use
700 	 * drm_atomic_crtc_set_property() instead.
701 	 *
702 	 * This callback is optional if the driver does not support any
703 	 * driver-private atomic properties.
704 	 *
705 	 * NOTE:
706 	 *
707 	 * This function is called in the state assembly phase of atomic
708 	 * modesets, which can be aborted for any reason (including on
709 	 * userspace's request to just check whether a configuration would be
710 	 * possible). Drivers MUST NOT touch any persistent state (hardware or
711 	 * software) or data structures except the passed in @state parameter.
712 	 *
713 	 * Also since userspace controls in which order properties are set this
714 	 * function must not do any input validation (since the state update is
715 	 * incomplete and hence likely inconsistent). Instead any such input
716 	 * validation must be done in the various atomic_check callbacks.
717 	 *
718 	 * RETURNS:
719 	 *
720 	 * 0 if the property has been found, -EINVAL if the property isn't
721 	 * implemented by the driver (which should never happen, the core only
722 	 * asks for properties attached to this CRTC). No other validation is
723 	 * allowed by the driver. The core already checks that the property
724 	 * value is within the range (integer, valid enum value, ...) the driver
725 	 * set when registering the property.
726 	 */
727 	int (*atomic_set_property)(struct drm_crtc *crtc,
728 				   struct drm_crtc_state *state,
729 				   struct drm_property *property,
730 				   uint64_t val);
731 	/**
732 	 * @atomic_get_property:
733 	 *
734 	 * Reads out the decoded driver-private property. This is used to
735 	 * implement the GETCRTC IOCTL.
736 	 *
737 	 * Do not call this function directly, use
738 	 * drm_atomic_crtc_get_property() instead.
739 	 *
740 	 * This callback is optional if the driver does not support any
741 	 * driver-private atomic properties.
742 	 *
743 	 * RETURNS:
744 	 *
745 	 * 0 on success, -EINVAL if the property isn't implemented by the
746 	 * driver (which should never happen, the core only asks for
747 	 * properties attached to this CRTC).
748 	 */
749 	int (*atomic_get_property)(struct drm_crtc *crtc,
750 				   const struct drm_crtc_state *state,
751 				   struct drm_property *property,
752 				   uint64_t *val);
753 
754 	/**
755 	 * @late_register:
756 	 *
757 	 * This optional hook can be used to register additional userspace
758 	 * interfaces attached to the crtc like debugfs interfaces.
759 	 * It is called late in the driver load sequence from drm_dev_register().
760 	 * Everything added from this callback should be unregistered in
761 	 * the early_unregister callback.
762 	 *
763 	 * Returns:
764 	 *
765 	 * 0 on success, or a negative error code on failure.
766 	 */
767 	int (*late_register)(struct drm_crtc *crtc);
768 
769 	/**
770 	 * @early_unregister:
771 	 *
772 	 * This optional hook should be used to unregister the additional
773 	 * userspace interfaces attached to the crtc from
774 	 * @late_register. It is called from drm_dev_unregister(),
775 	 * early in the driver unload sequence to disable userspace access
776 	 * before data structures are torndown.
777 	 */
778 	void (*early_unregister)(struct drm_crtc *crtc);
779 
780 	/**
781 	 * @set_crc_source:
782 	 *
783 	 * Changes the source of CRC checksums of frames at the request of
784 	 * userspace, typically for testing purposes. The sources available are
785 	 * specific of each driver and a %NULL value indicates that CRC
786 	 * generation is to be switched off.
787 	 *
788 	 * When CRC generation is enabled, the driver should call
789 	 * drm_crtc_add_crc_entry() at each frame, providing any information
790 	 * that characterizes the frame contents in the crcN arguments, as
791 	 * provided from the configured source. Drivers must accept an "auto"
792 	 * source name that will select a default source for this CRTC.
793 	 *
794 	 * This may trigger an atomic modeset commit if necessary, to enable CRC
795 	 * generation.
796 	 *
797 	 * Note that "auto" can depend upon the current modeset configuration,
798 	 * e.g. it could pick an encoder or output specific CRC sampling point.
799 	 *
800 	 * This callback is optional if the driver does not support any CRC
801 	 * generation functionality.
802 	 *
803 	 * RETURNS:
804 	 *
805 	 * 0 on success or a negative error code on failure.
806 	 */
807 	int (*set_crc_source)(struct drm_crtc *crtc, const char *source);
808 
809 	/**
810 	 * @verify_crc_source:
811 	 *
812 	 * verifies the source of CRC checksums of frames before setting the
813 	 * source for CRC and during crc open. Source parameter can be NULL
814 	 * while disabling crc source.
815 	 *
816 	 * This callback is optional if the driver does not support any CRC
817 	 * generation functionality.
818 	 *
819 	 * RETURNS:
820 	 *
821 	 * 0 on success or a negative error code on failure.
822 	 */
823 	int (*verify_crc_source)(struct drm_crtc *crtc, const char *source,
824 				 size_t *values_cnt);
825 	/**
826 	 * @get_crc_sources:
827 	 *
828 	 * Driver callback for getting a list of all the available sources for
829 	 * CRC generation. This callback depends upon verify_crc_source, So
830 	 * verify_crc_source callback should be implemented before implementing
831 	 * this. Driver can pass full list of available crc sources, this
832 	 * callback does the verification on each crc-source before passing it
833 	 * to userspace.
834 	 *
835 	 * This callback is optional if the driver does not support exporting of
836 	 * possible CRC sources list.
837 	 *
838 	 * RETURNS:
839 	 *
840 	 * a constant character pointer to the list of all the available CRC
841 	 * sources. On failure driver should return NULL. count should be
842 	 * updated with number of sources in list. if zero we don't process any
843 	 * source from the list.
844 	 */
845 	const char *const *(*get_crc_sources)(struct drm_crtc *crtc,
846 					      size_t *count);
847 
848 	/**
849 	 * @atomic_print_state:
850 	 *
851 	 * If driver subclasses &struct drm_crtc_state, it should implement
852 	 * this optional hook for printing additional driver specific state.
853 	 *
854 	 * Do not call this directly, use drm_atomic_crtc_print_state()
855 	 * instead.
856 	 */
857 	void (*atomic_print_state)(struct drm_printer *p,
858 				   const struct drm_crtc_state *state);
859 
860 	/**
861 	 * @get_vblank_counter:
862 	 *
863 	 * Driver callback for fetching a raw hardware vblank counter for the
864 	 * CRTC. It's meant to be used by new drivers as the replacement of
865 	 * &drm_driver.get_vblank_counter hook.
866 	 *
867 	 * This callback is optional. If a device doesn't have a hardware
868 	 * counter, the driver can simply leave the hook as NULL. The DRM core
869 	 * will account for missed vblank events while interrupts where disabled
870 	 * based on system timestamps.
871 	 *
872 	 * Wraparound handling and loss of events due to modesetting is dealt
873 	 * with in the DRM core code, as long as drivers call
874 	 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
875 	 * enabling a CRTC.
876 	 *
877 	 * See also &drm_device.vblank_disable_immediate and
878 	 * &drm_device.max_vblank_count.
879 	 *
880 	 * Returns:
881 	 *
882 	 * Raw vblank counter value.
883 	 */
884 	u32 (*get_vblank_counter)(struct drm_crtc *crtc);
885 
886 	/**
887 	 * @enable_vblank:
888 	 *
889 	 * Enable vblank interrupts for the CRTC. It's meant to be used by
890 	 * new drivers as the replacement of &drm_driver.enable_vblank hook.
891 	 *
892 	 * Returns:
893 	 *
894 	 * Zero on success, appropriate errno if the vblank interrupt cannot
895 	 * be enabled.
896 	 */
897 	int (*enable_vblank)(struct drm_crtc *crtc);
898 
899 	/**
900 	 * @disable_vblank:
901 	 *
902 	 * Disable vblank interrupts for the CRTC. It's meant to be used by
903 	 * new drivers as the replacement of &drm_driver.disable_vblank hook.
904 	 */
905 	void (*disable_vblank)(struct drm_crtc *crtc);
906 
907 	/**
908 	 * @get_vblank_timestamp:
909 	 *
910 	 * Called by drm_get_last_vbltimestamp(). Should return a precise
911 	 * timestamp when the most recent vblank interval ended or will end.
912 	 *
913 	 * Specifically, the timestamp in @vblank_time should correspond as
914 	 * closely as possible to the time when the first video scanline of
915 	 * the video frame after the end of vblank will start scanning out,
916 	 * the time immediately after end of the vblank interval. If the
917 	 * @crtc is currently inside vblank, this will be a time in the future.
918 	 * If the @crtc is currently scanning out a frame, this will be the
919 	 * past start time of the current scanout. This is meant to adhere
920 	 * to the OpenML OML_sync_control extension specification.
921 	 *
922 	 * Parameters:
923 	 *
924 	 * crtc:
925 	 *     CRTC for which timestamp should be returned.
926 	 * max_error:
927 	 *     Maximum allowable timestamp error in nanoseconds.
928 	 *     Implementation should strive to provide timestamp
929 	 *     with an error of at most max_error nanoseconds.
930 	 *     Returns true upper bound on error for timestamp.
931 	 * vblank_time:
932 	 *     Target location for returned vblank timestamp.
933 	 * in_vblank_irq:
934 	 *     True when called from drm_crtc_handle_vblank().  Some drivers
935 	 *     need to apply some workarounds for gpu-specific vblank irq quirks
936 	 *     if flag is set.
937 	 *
938 	 * Returns:
939 	 *
940 	 * True on success, false on failure, which means the core should
941 	 * fallback to a simple timestamp taken in drm_crtc_handle_vblank().
942 	 */
943 	bool (*get_vblank_timestamp)(struct drm_crtc *crtc,
944 				     int *max_error,
945 				     ktime_t *vblank_time,
946 				     bool in_vblank_irq);
947 };
948 
949 /**
950  * struct drm_crtc - central CRTC control structure
951  *
952  * Each CRTC may have one or more connectors associated with it.  This structure
953  * allows the CRTC to be controlled.
954  */
955 struct drm_crtc {
956 	/** @dev: parent DRM device */
957 	struct drm_device *dev;
958 	/** @port: OF node used by drm_of_find_possible_crtcs(). */
959 	struct device_node *port;
960 	/**
961 	 * @head:
962 	 *
963 	 * List of all CRTCs on @dev, linked from &drm_mode_config.crtc_list.
964 	 * Invariant over the lifetime of @dev and therefore does not need
965 	 * locking.
966 	 */
967 	struct list_head head;
968 
969 	/** @name: human readable name, can be overwritten by the driver */
970 	char *name;
971 
972 	/**
973 	 * @mutex:
974 	 *
975 	 * This provides a read lock for the overall CRTC state (mode, dpms
976 	 * state, ...) and a write lock for everything which can be update
977 	 * without a full modeset (fb, cursor data, CRTC properties ...). A full
978 	 * modeset also need to grab &drm_mode_config.connection_mutex.
979 	 *
980 	 * For atomic drivers specifically this protects @state.
981 	 */
982 	struct drm_modeset_lock mutex;
983 
984 	/** @base: base KMS object for ID tracking etc. */
985 	struct drm_mode_object base;
986 
987 	/**
988 	 * @primary:
989 	 * Primary plane for this CRTC. Note that this is only
990 	 * relevant for legacy IOCTL, it specifies the plane implicitly used by
991 	 * the SETCRTC and PAGE_FLIP IOCTLs. It does not have any significance
992 	 * beyond that.
993 	 */
994 	struct drm_plane *primary;
995 
996 	/**
997 	 * @cursor:
998 	 * Cursor plane for this CRTC. Note that this is only relevant for
999 	 * legacy IOCTL, it specifies the plane implicitly used by the SETCURSOR
1000 	 * and SETCURSOR2 IOCTLs. It does not have any significance
1001 	 * beyond that.
1002 	 */
1003 	struct drm_plane *cursor;
1004 
1005 	/**
1006 	 * @index: Position inside the mode_config.list, can be used as an array
1007 	 * index. It is invariant over the lifetime of the CRTC.
1008 	 */
1009 	unsigned index;
1010 
1011 	/**
1012 	 * @cursor_x: Current x position of the cursor, used for universal
1013 	 * cursor planes because the SETCURSOR IOCTL only can update the
1014 	 * framebuffer without supplying the coordinates. Drivers should not use
1015 	 * this directly, atomic drivers should look at &drm_plane_state.crtc_x
1016 	 * of the cursor plane instead.
1017 	 */
1018 	int cursor_x;
1019 	/**
1020 	 * @cursor_y: Current y position of the cursor, used for universal
1021 	 * cursor planes because the SETCURSOR IOCTL only can update the
1022 	 * framebuffer without supplying the coordinates. Drivers should not use
1023 	 * this directly, atomic drivers should look at &drm_plane_state.crtc_y
1024 	 * of the cursor plane instead.
1025 	 */
1026 	int cursor_y;
1027 
1028 	/**
1029 	 * @enabled:
1030 	 *
1031 	 * Is this CRTC enabled? Should only be used by legacy drivers, atomic
1032 	 * drivers should instead consult &drm_crtc_state.enable and
1033 	 * &drm_crtc_state.active. Atomic drivers can update this by calling
1034 	 * drm_atomic_helper_update_legacy_modeset_state().
1035 	 */
1036 	bool enabled;
1037 
1038 	/**
1039 	 * @mode:
1040 	 *
1041 	 * Current mode timings. Should only be used by legacy drivers, atomic
1042 	 * drivers should instead consult &drm_crtc_state.mode. Atomic drivers
1043 	 * can update this by calling
1044 	 * drm_atomic_helper_update_legacy_modeset_state().
1045 	 */
1046 	struct drm_display_mode mode;
1047 
1048 	/**
1049 	 * @hwmode:
1050 	 *
1051 	 * Programmed mode in hw, after adjustments for encoders, crtc, panel
1052 	 * scaling etc. Should only be used by legacy drivers, for high
1053 	 * precision vblank timestamps in
1054 	 * drm_crtc_vblank_helper_get_vblank_timestamp().
1055 	 *
1056 	 * Note that atomic drivers should not use this, but instead use
1057 	 * &drm_crtc_state.adjusted_mode. And for high-precision timestamps
1058 	 * drm_crtc_vblank_helper_get_vblank_timestamp() used
1059 	 * &drm_vblank_crtc.hwmode,
1060 	 * which is filled out by calling drm_calc_timestamping_constants().
1061 	 */
1062 	struct drm_display_mode hwmode;
1063 
1064 	/**
1065 	 * @x:
1066 	 * x position on screen. Should only be used by legacy drivers, atomic
1067 	 * drivers should look at &drm_plane_state.crtc_x of the primary plane
1068 	 * instead. Updated by calling
1069 	 * drm_atomic_helper_update_legacy_modeset_state().
1070 	 */
1071 	int x;
1072 	/**
1073 	 * @y:
1074 	 * y position on screen. Should only be used by legacy drivers, atomic
1075 	 * drivers should look at &drm_plane_state.crtc_y of the primary plane
1076 	 * instead. Updated by calling
1077 	 * drm_atomic_helper_update_legacy_modeset_state().
1078 	 */
1079 	int y;
1080 
1081 	/** @funcs: CRTC control functions */
1082 	const struct drm_crtc_funcs *funcs;
1083 
1084 	/**
1085 	 * @gamma_size: Size of legacy gamma ramp reported to userspace. Set up
1086 	 * by calling drm_mode_crtc_set_gamma_size().
1087 	 *
1088 	 * Note that atomic drivers need to instead use
1089 	 * &drm_crtc_state.gamma_lut. See drm_crtc_enable_color_mgmt().
1090 	 */
1091 	uint32_t gamma_size;
1092 
1093 	/**
1094 	 * @gamma_store: Gamma ramp values used by the legacy SETGAMMA and
1095 	 * GETGAMMA IOCTls. Set up by calling drm_mode_crtc_set_gamma_size().
1096 	 *
1097 	 * Note that atomic drivers need to instead use
1098 	 * &drm_crtc_state.gamma_lut. See drm_crtc_enable_color_mgmt().
1099 	 */
1100 	uint16_t *gamma_store;
1101 
1102 	/** @helper_private: mid-layer private data */
1103 	const struct drm_crtc_helper_funcs *helper_private;
1104 
1105 	/** @properties: property tracking for this CRTC */
1106 	struct drm_object_properties properties;
1107 
1108 	/**
1109 	 * @scaling_filter_property: property to apply a particular filter while
1110 	 * scaling.
1111 	 */
1112 	struct drm_property *scaling_filter_property;
1113 
1114 	/**
1115 	 * @sharpness_strength_property: property to apply
1116 	 * the intensity of the sharpness requested.
1117 	 */
1118 	struct drm_property *sharpness_strength_property;
1119 
1120 	/**
1121 	 * @state:
1122 	 *
1123 	 * Current atomic state for this CRTC.
1124 	 *
1125 	 * This is protected by @mutex. Note that nonblocking atomic commits
1126 	 * access the current CRTC state without taking locks. Either by going
1127 	 * through the &struct drm_atomic_state pointers, see
1128 	 * for_each_oldnew_crtc_in_state(), for_each_old_crtc_in_state() and
1129 	 * for_each_new_crtc_in_state(). Or through careful ordering of atomic
1130 	 * commit operations as implemented in the atomic helpers, see
1131 	 * &struct drm_crtc_commit.
1132 	 */
1133 	struct drm_crtc_state *state;
1134 
1135 	/**
1136 	 * @commit_list:
1137 	 *
1138 	 * List of &drm_crtc_commit structures tracking pending commits.
1139 	 * Protected by @commit_lock. This list holds its own full reference,
1140 	 * as does the ongoing commit.
1141 	 *
1142 	 * "Note that the commit for a state change is also tracked in
1143 	 * &drm_crtc_state.commit. For accessing the immediately preceding
1144 	 * commit in an atomic update it is recommended to just use that
1145 	 * pointer in the old CRTC state, since accessing that doesn't need
1146 	 * any locking or list-walking. @commit_list should only be used to
1147 	 * stall for framebuffer cleanup that's signalled through
1148 	 * &drm_crtc_commit.cleanup_done."
1149 	 */
1150 	struct list_head commit_list;
1151 
1152 	/**
1153 	 * @commit_lock:
1154 	 *
1155 	 * Spinlock to protect @commit_list.
1156 	 */
1157 	spinlock_t commit_lock;
1158 
1159 	/**
1160 	 * @debugfs_entry:
1161 	 *
1162 	 * Debugfs directory for this CRTC.
1163 	 */
1164 	struct dentry *debugfs_entry;
1165 
1166 	/**
1167 	 * @crc:
1168 	 *
1169 	 * Configuration settings of CRC capture.
1170 	 */
1171 	struct drm_crtc_crc crc;
1172 
1173 	/**
1174 	 * @fence_context:
1175 	 *
1176 	 * timeline context used for fence operations.
1177 	 */
1178 	unsigned int fence_context;
1179 
1180 	/**
1181 	 * @fence_lock:
1182 	 *
1183 	 * spinlock to protect the fences in the fence_context.
1184 	 */
1185 	spinlock_t fence_lock;
1186 	/**
1187 	 * @fence_seqno:
1188 	 *
1189 	 * Seqno variable used as monotonic counter for the fences
1190 	 * created on the CRTC's timeline.
1191 	 */
1192 	unsigned long fence_seqno;
1193 
1194 	/**
1195 	 * @timeline_name:
1196 	 *
1197 	 * The name of the CRTC's fence timeline.
1198 	 */
1199 	char timeline_name[32];
1200 
1201 	/**
1202 	 * @self_refresh_data: Holds the state for the self refresh helpers
1203 	 *
1204 	 * Initialized via drm_self_refresh_helper_init().
1205 	 */
1206 	struct drm_self_refresh_data *self_refresh_data;
1207 };
1208 
1209 /**
1210  * struct drm_mode_set - new values for a CRTC config change
1211  * @fb: framebuffer to use for new config
1212  * @crtc: CRTC whose configuration we're about to change
1213  * @mode: mode timings to use
1214  * @x: position of this CRTC relative to @fb
1215  * @y: position of this CRTC relative to @fb
1216  * @connectors: array of connectors to drive with this CRTC if possible
1217  * @num_connectors: size of @connectors array
1218  *
1219  * This represents a modeset configuration for the legacy SETCRTC ioctl and is
1220  * also used internally. Atomic drivers instead use &drm_atomic_state.
1221  */
1222 struct drm_mode_set {
1223 	struct drm_framebuffer *fb;
1224 	struct drm_crtc *crtc;
1225 	struct drm_display_mode *mode;
1226 
1227 	uint32_t x;
1228 	uint32_t y;
1229 
1230 	struct drm_connector **connectors;
1231 	size_t num_connectors;
1232 };
1233 
1234 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1235 
1236 __printf(6, 7)
1237 int drm_crtc_init_with_planes(struct drm_device *dev,
1238 			      struct drm_crtc *crtc,
1239 			      struct drm_plane *primary,
1240 			      struct drm_plane *cursor,
1241 			      const struct drm_crtc_funcs *funcs,
1242 			      const char *name, ...);
1243 
1244 __printf(6, 7)
1245 int drmm_crtc_init_with_planes(struct drm_device *dev,
1246 			       struct drm_crtc *crtc,
1247 			       struct drm_plane *primary,
1248 			       struct drm_plane *cursor,
1249 			       const struct drm_crtc_funcs *funcs,
1250 			       const char *name, ...);
1251 
1252 void drm_crtc_cleanup(struct drm_crtc *crtc);
1253 
1254 __printf(7, 8)
1255 void *__drmm_crtc_alloc_with_planes(struct drm_device *dev,
1256 				    size_t size, size_t offset,
1257 				    struct drm_plane *primary,
1258 				    struct drm_plane *cursor,
1259 				    const struct drm_crtc_funcs *funcs,
1260 				    const char *name, ...);
1261 
1262 /**
1263  * drmm_crtc_alloc_with_planes - Allocate and initialize a new CRTC object with
1264  *    specified primary and cursor planes.
1265  * @dev: DRM device
1266  * @type: the type of the struct which contains struct &drm_crtc
1267  * @member: the name of the &drm_crtc within @type.
1268  * @primary: Primary plane for CRTC
1269  * @cursor: Cursor plane for CRTC
1270  * @funcs: callbacks for the new CRTC
1271  * @name: printf style format string for the CRTC name, or NULL for default name
1272  *
1273  * Allocates and initializes a new crtc object. Cleanup is automatically
1274  * handled through registering drmm_crtc_cleanup() with drmm_add_action().
1275  *
1276  * The @drm_crtc_funcs.destroy hook must be NULL.
1277  *
1278  * Returns:
1279  * Pointer to new crtc, or ERR_PTR on failure.
1280  */
1281 #define drmm_crtc_alloc_with_planes(dev, type, member, primary, cursor, funcs, name, ...) \
1282 	((type *)__drmm_crtc_alloc_with_planes(dev, sizeof(type), \
1283 					       offsetof(type, member), \
1284 					       primary, cursor, funcs, \
1285 					       name, ##__VA_ARGS__))
1286 
1287 /**
1288  * drm_crtc_index - find the index of a registered CRTC
1289  * @crtc: CRTC to find index for
1290  *
1291  * Given a registered CRTC, return the index of that CRTC within a DRM
1292  * device's list of CRTCs.
1293  */
1294 static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc)
1295 {
1296 	return crtc->index;
1297 }
1298 
1299 /**
1300  * drm_crtc_mask - find the mask of a registered CRTC
1301  * @crtc: CRTC to find mask for
1302  *
1303  * Given a registered CRTC, return the mask bit of that CRTC for the
1304  * &drm_encoder.possible_crtcs and &drm_plane.possible_crtcs fields.
1305  */
1306 static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc)
1307 {
1308 	return 1 << drm_crtc_index(crtc);
1309 }
1310 
1311 int drm_mode_set_config_internal(struct drm_mode_set *set);
1312 struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx);
1313 
1314 /**
1315  * drm_crtc_find - look up a CRTC object from its ID
1316  * @dev: DRM device
1317  * @file_priv: drm file to check for lease against.
1318  * @id: &drm_mode_object ID
1319  *
1320  * This can be used to look up a CRTC from its userspace ID. Only used by
1321  * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS
1322  * userspace interface should be done using &drm_property.
1323  */
1324 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1325 		struct drm_file *file_priv,
1326 		uint32_t id)
1327 {
1328 	struct drm_mode_object *mo;
1329 	mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CRTC);
1330 	return mo ? obj_to_crtc(mo) : NULL;
1331 }
1332 
1333 /**
1334  * drm_for_each_crtc - iterate over all CRTCs
1335  * @crtc: a &struct drm_crtc as the loop cursor
1336  * @dev: the &struct drm_device
1337  *
1338  * Iterate over all CRTCs of @dev.
1339  */
1340 #define drm_for_each_crtc(crtc, dev) \
1341 	list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1342 
1343 /**
1344  * drm_for_each_crtc_reverse - iterate over all CRTCs in reverse order
1345  * @crtc: a &struct drm_crtc as the loop cursor
1346  * @dev: the &struct drm_device
1347  *
1348  * Iterate over all CRTCs of @dev.
1349  */
1350 #define drm_for_each_crtc_reverse(crtc, dev) \
1351 	list_for_each_entry_reverse(crtc, &(dev)->mode_config.crtc_list, head)
1352 
1353 int drm_crtc_create_scaling_filter_property(struct drm_crtc *crtc,
1354 					    unsigned int supported_filters);
1355 bool drm_crtc_in_clone_mode(struct drm_crtc_state *crtc_state);
1356 int drm_crtc_create_sharpness_strength_property(struct drm_crtc *crtc);
1357 #endif /* __DRM_CRTC_H__ */
1358