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