Merge branch 'component-for-drm' of git://ftp.arm.linux.org.uk/~rmk/linux-arm into...
[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         /* position of cursor plane on crtc */
337         int cursor_x;
338         int cursor_y;
339
340         /* Temporary tracking of the old fb while a modeset is ongoing. Used
341          * by drm_mode_set_config_internal to implement correct refcounting. */
342         struct drm_framebuffer *old_fb;
343
344         bool enabled;
345
346         /* Requested mode from modesetting. */
347         struct drm_display_mode mode;
348
349         /* Programmed mode in hw, after adjustments for encoders,
350          * crtc, panel scaling etc. Needed for timestamping etc.
351          */
352         struct drm_display_mode hwmode;
353
354         bool invert_dimensions;
355
356         int x, y;
357         const struct drm_crtc_funcs *funcs;
358
359         /* CRTC gamma size for reporting to userspace */
360         uint32_t gamma_size;
361         uint16_t *gamma_store;
362
363         /* Constants needed for precise vblank and swap timestamping. */
364         int framedur_ns, linedur_ns, pixeldur_ns;
365
366         /* if you are using the helper */
367         void *helper_private;
368
369         struct drm_object_properties properties;
370 };
371
372
373 /**
374  * drm_connector_funcs - control connectors on a given device
375  * @dpms: set power state (see drm_crtc_funcs above)
376  * @save: save connector state
377  * @restore: restore connector state
378  * @reset: reset connector after state has been invalidated (e.g. resume)
379  * @detect: is this connector active?
380  * @fill_modes: fill mode list for this connector
381  * @set_property: property for this connector may need an update
382  * @destroy: make object go away
383  * @force: notify the driver that the connector is forced on
384  *
385  * Each CRTC may have one or more connectors attached to it.  The functions
386  * below allow the core DRM code to control connectors, enumerate available modes,
387  * etc.
388  */
389 struct drm_connector_funcs {
390         void (*dpms)(struct drm_connector *connector, int mode);
391         void (*save)(struct drm_connector *connector);
392         void (*restore)(struct drm_connector *connector);
393         void (*reset)(struct drm_connector *connector);
394
395         /* Check to see if anything is attached to the connector.
396          * @force is set to false whilst polling, true when checking the
397          * connector due to user request. @force can be used by the driver
398          * to avoid expensive, destructive operations during automated
399          * probing.
400          */
401         enum drm_connector_status (*detect)(struct drm_connector *connector,
402                                             bool force);
403         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
404         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
405                              uint64_t val);
406         void (*destroy)(struct drm_connector *connector);
407         void (*force)(struct drm_connector *connector);
408 };
409
410 /**
411  * drm_encoder_funcs - encoder controls
412  * @reset: reset state (e.g. at init or resume time)
413  * @destroy: cleanup and free associated data
414  *
415  * Encoders sit between CRTCs and connectors.
416  */
417 struct drm_encoder_funcs {
418         void (*reset)(struct drm_encoder *encoder);
419         void (*destroy)(struct drm_encoder *encoder);
420 };
421
422 #define DRM_CONNECTOR_MAX_ENCODER 3
423
424 /**
425  * drm_encoder - central DRM encoder structure
426  * @dev: parent DRM device
427  * @head: list management
428  * @base: base KMS object
429  * @name: encoder name
430  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
431  * @possible_crtcs: bitmask of potential CRTC bindings
432  * @possible_clones: bitmask of potential sibling encoders for cloning
433  * @crtc: currently bound CRTC
434  * @bridge: bridge associated to the encoder
435  * @funcs: control functions
436  * @helper_private: mid-layer private data
437  *
438  * CRTCs drive pixels to encoders, which convert them into signals
439  * appropriate for a given connector or set of connectors.
440  */
441 struct drm_encoder {
442         struct drm_device *dev;
443         struct list_head head;
444
445         struct drm_mode_object base;
446         char *name;
447         int encoder_type;
448         uint32_t possible_crtcs;
449         uint32_t possible_clones;
450
451         struct drm_crtc *crtc;
452         struct drm_bridge *bridge;
453         const struct drm_encoder_funcs *funcs;
454         void *helper_private;
455 };
456
457 /* should we poll this connector for connects and disconnects */
458 /* hot plug detectable */
459 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
460 /* poll for connections */
461 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
462 /* can cleanly poll for disconnections without flickering the screen */
463 /* DACs should rarely do this without a lot of testing */
464 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
465
466 #define MAX_ELD_BYTES   128
467
468 /**
469  * drm_connector - central DRM connector control structure
470  * @dev: parent DRM device
471  * @kdev: kernel device for sysfs attributes
472  * @attr: sysfs attributes
473  * @head: list management
474  * @base: base KMS object
475  * @name: connector name
476  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
477  * @connector_type_id: index into connector type enum
478  * @interlace_allowed: can this connector handle interlaced modes?
479  * @doublescan_allowed: can this connector handle doublescan?
480  * @modes: modes available on this connector (from fill_modes() + user)
481  * @status: one of the drm_connector_status enums (connected, not, or unknown)
482  * @probed_modes: list of modes derived directly from the display
483  * @display_info: information about attached display (e.g. from EDID)
484  * @funcs: connector control functions
485  * @edid_blob_ptr: DRM property containing EDID if present
486  * @properties: property tracking for this connector
487  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
488  * @dpms: current dpms state
489  * @helper_private: mid-layer private data
490  * @force: a %DRM_FORCE_<foo> state for forced mode sets
491  * @encoder_ids: valid encoders for this connector
492  * @encoder: encoder driving this connector, if any
493  * @eld: EDID-like data, if present
494  * @dvi_dual: dual link DVI, if found
495  * @max_tmds_clock: max clock rate, if found
496  * @latency_present: AV delay info from ELD, if found
497  * @video_latency: video latency info from ELD, if found
498  * @audio_latency: audio latency info from ELD, if found
499  * @null_edid_counter: track sinks that give us all zeros for the EDID
500  *
501  * Each connector may be connected to one or more CRTCs, or may be clonable by
502  * another connector if they can share a CRTC.  Each connector also has a specific
503  * position in the broader display (referred to as a 'screen' though it could
504  * span multiple monitors).
505  */
506 struct drm_connector {
507         struct drm_device *dev;
508         struct device *kdev;
509         struct device_attribute *attr;
510         struct list_head head;
511
512         struct drm_mode_object base;
513
514         char *name;
515         int connector_type;
516         int connector_type_id;
517         bool interlace_allowed;
518         bool doublescan_allowed;
519         bool stereo_allowed;
520         struct list_head modes; /* list of modes on this connector */
521
522         enum drm_connector_status status;
523
524         /* these are modes added by probing with DDC or the BIOS */
525         struct list_head probed_modes;
526
527         struct drm_display_info display_info;
528         const struct drm_connector_funcs *funcs;
529
530         struct drm_property_blob *edid_blob_ptr;
531         struct drm_object_properties properties;
532
533         struct drm_property_blob *path_blob_ptr;
534
535         uint8_t polled; /* DRM_CONNECTOR_POLL_* */
536
537         /* requested DPMS state */
538         int dpms;
539
540         void *helper_private;
541
542         /* forced on connector */
543         enum drm_connector_force force;
544         bool override_edid;
545         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
546         struct drm_encoder *encoder; /* currently active encoder */
547
548         /* EDID bits */
549         uint8_t eld[MAX_ELD_BYTES];
550         bool dvi_dual;
551         int max_tmds_clock;     /* in MHz */
552         bool latency_present[2];
553         int video_latency[2];   /* [0]: progressive, [1]: interlaced */
554         int audio_latency[2];
555         int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
556         unsigned bad_edid_counter;
557
558         struct dentry *debugfs_entry;
559 };
560
561 /**
562  * drm_plane_funcs - driver plane control functions
563  * @update_plane: update the plane configuration
564  * @disable_plane: shut down the plane
565  * @destroy: clean up plane resources
566  * @set_property: called when a property is changed
567  */
568 struct drm_plane_funcs {
569         int (*update_plane)(struct drm_plane *plane,
570                             struct drm_crtc *crtc, struct drm_framebuffer *fb,
571                             int crtc_x, int crtc_y,
572                             unsigned int crtc_w, unsigned int crtc_h,
573                             uint32_t src_x, uint32_t src_y,
574                             uint32_t src_w, uint32_t src_h);
575         int (*disable_plane)(struct drm_plane *plane);
576         void (*destroy)(struct drm_plane *plane);
577
578         int (*set_property)(struct drm_plane *plane,
579                             struct drm_property *property, uint64_t val);
580 };
581
582 enum drm_plane_type {
583         DRM_PLANE_TYPE_OVERLAY,
584         DRM_PLANE_TYPE_PRIMARY,
585         DRM_PLANE_TYPE_CURSOR,
586 };
587
588 /**
589  * drm_plane - central DRM plane control structure
590  * @dev: DRM device this plane belongs to
591  * @head: for list management
592  * @base: base mode object
593  * @possible_crtcs: pipes this plane can be bound to
594  * @format_types: array of formats supported by this plane
595  * @format_count: number of formats supported
596  * @crtc: currently bound CRTC
597  * @fb: currently bound fb
598  * @funcs: helper functions
599  * @properties: property tracking for this plane
600  * @type: type of plane (overlay, primary, cursor)
601  */
602 struct drm_plane {
603         struct drm_device *dev;
604         struct list_head head;
605
606         struct drm_mode_object base;
607
608         uint32_t possible_crtcs;
609         uint32_t *format_types;
610         uint32_t format_count;
611
612         struct drm_crtc *crtc;
613         struct drm_framebuffer *fb;
614
615         const struct drm_plane_funcs *funcs;
616
617         struct drm_object_properties properties;
618
619         enum drm_plane_type type;
620 };
621
622 /**
623  * drm_bridge_funcs - drm_bridge control functions
624  * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
625  * @disable: Called right before encoder prepare, disables the bridge
626  * @post_disable: Called right after encoder prepare, for lockstepped disable
627  * @mode_set: Set this mode to the bridge
628  * @pre_enable: Called right before encoder commit, for lockstepped commit
629  * @enable: Called right after encoder commit, enables the bridge
630  * @destroy: make object go away
631  */
632 struct drm_bridge_funcs {
633         bool (*mode_fixup)(struct drm_bridge *bridge,
634                            const struct drm_display_mode *mode,
635                            struct drm_display_mode *adjusted_mode);
636         void (*disable)(struct drm_bridge *bridge);
637         void (*post_disable)(struct drm_bridge *bridge);
638         void (*mode_set)(struct drm_bridge *bridge,
639                          struct drm_display_mode *mode,
640                          struct drm_display_mode *adjusted_mode);
641         void (*pre_enable)(struct drm_bridge *bridge);
642         void (*enable)(struct drm_bridge *bridge);
643         void (*destroy)(struct drm_bridge *bridge);
644 };
645
646 /**
647  * drm_bridge - central DRM bridge control structure
648  * @dev: DRM device this bridge belongs to
649  * @head: list management
650  * @base: base mode object
651  * @funcs: control functions
652  * @driver_private: pointer to the bridge driver's internal context
653  */
654 struct drm_bridge {
655         struct drm_device *dev;
656         struct list_head head;
657
658         struct drm_mode_object base;
659
660         const struct drm_bridge_funcs *funcs;
661         void *driver_private;
662 };
663
664 /**
665  * drm_mode_set - new values for a CRTC config change
666  * @head: list management
667  * @fb: framebuffer to use for new config
668  * @crtc: CRTC whose configuration we're about to change
669  * @mode: mode timings to use
670  * @x: position of this CRTC relative to @fb
671  * @y: position of this CRTC relative to @fb
672  * @connectors: array of connectors to drive with this CRTC if possible
673  * @num_connectors: size of @connectors array
674  *
675  * Represents a single crtc the connectors that it drives with what mode
676  * and from which framebuffer it scans out from.
677  *
678  * This is used to set modes.
679  */
680 struct drm_mode_set {
681         struct drm_framebuffer *fb;
682         struct drm_crtc *crtc;
683         struct drm_display_mode *mode;
684
685         uint32_t x;
686         uint32_t y;
687
688         struct drm_connector **connectors;
689         size_t num_connectors;
690 };
691
692 /**
693  * struct drm_mode_config_funcs - basic driver provided mode setting functions
694  * @fb_create: create a new framebuffer object
695  * @output_poll_changed: function to handle output configuration changes
696  *
697  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
698  * involve drivers.
699  */
700 struct drm_mode_config_funcs {
701         struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
702                                              struct drm_file *file_priv,
703                                              struct drm_mode_fb_cmd2 *mode_cmd);
704         void (*output_poll_changed)(struct drm_device *dev);
705 };
706
707 /**
708  * drm_mode_group - group of mode setting resources for potential sub-grouping
709  * @num_crtcs: CRTC count
710  * @num_encoders: encoder count
711  * @num_connectors: connector count
712  * @id_list: list of KMS object IDs in this group
713  *
714  * Currently this simply tracks the global mode setting state.  But in the
715  * future it could allow groups of objects to be set aside into independent
716  * control groups for use by different user level processes (e.g. two X servers
717  * running simultaneously on different heads, each with their own mode
718  * configuration and freedom of mode setting).
719  */
720 struct drm_mode_group {
721         uint32_t num_crtcs;
722         uint32_t num_encoders;
723         uint32_t num_connectors;
724         uint32_t num_bridges;
725
726         /* list of object IDs for this group */
727         uint32_t *id_list;
728 };
729
730 /**
731  * drm_mode_config - Mode configuration control structure
732  * @mutex: mutex protecting KMS related lists and structures
733  * @idr_mutex: mutex for KMS ID allocation and management
734  * @crtc_idr: main KMS ID tracking object
735  * @num_fb: number of fbs available
736  * @fb_list: list of framebuffers available
737  * @num_connector: number of connectors on this device
738  * @connector_list: list of connector objects
739  * @num_bridge: number of bridges on this device
740  * @bridge_list: list of bridge objects
741  * @num_encoder: number of encoders on this device
742  * @encoder_list: list of encoder objects
743  * @num_crtc: number of CRTCs on this device
744  * @crtc_list: list of CRTC objects
745  * @min_width: minimum pixel width on this device
746  * @min_height: minimum pixel height on this device
747  * @max_width: maximum pixel width on this device
748  * @max_height: maximum pixel height on this device
749  * @funcs: core driver provided mode setting functions
750  * @fb_base: base address of the framebuffer
751  * @poll_enabled: track polling status for this device
752  * @output_poll_work: delayed work for polling in process context
753  * @*_property: core property tracking
754  *
755  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
756  * enumerated by the driver are added here, as are global properties.  Some
757  * global restrictions are also here, e.g. dimension restrictions.
758  */
759 struct drm_mode_config {
760         struct mutex mutex; /* protects configuration (mode lists etc.) */
761         struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
762         struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
763         struct mutex idr_mutex; /* for IDR management */
764         struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
765         /* this is limited to one for now */
766
767
768         /**
769          * fb_lock - mutex to protect fb state
770          *
771          * Besides the global fb list his also protects the fbs list in the
772          * file_priv
773          */
774         struct mutex fb_lock;
775         int num_fb;
776         struct list_head fb_list;
777
778         int num_connector;
779         struct list_head connector_list;
780         int num_bridge;
781         struct list_head bridge_list;
782         int num_encoder;
783         struct list_head encoder_list;
784
785         /*
786          * Track # of overlay planes separately from # of total planes.  By
787          * default we only advertise overlay planes to userspace; if userspace
788          * sets the "universal plane" capability bit, we'll go ahead and
789          * expose all planes.
790          */
791         int num_overlay_plane;
792         int num_total_plane;
793         struct list_head plane_list;
794
795         int num_crtc;
796         struct list_head crtc_list;
797
798         struct list_head property_list;
799
800         int min_width, min_height;
801         int max_width, max_height;
802         const struct drm_mode_config_funcs *funcs;
803         resource_size_t fb_base;
804
805         /* output poll support */
806         bool poll_enabled;
807         bool poll_running;
808         struct delayed_work output_poll_work;
809
810         /* pointers to standard properties */
811         struct list_head property_blob_list;
812         struct drm_property *edid_property;
813         struct drm_property *dpms_property;
814         struct drm_property *path_property;
815         struct drm_property *plane_type_property;
816
817         /* DVI-I properties */
818         struct drm_property *dvi_i_subconnector_property;
819         struct drm_property *dvi_i_select_subconnector_property;
820
821         /* TV properties */
822         struct drm_property *tv_subconnector_property;
823         struct drm_property *tv_select_subconnector_property;
824         struct drm_property *tv_mode_property;
825         struct drm_property *tv_left_margin_property;
826         struct drm_property *tv_right_margin_property;
827         struct drm_property *tv_top_margin_property;
828         struct drm_property *tv_bottom_margin_property;
829         struct drm_property *tv_brightness_property;
830         struct drm_property *tv_contrast_property;
831         struct drm_property *tv_flicker_reduction_property;
832         struct drm_property *tv_overscan_property;
833         struct drm_property *tv_saturation_property;
834         struct drm_property *tv_hue_property;
835
836         /* Optional properties */
837         struct drm_property *scaling_mode_property;
838         struct drm_property *dirty_info_property;
839
840         /* dumb ioctl parameters */
841         uint32_t preferred_depth, prefer_shadow;
842
843         /* whether async page flip is supported or not */
844         bool async_page_flip;
845
846         /* cursor size */
847         uint32_t cursor_width, cursor_height;
848 };
849
850 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
851 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
852 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
853 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
854 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
855 #define obj_to_property(x) container_of(x, struct drm_property, base)
856 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
857 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
858
859 struct drm_prop_enum_list {
860         int type;
861         char *name;
862 };
863
864 extern int drm_crtc_init_with_planes(struct drm_device *dev,
865                                      struct drm_crtc *crtc,
866                                      struct drm_plane *primary,
867                                      struct drm_plane *cursor,
868                                      const struct drm_crtc_funcs *funcs);
869 extern int drm_crtc_init(struct drm_device *dev,
870                          struct drm_crtc *crtc,
871                          const struct drm_crtc_funcs *funcs);
872 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
873 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
874
875 /**
876  * drm_crtc_mask - find the mask of a registered CRTC
877  * @crtc: CRTC to find mask for
878  *
879  * Given a registered CRTC, return the mask bit of that CRTC for an
880  * encoder's possible_crtcs field.
881  */
882 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
883 {
884         return 1 << drm_crtc_index(crtc);
885 }
886
887 extern void drm_connector_ida_init(void);
888 extern void drm_connector_ida_destroy(void);
889 extern int drm_connector_init(struct drm_device *dev,
890                               struct drm_connector *connector,
891                               const struct drm_connector_funcs *funcs,
892                               int connector_type);
893 int drm_connector_register(struct drm_connector *connector);
894 void drm_connector_unregister(struct drm_connector *connector);
895
896 extern void drm_connector_cleanup(struct drm_connector *connector);
897 /* helper to unplug all connectors from sysfs for device */
898 extern void drm_connector_unplug_all(struct drm_device *dev);
899
900 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
901                            const struct drm_bridge_funcs *funcs);
902 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
903
904 extern int drm_encoder_init(struct drm_device *dev,
905                             struct drm_encoder *encoder,
906                             const struct drm_encoder_funcs *funcs,
907                             int encoder_type);
908
909 /**
910  * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
911  * @encoder: encoder to test
912  * @crtc: crtc to test
913  *
914  * Return false if @encoder can't be driven by @crtc, true otherwise.
915  */
916 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
917                                        struct drm_crtc *crtc)
918 {
919         return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
920 }
921
922 extern int drm_universal_plane_init(struct drm_device *dev,
923                                     struct drm_plane *plane,
924                                     unsigned long possible_crtcs,
925                                     const struct drm_plane_funcs *funcs,
926                                     const uint32_t *formats,
927                                     uint32_t format_count,
928                                     enum drm_plane_type type);
929 extern int drm_plane_init(struct drm_device *dev,
930                           struct drm_plane *plane,
931                           unsigned long possible_crtcs,
932                           const struct drm_plane_funcs *funcs,
933                           const uint32_t *formats, uint32_t format_count,
934                           bool is_primary);
935 extern void drm_plane_cleanup(struct drm_plane *plane);
936 extern void drm_plane_force_disable(struct drm_plane *plane);
937 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
938                                    int x, int y,
939                                    const struct drm_display_mode *mode,
940                                    const struct drm_framebuffer *fb);
941
942 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
943
944 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
945 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
946 extern const char *drm_get_dpms_name(int val);
947 extern const char *drm_get_dvi_i_subconnector_name(int val);
948 extern const char *drm_get_dvi_i_select_name(int val);
949 extern const char *drm_get_tv_subconnector_name(int val);
950 extern const char *drm_get_tv_select_name(int val);
951 extern void drm_fb_release(struct drm_file *file_priv);
952 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
953 extern void drm_mode_group_destroy(struct drm_mode_group *group);
954 extern void drm_reinit_primary_mode_group(struct drm_device *dev);
955 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
956 extern struct edid *drm_get_edid(struct drm_connector *connector,
957                                  struct i2c_adapter *adapter);
958 extern struct edid *drm_edid_duplicate(const struct edid *edid);
959 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
960 extern void drm_mode_config_init(struct drm_device *dev);
961 extern void drm_mode_config_reset(struct drm_device *dev);
962 extern void drm_mode_config_cleanup(struct drm_device *dev);
963
964 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
965                                                 char *path);
966 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
967                                                 struct edid *edid);
968
969 static inline bool drm_property_type_is(struct drm_property *property,
970                 uint32_t type)
971 {
972         /* instanceof for props.. handles extended type vs original types: */
973         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
974                 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
975         return property->flags & type;
976 }
977
978 static inline bool drm_property_type_valid(struct drm_property *property)
979 {
980         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
981                 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
982         return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
983 }
984
985 extern int drm_object_property_set_value(struct drm_mode_object *obj,
986                                          struct drm_property *property,
987                                          uint64_t val);
988 extern int drm_object_property_get_value(struct drm_mode_object *obj,
989                                          struct drm_property *property,
990                                          uint64_t *value);
991 extern int drm_framebuffer_init(struct drm_device *dev,
992                                 struct drm_framebuffer *fb,
993                                 const struct drm_framebuffer_funcs *funcs);
994 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
995                                                       uint32_t id);
996 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
997 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
998 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
999 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1000 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1001
1002 extern void drm_object_attach_property(struct drm_mode_object *obj,
1003                                        struct drm_property *property,
1004                                        uint64_t init_val);
1005 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1006                                                 const char *name, int num_values);
1007 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1008                                          const char *name,
1009                                          const struct drm_prop_enum_list *props,
1010                                          int num_values);
1011 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1012                                          int flags, const char *name,
1013                                          const struct drm_prop_enum_list *props,
1014                                          int num_values);
1015 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1016                                          const char *name,
1017                                          uint64_t min, uint64_t max);
1018 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1019                                          int flags, const char *name,
1020                                          int64_t min, int64_t max);
1021 struct drm_property *drm_property_create_object(struct drm_device *dev,
1022                                          int flags, const char *name, uint32_t type);
1023 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1024 extern int drm_property_add_enum(struct drm_property *property, int index,
1025                                  uint64_t value, const char *name);
1026 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1027 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1028                                      char *formats[]);
1029 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1030 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1031
1032 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1033                                              struct drm_encoder *encoder);
1034 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1035                                          int gamma_size);
1036 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1037                 uint32_t id, uint32_t type);
1038
1039 /* IOCTLs */
1040 extern int drm_mode_getresources(struct drm_device *dev,
1041                                  void *data, struct drm_file *file_priv);
1042 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1043                                    struct drm_file *file_priv);
1044 extern int drm_mode_getcrtc(struct drm_device *dev,
1045                             void *data, struct drm_file *file_priv);
1046 extern int drm_mode_getconnector(struct drm_device *dev,
1047                               void *data, struct drm_file *file_priv);
1048 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1049 extern int drm_mode_setcrtc(struct drm_device *dev,
1050                             void *data, struct drm_file *file_priv);
1051 extern int drm_mode_getplane(struct drm_device *dev,
1052                                void *data, struct drm_file *file_priv);
1053 extern int drm_mode_setplane(struct drm_device *dev,
1054                                void *data, struct drm_file *file_priv);
1055 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1056                                 void *data, struct drm_file *file_priv);
1057 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1058                                 void *data, struct drm_file *file_priv);
1059 extern int drm_mode_addfb(struct drm_device *dev,
1060                           void *data, struct drm_file *file_priv);
1061 extern int drm_mode_addfb2(struct drm_device *dev,
1062                            void *data, struct drm_file *file_priv);
1063 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1064 extern int drm_mode_rmfb(struct drm_device *dev,
1065                          void *data, struct drm_file *file_priv);
1066 extern int drm_mode_getfb(struct drm_device *dev,
1067                           void *data, struct drm_file *file_priv);
1068 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1069                                   void *data, struct drm_file *file_priv);
1070
1071 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1072                                       void *data, struct drm_file *file_priv);
1073 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1074                                   void *data, struct drm_file *file_priv);
1075 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1076                                               void *data, struct drm_file *file_priv);
1077 extern int drm_mode_getencoder(struct drm_device *dev,
1078                                void *data, struct drm_file *file_priv);
1079 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1080                                     void *data, struct drm_file *file_priv);
1081 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1082                                     void *data, struct drm_file *file_priv);
1083 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1084 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1085 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1086 extern bool drm_detect_monitor_audio(struct edid *edid);
1087 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1088 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1089                                     void *data, struct drm_file *file_priv);
1090 extern int drm_add_modes_noedid(struct drm_connector *connector,
1091                                 int hdisplay, int vdisplay);
1092 extern void drm_set_preferred_mode(struct drm_connector *connector,
1093                                    int hpref, int vpref);
1094
1095 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1096 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1097 extern bool drm_edid_is_valid(struct edid *edid);
1098 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1099                                            int hsize, int vsize, int fresh,
1100                                            bool rb);
1101
1102 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1103                                       void *data, struct drm_file *file_priv);
1104 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1105                                     void *data, struct drm_file *file_priv);
1106 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1107                                       void *data, struct drm_file *file_priv);
1108 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1109                                              struct drm_file *file_priv);
1110 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1111                                            struct drm_file *file_priv);
1112
1113 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1114                                  int *bpp);
1115 extern int drm_format_num_planes(uint32_t format);
1116 extern int drm_format_plane_cpp(uint32_t format, int plane);
1117 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1118 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1119 extern const char *drm_get_format_name(uint32_t format);
1120
1121 /* Helpers */
1122
1123 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1124                 uint32_t id)
1125 {
1126         struct drm_mode_object *mo;
1127         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1128         return mo ? obj_to_plane(mo) : NULL;
1129 }
1130
1131 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1132         uint32_t id)
1133 {
1134         struct drm_mode_object *mo;
1135         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1136         return mo ? obj_to_crtc(mo) : NULL;
1137 }
1138
1139 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1140         uint32_t id)
1141 {
1142         struct drm_mode_object *mo;
1143         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1144         return mo ? obj_to_encoder(mo) : NULL;
1145 }
1146
1147 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1148                 uint32_t id)
1149 {
1150         struct drm_mode_object *mo;
1151         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1152         return mo ? obj_to_connector(mo) : NULL;
1153 }
1154
1155 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1156                 uint32_t id)
1157 {
1158         struct drm_mode_object *mo;
1159         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1160         return mo ? obj_to_property(mo) : NULL;
1161 }
1162
1163 static inline struct drm_property_blob *
1164 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1165 {
1166         struct drm_mode_object *mo;
1167         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1168         return mo ? obj_to_blob(mo) : NULL;
1169 }
1170
1171 /* Plane list iterator for legacy (overlay only) planes. */
1172 #define drm_for_each_legacy_plane(plane, planelist) \
1173         list_for_each_entry(plane, planelist, head) \
1174                 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1175
1176 #endif /* __DRM_CRTC_H__ */