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_MAX_PROPERTY 16 476 #define DRM_CONNECTOR_LEN 32 477 #define DRM_CONNECTOR_MAX_ENCODER 3 478 479 /** 480 * drm_encoder - central DRM encoder structure 481 * @dev: parent DRM device 482 * @head: list management 483 * @base: base KMS object 484 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h 485 * @possible_crtcs: bitmask of potential CRTC bindings 486 * @possible_clones: bitmask of potential sibling encoders for cloning 487 * @crtc: currently bound CRTC 488 * @funcs: control functions 489 * @helper_private: mid-layer private data 490 * 491 * CRTCs drive pixels to encoders, which convert them into signals 492 * appropriate for a given connector or set of connectors. 493 */ 494 struct drm_encoder { 495 struct drm_device *dev; 496 struct list_head head; 497 498 struct drm_mode_object base; 499 int encoder_type; 500 uint32_t possible_crtcs; 501 uint32_t possible_clones; 502 503 struct drm_crtc *crtc; 504 const struct drm_encoder_funcs *funcs; 505 void *helper_private; 506 }; 507 508 enum drm_connector_force { 509 DRM_FORCE_UNSPECIFIED, 510 DRM_FORCE_OFF, 511 DRM_FORCE_ON, /* force on analog part normally */ 512 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ 513 }; 514 515 /* should we poll this connector for connects and disconnects */ 516 /* hot plug detectable */ 517 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 518 /* poll for connections */ 519 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 520 /* can cleanly poll for disconnections without flickering the screen */ 521 /* DACs should rarely do this without a lot of testing */ 522 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 523 524 #define MAX_ELD_BYTES 128 525 526 /** 527 * drm_connector - central DRM connector control structure 528 * @dev: parent DRM device 529 * @kdev: kernel device for sysfs attributes 530 * @attr: sysfs attributes 531 * @head: list management 532 * @base: base KMS object 533 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 534 * @connector_type_id: index into connector type enum 535 * @interlace_allowed: can this connector handle interlaced modes? 536 * @doublescan_allowed: can this connector handle doublescan? 537 * @modes: modes available on this connector (from fill_modes() + user) 538 * @status: one of the drm_connector_status enums (connected, not, or unknown) 539 * @probed_modes: list of modes derived directly from the display 540 * @display_info: information about attached display (e.g. from EDID) 541 * @funcs: connector control functions 542 * @user_modes: user added mode list 543 * @edid_blob_ptr: DRM property containing EDID if present 544 * @properties: property tracking for this connector 545 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling 546 * @dpms: current dpms state 547 * @helper_private: mid-layer private data 548 * @force: a %DRM_FORCE_<foo> state for forced mode sets 549 * @encoder_ids: valid encoders for this connector 550 * @encoder: encoder driving this connector, if any 551 * @eld: EDID-like data, if present 552 * @dvi_dual: dual link DVI, if found 553 * @max_tmds_clock: max clock rate, if found 554 * @latency_present: AV delay info from ELD, if found 555 * @video_latency: video latency info from ELD, if found 556 * @audio_latency: audio latency info from ELD, if found 557 * @null_edid_counter: track sinks that give us all zeros for the EDID 558 * 559 * Each connector may be connected to one or more CRTCs, or may be clonable by 560 * another connector if they can share a CRTC. Each connector also has a specific 561 * position in the broader display (referred to as a 'screen' though it could 562 * span multiple monitors). 563 */ 564 struct drm_connector { 565 struct drm_device *dev; 566 /* struct device kdev; XXXKIB */ 567 struct device_attribute *attr; 568 struct list_head head; 569 570 struct drm_mode_object base; 571 572 int connector_type; 573 int connector_type_id; 574 bool interlace_allowed; 575 bool doublescan_allowed; 576 struct list_head modes; /* list of modes on this connector */ 577 578 enum drm_connector_status status; 579 580 /* these are modes added by probing with DDC or the BIOS */ 581 struct list_head probed_modes; 582 583 struct drm_display_info display_info; 584 const struct drm_connector_funcs *funcs; 585 586 struct list_head user_modes; 587 struct drm_property_blob *edid_blob_ptr; 588 u32 property_ids[DRM_CONNECTOR_MAX_PROPERTY]; 589 uint64_t property_values[DRM_CONNECTOR_MAX_PROPERTY]; 590 591 uint8_t polled; /* DRM_CONNECTOR_POLL_* */ 592 593 /* requested DPMS state */ 594 int dpms; 595 596 void *helper_private; 597 598 /* forced on connector */ 599 enum drm_connector_force force; 600 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; 601 struct drm_encoder *encoder; /* currently active encoder */ 602 603 /* EDID bits */ 604 uint8_t eld[MAX_ELD_BYTES]; 605 bool dvi_dual; 606 int max_tmds_clock; /* in MHz */ 607 bool latency_present[2]; 608 int video_latency[2]; /* [0]: progressive, [1]: interlaced */ 609 int audio_latency[2]; 610 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */ 611 unsigned bad_edid_counter; 612 }; 613 614 /** 615 * drm_plane_funcs - driver plane control functions 616 * @update_plane: update the plane configuration 617 * @disable_plane: shut down the plane 618 * @destroy: clean up plane resources 619 * @set_property: called when a property is changed 620 */ 621 struct drm_plane_funcs { 622 int (*update_plane)(struct drm_plane *plane, 623 struct drm_crtc *crtc, struct drm_framebuffer *fb, 624 int crtc_x, int crtc_y, 625 unsigned int crtc_w, unsigned int crtc_h, 626 uint32_t src_x, uint32_t src_y, 627 uint32_t src_w, uint32_t src_h); 628 int (*disable_plane)(struct drm_plane *plane); 629 void (*destroy)(struct drm_plane *plane); 630 631 int (*set_property)(struct drm_plane *plane, 632 struct drm_property *property, uint64_t val); 633 }; 634 635 /** 636 * drm_plane - central DRM plane control structure 637 * @dev: DRM device this plane belongs to 638 * @head: for list management 639 * @base: base mode object 640 * @possible_crtcs: pipes this plane can be bound to 641 * @format_types: array of formats supported by this plane 642 * @format_count: number of formats supported 643 * @crtc: currently bound CRTC 644 * @fb: currently bound fb 645 * @gamma_size: size of gamma table 646 * @gamma_store: gamma correction table 647 * @enabled: enabled flag 648 * @funcs: helper functions 649 * @helper_private: storage for drver layer 650 * @properties: property tracking for this plane 651 */ 652 struct drm_plane { 653 struct drm_device *dev; 654 struct list_head head; 655 656 struct drm_mode_object base; 657 658 uint32_t possible_crtcs; 659 uint32_t *format_types; 660 uint32_t format_count; 661 662 struct drm_crtc *crtc; 663 struct drm_framebuffer *fb; 664 665 /* CRTC gamma size for reporting to userspace */ 666 uint32_t gamma_size; 667 uint16_t *gamma_store; 668 669 bool enabled; 670 671 const struct drm_plane_funcs *funcs; 672 void *helper_private; 673 674 struct drm_object_properties properties; 675 }; 676 677 /** 678 * drm_mode_set - new values for a CRTC config change 679 * @head: list management 680 * @fb: framebuffer to use for new config 681 * @crtc: CRTC whose configuration we're about to change 682 * @mode: mode timings to use 683 * @x: position of this CRTC relative to @fb 684 * @y: position of this CRTC relative to @fb 685 * @connectors: array of connectors to drive with this CRTC if possible 686 * @num_connectors: size of @connectors array 687 * 688 * Represents a single crtc the connectors that it drives with what mode 689 * and from which framebuffer it scans out from. 690 * 691 * This is used to set modes. 692 */ 693 struct drm_mode_set { 694 struct drm_framebuffer *fb; 695 struct drm_crtc *crtc; 696 struct drm_display_mode *mode; 697 698 uint32_t x; 699 uint32_t y; 700 701 struct drm_connector **connectors; 702 size_t num_connectors; 703 }; 704 705 /** 706 * struct drm_mode_config_funcs - basic driver provided mode setting functions 707 * @fb_create: create a new framebuffer object 708 * @output_poll_changed: function to handle output configuration changes 709 * 710 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that 711 * involve drivers. 712 */ 713 struct drm_mode_config_funcs { 714 int (*fb_create)(struct drm_device *dev, 715 struct drm_file *file_priv, struct drm_mode_fb_cmd2 *mode_cmd, 716 struct drm_framebuffer **res); 717 void (*output_poll_changed)(struct drm_device *dev); 718 }; 719 720 /** 721 * drm_mode_group - group of mode setting resources for potential sub-grouping 722 * @num_crtcs: CRTC count 723 * @num_encoders: encoder count 724 * @num_connectors: connector count 725 * @id_list: list of KMS object IDs in this group 726 * 727 * Currently this simply tracks the global mode setting state. But in the 728 * future it could allow groups of objects to be set aside into independent 729 * control groups for use by different user level processes (e.g. two X servers 730 * running simultaneously on different heads, each with their own mode 731 * configuration and freedom of mode setting). 732 */ 733 struct drm_mode_group { 734 uint32_t num_crtcs; 735 uint32_t num_encoders; 736 uint32_t num_connectors; 737 738 /* list of object IDs for this group */ 739 uint32_t *id_list; 740 }; 741 742 /** 743 * drm_mode_config - Mode configuration control structure 744 * @mutex: mutex protecting KMS related lists and structures 745 * @idr_mutex: mutex for KMS ID allocation and management 746 * @crtc_idr: main KMS ID tracking object 747 * @num_fb: number of fbs available 748 * @fb_list: list of framebuffers available 749 * @num_connector: number of connectors on this device 750 * @connector_list: list of connector objects 751 * @num_encoder: number of encoders on this device 752 * @encoder_list: list of encoder objects 753 * @num_crtc: number of CRTCs on this device 754 * @crtc_list: list of CRTC objects 755 * @min_width: minimum pixel width on this device 756 * @min_height: minimum pixel height on this device 757 * @max_width: maximum pixel width on this device 758 * @max_height: maximum pixel height on this device 759 * @funcs: core driver provided mode setting functions 760 * @fb_base: base address of the framebuffer 761 * @poll_enabled: track polling status for this device 762 * @output_poll_work: delayed work for polling in process context 763 * @*_property: core property tracking 764 * 765 * Core mode resource tracking structure. All CRTC, encoders, and connectors 766 * enumerated by the driver are added here, as are global properties. Some 767 * global restrictions are also here, e.g. dimension restrictions. 768 */ 769 struct drm_mode_config { 770 struct lock mutex; /* protects configuration (mode lists etc.) */ 771 struct lock idr_mutex; /* for IDR management */ 772 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */ 773 /* this is limited to one for now */ 774 int num_fb; 775 struct list_head fb_list; 776 int num_connector; 777 struct list_head connector_list; 778 int num_encoder; 779 struct list_head encoder_list; 780 int num_plane; 781 struct list_head plane_list; 782 783 int num_crtc; 784 struct list_head crtc_list; 785 786 struct list_head property_list; 787 788 int min_width, min_height; 789 int max_width, max_height; 790 const struct drm_mode_config_funcs *funcs; 791 resource_size_t fb_base; 792 793 /* output poll support */ 794 bool poll_enabled; 795 bool poll_running; 796 struct timeout_task output_poll_task; 797 798 /* pointers to standard properties */ 799 struct list_head property_blob_list; 800 struct drm_property *edid_property; 801 struct drm_property *dpms_property; 802 803 /* DVI-I properties */ 804 struct drm_property *dvi_i_subconnector_property; 805 struct drm_property *dvi_i_select_subconnector_property; 806 807 /* TV properties */ 808 struct drm_property *tv_subconnector_property; 809 struct drm_property *tv_select_subconnector_property; 810 struct drm_property *tv_mode_property; 811 struct drm_property *tv_left_margin_property; 812 struct drm_property *tv_right_margin_property; 813 struct drm_property *tv_top_margin_property; 814 struct drm_property *tv_bottom_margin_property; 815 struct drm_property *tv_brightness_property; 816 struct drm_property *tv_contrast_property; 817 struct drm_property *tv_flicker_reduction_property; 818 struct drm_property *tv_overscan_property; 819 struct drm_property *tv_saturation_property; 820 struct drm_property *tv_hue_property; 821 822 /* Optional properties */ 823 struct drm_property *scaling_mode_property; 824 struct drm_property *dithering_mode_property; 825 struct drm_property *dirty_info_property; 826 827 /* dumb ioctl parameters */ 828 uint32_t preferred_depth, prefer_shadow; 829 }; 830 831 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base) 832 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 833 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base) 834 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base) 835 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base) 836 #define obj_to_property(x) container_of(x, struct drm_property, base) 837 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base) 838 #define obj_to_plane(x) container_of(x, struct drm_plane, base) 839 840 struct drm_prop_enum_list { 841 int type; 842 char *name; 843 }; 844 845 #if defined(MODE_SETTING_LOCKING_IS_NOT_BROKEN) 846 #define DRM_MODE_CONFIG_ASSERT_LOCKED(dev) \ 847 sx_assert(&dev->mode_config.mutex, SA_XLOCKED) 848 #else 849 #define DRM_MODE_CONFIG_ASSERT_LOCKED(dev) 850 #endif 851 852 extern char *drm_get_dirty_info_name(int val); 853 extern char *drm_get_connector_status_name(enum drm_connector_status status); 854 855 extern int drm_crtc_init(struct drm_device *dev, 856 struct drm_crtc *crtc, 857 const struct drm_crtc_funcs *funcs); 858 extern void drm_crtc_cleanup(struct drm_crtc *crtc); 859 860 extern int drm_connector_init(struct drm_device *dev, 861 struct drm_connector *connector, 862 const struct drm_connector_funcs *funcs, 863 int connector_type); 864 865 extern void drm_connector_cleanup(struct drm_connector *connector); 866 /* helper to unplug all connectors from sysfs for device */ 867 extern void drm_connector_unplug_all(struct drm_device *dev); 868 869 extern int drm_encoder_init(struct drm_device *dev, 870 struct drm_encoder *encoder, 871 const struct drm_encoder_funcs *funcs, 872 int encoder_type); 873 874 extern int drm_plane_init(struct drm_device *dev, 875 struct drm_plane *plane, 876 unsigned long possible_crtcs, 877 const struct drm_plane_funcs *funcs, 878 const uint32_t *formats, uint32_t format_count, 879 bool priv); 880 extern void drm_plane_cleanup(struct drm_plane *plane); 881 882 extern void drm_encoder_cleanup(struct drm_encoder *encoder); 883 884 extern char *drm_get_connector_name(struct drm_connector *connector); 885 extern char *drm_get_dpms_name(int val); 886 extern char *drm_get_dvi_i_subconnector_name(int val); 887 extern char *drm_get_dvi_i_select_name(int val); 888 extern char *drm_get_tv_subconnector_name(int val); 889 extern char *drm_get_tv_select_name(int val); 890 extern void drm_fb_release(struct drm_file *file_priv); 891 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group); 892 extern struct edid *drm_get_edid(struct drm_connector *connector, 893 device_t adapter); 894 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid); 895 extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode); 896 extern void drm_mode_remove(struct drm_connector *connector, struct drm_display_mode *mode); 897 extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src); 898 extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev, 899 const struct drm_display_mode *mode); 900 extern void drm_mode_debug_printmodeline(const struct drm_display_mode *mode); 901 extern void drm_mode_config_init(struct drm_device *dev); 902 extern void drm_mode_config_reset(struct drm_device *dev); 903 extern void drm_mode_config_cleanup(struct drm_device *dev); 904 extern void drm_mode_set_name(struct drm_display_mode *mode); 905 extern bool drm_mode_equal(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2); 906 extern int drm_mode_width(const struct drm_display_mode *mode); 907 extern int drm_mode_height(const struct drm_display_mode *mode); 908 909 /* for us by fb module */ 910 extern int drm_mode_attachmode_crtc(struct drm_device *dev, 911 struct drm_crtc *crtc, 912 const struct drm_display_mode *mode); 913 extern int drm_mode_detachmode_crtc(struct drm_device *dev, struct drm_display_mode *mode); 914 915 extern struct drm_display_mode *drm_mode_create(struct drm_device *dev); 916 extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode); 917 extern void drm_mode_list_concat(struct list_head *head, 918 struct list_head *new); 919 extern void drm_mode_validate_size(struct drm_device *dev, 920 struct list_head *mode_list, 921 int maxX, int maxY, int maxPitch); 922 extern void drm_mode_validate_clocks(struct drm_device *dev, 923 struct list_head *mode_list, 924 int *min, int *max, int n_ranges); 925 extern void drm_mode_prune_invalid(struct drm_device *dev, 926 struct list_head *mode_list, bool verbose); 927 extern void drm_mode_sort(struct list_head *mode_list); 928 extern int drm_mode_hsync(const struct drm_display_mode *mode); 929 extern int drm_mode_vrefresh(const struct drm_display_mode *mode); 930 extern void drm_mode_set_crtcinfo(struct drm_display_mode *p, 931 int adjust_flags); 932 extern void drm_mode_connector_list_update(struct drm_connector *connector); 933 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector, 934 struct edid *edid); 935 extern int drm_connector_property_set_value(struct drm_connector *connector, 936 struct drm_property *property, 937 uint64_t value); 938 extern int drm_connector_property_get_value(struct drm_connector *connector, 939 struct drm_property *property, 940 uint64_t *value); 941 extern struct drm_display_mode *drm_crtc_mode_create(struct drm_device *dev); 942 extern void drm_framebuffer_set_object(struct drm_device *dev, 943 unsigned long handle); 944 extern int drm_framebuffer_init(struct drm_device *dev, 945 struct drm_framebuffer *fb, 946 const struct drm_framebuffer_funcs *funcs); 947 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb); 948 extern void drm_framebuffer_reference(struct drm_framebuffer *fb); 949 extern void drm_framebuffer_remove(struct drm_framebuffer *fb); 950 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb); 951 extern int drmfb_probe(struct drm_device *dev, struct drm_crtc *crtc); 952 extern int drmfb_remove(struct drm_device *dev, struct drm_framebuffer *fb); 953 extern void drm_crtc_probe_connector_modes(struct drm_device *dev, int maxX, int maxY); 954 extern bool drm_crtc_in_use(struct drm_crtc *crtc); 955 956 extern int drm_connector_attach_property(struct drm_connector *connector, 957 struct drm_property *property, uint64_t init_val); 958 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags, 959 const char *name, int num_values); 960 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags, 961 const char *name, 962 const struct drm_prop_enum_list *props, 963 int num_values); 964 struct drm_property *drm_property_create_bitmask(struct drm_device *dev, 965 int flags, const char *name, 966 const struct drm_prop_enum_list *props, 967 int num_values); 968 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags, 969 const char *name, 970 uint64_t min, uint64_t max); 971 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property); 972 extern int drm_property_add_enum(struct drm_property *property, int index, 973 uint64_t value, const char *name); 974 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev); 975 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats, 976 char *formats[]); 977 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev); 978 extern int drm_mode_create_dithering_property(struct drm_device *dev); 979 extern int drm_mode_create_dirty_info_property(struct drm_device *dev); 980 extern char *drm_get_encoder_name(struct drm_encoder *encoder); 981 982 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector, 983 struct drm_encoder *encoder); 984 extern void drm_mode_connector_detach_encoder(struct drm_connector *connector, 985 struct drm_encoder *encoder); 986 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc, 987 int gamma_size); 988 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev, 989 uint32_t id, uint32_t type); 990 /* IOCTLs */ 991 extern int drm_mode_getresources(struct drm_device *dev, 992 void *data, struct drm_file *file_priv); 993 extern int drm_mode_getplane_res(struct drm_device *dev, void *data, 994 struct drm_file *file_priv); 995 extern int drm_mode_getcrtc(struct drm_device *dev, 996 void *data, struct drm_file *file_priv); 997 extern int drm_mode_getconnector(struct drm_device *dev, 998 void *data, struct drm_file *file_priv); 999 extern int drm_mode_setcrtc(struct drm_device *dev, 1000 void *data, struct drm_file *file_priv); 1001 extern int drm_mode_getplane(struct drm_device *dev, 1002 void *data, struct drm_file *file_priv); 1003 extern int drm_mode_setplane(struct drm_device *dev, 1004 void *data, struct drm_file *file_priv); 1005 extern int drm_mode_cursor_ioctl(struct drm_device *dev, 1006 void *data, struct drm_file *file_priv); 1007 extern int drm_mode_addfb(struct drm_device *dev, 1008 void *data, struct drm_file *file_priv); 1009 extern int drm_mode_addfb2(struct drm_device *dev, 1010 void *data, struct drm_file *file_priv); 1011 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 1012 extern int drm_mode_rmfb(struct drm_device *dev, 1013 void *data, struct drm_file *file_priv); 1014 extern int drm_mode_getfb(struct drm_device *dev, 1015 void *data, struct drm_file *file_priv); 1016 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev, 1017 void *data, struct drm_file *file_priv); 1018 extern int drm_mode_addmode_ioctl(struct drm_device *dev, 1019 void *data, struct drm_file *file_priv); 1020 extern int drm_mode_rmmode_ioctl(struct drm_device *dev, 1021 void *data, struct drm_file *file_priv); 1022 extern int drm_mode_attachmode_ioctl(struct drm_device *dev, 1023 void *data, struct drm_file *file_priv); 1024 extern int drm_mode_detachmode_ioctl(struct drm_device *dev, 1025 void *data, struct drm_file *file_priv); 1026 1027 extern int drm_mode_getproperty_ioctl(struct drm_device *dev, 1028 void *data, struct drm_file *file_priv); 1029 extern int drm_mode_getblob_ioctl(struct drm_device *dev, 1030 void *data, struct drm_file *file_priv); 1031 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev, 1032 void *data, struct drm_file *file_priv); 1033 extern int drm_mode_hotplug_ioctl(struct drm_device *dev, 1034 void *data, struct drm_file *file_priv); 1035 extern int drm_mode_replacefb(struct drm_device *dev, 1036 void *data, struct drm_file *file_priv); 1037 extern int drm_mode_getencoder(struct drm_device *dev, 1038 void *data, struct drm_file *file_priv); 1039 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev, 1040 void *data, struct drm_file *file_priv); 1041 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev, 1042 void *data, struct drm_file *file_priv); 1043 extern u8 *drm_find_cea_extension(struct edid *edid); 1044 extern u8 drm_match_cea_mode(struct drm_display_mode *to_match); 1045 extern bool drm_detect_hdmi_monitor(struct edid *edid); 1046 extern bool drm_detect_monitor_audio(struct edid *edid); 1047 extern int drm_mode_page_flip_ioctl(struct drm_device *dev, 1048 void *data, struct drm_file *file_priv); 1049 extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev, 1050 int hdisplay, int vdisplay, int vrefresh, 1051 bool reduced, bool interlaced, bool margins); 1052 extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev, 1053 int hdisplay, int vdisplay, int vrefresh, 1054 bool interlaced, int margins); 1055 extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev, 1056 int hdisplay, int vdisplay, int vrefresh, 1057 bool interlaced, int margins, int GTF_M, 1058 int GTF_2C, int GTF_K, int GTF_2J); 1059 extern int drm_add_modes_noedid(struct drm_connector *connector, 1060 int hdisplay, int vdisplay); 1061 extern uint8_t drm_mode_cea_vic(const struct drm_display_mode *mode); 1062 1063 extern int drm_edid_header_is_valid(const u8 *raw_edid); 1064 extern bool drm_edid_is_valid(struct edid *edid); 1065 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev, 1066 int hsize, int vsize, int fresh); 1067 1068 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev, 1069 void *data, struct drm_file *file_priv); 1070 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev, 1071 void *data, struct drm_file *file_priv); 1072 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev, 1073 void *data, struct drm_file *file_priv); 1074 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data, 1075 struct drm_file *file_priv); 1076 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data, 1077 struct drm_file *file_priv); 1078 1079 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth, 1080 int *bpp); 1081 extern int drm_format_num_planes(uint32_t format); 1082 extern int drm_format_plane_cpp(uint32_t format, int plane); 1083 extern int drm_format_horz_chroma_subsampling(uint32_t format); 1084 extern int drm_format_vert_chroma_subsampling(uint32_t format); 1085 1086 #endif /* __DRM_CRTC_H__ */ 1087