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