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