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