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