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