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