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
  34 #include <drm/drm_fourcc.h>
  35
  36 struct drm_device;
  37 struct drm_mode_set;
  38 struct drm_framebuffer;
  39 struct drm_object_properties;
  40
  41
  42 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
  43 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
  44 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
  45 #define DRM_MODE_OBJECT_MODE 0xdededede
  46 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
  47 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
  48 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
  49 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
  50
  51 struct drm_mode_object {
  52         uint32_t id;
  53         uint32_t type;
  54         struct drm_object_properties *properties;
  55 };
  56
  57 #define DRM_OBJECT_MAX_PROPERTY 16
  58 struct drm_object_properties {
  59         int count;
  60         uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
  61         uint64_t values[DRM_OBJECT_MAX_PROPERTY];
  62 };
  63
  64 /*
  65  * Note on terminology:  here, for brevity and convenience, we refer to connector
  66  * control chips as 'CRTCs'.  They can control any type of connector, VGA, LVDS,
  67  * DVI, etc.  And 'screen' refers to the whole of the visible display, which
  68  * may span multiple monitors (and therefore multiple CRTC and connector
  69  * structures).
  70  */
  71
  72 enum drm_mode_status {
  73     MODE_OK     = 0,    /* Mode OK */
  74     MODE_HSYNC,         /* hsync out of range */
  75     MODE_VSYNC,         /* vsync out of range */
  76     MODE_H_ILLEGAL,     /* mode has illegal horizontal timings */
  77     MODE_V_ILLEGAL,     /* mode has illegal horizontal timings */
  78     MODE_BAD_WIDTH,     /* requires an unsupported linepitch */
  79     MODE_NOMODE,        /* no mode with a matching name */
  80     MODE_NO_INTERLACE,  /* interlaced mode not supported */
  81     MODE_NO_DBLESCAN,   /* doublescan mode not supported */
  82     MODE_NO_VSCAN,      /* multiscan mode not supported */
  83     MODE_MEM,           /* insufficient video memory */
  84     MODE_VIRTUAL_X,     /* mode width too large for specified virtual size */
  85     MODE_VIRTUAL_Y,     /* mode height too large for specified virtual size */
  86     MODE_MEM_VIRT,      /* insufficient video memory given virtual size */
  87     MODE_NOCLOCK,       /* no fixed clock available */
  88     MODE_CLOCK_HIGH,    /* clock required is too high */
  89     MODE_CLOCK_LOW,     /* clock required is too low */
  90     MODE_CLOCK_RANGE,   /* clock/mode isn't in a ClockRange */
  91     MODE_BAD_HVALUE,    /* horizontal timing was out of range */
  92     MODE_BAD_VVALUE,    /* vertical timing was out of range */
  93     MODE_BAD_VSCAN,     /* VScan value out of range */
  94     MODE_HSYNC_NARROW,  /* horizontal sync too narrow */
  95     MODE_HSYNC_WIDE,    /* horizontal sync too wide */
  96     MODE_HBLANK_NARROW, /* horizontal blanking too narrow */
  97     MODE_HBLANK_WIDE,   /* horizontal blanking too wide */
  98     MODE_VSYNC_NARROW,  /* vertical sync too narrow */
  99     MODE_VSYNC_WIDE,    /* vertical sync too wide */
 100     MODE_VBLANK_NARROW, /* vertical blanking too narrow */
 101     MODE_VBLANK_WIDE,   /* vertical blanking too wide */
 102     MODE_PANEL,         /* exceeds panel dimensions */
 103     MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
 104     MODE_ONE_WIDTH,     /* only one width is supported */
 105     MODE_ONE_HEIGHT,    /* only one height is supported */
 106     MODE_ONE_SIZE,      /* only one resolution is supported */
 107     MODE_NO_REDUCED,    /* monitor doesn't accept reduced blanking */
 108     MODE_UNVERIFIED = -3, /* mode needs to reverified */
 109     MODE_BAD = -2,      /* unspecified reason */
 110     MODE_ERROR  = -1    /* error condition */
 111 };
 112
 113 #define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
 114                                     DRM_MODE_TYPE_CRTC_C)
 115
 116 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
 117         .name = nm, .status = 0, .type = (t), .clock = (c), \
 118         .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
 119         .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
 120         .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
 121         .vscan = (vs), .flags = (f), .vrefresh = 0
 122
 123 #define CRTC_INTERLACE_HALVE_V 0x1 /* halve V values for interlacing */
 124
 125 struct drm_display_mode {
 126         /* Header */
 127         struct list_head head;
 128         struct drm_mode_object base;
 129
 130         char name[DRM_DISPLAY_MODE_LEN];
 131
 132         enum drm_mode_status status;
 133         unsigned int type;
 134
 135         /* Proposed mode values */
 136         int clock;              /* in kHz */
 137         int hdisplay;
 138         int hsync_start;
 139         int hsync_end;
 140         int htotal;
 141         int hskew;
 142         int vdisplay;
 143         int vsync_start;
 144         int vsync_end;
 145         int vtotal;
 146         int vscan;
 147         unsigned int flags;
 148
 149         /* Addressable image size (may be 0 for projectors, etc.) */
 150         int width_mm;
 151         int height_mm;
 152
 153         /* Actual mode we give to hw */
 154         int clock_index;
 155         int synth_clock;
 156         int crtc_hdisplay;
 157         int crtc_hblank_start;
 158         int crtc_hblank_end;
 159         int crtc_hsync_start;
 160         int crtc_hsync_end;
 161         int crtc_htotal;
 162         int crtc_hskew;
 163         int crtc_vdisplay;
 164         int crtc_vblank_start;
 165         int crtc_vblank_end;
 166         int crtc_vsync_start;
 167         int crtc_vsync_end;
 168         int crtc_vtotal;
 169         int crtc_hadjusted;
 170         int crtc_vadjusted;
 171
 172         /* Driver private mode info */
 173         int private_size;
 174         int *private;
 175         int private_flags;
 176
 177         int vrefresh;           /* in Hz */
 178         int hsync;              /* in kHz */
 179 };
 180
 181 enum drm_connector_status {
 182         connector_status_connected = 1,
 183         connector_status_disconnected = 2,
 184         connector_status_unknown = 3,
 185 };
 186
 187 enum subpixel_order {
 188         SubPixelUnknown = 0,
 189         SubPixelHorizontalRGB,
 190         SubPixelHorizontalBGR,
 191         SubPixelVerticalRGB,
 192         SubPixelVerticalBGR,
 193         SubPixelNone,
 194 };
 195
 196 #define DRM_COLOR_FORMAT_RGB444         (1<<0)
 197 #define DRM_COLOR_FORMAT_YCRCB444       (1<<1)
 198 #define DRM_COLOR_FORMAT_YCRCB422       (1<<2)
 199 /*
 200  * Describes a given display (e.g. CRT or flat panel) and its limitations.
 201  */
 202 struct drm_display_info {
 203         char name[DRM_DISPLAY_INFO_LEN];
 204
 205         /* Physical size */
 206         unsigned int width_mm;
 207         unsigned int height_mm;
 208
 209         /* Clock limits FIXME: storage format */
 210         unsigned int min_vfreq, max_vfreq;
 211         unsigned int min_hfreq, max_hfreq;
 212         unsigned int pixel_clock;
 213         unsigned int bpc;
 214
 215         enum subpixel_order subpixel_order;
 216         u32 color_formats;
 217
 218         u8 cea_rev;
 219
 220         char *raw_edid; /* if any */
 221 };
 222
 223 struct drm_framebuffer_funcs {
 224         void (*destroy)(struct drm_framebuffer *framebuffer);
 225         int (*create_handle)(struct drm_framebuffer *fb,
 226                              struct drm_file *file_priv,
 227                              unsigned int *handle);
 228         /**
 229          * Optinal callback for the dirty fb ioctl.
 230          *
 231          * Userspace can notify the driver via this callback
 232          * that a area of the framebuffer has changed and should
 233          * be flushed to the display hardware.
 234          *
 235          * See documentation in drm_mode.h for the struct
 236          * drm_mode_fb_dirty_cmd for more information as all
 237          * the semantics and arguments have a one to one mapping
 238          * on this function.
 239          */
 240         int (*dirty)(struct drm_framebuffer *framebuffer,
 241                      struct drm_file *file_priv, unsigned flags,
 242                      unsigned color, struct drm_clip_rect *clips,
 243                      unsigned num_clips);
 244 };
 245
 246 struct drm_framebuffer {
 247         struct drm_device *dev;
 248         struct list_head head;
 249         struct drm_mode_object base;
 250         const struct drm_framebuffer_funcs *funcs;
 251         unsigned int pitches[4];
 252         unsigned int offsets[4];
 253         unsigned int width;
 254         unsigned int height;
 255         /* depth can be 15 or 16 */
 256         unsigned int depth;
 257         int bits_per_pixel;
 258         int flags;
 259         uint32_t pixel_format; /* fourcc format */
 260         struct list_head filp_head;
 261         /* if you are using the helper */
 262         void *helper_private;
 263 };
 264
 265 struct drm_property_blob {
 266         struct drm_mode_object base;
 267         struct list_head head;
 268         unsigned int length;
 269         unsigned char data[];
 270 };
 271
 272 struct drm_property_enum {
 273         uint64_t value;
 274         struct list_head head;
 275         char name[DRM_PROP_NAME_LEN];
 276 };
 277
 278 struct drm_property {
 279         struct list_head head;
 280         struct drm_mode_object base;
 281         uint32_t flags;
 282         char name[DRM_PROP_NAME_LEN];
 283         uint32_t num_values;
 284         uint64_t *values;
 285
 286         struct list_head enum_blob_list;
 287 };
 288
 289 struct drm_crtc;
 290 struct drm_connector;
 291 struct drm_encoder;
 292 struct drm_pending_vblank_event;
 293 struct drm_plane;
 294
 295 /**
 296  * drm_crtc_funcs - control CRTCs for a given device
 297  * @save: save CRTC state
 298  * @restore: restore CRTC state
 299  * @reset: reset CRTC after state has been invalidate (e.g. resume)
 300  * @cursor_set: setup the cursor
 301  * @cursor_move: move the cursor
 302  * @gamma_set: specify color ramp for CRTC
 303  * @destroy: deinit and free object
 304  * @set_property: called when a property is changed
 305  * @set_config: apply a new CRTC configuration
 306  * @page_flip: initiate a page flip
 307  *
 308  * The drm_crtc_funcs structure is the central CRTC management structure
 309  * in the DRM.  Each CRTC controls one or more connectors (note that the name
 310  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
 311  * connectors, not just CRTs).
 312  *
 313  * Each driver is responsible for filling out this structure at startup time,
 314  * in addition to providing other modesetting features, like i2c and DDC
 315  * bus accessors.
 316  */
 317 struct drm_crtc_funcs {
 318         /* Save CRTC state */
 319         void (*save)(struct drm_crtc *crtc); /* suspend? */
 320         /* Restore CRTC state */
 321         void (*restore)(struct drm_crtc *crtc); /* resume? */
 322         /* Reset CRTC state */
 323         void (*reset)(struct drm_crtc *crtc);
 324
 325         /* cursor controls */
 326         int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
 327                           uint32_t handle, uint32_t width, uint32_t height);
 328         int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
 329
 330         /* Set gamma on the CRTC */
 331         void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
 332                           uint32_t start, uint32_t size);
 333         /* Object destroy routine */
 334         void (*destroy)(struct drm_crtc *crtc);
 335
 336         int (*set_config)(struct drm_mode_set *set);
 337
 338         /*
 339          * Flip to the given framebuffer.  This implements the page
 340          * flip ioctl described in drm_mode.h, specifically, the
 341          * implementation must return immediately and block all
 342          * rendering to the current fb until the flip has completed.
 343          * If userspace set the event flag in the ioctl, the event
 344          * argument will point to an event to send back when the flip
 345          * completes, otherwise it will be NULL.
 346          */
 347         int (*page_flip)(struct drm_crtc *crtc,
 348                          struct drm_framebuffer *fb,
 349                          struct drm_pending_vblank_event *event);
 350
 351         int (*set_property)(struct drm_crtc *crtc,
 352                             struct drm_property *property, uint64_t val);
 353 };
 354
 355 /**
 356  * drm_crtc - central CRTC control structure
 357  * @dev: parent DRM device
 358  * @head: list management
 359  * @base: base KMS object for ID tracking etc.
 360  * @enabled: is this CRTC enabled?
 361  * @mode: current mode timings
 362  * @hwmode: mode timings as programmed to hw regs
 363  * @x: x position on screen
 364  * @y: y position on screen
 365  * @funcs: CRTC control functions
 366  * @gamma_size: size of gamma ramp
 367  * @gamma_store: gamma ramp values
 368  * @framedur_ns: precise frame timing
 369  * @framedur_ns: precise line timing
 370  * @pixeldur_ns: precise pixel timing
 371  * @helper_private: mid-layer private data
 372  * @properties: property tracking for this CRTC
 373  *
 374  * Each CRTC may have one or more connectors associated with it.  This structure
 375  * allows the CRTC to be controlled.
 376  */
 377 struct drm_crtc {
 378         struct drm_device *dev;
 379         struct list_head head;
 380
 381         struct drm_mode_object base;
 382
 383         /* framebuffer the connector is currently bound to */
 384         struct drm_framebuffer *fb;
 385
 386         bool enabled;
 387
 388         /* Requested mode from modesetting. */
 389         struct drm_display_mode mode;
 390
 391         /* Programmed mode in hw, after adjustments for encoders,
 392          * crtc, panel scaling etc. Needed for timestamping etc.
 393          */
 394         struct drm_display_mode hwmode;
 395
 396         int x, y;
 397         const struct drm_crtc_funcs *funcs;
 398
 399         /* CRTC gamma size for reporting to userspace */
 400         uint32_t gamma_size;
 401         uint16_t *gamma_store;
 402
 403         /* Constants needed for precise vblank and swap timestamping. */
 404         s64 framedur_ns, linedur_ns, pixeldur_ns;
 405
 406         /* if you are using the helper */
 407         void *helper_private;
 408
 409         struct drm_object_properties properties;
 410 };
 411
 412
 413 /**
 414  * drm_connector_funcs - control connectors on a given device
 415  * @dpms: set power state (see drm_crtc_funcs above)
 416  * @save: save connector state
 417  * @restore: restore connector state
 418  * @reset: reset connector after state has been invalidate (e.g. resume)
 419  * @detect: is this connector active?
 420  * @fill_modes: fill mode list for this connector
 421  * @set_property: property for this connector may need update
 422  * @destroy: make object go away
 423  * @force: notify the driver the connector is forced on
 424  *
 425  * Each CRTC may have one or more connectors attached to it.  The functions
 426  * below allow the core DRM code to control connectors, enumerate available modes,
 427  * etc.
 428  */
 429 struct drm_connector_funcs {
 430         void (*dpms)(struct drm_connector *connector, int mode);
 431         void (*save)(struct drm_connector *connector);
 432         void (*restore)(struct drm_connector *connector);
 433         void (*reset)(struct drm_connector *connector);
 434
 435         /* Check to see if anything is attached to the connector.
 436          * @force is set to false whilst polling, true when checking the
 437          * connector due to user request. @force can be used by the driver
 438          * to avoid expensive, destructive operations during automated
 439          * probing.
 440          */
 441         enum drm_connector_status (*detect)(struct drm_connector *connector,
 442                                             bool force);
 443         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
 444         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
 445                              uint64_t val);
 446         void (*destroy)(struct drm_connector *connector);
 447         void (*force)(struct drm_connector *connector);
 448 };
 449
 450 /**
 451  * drm_encoder_funcs - encoder controls
 452  * @reset: reset state (e.g. at init or resume time)
 453  * @destroy: cleanup and free associated data
 454  *
 455  * Encoders sit between CRTCs and connectors.
 456  */
 457 struct drm_encoder_funcs {
 458         void (*reset)(struct drm_encoder *encoder);
 459         void (*destroy)(struct drm_encoder *encoder);
 460 };
 461
 462 #define DRM_CONNECTOR_MAX_UMODES 16
 463 #define DRM_CONNECTOR_LEN 32
 464 #define DRM_CONNECTOR_MAX_ENCODER 3
 465
 466 /**
 467  * drm_encoder - central DRM encoder structure
 468  * @dev: parent DRM device
 469  * @head: list management
 470  * @base: base KMS object
 471  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
 472  * @possible_crtcs: bitmask of potential CRTC bindings
 473  * @possible_clones: bitmask of potential sibling encoders for cloning
 474  * @crtc: currently bound CRTC
 475  * @funcs: control functions
 476  * @helper_private: mid-layer private data
 477  *
 478  * CRTCs drive pixels to encoders, which convert them into signals
 479  * appropriate for a given connector or set of connectors.
 480  */
 481 struct drm_encoder {
 482         struct drm_device *dev;
 483         struct list_head head;
 484
 485         struct drm_mode_object base;
 486         int encoder_type;
 487         uint32_t possible_crtcs;
 488         uint32_t possible_clones;
 489
 490         struct drm_crtc *crtc;
 491         const struct drm_encoder_funcs *funcs;
 492         void *helper_private;
 493 };
 494
 495 enum drm_connector_force {
 496         DRM_FORCE_UNSPECIFIED,
 497         DRM_FORCE_OFF,
 498         DRM_FORCE_ON,         /* force on analog part normally */
 499         DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
 500 };
 501
 502 /* should we poll this connector for connects and disconnects */
 503 /* hot plug detectable */
 504 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
 505 /* poll for connections */
 506 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
 507 /* can cleanly poll for disconnections without flickering the screen */
 508 /* DACs should rarely do this without a lot of testing */
 509 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
 510
 511 #define MAX_ELD_BYTES   128
 512
 513 /**
 514  * drm_connector - central DRM connector control structure
 515  * @dev: parent DRM device
 516  * @kdev: kernel device for sysfs attributes
 517  * @attr: sysfs attributes
 518  * @head: list management
 519  * @base: base KMS object
 520  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
 521  * @connector_type_id: index into connector type enum
 522  * @interlace_allowed: can this connector handle interlaced modes?
 523  * @doublescan_allowed: can this connector handle doublescan?
 524  * @modes: modes available on this connector (from fill_modes() + user)
 525  * @status: one of the drm_connector_status enums (connected, not, or unknown)
 526  * @probed_modes: list of modes derived directly from the display
 527  * @display_info: information about attached display (e.g. from EDID)
 528  * @funcs: connector control functions
 529  * @user_modes: user added mode list
 530  * @edid_blob_ptr: DRM property containing EDID if present
 531  * @properties: property tracking for this connector
 532  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
 533  * @dpms: current dpms state
 534  * @helper_private: mid-layer private data
 535  * @force: a %DRM_FORCE_<foo> state for forced mode sets
 536  * @encoder_ids: valid encoders for this connector
 537  * @encoder: encoder driving this connector, if any
 538  * @eld: EDID-like data, if present
 539  * @dvi_dual: dual link DVI, if found
 540  * @max_tmds_clock: max clock rate, if found
 541  * @latency_present: AV delay info from ELD, if found
 542  * @video_latency: video latency info from ELD, if found
 543  * @audio_latency: audio latency info from ELD, if found
 544  * @null_edid_counter: track sinks that give us all zeros for the EDID
 545  *
 546  * Each connector may be connected to one or more CRTCs, or may be clonable by
 547  * another connector if they can share a CRTC.  Each connector also has a specific
 548  * position in the broader display (referred to as a 'screen' though it could
 549  * span multiple monitors).
 550  */
 551 struct drm_connector {
 552         struct drm_device *dev;
 553         struct device kdev;
 554         struct device_attribute *attr;
 555         struct list_head head;
 556
 557         struct drm_mode_object base;
 558
 559         int connector_type;
 560         int connector_type_id;
 561         bool interlace_allowed;
 562         bool doublescan_allowed;
 563         struct list_head modes; /* list of modes on this connector */
 564
 565         enum drm_connector_status status;
 566
 567         /* these are modes added by probing with DDC or the BIOS */
 568         struct list_head probed_modes;
 569
 570         struct drm_display_info display_info;
 571         const struct drm_connector_funcs *funcs;
 572
 573         struct list_head user_modes;
 574         struct drm_property_blob *edid_blob_ptr;
 575         struct drm_object_properties properties;
 576
 577         uint8_t polled; /* DRM_CONNECTOR_POLL_* */
 578
 579         /* requested DPMS state */
 580         int dpms;
 581
 582         void *helper_private;
 583
 584         /* forced on connector */
 585         enum drm_connector_force force;
 586         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
 587         struct drm_encoder *encoder; /* currently active encoder */
 588
 589         /* EDID bits */
 590         uint8_t eld[MAX_ELD_BYTES];
 591         bool dvi_dual;
 592         int max_tmds_clock;     /* in MHz */
 593         bool latency_present[2];
 594         int video_latency[2];   /* [0]: progressive, [1]: interlaced */
 595         int audio_latency[2];
 596         int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
 597 };
 598
 599 /**
 600  * drm_plane_funcs - driver plane control functions
 601  * @update_plane: update the plane configuration
 602  * @disable_plane: shut down the plane
 603  * @destroy: clean up plane resources
 604  * @set_property: called when a property is changed
 605  */
 606 struct drm_plane_funcs {
 607         int (*update_plane)(struct drm_plane *plane,
 608                             struct drm_crtc *crtc, struct drm_framebuffer *fb,
 609                             int crtc_x, int crtc_y,
 610                             unsigned int crtc_w, unsigned int crtc_h,
 611                             uint32_t src_x, uint32_t src_y,
 612                             uint32_t src_w, uint32_t src_h);
 613         int (*disable_plane)(struct drm_plane *plane);
 614         void (*destroy)(struct drm_plane *plane);
 615
 616         int (*set_property)(struct drm_plane *plane,
 617                             struct drm_property *property, uint64_t val);
 618 };
 619
 620 /**
 621  * drm_plane - central DRM plane control structure
 622  * @dev: DRM device this plane belongs to
 623  * @head: for list management
 624  * @base: base mode object
 625  * @possible_crtcs: pipes this plane can be bound to
 626  * @format_types: array of formats supported by this plane
 627  * @format_count: number of formats supported
 628  * @crtc: currently bound CRTC
 629  * @fb: currently bound fb
 630  * @gamma_size: size of gamma table
 631  * @gamma_store: gamma correction table
 632  * @enabled: enabled flag
 633  * @funcs: helper functions
 634  * @helper_private: storage for drver layer
 635  * @properties: property tracking for this plane
 636  */
 637 struct drm_plane {
 638         struct drm_device *dev;
 639         struct list_head head;
 640
 641         struct drm_mode_object base;
 642
 643         uint32_t possible_crtcs;
 644         uint32_t *format_types;
 645         uint32_t format_count;
 646
 647         struct drm_crtc *crtc;
 648         struct drm_framebuffer *fb;
 649
 650         /* CRTC gamma size for reporting to userspace */
 651         uint32_t gamma_size;
 652         uint16_t *gamma_store;
 653
 654         bool enabled;
 655
 656         const struct drm_plane_funcs *funcs;
 657         void *helper_private;
 658
 659         struct drm_object_properties properties;
 660 };
 661
 662 /**
 663  * drm_mode_set - new values for a CRTC config change
 664  * @head: list management
 665  * @fb: framebuffer to use for new config
 666  * @crtc: CRTC whose configuration we're about to change
 667  * @mode: mode timings to use
 668  * @x: position of this CRTC relative to @fb
 669  * @y: position of this CRTC relative to @fb
 670  * @connectors: array of connectors to drive with this CRTC if possible
 671  * @num_connectors: size of @connectors array
 672  *
 673  * Represents a single crtc the connectors that it drives with what mode
 674  * and from which framebuffer it scans out from.
 675  *
 676  * This is used to set modes.
 677  */
 678 struct drm_mode_set {
 679         struct list_head head;
 680
 681         struct drm_framebuffer *fb;
 682         struct drm_crtc *crtc;
 683         struct drm_display_mode *mode;
 684
 685         uint32_t x;
 686         uint32_t y;
 687
 688         struct drm_connector **connectors;
 689         size_t num_connectors;
 690 };
 691
 692 /**
 693  * struct drm_mode_config_funcs - basic driver provided mode setting functions
 694  * @fb_create: create a new framebuffer object
 695  * @output_poll_changed: function to handle output configuration changes
 696  *
 697  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
 698  * involve drivers.
 699  */
 700 struct drm_mode_config_funcs {
 701         struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
 702                                              struct drm_file *file_priv,
 703                                              struct drm_mode_fb_cmd2 *mode_cmd);
 704         void (*output_poll_changed)(struct drm_device *dev);
 705 };
 706
 707 /**
 708  * drm_mode_group - group of mode setting resources for potential sub-grouping
 709  * @num_crtcs: CRTC count
 710  * @num_encoders: encoder count
 711  * @num_connectors: connector count
 712  * @id_list: list of KMS object IDs in this group
 713  *
 714  * Currently this simply tracks the global mode setting state.  But in the
 715  * future it could allow groups of objects to be set aside into independent
 716  * control groups for use by different user level processes (e.g. two X servers
 717  * running simultaneously on different heads, each with their own mode
 718  * configuration and freedom of mode setting).
 719  */
 720 struct drm_mode_group {
 721         uint32_t num_crtcs;
 722         uint32_t num_encoders;
 723         uint32_t num_connectors;
 724
 725         /* list of object IDs for this group */
 726         uint32_t *id_list;
 727 };
 728
 729 /**
 730  * drm_mode_config - Mode configuration control structure
 731  * @mutex: mutex protecting KMS related lists and structures
 732  * @idr_mutex: mutex for KMS ID allocation and management
 733  * @crtc_idr: main KMS ID tracking object
 734  * @num_fb: number of fbs available
 735  * @fb_list: list of framebuffers available
 736  * @num_connector: number of connectors on this device
 737  * @connector_list: list of connector objects
 738  * @num_encoder: number of encoders on this device
 739  * @encoder_list: list of encoder objects
 740  * @num_crtc: number of CRTCs on this device
 741  * @crtc_list: list of CRTC objects
 742  * @min_width: minimum pixel width on this device
 743  * @min_height: minimum pixel height on this device
 744  * @max_width: maximum pixel width on this device
 745  * @max_height: maximum pixel height on this device
 746  * @funcs: core driver provided mode setting functions
 747  * @fb_base: base address of the framebuffer
 748  * @poll_enabled: track polling status for this device
 749  * @output_poll_work: delayed work for polling in process context
 750  * @*_property: core property tracking
 751  *
 752  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
 753  * enumerated by the driver are added here, as are global properties.  Some
 754  * global restrictions are also here, e.g. dimension restrictions.
 755  */
 756 struct drm_mode_config {
 757         struct mutex mutex; /* protects configuration (mode lists etc.) */
 758         struct mutex idr_mutex; /* for IDR management */
 759         struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
 760         /* this is limited to one for now */
 761         int num_fb;
 762         struct list_head fb_list;
 763         int num_connector;
 764         struct list_head connector_list;
 765         int num_encoder;
 766         struct list_head encoder_list;
 767         int num_plane;
 768         struct list_head plane_list;
 769
 770         int num_crtc;
 771         struct list_head crtc_list;
 772
 773         struct list_head property_list;
 774
 775         int min_width, min_height;
 776         int max_width, max_height;
 777         const struct drm_mode_config_funcs *funcs;
 778         resource_size_t fb_base;
 779
 780         /* output poll support */
 781         bool poll_enabled;
 782         struct delayed_work output_poll_work;
 783
 784         /* pointers to standard properties */
 785         struct list_head property_blob_list;
 786         struct drm_property *edid_property;
 787         struct drm_property *dpms_property;
 788
 789         /* DVI-I properties */
 790         struct drm_property *dvi_i_subconnector_property;
 791         struct drm_property *dvi_i_select_subconnector_property;
 792
 793         /* TV properties */
 794         struct drm_property *tv_subconnector_property;
 795         struct drm_property *tv_select_subconnector_property;
 796         struct drm_property *tv_mode_property;
 797         struct drm_property *tv_left_margin_property;
 798         struct drm_property *tv_right_margin_property;
 799         struct drm_property *tv_top_margin_property;
 800         struct drm_property *tv_bottom_margin_property;
 801         struct drm_property *tv_brightness_property;
 802         struct drm_property *tv_contrast_property;
 803         struct drm_property *tv_flicker_reduction_property;
 804         struct drm_property *tv_overscan_property;
 805         struct drm_property *tv_saturation_property;
 806         struct drm_property *tv_hue_property;
 807
 808         /* Optional properties */
 809         struct drm_property *scaling_mode_property;
 810         struct drm_property *dithering_mode_property;
 811         struct drm_property *dirty_info_property;
 812
 813         /* dumb ioctl parameters */
 814         uint32_t preferred_depth, prefer_shadow;
 815 };
 816
 817 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
 818 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
 819 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
 820 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
 821 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
 822 #define obj_to_property(x) container_of(x, struct drm_property, base)
 823 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
 824 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
 825
 826 struct drm_prop_enum_list {
 827         int type;
 828         char *name;
 829 };
 830
 831 extern int drm_crtc_init(struct drm_device *dev,
 832                          struct drm_crtc *crtc,
 833                          const struct drm_crtc_funcs *funcs);
 834 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
 835
 836 extern int drm_connector_init(struct drm_device *dev,
 837                               struct drm_connector *connector,
 838                               const struct drm_connector_funcs *funcs,
 839                               int connector_type);
 840
 841 extern void drm_connector_cleanup(struct drm_connector *connector);
 842 /* helper to unplug all connectors from sysfs for device */
 843 extern void drm_connector_unplug_all(struct drm_device *dev);
 844
 845 extern int drm_encoder_init(struct drm_device *dev,
 846                             struct drm_encoder *encoder,
 847                             const struct drm_encoder_funcs *funcs,
 848                             int encoder_type);
 849
 850 extern int drm_plane_init(struct drm_device *dev,
 851                           struct drm_plane *plane,
 852                           unsigned long possible_crtcs,
 853                           const struct drm_plane_funcs *funcs,
 854                           const uint32_t *formats, uint32_t format_count,
 855                           bool priv);
 856 extern void drm_plane_cleanup(struct drm_plane *plane);
 857
 858 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
 859
 860 extern char *drm_get_connector_name(struct drm_connector *connector);
 861 extern char *drm_get_dpms_name(int val);
 862 extern char *drm_get_dvi_i_subconnector_name(int val);
 863 extern char *drm_get_dvi_i_select_name(int val);
 864 extern char *drm_get_tv_subconnector_name(int val);
 865 extern char *drm_get_tv_select_name(int val);
 866 extern void drm_fb_release(struct drm_file *file_priv);
 867 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
 868 extern struct edid *drm_get_edid(struct drm_connector *connector,
 869                                  struct i2c_adapter *adapter);
 870 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
 871 extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
 872 extern void drm_mode_remove(struct drm_connector *connector, struct drm_display_mode *mode);
 873 extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src);
 874 extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
 875                                                    const struct drm_display_mode *mode);
 876 extern void drm_mode_debug_printmodeline(struct drm_display_mode *mode);
 877 extern void drm_mode_config_init(struct drm_device *dev);
 878 extern void drm_mode_config_reset(struct drm_device *dev);
 879 extern void drm_mode_config_cleanup(struct drm_device *dev);
 880 extern void drm_mode_set_name(struct drm_display_mode *mode);
 881 extern bool drm_mode_equal(struct drm_display_mode *mode1, struct drm_display_mode *mode2);
 882 extern int drm_mode_width(struct drm_display_mode *mode);
 883 extern int drm_mode_height(struct drm_display_mode *mode);
 884
 885 /* for us by fb module */
 886 extern int drm_mode_attachmode_crtc(struct drm_device *dev,
 887                                     struct drm_crtc *crtc,
 888                                     const struct drm_display_mode *mode);
 889 extern int drm_mode_detachmode_crtc(struct drm_device *dev, struct drm_display_mode *mode);
 890
 891 extern struct drm_display_mode *drm_mode_create(struct drm_device *dev);
 892 extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
 893 extern void drm_mode_list_concat(struct list_head *head,
 894                                  struct list_head *new);
 895 extern void drm_mode_validate_size(struct drm_device *dev,
 896                                    struct list_head *mode_list,
 897                                    int maxX, int maxY, int maxPitch);
 898 extern void drm_mode_prune_invalid(struct drm_device *dev,
 899                                    struct list_head *mode_list, bool verbose);
 900 extern void drm_mode_sort(struct list_head *mode_list);
 901 extern int drm_mode_hsync(const struct drm_display_mode *mode);
 902 extern int drm_mode_vrefresh(const struct drm_display_mode *mode);
 903 extern void drm_mode_set_crtcinfo(struct drm_display_mode *p,
 904                                   int adjust_flags);
 905 extern void drm_mode_connector_list_update(struct drm_connector *connector);
 906 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
 907                                                 struct edid *edid);
 908 extern int drm_connector_property_set_value(struct drm_connector *connector,
 909                                          struct drm_property *property,
 910                                          uint64_t value);
 911 extern int drm_connector_property_get_value(struct drm_connector *connector,
 912                                          struct drm_property *property,
 913                                          uint64_t *value);
 914 extern int drm_object_property_set_value(struct drm_mode_object *obj,
 915                                          struct drm_property *property,
 916                                          uint64_t val);
 917 extern int drm_object_property_get_value(struct drm_mode_object *obj,
 918                                          struct drm_property *property,
 919                                          uint64_t *value);
 920 extern struct drm_display_mode *drm_crtc_mode_create(struct drm_device *dev);
 921 extern void drm_framebuffer_set_object(struct drm_device *dev,
 922                                        unsigned long handle);
 923 extern int drm_framebuffer_init(struct drm_device *dev,
 924                                 struct drm_framebuffer *fb,
 925                                 const struct drm_framebuffer_funcs *funcs);
 926 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
 927 extern int drmfb_probe(struct drm_device *dev, struct drm_crtc *crtc);
 928 extern int drmfb_remove(struct drm_device *dev, struct drm_framebuffer *fb);
 929 extern void drm_crtc_probe_connector_modes(struct drm_device *dev, int maxX, int maxY);
 930 extern bool drm_crtc_in_use(struct drm_crtc *crtc);
 931
 932 extern void drm_connector_attach_property(struct drm_connector *connector,
 933                                           struct drm_property *property, uint64_t init_val);
 934 extern void drm_object_attach_property(struct drm_mode_object *obj,
 935                                        struct drm_property *property,
 936                                        uint64_t init_val);
 937 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
 938                                                 const char *name, int num_values);
 939 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
 940                                          const char *name,
 941                                          const struct drm_prop_enum_list *props,
 942                                          int num_values);
 943 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
 944                                          int flags, const char *name,
 945                                          const struct drm_prop_enum_list *props,
 946                                          int num_values);
 947 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
 948                                          const char *name,
 949                                          uint64_t min, uint64_t max);
 950 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
 951 extern int drm_property_add_enum(struct drm_property *property, int index,
 952                                  uint64_t value, const char *name);
 953 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
 954 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
 955                                      char *formats[]);
 956 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
 957 extern int drm_mode_create_dithering_property(struct drm_device *dev);
 958 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
 959 extern char *drm_get_encoder_name(struct drm_encoder *encoder);
 960
 961 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
 962                                              struct drm_encoder *encoder);
 963 extern void drm_mode_connector_detach_encoder(struct drm_connector *connector,
 964                                            struct drm_encoder *encoder);
 965 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
 966                                          int gamma_size);
 967 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
 968                 uint32_t id, uint32_t type);
 969 /* IOCTLs */
 970 extern int drm_mode_getresources(struct drm_device *dev,
 971                                  void *data, struct drm_file *file_priv);
 972 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
 973                                    struct drm_file *file_priv);
 974 extern int drm_mode_getcrtc(struct drm_device *dev,
 975                             void *data, struct drm_file *file_priv);
 976 extern int drm_mode_getconnector(struct drm_device *dev,
 977                               void *data, struct drm_file *file_priv);
 978 extern int drm_mode_setcrtc(struct drm_device *dev,
 979                             void *data, struct drm_file *file_priv);
 980 extern int drm_mode_getplane(struct drm_device *dev,
 981                                void *data, struct drm_file *file_priv);
 982 extern int drm_mode_setplane(struct drm_device *dev,
 983                                void *data, struct drm_file *file_priv);
 984 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
 985                                 void *data, struct drm_file *file_priv);
 986 extern int drm_mode_addfb(struct drm_device *dev,
 987                           void *data, struct drm_file *file_priv);
 988 extern int drm_mode_addfb2(struct drm_device *dev,
 989                            void *data, struct drm_file *file_priv);
 990 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
 991 extern int drm_mode_rmfb(struct drm_device *dev,
 992                          void *data, struct drm_file *file_priv);
 993 extern int drm_mode_getfb(struct drm_device *dev,
 994                           void *data, struct drm_file *file_priv);
 995 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
 996                                   void *data, struct drm_file *file_priv);
 997 extern int drm_mode_addmode_ioctl(struct drm_device *dev,
 998                                   void *data, struct drm_file *file_priv);
 999 extern int drm_mode_rmmode_ioctl(struct drm_device *dev,
1000                                  void *data, struct drm_file *file_priv);
1001 extern int drm_mode_attachmode_ioctl(struct drm_device *dev,
1002                                      void *data, struct drm_file *file_priv);
1003 extern int drm_mode_detachmode_ioctl(struct drm_device *dev,
1004                                      void *data, struct drm_file *file_priv);
1005
1006 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1007                                       void *data, struct drm_file *file_priv);
1008 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1009                                   void *data, struct drm_file *file_priv);
1010 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1011                                               void *data, struct drm_file *file_priv);
1012 extern int drm_mode_hotplug_ioctl(struct drm_device *dev,
1013                                   void *data, struct drm_file *file_priv);
1014 extern int drm_mode_replacefb(struct drm_device *dev,
1015                               void *data, struct drm_file *file_priv);
1016 extern int drm_mode_getencoder(struct drm_device *dev,
1017                                void *data, struct drm_file *file_priv);
1018 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1019                                     void *data, struct drm_file *file_priv);
1020 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1021                                     void *data, struct drm_file *file_priv);
1022 extern u8 *drm_find_cea_extension(struct edid *edid);
1023 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1024 extern bool drm_detect_monitor_audio(struct edid *edid);
1025 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1026                                     void *data, struct drm_file *file_priv);
1027 extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
1028                                 int hdisplay, int vdisplay, int vrefresh,
1029                                 bool reduced, bool interlaced, bool margins);
1030 extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
1031                                 int hdisplay, int vdisplay, int vrefresh,
1032                                 bool interlaced, int margins);
1033 extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
1034                                 int hdisplay, int vdisplay, int vrefresh,
1035                                 bool interlaced, int margins, int GTF_M,
1036                                 int GTF_2C, int GTF_K, int GTF_2J);
1037 extern int drm_add_modes_noedid(struct drm_connector *connector,
1038                                 int hdisplay, int vdisplay);
1039
1040 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1041 extern bool drm_edid_block_valid(u8 *raw_edid, int block);
1042 extern bool drm_edid_is_valid(struct edid *edid);
1043 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1044                                            int hsize, int vsize, int fresh,
1045                                            bool rb);
1046
1047 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1048                                       void *data, struct drm_file *file_priv);
1049 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1050                                     void *data, struct drm_file *file_priv);
1051 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1052                                       void *data, struct drm_file *file_priv);
1053 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1054                                              struct drm_file *file_priv);
1055 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1056                                            struct drm_file *file_priv);
1057
1058 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1059                                  int *bpp);
1060 extern int drm_format_num_planes(uint32_t format);
1061 extern int drm_format_plane_cpp(uint32_t format, int plane);
1062 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1063 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1064
1065 #endif /* __DRM_CRTC_H__ */