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