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