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