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