Pileus Git - ~andy/linux/blob - include/drm/drm_crtc.h

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