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