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