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