include/drm/drm_crtc.h

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