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