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