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