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 <drm/drm_mode.h>
  35 #include <drm/drm_fourcc.h>
  36
  37 struct drm_device;
  38 struct drm_mode_set;
  39 struct drm_framebuffer;
  40 struct drm_object_properties;
  41 struct drm_file;
  42 struct drm_clip_rect;
  43
  44 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
  45 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
  46 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
  47 #define DRM_MODE_OBJECT_MODE 0xdededede
  48 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
  49 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
  50 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
  51 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
  52 #define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
  53 #define DRM_MODE_OBJECT_ANY 0
  54
  55 struct drm_mode_object {
  56         uint32_t id;
  57         uint32_t type;
  58         struct drm_object_properties *properties;
  59 };
  60
  61 #define DRM_OBJECT_MAX_PROPERTY 24
  62 struct drm_object_properties {
  63         int count;
  64         uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
  65         uint64_t values[DRM_OBJECT_MAX_PROPERTY];
  66 };
  67
  68 static inline int64_t U642I64(uint64_t val)
  69 {
  70         return (int64_t)*((int64_t *)&val);
  71 }
  72 static inline uint64_t I642U64(int64_t val)
  73 {
  74         return (uint64_t)*((uint64_t *)&val);
  75 }
  76
  77 enum drm_connector_force {
  78         DRM_FORCE_UNSPECIFIED,
  79         DRM_FORCE_OFF,
  80         DRM_FORCE_ON,         /* force on analog part normally */
  81         DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
  82 };
  83
  84 #include <drm/drm_modes.h>
  85
  86 enum drm_connector_status {
  87         connector_status_connected = 1,
  88         connector_status_disconnected = 2,
  89         connector_status_unknown = 3,
  90 };
  91
  92 enum subpixel_order {
  93         SubPixelUnknown = 0,
  94         SubPixelHorizontalRGB,
  95         SubPixelHorizontalBGR,
  96         SubPixelVerticalRGB,
  97         SubPixelVerticalBGR,
  98         SubPixelNone,
  99 };
 100
 101 #define DRM_COLOR_FORMAT_RGB444         (1<<0)
 102 #define DRM_COLOR_FORMAT_YCRCB444       (1<<1)
 103 #define DRM_COLOR_FORMAT_YCRCB422       (1<<2)
 104 /*
 105  * Describes a given display (e.g. CRT or flat panel) and its limitations.
 106  */
 107 struct drm_display_info {
 108         char name[DRM_DISPLAY_INFO_LEN];
 109
 110         /* Physical size */
 111         unsigned int width_mm;
 112         unsigned int height_mm;
 113
 114         /* Clock limits FIXME: storage format */
 115         unsigned int min_vfreq, max_vfreq;
 116         unsigned int min_hfreq, max_hfreq;
 117         unsigned int pixel_clock;
 118         unsigned int bpc;
 119
 120         enum subpixel_order subpixel_order;
 121         u32 color_formats;
 122
 123         u8 cea_rev;
 124 };
 125
 126 struct drm_framebuffer_funcs {
 127         /* note: use drm_framebuffer_remove() */
 128         void (*destroy)(struct drm_framebuffer *framebuffer);
 129         int (*create_handle)(struct drm_framebuffer *fb,
 130                              struct drm_file *file_priv,
 131                              unsigned int *handle);
 132         /**
 133          * Optinal callback for the dirty fb ioctl.
 134          *
 135          * Userspace can notify the driver via this callback
 136          * that a area of the framebuffer has changed and should
 137          * be flushed to the display hardware.
 138          *
 139          * See documentation in drm_mode.h for the struct
 140          * drm_mode_fb_dirty_cmd for more information as all
 141          * the semantics and arguments have a one to one mapping
 142          * on this function.
 143          */
 144         int (*dirty)(struct drm_framebuffer *framebuffer,
 145                      struct drm_file *file_priv, unsigned flags,
 146                      unsigned color, struct drm_clip_rect *clips,
 147                      unsigned num_clips);
 148 };
 149
 150 struct drm_framebuffer {
 151         struct drm_device *dev;
 152         /*
 153          * Note that the fb is refcounted for the benefit of driver internals,
 154          * for example some hw, disabling a CRTC/plane is asynchronous, and
 155          * scanout does not actually complete until the next vblank.  So some
 156          * cleanup (like releasing the reference(s) on the backing GEM bo(s))
 157          * should be deferred.  In cases like this, the driver would like to
 158          * hold a ref to the fb even though it has already been removed from
 159          * userspace perspective.
 160          */
 161         struct kref refcount;
 162         /*
 163          * Place on the dev->mode_config.fb_list, access protected by
 164          * dev->mode_config.fb_lock.
 165          */
 166         struct list_head head;
 167         struct drm_mode_object base;
 168         const struct drm_framebuffer_funcs *funcs;
 169         unsigned int pitches[4];
 170         unsigned int offsets[4];
 171         unsigned int width;
 172         unsigned int height;
 173         /* depth can be 15 or 16 */
 174         unsigned int depth;
 175         int bits_per_pixel;
 176         int flags;
 177         uint32_t pixel_format; /* fourcc format */
 178         struct list_head filp_head;
 179         /* if you are using the helper */
 180         void *helper_private;
 181 };
 182
 183 struct drm_property_blob {
 184         struct drm_mode_object base;
 185         struct list_head head;
 186         unsigned int length;
 187         unsigned char data[];
 188 };
 189
 190 struct drm_property_enum {
 191         uint64_t value;
 192         struct list_head head;
 193         char name[DRM_PROP_NAME_LEN];
 194 };
 195
 196 struct drm_property {
 197         struct list_head head;
 198         struct drm_mode_object base;
 199         uint32_t flags;
 200         char name[DRM_PROP_NAME_LEN];
 201         uint32_t num_values;
 202         uint64_t *values;
 203         struct drm_device *dev;
 204
 205         struct list_head enum_blob_list;
 206 };
 207
 208 struct drm_crtc;
 209 struct drm_connector;
 210 struct drm_encoder;
 211 struct drm_pending_vblank_event;
 212 struct drm_plane;
 213 struct drm_bridge;
 214
 215 /**
 216  * drm_crtc_funcs - control CRTCs for a given device
 217  * @save: save CRTC state
 218  * @restore: restore CRTC state
 219  * @reset: reset CRTC after state has been invalidated (e.g. resume)
 220  * @cursor_set: setup the cursor
 221  * @cursor_move: move the cursor
 222  * @gamma_set: specify color ramp for CRTC
 223  * @destroy: deinit and free object
 224  * @set_property: called when a property is changed
 225  * @set_config: apply a new CRTC configuration
 226  * @page_flip: initiate a page flip
 227  *
 228  * The drm_crtc_funcs structure is the central CRTC management structure
 229  * in the DRM.  Each CRTC controls one or more connectors (note that the name
 230  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
 231  * connectors, not just CRTs).
 232  *
 233  * Each driver is responsible for filling out this structure at startup time,
 234  * in addition to providing other modesetting features, like i2c and DDC
 235  * bus accessors.
 236  */
 237 struct drm_crtc_funcs {
 238         /* Save CRTC state */
 239         void (*save)(struct drm_crtc *crtc); /* suspend? */
 240         /* Restore CRTC state */
 241         void (*restore)(struct drm_crtc *crtc); /* resume? */
 242         /* Reset CRTC state */
 243         void (*reset)(struct drm_crtc *crtc);
 244
 245         /* cursor controls */
 246         int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
 247                           uint32_t handle, uint32_t width, uint32_t height);
 248         int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
 249                            uint32_t handle, uint32_t width, uint32_t height,
 250                            int32_t hot_x, int32_t hot_y);
 251         int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
 252
 253         /* Set gamma on the CRTC */
 254         void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
 255                           uint32_t start, uint32_t size);
 256         /* Object destroy routine */
 257         void (*destroy)(struct drm_crtc *crtc);
 258
 259         int (*set_config)(struct drm_mode_set *set);
 260
 261         /*
 262          * Flip to the given framebuffer.  This implements the page
 263          * flip ioctl described in drm_mode.h, specifically, the
 264          * implementation must return immediately and block all
 265          * rendering to the current fb until the flip has completed.
 266          * If userspace set the event flag in the ioctl, the event
 267          * argument will point to an event to send back when the flip
 268          * completes, otherwise it will be NULL.
 269          */
 270         int (*page_flip)(struct drm_crtc *crtc,
 271                          struct drm_framebuffer *fb,
 272                          struct drm_pending_vblank_event *event,
 273                          uint32_t flags);
 274
 275         int (*set_property)(struct drm_crtc *crtc,
 276                             struct drm_property *property, uint64_t val);
 277 };
 278
 279 /**
 280  * drm_crtc - central CRTC control structure
 281  * @dev: parent DRM device
 282  * @head: list management
 283  * @base: base KMS object for ID tracking etc.
 284  * @primary: primary plane for this CRTC
 285  * @cursor: cursor plane for this CRTC
 286  * @enabled: is this CRTC enabled?
 287  * @mode: current mode timings
 288  * @hwmode: mode timings as programmed to hw regs
 289  * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
 290  *    invert the width/height of the crtc.  This is used if the driver
 291  *    is performing 90 or 270 degree rotated scanout
 292  * @x: x position on screen
 293  * @y: y position on screen
 294  * @funcs: CRTC control functions
 295  * @gamma_size: size of gamma ramp
 296  * @gamma_store: gamma ramp values
 297  * @framedur_ns: precise frame timing
 298  * @framedur_ns: precise line timing
 299  * @pixeldur_ns: precise pixel timing
 300  * @helper_private: mid-layer private data
 301  * @properties: property tracking for this CRTC
 302  *
 303  * Each CRTC may have one or more connectors associated with it.  This structure
 304  * allows the CRTC to be controlled.
 305  */
 306 struct drm_crtc {
 307         struct drm_device *dev;
 308         struct list_head head;
 309
 310         /**
 311          * crtc mutex
 312          *
 313          * This provides a read lock for the overall crtc state (mode, dpms
 314          * state, ...) and a write lock for everything which can be update
 315          * without a full modeset (fb, cursor data, ...)
 316          */
 317         struct mutex mutex;
 318
 319         struct drm_mode_object base;
 320
 321         /* primary and cursor planes for CRTC */
 322         struct drm_plane *primary;
 323         struct drm_plane *cursor;
 324
 325         /* Temporary tracking of the old fb while a modeset is ongoing. Used
 326          * by drm_mode_set_config_internal to implement correct refcounting. */
 327         struct drm_framebuffer *old_fb;
 328
 329         bool enabled;
 330
 331         /* Requested mode from modesetting. */
 332         struct drm_display_mode mode;
 333
 334         /* Programmed mode in hw, after adjustments for encoders,
 335          * crtc, panel scaling etc. Needed for timestamping etc.
 336          */
 337         struct drm_display_mode hwmode;
 338
 339         bool invert_dimensions;
 340
 341         int x, y;
 342         const struct drm_crtc_funcs *funcs;
 343
 344         /* CRTC gamma size for reporting to userspace */
 345         uint32_t gamma_size;
 346         uint16_t *gamma_store;
 347
 348         /* Constants needed for precise vblank and swap timestamping. */
 349         int framedur_ns, linedur_ns, pixeldur_ns;
 350
 351         /* if you are using the helper */
 352         void *helper_private;
 353
 354         struct drm_object_properties properties;
 355 };
 356
 357
 358 /**
 359  * drm_connector_funcs - control connectors on a given device
 360  * @dpms: set power state (see drm_crtc_funcs above)
 361  * @save: save connector state
 362  * @restore: restore connector state
 363  * @reset: reset connector after state has been invalidated (e.g. resume)
 364  * @detect: is this connector active?
 365  * @fill_modes: fill mode list for this connector
 366  * @set_property: property for this connector may need an update
 367  * @destroy: make object go away
 368  * @force: notify the driver that the connector is forced on
 369  *
 370  * Each CRTC may have one or more connectors attached to it.  The functions
 371  * below allow the core DRM code to control connectors, enumerate available modes,
 372  * etc.
 373  */
 374 struct drm_connector_funcs {
 375         void (*dpms)(struct drm_connector *connector, int mode);
 376         void (*save)(struct drm_connector *connector);
 377         void (*restore)(struct drm_connector *connector);
 378         void (*reset)(struct drm_connector *connector);
 379
 380         /* Check to see if anything is attached to the connector.
 381          * @force is set to false whilst polling, true when checking the
 382          * connector due to user request. @force can be used by the driver
 383          * to avoid expensive, destructive operations during automated
 384          * probing.
 385          */
 386         enum drm_connector_status (*detect)(struct drm_connector *connector,
 387                                             bool force);
 388         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
 389         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
 390                              uint64_t val);
 391         void (*destroy)(struct drm_connector *connector);
 392         void (*force)(struct drm_connector *connector);
 393 };
 394
 395 /**
 396  * drm_encoder_funcs - encoder controls
 397  * @reset: reset state (e.g. at init or resume time)
 398  * @destroy: cleanup and free associated data
 399  *
 400  * Encoders sit between CRTCs and connectors.
 401  */
 402 struct drm_encoder_funcs {
 403         void (*reset)(struct drm_encoder *encoder);
 404         void (*destroy)(struct drm_encoder *encoder);
 405 };
 406
 407 #define DRM_CONNECTOR_MAX_ENCODER 3
 408
 409 /**
 410  * drm_encoder - central DRM encoder structure
 411  * @dev: parent DRM device
 412  * @head: list management
 413  * @base: base KMS object
 414  * @name: encoder name
 415  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
 416  * @possible_crtcs: bitmask of potential CRTC bindings
 417  * @possible_clones: bitmask of potential sibling encoders for cloning
 418  * @crtc: currently bound CRTC
 419  * @bridge: bridge associated to the encoder
 420  * @funcs: control functions
 421  * @helper_private: mid-layer private data
 422  *
 423  * CRTCs drive pixels to encoders, which convert them into signals
 424  * appropriate for a given connector or set of connectors.
 425  */
 426 struct drm_encoder {
 427         struct drm_device *dev;
 428         struct list_head head;
 429
 430         struct drm_mode_object base;
 431         char *name;
 432         int encoder_type;
 433         uint32_t possible_crtcs;
 434         uint32_t possible_clones;
 435
 436         struct drm_crtc *crtc;
 437         struct drm_bridge *bridge;
 438         const struct drm_encoder_funcs *funcs;
 439         void *helper_private;
 440 };
 441
 442 /* should we poll this connector for connects and disconnects */
 443 /* hot plug detectable */
 444 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
 445 /* poll for connections */
 446 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
 447 /* can cleanly poll for disconnections without flickering the screen */
 448 /* DACs should rarely do this without a lot of testing */
 449 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
 450
 451 #define MAX_ELD_BYTES   128
 452
 453 /**
 454  * drm_connector - central DRM connector control structure
 455  * @dev: parent DRM device
 456  * @kdev: kernel device for sysfs attributes
 457  * @attr: sysfs attributes
 458  * @head: list management
 459  * @base: base KMS object
 460  * @name: connector name
 461  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
 462  * @connector_type_id: index into connector type enum
 463  * @interlace_allowed: can this connector handle interlaced modes?
 464  * @doublescan_allowed: can this connector handle doublescan?
 465  * @modes: modes available on this connector (from fill_modes() + user)
 466  * @status: one of the drm_connector_status enums (connected, not, or unknown)
 467  * @probed_modes: list of modes derived directly from the display
 468  * @display_info: information about attached display (e.g. from EDID)
 469  * @funcs: connector control functions
 470  * @edid_blob_ptr: DRM property containing EDID if present
 471  * @properties: property tracking for this connector
 472  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
 473  * @dpms: current dpms state
 474  * @helper_private: mid-layer private data
 475  * @force: a %DRM_FORCE_<foo> state for forced mode sets
 476  * @encoder_ids: valid encoders for this connector
 477  * @encoder: encoder driving this connector, if any
 478  * @eld: EDID-like data, if present
 479  * @dvi_dual: dual link DVI, if found
 480  * @max_tmds_clock: max clock rate, if found
 481  * @latency_present: AV delay info from ELD, if found
 482  * @video_latency: video latency info from ELD, if found
 483  * @audio_latency: audio latency info from ELD, if found
 484  * @null_edid_counter: track sinks that give us all zeros for the EDID
 485  *
 486  * Each connector may be connected to one or more CRTCs, or may be clonable by
 487  * another connector if they can share a CRTC.  Each connector also has a specific
 488  * position in the broader display (referred to as a 'screen' though it could
 489  * span multiple monitors).
 490  */
 491 struct drm_connector {
 492         struct drm_device *dev;
 493         struct device *kdev;
 494         struct device_attribute *attr;
 495         struct list_head head;
 496
 497         struct drm_mode_object base;
 498
 499         char *name;
 500         int connector_type;
 501         int connector_type_id;
 502         bool interlace_allowed;
 503         bool doublescan_allowed;
 504         bool stereo_allowed;
 505         struct list_head modes; /* list of modes on this connector */
 506
 507         enum drm_connector_status status;
 508
 509         /* these are modes added by probing with DDC or the BIOS */
 510         struct list_head probed_modes;
 511
 512         struct drm_display_info display_info;
 513         const struct drm_connector_funcs *funcs;
 514
 515         struct drm_property_blob *edid_blob_ptr;
 516         struct drm_object_properties properties;
 517
 518         uint8_t polled; /* DRM_CONNECTOR_POLL_* */
 519
 520         /* requested DPMS state */
 521         int dpms;
 522
 523         void *helper_private;
 524
 525         /* forced on connector */
 526         enum drm_connector_force force;
 527         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
 528         struct drm_encoder *encoder; /* currently active encoder */
 529
 530         /* EDID bits */
 531         uint8_t eld[MAX_ELD_BYTES];
 532         bool dvi_dual;
 533         int max_tmds_clock;     /* in MHz */
 534         bool latency_present[2];
 535         int video_latency[2];   /* [0]: progressive, [1]: interlaced */
 536         int audio_latency[2];
 537         int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
 538         unsigned bad_edid_counter;
 539 };
 540
 541 /**
 542  * drm_plane_funcs - driver plane control functions
 543  * @update_plane: update the plane configuration
 544  * @disable_plane: shut down the plane
 545  * @destroy: clean up plane resources
 546  * @set_property: called when a property is changed
 547  */
 548 struct drm_plane_funcs {
 549         int (*update_plane)(struct drm_plane *plane,
 550                             struct drm_crtc *crtc, struct drm_framebuffer *fb,
 551                             int crtc_x, int crtc_y,
 552                             unsigned int crtc_w, unsigned int crtc_h,
 553                             uint32_t src_x, uint32_t src_y,
 554                             uint32_t src_w, uint32_t src_h);
 555         int (*disable_plane)(struct drm_plane *plane);
 556         void (*destroy)(struct drm_plane *plane);
 557
 558         int (*set_property)(struct drm_plane *plane,
 559                             struct drm_property *property, uint64_t val);
 560 };
 561
 562 enum drm_plane_type {
 563         DRM_PLANE_TYPE_OVERLAY,
 564         DRM_PLANE_TYPE_PRIMARY,
 565         DRM_PLANE_TYPE_CURSOR,
 566 };
 567
 568 /**
 569  * drm_plane - central DRM plane control structure
 570  * @dev: DRM device this plane belongs to
 571  * @head: for list management
 572  * @base: base mode object
 573  * @possible_crtcs: pipes this plane can be bound to
 574  * @format_types: array of formats supported by this plane
 575  * @format_count: number of formats supported
 576  * @crtc: currently bound CRTC
 577  * @fb: currently bound fb
 578  * @funcs: helper functions
 579  * @properties: property tracking for this plane
 580  * @type: type of plane (overlay, primary, cursor)
 581  */
 582 struct drm_plane {
 583         struct drm_device *dev;
 584         struct list_head head;
 585
 586         struct drm_mode_object base;
 587
 588         uint32_t possible_crtcs;
 589         uint32_t *format_types;
 590         uint32_t format_count;
 591
 592         struct drm_crtc *crtc;
 593         struct drm_framebuffer *fb;
 594
 595         const struct drm_plane_funcs *funcs;
 596
 597         struct drm_object_properties properties;
 598
 599         enum drm_plane_type type;
 600 };
 601
 602 /**
 603  * drm_bridge_funcs - drm_bridge control functions
 604  * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
 605  * @disable: Called right before encoder prepare, disables the bridge
 606  * @post_disable: Called right after encoder prepare, for lockstepped disable
 607  * @mode_set: Set this mode to the bridge
 608  * @pre_enable: Called right before encoder commit, for lockstepped commit
 609  * @enable: Called right after encoder commit, enables the bridge
 610  * @destroy: make object go away
 611  */
 612 struct drm_bridge_funcs {
 613         bool (*mode_fixup)(struct drm_bridge *bridge,
 614                            const struct drm_display_mode *mode,
 615                            struct drm_display_mode *adjusted_mode);
 616         void (*disable)(struct drm_bridge *bridge);
 617         void (*post_disable)(struct drm_bridge *bridge);
 618         void (*mode_set)(struct drm_bridge *bridge,
 619                          struct drm_display_mode *mode,
 620                          struct drm_display_mode *adjusted_mode);
 621         void (*pre_enable)(struct drm_bridge *bridge);
 622         void (*enable)(struct drm_bridge *bridge);
 623         void (*destroy)(struct drm_bridge *bridge);
 624 };
 625
 626 /**
 627  * drm_bridge - central DRM bridge control structure
 628  * @dev: DRM device this bridge belongs to
 629  * @head: list management
 630  * @base: base mode object
 631  * @funcs: control functions
 632  * @driver_private: pointer to the bridge driver's internal context
 633  */
 634 struct drm_bridge {
 635         struct drm_device *dev;
 636         struct list_head head;
 637
 638         struct drm_mode_object base;
 639
 640         const struct drm_bridge_funcs *funcs;
 641         void *driver_private;
 642 };
 643
 644 /**
 645  * drm_mode_set - new values for a CRTC config change
 646  * @head: list management
 647  * @fb: framebuffer to use for new config
 648  * @crtc: CRTC whose configuration we're about to change
 649  * @mode: mode timings to use
 650  * @x: position of this CRTC relative to @fb
 651  * @y: position of this CRTC relative to @fb
 652  * @connectors: array of connectors to drive with this CRTC if possible
 653  * @num_connectors: size of @connectors array
 654  *
 655  * Represents a single crtc the connectors that it drives with what mode
 656  * and from which framebuffer it scans out from.
 657  *
 658  * This is used to set modes.
 659  */
 660 struct drm_mode_set {
 661         struct drm_framebuffer *fb;
 662         struct drm_crtc *crtc;
 663         struct drm_display_mode *mode;
 664
 665         uint32_t x;
 666         uint32_t y;
 667
 668         struct drm_connector **connectors;
 669         size_t num_connectors;
 670 };
 671
 672 /**
 673  * struct drm_mode_config_funcs - basic driver provided mode setting functions
 674  * @fb_create: create a new framebuffer object
 675  * @output_poll_changed: function to handle output configuration changes
 676  *
 677  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
 678  * involve drivers.
 679  */
 680 struct drm_mode_config_funcs {
 681         struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
 682                                              struct drm_file *file_priv,
 683                                              struct drm_mode_fb_cmd2 *mode_cmd);
 684         void (*output_poll_changed)(struct drm_device *dev);
 685 };
 686
 687 /**
 688  * drm_mode_group - group of mode setting resources for potential sub-grouping
 689  * @num_crtcs: CRTC count
 690  * @num_encoders: encoder count
 691  * @num_connectors: connector count
 692  * @id_list: list of KMS object IDs in this group
 693  *
 694  * Currently this simply tracks the global mode setting state.  But in the
 695  * future it could allow groups of objects to be set aside into independent
 696  * control groups for use by different user level processes (e.g. two X servers
 697  * running simultaneously on different heads, each with their own mode
 698  * configuration and freedom of mode setting).
 699  */
 700 struct drm_mode_group {
 701         uint32_t num_crtcs;
 702         uint32_t num_encoders;
 703         uint32_t num_connectors;
 704         uint32_t num_bridges;
 705
 706         /* list of object IDs for this group */
 707         uint32_t *id_list;
 708 };
 709
 710 /**
 711  * drm_mode_config - Mode configuration control structure
 712  * @mutex: mutex protecting KMS related lists and structures
 713  * @idr_mutex: mutex for KMS ID allocation and management
 714  * @crtc_idr: main KMS ID tracking object
 715  * @num_fb: number of fbs available
 716  * @fb_list: list of framebuffers available
 717  * @num_connector: number of connectors on this device
 718  * @connector_list: list of connector objects
 719  * @num_bridge: number of bridges on this device
 720  * @bridge_list: list of bridge objects
 721  * @num_encoder: number of encoders on this device
 722  * @encoder_list: list of encoder objects
 723  * @num_crtc: number of CRTCs on this device
 724  * @crtc_list: list of CRTC objects
 725  * @min_width: minimum pixel width on this device
 726  * @min_height: minimum pixel height on this device
 727  * @max_width: maximum pixel width on this device
 728  * @max_height: maximum pixel height on this device
 729  * @funcs: core driver provided mode setting functions
 730  * @fb_base: base address of the framebuffer
 731  * @poll_enabled: track polling status for this device
 732  * @output_poll_work: delayed work for polling in process context
 733  * @*_property: core property tracking
 734  *
 735  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
 736  * enumerated by the driver are added here, as are global properties.  Some
 737  * global restrictions are also here, e.g. dimension restrictions.
 738  */
 739 struct drm_mode_config {
 740         struct mutex mutex; /* protects configuration (mode lists etc.) */
 741         struct mutex idr_mutex; /* for IDR management */
 742         struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
 743         /* this is limited to one for now */
 744
 745
 746         /**
 747          * fb_lock - mutex to protect fb state
 748          *
 749          * Besides the global fb list his also protects the fbs list in the
 750          * file_priv
 751          */
 752         struct mutex fb_lock;
 753         int num_fb;
 754         struct list_head fb_list;
 755
 756         int num_connector;
 757         struct list_head connector_list;
 758         int num_bridge;
 759         struct list_head bridge_list;
 760         int num_encoder;
 761         struct list_head encoder_list;
 762
 763         /*
 764          * Track # of overlay planes separately from # of total planes.  By
 765          * default we only advertise overlay planes to userspace; if userspace
 766          * sets the "universal plane" capability bit, we'll go ahead and
 767          * expose all planes.
 768          */
 769         int num_overlay_plane;
 770         int num_total_plane;
 771         struct list_head plane_list;
 772
 773         int num_crtc;
 774         struct list_head crtc_list;
 775
 776         struct list_head property_list;
 777
 778         int min_width, min_height;
 779         int max_width, max_height;
 780         const struct drm_mode_config_funcs *funcs;
 781         resource_size_t fb_base;
 782
 783         /* output poll support */
 784         bool poll_enabled;
 785         bool poll_running;
 786         struct delayed_work output_poll_work;
 787
 788         /* pointers to standard properties */
 789         struct list_head property_blob_list;
 790         struct drm_property *edid_property;
 791         struct drm_property *dpms_property;
 792         struct drm_property *plane_type_property;
 793
 794         /* DVI-I properties */
 795         struct drm_property *dvi_i_subconnector_property;
 796         struct drm_property *dvi_i_select_subconnector_property;
 797
 798         /* TV properties */
 799         struct drm_property *tv_subconnector_property;
 800         struct drm_property *tv_select_subconnector_property;
 801         struct drm_property *tv_mode_property;
 802         struct drm_property *tv_left_margin_property;
 803         struct drm_property *tv_right_margin_property;
 804         struct drm_property *tv_top_margin_property;
 805         struct drm_property *tv_bottom_margin_property;
 806         struct drm_property *tv_brightness_property;
 807         struct drm_property *tv_contrast_property;
 808         struct drm_property *tv_flicker_reduction_property;
 809         struct drm_property *tv_overscan_property;
 810         struct drm_property *tv_saturation_property;
 811         struct drm_property *tv_hue_property;
 812
 813         /* Optional properties */
 814         struct drm_property *scaling_mode_property;
 815         struct drm_property *dirty_info_property;
 816
 817         /* dumb ioctl parameters */
 818         uint32_t preferred_depth, prefer_shadow;
 819
 820         /* whether async page flip is supported or not */
 821         bool async_page_flip;
 822
 823         /* cursor size */
 824         uint32_t cursor_width, cursor_height;
 825 };
 826
 827 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
 828 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
 829 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
 830 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
 831 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
 832 #define obj_to_property(x) container_of(x, struct drm_property, base)
 833 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
 834 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
 835
 836 struct drm_prop_enum_list {
 837         int type;
 838         char *name;
 839 };
 840
 841 extern void drm_modeset_lock_all(struct drm_device *dev);
 842 extern void drm_modeset_unlock_all(struct drm_device *dev);
 843 extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
 844
 845 extern int drm_crtc_init_with_planes(struct drm_device *dev,
 846                                      struct drm_crtc *crtc,
 847                                      struct drm_plane *primary,
 848                                      void *cursor,
 849                                      const struct drm_crtc_funcs *funcs);
 850 extern int drm_crtc_init(struct drm_device *dev,
 851                          struct drm_crtc *crtc,
 852                          const struct drm_crtc_funcs *funcs);
 853 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
 854 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
 855
 856 /**
 857  * drm_crtc_mask - find the mask of a registered CRTC
 858  * @crtc: CRTC to find mask for
 859  *
 860  * Given a registered CRTC, return the mask bit of that CRTC for an
 861  * encoder's possible_crtcs field.
 862  */
 863 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
 864 {
 865         return 1 << drm_crtc_index(crtc);
 866 }
 867
 868 extern void drm_connector_ida_init(void);
 869 extern void drm_connector_ida_destroy(void);
 870 extern int drm_connector_init(struct drm_device *dev,
 871                               struct drm_connector *connector,
 872                               const struct drm_connector_funcs *funcs,
 873                               int connector_type);
 874
 875 extern void drm_connector_cleanup(struct drm_connector *connector);
 876 /* helper to unplug all connectors from sysfs for device */
 877 extern void drm_connector_unplug_all(struct drm_device *dev);
 878
 879 extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
 880                            const struct drm_bridge_funcs *funcs);
 881 extern void drm_bridge_cleanup(struct drm_bridge *bridge);
 882
 883 extern int drm_encoder_init(struct drm_device *dev,
 884                             struct drm_encoder *encoder,
 885                             const struct drm_encoder_funcs *funcs,
 886                             int encoder_type);
 887
 888 /**
 889  * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
 890  * @encoder: encoder to test
 891  * @crtc: crtc to test
 892  *
 893  * Return false if @encoder can't be driven by @crtc, true otherwise.
 894  */
 895 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
 896                                        struct drm_crtc *crtc)
 897 {
 898         return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
 899 }
 900
 901 extern int drm_universal_plane_init(struct drm_device *dev,
 902                                     struct drm_plane *plane,
 903                                     unsigned long possible_crtcs,
 904                                     const struct drm_plane_funcs *funcs,
 905                                     const uint32_t *formats,
 906                                     uint32_t format_count,
 907                                     enum drm_plane_type type);
 908 extern int drm_plane_init(struct drm_device *dev,
 909                           struct drm_plane *plane,
 910                           unsigned long possible_crtcs,
 911                           const struct drm_plane_funcs *funcs,
 912                           const uint32_t *formats, uint32_t format_count,
 913                           bool is_primary);
 914 extern void drm_plane_cleanup(struct drm_plane *plane);
 915 extern void drm_plane_force_disable(struct drm_plane *plane);
 916 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
 917                                    int x, int y,
 918                                    const struct drm_display_mode *mode,
 919                                    const struct drm_framebuffer *fb);
 920
 921 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
 922
 923 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
 924 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
 925 extern const char *drm_get_dpms_name(int val);
 926 extern const char *drm_get_dvi_i_subconnector_name(int val);
 927 extern const char *drm_get_dvi_i_select_name(int val);
 928 extern const char *drm_get_tv_subconnector_name(int val);
 929 extern const char *drm_get_tv_select_name(int val);
 930 extern void drm_fb_release(struct drm_file *file_priv);
 931 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
 932 extern void drm_mode_group_destroy(struct drm_mode_group *group);
 933 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
 934 extern struct edid *drm_get_edid(struct drm_connector *connector,
 935                                  struct i2c_adapter *adapter);
 936 extern struct edid *drm_edid_duplicate(const struct edid *edid);
 937 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
 938 extern void drm_mode_config_init(struct drm_device *dev);
 939 extern void drm_mode_config_reset(struct drm_device *dev);
 940 extern void drm_mode_config_cleanup(struct drm_device *dev);
 941
 942 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
 943                                                 struct edid *edid);
 944
 945 static inline bool drm_property_type_is(struct drm_property *property,
 946                 uint32_t type)
 947 {
 948         /* instanceof for props.. handles extended type vs original types: */
 949         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
 950                 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
 951         return property->flags & type;
 952 }
 953
 954 static inline bool drm_property_type_valid(struct drm_property *property)
 955 {
 956         if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
 957                 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
 958         return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
 959 }
 960
 961 extern int drm_object_property_set_value(struct drm_mode_object *obj,
 962                                          struct drm_property *property,
 963                                          uint64_t val);
 964 extern int drm_object_property_get_value(struct drm_mode_object *obj,
 965                                          struct drm_property *property,
 966                                          uint64_t *value);
 967 extern int drm_framebuffer_init(struct drm_device *dev,
 968                                 struct drm_framebuffer *fb,
 969                                 const struct drm_framebuffer_funcs *funcs);
 970 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
 971                                                       uint32_t id);
 972 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
 973 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
 974 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
 975 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
 976 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
 977
 978 extern void drm_object_attach_property(struct drm_mode_object *obj,
 979                                        struct drm_property *property,
 980                                        uint64_t init_val);
 981 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
 982                                                 const char *name, int num_values);
 983 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
 984                                          const char *name,
 985                                          const struct drm_prop_enum_list *props,
 986                                          int num_values);
 987 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
 988                                          int flags, const char *name,
 989                                          const struct drm_prop_enum_list *props,
 990                                          int num_values);
 991 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
 992                                          const char *name,
 993                                          uint64_t min, uint64_t max);
 994 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
 995                                          int flags, const char *name,
 996                                          int64_t min, int64_t max);
 997 struct drm_property *drm_property_create_object(struct drm_device *dev,
 998                                          int flags, const char *name, uint32_t type);
 999 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1000 extern int drm_property_add_enum(struct drm_property *property, int index,
1001                                  uint64_t value, const char *name);
1002 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1003 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1004                                      char *formats[]);
1005 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1006 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1007
1008 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1009                                              struct drm_encoder *encoder);
1010 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1011                                          int gamma_size);
1012 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1013                 uint32_t id, uint32_t type);
1014
1015 /* IOCTLs */
1016 extern int drm_mode_getresources(struct drm_device *dev,
1017                                  void *data, struct drm_file *file_priv);
1018 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1019                                    struct drm_file *file_priv);
1020 extern int drm_mode_getcrtc(struct drm_device *dev,
1021                             void *data, struct drm_file *file_priv);
1022 extern int drm_mode_getconnector(struct drm_device *dev,
1023                               void *data, struct drm_file *file_priv);
1024 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1025 extern int drm_mode_setcrtc(struct drm_device *dev,
1026                             void *data, struct drm_file *file_priv);
1027 extern int drm_mode_getplane(struct drm_device *dev,
1028                                void *data, struct drm_file *file_priv);
1029 extern int drm_mode_setplane(struct drm_device *dev,
1030                                void *data, struct drm_file *file_priv);
1031 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1032                                 void *data, struct drm_file *file_priv);
1033 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1034                                 void *data, struct drm_file *file_priv);
1035 extern int drm_mode_addfb(struct drm_device *dev,
1036                           void *data, struct drm_file *file_priv);
1037 extern int drm_mode_addfb2(struct drm_device *dev,
1038                            void *data, struct drm_file *file_priv);
1039 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1040 extern int drm_mode_rmfb(struct drm_device *dev,
1041                          void *data, struct drm_file *file_priv);
1042 extern int drm_mode_getfb(struct drm_device *dev,
1043                           void *data, struct drm_file *file_priv);
1044 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1045                                   void *data, struct drm_file *file_priv);
1046
1047 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1048                                       void *data, struct drm_file *file_priv);
1049 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1050                                   void *data, struct drm_file *file_priv);
1051 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1052                                               void *data, struct drm_file *file_priv);
1053 extern int drm_mode_getencoder(struct drm_device *dev,
1054                                void *data, struct drm_file *file_priv);
1055 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1056                                     void *data, struct drm_file *file_priv);
1057 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1058                                     void *data, struct drm_file *file_priv);
1059 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1060 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1061 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1062 extern bool drm_detect_monitor_audio(struct edid *edid);
1063 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1064 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1065                                     void *data, struct drm_file *file_priv);
1066 extern int drm_add_modes_noedid(struct drm_connector *connector,
1067                                 int hdisplay, int vdisplay);
1068 extern void drm_set_preferred_mode(struct drm_connector *connector,
1069                                    int hpref, int vpref);
1070
1071 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1072 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1073 extern bool drm_edid_is_valid(struct edid *edid);
1074 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1075                                            int hsize, int vsize, int fresh,
1076                                            bool rb);
1077
1078 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1079                                       void *data, struct drm_file *file_priv);
1080 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1081                                     void *data, struct drm_file *file_priv);
1082 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1083                                       void *data, struct drm_file *file_priv);
1084 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1085                                              struct drm_file *file_priv);
1086 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1087                                            struct drm_file *file_priv);
1088
1089 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1090                                  int *bpp);
1091 extern int drm_format_num_planes(uint32_t format);
1092 extern int drm_format_plane_cpp(uint32_t format, int plane);
1093 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1094 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1095 extern const char *drm_get_format_name(uint32_t format);
1096
1097 /* Helpers */
1098
1099 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1100                 uint32_t id)
1101 {
1102         struct drm_mode_object *mo;
1103         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1104         return mo ? obj_to_plane(mo) : NULL;
1105 }
1106
1107 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1108         uint32_t id)
1109 {
1110         struct drm_mode_object *mo;
1111         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1112         return mo ? obj_to_crtc(mo) : NULL;
1113 }
1114
1115 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1116         uint32_t id)
1117 {
1118         struct drm_mode_object *mo;
1119         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1120         return mo ? obj_to_encoder(mo) : NULL;
1121 }
1122
1123 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1124                 uint32_t id)
1125 {
1126         struct drm_mode_object *mo;
1127         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1128         return mo ? obj_to_connector(mo) : NULL;
1129 }
1130
1131 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1132                 uint32_t id)
1133 {
1134         struct drm_mode_object *mo;
1135         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1136         return mo ? obj_to_property(mo) : NULL;
1137 }
1138
1139 static inline struct drm_property_blob *
1140 drm_property_blob_find(struct drm_device *dev, uint32_t id)
1141 {
1142         struct drm_mode_object *mo;
1143         mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1144         return mo ? obj_to_blob(mo) : NULL;
1145 }
1146
1147 /* Plane list iterator for legacy (overlay only) planes. */
1148 #define drm_for_each_legacy_plane(plane, planelist) \
1149         list_for_each_entry(plane, planelist, head) \
1150                 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1151
1152 #endif /* __DRM_CRTC_H__ */