1 /* 2 * Copyright (c) 2016 Intel Corporation 3 * 4 * Permission to use, copy, modify, distribute, and sell this software and its 5 * documentation for any purpose is hereby granted without fee, provided that 6 * the above copyright notice appear in all copies and that both that copyright 7 * notice and this permission notice appear in supporting documentation, and 8 * that the name of the copyright holders not be used in advertising or 9 * publicity pertaining to distribution of the software without specific, 10 * written prior permission. The copyright holders make no representations 11 * about the suitability of this software for any purpose. It is provided "as 12 * is" without express or implied warranty. 13 * 14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 20 * OF THIS SOFTWARE. 21 */ 22 23 #ifndef __DRM_MODE_CONFIG_H__ 24 #define __DRM_MODE_CONFIG_H__ 25 26 #include <linux/mutex.h> 27 #include <linux/types.h> 28 #include <linux/idr.h> 29 #include <linux/workqueue.h> 30 #include <linux/llist.h> 31 32 #include <drm/drm_modeset_lock.h> 33 34 struct drm_file; 35 struct drm_device; 36 struct drm_atomic_state; 37 struct drm_mode_fb_cmd2; 38 struct drm_format_info; 39 struct drm_display_mode; 40 41 /** 42 * struct drm_mode_config_funcs - basic driver provided mode setting functions 43 * 44 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that 45 * involve drivers. 46 */ 47 struct drm_mode_config_funcs { 48 /** 49 * @fb_create: 50 * 51 * Create a new framebuffer object. The core does basic checks on the 52 * requested metadata, but most of that is left to the driver. See 53 * &struct drm_mode_fb_cmd2 for details. 54 * 55 * To validate the pixel format and modifier drivers can use 56 * drm_any_plane_has_format() to make sure at least one plane supports 57 * the requested values. Note that the driver must first determine the 58 * actual modifier used if the request doesn't have it specified, 59 * ie. when (@mode_cmd->flags & DRM_MODE_FB_MODIFIERS) == 0. 60 * 61 * IMPORTANT: These implied modifiers for legacy userspace must be 62 * stored in struct &drm_framebuffer, including all relevant metadata 63 * like &drm_framebuffer.pitches and &drm_framebuffer.offsets if the 64 * modifier enables additional planes beyond the fourcc pixel format 65 * code. This is required by the GETFB2 ioctl. 66 * 67 * If the parameters are deemed valid and the backing storage objects in 68 * the underlying memory manager all exist, then the driver allocates 69 * a new &drm_framebuffer structure, subclassed to contain 70 * driver-specific information (like the internal native buffer object 71 * references). It also needs to fill out all relevant metadata, which 72 * should be done by calling drm_helper_mode_fill_fb_struct(). 73 * 74 * The initialization is finalized by calling drm_framebuffer_init(), 75 * which registers the framebuffer and makes it accessible to other 76 * threads. 77 * 78 * RETURNS: 79 * 80 * A new framebuffer with an initial reference count of 1 or a negative 81 * error code encoded with ERR_PTR(). 82 */ 83 struct drm_framebuffer *(*fb_create)(struct drm_device *dev, 84 struct drm_file *file_priv, 85 const struct drm_mode_fb_cmd2 *mode_cmd); 86 87 /** 88 * @get_format_info: 89 * 90 * Allows a driver to return custom format information for special 91 * fb layouts (eg. ones with auxiliary compression control planes). 92 * 93 * RETURNS: 94 * 95 * The format information specific to the given fb metadata, or 96 * NULL if none is found. 97 */ 98 const struct drm_format_info *(*get_format_info)(const struct drm_mode_fb_cmd2 *mode_cmd); 99 100 /** 101 * @output_poll_changed: 102 * 103 * Callback used by helpers to inform the driver of output configuration 104 * changes. 105 * 106 * Drivers implementing fbdev emulation use drm_kms_helper_hotplug_event() 107 * to call this hook to inform the fbdev helper of output changes. 108 * 109 * This hook is deprecated, drivers should instead use 110 * drm_fbdev_generic_setup() which takes care of any necessary 111 * hotplug event forwarding already without further involvement by 112 * the driver. 113 */ 114 void (*output_poll_changed)(struct drm_device *dev); 115 116 /** 117 * @mode_valid: 118 * 119 * Device specific validation of display modes. Can be used to reject 120 * modes that can never be supported. Only device wide constraints can 121 * be checked here. crtc/encoder/bridge/connector specific constraints 122 * should be checked in the .mode_valid() hook for each specific object. 123 */ 124 enum drm_mode_status (*mode_valid)(struct drm_device *dev, 125 const struct drm_display_mode *mode); 126 127 /** 128 * @atomic_check: 129 * 130 * This is the only hook to validate an atomic modeset update. This 131 * function must reject any modeset and state changes which the hardware 132 * or driver doesn't support. This includes but is of course not limited 133 * to: 134 * 135 * - Checking that the modes, framebuffers, scaling and placement 136 * requirements and so on are within the limits of the hardware. 137 * 138 * - Checking that any hidden shared resources are not oversubscribed. 139 * This can be shared PLLs, shared lanes, overall memory bandwidth, 140 * display fifo space (where shared between planes or maybe even 141 * CRTCs). 142 * 143 * - Checking that virtualized resources exported to userspace are not 144 * oversubscribed. For various reasons it can make sense to expose 145 * more planes, crtcs or encoders than which are physically there. One 146 * example is dual-pipe operations (which generally should be hidden 147 * from userspace if when lockstepped in hardware, exposed otherwise), 148 * where a plane might need 1 hardware plane (if it's just on one 149 * pipe), 2 hardware planes (when it spans both pipes) or maybe even 150 * shared a hardware plane with a 2nd plane (if there's a compatible 151 * plane requested on the area handled by the other pipe). 152 * 153 * - Check that any transitional state is possible and that if 154 * requested, the update can indeed be done in the vblank period 155 * without temporarily disabling some functions. 156 * 157 * - Check any other constraints the driver or hardware might have. 158 * 159 * - This callback also needs to correctly fill out the &drm_crtc_state 160 * in this update to make sure that drm_atomic_crtc_needs_modeset() 161 * reflects the nature of the possible update and returns true if and 162 * only if the update cannot be applied without tearing within one 163 * vblank on that CRTC. The core uses that information to reject 164 * updates which require a full modeset (i.e. blanking the screen, or 165 * at least pausing updates for a substantial amount of time) if 166 * userspace has disallowed that in its request. 167 * 168 * - The driver also does not need to repeat basic input validation 169 * like done for the corresponding legacy entry points. The core does 170 * that before calling this hook. 171 * 172 * See the documentation of @atomic_commit for an exhaustive list of 173 * error conditions which don't have to be checked at the in this 174 * callback. 175 * 176 * See the documentation for &struct drm_atomic_state for how exactly 177 * an atomic modeset update is described. 178 * 179 * Drivers using the atomic helpers can implement this hook using 180 * drm_atomic_helper_check(), or one of the exported sub-functions of 181 * it. 182 * 183 * RETURNS: 184 * 185 * 0 on success or one of the below negative error codes: 186 * 187 * - -EINVAL, if any of the above constraints are violated. 188 * 189 * - -EDEADLK, when returned from an attempt to acquire an additional 190 * &drm_modeset_lock through drm_modeset_lock(). 191 * 192 * - -ENOMEM, if allocating additional state sub-structures failed due 193 * to lack of memory. 194 * 195 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted. 196 * This can either be due to a pending signal, or because the driver 197 * needs to completely bail out to recover from an exceptional 198 * situation like a GPU hang. From a userspace point all errors are 199 * treated equally. 200 */ 201 int (*atomic_check)(struct drm_device *dev, 202 struct drm_atomic_state *state); 203 204 /** 205 * @atomic_commit: 206 * 207 * This is the only hook to commit an atomic modeset update. The core 208 * guarantees that @atomic_check has been called successfully before 209 * calling this function, and that nothing has been changed in the 210 * interim. 211 * 212 * See the documentation for &struct drm_atomic_state for how exactly 213 * an atomic modeset update is described. 214 * 215 * Drivers using the atomic helpers can implement this hook using 216 * drm_atomic_helper_commit(), or one of the exported sub-functions of 217 * it. 218 * 219 * Nonblocking commits (as indicated with the nonblock parameter) must 220 * do any preparatory work which might result in an unsuccessful commit 221 * in the context of this callback. The only exceptions are hardware 222 * errors resulting in -EIO. But even in that case the driver must 223 * ensure that the display pipe is at least running, to avoid 224 * compositors crashing when pageflips don't work. Anything else, 225 * specifically committing the update to the hardware, should be done 226 * without blocking the caller. For updates which do not require a 227 * modeset this must be guaranteed. 228 * 229 * The driver must wait for any pending rendering to the new 230 * framebuffers to complete before executing the flip. It should also 231 * wait for any pending rendering from other drivers if the underlying 232 * buffer is a shared dma-buf. Nonblocking commits must not wait for 233 * rendering in the context of this callback. 234 * 235 * An application can request to be notified when the atomic commit has 236 * completed. These events are per-CRTC and can be distinguished by the 237 * CRTC index supplied in &drm_event to userspace. 238 * 239 * The drm core will supply a &struct drm_event in each CRTC's 240 * &drm_crtc_state.event. See the documentation for 241 * &drm_crtc_state.event for more details about the precise semantics of 242 * this event. 243 * 244 * NOTE: 245 * 246 * Drivers are not allowed to shut down any display pipe successfully 247 * enabled through an atomic commit on their own. Doing so can result in 248 * compositors crashing if a page flip is suddenly rejected because the 249 * pipe is off. 250 * 251 * RETURNS: 252 * 253 * 0 on success or one of the below negative error codes: 254 * 255 * - -EBUSY, if a nonblocking updated is requested and there is 256 * an earlier updated pending. Drivers are allowed to support a queue 257 * of outstanding updates, but currently no driver supports that. 258 * Note that drivers must wait for preceding updates to complete if a 259 * synchronous update is requested, they are not allowed to fail the 260 * commit in that case. 261 * 262 * - -ENOMEM, if the driver failed to allocate memory. Specifically 263 * this can happen when trying to pin framebuffers, which must only 264 * be done when committing the state. 265 * 266 * - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate 267 * that the driver has run out of vram, iommu space or similar GPU 268 * address space needed for framebuffer. 269 * 270 * - -EIO, if the hardware completely died. 271 * 272 * - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted. 273 * This can either be due to a pending signal, or because the driver 274 * needs to completely bail out to recover from an exceptional 275 * situation like a GPU hang. From a userspace point of view all errors are 276 * treated equally. 277 * 278 * This list is exhaustive. Specifically this hook is not allowed to 279 * return -EINVAL (any invalid requests should be caught in 280 * @atomic_check) or -EDEADLK (this function must not acquire 281 * additional modeset locks). 282 */ 283 int (*atomic_commit)(struct drm_device *dev, 284 struct drm_atomic_state *state, 285 bool nonblock); 286 287 /** 288 * @atomic_state_alloc: 289 * 290 * This optional hook can be used by drivers that want to subclass struct 291 * &drm_atomic_state to be able to track their own driver-private global 292 * state easily. If this hook is implemented, drivers must also 293 * implement @atomic_state_clear and @atomic_state_free. 294 * 295 * Subclassing of &drm_atomic_state is deprecated in favour of using 296 * &drm_private_state and &drm_private_obj. 297 * 298 * RETURNS: 299 * 300 * A new &drm_atomic_state on success or NULL on failure. 301 */ 302 struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev); 303 304 /** 305 * @atomic_state_clear: 306 * 307 * This hook must clear any driver private state duplicated into the 308 * passed-in &drm_atomic_state. This hook is called when the caller 309 * encountered a &drm_modeset_lock deadlock and needs to drop all 310 * already acquired locks as part of the deadlock avoidance dance 311 * implemented in drm_modeset_backoff(). 312 * 313 * Any duplicated state must be invalidated since a concurrent atomic 314 * update might change it, and the drm atomic interfaces always apply 315 * updates as relative changes to the current state. 316 * 317 * Drivers that implement this must call drm_atomic_state_default_clear() 318 * to clear common state. 319 * 320 * Subclassing of &drm_atomic_state is deprecated in favour of using 321 * &drm_private_state and &drm_private_obj. 322 */ 323 void (*atomic_state_clear)(struct drm_atomic_state *state); 324 325 /** 326 * @atomic_state_free: 327 * 328 * This hook needs driver private resources and the &drm_atomic_state 329 * itself. Note that the core first calls drm_atomic_state_clear() to 330 * avoid code duplicate between the clear and free hooks. 331 * 332 * Drivers that implement this must call 333 * drm_atomic_state_default_release() to release common resources. 334 * 335 * Subclassing of &drm_atomic_state is deprecated in favour of using 336 * &drm_private_state and &drm_private_obj. 337 */ 338 void (*atomic_state_free)(struct drm_atomic_state *state); 339 }; 340 341 /** 342 * struct drm_mode_config - Mode configuration control structure 343 * @min_width: minimum fb pixel width on this device 344 * @min_height: minimum fb pixel height on this device 345 * @max_width: maximum fb pixel width on this device 346 * @max_height: maximum fb pixel height on this device 347 * @funcs: core driver provided mode setting functions 348 * @poll_enabled: track polling support for this device 349 * @poll_running: track polling status for this device 350 * @delayed_event: track delayed poll uevent deliver for this device 351 * @output_poll_work: delayed work for polling in process context 352 * @preferred_depth: preferred RBG pixel depth, used by fb helpers 353 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering 354 * @cursor_width: hint to userspace for max cursor width 355 * @cursor_height: hint to userspace for max cursor height 356 * @helper_private: mid-layer private data 357 * 358 * Core mode resource tracking structure. All CRTC, encoders, and connectors 359 * enumerated by the driver are added here, as are global properties. Some 360 * global restrictions are also here, e.g. dimension restrictions. 361 * 362 * Framebuffer sizes refer to the virtual screen that can be displayed by 363 * the CRTC. This can be different from the physical resolution programmed. 364 * The minimum width and height, stored in @min_width and @min_height, 365 * describe the smallest size of the framebuffer. It correlates to the 366 * minimum programmable resolution. 367 * The maximum width, stored in @max_width, is typically limited by the 368 * maximum pitch between two adjacent scanlines. The maximum height, stored 369 * in @max_height, is usually only limited by the amount of addressable video 370 * memory. For hardware that has no real maximum, drivers should pick a 371 * reasonable default. 372 * 373 * See also @DRM_SHADOW_PLANE_MAX_WIDTH and @DRM_SHADOW_PLANE_MAX_HEIGHT. 374 */ 375 struct drm_mode_config { 376 /** 377 * @mutex: 378 * 379 * This is the big scary modeset BKL which protects everything that 380 * isn't protect otherwise. Scope is unclear and fuzzy, try to remove 381 * anything from under its protection and move it into more well-scoped 382 * locks. 383 * 384 * The one important thing this protects is the use of @acquire_ctx. 385 */ 386 struct mutex mutex; 387 388 /** 389 * @connection_mutex: 390 * 391 * This protects connector state and the connector to encoder to CRTC 392 * routing chain. 393 * 394 * For atomic drivers specifically this protects &drm_connector.state. 395 */ 396 struct drm_modeset_lock connection_mutex; 397 398 /** 399 * @acquire_ctx: 400 * 401 * Global implicit acquire context used by atomic drivers for legacy 402 * IOCTLs. Deprecated, since implicit locking contexts make it 403 * impossible to use driver-private &struct drm_modeset_lock. Users of 404 * this must hold @mutex. 405 */ 406 struct drm_modeset_acquire_ctx *acquire_ctx; 407 408 /** 409 * @idr_mutex: 410 * 411 * Mutex for KMS ID allocation and management. Protects both @object_idr 412 * and @tile_idr. 413 */ 414 struct mutex idr_mutex; 415 416 /** 417 * @object_idr: 418 * 419 * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc, 420 * connector, modes - just makes life easier to have only one. 421 */ 422 struct idr object_idr; 423 424 /** 425 * @tile_idr: 426 * 427 * Use this idr for allocating new IDs for tiled sinks like use in some 428 * high-res DP MST screens. 429 */ 430 struct idr tile_idr; 431 432 /** @fb_lock: Mutex to protect fb the global @fb_list and @num_fb. */ 433 struct mutex fb_lock; 434 /** @num_fb: Number of entries on @fb_list. */ 435 int num_fb; 436 /** @fb_list: List of all &struct drm_framebuffer. */ 437 struct list_head fb_list; 438 439 /** 440 * @connector_list_lock: Protects @num_connector and 441 * @connector_list and @connector_free_list. 442 */ 443 spinlock_t connector_list_lock; 444 /** 445 * @num_connector: Number of connectors on this device. Protected by 446 * @connector_list_lock. 447 */ 448 int num_connector; 449 /** 450 * @connector_ida: ID allocator for connector indices. 451 */ 452 struct ida connector_ida; 453 /** 454 * @connector_list: 455 * 456 * List of connector objects linked with &drm_connector.head. Protected 457 * by @connector_list_lock. Only use drm_for_each_connector_iter() and 458 * &struct drm_connector_list_iter to walk this list. 459 */ 460 struct list_head connector_list; 461 /** 462 * @connector_free_list: 463 * 464 * List of connector objects linked with &drm_connector.free_head. 465 * Protected by @connector_list_lock. Used by 466 * drm_for_each_connector_iter() and 467 * &struct drm_connector_list_iter to savely free connectors using 468 * @connector_free_work. 469 */ 470 struct llist_head connector_free_list; 471 /** 472 * @connector_free_work: Work to clean up @connector_free_list. 473 */ 474 struct work_struct connector_free_work; 475 476 /** 477 * @num_encoder: 478 * 479 * Number of encoders on this device. This is invariant over the 480 * lifetime of a device and hence doesn't need any locks. 481 */ 482 int num_encoder; 483 /** 484 * @encoder_list: 485 * 486 * List of encoder objects linked with &drm_encoder.head. This is 487 * invariant over the lifetime of a device and hence doesn't need any 488 * locks. 489 */ 490 struct list_head encoder_list; 491 492 /** 493 * @num_total_plane: 494 * 495 * Number of universal (i.e. with primary/curso) planes on this device. 496 * This is invariant over the lifetime of a device and hence doesn't 497 * need any locks. 498 */ 499 int num_total_plane; 500 /** 501 * @plane_list: 502 * 503 * List of plane objects linked with &drm_plane.head. This is invariant 504 * over the lifetime of a device and hence doesn't need any locks. 505 */ 506 struct list_head plane_list; 507 508 /** 509 * @num_crtc: 510 * 511 * Number of CRTCs on this device linked with &drm_crtc.head. This is invariant over the lifetime 512 * of a device and hence doesn't need any locks. 513 */ 514 int num_crtc; 515 /** 516 * @crtc_list: 517 * 518 * List of CRTC objects linked with &drm_crtc.head. This is invariant 519 * over the lifetime of a device and hence doesn't need any locks. 520 */ 521 struct list_head crtc_list; 522 523 /** 524 * @property_list: 525 * 526 * List of property type objects linked with &drm_property.head. This is 527 * invariant over the lifetime of a device and hence doesn't need any 528 * locks. 529 */ 530 struct list_head property_list; 531 532 /** 533 * @privobj_list: 534 * 535 * List of private objects linked with &drm_private_obj.head. This is 536 * invariant over the lifetime of a device and hence doesn't need any 537 * locks. 538 */ 539 struct list_head privobj_list; 540 541 int min_width, min_height; 542 int max_width, max_height; 543 const struct drm_mode_config_funcs *funcs; 544 545 /* output poll support */ 546 bool poll_enabled; 547 bool poll_running; 548 bool delayed_event; 549 struct delayed_work output_poll_work; 550 551 /** 552 * @blob_lock: 553 * 554 * Mutex for blob property allocation and management, protects 555 * @property_blob_list and &drm_file.blobs. 556 */ 557 struct mutex blob_lock; 558 559 /** 560 * @property_blob_list: 561 * 562 * List of all the blob property objects linked with 563 * &drm_property_blob.head. Protected by @blob_lock. 564 */ 565 struct list_head property_blob_list; 566 567 /* pointers to standard properties */ 568 569 /** 570 * @edid_property: Default connector property to hold the EDID of the 571 * currently connected sink, if any. 572 */ 573 struct drm_property *edid_property; 574 /** 575 * @dpms_property: Default connector property to control the 576 * connector's DPMS state. 577 */ 578 struct drm_property *dpms_property; 579 /** 580 * @path_property: Default connector property to hold the DP MST path 581 * for the port. 582 */ 583 struct drm_property *path_property; 584 /** 585 * @tile_property: Default connector property to store the tile 586 * position of a tiled screen, for sinks which need to be driven with 587 * multiple CRTCs. 588 */ 589 struct drm_property *tile_property; 590 /** 591 * @link_status_property: Default connector property for link status 592 * of a connector 593 */ 594 struct drm_property *link_status_property; 595 /** 596 * @plane_type_property: Default plane property to differentiate 597 * CURSOR, PRIMARY and OVERLAY legacy uses of planes. 598 */ 599 struct drm_property *plane_type_property; 600 /** 601 * @prop_src_x: Default atomic plane property for the plane source 602 * position in the connected &drm_framebuffer. 603 */ 604 struct drm_property *prop_src_x; 605 /** 606 * @prop_src_y: Default atomic plane property for the plane source 607 * position in the connected &drm_framebuffer. 608 */ 609 struct drm_property *prop_src_y; 610 /** 611 * @prop_src_w: Default atomic plane property for the plane source 612 * position in the connected &drm_framebuffer. 613 */ 614 struct drm_property *prop_src_w; 615 /** 616 * @prop_src_h: Default atomic plane property for the plane source 617 * position in the connected &drm_framebuffer. 618 */ 619 struct drm_property *prop_src_h; 620 /** 621 * @prop_crtc_x: Default atomic plane property for the plane destination 622 * position in the &drm_crtc is being shown on. 623 */ 624 struct drm_property *prop_crtc_x; 625 /** 626 * @prop_crtc_y: Default atomic plane property for the plane destination 627 * position in the &drm_crtc is being shown on. 628 */ 629 struct drm_property *prop_crtc_y; 630 /** 631 * @prop_crtc_w: Default atomic plane property for the plane destination 632 * position in the &drm_crtc is being shown on. 633 */ 634 struct drm_property *prop_crtc_w; 635 /** 636 * @prop_crtc_h: Default atomic plane property for the plane destination 637 * position in the &drm_crtc is being shown on. 638 */ 639 struct drm_property *prop_crtc_h; 640 /** 641 * @prop_fb_id: Default atomic plane property to specify the 642 * &drm_framebuffer. 643 */ 644 struct drm_property *prop_fb_id; 645 /** 646 * @prop_in_fence_fd: Sync File fd representing the incoming fences 647 * for a Plane. 648 */ 649 struct drm_property *prop_in_fence_fd; 650 /** 651 * @prop_out_fence_ptr: Sync File fd pointer representing the 652 * outgoing fences for a CRTC. Userspace should provide a pointer to a 653 * value of type s32, and then cast that pointer to u64. 654 */ 655 struct drm_property *prop_out_fence_ptr; 656 /** 657 * @prop_crtc_id: Default atomic plane property to specify the 658 * &drm_crtc. 659 */ 660 struct drm_property *prop_crtc_id; 661 /** 662 * @prop_fb_damage_clips: Optional plane property to mark damaged 663 * regions on the plane in framebuffer coordinates of the framebuffer 664 * attached to the plane. 665 * 666 * The layout of blob data is simply an array of &drm_mode_rect. Unlike 667 * plane src coordinates, damage clips are not in 16.16 fixed point. 668 */ 669 struct drm_property *prop_fb_damage_clips; 670 /** 671 * @prop_active: Default atomic CRTC property to control the active 672 * state, which is the simplified implementation for DPMS in atomic 673 * drivers. 674 */ 675 struct drm_property *prop_active; 676 /** 677 * @prop_mode_id: Default atomic CRTC property to set the mode for a 678 * CRTC. A 0 mode implies that the CRTC is entirely disabled - all 679 * connectors must be of and active must be set to disabled, too. 680 */ 681 struct drm_property *prop_mode_id; 682 /** 683 * @prop_vrr_enabled: Default atomic CRTC property to indicate 684 * whether variable refresh rate should be enabled on the CRTC. 685 */ 686 struct drm_property *prop_vrr_enabled; 687 688 /** 689 * @dvi_i_subconnector_property: Optional DVI-I property to 690 * differentiate between analog or digital mode. 691 */ 692 struct drm_property *dvi_i_subconnector_property; 693 /** 694 * @dvi_i_select_subconnector_property: Optional DVI-I property to 695 * select between analog or digital mode. 696 */ 697 struct drm_property *dvi_i_select_subconnector_property; 698 699 /** 700 * @dp_subconnector_property: Optional DP property to differentiate 701 * between different DP downstream port types. 702 */ 703 struct drm_property *dp_subconnector_property; 704 705 /** 706 * @tv_subconnector_property: Optional TV property to differentiate 707 * between different TV connector types. 708 */ 709 struct drm_property *tv_subconnector_property; 710 /** 711 * @tv_select_subconnector_property: Optional TV property to select 712 * between different TV connector types. 713 */ 714 struct drm_property *tv_select_subconnector_property; 715 716 /** 717 * @legacy_tv_mode_property: Optional TV property to select 718 * the output TV mode. 719 * 720 * Superseded by @tv_mode_property 721 */ 722 struct drm_property *legacy_tv_mode_property; 723 724 /** 725 * @tv_mode_property: Optional TV property to select the TV 726 * standard output on the connector. 727 */ 728 struct drm_property *tv_mode_property; 729 730 /** 731 * @tv_left_margin_property: Optional TV property to set the left 732 * margin (expressed in pixels). 733 */ 734 struct drm_property *tv_left_margin_property; 735 /** 736 * @tv_right_margin_property: Optional TV property to set the right 737 * margin (expressed in pixels). 738 */ 739 struct drm_property *tv_right_margin_property; 740 /** 741 * @tv_top_margin_property: Optional TV property to set the right 742 * margin (expressed in pixels). 743 */ 744 struct drm_property *tv_top_margin_property; 745 /** 746 * @tv_bottom_margin_property: Optional TV property to set the right 747 * margin (expressed in pixels). 748 */ 749 struct drm_property *tv_bottom_margin_property; 750 /** 751 * @tv_brightness_property: Optional TV property to set the 752 * brightness. 753 */ 754 struct drm_property *tv_brightness_property; 755 /** 756 * @tv_contrast_property: Optional TV property to set the 757 * contrast. 758 */ 759 struct drm_property *tv_contrast_property; 760 /** 761 * @tv_flicker_reduction_property: Optional TV property to control the 762 * flicker reduction mode. 763 */ 764 struct drm_property *tv_flicker_reduction_property; 765 /** 766 * @tv_overscan_property: Optional TV property to control the overscan 767 * setting. 768 */ 769 struct drm_property *tv_overscan_property; 770 /** 771 * @tv_saturation_property: Optional TV property to set the 772 * saturation. 773 */ 774 struct drm_property *tv_saturation_property; 775 /** 776 * @tv_hue_property: Optional TV property to set the hue. 777 */ 778 struct drm_property *tv_hue_property; 779 780 /** 781 * @scaling_mode_property: Optional connector property to control the 782 * upscaling, mostly used for built-in panels. 783 */ 784 struct drm_property *scaling_mode_property; 785 /** 786 * @aspect_ratio_property: Optional connector property to control the 787 * HDMI infoframe aspect ratio setting. 788 */ 789 struct drm_property *aspect_ratio_property; 790 /** 791 * @content_type_property: Optional connector property to control the 792 * HDMI infoframe content type setting. 793 */ 794 struct drm_property *content_type_property; 795 /** 796 * @degamma_lut_property: Optional CRTC property to set the LUT used to 797 * convert the framebuffer's colors to linear gamma. 798 */ 799 struct drm_property *degamma_lut_property; 800 /** 801 * @degamma_lut_size_property: Optional CRTC property for the size of 802 * the degamma LUT as supported by the driver (read-only). 803 */ 804 struct drm_property *degamma_lut_size_property; 805 /** 806 * @ctm_property: Optional CRTC property to set the 807 * matrix used to convert colors after the lookup in the 808 * degamma LUT. 809 */ 810 struct drm_property *ctm_property; 811 /** 812 * @gamma_lut_property: Optional CRTC property to set the LUT used to 813 * convert the colors, after the CTM matrix, to the gamma space of the 814 * connected screen. 815 */ 816 struct drm_property *gamma_lut_property; 817 /** 818 * @gamma_lut_size_property: Optional CRTC property for the size of the 819 * gamma LUT as supported by the driver (read-only). 820 */ 821 struct drm_property *gamma_lut_size_property; 822 823 /** 824 * @suggested_x_property: Optional connector property with a hint for 825 * the position of the output on the host's screen. 826 */ 827 struct drm_property *suggested_x_property; 828 /** 829 * @suggested_y_property: Optional connector property with a hint for 830 * the position of the output on the host's screen. 831 */ 832 struct drm_property *suggested_y_property; 833 834 /** 835 * @non_desktop_property: Optional connector property with a hint 836 * that device isn't a standard display, and the console/desktop, 837 * should not be displayed on it. 838 */ 839 struct drm_property *non_desktop_property; 840 841 /** 842 * @panel_orientation_property: Optional connector property indicating 843 * how the lcd-panel is mounted inside the casing (e.g. normal or 844 * upside-down). 845 */ 846 struct drm_property *panel_orientation_property; 847 848 /** 849 * @writeback_fb_id_property: Property for writeback connectors, storing 850 * the ID of the output framebuffer. 851 * See also: drm_writeback_connector_init() 852 */ 853 struct drm_property *writeback_fb_id_property; 854 855 /** 856 * @writeback_pixel_formats_property: Property for writeback connectors, 857 * storing an array of the supported pixel formats for the writeback 858 * engine (read-only). 859 * See also: drm_writeback_connector_init() 860 */ 861 struct drm_property *writeback_pixel_formats_property; 862 /** 863 * @writeback_out_fence_ptr_property: Property for writeback connectors, 864 * fd pointer representing the outgoing fences for a writeback 865 * connector. Userspace should provide a pointer to a value of type s32, 866 * and then cast that pointer to u64. 867 * See also: drm_writeback_connector_init() 868 */ 869 struct drm_property *writeback_out_fence_ptr_property; 870 871 /** 872 * @hdr_output_metadata_property: Connector property containing hdr 873 * metatada. This will be provided by userspace compositors based 874 * on HDR content 875 */ 876 struct drm_property *hdr_output_metadata_property; 877 878 /** 879 * @content_protection_property: DRM ENUM property for content 880 * protection. See drm_connector_attach_content_protection_property(). 881 */ 882 struct drm_property *content_protection_property; 883 884 /** 885 * @hdcp_content_type_property: DRM ENUM property for type of 886 * Protected Content. 887 */ 888 struct drm_property *hdcp_content_type_property; 889 890 /* dumb ioctl parameters */ 891 uint32_t preferred_depth, prefer_shadow; 892 893 /** 894 * @quirk_addfb_prefer_xbgr_30bpp: 895 * 896 * Special hack for legacy ADDFB to keep nouveau userspace happy. Should 897 * only ever be set by the nouveau kernel driver. 898 */ 899 bool quirk_addfb_prefer_xbgr_30bpp; 900 901 /** 902 * @quirk_addfb_prefer_host_byte_order: 903 * 904 * When set to true drm_mode_addfb() will pick host byte order 905 * pixel_format when calling drm_mode_addfb2(). This is how 906 * drm_mode_addfb() should have worked from day one. It 907 * didn't though, so we ended up with quirks in both kernel 908 * and userspace drivers to deal with the broken behavior. 909 * Simply fixing drm_mode_addfb() unconditionally would break 910 * these drivers, so add a quirk bit here to allow drivers 911 * opt-in. 912 */ 913 bool quirk_addfb_prefer_host_byte_order; 914 915 /** 916 * @async_page_flip: Does this device support async flips on the primary 917 * plane? 918 */ 919 bool async_page_flip; 920 921 /** 922 * @fb_modifiers_not_supported: 923 * 924 * When this flag is set, the DRM device will not expose modifier 925 * support to userspace. This is only used by legacy drivers that infer 926 * the buffer layout through heuristics without using modifiers. New 927 * drivers shall not set fhis flag. 928 */ 929 bool fb_modifiers_not_supported; 930 931 /** 932 * @normalize_zpos: 933 * 934 * If true the drm core will call drm_atomic_normalize_zpos() as part of 935 * atomic mode checking from drm_atomic_helper_check() 936 */ 937 bool normalize_zpos; 938 939 /** 940 * @modifiers_property: Plane property to list support modifier/format 941 * combination. 942 */ 943 struct drm_property *modifiers_property; 944 945 /* cursor size */ 946 uint32_t cursor_width, cursor_height; 947 948 /** 949 * @suspend_state: 950 * 951 * Atomic state when suspended. 952 * Set by drm_mode_config_helper_suspend() and cleared by 953 * drm_mode_config_helper_resume(). 954 */ 955 struct drm_atomic_state *suspend_state; 956 957 const struct drm_mode_config_helper_funcs *helper_private; 958 }; 959 960 int __must_check drmm_mode_config_init(struct drm_device *dev); 961 962 /** 963 * drm_mode_config_init - DRM mode_configuration structure initialization 964 * @dev: DRM device 965 * 966 * This is the unmanaged version of drmm_mode_config_init() for drivers which 967 * still explicitly call drm_mode_config_cleanup(). 968 * 969 * FIXME: This function is deprecated and drivers should be converted over to 970 * drmm_mode_config_init(). 971 */ 972 static inline int drm_mode_config_init(struct drm_device *dev) 973 { 974 return drmm_mode_config_init(dev); 975 } 976 977 void drm_mode_config_reset(struct drm_device *dev); 978 void drm_mode_config_cleanup(struct drm_device *dev); 979 980 #endif 981