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