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_CONNECTOR_H__ 24 #define __DRM_CONNECTOR_H__ 25 26 #include <linux/list.h> 27 #include <linux/llist.h> 28 #include <linux/ctype.h> 29 #include <linux/hdmi.h> 30 #include <drm/drm_mode_object.h> 31 #include <drm/drm_util.h> 32 33 #include <uapi/drm/drm_mode.h> 34 35 struct drm_connector_helper_funcs; 36 struct drm_modeset_acquire_ctx; 37 struct drm_device; 38 struct drm_crtc; 39 struct drm_encoder; 40 struct drm_property; 41 struct drm_property_blob; 42 struct drm_printer; 43 struct edid; 44 45 enum drm_connector_force { 46 DRM_FORCE_UNSPECIFIED, 47 DRM_FORCE_OFF, 48 DRM_FORCE_ON, /* force on analog part normally */ 49 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ 50 }; 51 52 /** 53 * enum drm_connector_status - status for a &drm_connector 54 * 55 * This enum is used to track the connector status. There are no separate 56 * #defines for the uapi! 57 */ 58 enum drm_connector_status { 59 /** 60 * @connector_status_connected: The connector is definitely connected to 61 * a sink device, and can be enabled. 62 */ 63 connector_status_connected = 1, 64 /** 65 * @connector_status_disconnected: The connector isn't connected to a 66 * sink device which can be autodetect. For digital outputs like DP or 67 * HDMI (which can be realiable probed) this means there's really 68 * nothing there. It is driver-dependent whether a connector with this 69 * status can be lit up or not. 70 */ 71 connector_status_disconnected = 2, 72 /** 73 * @connector_status_unknown: The connector's status could not be 74 * reliably detected. This happens when probing would either cause 75 * flicker (like load-detection when the connector is in use), or when a 76 * hardware resource isn't available (like when load-detection needs a 77 * free CRTC). It should be possible to light up the connector with one 78 * of the listed fallback modes. For default configuration userspace 79 * should only try to light up connectors with unknown status when 80 * there's not connector with @connector_status_connected. 81 */ 82 connector_status_unknown = 3, 83 }; 84 85 /** 86 * enum drm_connector_registration_status - userspace registration status for 87 * a &drm_connector 88 * 89 * This enum is used to track the status of initializing a connector and 90 * registering it with userspace, so that DRM can prevent bogus modesets on 91 * connectors that no longer exist. 92 */ 93 enum drm_connector_registration_state { 94 /** 95 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created, 96 * but has yet to be exposed to userspace. There should be no 97 * additional restrictions to how the state of this connector may be 98 * modified. 99 */ 100 DRM_CONNECTOR_INITIALIZING = 0, 101 102 /** 103 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized 104 * and registered with sysfs, as such it has been exposed to 105 * userspace. There should be no additional restrictions to how the 106 * state of this connector may be modified. 107 */ 108 DRM_CONNECTOR_REGISTERED = 1, 109 110 /** 111 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed 112 * to userspace and has since been unregistered and removed from 113 * userspace, or the connector was unregistered before it had a chance 114 * to be exposed to userspace (e.g. still in the 115 * @DRM_CONNECTOR_INITIALIZING state). When a connector is 116 * unregistered, there are additional restrictions to how its state 117 * may be modified: 118 * 119 * - An unregistered connector may only have its DPMS changed from 120 * On->Off. Once DPMS is changed to Off, it may not be switched back 121 * to On. 122 * - Modesets are not allowed on unregistered connectors, unless they 123 * would result in disabling its assigned CRTCs. This means 124 * disabling a CRTC on an unregistered connector is OK, but enabling 125 * one is not. 126 * - Removing a CRTC from an unregistered connector is OK, but new 127 * CRTCs may never be assigned to an unregistered connector. 128 */ 129 DRM_CONNECTOR_UNREGISTERED = 2, 130 }; 131 132 enum subpixel_order { 133 SubPixelUnknown = 0, 134 SubPixelHorizontalRGB, 135 SubPixelHorizontalBGR, 136 SubPixelVerticalRGB, 137 SubPixelVerticalBGR, 138 SubPixelNone, 139 140 }; 141 142 /** 143 * struct drm_scrambling: sink's scrambling support. 144 */ 145 struct drm_scrambling { 146 /** 147 * @supported: scrambling supported for rates > 340 Mhz. 148 */ 149 bool supported; 150 /** 151 * @low_rates: scrambling supported for rates <= 340 Mhz. 152 */ 153 bool low_rates; 154 }; 155 156 /* 157 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink 158 * 159 * Provides SCDC register support and capabilities related information on a 160 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0. 161 */ 162 struct drm_scdc { 163 /** 164 * @supported: status control & data channel present. 165 */ 166 bool supported; 167 /** 168 * @read_request: sink is capable of generating scdc read request. 169 */ 170 bool read_request; 171 /** 172 * @scrambling: sink's scrambling capabilities 173 */ 174 struct drm_scrambling scrambling; 175 }; 176 177 178 /** 179 * struct drm_hdmi_info - runtime information about the connected HDMI sink 180 * 181 * Describes if a given display supports advanced HDMI 2.0 features. 182 * This information is available in CEA-861-F extension blocks (like HF-VSDB). 183 */ 184 struct drm_hdmi_info { 185 /** @scdc: sink's scdc support and capabilities */ 186 struct drm_scdc scdc; 187 188 /** 189 * @y420_vdb_modes: bitmap of modes which can support ycbcr420 190 * output only (not normal RGB/YCBCR444/422 outputs). There are total 191 * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map 192 * upto 128 VICs; 193 */ 194 unsigned long y420_vdb_modes[BITS_TO_LONGS(128)]; 195 196 /** 197 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420 198 * output also, along with normal HDMI outputs. There are total 107 199 * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto 200 * 128 VICs; 201 */ 202 unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)]; 203 204 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */ 205 u64 y420_cmdb_map; 206 207 /** @y420_dc_modes: bitmap of deep color support index */ 208 u8 y420_dc_modes; 209 }; 210 211 /** 212 * enum drm_link_status - connector's link_status property value 213 * 214 * This enum is used as the connector's link status property value. 215 * It is set to the values defined in uapi. 216 * 217 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful 218 * link training 219 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training 220 * failure 221 */ 222 enum drm_link_status { 223 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD, 224 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD, 225 }; 226 227 /** 228 * enum drm_panel_orientation - panel_orientation info for &drm_display_info 229 * 230 * This enum is used to track the (LCD) panel orientation. There are no 231 * separate #defines for the uapi! 232 * 233 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any 234 * panel orientation information (normal 235 * for non panels) in this case the "panel 236 * orientation" connector prop will not be 237 * attached. 238 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the 239 * top side of the device's casing. 240 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the 241 * bottom side of the device's casing, iow 242 * the panel is mounted upside-down. 243 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the 244 * top side of the device's casing. 245 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the 246 * top side of the device's casing. 247 */ 248 enum drm_panel_orientation { 249 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1, 250 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0, 251 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, 252 DRM_MODE_PANEL_ORIENTATION_LEFT_UP, 253 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, 254 }; 255 256 /** 257 * struct drm_display_info - runtime data about the connected sink 258 * 259 * Describes a given display (e.g. CRT or flat panel) and its limitations. For 260 * fixed display sinks like built-in panels there's not much difference between 261 * this and &struct drm_connector. But for sinks with a real cable this 262 * structure is meant to describe all the things at the other end of the cable. 263 * 264 * For sinks which provide an EDID this can be filled out by calling 265 * drm_add_edid_modes(). 266 */ 267 struct drm_display_info { 268 /** 269 * @name: Name of the display. 270 */ 271 char name[DRM_DISPLAY_INFO_LEN]; 272 273 /** 274 * @width_mm: Physical width in mm. 275 */ 276 unsigned int width_mm; 277 /** 278 * @height_mm: Physical height in mm. 279 */ 280 unsigned int height_mm; 281 282 /** 283 * @pixel_clock: Maximum pixel clock supported by the sink, in units of 284 * 100Hz. This mismatches the clock in &drm_display_mode (which is in 285 * kHZ), because that's what the EDID uses as base unit. 286 */ 287 unsigned int pixel_clock; 288 /** 289 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs. 290 */ 291 unsigned int bpc; 292 293 /** 294 * @subpixel_order: Subpixel order of LCD panels. 295 */ 296 enum subpixel_order subpixel_order; 297 298 #define DRM_COLOR_FORMAT_RGB444 (1<<0) 299 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1) 300 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2) 301 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3) 302 303 /** 304 * @panel_orientation: Read only connector property for built-in panels, 305 * indicating the orientation of the panel vs the device's casing. 306 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN. 307 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the 308 * fb to compensate and gets exported as prop to userspace. 309 */ 310 int panel_orientation; 311 312 /** 313 * @color_formats: HDMI Color formats, selects between RGB and YCrCb 314 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones 315 * as used to describe the pixel format in framebuffers, and also don't 316 * match the formats in @bus_formats which are shared with v4l. 317 */ 318 u32 color_formats; 319 320 /** 321 * @bus_formats: Pixel data format on the wire, somewhat redundant with 322 * @color_formats. Array of size @num_bus_formats encoded using 323 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers. 324 */ 325 const u32 *bus_formats; 326 /** 327 * @num_bus_formats: Size of @bus_formats array. 328 */ 329 unsigned int num_bus_formats; 330 331 #define DRM_BUS_FLAG_DE_LOW (1<<0) 332 #define DRM_BUS_FLAG_DE_HIGH (1<<1) 333 /* drive data on pos. edge */ 334 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2) 335 /* drive data on neg. edge */ 336 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3) 337 /* data is transmitted MSB to LSB on the bus */ 338 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4) 339 /* data is transmitted LSB to MSB on the bus */ 340 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5) 341 /* drive sync on pos. edge */ 342 #define DRM_BUS_FLAG_SYNC_POSEDGE (1<<6) 343 /* drive sync on neg. edge */ 344 #define DRM_BUS_FLAG_SYNC_NEGEDGE (1<<7) 345 346 /** 347 * @bus_flags: Additional information (like pixel signal polarity) for 348 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines. 349 */ 350 u32 bus_flags; 351 352 /** 353 * @max_tmds_clock: Maximum TMDS clock rate supported by the 354 * sink in kHz. 0 means undefined. 355 */ 356 int max_tmds_clock; 357 358 /** 359 * @dvi_dual: Dual-link DVI sink? 360 */ 361 bool dvi_dual; 362 363 /** 364 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe? 365 */ 366 bool has_hdmi_infoframe; 367 368 /** 369 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even 370 * more stuff redundant with @bus_formats. 371 */ 372 u8 edid_hdmi_dc_modes; 373 374 /** 375 * @cea_rev: CEA revision of the HDMI sink. 376 */ 377 u8 cea_rev; 378 379 /** 380 * @hdmi: advance features of a HDMI sink. 381 */ 382 struct drm_hdmi_info hdmi; 383 384 /** 385 * @non_desktop: Non desktop display (HMD). 386 */ 387 bool non_desktop; 388 }; 389 390 int drm_display_info_set_bus_formats(struct drm_display_info *info, 391 const u32 *formats, 392 unsigned int num_formats); 393 394 /** 395 * struct drm_tv_connector_state - TV connector related states 396 * @subconnector: selected subconnector 397 * @margins: margins 398 * @margins.left: left margin 399 * @margins.right: right margin 400 * @margins.top: top margin 401 * @margins.bottom: bottom margin 402 * @mode: TV mode 403 * @brightness: brightness in percent 404 * @contrast: contrast in percent 405 * @flicker_reduction: flicker reduction in percent 406 * @overscan: overscan in percent 407 * @saturation: saturation in percent 408 * @hue: hue in percent 409 */ 410 struct drm_tv_connector_state { 411 enum drm_mode_subconnector subconnector; 412 struct { 413 unsigned int left; 414 unsigned int right; 415 unsigned int top; 416 unsigned int bottom; 417 } margins; 418 unsigned int mode; 419 unsigned int brightness; 420 unsigned int contrast; 421 unsigned int flicker_reduction; 422 unsigned int overscan; 423 unsigned int saturation; 424 unsigned int hue; 425 }; 426 427 /** 428 * struct drm_connector_state - mutable connector state 429 */ 430 struct drm_connector_state { 431 /** @connector: backpointer to the connector */ 432 struct drm_connector *connector; 433 434 /** 435 * @crtc: CRTC to connect connector to, NULL if disabled. 436 * 437 * Do not change this directly, use drm_atomic_set_crtc_for_connector() 438 * instead. 439 */ 440 struct drm_crtc *crtc; 441 442 /** 443 * @best_encoder: 444 * 445 * Used by the atomic helpers to select the encoder, through the 446 * &drm_connector_helper_funcs.atomic_best_encoder or 447 * &drm_connector_helper_funcs.best_encoder callbacks. 448 */ 449 struct drm_encoder *best_encoder; 450 451 /** 452 * @link_status: Connector link_status to keep track of whether link is 453 * GOOD or BAD to notify userspace if retraining is necessary. 454 */ 455 enum drm_link_status link_status; 456 457 /** @state: backpointer to global drm_atomic_state */ 458 struct drm_atomic_state *state; 459 460 /** 461 * @commit: Tracks the pending commit to prevent use-after-free conditions. 462 * 463 * Is only set when @crtc is NULL. 464 */ 465 struct drm_crtc_commit *commit; 466 467 /** @tv: TV connector state */ 468 struct drm_tv_connector_state tv; 469 470 /** 471 * @picture_aspect_ratio: Connector property to control the 472 * HDMI infoframe aspect ratio setting. 473 * 474 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the 475 * values for &enum hdmi_picture_aspect 476 */ 477 enum hdmi_picture_aspect picture_aspect_ratio; 478 479 /** 480 * @content_type: Connector property to control the 481 * HDMI infoframe content type setting. 482 * The %DRM_MODE_CONTENT_TYPE_\* values much 483 * match the values. 484 */ 485 unsigned int content_type; 486 487 /** 488 * @scaling_mode: Connector property to control the 489 * upscaling, mostly used for built-in panels. 490 */ 491 unsigned int scaling_mode; 492 493 /** 494 * @content_protection: Connector property to request content 495 * protection. This is most commonly used for HDCP. 496 */ 497 unsigned int content_protection; 498 499 /** 500 * @writeback_job: Writeback job for writeback connectors 501 * 502 * Holds the framebuffer and out-fence for a writeback connector. As 503 * the writeback completion may be asynchronous to the normal commit 504 * cycle, the writeback job lifetime is managed separately from the 505 * normal atomic state by this object. 506 * 507 * See also: drm_writeback_queue_job() and 508 * drm_writeback_signal_completion() 509 */ 510 struct drm_writeback_job *writeback_job; 511 }; 512 513 /** 514 * struct drm_connector_funcs - control connectors on a given device 515 * 516 * Each CRTC may have one or more connectors attached to it. The functions 517 * below allow the core DRM code to control connectors, enumerate available modes, 518 * etc. 519 */ 520 struct drm_connector_funcs { 521 /** 522 * @dpms: 523 * 524 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS 525 * is exposed as a standard property on the connector, but diverted to 526 * this callback in the drm core. Note that atomic drivers don't 527 * implement the 4 level DPMS support on the connector any more, but 528 * instead only have an on/off "ACTIVE" property on the CRTC object. 529 * 530 * This hook is not used by atomic drivers, remapping of the legacy DPMS 531 * property is entirely handled in the DRM core. 532 * 533 * RETURNS: 534 * 535 * 0 on success or a negative error code on failure. 536 */ 537 int (*dpms)(struct drm_connector *connector, int mode); 538 539 /** 540 * @reset: 541 * 542 * Reset connector hardware and software state to off. This function isn't 543 * called by the core directly, only through drm_mode_config_reset(). 544 * It's not a helper hook only for historical reasons. 545 * 546 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset 547 * atomic state using this hook. 548 */ 549 void (*reset)(struct drm_connector *connector); 550 551 /** 552 * @detect: 553 * 554 * Check to see if anything is attached to the connector. The parameter 555 * force is set to false whilst polling, true when checking the 556 * connector due to a user request. force can be used by the driver to 557 * avoid expensive, destructive operations during automated probing. 558 * 559 * This callback is optional, if not implemented the connector will be 560 * considered as always being attached. 561 * 562 * FIXME: 563 * 564 * Note that this hook is only called by the probe helper. It's not in 565 * the helper library vtable purely for historical reasons. The only DRM 566 * core entry point to probe connector state is @fill_modes. 567 * 568 * Note that the helper library will already hold 569 * &drm_mode_config.connection_mutex. Drivers which need to grab additional 570 * locks to avoid races with concurrent modeset changes need to use 571 * &drm_connector_helper_funcs.detect_ctx instead. 572 * 573 * RETURNS: 574 * 575 * drm_connector_status indicating the connector's status. 576 */ 577 enum drm_connector_status (*detect)(struct drm_connector *connector, 578 bool force); 579 580 /** 581 * @force: 582 * 583 * This function is called to update internal encoder state when the 584 * connector is forced to a certain state by userspace, either through 585 * the sysfs interfaces or on the kernel cmdline. In that case the 586 * @detect callback isn't called. 587 * 588 * FIXME: 589 * 590 * Note that this hook is only called by the probe helper. It's not in 591 * the helper library vtable purely for historical reasons. The only DRM 592 * core entry point to probe connector state is @fill_modes. 593 */ 594 void (*force)(struct drm_connector *connector); 595 596 /** 597 * @fill_modes: 598 * 599 * Entry point for output detection and basic mode validation. The 600 * driver should reprobe the output if needed (e.g. when hotplug 601 * handling is unreliable), add all detected modes to &drm_connector.modes 602 * and filter out any the device can't support in any configuration. It 603 * also needs to filter out any modes wider or higher than the 604 * parameters max_width and max_height indicate. 605 * 606 * The drivers must also prune any modes no longer valid from 607 * &drm_connector.modes. Furthermore it must update 608 * &drm_connector.status and &drm_connector.edid. If no EDID has been 609 * received for this output connector->edid must be NULL. 610 * 611 * Drivers using the probe helpers should use 612 * drm_helper_probe_single_connector_modes() to implement this 613 * function. 614 * 615 * RETURNS: 616 * 617 * The number of modes detected and filled into &drm_connector.modes. 618 */ 619 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); 620 621 /** 622 * @set_property: 623 * 624 * This is the legacy entry point to update a property attached to the 625 * connector. 626 * 627 * This callback is optional if the driver does not support any legacy 628 * driver-private properties. For atomic drivers it is not used because 629 * property handling is done entirely in the DRM core. 630 * 631 * RETURNS: 632 * 633 * 0 on success or a negative error code on failure. 634 */ 635 int (*set_property)(struct drm_connector *connector, struct drm_property *property, 636 uint64_t val); 637 638 /** 639 * @late_register: 640 * 641 * This optional hook can be used to register additional userspace 642 * interfaces attached to the connector, light backlight control, i2c, 643 * DP aux or similar interfaces. It is called late in the driver load 644 * sequence from drm_connector_register() when registering all the 645 * core drm connector interfaces. Everything added from this callback 646 * should be unregistered in the early_unregister callback. 647 * 648 * This is called while holding &drm_connector.mutex. 649 * 650 * Returns: 651 * 652 * 0 on success, or a negative error code on failure. 653 */ 654 int (*late_register)(struct drm_connector *connector); 655 656 /** 657 * @early_unregister: 658 * 659 * This optional hook should be used to unregister the additional 660 * userspace interfaces attached to the connector from 661 * late_register(). It is called from drm_connector_unregister(), 662 * early in the driver unload sequence to disable userspace access 663 * before data structures are torndown. 664 * 665 * This is called while holding &drm_connector.mutex. 666 */ 667 void (*early_unregister)(struct drm_connector *connector); 668 669 /** 670 * @destroy: 671 * 672 * Clean up connector resources. This is called at driver unload time 673 * through drm_mode_config_cleanup(). It can also be called at runtime 674 * when a connector is being hot-unplugged for drivers that support 675 * connector hotplugging (e.g. DisplayPort MST). 676 */ 677 void (*destroy)(struct drm_connector *connector); 678 679 /** 680 * @atomic_duplicate_state: 681 * 682 * Duplicate the current atomic state for this connector and return it. 683 * The core and helpers guarantee that any atomic state duplicated with 684 * this hook and still owned by the caller (i.e. not transferred to the 685 * driver by calling &drm_mode_config_funcs.atomic_commit) will be 686 * cleaned up by calling the @atomic_destroy_state hook in this 687 * structure. 688 * 689 * This callback is mandatory for atomic drivers. 690 * 691 * Atomic drivers which don't subclass &struct drm_connector_state should use 692 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the 693 * state structure to extend it with driver-private state should use 694 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is 695 * duplicated in a consistent fashion across drivers. 696 * 697 * It is an error to call this hook before &drm_connector.state has been 698 * initialized correctly. 699 * 700 * NOTE: 701 * 702 * If the duplicate state references refcounted resources this hook must 703 * acquire a reference for each of them. The driver must release these 704 * references again in @atomic_destroy_state. 705 * 706 * RETURNS: 707 * 708 * Duplicated atomic state or NULL when the allocation failed. 709 */ 710 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector); 711 712 /** 713 * @atomic_destroy_state: 714 * 715 * Destroy a state duplicated with @atomic_duplicate_state and release 716 * or unreference all resources it references 717 * 718 * This callback is mandatory for atomic drivers. 719 */ 720 void (*atomic_destroy_state)(struct drm_connector *connector, 721 struct drm_connector_state *state); 722 723 /** 724 * @atomic_set_property: 725 * 726 * Decode a driver-private property value and store the decoded value 727 * into the passed-in state structure. Since the atomic core decodes all 728 * standardized properties (even for extensions beyond the core set of 729 * properties which might not be implemented by all drivers) this 730 * requires drivers to subclass the state structure. 731 * 732 * Such driver-private properties should really only be implemented for 733 * truly hardware/vendor specific state. Instead it is preferred to 734 * standardize atomic extension and decode the properties used to expose 735 * such an extension in the core. 736 * 737 * Do not call this function directly, use 738 * drm_atomic_connector_set_property() instead. 739 * 740 * This callback is optional if the driver does not support any 741 * driver-private atomic properties. 742 * 743 * NOTE: 744 * 745 * This function is called in the state assembly phase of atomic 746 * modesets, which can be aborted for any reason (including on 747 * userspace's request to just check whether a configuration would be 748 * possible). Drivers MUST NOT touch any persistent state (hardware or 749 * software) or data structures except the passed in @state parameter. 750 * 751 * Also since userspace controls in which order properties are set this 752 * function must not do any input validation (since the state update is 753 * incomplete and hence likely inconsistent). Instead any such input 754 * validation must be done in the various atomic_check callbacks. 755 * 756 * RETURNS: 757 * 758 * 0 if the property has been found, -EINVAL if the property isn't 759 * implemented by the driver (which shouldn't ever happen, the core only 760 * asks for properties attached to this connector). No other validation 761 * is allowed by the driver. The core already checks that the property 762 * value is within the range (integer, valid enum value, ...) the driver 763 * set when registering the property. 764 */ 765 int (*atomic_set_property)(struct drm_connector *connector, 766 struct drm_connector_state *state, 767 struct drm_property *property, 768 uint64_t val); 769 770 /** 771 * @atomic_get_property: 772 * 773 * Reads out the decoded driver-private property. This is used to 774 * implement the GETCONNECTOR IOCTL. 775 * 776 * Do not call this function directly, use 777 * drm_atomic_connector_get_property() instead. 778 * 779 * This callback is optional if the driver does not support any 780 * driver-private atomic properties. 781 * 782 * RETURNS: 783 * 784 * 0 on success, -EINVAL if the property isn't implemented by the 785 * driver (which shouldn't ever happen, the core only asks for 786 * properties attached to this connector). 787 */ 788 int (*atomic_get_property)(struct drm_connector *connector, 789 const struct drm_connector_state *state, 790 struct drm_property *property, 791 uint64_t *val); 792 793 /** 794 * @atomic_print_state: 795 * 796 * If driver subclasses &struct drm_connector_state, it should implement 797 * this optional hook for printing additional driver specific state. 798 * 799 * Do not call this directly, use drm_atomic_connector_print_state() 800 * instead. 801 */ 802 void (*atomic_print_state)(struct drm_printer *p, 803 const struct drm_connector_state *state); 804 }; 805 806 /* mode specified on the command line */ 807 struct drm_cmdline_mode { 808 bool specified; 809 bool refresh_specified; 810 bool bpp_specified; 811 int xres, yres; 812 int bpp; 813 int refresh; 814 bool rb; 815 bool interlace; 816 bool cvt; 817 bool margins; 818 enum drm_connector_force force; 819 }; 820 821 /** 822 * struct drm_connector - central DRM connector control structure 823 * 824 * Each connector may be connected to one or more CRTCs, or may be clonable by 825 * another connector if they can share a CRTC. Each connector also has a specific 826 * position in the broader display (referred to as a 'screen' though it could 827 * span multiple monitors). 828 */ 829 struct drm_connector { 830 /** @dev: parent DRM device */ 831 struct drm_device *dev; 832 /** @kdev: kernel device for sysfs attributes */ 833 struct device *kdev; 834 /** @attr: sysfs attributes */ 835 struct device_attribute *attr; 836 837 /** 838 * @head: 839 * 840 * List of all connectors on a @dev, linked from 841 * &drm_mode_config.connector_list. Protected by 842 * &drm_mode_config.connector_list_lock, but please only use 843 * &drm_connector_list_iter to walk this list. 844 */ 845 struct list_head head; 846 847 /** @base: base KMS object */ 848 struct drm_mode_object base; 849 850 /** @name: human readable name, can be overwritten by the driver */ 851 char *name; 852 853 /** 854 * @mutex: Lock for general connector state, but currently only protects 855 * @registered. Most of the connector state is still protected by 856 * &drm_mode_config.mutex. 857 */ 858 struct mutex mutex; 859 860 /** 861 * @index: Compacted connector index, which matches the position inside 862 * the mode_config.list for drivers not supporting hot-add/removing. Can 863 * be used as an array index. It is invariant over the lifetime of the 864 * connector. 865 */ 866 unsigned index; 867 868 /** 869 * @connector_type: 870 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 871 */ 872 int connector_type; 873 /** @connector_type_id: index into connector type enum */ 874 int connector_type_id; 875 /** 876 * @interlace_allowed: 877 * Can this connector handle interlaced modes? Only used by 878 * drm_helper_probe_single_connector_modes() for mode filtering. 879 */ 880 bool interlace_allowed; 881 /** 882 * @doublescan_allowed: 883 * Can this connector handle doublescan? Only used by 884 * drm_helper_probe_single_connector_modes() for mode filtering. 885 */ 886 bool doublescan_allowed; 887 /** 888 * @stereo_allowed: 889 * Can this connector handle stereo modes? Only used by 890 * drm_helper_probe_single_connector_modes() for mode filtering. 891 */ 892 bool stereo_allowed; 893 894 /** 895 * @ycbcr_420_allowed : This bool indicates if this connector is 896 * capable of handling YCBCR 420 output. While parsing the EDID 897 * blocks, its very helpful to know, if the source is capable of 898 * handling YCBCR 420 outputs. 899 */ 900 bool ycbcr_420_allowed; 901 902 /** 903 * @registration_state: Is this connector initializing, exposed 904 * (registered) with userspace, or unregistered? 905 * 906 * Protected by @mutex. 907 */ 908 enum drm_connector_registration_state registration_state; 909 910 /** 911 * @modes: 912 * Modes available on this connector (from fill_modes() + user). 913 * Protected by &drm_mode_config.mutex. 914 */ 915 struct list_head modes; 916 917 /** 918 * @status: 919 * One of the drm_connector_status enums (connected, not, or unknown). 920 * Protected by &drm_mode_config.mutex. 921 */ 922 enum drm_connector_status status; 923 924 /** 925 * @probed_modes: 926 * These are modes added by probing with DDC or the BIOS, before 927 * filtering is applied. Used by the probe helpers. Protected by 928 * &drm_mode_config.mutex. 929 */ 930 struct list_head probed_modes; 931 932 /** 933 * @display_info: Display information is filled from EDID information 934 * when a display is detected. For non hot-pluggable displays such as 935 * flat panels in embedded systems, the driver should initialize the 936 * &drm_display_info.width_mm and &drm_display_info.height_mm fields 937 * with the physical size of the display. 938 * 939 * Protected by &drm_mode_config.mutex. 940 */ 941 struct drm_display_info display_info; 942 943 /** @funcs: connector control functions */ 944 const struct drm_connector_funcs *funcs; 945 946 /** 947 * @edid_blob_ptr: DRM property containing EDID if present. Protected by 948 * &drm_mode_config.mutex. This should be updated only by calling 949 * drm_connector_update_edid_property(). 950 */ 951 struct drm_property_blob *edid_blob_ptr; 952 953 /** @properties: property tracking for this connector */ 954 struct drm_object_properties properties; 955 956 /** 957 * @scaling_mode_property: Optional atomic property to control the 958 * upscaling. See drm_connector_attach_content_protection_property(). 959 */ 960 struct drm_property *scaling_mode_property; 961 962 /** 963 * @content_protection_property: DRM ENUM property for content 964 * protection. See drm_connector_attach_content_protection_property(). 965 */ 966 struct drm_property *content_protection_property; 967 968 /** 969 * @path_blob_ptr: 970 * 971 * DRM blob property data for the DP MST path property. This should only 972 * be updated by calling drm_connector_set_path_property(). 973 */ 974 struct drm_property_blob *path_blob_ptr; 975 976 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 977 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 978 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 979 980 /** 981 * @polled: 982 * 983 * Connector polling mode, a combination of 984 * 985 * DRM_CONNECTOR_POLL_HPD 986 * The connector generates hotplug events and doesn't need to be 987 * periodically polled. The CONNECT and DISCONNECT flags must not 988 * be set together with the HPD flag. 989 * 990 * DRM_CONNECTOR_POLL_CONNECT 991 * Periodically poll the connector for connection. 992 * 993 * DRM_CONNECTOR_POLL_DISCONNECT 994 * Periodically poll the connector for disconnection, without 995 * causing flickering even when the connector is in use. DACs should 996 * rarely do this without a lot of testing. 997 * 998 * Set to 0 for connectors that don't support connection status 999 * discovery. 1000 */ 1001 uint8_t polled; 1002 1003 /** 1004 * @dpms: Current dpms state. For legacy drivers the 1005 * &drm_connector_funcs.dpms callback must update this. For atomic 1006 * drivers, this is handled by the core atomic code, and drivers must 1007 * only take &drm_crtc_state.active into account. 1008 */ 1009 int dpms; 1010 1011 /** @helper_private: mid-layer private data */ 1012 const struct drm_connector_helper_funcs *helper_private; 1013 1014 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */ 1015 struct drm_cmdline_mode cmdline_mode; 1016 /** @force: a DRM_FORCE_<foo> state for forced mode sets */ 1017 enum drm_connector_force force; 1018 /** @override_edid: has the EDID been overwritten through debugfs for testing? */ 1019 bool override_edid; 1020 1021 #define DRM_CONNECTOR_MAX_ENCODER 3 1022 /** 1023 * @encoder_ids: Valid encoders for this connector. Please only use 1024 * drm_connector_for_each_possible_encoder() to enumerate these. 1025 */ 1026 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; 1027 1028 /** 1029 * @encoder: Currently bound encoder driving this connector, if any. 1030 * Only really meaningful for non-atomic drivers. Atomic drivers should 1031 * instead look at &drm_connector_state.best_encoder, and in case they 1032 * need the CRTC driving this output, &drm_connector_state.crtc. 1033 */ 1034 struct drm_encoder *encoder; 1035 1036 #define MAX_ELD_BYTES 128 1037 /** @eld: EDID-like data, if present */ 1038 uint8_t eld[MAX_ELD_BYTES]; 1039 /** @latency_present: AV delay info from ELD, if found */ 1040 bool latency_present[2]; 1041 /** 1042 * @video_latency: Video latency info from ELD, if found. 1043 * [0]: progressive, [1]: interlaced 1044 */ 1045 int video_latency[2]; 1046 /** 1047 * @audio_latency: audio latency info from ELD, if found 1048 * [0]: progressive, [1]: interlaced 1049 */ 1050 int audio_latency[2]; 1051 /** 1052 * @null_edid_counter: track sinks that give us all zeros for the EDID. 1053 * Needed to workaround some HW bugs where we get all 0s 1054 */ 1055 int null_edid_counter; 1056 1057 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */ 1058 unsigned bad_edid_counter; 1059 1060 /** 1061 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used 1062 * in Displayport compliance testing - Displayport Link CTS Core 1.2 1063 * rev1.1 4.2.2.6 1064 */ 1065 bool edid_corrupt; 1066 1067 /** @debugfs_entry: debugfs directory for this connector */ 1068 struct dentry *debugfs_entry; 1069 1070 /** 1071 * @state: 1072 * 1073 * Current atomic state for this connector. 1074 * 1075 * This is protected by &drm_mode_config.connection_mutex. Note that 1076 * nonblocking atomic commits access the current connector state without 1077 * taking locks. Either by going through the &struct drm_atomic_state 1078 * pointers, see for_each_oldnew_connector_in_state(), 1079 * for_each_old_connector_in_state() and 1080 * for_each_new_connector_in_state(). Or through careful ordering of 1081 * atomic commit operations as implemented in the atomic helpers, see 1082 * &struct drm_crtc_commit. 1083 */ 1084 struct drm_connector_state *state; 1085 1086 /* DisplayID bits. FIXME: Extract into a substruct? */ 1087 1088 /** 1089 * @tile_blob_ptr: 1090 * 1091 * DRM blob property data for the tile property (used mostly by DP MST). 1092 * This is meant for screens which are driven through separate display 1093 * pipelines represented by &drm_crtc, which might not be running with 1094 * genlocked clocks. For tiled panels which are genlocked, like 1095 * dual-link LVDS or dual-link DSI, the driver should try to not expose 1096 * the tiling and virtualize both &drm_crtc and &drm_plane if needed. 1097 * 1098 * This should only be updated by calling 1099 * drm_connector_set_tile_property(). 1100 */ 1101 struct drm_property_blob *tile_blob_ptr; 1102 1103 /** @has_tile: is this connector connected to a tiled monitor */ 1104 bool has_tile; 1105 /** @tile_group: tile group for the connected monitor */ 1106 struct drm_tile_group *tile_group; 1107 /** @tile_is_single_monitor: whether the tile is one monitor housing */ 1108 bool tile_is_single_monitor; 1109 1110 /** @num_h_tile: number of horizontal tiles in the tile group */ 1111 /** @num_v_tile: number of vertical tiles in the tile group */ 1112 uint8_t num_h_tile, num_v_tile; 1113 /** @tile_h_loc: horizontal location of this tile */ 1114 /** @tile_v_loc: vertical location of this tile */ 1115 uint8_t tile_h_loc, tile_v_loc; 1116 /** @tile_h_size: horizontal size of this tile. */ 1117 /** @tile_v_size: vertical size of this tile. */ 1118 uint16_t tile_h_size, tile_v_size; 1119 1120 /** 1121 * @free_node: 1122 * 1123 * List used only by &drm_connector_list_iter to be able to clean up a 1124 * connector from any context, in conjunction with 1125 * &drm_mode_config.connector_free_work. 1126 */ 1127 struct llist_node free_node; 1128 }; 1129 1130 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 1131 1132 int drm_connector_init(struct drm_device *dev, 1133 struct drm_connector *connector, 1134 const struct drm_connector_funcs *funcs, 1135 int connector_type); 1136 int drm_connector_register(struct drm_connector *connector); 1137 void drm_connector_unregister(struct drm_connector *connector); 1138 int drm_connector_attach_encoder(struct drm_connector *connector, 1139 struct drm_encoder *encoder); 1140 1141 void drm_connector_cleanup(struct drm_connector *connector); 1142 1143 static inline unsigned int drm_connector_index(const struct drm_connector *connector) 1144 { 1145 return connector->index; 1146 } 1147 1148 static inline u32 drm_connector_mask(const struct drm_connector *connector) 1149 { 1150 return 1 << connector->index; 1151 } 1152 1153 /** 1154 * drm_connector_lookup - lookup connector object 1155 * @dev: DRM device 1156 * @file_priv: drm file to check for lease against. 1157 * @id: connector object id 1158 * 1159 * This function looks up the connector object specified by id 1160 * add takes a reference to it. 1161 */ 1162 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev, 1163 struct drm_file *file_priv, 1164 uint32_t id) 1165 { 1166 struct drm_mode_object *mo; 1167 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR); 1168 return mo ? obj_to_connector(mo) : NULL; 1169 } 1170 1171 /** 1172 * drm_connector_get - acquire a connector reference 1173 * @connector: DRM connector 1174 * 1175 * This function increments the connector's refcount. 1176 */ 1177 static inline void drm_connector_get(struct drm_connector *connector) 1178 { 1179 drm_mode_object_get(&connector->base); 1180 } 1181 1182 /** 1183 * drm_connector_put - release a connector reference 1184 * @connector: DRM connector 1185 * 1186 * This function decrements the connector's reference count and frees the 1187 * object if the reference count drops to zero. 1188 */ 1189 static inline void drm_connector_put(struct drm_connector *connector) 1190 { 1191 drm_mode_object_put(&connector->base); 1192 } 1193 1194 /** 1195 * drm_connector_reference - acquire a connector reference 1196 * @connector: DRM connector 1197 * 1198 * This is a compatibility alias for drm_connector_get() and should not be 1199 * used by new code. 1200 */ 1201 static inline void drm_connector_reference(struct drm_connector *connector) 1202 { 1203 drm_connector_get(connector); 1204 } 1205 1206 /** 1207 * drm_connector_unreference - release a connector reference 1208 * @connector: DRM connector 1209 * 1210 * This is a compatibility alias for drm_connector_put() and should not be 1211 * used by new code. 1212 */ 1213 static inline void drm_connector_unreference(struct drm_connector *connector) 1214 { 1215 drm_connector_put(connector); 1216 } 1217 1218 /** 1219 * drm_connector_is_unregistered - has the connector been unregistered from 1220 * userspace? 1221 * @connector: DRM connector 1222 * 1223 * Checks whether or not @connector has been unregistered from userspace. 1224 * 1225 * Returns: 1226 * True if the connector was unregistered, false if the connector is 1227 * registered or has not yet been registered with userspace. 1228 */ 1229 static inline bool 1230 drm_connector_is_unregistered(struct drm_connector *connector) 1231 { 1232 return READ_ONCE(connector->registration_state) == 1233 DRM_CONNECTOR_UNREGISTERED; 1234 } 1235 1236 const char *drm_get_connector_status_name(enum drm_connector_status status); 1237 const char *drm_get_subpixel_order_name(enum subpixel_order order); 1238 const char *drm_get_dpms_name(int val); 1239 const char *drm_get_dvi_i_subconnector_name(int val); 1240 const char *drm_get_dvi_i_select_name(int val); 1241 const char *drm_get_tv_subconnector_name(int val); 1242 const char *drm_get_tv_select_name(int val); 1243 const char *drm_get_content_protection_name(int val); 1244 1245 int drm_mode_create_dvi_i_properties(struct drm_device *dev); 1246 int drm_mode_create_tv_properties(struct drm_device *dev, 1247 unsigned int num_modes, 1248 const char * const modes[]); 1249 int drm_mode_create_scaling_mode_property(struct drm_device *dev); 1250 int drm_connector_attach_content_type_property(struct drm_connector *dev); 1251 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector, 1252 u32 scaling_mode_mask); 1253 int drm_connector_attach_content_protection_property( 1254 struct drm_connector *connector); 1255 int drm_mode_create_aspect_ratio_property(struct drm_device *dev); 1256 int drm_mode_create_content_type_property(struct drm_device *dev); 1257 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame, 1258 const struct drm_connector_state *conn_state); 1259 1260 int drm_mode_create_suggested_offset_properties(struct drm_device *dev); 1261 1262 int drm_connector_set_path_property(struct drm_connector *connector, 1263 const char *path); 1264 int drm_connector_set_tile_property(struct drm_connector *connector); 1265 int drm_connector_update_edid_property(struct drm_connector *connector, 1266 const struct edid *edid); 1267 void drm_connector_set_link_status_property(struct drm_connector *connector, 1268 uint64_t link_status); 1269 int drm_connector_init_panel_orientation_property( 1270 struct drm_connector *connector, int width, int height); 1271 1272 /** 1273 * struct drm_tile_group - Tile group metadata 1274 * @refcount: reference count 1275 * @dev: DRM device 1276 * @id: tile group id exposed to userspace 1277 * @group_data: Sink-private data identifying this group 1278 * 1279 * @group_data corresponds to displayid vend/prod/serial for external screens 1280 * with an EDID. 1281 */ 1282 struct drm_tile_group { 1283 struct kref refcount; 1284 struct drm_device *dev; 1285 int id; 1286 u8 group_data[8]; 1287 }; 1288 1289 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev, 1290 char topology[8]); 1291 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev, 1292 char topology[8]); 1293 void drm_mode_put_tile_group(struct drm_device *dev, 1294 struct drm_tile_group *tg); 1295 1296 /** 1297 * struct drm_connector_list_iter - connector_list iterator 1298 * 1299 * This iterator tracks state needed to be able to walk the connector_list 1300 * within struct drm_mode_config. Only use together with 1301 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and 1302 * drm_connector_list_iter_next() respectively the convenience macro 1303 * drm_for_each_connector_iter(). 1304 */ 1305 struct drm_connector_list_iter { 1306 /* private: */ 1307 struct drm_device *dev; 1308 struct drm_connector *conn; 1309 }; 1310 1311 void drm_connector_list_iter_begin(struct drm_device *dev, 1312 struct drm_connector_list_iter *iter); 1313 struct drm_connector * 1314 drm_connector_list_iter_next(struct drm_connector_list_iter *iter); 1315 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter); 1316 1317 bool drm_connector_has_possible_encoder(struct drm_connector *connector, 1318 struct drm_encoder *encoder); 1319 1320 /** 1321 * drm_for_each_connector_iter - connector_list iterator macro 1322 * @connector: &struct drm_connector pointer used as cursor 1323 * @iter: &struct drm_connector_list_iter 1324 * 1325 * Note that @connector is only valid within the list body, if you want to use 1326 * @connector after calling drm_connector_list_iter_end() then you need to grab 1327 * your own reference first using drm_connector_get(). 1328 */ 1329 #define drm_for_each_connector_iter(connector, iter) \ 1330 while ((connector = drm_connector_list_iter_next(iter))) 1331 1332 /** 1333 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders 1334 * @connector: &struct drm_connector pointer 1335 * @encoder: &struct drm_encoder pointer used as cursor 1336 * @__i: int iteration cursor, for macro-internal use 1337 */ 1338 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \ 1339 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \ 1340 (connector)->encoder_ids[(__i)] != 0; (__i)++) \ 1341 for_each_if((encoder) = \ 1342 drm_encoder_find((connector)->dev, NULL, \ 1343 (connector)->encoder_ids[(__i)])) \ 1344 1345 #endif 1346