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