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