Merge branches 'drm-devel' and 'component-for-driver' into armada-drm
[firefly-linux-kernel-4.4.55.git] / include / drm / drm_crtc.h
1 /*
2  * Copyright © 2006 Keith Packard
3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
5  *   Jesse Barnes <jesse.barnes@intel.com>
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation
10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11  * and/or sell copies of the Software, and to permit persons to whom the
12  * Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23  * OTHER DEALINGS IN THE SOFTWARE.
24  */
25 #ifndef __DRM_CRTC_H__
26 #define __DRM_CRTC_H__
27
28 #include <linux/i2c.h>
29 #include <linux/spinlock.h>
30 #include <linux/types.h>
31 #include <linux/idr.h>
32 #include <linux/fb.h>
33 #include <linux/hdmi.h>
34 #include <drm/drm_mode.h>
35 #include <drm/drm_fourcc.h>
36 #include <drm/drm_modeset_lock.h>
37
38 struct drm_device;
39 struct drm_mode_set;
40 struct drm_framebuffer;
41 struct drm_object_properties;
42 struct drm_file;
43 struct drm_clip_rect;
44 struct device_node;
45
46 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
47 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
48 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
49 #define DRM_MODE_OBJECT_MODE 0xdededede
50 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
51 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
52 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
53 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
54 #define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
55 #define DRM_MODE_OBJECT_ANY 0
56
57 struct drm_mode_object {
58         uint32_t id;
59         uint32_t type;
60         struct drm_object_properties *properties;
61 };
62
63 #define DRM_OBJECT_MAX_PROPERTY 24
64 struct drm_object_properties {
65         int count;
66         uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
67         uint64_t values[DRM_OBJECT_MAX_PROPERTY];
68 };
69
70 static inline int64_t U642I64(uint64_t val)
71 {
72         return (int64_t)*((int64_t *)&val);
73 }
74 static inline uint64_t I642U64(int64_t val)
75 {
76         return (uint64_t)*((uint64_t *)&val);
77 }
78
79 enum drm_connector_force {
80         DRM_FORCE_UNSPECIFIED,
81         DRM_FORCE_OFF,
82         DRM_FORCE_ON,         /* force on analog part normally */
83         DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
84 };
85
86 #include <drm/drm_modes.h>
87
88 enum drm_connector_status {
89         connector_status_connected = 1,
90         connector_status_disconnected = 2,
91         connector_status_unknown = 3,
92 };
93
94 enum subpixel_order {
95         SubPixelUnknown = 0,
96         SubPixelHorizontalRGB,
97         SubPixelHorizontalBGR,
98         SubPixelVerticalRGB,
99         SubPixelVerticalBGR,
100         SubPixelNone,
101 };
102
103 #define DRM_COLOR_FORMAT_RGB444         (1<<0)
104 #define DRM_COLOR_FORMAT_YCRCB444       (1<<1)
105 #define DRM_COLOR_FORMAT_YCRCB422       (1<<2)
106 /*
107  * Describes a given display (e.g. CRT or flat panel) and its limitations.
108  */
109 struct drm_display_info {
110         char name[DRM_DISPLAY_INFO_LEN];
111
112         /* Physical size */
113         unsigned int width_mm;
114         unsigned int height_mm;
115
116         /* Clock limits FIXME: storage format */
117         unsigned int min_vfreq, max_vfreq;
118         unsigned int min_hfreq, max_hfreq;
119         unsigned int pixel_clock;
120         unsigned int bpc;
121
122         enum subpixel_order subpixel_order;
123         u32 color_formats;
124
125         /* Mask of supported hdmi deep color modes */
126         u8 edid_hdmi_dc_modes;
127
128         u8 cea_rev;
129 };
130
131 struct drm_framebuffer_funcs {
132         /* note: use drm_framebuffer_remove() */
133         void (*destroy)(struct drm_framebuffer *framebuffer);
134         int (*create_handle)(struct drm_framebuffer *fb,
135                              struct drm_file *file_priv,
136                              unsigned int *handle);
137         /**
138          * Optinal callback for the dirty fb ioctl.
139          *
140          * Userspace can notify the driver via this callback
141          * that a area of the framebuffer has changed and should
142          * be flushed to the display hardware.
143          *
144          * See documentation in drm_mode.h for the struct
145          * drm_mode_fb_dirty_cmd for more information as all
146          * the semantics and arguments have a one to one mapping
147          * on this function.
148          */
149         int (*dirty)(struct drm_framebuffer *framebuffer,
150                      struct drm_file *file_priv, unsigned flags,
151                      unsigned color, struct drm_clip_rect *clips,
152                      unsigned num_clips);
153 };
154
155 struct drm_framebuffer {
156         struct drm_device *dev;
157         /*
158          * Note that the fb is refcounted for the benefit of driver internals,
159          * for example some hw, disabling a CRTC/plane is asynchronous, and
160          * scanout does not actually complete until the next vblank.  So some
161          * cleanup (like releasing the reference(s) on the backing GEM bo(s))
162          * should be deferred.  In cases like this, the driver would like to
163          * hold a ref to the fb even though it has already been removed from
164          * userspace perspective.
165          */
166         struct kref refcount;
167         /*
168          * Place on the dev->mode_config.fb_list, access protected by
169          * dev->mode_config.fb_lock.
170          */
171         struct list_head head;
172         struct drm_mode_object base;
173         const struct drm_framebuffer_funcs *funcs;
174         unsigned int pitches[4];
175         unsigned int offsets[4];
176         unsigned int width;
177         unsigned int height;
178         /* depth can be 15 or 16 */
179         unsigned int depth;
180         int bits_per_pixel;
181         int flags;
182         uint32_t pixel_format; /* fourcc format */
183         struct list_head filp_head;
184         /* if you are using the helper */
185         void *helper_private;
186 };
187
188 struct drm_property_blob {
189         struct drm_mode_object base;
190         struct list_head head;
191         unsigned int length;
192         unsigned char data[];
193 };
194
195 struct drm_property_enum {
196         uint64_t value;
197         struct list_head head;
198         char name[DRM_PROP_NAME_LEN];
199 };
200
201 struct drm_property {
202         struct list_head head;
203         struct drm_mode_object base;
204         uint32_t flags;
205         char name[DRM_PROP_NAME_LEN];
206         uint32_t num_values;
207         uint64_t *values;
208         struct drm_device *dev;
209
210         struct list_head enum_blob_list;
211 };
212
213 void drm_modeset_lock_all(struct drm_device *dev);
214 void drm_modeset_unlock_all(struct drm_device *dev);
215 void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
216
217 struct drm_crtc;
218 struct drm_connector;
219 struct drm_encoder;
220 struct drm_pending_vblank_event;
221 struct drm_plane;
222 struct drm_bridge;
223
224 /**
225  * drm_crtc_funcs - control CRTCs for a given device
226  * @save: save CRTC state
227  * @restore: restore CRTC state
228  * @reset: reset CRTC after state has been invalidated (e.g. resume)
229  * @cursor_set: setup the cursor
230  * @cursor_move: move the cursor
231  * @gamma_set: specify color ramp for CRTC
232  * @destroy: deinit and free object
233  * @set_property: called when a property is changed
234  * @set_config: apply a new CRTC configuration
235  * @page_flip: initiate a page flip
236  *
237  * The drm_crtc_funcs structure is the central CRTC management structure
238  * in the DRM.  Each CRTC controls one or more connectors (note that the name
239  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
240  * connectors, not just CRTs).
241  *
242  * Each driver is responsible for filling out this structure at startup time,
243  * in addition to providing other modesetting features, like i2c and DDC
244  * bus accessors.
245  */
246 struct drm_crtc_funcs {
247         /* Save CRTC state */
248         void (*save)(struct drm_crtc *crtc); /* suspend? */
249         /* Restore CRTC state */
250         void (*restore)(struct drm_crtc *crtc); /* resume? */
251         /* Reset CRTC state */
252         void (*reset)(struct drm_crtc *crtc);
253
254         /* cursor controls */
255         int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
256                           uint32_t handle, uint32_t width, uint32_t height);
257         int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
258                            uint32_t handle, uint32_t width, uint32_t height,
259                            int32_t hot_x, int32_t hot_y);
260         int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
261
262         /* Set gamma on the CRTC */
263         void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
264                           uint32_t start, uint32_t size);
265         /* Object destroy routine */
266         void (*destroy)(struct drm_crtc *crtc);
267
268         int (*set_config)(struct drm_mode_set *set);
269
270         /*
271          * Flip to the given framebuffer.  This implements the page
272          * flip ioctl described in drm_mode.h, specifically, the
273          * implementation must return immediately and block all
274          * rendering to the current fb until the flip has completed.
275          * If userspace set the event flag in the ioctl, the event
276          * argument will point to an event to send back when the flip
277          * completes, otherwise it will be NULL.
278          */
279         int (*page_flip)(struct drm_crtc *crtc,
280                          struct drm_framebuffer *fb,
281                          struct drm_pending_vblank_event *event,
282                          uint32_t flags);
283
284         int (*set_property)(struct drm_crtc *crtc,
285                             struct drm_property *property, uint64_t val);
286 };
287
288 /**
289  * drm_crtc - central CRTC control structure
290  * @dev: parent DRM device
291  * @head: list management
292  * @mutex: per-CRTC locking
293  * @base: base KMS object for ID tracking etc.
294  * @primary: primary plane for this CRTC
295  * @cursor: cursor plane for this CRTC
296  * @enabled: is this CRTC enabled?
297  * @mode: current mode timings
298  * @hwmode: mode timings as programmed to hw regs
299  * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
300  *    invert the width/height of the crtc.  This is used if the driver
301  *    is performing 90 or 270 degree rotated scanout
302  * @x: x position on screen
303  * @y: y position on screen
304  * @funcs: CRTC control functions
305  * @gamma_size: size of gamma ramp
306  * @gamma_store: gamma ramp values
307  * @framedur_ns: precise frame timing
308  * @framedur_ns: precise line timing
309  * @pixeldur_ns: precise pixel timing
310  * @helper_private: mid-layer private data
311  * @properties: property tracking for this CRTC
312  *
313  * Each CRTC may have one or more connectors associated with it.  This structure
314  * allows the CRTC to be controlled.
315  */
316 struct drm_crtc {
317         struct drm_device *dev;
318         struct device_node *port;
319         struct list_head head;
320
321         /**
322          * crtc mutex
323          *
324          * This provides a read lock for the overall crtc state (mode, dpms
325          * state, ...) and a write lock for everything which can be update
326          * without a full modeset (fb, cursor data, ...)
327          */
328         struct drm_modeset_lock mutex;
329
330         struct drm_mode_object base;
331
332         /* primary and cursor planes for CRTC */
333         struct drm_plane *primary;
334         struct drm_plane *cursor;
335
336         /* Temporary tracking of the old fb while a modeset is ongoing. Used
337          * by drm_mode_set_config_internal to implement correct refcounting. */
338         struct drm_framebuffer *old_fb;
339
340         bool enabled;
341
342         /* Requested mode from modesetting. */
343         struct drm_display_mode mode;
344
345         /* Programmed mode in hw, after adjustments for encoders,
346          * crtc, panel scaling etc. Needed for timestamping etc.
347          */
348         struct drm_display_mode hwmode;
349
350         bool invert_dimensions;
351
352         int x, y;
353         const struct drm_crtc_funcs *funcs;
354
355         /* CRTC gamma size for reporting to userspace */
356         uint32_t gamma_size;
357         uint16_t *gamma_store;
358
359         /* Constants needed for precise vblank and swap timestamping. */
360         int framedur_ns, linedur_ns, pixeldur_ns;
361
362         /* if you are using the helper */
363         void *helper_private;
364
365         struct drm_object_properties properties;
366 };
367
368
369 /**
370  * drm_connector_funcs - control connectors on a given device
371  * @dpms: set power state (see drm_crtc_funcs above)
372  * @save: save connector state
373  * @restore: restore connector state
374  * @reset: reset connector after state has been invalidated (e.g. resume)
375  * @detect: is this connector active?
376  * @fill_modes: fill mode list for this connector
377  * @set_property: property for this connector may need an update
378  * @destroy: make object go away
379  * @force: notify the driver that the connector is forced on
380  *
381  * Each CRTC may have one or more connectors attached to it.  The functions
382  * below allow the core DRM code to control connectors, enumerate available modes,
383  * etc.
384  */
385 struct drm_connector_funcs {
386         void (*dpms)(struct drm_connector *connector, int mode);
387         void (*save)(struct drm_connector *connector);
388         void (*restore)(struct drm_connector *connector);
389         void (*reset)(struct drm_connector *connector);
390
391         /* Check to see if anything is attached to the connector.
392          * @force is set to false whilst polling, true when checking the
393          * connector due to user request. @force can be used by the driver
394          * to avoid expensive, destructive operations during automated
395          * probing.
396          */
397         enum drm_connector_status (*detect)(struct drm_connector *connector,
398                                             bool force);
399         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
400         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
401                              uint64_t val);
402         void (*destroy)(struct drm_connector *connector);
403         void (*force)(struct drm_connector *connector);
404 };
405
406 /**
407  * drm_encoder_funcs - encoder controls
408  * @reset: reset state (e.g. at init or resume time)
409  * @destroy: cleanup and free associated data
410  *
411  * Encoders sit between CRTCs and connectors.
412  */
413 struct drm_encoder_funcs {
414         void (*reset)(struct drm_encoder *encoder);
415         void (*destroy)(struct drm_encoder *encoder);
416 };
417
418 #define DRM_CONNECTOR_MAX_ENCODER 3
419
420 /**
421  * drm_encoder - central DRM encoder structure
422  * @dev: parent DRM device
423  * @head: list management
424  * @base: base KMS object
425  * @name: encoder name
426  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
427  * @possible_crtcs: bitmask of potential CRTC bindings
428  * @possible_clones: bitmask of potential sibling encoders for cloning
429  * @crtc: currently bound CRTC
430  * @bridge: bridge associated to the encoder
431  * @funcs: control functions
432  * @helper_private: mid-layer private data
433  *
434  * CRTCs drive pixels to encoders, which convert them into signals
435  * appropriate for a given connector or set of connectors.
436  */
437 struct drm_encoder {
438         struct drm_device *dev;
439         struct list_head head;
440
441         struct drm_mode_object base;
442         char *name;
443         int encoder_type;
444         uint32_t possible_crtcs;
445         uint32_t possible_clones;
446
447         struct drm_crtc *crtc;
448         struct drm_bridge *bridge;
449         const struct drm_encoder_funcs *funcs;
450         void *helper_private;
451 };
452
453 /* should we poll this connector for connects and disconnects */
454 /* hot plug detectable */
455 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
456 /* poll for connections */
457 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
458 /* can cleanly poll for disconnections without flickering the screen */
459 /* DACs should rarely do this without a lot of testing */
460 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
461
462 #define MAX_ELD_BYTES   128
463
464 /**
465  * drm_connector - central DRM connector control structure
466  * @dev: parent DRM device
467  * @kdev: kernel device for sysfs attributes
468  * @attr: sysfs attributes
469  * @head: list management
470  * @base: base KMS object
471  * @name: connector name
472  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
473  * @connector_type_id: index into connector type enum
474  * @interlace_allowed: can this connector handle interlaced modes?
475  * @doublescan_allowed: can this connector handle doublescan?
476  * @modes: modes available on this connector (from fill_modes() + user)
477  * @status: one of the drm_connector_status enums (connected, not, or unknown)
478  * @probed_modes: list of modes derived directly from the display
479  * @display_info: information about attached display (e.g. from EDID)
480  * @funcs: connector control functions
481  * @edid_blob_ptr: DRM property containing EDID if present
482  * @properties: property tracking for this connector
483  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
484  * @dpms: current dpms state
485  * @helper_private: mid-layer private data
486  * @force: a %DRM_FORCE_<foo> state for forced mode sets
487  * @encoder_ids: valid encoders for this connector
488  * @encoder: encoder driving this connector, if any
489  * @eld: EDID-like data, if present
490  * @dvi_dual: dual link DVI, if found
491  * @max_tmds_clock: max clock rate, if found
492  * @latency_present: AV delay info from ELD, if found
493  * @video_latency: video latency info from ELD, if found
494  * @audio_latency: audio latency info from ELD, if found
495  * @null_edid_counter: track sinks that give us all zeros for the EDID
496  *
497  * Each connector may be connected to one or more CRTCs, or may be clonable by
498  * another connector if they can share a CRTC.  Each connector also has a specific
499  * position in the broader display (referred to as a 'screen' though it could
500  * span multiple monitors).
501  */
502 struct drm_connector {
503         struct drm_device *dev;
504         struct device *kdev;
505         struct device_attribute *attr;
506         struct list_head head;
507
508         struct drm_mode_object base;
509
510         char *name;
511         int connector_type;
512         int connector_type_id;
513         bool interlace_allowed;
514         bool doublescan_allowed;
515         bool stereo_allowed;
516         struct list_head modes; /* list of modes on this connector */
517
518         enum drm_connector_status status;
519
520         /* these are modes added by probing with DDC or the BIOS */
521         struct list_head probed_modes;
522
523         struct drm_display_info display_info;
524         const struct drm_connector_funcs *funcs;
525
526         struct drm_property_blob *edid_blob_ptr;
527         struct drm_object_properties properties;
528
529         uint8_t polled; /* DRM_CONNECTOR_POLL_* */
530
531         /* requested DPMS state */
532         int dpms;
533
534         void *helper_private;
535
536         /* forced on connector */
537         enum drm_connector_force force;
538         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
539         struct drm_encoder *encoder; /* currently active encoder */
540
541         /* EDID bits */
542         uint8_t eld[MAX_ELD_BYTES];
543         bool dvi_dual;
544         int max_tmds_clock;     /* in MHz */
545         bool latency_present[2];
546         int video_latency[2];   /* [0]: progressive, [1]: interlaced */
547         int audio_latency[2];
548         int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
549         unsigned bad_edid_counter;
550 };
551
552 /**
553  * drm_plane_funcs - driver plane control functions
554  * @update_plane: update the plane configuration
555  * @disable_plane: shut down the plane
556  * @destroy: clean up plane resources
557  * @set_property: called when a property is changed
558  */
559 struct drm_plane_funcs {
560         int (*update_plane)(struct drm_plane *plane,
561                             struct drm_crtc *crtc, struct drm_framebuffer *fb,
562                             int crtc_x, int crtc_y,
563                             unsigned int crtc_w, unsigned int crtc_h,
564                             uint32_t src_x, uint32_t src_y,
565                             uint32_t src_w, uint32_t src_h);
566         int (*disable_plane)(struct drm_plane *plane);
567         void (*destroy)(struct drm_plane *plane);
568
569         int (*set_property)(struct drm_plane *plane,
570                             struct drm_property *property, uint64_t val);
571 };
572
573 enum drm_plane_type {
574         DRM_PLANE_TYPE_OVERLAY,
575         DRM_PLANE_TYPE_PRIMARY,
576         DRM_PLANE_TYPE_CURSOR,
577 };
578
579 /**
580  * drm_plane - central DRM plane control structure
581  * @dev: DRM device this plane belongs to
582  * @head: for list management
583  * @base: base mode object
584  * @possible_crtcs: pipes this plane can be bound to
585  * @format_types: array of formats supported by this plane
586  * @format_count: number of formats supported
587  * @crtc: currently bound CRTC
588  * @fb: currently bound fb
589  * @funcs: helper functions
590  * @properties: property tracking for this plane
591  * @type: type of plane (overlay, primary, cursor)
592  */
593 struct drm_plane {
594         struct drm_device *dev;
595         struct list_head head;
596
597         struct drm_mode_object base;
598
599         uint32_t possible_crtcs;
600         uint32_t *format_types;
601         uint32_t format_count;
602
603         struct drm_crtc *crtc;
604         struct drm_framebuffer *fb;
605
606         const struct drm_plane_funcs *funcs;
607
608         struct drm_object_properties properties;
609
610         enum drm_plane_type type;
611 };
612
613 /**
614  * drm_bridge_funcs - drm_bridge control functions
615  * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
616  * @disable: Called right before encoder prepare, disables the bridge
617  * @post_disable: Called right after encoder prepare, for lockstepped disable
618  * @mode_set: Set this mode to the bridge
619  * @pre_enable: Called right before encoder commit, for lockstepped commit
620  * @enable: Called right after encoder commit, enables the bridge
621  * @destroy: make object go away
622  */
623 struct drm_bridge_funcs {
624         bool (*mode_fixup)(struct drm_bridge *bridge,
625                            const struct drm_display_mode *mode,
626                            struct drm_display_mode *adjusted_mode);
627         void (*disable)(struct drm_bridge *bridge);
628         void (*post_disable)(struct drm_bridge *bridge);
629         void (*mode_set)(struct drm_bridge *bridge,
630                          struct drm_display_mode *mode,
631                          struct drm_display_mode *adjusted_mode);
632         void (*pre_enable)(struct drm_bridge *bridge);
633         void (*enable)(struct drm_bridge *bridge);
634         void (*destroy)(struct drm_bridge *bridge);
635 };
636
637 /**
638  * drm_bridge - central DRM bridge control structure
639  * @dev: DRM device this bridge belongs to
640  * @head: list management
641  * @base: base mode object
642  * @funcs: control functions
643  * @driver_private: pointer to the bridge driver's internal context
644  */
645 struct drm_bridge {
646         struct drm_device *dev;
647         struct list_head head;
648
649         struct drm_mode_object base;
650
651         const struct drm_bridge_funcs *funcs;
652         void *driver_private;
653 };
654
655 /**
656  * drm_mode_set - new values for a CRTC config change
657  * @head: list management
658  * @fb: framebuffer to use for new config
659  * @crtc: CRTC whose configuration we're about to change
660  * @mode: mode timings to use
661  * @x: position of this CRTC relative to @fb
662  * @y: position of this CRTC relative to @fb
663  * @connectors: array of connectors to drive with this CRTC if possible
664  * @num_connectors: size of @connectors array
665  *
666  * Represents a single crtc the connectors that it drives with what mode
667  * and from which framebuffer it scans out from.
668  *
669  * This is used to set modes.
670  */
671 struct drm_mode_set {
672         struct drm_framebuffer *fb;
673         struct drm_crtc *crtc;
674         struct drm_display_mode *mode;
675
676         uint32_t x;
677         uint32_t y;
678
679         struct drm_connector **connectors;
680         size_t num_connectors;
681 };
682
683 /**
684  * struct drm_mode_config_funcs - basic driver provided mode setting functions
685  * @fb_create: create a new framebuffer object
686  * @output_poll_changed: function to handle output configuration changes
687  *
688  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
689  * involve drivers.
690  */
691 struct drm_mode_config_funcs {
692         struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
693                                              struct drm_file *file_priv,
694                                              struct drm_mode_fb_cmd2 *mode_cmd);
695         void (*output_poll_changed)(struct drm_device *dev);
696 };
697
698 /**
699  * drm_mode_group - group of mode setting resources for potential sub-grouping
700  * @num_crtcs: CRTC count
701  * @num_encoders: encoder count
702  * @num_connectors: connector count
703  * @id_list: list of KMS object IDs in this group
704  *
705  * Currently this simply tracks the global mode setting state.  But in the
706  * future it could allow groups of objects to be set aside into independent
707  * control groups for use by different user level processes (e.g. two X servers
708  * running simultaneously on different heads, each with their own mode
709  * configuration and freedom of mode setting).
710  */
711 struct drm_mode_group {
712         uint32_t num_crtcs;
713         uint32_t num_encoders;
714         uint32_t num_connectors;
715         uint32_t num_bridges;
716
717         /* list of object IDs for this group */
718         uint32_t *id_list;
719 };
720
721 /**
722  * drm_mode_config - Mode configuration control structure
723  * @mutex: mutex protecting KMS related lists and structures
724  * @idr_mutex: mutex for KMS ID allocation and management
725  * @crtc_idr: main KMS ID tracking object
726  * @num_fb: number of fbs available
727  * @fb_list: list of framebuffers available
728  * @num_connector: number of connectors on this device
729  * @connector_list: list of connector objects
730  * @num_bridge: number of bridges on this device
731  * @bridge_list: list of bridge objects
732  * @num_encoder: number of encoders on this device
733  * @encoder_list: list of encoder objects
734  * @num_crtc: number of CRTCs on this device
735  * @crtc_list: list of CRTC objects
736  * @min_width: minimum pixel width on this device
737  * @min_height: minimum pixel height on this device
738  * @max_width: maximum pixel width on this device
739  * @max_height: maximum pixel height on this device
740  * @funcs: core driver provided mode setting functions
741  * @fb_base: base address of the framebuffer
742  * @poll_enabled: track polling status for this device
743  * @output_poll_work: delayed work for polling in process context
744  * @*_property: core property tracking
745  *
746  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
747  * enumerated by the driver are added here, as are global properties.  Some
748  * global restrictions are also here, e.g. dimension restrictions.
749  */
750 struct drm_mode_config {
751         struct mutex mutex; /* protects configuration (mode lists etc.) */
752         struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
753         struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
754         struct mutex idr_mutex; /* for IDR management */
755         struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
756         /* this is limited to one for now */
757
758
759         /**
760          * fb_lock - mutex to protect fb state
761          *
762          * Besides the global fb list his also protects the fbs list in the
763          * file_priv
764          */
765         struct mutex fb_lock;
766         int num_fb;
767         struct list_head fb_list;
768
769         int num_connector;
770         struct list_head connector_list;
771         int num_bridge;
772         struct list_head bridge_list;
773         int num_encoder;
774         struct list_head encoder_list;
775
776         /*
777          * Track # of overlay planes separately from # of total planes.  By
778          * default we only advertise overlay planes to userspace; if userspace
779          * sets the "universal plane" capability bit, we'll go ahead and
780          * expose all planes.
781          */
782         int num_overlay_plane;
783         int num_total_plane;
784         struct list_head plane_list;
785
786         int num_crtc;
787         struct list_head crtc_list;
788
789         struct list_head property_list;
790
791         int min_width, min_height;
792         int max_width, max_height;
793         const struct drm_mode_config_funcs *funcs;
794         resource_size_t fb_base;
795
796         /* output poll support */
797         bool poll_enabled;
798         bool poll_running;
799         struct delayed_work output_poll_work;
800
801         /* pointers to standard properties */
802         struct list_head property_blob_list;
803         struct drm_property *edid_property;
804         struct drm_property *dpms_property;
805         struct drm_property *plane_type_property;
806
807         /* DVI-I properties */
808         struct drm_property *dvi_i_subconnector_property;
809         struct drm_property *dvi_i_select_subconnector_property;
810
811         /* TV properties */
812         struct drm_property *tv_subconnector_property;
813         struct drm_property *tv_select_subconnector_property;
814         struct drm_property *tv_mode_property;
815         struct drm_property *tv_left_margin_property;
816         struct drm_property *tv_right_margin_property;
817         struct drm_property *tv_top_margin_property;
818         struct drm_property *tv_bottom_margin_property;
819         struct drm_property *tv_brightness_property;
820         struct drm_property *tv_contrast_property;
821         struct drm_property *tv_flicker_reduction_property;
822         struct drm_property *tv_overscan_property;
823         struct drm_property *tv_saturation_property;
824         struct drm_property *tv_hue_property;
825
826         /* Optional properties */
827         struct drm_property *scaling_mode_property;
828         struct drm_property *dirty_info_property;
829
830         /* dumb ioctl parameters */
831         uint32_t preferred_depth, prefer_shadow;
832
833         /* whether async page flip is supported or not */
834         bool async_page_flip;
835
836         /* cursor size */
837         uint32_t cursor_width, cursor_height;
838 };
839
840 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
841 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
842 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
843 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
844 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
845 #define obj_to_property(x) container_of(x, struct drm_property, base)
846 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
847 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
848
849 struct drm_prop_enum_list {
850         int type;
851         char *name;
852 };
853
854 extern int drm_crtc_init_with_planes(struct drm_device *dev,
855                                      struct drm_crtc *crtc,
856                                      struct drm_plane *primary,
857                                      void *cursor,
858                                      const struct drm_crtc_funcs *funcs);
859 extern int drm_crtc_init(struct drm_device *dev,
860                          struct drm_crtc *crtc,
861                          const struct drm_crtc_funcs *funcs);
862 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
863 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
864
865 /**
866  * drm_crtc_mask - find the mask of a registered CRTC
867  * @crtc: CRTC to find mask for
868  *
869  * Given a registered CRTC, return the mask bit of that CRTC for an
870  * encoder's possible_crtcs field.
871  */
872 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
873 {
874         return 1 << drm_crtc_index(crtc);
875 }
876
877 extern void drm_connector_ida_init(void);
878 extern void drm_connector_ida_destroy(void);
879 extern int drm_connector_init(struct drm_device *dev,
880                               struct drm_connector *connector,
881                               const struct drm_connector_funcs *funcs,
882                               int connector_type);
883
884 extern void drm_connector_cleanup(struct drm_connector *connector);
885 /* helper to unplug all connectors from sysfs for device */
886 extern void drm_connector_unplug_all(struct drm_device *dev);
887
888 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
889                            const struct drm_bridge_funcs *funcs);
890 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
891
892 extern int drm_encoder_init(struct drm_device *dev,
893                             struct drm_encoder *encoder,
894                             const struct drm_encoder_funcs *funcs,
895                             int encoder_type);
896
897 /**
898  * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
899  * @encoder: encoder to test
900  * @crtc: crtc to test
901  *
902  * Return false if @encoder can't be driven by @crtc, true otherwise.
903  */
904 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
905                                        struct drm_crtc *crtc)
906 {
907         return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
908 }
909
910 extern int drm_universal_plane_init(struct drm_device *dev,
911                                     struct drm_plane *plane,
912                                     unsigned long possible_crtcs,
913                                     const struct drm_plane_funcs *funcs,
914                                     const uint32_t *formats,
915                                     uint32_t format_count,
916                                     enum drm_plane_type type);
917 extern int drm_plane_init(struct drm_device *dev,
918                           struct drm_plane *plane,
919                           unsigned long possible_crtcs,
920                           const struct drm_plane_funcs *funcs,
921                           const uint32_t *formats, uint32_t format_count,
922                           bool is_primary);
923 extern void drm_plane_cleanup(struct drm_plane *plane);
924 extern void drm_plane_force_disable(struct drm_plane *plane);
925 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
926                                    int x, int y,
927                                    const struct drm_display_mode *mode,
928                                    const struct drm_framebuffer *fb);
929
930 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
931
932 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
933 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
934 extern const char *drm_get_dpms_name(int val);
935 extern const char *drm_get_dvi_i_subconnector_name(int val);
936 extern const char *drm_get_dvi_i_select_name(int val);
937 extern const char *drm_get_tv_subconnector_name(int val);
938 extern const char *drm_get_tv_select_name(int val);
939 extern void drm_fb_release(struct drm_file *file_priv);
940 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
941 extern void drm_mode_group_destroy(struct drm_mode_group *group);
942 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
943 extern struct edid *drm_get_edid(struct drm_connector *connector,
944                                  struct i2c_adapter *adapter);
945 extern struct edid *drm_edid_duplicate(const struct edid *edid);
946 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
947 extern void drm_mode_config_init(struct drm_device *dev);
948 extern void drm_mode_config_reset(struct drm_device *dev);
949 extern void drm_mode_config_cleanup(struct drm_device *dev);
950
951 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
952                                                 struct edid *edid);
953
954 static inline bool drm_property_type_is(struct drm_property *property,
955                 uint32_t type)
956 {
957         /* instanceof for props.. handles extended type vs original types: */
958         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
959                 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
960         return property->flags & type;
961 }
962
963 static inline bool drm_property_type_valid(struct drm_property *property)
964 {
965         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
966                 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
967         return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
968 }
969
970 extern int drm_object_property_set_value(struct drm_mode_object *obj,
971                                          struct drm_property *property,
972                                          uint64_t val);
973 extern int drm_object_property_get_value(struct drm_mode_object *obj,
974                                          struct drm_property *property,
975                                          uint64_t *value);
976 extern int drm_framebuffer_init(struct drm_device *dev,
977                                 struct drm_framebuffer *fb,
978                                 const struct drm_framebuffer_funcs *funcs);
979 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
980                                                       uint32_t id);
981 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
982 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
983 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
984 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
985 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
986
987 extern void drm_object_attach_property(struct drm_mode_object *obj,
988                                        struct drm_property *property,
989                                        uint64_t init_val);
990 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
991                                                 const char *name, int num_values);
992 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
993                                          const char *name,
994                                          const struct drm_prop_enum_list *props,
995                                          int num_values);
996 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
997                                          int flags, const char *name,
998                                          const struct drm_prop_enum_list *props,
999                                          int num_values);
1000 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1001                                          const char *name,
1002                                          uint64_t min, uint64_t max);
1003 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1004                                          int flags, const char *name,
1005                                          int64_t min, int64_t max);
1006 struct drm_property *drm_property_create_object(struct drm_device *dev,
1007                                          int flags, const char *name, uint32_t type);
1008 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1009 extern int drm_property_add_enum(struct drm_property *property, int index,
1010                                  uint64_t value, const char *name);
1011 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1012 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1013                                      char *formats[]);
1014 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1015 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1016
1017 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1018                                              struct drm_encoder *encoder);
1019 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1020                                          int gamma_size);
1021 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1022                 uint32_t id, uint32_t type);
1023
1024 /* IOCTLs */
1025 extern int drm_mode_getresources(struct drm_device *dev,
1026                                  void *data, struct drm_file *file_priv);
1027 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1028                                    struct drm_file *file_priv);
1029 extern int drm_mode_getcrtc(struct drm_device *dev,
1030                             void *data, struct drm_file *file_priv);
1031 extern int drm_mode_getconnector(struct drm_device *dev,
1032                               void *data, struct drm_file *file_priv);
1033 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1034 extern int drm_mode_setcrtc(struct drm_device *dev,
1035                             void *data, struct drm_file *file_priv);
1036 extern int drm_mode_getplane(struct drm_device *dev,
1037                                void *data, struct drm_file *file_priv);
1038 extern int drm_mode_setplane(struct drm_device *dev,
1039                                void *data, struct drm_file *file_priv);
1040 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1041                                 void *data, struct drm_file *file_priv);
1042 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1043                                 void *data, struct drm_file *file_priv);
1044 extern int drm_mode_addfb(struct drm_device *dev,
1045                           void *data, struct drm_file *file_priv);
1046 extern int drm_mode_addfb2(struct drm_device *dev,
1047                            void *data, struct drm_file *file_priv);
1048 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1049 extern int drm_mode_rmfb(struct drm_device *dev,
1050                          void *data, struct drm_file *file_priv);
1051 extern int drm_mode_getfb(struct drm_device *dev,
1052                           void *data, struct drm_file *file_priv);
1053 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1054                                   void *data, struct drm_file *file_priv);
1055
1056 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1057                                       void *data, struct drm_file *file_priv);
1058 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1059                                   void *data, struct drm_file *file_priv);
1060 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1061                                               void *data, struct drm_file *file_priv);
1062 extern int drm_mode_getencoder(struct drm_device *dev,
1063                                void *data, struct drm_file *file_priv);
1064 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1065                                     void *data, struct drm_file *file_priv);
1066 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1067                                     void *data, struct drm_file *file_priv);
1068 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1069 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1070 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1071 extern bool drm_detect_monitor_audio(struct edid *edid);
1072 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1073 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1074                                     void *data, struct drm_file *file_priv);
1075 extern int drm_add_modes_noedid(struct drm_connector *connector,
1076                                 int hdisplay, int vdisplay);
1077 extern void drm_set_preferred_mode(struct drm_connector *connector,
1078                                    int hpref, int vpref);
1079
1080 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1081 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1082 extern bool drm_edid_is_valid(struct edid *edid);
1083 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1084                                            int hsize, int vsize, int fresh,
1085                                            bool rb);
1086
1087 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1088                                       void *data, struct drm_file *file_priv);
1089 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1090                                     void *data, struct drm_file *file_priv);
1091 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1092                                       void *data, struct drm_file *file_priv);
1093 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1094                                              struct drm_file *file_priv);
1095 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1096                                            struct drm_file *file_priv);
1097
1098 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1099                                  int *bpp);
1100 extern int drm_format_num_planes(uint32_t format);
1101 extern int drm_format_plane_cpp(uint32_t format, int plane);
1102 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1103 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1104 extern const char *drm_get_format_name(uint32_t format);
1105
1106 /* Helpers */
1107
1108 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1109                 uint32_t id)
1110 {
1111         struct drm_mode_object *mo;
1112         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1113         return mo ? obj_to_plane(mo) : NULL;
1114 }
1115
1116 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1117         uint32_t id)
1118 {
1119         struct drm_mode_object *mo;
1120         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1121         return mo ? obj_to_crtc(mo) : NULL;
1122 }
1123
1124 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1125         uint32_t id)
1126 {
1127         struct drm_mode_object *mo;
1128         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1129         return mo ? obj_to_encoder(mo) : NULL;
1130 }
1131
1132 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1133                 uint32_t id)
1134 {
1135         struct drm_mode_object *mo;
1136         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1137         return mo ? obj_to_connector(mo) : NULL;
1138 }
1139
1140 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1141                 uint32_t id)
1142 {
1143         struct drm_mode_object *mo;
1144         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1145         return mo ? obj_to_property(mo) : NULL;
1146 }
1147
1148 static inline struct drm_property_blob *
1149 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1150 {
1151         struct drm_mode_object *mo;
1152         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1153         return mo ? obj_to_blob(mo) : NULL;
1154 }
1155
1156 /* Plane list iterator for legacy (overlay only) planes. */
1157 #define drm_for_each_legacy_plane(plane, planelist) \
1158         list_for_each_entry(plane, planelist, head) \
1159                 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1160
1161 #endif /* __DRM_CRTC_H__ */