xref: /dragonfly/sys/dev/drm/include/drm/drm_mode_config.h (revision 3f2dd94a569761201b5b0a18b2f697f97fe1b9dc)
1 /*
2  * Copyright (c) 2016 Intel Corporation
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and its
5  * documentation for any purpose is hereby granted without fee, provided that
6  * the above copyright notice appear in all copies and that both that copyright
7  * notice and this permission notice appear in supporting documentation, and
8  * that the name of the copyright holders not be used in advertising or
9  * publicity pertaining to distribution of the software without specific,
10  * written prior permission.  The copyright holders make no representations
11  * about the suitability of this software for any purpose.  It is provided "as
12  * is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20  * OF THIS SOFTWARE.
21  */
22 
23 #ifndef __DRM_MODE_CONFIG_H__
24 #define __DRM_MODE_CONFIG_H__
25 
26 #include <linux/mutex.h>
27 #include <linux/types.h>
28 #include <linux/idr.h>
29 #include <linux/workqueue.h>
30 #include <linux/llist.h>
31 
32 #include <drm/drm_modeset_lock.h>
33 
34 struct drm_file;
35 struct drm_device;
36 struct drm_atomic_state;
37 struct drm_mode_fb_cmd2;
38 struct drm_format_info;
39 
40 /**
41  * struct drm_mode_config_funcs - basic driver provided mode setting functions
42  *
43  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
44  * involve drivers.
45  */
46 struct drm_mode_config_funcs {
47           /**
48            * @fb_create:
49            *
50            * Create a new framebuffer object. The core does basic checks on the
51            * requested metadata, but most of that is left to the driver. See
52            * &struct drm_mode_fb_cmd2 for details.
53            *
54            * If the parameters are deemed valid and the backing storage objects in
55            * the underlying memory manager all exist, then the driver allocates
56            * a new &drm_framebuffer structure, subclassed to contain
57            * driver-specific information (like the internal native buffer object
58            * references). It also needs to fill out all relevant metadata, which
59            * should be done by calling drm_helper_mode_fill_fb_struct().
60            *
61            * The initialization is finalized by calling drm_framebuffer_init(),
62            * which registers the framebuffer and makes it accessible to other
63            * threads.
64            *
65            * RETURNS:
66            *
67            * A new framebuffer with an initial reference count of 1 or a negative
68            * error code encoded with ERR_PTR().
69            */
70           struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
71                                                        struct drm_file *file_priv,
72                                                        const struct drm_mode_fb_cmd2 *mode_cmd);
73 
74           /**
75            * @get_format_info:
76            *
77            * Allows a driver to return custom format information for special
78            * fb layouts (eg. ones with auxiliary compression control planes).
79            *
80            * RETURNS:
81            *
82            * The format information specific to the given fb metadata, or
83            * NULL if none is found.
84            */
85           const struct drm_format_info *(*get_format_info)(const struct drm_mode_fb_cmd2 *mode_cmd);
86 
87           /**
88            * @output_poll_changed:
89            *
90            * Callback used by helpers to inform the driver of output configuration
91            * changes.
92            *
93            * Drivers implementing fbdev emulation with the helpers can call
94            * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
95            * helper of output changes.
96            *
97            * FIXME:
98            *
99            * Except that there's no vtable for device-level helper callbacks
100            * there's no reason this is a core function.
101            */
102           void (*output_poll_changed)(struct drm_device *dev);
103 
104           /**
105            * @atomic_check:
106            *
107            * This is the only hook to validate an atomic modeset update. This
108            * function must reject any modeset and state changes which the hardware
109            * or driver doesn't support. This includes but is of course not limited
110            * to:
111            *
112            *  - Checking that the modes, framebuffers, scaling and placement
113            *    requirements and so on are within the limits of the hardware.
114            *
115            *  - Checking that any hidden shared resources are not oversubscribed.
116            *    This can be shared PLLs, shared lanes, overall memory bandwidth,
117            *    display fifo space (where shared between planes or maybe even
118            *    CRTCs).
119            *
120            *  - Checking that virtualized resources exported to userspace are not
121            *    oversubscribed. For various reasons it can make sense to expose
122            *    more planes, crtcs or encoders than which are physically there. One
123            *    example is dual-pipe operations (which generally should be hidden
124            *    from userspace if when lockstepped in hardware, exposed otherwise),
125            *    where a plane might need 1 hardware plane (if it's just on one
126            *    pipe), 2 hardware planes (when it spans both pipes) or maybe even
127            *    shared a hardware plane with a 2nd plane (if there's a compatible
128            *    plane requested on the area handled by the other pipe).
129            *
130            *  - Check that any transitional state is possible and that if
131            *    requested, the update can indeed be done in the vblank period
132            *    without temporarily disabling some functions.
133            *
134            *  - Check any other constraints the driver or hardware might have.
135            *
136            *  - This callback also needs to correctly fill out the &drm_crtc_state
137            *    in this update to make sure that drm_atomic_crtc_needs_modeset()
138            *    reflects the nature of the possible update and returns true if and
139            *    only if the update cannot be applied without tearing within one
140            *    vblank on that CRTC. The core uses that information to reject
141            *    updates which require a full modeset (i.e. blanking the screen, or
142            *    at least pausing updates for a substantial amount of time) if
143            *    userspace has disallowed that in its request.
144            *
145            *  - The driver also does not need to repeat basic input validation
146            *    like done for the corresponding legacy entry points. The core does
147            *    that before calling this hook.
148            *
149            * See the documentation of @atomic_commit for an exhaustive list of
150            * error conditions which don't have to be checked at the in this
151            * callback.
152            *
153            * See the documentation for &struct drm_atomic_state for how exactly
154            * an atomic modeset update is described.
155            *
156            * Drivers using the atomic helpers can implement this hook using
157            * drm_atomic_helper_check(), or one of the exported sub-functions of
158            * it.
159            *
160            * RETURNS:
161            *
162            * 0 on success or one of the below negative error codes:
163            *
164            *  - -EINVAL, if any of the above constraints are violated.
165            *
166            *  - -EDEADLK, when returned from an attempt to acquire an additional
167            *    &drm_modeset_lock through drm_modeset_lock().
168            *
169            *  - -ENOMEM, if allocating additional state sub-structures failed due
170            *    to lack of memory.
171            *
172            *  - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
173            *    This can either be due to a pending signal, or because the driver
174            *    needs to completely bail out to recover from an exceptional
175            *    situation like a GPU hang. From a userspace point all errors are
176            *    treated equally.
177            */
178           int (*atomic_check)(struct drm_device *dev,
179                                   struct drm_atomic_state *state);
180 
181           /**
182            * @atomic_commit:
183            *
184            * This is the only hook to commit an atomic modeset update. The core
185            * guarantees that @atomic_check has been called successfully before
186            * calling this function, and that nothing has been changed in the
187            * interim.
188            *
189            * See the documentation for &struct drm_atomic_state for how exactly
190            * an atomic modeset update is described.
191            *
192            * Drivers using the atomic helpers can implement this hook using
193            * drm_atomic_helper_commit(), or one of the exported sub-functions of
194            * it.
195            *
196            * Nonblocking commits (as indicated with the nonblock parameter) must
197            * do any preparatory work which might result in an unsuccessful commit
198            * in the context of this callback. The only exceptions are hardware
199            * errors resulting in -EIO. But even in that case the driver must
200            * ensure that the display pipe is at least running, to avoid
201            * compositors crashing when pageflips don't work. Anything else,
202            * specifically committing the update to the hardware, should be done
203            * without blocking the caller. For updates which do not require a
204            * modeset this must be guaranteed.
205            *
206            * The driver must wait for any pending rendering to the new
207            * framebuffers to complete before executing the flip. It should also
208            * wait for any pending rendering from other drivers if the underlying
209            * buffer is a shared dma-buf. Nonblocking commits must not wait for
210            * rendering in the context of this callback.
211            *
212            * An application can request to be notified when the atomic commit has
213            * completed. These events are per-CRTC and can be distinguished by the
214            * CRTC index supplied in &drm_event to userspace.
215            *
216            * The drm core will supply a &struct drm_event in each CRTC's
217            * &drm_crtc_state.event. See the documentation for
218            * &drm_crtc_state.event for more details about the precise semantics of
219            * this event.
220            *
221            * NOTE:
222            *
223            * Drivers are not allowed to shut down any display pipe successfully
224            * enabled through an atomic commit on their own. Doing so can result in
225            * compositors crashing if a page flip is suddenly rejected because the
226            * pipe is off.
227            *
228            * RETURNS:
229            *
230            * 0 on success or one of the below negative error codes:
231            *
232            *  - -EBUSY, if a nonblocking updated is requested and there is
233            *    an earlier updated pending. Drivers are allowed to support a queue
234            *    of outstanding updates, but currently no driver supports that.
235            *    Note that drivers must wait for preceding updates to complete if a
236            *    synchronous update is requested, they are not allowed to fail the
237            *    commit in that case.
238            *
239            *  - -ENOMEM, if the driver failed to allocate memory. Specifically
240            *    this can happen when trying to pin framebuffers, which must only
241            *    be done when committing the state.
242            *
243            *  - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
244            *    that the driver has run out of vram, iommu space or similar GPU
245            *    address space needed for framebuffer.
246            *
247            *  - -EIO, if the hardware completely died.
248            *
249            *  - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
250            *    This can either be due to a pending signal, or because the driver
251            *    needs to completely bail out to recover from an exceptional
252            *    situation like a GPU hang. From a userspace point of view all errors are
253            *    treated equally.
254            *
255            * This list is exhaustive. Specifically this hook is not allowed to
256            * return -EINVAL (any invalid requests should be caught in
257            * @atomic_check) or -EDEADLK (this function must not acquire
258            * additional modeset locks).
259            */
260           int (*atomic_commit)(struct drm_device *dev,
261                                    struct drm_atomic_state *state,
262                                    bool nonblock);
263 
264           /**
265            * @atomic_state_alloc:
266            *
267            * This optional hook can be used by drivers that want to subclass struct
268            * &drm_atomic_state to be able to track their own driver-private global
269            * state easily. If this hook is implemented, drivers must also
270            * implement @atomic_state_clear and @atomic_state_free.
271            *
272            * RETURNS:
273            *
274            * A new &drm_atomic_state on success or NULL on failure.
275            */
276           struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
277 
278           /**
279            * @atomic_state_clear:
280            *
281            * This hook must clear any driver private state duplicated into the
282            * passed-in &drm_atomic_state. This hook is called when the caller
283            * encountered a &drm_modeset_lock deadlock and needs to drop all
284            * already acquired locks as part of the deadlock avoidance dance
285            * implemented in drm_modeset_backoff().
286            *
287            * Any duplicated state must be invalidated since a concurrent atomic
288            * update might change it, and the drm atomic interfaces always apply
289            * updates as relative changes to the current state.
290            *
291            * Drivers that implement this must call drm_atomic_state_default_clear()
292            * to clear common state.
293            */
294           void (*atomic_state_clear)(struct drm_atomic_state *state);
295 
296           /**
297            * @atomic_state_free:
298            *
299            * This hook needs driver private resources and the &drm_atomic_state
300            * itself. Note that the core first calls drm_atomic_state_clear() to
301            * avoid code duplicate between the clear and free hooks.
302            *
303            * Drivers that implement this must call
304            * drm_atomic_state_default_release() to release common resources.
305            */
306           void (*atomic_state_free)(struct drm_atomic_state *state);
307 };
308 
309 /**
310  * struct drm_mode_config - Mode configuration control structure
311  * @min_width: minimum pixel width on this device
312  * @min_height: minimum pixel height on this device
313  * @max_width: maximum pixel width on this device
314  * @max_height: maximum pixel height on this device
315  * @funcs: core driver provided mode setting functions
316  * @fb_base: base address of the framebuffer
317  * @poll_enabled: track polling support for this device
318  * @poll_running: track polling status for this device
319  * @delayed_event: track delayed poll uevent deliver for this device
320  * @output_poll_work: delayed work for polling in process context
321  * @preferred_depth: preferred RBG pixel depth, used by fb helpers
322  * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
323  * @cursor_width: hint to userspace for max cursor width
324  * @cursor_height: hint to userspace for max cursor height
325  * @helper_private: mid-layer private data
326  *
327  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
328  * enumerated by the driver are added here, as are global properties.  Some
329  * global restrictions are also here, e.g. dimension restrictions.
330  */
331 struct drm_mode_config {
332           /**
333            * @mutex:
334            *
335            * This is the big scary modeset BKL which protects everything that
336            * isn't protect otherwise. Scope is unclear and fuzzy, try to remove
337            * anything from under it's protection and move it into more well-scoped
338            * locks.
339            *
340            * The one important thing this protects is the use of @acquire_ctx.
341            */
342           struct lock mutex;
343 
344           /**
345            * @connection_mutex:
346            *
347            * This protects connector state and the connector to encoder to CRTC
348            * routing chain.
349            *
350            * For atomic drivers specifically this protects &drm_connector.state.
351            */
352           struct drm_modeset_lock connection_mutex;
353 
354           /**
355            * @acquire_ctx:
356            *
357            * Global implicit acquire context used by atomic drivers for legacy
358            * IOCTLs. Deprecated, since implicit locking contexts make it
359            * impossible to use driver-private &struct drm_modeset_lock. Users of
360            * this must hold @mutex.
361            */
362           struct drm_modeset_acquire_ctx *acquire_ctx;
363 
364           /**
365            * @idr_mutex:
366            *
367            * Mutex for KMS ID allocation and management. Protects both @crtc_idr
368            * and @tile_idr.
369            */
370           struct lock idr_mutex;
371 
372           /**
373            * @crtc_idr:
374            *
375            * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
376            * connector, modes - just makes life easier to have only one.
377            */
378           struct idr crtc_idr;
379 
380           /**
381            * @tile_idr:
382            *
383            * Use this idr for allocating new IDs for tiled sinks like use in some
384            * high-res DP MST screens.
385            */
386           struct idr tile_idr;
387 
388           /** @fb_lock: Mutex to protect fb the global @fb_list and @num_fb. */
389           struct lock fb_lock;
390           /** @num_fb: Number of entries on @fb_list. */
391           int num_fb;
392           /** @fb_list: List of all &struct drm_framebuffer. */
393           struct list_head fb_list;
394 
395           /**
396            * @connector_list_lock: Protects @num_connector and
397            * @connector_list and @connector_free_list.
398            */
399           spinlock_t connector_list_lock;
400           /**
401            * @num_connector: Number of connectors on this device. Protected by
402            * @connector_list_lock.
403            */
404           int num_connector;
405           /**
406            * @connector_ida: ID allocator for connector indices.
407            */
408           struct ida connector_ida;
409           /**
410            * @connector_list:
411            *
412            * List of connector objects linked with &drm_connector.head. Protected
413            * by @connector_list_lock. Only use drm_for_each_connector_iter() and
414            * &struct drm_connector_list_iter to walk this list.
415            */
416           struct list_head connector_list;
417           /**
418            * @connector_free_list:
419            *
420            * List of connector objects linked with &drm_connector.free_head.
421            * Protected by @connector_list_lock. Used by
422            * drm_for_each_connector_iter() and
423            * &struct drm_connector_list_iter to savely free connectors using
424            * @connector_free_work.
425            */
426           struct llist_head connector_free_list;
427           /**
428            * @connector_free_work: Work to clean up @connector_free_list.
429            */
430           struct work_struct connector_free_work;
431 
432           /**
433            * @num_encoder:
434            *
435            * Number of encoders on this device. This is invariant over the
436            * lifetime of a device and hence doesn't need any locks.
437            */
438           int num_encoder;
439           /**
440            * @encoder_list:
441            *
442            * List of encoder objects linked with &drm_encoder.head. This is
443            * invariant over the lifetime of a device and hence doesn't need any
444            * locks.
445            */
446           struct list_head encoder_list;
447 
448           /**
449            * @num_total_plane:
450            *
451            * Number of universal (i.e. with primary/curso) planes on this device.
452            * This is invariant over the lifetime of a device and hence doesn't
453            * need any locks.
454            */
455           int num_total_plane;
456           /**
457            * @plane_list:
458            *
459            * List of plane objects linked with &drm_plane.head. This is invariant
460            * over the lifetime of a device and hence doesn't need any locks.
461            */
462           struct list_head plane_list;
463 
464           /**
465            * @num_crtc:
466            *
467            * Number of CRTCs on this device linked with &drm_crtc.head. This is invariant over the lifetime
468            * of a device and hence doesn't need any locks.
469            */
470           int num_crtc;
471           /**
472            * @crtc_list:
473            *
474            * List of CRTC objects linked with &drm_crtc.head. This is invariant
475            * over the lifetime of a device and hence doesn't need any locks.
476            */
477           struct list_head crtc_list;
478 
479           /**
480            * @property_list:
481            *
482            * List of property type objects linked with &drm_property.head. This is
483            * invariant over the lifetime of a device and hence doesn't need any
484            * locks.
485            */
486           struct list_head property_list;
487 
488           int min_width, min_height;
489           int max_width, max_height;
490           const struct drm_mode_config_funcs *funcs;
491           resource_size_t fb_base;
492 
493           /* output poll support */
494           bool poll_enabled;
495           bool poll_running;
496           bool delayed_event;
497           struct delayed_work output_poll_work;
498 
499           /**
500            * @blob_lock:
501            *
502            * Mutex for blob property allocation and management, protects
503            * @property_blob_list and &drm_file.blobs.
504            */
505           struct lock blob_lock;
506 
507           /**
508            * @property_blob_list:
509            *
510            * List of all the blob property objects linked with
511            * &drm_property_blob.head. Protected by @blob_lock.
512            */
513           struct list_head property_blob_list;
514 
515           /* pointers to standard properties */
516 
517           /**
518            * @edid_property: Default connector property to hold the EDID of the
519            * currently connected sink, if any.
520            */
521           struct drm_property *edid_property;
522           /**
523            * @dpms_property: Default connector property to control the
524            * connector's DPMS state.
525            */
526           struct drm_property *dpms_property;
527           /**
528            * @path_property: Default connector property to hold the DP MST path
529            * for the port.
530            */
531           struct drm_property *path_property;
532           /**
533            * @tile_property: Default connector property to store the tile
534            * position of a tiled screen, for sinks which need to be driven with
535            * multiple CRTCs.
536            */
537           struct drm_property *tile_property;
538           /**
539            * @link_status_property: Default connector property for link status
540            * of a connector
541            */
542           struct drm_property *link_status_property;
543           /**
544            * @plane_type_property: Default plane property to differentiate
545            * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
546            */
547           struct drm_property *plane_type_property;
548           /**
549            * @prop_src_x: Default atomic plane property for the plane source
550            * position in the connected &drm_framebuffer.
551            */
552           struct drm_property *prop_src_x;
553           /**
554            * @prop_src_y: Default atomic plane property for the plane source
555            * position in the connected &drm_framebuffer.
556            */
557           struct drm_property *prop_src_y;
558           /**
559            * @prop_src_w: Default atomic plane property for the plane source
560            * position in the connected &drm_framebuffer.
561            */
562           struct drm_property *prop_src_w;
563           /**
564            * @prop_src_h: Default atomic plane property for the plane source
565            * position in the connected &drm_framebuffer.
566            */
567           struct drm_property *prop_src_h;
568           /**
569            * @prop_crtc_x: Default atomic plane property for the plane destination
570            * position in the &drm_crtc is is being shown on.
571            */
572           struct drm_property *prop_crtc_x;
573           /**
574            * @prop_crtc_y: Default atomic plane property for the plane destination
575            * position in the &drm_crtc is is being shown on.
576            */
577           struct drm_property *prop_crtc_y;
578           /**
579            * @prop_crtc_w: Default atomic plane property for the plane destination
580            * position in the &drm_crtc is is being shown on.
581            */
582           struct drm_property *prop_crtc_w;
583           /**
584            * @prop_crtc_h: Default atomic plane property for the plane destination
585            * position in the &drm_crtc is is being shown on.
586            */
587           struct drm_property *prop_crtc_h;
588           /**
589            * @prop_fb_id: Default atomic plane property to specify the
590            * &drm_framebuffer.
591            */
592           struct drm_property *prop_fb_id;
593           /**
594            * @prop_in_fence_fd: Sync File fd representing the incoming fences
595            * for a Plane.
596            */
597           struct drm_property *prop_in_fence_fd;
598           /**
599            * @prop_out_fence_ptr: Sync File fd pointer representing the
600            * outgoing fences for a CRTC. Userspace should provide a pointer to a
601            * value of type s32, and then cast that pointer to u64.
602            */
603           struct drm_property *prop_out_fence_ptr;
604           /**
605            * @prop_crtc_id: Default atomic plane property to specify the
606            * &drm_crtc.
607            */
608           struct drm_property *prop_crtc_id;
609           /**
610            * @prop_active: Default atomic CRTC property to control the active
611            * state, which is the simplified implementation for DPMS in atomic
612            * drivers.
613            */
614           struct drm_property *prop_active;
615           /**
616            * @prop_mode_id: Default atomic CRTC property to set the mode for a
617            * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
618            * connectors must be of and active must be set to disabled, too.
619            */
620           struct drm_property *prop_mode_id;
621 
622           /**
623            * @dvi_i_subconnector_property: Optional DVI-I property to
624            * differentiate between analog or digital mode.
625            */
626           struct drm_property *dvi_i_subconnector_property;
627           /**
628            * @dvi_i_select_subconnector_property: Optional DVI-I property to
629            * select between analog or digital mode.
630            */
631           struct drm_property *dvi_i_select_subconnector_property;
632 
633           /**
634            * @tv_subconnector_property: Optional TV property to differentiate
635            * between different TV connector types.
636            */
637           struct drm_property *tv_subconnector_property;
638           /**
639            * @tv_select_subconnector_property: Optional TV property to select
640            * between different TV connector types.
641            */
642           struct drm_property *tv_select_subconnector_property;
643           /**
644            * @tv_mode_property: Optional TV property to select
645            * the output TV mode.
646            */
647           struct drm_property *tv_mode_property;
648           /**
649            * @tv_left_margin_property: Optional TV property to set the left
650            * margin.
651            */
652           struct drm_property *tv_left_margin_property;
653           /**
654            * @tv_right_margin_property: Optional TV property to set the right
655            * margin.
656            */
657           struct drm_property *tv_right_margin_property;
658           /**
659            * @tv_top_margin_property: Optional TV property to set the right
660            * margin.
661            */
662           struct drm_property *tv_top_margin_property;
663           /**
664            * @tv_bottom_margin_property: Optional TV property to set the right
665            * margin.
666            */
667           struct drm_property *tv_bottom_margin_property;
668           /**
669            * @tv_brightness_property: Optional TV property to set the
670            * brightness.
671            */
672           struct drm_property *tv_brightness_property;
673           /**
674            * @tv_contrast_property: Optional TV property to set the
675            * contrast.
676            */
677           struct drm_property *tv_contrast_property;
678           /**
679            * @tv_flicker_reduction_property: Optional TV property to control the
680            * flicker reduction mode.
681            */
682           struct drm_property *tv_flicker_reduction_property;
683           /**
684            * @tv_overscan_property: Optional TV property to control the overscan
685            * setting.
686            */
687           struct drm_property *tv_overscan_property;
688           /**
689            * @tv_saturation_property: Optional TV property to set the
690            * saturation.
691            */
692           struct drm_property *tv_saturation_property;
693           /**
694            * @tv_hue_property: Optional TV property to set the hue.
695            */
696           struct drm_property *tv_hue_property;
697 
698           /**
699            * @scaling_mode_property: Optional connector property to control the
700            * upscaling, mostly used for built-in panels.
701            */
702           struct drm_property *scaling_mode_property;
703           /**
704            * @aspect_ratio_property: Optional connector property to control the
705            * HDMI infoframe aspect ratio setting.
706            */
707           struct drm_property *aspect_ratio_property;
708           /**
709            * @degamma_lut_property: Optional CRTC property to set the LUT used to
710            * convert the framebuffer's colors to linear gamma.
711            */
712           struct drm_property *degamma_lut_property;
713           /**
714            * @degamma_lut_size_property: Optional CRTC property for the size of
715            * the degamma LUT as supported by the driver (read-only).
716            */
717           struct drm_property *degamma_lut_size_property;
718           /**
719            * @ctm_property: Optional CRTC property to set the
720            * matrix used to convert colors after the lookup in the
721            * degamma LUT.
722            */
723           struct drm_property *ctm_property;
724           /**
725            * @gamma_lut_property: Optional CRTC property to set the LUT used to
726            * convert the colors, after the CTM matrix, to the gamma space of the
727            * connected screen.
728            */
729           struct drm_property *gamma_lut_property;
730           /**
731            * @gamma_lut_size_property: Optional CRTC property for the size of the
732            * gamma LUT as supported by the driver (read-only).
733            */
734           struct drm_property *gamma_lut_size_property;
735 
736           /**
737            * @suggested_x_property: Optional connector property with a hint for
738            * the position of the output on the host's screen.
739            */
740           struct drm_property *suggested_x_property;
741           /**
742            * @suggested_y_property: Optional connector property with a hint for
743            * the position of the output on the host's screen.
744            */
745           struct drm_property *suggested_y_property;
746 
747           /**
748            * @non_desktop_property: Optional connector property with a hint
749            * that device isn't a standard display, and the console/desktop,
750            * should not be displayed on it.
751            */
752           struct drm_property *non_desktop_property;
753 
754           /* dumb ioctl parameters */
755           uint32_t preferred_depth, prefer_shadow;
756 
757           /**
758            * @async_page_flip: Does this device support async flips on the primary
759            * plane?
760            */
761           bool async_page_flip;
762 
763           /**
764            * @allow_fb_modifiers:
765            *
766            * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
767            */
768           bool allow_fb_modifiers;
769 
770           /**
771            * @modifiers: Plane property to list support modifier/format
772            * combination.
773            */
774           struct drm_property *modifiers_property;
775 
776           /* cursor size */
777           uint32_t cursor_width, cursor_height;
778 
779           const struct drm_mode_config_helper_funcs *helper_private;
780 };
781 
782 void drm_mode_config_init(struct drm_device *dev);
783 void drm_mode_config_reset(struct drm_device *dev);
784 void drm_mode_config_cleanup(struct drm_device *dev);
785 
786 #endif
787