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