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