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