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