1 /* 2 * Copyright © 2006 Keith Packard 3 * Copyright © 2007-2008 Dave Airlie 4 * Copyright © 2007-2008 Intel Corporation 5 * Jesse Barnes <jesse.barnes@intel.com> 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a 8 * copy of this software and associated documentation files (the "Software"), 9 * to deal in the Software without restriction, including without limitation 10 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 11 * and/or sell copies of the Software, and to permit persons to whom the 12 * Software is furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in 15 * all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 23 * OTHER DEALINGS IN THE SOFTWARE. 24 */ 25 #ifndef __DRM_CRTC_H__ 26 #define __DRM_CRTC_H__ 27 28 #include <linux/i2c.h> 29 #include <linux/spinlock.h> 30 #include <linux/types.h> 31 #include <linux/fb.h> 32 #include <linux/hdmi.h> 33 #include <linux/media-bus-format.h> 34 #include <uapi/drm/drm_mode.h> 35 #include <uapi/drm/drm_fourcc.h> 36 #include <drm/drm_modeset_lock.h> 37 #include <drm/drm_rect.h> 38 #include <drm/drm_mode_object.h> 39 #include <drm/drm_framebuffer.h> 40 #include <drm/drm_modes.h> 41 #include <drm/drm_connector.h> 42 #include <drm/drm_property.h> 43 #include <drm/drm_bridge.h> 44 #include <drm/drm_edid.h> 45 #include <drm/drm_plane.h> 46 #include <drm/drm_blend.h> 47 #include <drm/drm_color_mgmt.h> 48 #include <drm/drm_debugfs_crc.h> 49 #include <drm/drm_mode_config.h> 50 51 struct drm_device; 52 struct drm_mode_set; 53 struct drm_file; 54 struct drm_clip_rect; 55 struct drm_printer; 56 struct device_node; 57 struct dma_fence; 58 struct edid; 59 60 static inline int64_t U642I64(uint64_t val) 61 { 62 return (int64_t)*((int64_t *)&val); 63 } 64 static inline uint64_t I642U64(int64_t val) 65 { 66 return (uint64_t)*((uint64_t *)&val); 67 } 68 69 struct drm_crtc; 70 struct drm_pending_vblank_event; 71 struct drm_plane; 72 struct drm_bridge; 73 struct drm_atomic_state; 74 75 struct drm_crtc_helper_funcs; 76 struct drm_plane_helper_funcs; 77 78 /** 79 * struct drm_crtc_state - mutable CRTC state 80 * @crtc: backpointer to the CRTC 81 * @enable: whether the CRTC should be enabled, gates all other state 82 * @active: whether the CRTC is actively displaying (used for DPMS) 83 * @planes_changed: planes on this crtc are updated 84 * @mode_changed: @mode or @enable has been changed 85 * @active_changed: @active has been toggled. 86 * @connectors_changed: connectors to this crtc have been updated 87 * @zpos_changed: zpos values of planes on this crtc have been updated 88 * @color_mgmt_changed: color management properties have changed (degamma or 89 * gamma LUT or CSC matrix) 90 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes 91 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors 92 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders 93 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings 94 * @mode: current mode timings 95 * @mode_blob: &drm_property_blob for @mode 96 * @degamma_lut: Lookup table for converting framebuffer pixel data 97 * before apply the conversion matrix 98 * @ctm: Transformation matrix 99 * @gamma_lut: Lookup table for converting pixel data after the 100 * conversion matrix 101 * @state: backpointer to global drm_atomic_state 102 * 103 * Note that the distinction between @enable and @active is rather subtile: 104 * Flipping @active while @enable is set without changing anything else may 105 * never return in a failure from the &drm_mode_config_funcs.atomic_check 106 * callback. Userspace assumes that a DPMS On will always succeed. In other 107 * words: @enable controls resource assignment, @active controls the actual 108 * hardware state. 109 * 110 * The three booleans active_changed, connectors_changed and mode_changed are 111 * intended to indicate whether a full modeset is needed, rather than strictly 112 * describing what has changed in a commit. 113 * See also: drm_atomic_crtc_needs_modeset() 114 */ 115 struct drm_crtc_state { 116 struct drm_crtc *crtc; 117 118 bool enable; 119 bool active; 120 121 /* computed state bits used by helpers and drivers */ 122 bool planes_changed : 1; 123 bool mode_changed : 1; 124 bool active_changed : 1; 125 bool connectors_changed : 1; 126 bool zpos_changed : 1; 127 bool color_mgmt_changed : 1; 128 129 /* attached planes bitmask: 130 * WARNING: transitional helpers do not maintain plane_mask so 131 * drivers not converted over to atomic helpers should not rely 132 * on plane_mask being accurate! 133 */ 134 u32 plane_mask; 135 136 u32 connector_mask; 137 u32 encoder_mask; 138 139 /* adjusted_mode: for use by helpers and drivers */ 140 struct drm_display_mode adjusted_mode; 141 142 struct drm_display_mode mode; 143 144 /* blob property to expose current mode to atomic userspace */ 145 struct drm_property_blob *mode_blob; 146 147 /* blob property to expose color management to userspace */ 148 struct drm_property_blob *degamma_lut; 149 struct drm_property_blob *ctm; 150 struct drm_property_blob *gamma_lut; 151 152 /** 153 * @target_vblank: 154 * 155 * Target vertical blank period when a page flip 156 * should take effect. 157 */ 158 u32 target_vblank; 159 160 /** 161 * @pageflip_flags: 162 * 163 * DRM_MODE_PAGE_FLIP_* flags, as passed to the page flip ioctl. 164 * Zero in any other case. 165 */ 166 u32 pageflip_flags; 167 168 /** 169 * @event: 170 * 171 * Optional pointer to a DRM event to signal upon completion of the 172 * state update. The driver must send out the event when the atomic 173 * commit operation completes. There are two cases: 174 * 175 * - The event is for a CRTC which is being disabled through this 176 * atomic commit. In that case the event can be send out any time 177 * after the hardware has stopped scanning out the current 178 * framebuffers. It should contain the timestamp and counter for the 179 * last vblank before the display pipeline was shut off. 180 * 181 * - For a CRTC which is enabled at the end of the commit (even when it 182 * undergoes an full modeset) the vblank timestamp and counter must 183 * be for the vblank right before the first frame that scans out the 184 * new set of buffers. Again the event can only be sent out after the 185 * hardware has stopped scanning out the old buffers. 186 * 187 * - Events for disabled CRTCs are not allowed, and drivers can ignore 188 * that case. 189 * 190 * This can be handled by the drm_crtc_send_vblank_event() function, 191 * which the driver should call on the provided event upon completion of 192 * the atomic commit. Note that if the driver supports vblank signalling 193 * and timestamping the vblank counters and timestamps must agree with 194 * the ones returned from page flip events. With the current vblank 195 * helper infrastructure this can be achieved by holding a vblank 196 * reference while the page flip is pending, acquired through 197 * drm_crtc_vblank_get() and released with drm_crtc_vblank_put(). 198 * Drivers are free to implement their own vblank counter and timestamp 199 * tracking though, e.g. if they have accurate timestamp registers in 200 * hardware. 201 * 202 * For hardware which supports some means to synchronize vblank 203 * interrupt delivery with committing display state there's also 204 * drm_crtc_arm_vblank_event(). See the documentation of that function 205 * for a detailed discussion of the constraints it needs to be used 206 * safely. 207 * 208 * If the device can't notify of flip completion in a race-free way 209 * at all, then the event should be armed just after the page flip is 210 * committed. In the worst case the driver will send the event to 211 * userspace one frame too late. This doesn't allow for a real atomic 212 * update, but it should avoid tearing. 213 */ 214 struct drm_pending_vblank_event *event; 215 216 struct drm_atomic_state *state; 217 }; 218 219 /** 220 * struct drm_crtc_funcs - control CRTCs for a given device 221 * 222 * The drm_crtc_funcs structure is the central CRTC management structure 223 * in the DRM. Each CRTC controls one or more connectors (note that the name 224 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc. 225 * connectors, not just CRTs). 226 * 227 * Each driver is responsible for filling out this structure at startup time, 228 * in addition to providing other modesetting features, like i2c and DDC 229 * bus accessors. 230 */ 231 struct drm_crtc_funcs { 232 /** 233 * @reset: 234 * 235 * Reset CRTC hardware and software state to off. This function isn't 236 * called by the core directly, only through drm_mode_config_reset(). 237 * It's not a helper hook only for historical reasons. 238 * 239 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset 240 * atomic state using this hook. 241 */ 242 void (*reset)(struct drm_crtc *crtc); 243 244 /** 245 * @cursor_set: 246 * 247 * Update the cursor image. The cursor position is relative to the CRTC 248 * and can be partially or fully outside of the visible area. 249 * 250 * Note that contrary to all other KMS functions the legacy cursor entry 251 * points don't take a framebuffer object, but instead take directly a 252 * raw buffer object id from the driver's buffer manager (which is 253 * either GEM or TTM for current drivers). 254 * 255 * This entry point is deprecated, drivers should instead implement 256 * universal plane support and register a proper cursor plane using 257 * drm_crtc_init_with_planes(). 258 * 259 * This callback is optional 260 * 261 * RETURNS: 262 * 263 * 0 on success or a negative error code on failure. 264 */ 265 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv, 266 uint32_t handle, uint32_t width, uint32_t height); 267 268 /** 269 * @cursor_set2: 270 * 271 * Update the cursor image, including hotspot information. The hotspot 272 * must not affect the cursor position in CRTC coordinates, but is only 273 * meant as a hint for virtualized display hardware to coordinate the 274 * guests and hosts cursor position. The cursor hotspot is relative to 275 * the cursor image. Otherwise this works exactly like @cursor_set. 276 * 277 * This entry point is deprecated, drivers should instead implement 278 * universal plane support and register a proper cursor plane using 279 * drm_crtc_init_with_planes(). 280 * 281 * This callback is optional. 282 * 283 * RETURNS: 284 * 285 * 0 on success or a negative error code on failure. 286 */ 287 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv, 288 uint32_t handle, uint32_t width, uint32_t height, 289 int32_t hot_x, int32_t hot_y); 290 291 /** 292 * @cursor_move: 293 * 294 * Update the cursor position. The cursor does not need to be visible 295 * when this hook is called. 296 * 297 * This entry point is deprecated, drivers should instead implement 298 * universal plane support and register a proper cursor plane using 299 * drm_crtc_init_with_planes(). 300 * 301 * This callback is optional. 302 * 303 * RETURNS: 304 * 305 * 0 on success or a negative error code on failure. 306 */ 307 int (*cursor_move)(struct drm_crtc *crtc, int x, int y); 308 309 /** 310 * @gamma_set: 311 * 312 * Set gamma on the CRTC. 313 * 314 * This callback is optional. 315 * 316 * NOTE: 317 * 318 * Drivers that support gamma tables and also fbdev emulation through 319 * the provided helper library need to take care to fill out the gamma 320 * hooks for both. Currently there's a bit an unfortunate duplication 321 * going on, which should eventually be unified to just one set of 322 * hooks. 323 */ 324 int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b, 325 uint32_t size); 326 327 /** 328 * @destroy: 329 * 330 * Clean up plane resources. This is only called at driver unload time 331 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged 332 * in DRM. 333 */ 334 void (*destroy)(struct drm_crtc *crtc); 335 336 /** 337 * @set_config: 338 * 339 * This is the main legacy entry point to change the modeset state on a 340 * CRTC. All the details of the desired configuration are passed in a 341 * &struct drm_mode_set - see there for details. 342 * 343 * Drivers implementing atomic modeset should use 344 * drm_atomic_helper_set_config() to implement this hook. 345 * 346 * RETURNS: 347 * 348 * 0 on success or a negative error code on failure. 349 */ 350 int (*set_config)(struct drm_mode_set *set, 351 struct drm_modeset_acquire_ctx *ctx); 352 353 /** 354 * @page_flip: 355 * 356 * Legacy entry point to schedule a flip to the given framebuffer. 357 * 358 * Page flipping is a synchronization mechanism that replaces the frame 359 * buffer being scanned out by the CRTC with a new frame buffer during 360 * vertical blanking, avoiding tearing (except when requested otherwise 361 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application 362 * requests a page flip the DRM core verifies that the new frame buffer 363 * is large enough to be scanned out by the CRTC in the currently 364 * configured mode and then calls this hook with a pointer to the new 365 * frame buffer. 366 * 367 * The driver must wait for any pending rendering to the new framebuffer 368 * to complete before executing the flip. It should also wait for any 369 * pending rendering from other drivers if the underlying buffer is a 370 * shared dma-buf. 371 * 372 * An application can request to be notified when the page flip has 373 * completed. The drm core will supply a &struct drm_event in the event 374 * parameter in this case. This can be handled by the 375 * drm_crtc_send_vblank_event() function, which the driver should call on 376 * the provided event upon completion of the flip. Note that if 377 * the driver supports vblank signalling and timestamping the vblank 378 * counters and timestamps must agree with the ones returned from page 379 * flip events. With the current vblank helper infrastructure this can 380 * be achieved by holding a vblank reference while the page flip is 381 * pending, acquired through drm_crtc_vblank_get() and released with 382 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank 383 * counter and timestamp tracking though, e.g. if they have accurate 384 * timestamp registers in hardware. 385 * 386 * This callback is optional. 387 * 388 * NOTE: 389 * 390 * Very early versions of the KMS ABI mandated that the driver must 391 * block (but not reject) any rendering to the old framebuffer until the 392 * flip operation has completed and the old framebuffer is no longer 393 * visible. This requirement has been lifted, and userspace is instead 394 * expected to request delivery of an event and wait with recycling old 395 * buffers until such has been received. 396 * 397 * RETURNS: 398 * 399 * 0 on success or a negative error code on failure. Note that if a 400 * page flip operation is already pending the callback should return 401 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode 402 * or just runtime disabled through DPMS respectively the new atomic 403 * "ACTIVE" state) should result in an -EINVAL error code. Note that 404 * drm_atomic_helper_page_flip() checks this already for atomic drivers. 405 */ 406 int (*page_flip)(struct drm_crtc *crtc, 407 struct drm_framebuffer *fb, 408 struct drm_pending_vblank_event *event, 409 uint32_t flags, 410 struct drm_modeset_acquire_ctx *ctx); 411 412 /** 413 * @page_flip_target: 414 * 415 * Same as @page_flip but with an additional parameter specifying the 416 * absolute target vertical blank period (as reported by 417 * drm_crtc_vblank_count()) when the flip should take effect. 418 * 419 * Note that the core code calls drm_crtc_vblank_get before this entry 420 * point, and will call drm_crtc_vblank_put if this entry point returns 421 * any non-0 error code. It's the driver's responsibility to call 422 * drm_crtc_vblank_put after this entry point returns 0, typically when 423 * the flip completes. 424 */ 425 int (*page_flip_target)(struct drm_crtc *crtc, 426 struct drm_framebuffer *fb, 427 struct drm_pending_vblank_event *event, 428 uint32_t flags, uint32_t target, 429 struct drm_modeset_acquire_ctx *ctx); 430 431 /** 432 * @set_property: 433 * 434 * This is the legacy entry point to update a property attached to the 435 * CRTC. 436 * 437 * Drivers implementing atomic modeset should use 438 * drm_atomic_helper_crtc_set_property() to implement this hook. 439 * 440 * This callback is optional if the driver does not support any legacy 441 * driver-private properties. 442 * 443 * RETURNS: 444 * 445 * 0 on success or a negative error code on failure. 446 */ 447 int (*set_property)(struct drm_crtc *crtc, 448 struct drm_property *property, uint64_t val); 449 450 /** 451 * @atomic_duplicate_state: 452 * 453 * Duplicate the current atomic state for this CRTC and return it. 454 * The core and helpers guarantee that any atomic state duplicated with 455 * this hook and still owned by the caller (i.e. not transferred to the 456 * driver by calling &drm_mode_config_funcs.atomic_commit) will be 457 * cleaned up by calling the @atomic_destroy_state hook in this 458 * structure. 459 * 460 * Atomic drivers which don't subclass &struct drm_crtc_state should use 461 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the 462 * state structure to extend it with driver-private state should use 463 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is 464 * duplicated in a consistent fashion across drivers. 465 * 466 * It is an error to call this hook before &drm_crtc.state has been 467 * initialized correctly. 468 * 469 * NOTE: 470 * 471 * If the duplicate state references refcounted resources this hook must 472 * acquire a reference for each of them. The driver must release these 473 * references again in @atomic_destroy_state. 474 * 475 * RETURNS: 476 * 477 * Duplicated atomic state or NULL when the allocation failed. 478 */ 479 struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc); 480 481 /** 482 * @atomic_destroy_state: 483 * 484 * Destroy a state duplicated with @atomic_duplicate_state and release 485 * or unreference all resources it references 486 */ 487 void (*atomic_destroy_state)(struct drm_crtc *crtc, 488 struct drm_crtc_state *state); 489 490 /** 491 * @atomic_set_property: 492 * 493 * Decode a driver-private property value and store the decoded value 494 * into the passed-in state structure. Since the atomic core decodes all 495 * standardized properties (even for extensions beyond the core set of 496 * properties which might not be implemented by all drivers) this 497 * requires drivers to subclass the state structure. 498 * 499 * Such driver-private properties should really only be implemented for 500 * truly hardware/vendor specific state. Instead it is preferred to 501 * standardize atomic extension and decode the properties used to expose 502 * such an extension in the core. 503 * 504 * Do not call this function directly, use 505 * drm_atomic_crtc_set_property() instead. 506 * 507 * This callback is optional if the driver does not support any 508 * driver-private atomic properties. 509 * 510 * NOTE: 511 * 512 * This function is called in the state assembly phase of atomic 513 * modesets, which can be aborted for any reason (including on 514 * userspace's request to just check whether a configuration would be 515 * possible). Drivers MUST NOT touch any persistent state (hardware or 516 * software) or data structures except the passed in @state parameter. 517 * 518 * Also since userspace controls in which order properties are set this 519 * function must not do any input validation (since the state update is 520 * incomplete and hence likely inconsistent). Instead any such input 521 * validation must be done in the various atomic_check callbacks. 522 * 523 * RETURNS: 524 * 525 * 0 if the property has been found, -EINVAL if the property isn't 526 * implemented by the driver (which should never happen, the core only 527 * asks for properties attached to this CRTC). No other validation is 528 * allowed by the driver. The core already checks that the property 529 * value is within the range (integer, valid enum value, ...) the driver 530 * set when registering the property. 531 */ 532 int (*atomic_set_property)(struct drm_crtc *crtc, 533 struct drm_crtc_state *state, 534 struct drm_property *property, 535 uint64_t val); 536 /** 537 * @atomic_get_property: 538 * 539 * Reads out the decoded driver-private property. This is used to 540 * implement the GETCRTC IOCTL. 541 * 542 * Do not call this function directly, use 543 * drm_atomic_crtc_get_property() instead. 544 * 545 * This callback is optional if the driver does not support any 546 * driver-private atomic properties. 547 * 548 * RETURNS: 549 * 550 * 0 on success, -EINVAL if the property isn't implemented by the 551 * driver (which should never happen, the core only asks for 552 * properties attached to this CRTC). 553 */ 554 int (*atomic_get_property)(struct drm_crtc *crtc, 555 const struct drm_crtc_state *state, 556 struct drm_property *property, 557 uint64_t *val); 558 559 /** 560 * @late_register: 561 * 562 * This optional hook can be used to register additional userspace 563 * interfaces attached to the crtc like debugfs interfaces. 564 * It is called late in the driver load sequence from drm_dev_register(). 565 * Everything added from this callback should be unregistered in 566 * the early_unregister callback. 567 * 568 * Returns: 569 * 570 * 0 on success, or a negative error code on failure. 571 */ 572 int (*late_register)(struct drm_crtc *crtc); 573 574 /** 575 * @early_unregister: 576 * 577 * This optional hook should be used to unregister the additional 578 * userspace interfaces attached to the crtc from 579 * @late_register. It is called from drm_dev_unregister(), 580 * early in the driver unload sequence to disable userspace access 581 * before data structures are torndown. 582 */ 583 void (*early_unregister)(struct drm_crtc *crtc); 584 585 /** 586 * @set_crc_source: 587 * 588 * Changes the source of CRC checksums of frames at the request of 589 * userspace, typically for testing purposes. The sources available are 590 * specific of each driver and a %NULL value indicates that CRC 591 * generation is to be switched off. 592 * 593 * When CRC generation is enabled, the driver should call 594 * drm_crtc_add_crc_entry() at each frame, providing any information 595 * that characterizes the frame contents in the crcN arguments, as 596 * provided from the configured source. Drivers must accept an "auto" 597 * source name that will select a default source for this CRTC. 598 * 599 * Note that "auto" can depend upon the current modeset configuration, 600 * e.g. it could pick an encoder or output specific CRC sampling point. 601 * 602 * This callback is optional if the driver does not support any CRC 603 * generation functionality. 604 * 605 * RETURNS: 606 * 607 * 0 on success or a negative error code on failure. 608 */ 609 int (*set_crc_source)(struct drm_crtc *crtc, const char *source, 610 size_t *values_cnt); 611 612 /** 613 * @atomic_print_state: 614 * 615 * If driver subclasses &struct drm_crtc_state, it should implement 616 * this optional hook for printing additional driver specific state. 617 * 618 * Do not call this directly, use drm_atomic_crtc_print_state() 619 * instead. 620 */ 621 void (*atomic_print_state)(struct drm_printer *p, 622 const struct drm_crtc_state *state); 623 624 /** 625 * @get_vblank_counter: 626 * 627 * Driver callback for fetching a raw hardware vblank counter for the 628 * CRTC. It's meant to be used by new drivers as the replacement of 629 * &drm_driver.get_vblank_counter hook. 630 * 631 * This callback is optional. If a device doesn't have a hardware 632 * counter, the driver can simply leave the hook as NULL. The DRM core 633 * will account for missed vblank events while interrupts where disabled 634 * based on system timestamps. 635 * 636 * Wraparound handling and loss of events due to modesetting is dealt 637 * with in the DRM core code, as long as drivers call 638 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or 639 * enabling a CRTC. 640 * 641 * Returns: 642 * 643 * Raw vblank counter value. 644 */ 645 u32 (*get_vblank_counter)(struct drm_crtc *crtc); 646 647 /** 648 * @enable_vblank: 649 * 650 * Enable vblank interrupts for the CRTC. It's meant to be used by 651 * new drivers as the replacement of &drm_driver.enable_vblank hook. 652 * 653 * Returns: 654 * 655 * Zero on success, appropriate errno if the vblank interrupt cannot 656 * be enabled. 657 */ 658 int (*enable_vblank)(struct drm_crtc *crtc); 659 660 /** 661 * @disable_vblank: 662 * 663 * Disable vblank interrupts for the CRTC. It's meant to be used by 664 * new drivers as the replacement of &drm_driver.disable_vblank hook. 665 */ 666 void (*disable_vblank)(struct drm_crtc *crtc); 667 }; 668 669 /** 670 * struct drm_crtc - central CRTC control structure 671 * @dev: parent DRM device 672 * @port: OF node used by drm_of_find_possible_crtcs() 673 * @head: list management 674 * @name: human readable name, can be overwritten by the driver 675 * @mutex: per-CRTC locking 676 * @base: base KMS object for ID tracking etc. 677 * @primary: primary plane for this CRTC 678 * @cursor: cursor plane for this CRTC 679 * @cursor_x: current x position of the cursor, used for universal cursor planes 680 * @cursor_y: current y position of the cursor, used for universal cursor planes 681 * @enabled: is this CRTC enabled? 682 * @mode: current mode timings 683 * @hwmode: mode timings as programmed to hw regs 684 * @x: x position on screen 685 * @y: y position on screen 686 * @funcs: CRTC control functions 687 * @gamma_size: size of gamma ramp 688 * @gamma_store: gamma ramp values 689 * @helper_private: mid-layer private data 690 * @properties: property tracking for this CRTC 691 * 692 * Each CRTC may have one or more connectors associated with it. This structure 693 * allows the CRTC to be controlled. 694 */ 695 struct drm_crtc { 696 struct drm_device *dev; 697 struct device_node *port; 698 struct list_head head; 699 700 char *name; 701 702 /** 703 * @mutex: 704 * 705 * This provides a read lock for the overall CRTC state (mode, dpms 706 * state, ...) and a write lock for everything which can be update 707 * without a full modeset (fb, cursor data, CRTC properties ...). A full 708 * modeset also need to grab &drm_mode_config.connection_mutex. 709 * 710 * For atomic drivers specifically this protects @state. 711 */ 712 struct drm_modeset_lock mutex; 713 714 struct drm_mode_object base; 715 716 /* primary and cursor planes for CRTC */ 717 struct drm_plane *primary; 718 struct drm_plane *cursor; 719 720 /** 721 * @index: Position inside the mode_config.list, can be used as an array 722 * index. It is invariant over the lifetime of the CRTC. 723 */ 724 unsigned index; 725 726 /* position of cursor plane on crtc */ 727 int cursor_x; 728 int cursor_y; 729 730 bool enabled; 731 732 /* Requested mode from modesetting. */ 733 struct drm_display_mode mode; 734 735 /* Programmed mode in hw, after adjustments for encoders, 736 * crtc, panel scaling etc. Needed for timestamping etc. 737 */ 738 struct drm_display_mode hwmode; 739 740 int x, y; 741 const struct drm_crtc_funcs *funcs; 742 743 /* Legacy FB CRTC gamma size for reporting to userspace */ 744 uint32_t gamma_size; 745 uint16_t *gamma_store; 746 747 /* if you are using the helper */ 748 const struct drm_crtc_helper_funcs *helper_private; 749 750 struct drm_object_properties properties; 751 752 /** 753 * @state: 754 * 755 * Current atomic state for this CRTC. 756 * 757 * This is protected by @mutex. Note that nonblocking atomic commits 758 * access the current CRTC state without taking locks. Either by going 759 * through the &struct drm_atomic_state pointers, see 760 * for_each_crtc_in_state(), for_each_oldnew_crtc_in_state(), 761 * for_each_old_crtc_in_state() and for_each_new_crtc_in_state(). Or 762 * through careful ordering of atomic commit operations as implemented 763 * in the atomic helpers, see &struct drm_crtc_commit. 764 */ 765 struct drm_crtc_state *state; 766 767 /** 768 * @commit_list: 769 * 770 * List of &drm_crtc_commit structures tracking pending commits. 771 * Protected by @commit_lock. This list doesn't hold its own full 772 * reference, but burrows it from the ongoing commit. Commit entries 773 * must be removed from this list once the commit is fully completed, 774 * but before it's correspoding &drm_atomic_state gets destroyed. 775 */ 776 struct list_head commit_list; 777 778 /** 779 * @commit_lock: 780 * 781 * Spinlock to protect @commit_list. 782 */ 783 spinlock_t commit_lock; 784 785 /** 786 * @acquire_ctx: 787 * 788 * Per-CRTC implicit acquire context used by atomic drivers for legacy 789 * IOCTLs, so that atomic drivers can get at the locking acquire 790 * context. 791 */ 792 struct drm_modeset_acquire_ctx *acquire_ctx; 793 794 #ifdef CONFIG_DEBUG_FS 795 /** 796 * @debugfs_entry: 797 * 798 * Debugfs directory for this CRTC. 799 */ 800 struct dentry *debugfs_entry; 801 #endif 802 803 /** 804 * @crc: 805 * 806 * Configuration settings of CRC capture. 807 */ 808 struct drm_crtc_crc crc; 809 810 /** 811 * @fence_context: 812 * 813 * timeline context used for fence operations. 814 */ 815 unsigned int fence_context; 816 817 /** 818 * @fence_lock: 819 * 820 * spinlock to protect the fences in the fence_context. 821 */ 822 823 spinlock_t fence_lock; 824 /** 825 * @fence_seqno: 826 * 827 * Seqno variable used as monotonic counter for the fences 828 * created on the CRTC's timeline. 829 */ 830 unsigned long fence_seqno; 831 832 /** 833 * @timeline_name: 834 * 835 * The name of the CRTC's fence timeline. 836 */ 837 char timeline_name[32]; 838 }; 839 840 /** 841 * struct drm_mode_set - new values for a CRTC config change 842 * @fb: framebuffer to use for new config 843 * @crtc: CRTC whose configuration we're about to change 844 * @mode: mode timings to use 845 * @x: position of this CRTC relative to @fb 846 * @y: position of this CRTC relative to @fb 847 * @connectors: array of connectors to drive with this CRTC if possible 848 * @num_connectors: size of @connectors array 849 * 850 * This represents a modeset configuration for the legacy SETCRTC ioctl and is 851 * also used internally. Atomic drivers instead use &drm_atomic_state. 852 */ 853 struct drm_mode_set { 854 struct drm_framebuffer *fb; 855 struct drm_crtc *crtc; 856 struct drm_display_mode *mode; 857 858 uint32_t x; 859 uint32_t y; 860 861 struct drm_connector **connectors; 862 size_t num_connectors; 863 }; 864 865 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base) 866 867 __printf(6, 7) 868 int drm_crtc_init_with_planes(struct drm_device *dev, 869 struct drm_crtc *crtc, 870 struct drm_plane *primary, 871 struct drm_plane *cursor, 872 const struct drm_crtc_funcs *funcs, 873 const char *name, ...); 874 void drm_crtc_cleanup(struct drm_crtc *crtc); 875 876 /** 877 * drm_crtc_index - find the index of a registered CRTC 878 * @crtc: CRTC to find index for 879 * 880 * Given a registered CRTC, return the index of that CRTC within a DRM 881 * device's list of CRTCs. 882 */ 883 static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc) 884 { 885 return crtc->index; 886 } 887 888 /** 889 * drm_crtc_mask - find the mask of a registered CRTC 890 * @crtc: CRTC to find mask for 891 * 892 * Given a registered CRTC, return the mask bit of that CRTC for an 893 * encoder's possible_crtcs field. 894 */ 895 static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc) 896 { 897 return 1 << drm_crtc_index(crtc); 898 } 899 900 int drm_crtc_force_disable(struct drm_crtc *crtc); 901 int drm_crtc_force_disable_all(struct drm_device *dev); 902 903 int drm_mode_set_config_internal(struct drm_mode_set *set); 904 struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx); 905 906 /** 907 * drm_crtc_find - look up a CRTC object from its ID 908 * @dev: DRM device 909 * @id: &drm_mode_object ID 910 * 911 * This can be used to look up a CRTC from its userspace ID. Only used by 912 * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS 913 * userspace interface should be done using &drm_property. 914 */ 915 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev, 916 uint32_t id) 917 { 918 struct drm_mode_object *mo; 919 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC); 920 return mo ? obj_to_crtc(mo) : NULL; 921 } 922 923 /** 924 * drm_for_each_crtc - iterate over all CRTCs 925 * @crtc: a &struct drm_crtc as the loop cursor 926 * @dev: the &struct drm_device 927 * 928 * Iterate over all CRTCs of @dev. 929 */ 930 #define drm_for_each_crtc(crtc, dev) \ 931 list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head) 932 933 #endif /* __DRM_CRTC_H__ */ 934