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