include/drm/drm_crtc.h

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