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