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