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 struct i2c_adapter; 45 46 enum drm_connector_force { 47 DRM_FORCE_UNSPECIFIED, 48 DRM_FORCE_OFF, 49 DRM_FORCE_ON, /* force on analog part normally */ 50 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */ 51 }; 52 53 /** 54 * enum drm_connector_status - status for a &drm_connector 55 * 56 * This enum is used to track the connector status. There are no separate 57 * #defines for the uapi! 58 */ 59 enum drm_connector_status { 60 /** 61 * @connector_status_connected: The connector is definitely connected to 62 * a sink device, and can be enabled. 63 */ 64 connector_status_connected = 1, 65 /** 66 * @connector_status_disconnected: The connector isn't connected to a 67 * sink device which can be autodetect. For digital outputs like DP or 68 * HDMI (which can be realiable probed) this means there's really 69 * nothing there. It is driver-dependent whether a connector with this 70 * status can be lit up or not. 71 */ 72 connector_status_disconnected = 2, 73 /** 74 * @connector_status_unknown: The connector's status could not be 75 * reliably detected. This happens when probing would either cause 76 * flicker (like load-detection when the connector is in use), or when a 77 * hardware resource isn't available (like when load-detection needs a 78 * free CRTC). It should be possible to light up the connector with one 79 * of the listed fallback modes. For default configuration userspace 80 * should only try to light up connectors with unknown status when 81 * there's not connector with @connector_status_connected. 82 */ 83 connector_status_unknown = 3, 84 }; 85 86 /** 87 * enum drm_connector_registration_state - userspace registration status for 88 * a &drm_connector 89 * 90 * This enum is used to track the status of initializing a connector and 91 * registering it with userspace, so that DRM can prevent bogus modesets on 92 * connectors that no longer exist. 93 */ 94 enum drm_connector_registration_state { 95 /** 96 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created, 97 * but has yet to be exposed to userspace. There should be no 98 * additional restrictions to how the state of this connector may be 99 * modified. 100 */ 101 DRM_CONNECTOR_INITIALIZING = 0, 102 103 /** 104 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized 105 * and registered with sysfs, as such it has been exposed to 106 * userspace. There should be no additional restrictions to how the 107 * state of this connector may be modified. 108 */ 109 DRM_CONNECTOR_REGISTERED = 1, 110 111 /** 112 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed 113 * to userspace and has since been unregistered and removed from 114 * userspace, or the connector was unregistered before it had a chance 115 * to be exposed to userspace (e.g. still in the 116 * @DRM_CONNECTOR_INITIALIZING state). When a connector is 117 * unregistered, there are additional restrictions to how its state 118 * may be modified: 119 * 120 * - An unregistered connector may only have its DPMS changed from 121 * On->Off. Once DPMS is changed to Off, it may not be switched back 122 * to On. 123 * - Modesets are not allowed on unregistered connectors, unless they 124 * would result in disabling its assigned CRTCs. This means 125 * disabling a CRTC on an unregistered connector is OK, but enabling 126 * one is not. 127 * - Removing a CRTC from an unregistered connector is OK, but new 128 * CRTCs may never be assigned to an unregistered connector. 129 */ 130 DRM_CONNECTOR_UNREGISTERED = 2, 131 }; 132 133 enum subpixel_order { 134 SubPixelUnknown = 0, 135 SubPixelHorizontalRGB, 136 SubPixelHorizontalBGR, 137 SubPixelVerticalRGB, 138 SubPixelVerticalBGR, 139 SubPixelNone, 140 141 }; 142 143 /** 144 * struct drm_scrambling: sink's scrambling support. 145 */ 146 struct drm_scrambling { 147 /** 148 * @supported: scrambling supported for rates > 340 Mhz. 149 */ 150 bool supported; 151 /** 152 * @low_rates: scrambling supported for rates <= 340 Mhz. 153 */ 154 bool low_rates; 155 }; 156 157 /* 158 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink 159 * 160 * Provides SCDC register support and capabilities related information on a 161 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0. 162 */ 163 struct drm_scdc { 164 /** 165 * @supported: status control & data channel present. 166 */ 167 bool supported; 168 /** 169 * @read_request: sink is capable of generating scdc read request. 170 */ 171 bool read_request; 172 /** 173 * @scrambling: sink's scrambling capabilities 174 */ 175 struct drm_scrambling scrambling; 176 }; 177 178 /** 179 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink 180 * 181 * Describes the DSC support provided by HDMI 2.1 sink. 182 * The information is fetched fom additional HFVSDB blocks defined 183 * for HDMI 2.1. 184 */ 185 struct drm_hdmi_dsc_cap { 186 /** @v_1p2: flag for dsc1.2 version support by sink */ 187 bool v_1p2; 188 189 /** @native_420: Does sink support DSC with 4:2:0 compression */ 190 bool native_420; 191 192 /** 193 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2 194 * compressed formats 195 */ 196 bool all_bpp; 197 198 /** 199 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc 200 */ 201 u8 bpc_supported; 202 203 /** @max_slices: maximum number of Horizontal slices supported by */ 204 u8 max_slices; 205 206 /** @clk_per_slice : max pixel clock in MHz supported per slice */ 207 int clk_per_slice; 208 209 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */ 210 u8 max_lanes; 211 212 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */ 213 u8 max_frl_rate_per_lane; 214 215 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/ 216 u8 total_chunk_kbytes; 217 }; 218 219 /** 220 * struct drm_hdmi_info - runtime information about the connected HDMI sink 221 * 222 * Describes if a given display supports advanced HDMI 2.0 features. 223 * This information is available in CEA-861-F extension blocks (like HF-VSDB). 224 */ 225 struct drm_hdmi_info { 226 /** @scdc: sink's scdc support and capabilities */ 227 struct drm_scdc scdc; 228 229 /** 230 * @y420_vdb_modes: bitmap of modes which can support ycbcr420 231 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC 232 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map 233 * up to 256 VICs. 234 */ 235 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)]; 236 237 /** 238 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420 239 * output also, along with normal HDMI outputs. The max VIC defined by 240 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256 241 * VICs. 242 */ 243 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)]; 244 245 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */ 246 u64 y420_cmdb_map; 247 248 /** @y420_dc_modes: bitmap of deep color support index */ 249 u8 y420_dc_modes; 250 251 /** @max_frl_rate_per_lane: support fixed rate link */ 252 u8 max_frl_rate_per_lane; 253 254 /** @max_lanes: supported by sink */ 255 u8 max_lanes; 256 257 /** @dsc_cap: DSC capabilities of the sink */ 258 struct drm_hdmi_dsc_cap dsc_cap; 259 }; 260 261 /** 262 * enum drm_link_status - connector's link_status property value 263 * 264 * This enum is used as the connector's link status property value. 265 * It is set to the values defined in uapi. 266 * 267 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful 268 * link training 269 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training 270 * failure 271 */ 272 enum drm_link_status { 273 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD, 274 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD, 275 }; 276 277 /** 278 * enum drm_panel_orientation - panel_orientation info for &drm_display_info 279 * 280 * This enum is used to track the (LCD) panel orientation. There are no 281 * separate #defines for the uapi! 282 * 283 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any 284 * panel orientation information (normal 285 * for non panels) in this case the "panel 286 * orientation" connector prop will not be 287 * attached. 288 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the 289 * top side of the device's casing. 290 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the 291 * bottom side of the device's casing, iow 292 * the panel is mounted upside-down. 293 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the 294 * top side of the device's casing. 295 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the 296 * top side of the device's casing. 297 */ 298 enum drm_panel_orientation { 299 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1, 300 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0, 301 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP, 302 DRM_MODE_PANEL_ORIENTATION_LEFT_UP, 303 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP, 304 }; 305 306 /** 307 * struct drm_monitor_range_info - Panel's Monitor range in EDID for 308 * &drm_display_info 309 * 310 * This struct is used to store a frequency range supported by panel 311 * as parsed from EDID's detailed monitor range descriptor block. 312 * 313 * @min_vfreq: This is the min supported refresh rate in Hz from 314 * EDID's detailed monitor range. 315 * @max_vfreq: This is the max supported refresh rate in Hz from 316 * EDID's detailed monitor range 317 */ 318 struct drm_monitor_range_info { 319 u8 min_vfreq; 320 u8 max_vfreq; 321 }; 322 323 /* 324 * This is a consolidated colorimetry list supported by HDMI and 325 * DP protocol standard. The respective connectors will register 326 * a property with the subset of this list (supported by that 327 * respective protocol). Userspace will set the colorspace through 328 * a colorspace property which will be created and exposed to 329 * userspace. 330 */ 331 332 /* For Default case, driver will set the colorspace */ 333 #define DRM_MODE_COLORIMETRY_DEFAULT 0 334 /* CEA 861 Normal Colorimetry options */ 335 #define DRM_MODE_COLORIMETRY_NO_DATA 0 336 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC 1 337 #define DRM_MODE_COLORIMETRY_BT709_YCC 2 338 /* CEA 861 Extended Colorimetry Options */ 339 #define DRM_MODE_COLORIMETRY_XVYCC_601 3 340 #define DRM_MODE_COLORIMETRY_XVYCC_709 4 341 #define DRM_MODE_COLORIMETRY_SYCC_601 5 342 #define DRM_MODE_COLORIMETRY_OPYCC_601 6 343 #define DRM_MODE_COLORIMETRY_OPRGB 7 344 #define DRM_MODE_COLORIMETRY_BT2020_CYCC 8 345 #define DRM_MODE_COLORIMETRY_BT2020_RGB 9 346 #define DRM_MODE_COLORIMETRY_BT2020_YCC 10 347 /* Additional Colorimetry extension added as part of CTA 861.G */ 348 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 11 349 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER 12 350 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */ 351 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED 13 352 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT 14 353 #define DRM_MODE_COLORIMETRY_BT601_YCC 15 354 355 /** 356 * enum drm_bus_flags - bus_flags info for &drm_display_info 357 * 358 * This enum defines signal polarities and clock edge information for signals on 359 * a bus as bitmask flags. 360 * 361 * The clock edge information is conveyed by two sets of symbols, 362 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is 363 * used to describe a bus from the point of view of the transmitter, the 364 * \*_DRIVE_\* flags should be used. When used from the point of view of the 365 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and 366 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and 367 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE 368 * respectively. This simplifies code as signals are usually sampled on the 369 * opposite edge of the driving edge. Transmitters and receivers may however 370 * need to take other signal timings into account to convert between driving 371 * and sample edges. 372 */ 373 enum drm_bus_flags { 374 /** 375 * @DRM_BUS_FLAG_DE_LOW: 376 * 377 * The Data Enable signal is active low 378 */ 379 DRM_BUS_FLAG_DE_LOW = BIT(0), 380 381 /** 382 * @DRM_BUS_FLAG_DE_HIGH: 383 * 384 * The Data Enable signal is active high 385 */ 386 DRM_BUS_FLAG_DE_HIGH = BIT(1), 387 388 /** 389 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE: 390 * 391 * Data is driven on the rising edge of the pixel clock 392 */ 393 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2), 394 395 /** 396 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE: 397 * 398 * Data is driven on the falling edge of the pixel clock 399 */ 400 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3), 401 402 /** 403 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE: 404 * 405 * Data is sampled on the rising edge of the pixel clock 406 */ 407 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE, 408 409 /** 410 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE: 411 * 412 * Data is sampled on the falling edge of the pixel clock 413 */ 414 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE, 415 416 /** 417 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB: 418 * 419 * Data is transmitted MSB to LSB on the bus 420 */ 421 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4), 422 423 /** 424 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB: 425 * 426 * Data is transmitted LSB to MSB on the bus 427 */ 428 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5), 429 430 /** 431 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE: 432 * 433 * Sync signals are driven on the rising edge of the pixel clock 434 */ 435 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6), 436 437 /** 438 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE: 439 * 440 * Sync signals are driven on the falling edge of the pixel clock 441 */ 442 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7), 443 444 /** 445 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE: 446 * 447 * Sync signals are sampled on the rising edge of the pixel clock 448 */ 449 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE, 450 451 /** 452 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE: 453 * 454 * Sync signals are sampled on the falling edge of the pixel clock 455 */ 456 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE, 457 458 /** 459 * @DRM_BUS_FLAG_SHARP_SIGNALS: 460 * 461 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used 462 */ 463 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8), 464 }; 465 466 /** 467 * struct drm_display_info - runtime data about the connected sink 468 * 469 * Describes a given display (e.g. CRT or flat panel) and its limitations. For 470 * fixed display sinks like built-in panels there's not much difference between 471 * this and &struct drm_connector. But for sinks with a real cable this 472 * structure is meant to describe all the things at the other end of the cable. 473 * 474 * For sinks which provide an EDID this can be filled out by calling 475 * drm_add_edid_modes(). 476 */ 477 struct drm_display_info { 478 /** 479 * @width_mm: Physical width in mm. 480 */ 481 unsigned int width_mm; 482 483 /** 484 * @height_mm: Physical height in mm. 485 */ 486 unsigned int height_mm; 487 488 /** 489 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs. 490 */ 491 unsigned int bpc; 492 493 /** 494 * @subpixel_order: Subpixel order of LCD panels. 495 */ 496 enum subpixel_order subpixel_order; 497 498 #define DRM_COLOR_FORMAT_RGB444 (1<<0) 499 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1) 500 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2) 501 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3) 502 503 /** 504 * @panel_orientation: Read only connector property for built-in panels, 505 * indicating the orientation of the panel vs the device's casing. 506 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN. 507 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the 508 * fb to compensate and gets exported as prop to userspace. 509 */ 510 int panel_orientation; 511 512 /** 513 * @color_formats: HDMI Color formats, selects between RGB and YCrCb 514 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones 515 * as used to describe the pixel format in framebuffers, and also don't 516 * match the formats in @bus_formats which are shared with v4l. 517 */ 518 u32 color_formats; 519 520 /** 521 * @bus_formats: Pixel data format on the wire, somewhat redundant with 522 * @color_formats. Array of size @num_bus_formats encoded using 523 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers. 524 */ 525 const u32 *bus_formats; 526 /** 527 * @num_bus_formats: Size of @bus_formats array. 528 */ 529 unsigned int num_bus_formats; 530 531 /** 532 * @bus_flags: Additional information (like pixel signal polarity) for 533 * the pixel data on the bus, using &enum drm_bus_flags values 534 * DRM_BUS_FLAGS\_. 535 */ 536 u32 bus_flags; 537 538 /** 539 * @max_tmds_clock: Maximum TMDS clock rate supported by the 540 * sink in kHz. 0 means undefined. 541 */ 542 int max_tmds_clock; 543 544 /** 545 * @dvi_dual: Dual-link DVI sink? 546 */ 547 bool dvi_dual; 548 549 /** 550 * @is_hdmi: True if the sink is an HDMI device. 551 * 552 * This field shall be used instead of calling 553 * drm_detect_hdmi_monitor() when possible. 554 */ 555 bool is_hdmi; 556 557 /** 558 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe? 559 */ 560 bool has_hdmi_infoframe; 561 562 /** 563 * @rgb_quant_range_selectable: Does the sink support selecting 564 * the RGB quantization range? 565 */ 566 bool rgb_quant_range_selectable; 567 568 /** 569 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even 570 * more stuff redundant with @bus_formats. 571 */ 572 u8 edid_hdmi_dc_modes; 573 574 /** 575 * @cea_rev: CEA revision of the HDMI sink. 576 */ 577 u8 cea_rev; 578 579 /** 580 * @hdmi: advance features of a HDMI sink. 581 */ 582 struct drm_hdmi_info hdmi; 583 584 /** 585 * @non_desktop: Non desktop display (HMD). 586 */ 587 bool non_desktop; 588 589 /** 590 * @monitor_range: Frequency range supported by monitor range descriptor 591 */ 592 struct drm_monitor_range_info monitor_range; 593 }; 594 595 int drm_display_info_set_bus_formats(struct drm_display_info *info, 596 const u32 *formats, 597 unsigned int num_formats); 598 599 /** 600 * struct drm_connector_tv_margins - TV connector related margins 601 * 602 * Describes the margins in pixels to put around the image on TV 603 * connectors to deal with overscan. 604 */ 605 struct drm_connector_tv_margins { 606 /** 607 * @bottom: Bottom margin in pixels. 608 */ 609 unsigned int bottom; 610 611 /** 612 * @left: Left margin in pixels. 613 */ 614 unsigned int left; 615 616 /** 617 * @right: Right margin in pixels. 618 */ 619 unsigned int right; 620 621 /** 622 * @top: Top margin in pixels. 623 */ 624 unsigned int top; 625 }; 626 627 /** 628 * struct drm_tv_connector_state - TV connector related states 629 * @subconnector: selected subconnector 630 * @margins: TV margins 631 * @mode: TV mode 632 * @brightness: brightness in percent 633 * @contrast: contrast in percent 634 * @flicker_reduction: flicker reduction in percent 635 * @overscan: overscan in percent 636 * @saturation: saturation in percent 637 * @hue: hue in percent 638 */ 639 struct drm_tv_connector_state { 640 enum drm_mode_subconnector subconnector; 641 struct drm_connector_tv_margins margins; 642 unsigned int mode; 643 unsigned int brightness; 644 unsigned int contrast; 645 unsigned int flicker_reduction; 646 unsigned int overscan; 647 unsigned int saturation; 648 unsigned int hue; 649 }; 650 651 /** 652 * struct drm_connector_state - mutable connector state 653 */ 654 struct drm_connector_state { 655 /** @connector: backpointer to the connector */ 656 struct drm_connector *connector; 657 658 /** 659 * @crtc: CRTC to connect connector to, NULL if disabled. 660 * 661 * Do not change this directly, use drm_atomic_set_crtc_for_connector() 662 * instead. 663 */ 664 struct drm_crtc *crtc; 665 666 /** 667 * @best_encoder: 668 * 669 * Used by the atomic helpers to select the encoder, through the 670 * &drm_connector_helper_funcs.atomic_best_encoder or 671 * &drm_connector_helper_funcs.best_encoder callbacks. 672 * 673 * This is also used in the atomic helpers to map encoders to their 674 * current and previous connectors, see 675 * drm_atomic_get_old_connector_for_encoder() and 676 * drm_atomic_get_new_connector_for_encoder(). 677 * 678 * NOTE: Atomic drivers must fill this out (either themselves or through 679 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will 680 * not return correct data to userspace. 681 */ 682 struct drm_encoder *best_encoder; 683 684 /** 685 * @link_status: Connector link_status to keep track of whether link is 686 * GOOD or BAD to notify userspace if retraining is necessary. 687 */ 688 enum drm_link_status link_status; 689 690 /** @state: backpointer to global drm_atomic_state */ 691 struct drm_atomic_state *state; 692 693 /** 694 * @commit: Tracks the pending commit to prevent use-after-free conditions. 695 * 696 * Is only set when @crtc is NULL. 697 */ 698 struct drm_crtc_commit *commit; 699 700 /** @tv: TV connector state */ 701 struct drm_tv_connector_state tv; 702 703 /** 704 * @self_refresh_aware: 705 * 706 * This tracks whether a connector is aware of the self refresh state. 707 * It should be set to true for those connector implementations which 708 * understand the self refresh state. This is needed since the crtc 709 * registers the self refresh helpers and it doesn't know if the 710 * connectors downstream have implemented self refresh entry/exit. 711 * 712 * Drivers should set this to true in atomic_check if they know how to 713 * handle self_refresh requests. 714 */ 715 bool self_refresh_aware; 716 717 /** 718 * @picture_aspect_ratio: Connector property to control the 719 * HDMI infoframe aspect ratio setting. 720 * 721 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the 722 * values for &enum hdmi_picture_aspect 723 */ 724 enum hdmi_picture_aspect picture_aspect_ratio; 725 726 /** 727 * @content_type: Connector property to control the 728 * HDMI infoframe content type setting. 729 * The %DRM_MODE_CONTENT_TYPE_\* values much 730 * match the values. 731 */ 732 unsigned int content_type; 733 734 /** 735 * @hdcp_content_type: Connector property to pass the type of 736 * protected content. This is most commonly used for HDCP. 737 */ 738 unsigned int hdcp_content_type; 739 740 /** 741 * @scaling_mode: Connector property to control the 742 * upscaling, mostly used for built-in panels. 743 */ 744 unsigned int scaling_mode; 745 746 /** 747 * @content_protection: Connector property to request content 748 * protection. This is most commonly used for HDCP. 749 */ 750 unsigned int content_protection; 751 752 /** 753 * @colorspace: State variable for Connector property to request 754 * colorspace change on Sink. This is most commonly used to switch 755 * to wider color gamuts like BT2020. 756 */ 757 u32 colorspace; 758 759 /** 760 * @writeback_job: Writeback job for writeback connectors 761 * 762 * Holds the framebuffer and out-fence for a writeback connector. As 763 * the writeback completion may be asynchronous to the normal commit 764 * cycle, the writeback job lifetime is managed separately from the 765 * normal atomic state by this object. 766 * 767 * See also: drm_writeback_queue_job() and 768 * drm_writeback_signal_completion() 769 */ 770 struct drm_writeback_job *writeback_job; 771 772 /** 773 * @max_requested_bpc: Connector property to limit the maximum bit 774 * depth of the pixels. 775 */ 776 u8 max_requested_bpc; 777 778 /** 779 * @max_bpc: Connector max_bpc based on the requested max_bpc property 780 * and the connector bpc limitations obtained from edid. 781 */ 782 u8 max_bpc; 783 784 /** 785 * @hdr_output_metadata: 786 * DRM blob property for HDR output metadata 787 */ 788 struct drm_property_blob *hdr_output_metadata; 789 }; 790 791 /** 792 * struct drm_connector_funcs - control connectors on a given device 793 * 794 * Each CRTC may have one or more connectors attached to it. The functions 795 * below allow the core DRM code to control connectors, enumerate available modes, 796 * etc. 797 */ 798 struct drm_connector_funcs { 799 /** 800 * @dpms: 801 * 802 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS 803 * is exposed as a standard property on the connector, but diverted to 804 * this callback in the drm core. Note that atomic drivers don't 805 * implement the 4 level DPMS support on the connector any more, but 806 * instead only have an on/off "ACTIVE" property on the CRTC object. 807 * 808 * This hook is not used by atomic drivers, remapping of the legacy DPMS 809 * property is entirely handled in the DRM core. 810 * 811 * RETURNS: 812 * 813 * 0 on success or a negative error code on failure. 814 */ 815 int (*dpms)(struct drm_connector *connector, int mode); 816 817 /** 818 * @reset: 819 * 820 * Reset connector hardware and software state to off. This function isn't 821 * called by the core directly, only through drm_mode_config_reset(). 822 * It's not a helper hook only for historical reasons. 823 * 824 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset 825 * atomic state using this hook. 826 */ 827 void (*reset)(struct drm_connector *connector); 828 829 /** 830 * @detect: 831 * 832 * Check to see if anything is attached to the connector. The parameter 833 * force is set to false whilst polling, true when checking the 834 * connector due to a user request. force can be used by the driver to 835 * avoid expensive, destructive operations during automated probing. 836 * 837 * This callback is optional, if not implemented the connector will be 838 * considered as always being attached. 839 * 840 * FIXME: 841 * 842 * Note that this hook is only called by the probe helper. It's not in 843 * the helper library vtable purely for historical reasons. The only DRM 844 * core entry point to probe connector state is @fill_modes. 845 * 846 * Note that the helper library will already hold 847 * &drm_mode_config.connection_mutex. Drivers which need to grab additional 848 * locks to avoid races with concurrent modeset changes need to use 849 * &drm_connector_helper_funcs.detect_ctx instead. 850 * 851 * Also note that this callback can be called no matter the 852 * state the connector is in. Drivers that need the underlying 853 * device to be powered to perform the detection will first need 854 * to make sure it's been properly enabled. 855 * 856 * RETURNS: 857 * 858 * drm_connector_status indicating the connector's status. 859 */ 860 enum drm_connector_status (*detect)(struct drm_connector *connector, 861 bool force); 862 863 /** 864 * @force: 865 * 866 * This function is called to update internal encoder state when the 867 * connector is forced to a certain state by userspace, either through 868 * the sysfs interfaces or on the kernel cmdline. In that case the 869 * @detect callback isn't called. 870 * 871 * FIXME: 872 * 873 * Note that this hook is only called by the probe helper. It's not in 874 * the helper library vtable purely for historical reasons. The only DRM 875 * core entry point to probe connector state is @fill_modes. 876 */ 877 void (*force)(struct drm_connector *connector); 878 879 /** 880 * @fill_modes: 881 * 882 * Entry point for output detection and basic mode validation. The 883 * driver should reprobe the output if needed (e.g. when hotplug 884 * handling is unreliable), add all detected modes to &drm_connector.modes 885 * and filter out any the device can't support in any configuration. It 886 * also needs to filter out any modes wider or higher than the 887 * parameters max_width and max_height indicate. 888 * 889 * The drivers must also prune any modes no longer valid from 890 * &drm_connector.modes. Furthermore it must update 891 * &drm_connector.status and &drm_connector.edid. If no EDID has been 892 * received for this output connector->edid must be NULL. 893 * 894 * Drivers using the probe helpers should use 895 * drm_helper_probe_single_connector_modes() to implement this 896 * function. 897 * 898 * RETURNS: 899 * 900 * The number of modes detected and filled into &drm_connector.modes. 901 */ 902 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); 903 904 /** 905 * @set_property: 906 * 907 * This is the legacy entry point to update a property attached to the 908 * connector. 909 * 910 * This callback is optional if the driver does not support any legacy 911 * driver-private properties. For atomic drivers it is not used because 912 * property handling is done entirely in the DRM core. 913 * 914 * RETURNS: 915 * 916 * 0 on success or a negative error code on failure. 917 */ 918 int (*set_property)(struct drm_connector *connector, struct drm_property *property, 919 uint64_t val); 920 921 /** 922 * @late_register: 923 * 924 * This optional hook can be used to register additional userspace 925 * interfaces attached to the connector, light backlight control, i2c, 926 * DP aux or similar interfaces. It is called late in the driver load 927 * sequence from drm_connector_register() when registering all the 928 * core drm connector interfaces. Everything added from this callback 929 * should be unregistered in the early_unregister callback. 930 * 931 * This is called while holding &drm_connector.mutex. 932 * 933 * Returns: 934 * 935 * 0 on success, or a negative error code on failure. 936 */ 937 int (*late_register)(struct drm_connector *connector); 938 939 /** 940 * @early_unregister: 941 * 942 * This optional hook should be used to unregister the additional 943 * userspace interfaces attached to the connector from 944 * late_register(). It is called from drm_connector_unregister(), 945 * early in the driver unload sequence to disable userspace access 946 * before data structures are torndown. 947 * 948 * This is called while holding &drm_connector.mutex. 949 */ 950 void (*early_unregister)(struct drm_connector *connector); 951 952 /** 953 * @destroy: 954 * 955 * Clean up connector resources. This is called at driver unload time 956 * through drm_mode_config_cleanup(). It can also be called at runtime 957 * when a connector is being hot-unplugged for drivers that support 958 * connector hotplugging (e.g. DisplayPort MST). 959 */ 960 void (*destroy)(struct drm_connector *connector); 961 962 /** 963 * @atomic_duplicate_state: 964 * 965 * Duplicate the current atomic state for this connector and return it. 966 * The core and helpers guarantee that any atomic state duplicated with 967 * this hook and still owned by the caller (i.e. not transferred to the 968 * driver by calling &drm_mode_config_funcs.atomic_commit) will be 969 * cleaned up by calling the @atomic_destroy_state hook in this 970 * structure. 971 * 972 * This callback is mandatory for atomic drivers. 973 * 974 * Atomic drivers which don't subclass &struct drm_connector_state should use 975 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the 976 * state structure to extend it with driver-private state should use 977 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is 978 * duplicated in a consistent fashion across drivers. 979 * 980 * It is an error to call this hook before &drm_connector.state has been 981 * initialized correctly. 982 * 983 * NOTE: 984 * 985 * If the duplicate state references refcounted resources this hook must 986 * acquire a reference for each of them. The driver must release these 987 * references again in @atomic_destroy_state. 988 * 989 * RETURNS: 990 * 991 * Duplicated atomic state or NULL when the allocation failed. 992 */ 993 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector); 994 995 /** 996 * @atomic_destroy_state: 997 * 998 * Destroy a state duplicated with @atomic_duplicate_state and release 999 * or unreference all resources it references 1000 * 1001 * This callback is mandatory for atomic drivers. 1002 */ 1003 void (*atomic_destroy_state)(struct drm_connector *connector, 1004 struct drm_connector_state *state); 1005 1006 /** 1007 * @atomic_set_property: 1008 * 1009 * Decode a driver-private property value and store the decoded value 1010 * into the passed-in state structure. Since the atomic core decodes all 1011 * standardized properties (even for extensions beyond the core set of 1012 * properties which might not be implemented by all drivers) this 1013 * requires drivers to subclass the state structure. 1014 * 1015 * Such driver-private properties should really only be implemented for 1016 * truly hardware/vendor specific state. Instead it is preferred to 1017 * standardize atomic extension and decode the properties used to expose 1018 * such an extension in the core. 1019 * 1020 * Do not call this function directly, use 1021 * drm_atomic_connector_set_property() instead. 1022 * 1023 * This callback is optional if the driver does not support any 1024 * driver-private atomic properties. 1025 * 1026 * NOTE: 1027 * 1028 * This function is called in the state assembly phase of atomic 1029 * modesets, which can be aborted for any reason (including on 1030 * userspace's request to just check whether a configuration would be 1031 * possible). Drivers MUST NOT touch any persistent state (hardware or 1032 * software) or data structures except the passed in @state parameter. 1033 * 1034 * Also since userspace controls in which order properties are set this 1035 * function must not do any input validation (since the state update is 1036 * incomplete and hence likely inconsistent). Instead any such input 1037 * validation must be done in the various atomic_check callbacks. 1038 * 1039 * RETURNS: 1040 * 1041 * 0 if the property has been found, -EINVAL if the property isn't 1042 * implemented by the driver (which shouldn't ever happen, the core only 1043 * asks for properties attached to this connector). No other validation 1044 * is allowed by the driver. The core already checks that the property 1045 * value is within the range (integer, valid enum value, ...) the driver 1046 * set when registering the property. 1047 */ 1048 int (*atomic_set_property)(struct drm_connector *connector, 1049 struct drm_connector_state *state, 1050 struct drm_property *property, 1051 uint64_t val); 1052 1053 /** 1054 * @atomic_get_property: 1055 * 1056 * Reads out the decoded driver-private property. This is used to 1057 * implement the GETCONNECTOR IOCTL. 1058 * 1059 * Do not call this function directly, use 1060 * drm_atomic_connector_get_property() instead. 1061 * 1062 * This callback is optional if the driver does not support any 1063 * driver-private atomic properties. 1064 * 1065 * RETURNS: 1066 * 1067 * 0 on success, -EINVAL if the property isn't implemented by the 1068 * driver (which shouldn't ever happen, the core only asks for 1069 * properties attached to this connector). 1070 */ 1071 int (*atomic_get_property)(struct drm_connector *connector, 1072 const struct drm_connector_state *state, 1073 struct drm_property *property, 1074 uint64_t *val); 1075 1076 /** 1077 * @atomic_print_state: 1078 * 1079 * If driver subclasses &struct drm_connector_state, it should implement 1080 * this optional hook for printing additional driver specific state. 1081 * 1082 * Do not call this directly, use drm_atomic_connector_print_state() 1083 * instead. 1084 */ 1085 void (*atomic_print_state)(struct drm_printer *p, 1086 const struct drm_connector_state *state); 1087 1088 /** 1089 * @oob_hotplug_event: 1090 * 1091 * This will get called when a hotplug-event for a drm-connector 1092 * has been received from a source outside the display driver / device. 1093 */ 1094 void (*oob_hotplug_event)(struct drm_connector *connector); 1095 }; 1096 1097 /** 1098 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line 1099 * 1100 * Each connector can have an initial mode with additional options 1101 * passed through the kernel command line. This structure allows to 1102 * express those parameters and will be filled by the command-line 1103 * parser. 1104 */ 1105 struct drm_cmdline_mode { 1106 /** 1107 * @name: 1108 * 1109 * Name of the mode. 1110 */ 1111 char name[DRM_DISPLAY_MODE_LEN]; 1112 1113 /** 1114 * @specified: 1115 * 1116 * Has a mode been read from the command-line? 1117 */ 1118 bool specified; 1119 1120 /** 1121 * @refresh_specified: 1122 * 1123 * Did the mode have a preferred refresh rate? 1124 */ 1125 bool refresh_specified; 1126 1127 /** 1128 * @bpp_specified: 1129 * 1130 * Did the mode have a preferred BPP? 1131 */ 1132 bool bpp_specified; 1133 1134 /** 1135 * @xres: 1136 * 1137 * Active resolution on the X axis, in pixels. 1138 */ 1139 int xres; 1140 1141 /** 1142 * @yres: 1143 * 1144 * Active resolution on the Y axis, in pixels. 1145 */ 1146 int yres; 1147 1148 /** 1149 * @bpp: 1150 * 1151 * Bits per pixels for the mode. 1152 */ 1153 int bpp; 1154 1155 /** 1156 * @refresh: 1157 * 1158 * Refresh rate, in Hertz. 1159 */ 1160 int refresh; 1161 1162 /** 1163 * @rb: 1164 * 1165 * Do we need to use reduced blanking? 1166 */ 1167 bool rb; 1168 1169 /** 1170 * @interlace: 1171 * 1172 * The mode is interlaced. 1173 */ 1174 bool interlace; 1175 1176 /** 1177 * @cvt: 1178 * 1179 * The timings will be calculated using the VESA Coordinated 1180 * Video Timings instead of looking up the mode from a table. 1181 */ 1182 bool cvt; 1183 1184 /** 1185 * @margins: 1186 * 1187 * Add margins to the mode calculation (1.8% of xres rounded 1188 * down to 8 pixels and 1.8% of yres). 1189 */ 1190 bool margins; 1191 1192 /** 1193 * @force: 1194 * 1195 * Ignore the hotplug state of the connector, and force its 1196 * state to one of the DRM_FORCE_* values. 1197 */ 1198 enum drm_connector_force force; 1199 1200 /** 1201 * @rotation_reflection: 1202 * 1203 * Initial rotation and reflection of the mode setup from the 1204 * command line. See DRM_MODE_ROTATE_* and 1205 * DRM_MODE_REFLECT_*. The only rotations supported are 1206 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180. 1207 */ 1208 unsigned int rotation_reflection; 1209 1210 /** 1211 * @panel_orientation: 1212 * 1213 * drm-connector "panel orientation" property override value, 1214 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set. 1215 */ 1216 enum drm_panel_orientation panel_orientation; 1217 1218 /** 1219 * @tv_margins: TV margins to apply to the mode. 1220 */ 1221 struct drm_connector_tv_margins tv_margins; 1222 }; 1223 1224 /** 1225 * struct drm_connector - central DRM connector control structure 1226 * 1227 * Each connector may be connected to one or more CRTCs, or may be clonable by 1228 * another connector if they can share a CRTC. Each connector also has a specific 1229 * position in the broader display (referred to as a 'screen' though it could 1230 * span multiple monitors). 1231 */ 1232 struct drm_connector { 1233 /** @dev: parent DRM device */ 1234 struct drm_device *dev; 1235 /** @kdev: kernel device for sysfs attributes */ 1236 struct device *kdev; 1237 /** @attr: sysfs attributes */ 1238 struct device_attribute *attr; 1239 /** 1240 * @fwnode: associated fwnode supplied by platform firmware 1241 * 1242 * Drivers can set this to associate a fwnode with a connector, drivers 1243 * are expected to get a reference on the fwnode when setting this. 1244 * drm_connector_cleanup() will call fwnode_handle_put() on this. 1245 */ 1246 struct fwnode_handle *fwnode; 1247 1248 /** 1249 * @head: 1250 * 1251 * List of all connectors on a @dev, linked from 1252 * &drm_mode_config.connector_list. Protected by 1253 * &drm_mode_config.connector_list_lock, but please only use 1254 * &drm_connector_list_iter to walk this list. 1255 */ 1256 struct list_head head; 1257 1258 /** 1259 * @global_connector_list_entry: 1260 * 1261 * Connector entry in the global connector-list, used by 1262 * drm_connector_find_by_fwnode(). 1263 */ 1264 struct list_head global_connector_list_entry; 1265 1266 /** @base: base KMS object */ 1267 struct drm_mode_object base; 1268 1269 /** @name: human readable name, can be overwritten by the driver */ 1270 char *name; 1271 1272 /** 1273 * @mutex: Lock for general connector state, but currently only protects 1274 * @registered. Most of the connector state is still protected by 1275 * &drm_mode_config.mutex. 1276 */ 1277 struct mutex mutex; 1278 1279 /** 1280 * @index: Compacted connector index, which matches the position inside 1281 * the mode_config.list for drivers not supporting hot-add/removing. Can 1282 * be used as an array index. It is invariant over the lifetime of the 1283 * connector. 1284 */ 1285 unsigned index; 1286 1287 /** 1288 * @connector_type: 1289 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 1290 */ 1291 int connector_type; 1292 /** @connector_type_id: index into connector type enum */ 1293 int connector_type_id; 1294 /** 1295 * @interlace_allowed: 1296 * Can this connector handle interlaced modes? Only used by 1297 * drm_helper_probe_single_connector_modes() for mode filtering. 1298 */ 1299 bool interlace_allowed; 1300 /** 1301 * @doublescan_allowed: 1302 * Can this connector handle doublescan? Only used by 1303 * drm_helper_probe_single_connector_modes() for mode filtering. 1304 */ 1305 bool doublescan_allowed; 1306 /** 1307 * @stereo_allowed: 1308 * Can this connector handle stereo modes? Only used by 1309 * drm_helper_probe_single_connector_modes() for mode filtering. 1310 */ 1311 bool stereo_allowed; 1312 1313 /** 1314 * @ycbcr_420_allowed : This bool indicates if this connector is 1315 * capable of handling YCBCR 420 output. While parsing the EDID 1316 * blocks it's very helpful to know if the source is capable of 1317 * handling YCBCR 420 outputs. 1318 */ 1319 bool ycbcr_420_allowed; 1320 1321 /** 1322 * @registration_state: Is this connector initializing, exposed 1323 * (registered) with userspace, or unregistered? 1324 * 1325 * Protected by @mutex. 1326 */ 1327 enum drm_connector_registration_state registration_state; 1328 1329 /** 1330 * @modes: 1331 * Modes available on this connector (from fill_modes() + user). 1332 * Protected by &drm_mode_config.mutex. 1333 */ 1334 struct list_head modes; 1335 1336 /** 1337 * @status: 1338 * One of the drm_connector_status enums (connected, not, or unknown). 1339 * Protected by &drm_mode_config.mutex. 1340 */ 1341 enum drm_connector_status status; 1342 1343 /** 1344 * @probed_modes: 1345 * These are modes added by probing with DDC or the BIOS, before 1346 * filtering is applied. Used by the probe helpers. Protected by 1347 * &drm_mode_config.mutex. 1348 */ 1349 struct list_head probed_modes; 1350 1351 /** 1352 * @display_info: Display information is filled from EDID information 1353 * when a display is detected. For non hot-pluggable displays such as 1354 * flat panels in embedded systems, the driver should initialize the 1355 * &drm_display_info.width_mm and &drm_display_info.height_mm fields 1356 * with the physical size of the display. 1357 * 1358 * Protected by &drm_mode_config.mutex. 1359 */ 1360 struct drm_display_info display_info; 1361 1362 /** @funcs: connector control functions */ 1363 const struct drm_connector_funcs *funcs; 1364 1365 /** 1366 * @edid_blob_ptr: DRM property containing EDID if present. Protected by 1367 * &drm_mode_config.mutex. This should be updated only by calling 1368 * drm_connector_update_edid_property(). 1369 */ 1370 struct drm_property_blob *edid_blob_ptr; 1371 1372 /** @properties: property tracking for this connector */ 1373 struct drm_object_properties properties; 1374 1375 /** 1376 * @scaling_mode_property: Optional atomic property to control the 1377 * upscaling. See drm_connector_attach_content_protection_property(). 1378 */ 1379 struct drm_property *scaling_mode_property; 1380 1381 /** 1382 * @vrr_capable_property: Optional property to help userspace 1383 * query hardware support for variable refresh rate on a connector. 1384 * connector. Drivers can add the property to a connector by 1385 * calling drm_connector_attach_vrr_capable_property(). 1386 * 1387 * This should be updated only by calling 1388 * drm_connector_set_vrr_capable_property(). 1389 */ 1390 struct drm_property *vrr_capable_property; 1391 1392 /** 1393 * @colorspace_property: Connector property to set the suitable 1394 * colorspace supported by the sink. 1395 */ 1396 struct drm_property *colorspace_property; 1397 1398 /** 1399 * @path_blob_ptr: 1400 * 1401 * DRM blob property data for the DP MST path property. This should only 1402 * be updated by calling drm_connector_set_path_property(). 1403 */ 1404 struct drm_property_blob *path_blob_ptr; 1405 1406 /** 1407 * @max_bpc_property: Default connector property for the max bpc to be 1408 * driven out of the connector. 1409 */ 1410 struct drm_property *max_bpc_property; 1411 1412 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 1413 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 1414 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 1415 1416 /** 1417 * @polled: 1418 * 1419 * Connector polling mode, a combination of 1420 * 1421 * DRM_CONNECTOR_POLL_HPD 1422 * The connector generates hotplug events and doesn't need to be 1423 * periodically polled. The CONNECT and DISCONNECT flags must not 1424 * be set together with the HPD flag. 1425 * 1426 * DRM_CONNECTOR_POLL_CONNECT 1427 * Periodically poll the connector for connection. 1428 * 1429 * DRM_CONNECTOR_POLL_DISCONNECT 1430 * Periodically poll the connector for disconnection, without 1431 * causing flickering even when the connector is in use. DACs should 1432 * rarely do this without a lot of testing. 1433 * 1434 * Set to 0 for connectors that don't support connection status 1435 * discovery. 1436 */ 1437 uint8_t polled; 1438 1439 /** 1440 * @dpms: Current dpms state. For legacy drivers the 1441 * &drm_connector_funcs.dpms callback must update this. For atomic 1442 * drivers, this is handled by the core atomic code, and drivers must 1443 * only take &drm_crtc_state.active into account. 1444 */ 1445 int dpms; 1446 1447 /** @helper_private: mid-layer private data */ 1448 const struct drm_connector_helper_funcs *helper_private; 1449 1450 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */ 1451 struct drm_cmdline_mode cmdline_mode; 1452 /** @force: a DRM_FORCE_<foo> state for forced mode sets */ 1453 enum drm_connector_force force; 1454 /** @override_edid: has the EDID been overwritten through debugfs for testing? */ 1455 bool override_edid; 1456 /** @epoch_counter: used to detect any other changes in connector, besides status */ 1457 u64 epoch_counter; 1458 1459 /** 1460 * @possible_encoders: Bit mask of encoders that can drive this 1461 * connector, drm_encoder_index() determines the index into the bitfield 1462 * and the bits are set with drm_connector_attach_encoder(). 1463 */ 1464 u32 possible_encoders; 1465 1466 /** 1467 * @encoder: Currently bound encoder driving this connector, if any. 1468 * Only really meaningful for non-atomic drivers. Atomic drivers should 1469 * instead look at &drm_connector_state.best_encoder, and in case they 1470 * need the CRTC driving this output, &drm_connector_state.crtc. 1471 */ 1472 struct drm_encoder *encoder; 1473 1474 #define MAX_ELD_BYTES 128 1475 /** @eld: EDID-like data, if present */ 1476 uint8_t eld[MAX_ELD_BYTES]; 1477 /** @latency_present: AV delay info from ELD, if found */ 1478 bool latency_present[2]; 1479 /** 1480 * @video_latency: Video latency info from ELD, if found. 1481 * [0]: progressive, [1]: interlaced 1482 */ 1483 int video_latency[2]; 1484 /** 1485 * @audio_latency: audio latency info from ELD, if found 1486 * [0]: progressive, [1]: interlaced 1487 */ 1488 int audio_latency[2]; 1489 1490 /** 1491 * @ddc: associated ddc adapter. 1492 * A connector usually has its associated ddc adapter. If a driver uses 1493 * this field, then an appropriate symbolic link is created in connector 1494 * sysfs directory to make it easy for the user to tell which i2c 1495 * adapter is for a particular display. 1496 * 1497 * The field should be set by calling drm_connector_init_with_ddc(). 1498 */ 1499 struct i2c_adapter *ddc; 1500 1501 /** 1502 * @null_edid_counter: track sinks that give us all zeros for the EDID. 1503 * Needed to workaround some HW bugs where we get all 0s 1504 */ 1505 int null_edid_counter; 1506 1507 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */ 1508 unsigned bad_edid_counter; 1509 1510 /** 1511 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used 1512 * in Displayport compliance testing - Displayport Link CTS Core 1.2 1513 * rev1.1 4.2.2.6 1514 */ 1515 bool edid_corrupt; 1516 /** 1517 * @real_edid_checksum: real edid checksum for corrupted edid block. 1518 * Required in Displayport 1.4 compliance testing 1519 * rev1.1 4.2.2.6 1520 */ 1521 u8 real_edid_checksum; 1522 1523 /** @debugfs_entry: debugfs directory for this connector */ 1524 struct dentry *debugfs_entry; 1525 1526 /** 1527 * @state: 1528 * 1529 * Current atomic state for this connector. 1530 * 1531 * This is protected by &drm_mode_config.connection_mutex. Note that 1532 * nonblocking atomic commits access the current connector state without 1533 * taking locks. Either by going through the &struct drm_atomic_state 1534 * pointers, see for_each_oldnew_connector_in_state(), 1535 * for_each_old_connector_in_state() and 1536 * for_each_new_connector_in_state(). Or through careful ordering of 1537 * atomic commit operations as implemented in the atomic helpers, see 1538 * &struct drm_crtc_commit. 1539 */ 1540 struct drm_connector_state *state; 1541 1542 /* DisplayID bits. FIXME: Extract into a substruct? */ 1543 1544 /** 1545 * @tile_blob_ptr: 1546 * 1547 * DRM blob property data for the tile property (used mostly by DP MST). 1548 * This is meant for screens which are driven through separate display 1549 * pipelines represented by &drm_crtc, which might not be running with 1550 * genlocked clocks. For tiled panels which are genlocked, like 1551 * dual-link LVDS or dual-link DSI, the driver should try to not expose 1552 * the tiling and virtualize both &drm_crtc and &drm_plane if needed. 1553 * 1554 * This should only be updated by calling 1555 * drm_connector_set_tile_property(). 1556 */ 1557 struct drm_property_blob *tile_blob_ptr; 1558 1559 /** @has_tile: is this connector connected to a tiled monitor */ 1560 bool has_tile; 1561 /** @tile_group: tile group for the connected monitor */ 1562 struct drm_tile_group *tile_group; 1563 /** @tile_is_single_monitor: whether the tile is one monitor housing */ 1564 bool tile_is_single_monitor; 1565 1566 /** @num_h_tile: number of horizontal tiles in the tile group */ 1567 /** @num_v_tile: number of vertical tiles in the tile group */ 1568 uint8_t num_h_tile, num_v_tile; 1569 /** @tile_h_loc: horizontal location of this tile */ 1570 /** @tile_v_loc: vertical location of this tile */ 1571 uint8_t tile_h_loc, tile_v_loc; 1572 /** @tile_h_size: horizontal size of this tile. */ 1573 /** @tile_v_size: vertical size of this tile. */ 1574 uint16_t tile_h_size, tile_v_size; 1575 1576 /** 1577 * @free_node: 1578 * 1579 * List used only by &drm_connector_list_iter to be able to clean up a 1580 * connector from any context, in conjunction with 1581 * &drm_mode_config.connector_free_work. 1582 */ 1583 struct llist_node free_node; 1584 1585 /** @hdr_sink_metadata: HDR Metadata Information read from sink */ 1586 struct hdr_sink_metadata hdr_sink_metadata; 1587 }; 1588 1589 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 1590 1591 int drm_connector_init(struct drm_device *dev, 1592 struct drm_connector *connector, 1593 const struct drm_connector_funcs *funcs, 1594 int connector_type); 1595 int drm_connector_init_with_ddc(struct drm_device *dev, 1596 struct drm_connector *connector, 1597 const struct drm_connector_funcs *funcs, 1598 int connector_type, 1599 struct i2c_adapter *ddc); 1600 void drm_connector_attach_edid_property(struct drm_connector *connector); 1601 int drm_connector_register(struct drm_connector *connector); 1602 void drm_connector_unregister(struct drm_connector *connector); 1603 int drm_connector_attach_encoder(struct drm_connector *connector, 1604 struct drm_encoder *encoder); 1605 1606 void drm_connector_cleanup(struct drm_connector *connector); 1607 1608 static inline unsigned int drm_connector_index(const struct drm_connector *connector) 1609 { 1610 return connector->index; 1611 } 1612 1613 static inline u32 drm_connector_mask(const struct drm_connector *connector) 1614 { 1615 return 1 << connector->index; 1616 } 1617 1618 /** 1619 * drm_connector_lookup - lookup connector object 1620 * @dev: DRM device 1621 * @file_priv: drm file to check for lease against. 1622 * @id: connector object id 1623 * 1624 * This function looks up the connector object specified by id 1625 * add takes a reference to it. 1626 */ 1627 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev, 1628 struct drm_file *file_priv, 1629 uint32_t id) 1630 { 1631 struct drm_mode_object *mo; 1632 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR); 1633 return mo ? obj_to_connector(mo) : NULL; 1634 } 1635 1636 /** 1637 * drm_connector_get - acquire a connector reference 1638 * @connector: DRM connector 1639 * 1640 * This function increments the connector's refcount. 1641 */ 1642 static inline void drm_connector_get(struct drm_connector *connector) 1643 { 1644 drm_mode_object_get(&connector->base); 1645 } 1646 1647 /** 1648 * drm_connector_put - release a connector reference 1649 * @connector: DRM connector 1650 * 1651 * This function decrements the connector's reference count and frees the 1652 * object if the reference count drops to zero. 1653 */ 1654 static inline void drm_connector_put(struct drm_connector *connector) 1655 { 1656 drm_mode_object_put(&connector->base); 1657 } 1658 1659 /** 1660 * drm_connector_is_unregistered - has the connector been unregistered from 1661 * userspace? 1662 * @connector: DRM connector 1663 * 1664 * Checks whether or not @connector has been unregistered from userspace. 1665 * 1666 * Returns: 1667 * True if the connector was unregistered, false if the connector is 1668 * registered or has not yet been registered with userspace. 1669 */ 1670 static inline bool 1671 drm_connector_is_unregistered(struct drm_connector *connector) 1672 { 1673 return READ_ONCE(connector->registration_state) == 1674 DRM_CONNECTOR_UNREGISTERED; 1675 } 1676 1677 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode); 1678 const char *drm_get_connector_type_name(unsigned int connector_type); 1679 const char *drm_get_connector_status_name(enum drm_connector_status status); 1680 const char *drm_get_subpixel_order_name(enum subpixel_order order); 1681 const char *drm_get_dpms_name(int val); 1682 const char *drm_get_dvi_i_subconnector_name(int val); 1683 const char *drm_get_dvi_i_select_name(int val); 1684 const char *drm_get_tv_subconnector_name(int val); 1685 const char *drm_get_tv_select_name(int val); 1686 const char *drm_get_dp_subconnector_name(int val); 1687 const char *drm_get_content_protection_name(int val); 1688 const char *drm_get_hdcp_content_type_name(int val); 1689 1690 int drm_mode_create_dvi_i_properties(struct drm_device *dev); 1691 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector); 1692 1693 int drm_mode_create_tv_margin_properties(struct drm_device *dev); 1694 int drm_mode_create_tv_properties(struct drm_device *dev, 1695 unsigned int num_modes, 1696 const char * const modes[]); 1697 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn); 1698 int drm_mode_create_scaling_mode_property(struct drm_device *dev); 1699 int drm_connector_attach_content_type_property(struct drm_connector *dev); 1700 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector, 1701 u32 scaling_mode_mask); 1702 int drm_connector_attach_vrr_capable_property( 1703 struct drm_connector *connector); 1704 int drm_connector_attach_colorspace_property(struct drm_connector *connector); 1705 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector); 1706 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state, 1707 struct drm_connector_state *new_state); 1708 int drm_mode_create_aspect_ratio_property(struct drm_device *dev); 1709 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector); 1710 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector); 1711 int drm_mode_create_content_type_property(struct drm_device *dev); 1712 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame, 1713 const struct drm_connector_state *conn_state); 1714 1715 int drm_mode_create_suggested_offset_properties(struct drm_device *dev); 1716 1717 int drm_connector_set_path_property(struct drm_connector *connector, 1718 const char *path); 1719 int drm_connector_set_tile_property(struct drm_connector *connector); 1720 int drm_connector_update_edid_property(struct drm_connector *connector, 1721 const struct edid *edid); 1722 void drm_connector_set_link_status_property(struct drm_connector *connector, 1723 uint64_t link_status); 1724 void drm_connector_set_vrr_capable_property( 1725 struct drm_connector *connector, bool capable); 1726 int drm_connector_set_panel_orientation( 1727 struct drm_connector *connector, 1728 enum drm_panel_orientation panel_orientation); 1729 int drm_connector_set_panel_orientation_with_quirk( 1730 struct drm_connector *connector, 1731 enum drm_panel_orientation panel_orientation, 1732 int width, int height); 1733 int drm_connector_attach_max_bpc_property(struct drm_connector *connector, 1734 int min, int max); 1735 1736 /** 1737 * struct drm_tile_group - Tile group metadata 1738 * @refcount: reference count 1739 * @dev: DRM device 1740 * @id: tile group id exposed to userspace 1741 * @group_data: Sink-private data identifying this group 1742 * 1743 * @group_data corresponds to displayid vend/prod/serial for external screens 1744 * with an EDID. 1745 */ 1746 struct drm_tile_group { 1747 struct kref refcount; 1748 struct drm_device *dev; 1749 int id; 1750 u8 group_data[8]; 1751 }; 1752 1753 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev, 1754 const char topology[8]); 1755 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev, 1756 const char topology[8]); 1757 void drm_mode_put_tile_group(struct drm_device *dev, 1758 struct drm_tile_group *tg); 1759 1760 /** 1761 * struct drm_connector_list_iter - connector_list iterator 1762 * 1763 * This iterator tracks state needed to be able to walk the connector_list 1764 * within struct drm_mode_config. Only use together with 1765 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and 1766 * drm_connector_list_iter_next() respectively the convenience macro 1767 * drm_for_each_connector_iter(). 1768 * 1769 * Note that the return value of drm_connector_list_iter_next() is only valid 1770 * up to the next drm_connector_list_iter_next() or 1771 * drm_connector_list_iter_end() call. If you want to use the connector later, 1772 * then you need to grab your own reference first using drm_connector_get(). 1773 */ 1774 struct drm_connector_list_iter { 1775 /* private: */ 1776 struct drm_device *dev; 1777 struct drm_connector *conn; 1778 }; 1779 1780 void drm_connector_list_iter_begin(struct drm_device *dev, 1781 struct drm_connector_list_iter *iter); 1782 struct drm_connector * 1783 drm_connector_list_iter_next(struct drm_connector_list_iter *iter); 1784 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter); 1785 1786 bool drm_connector_has_possible_encoder(struct drm_connector *connector, 1787 struct drm_encoder *encoder); 1788 1789 /** 1790 * drm_for_each_connector_iter - connector_list iterator macro 1791 * @connector: &struct drm_connector pointer used as cursor 1792 * @iter: &struct drm_connector_list_iter 1793 * 1794 * Note that @connector is only valid within the list body, if you want to use 1795 * @connector after calling drm_connector_list_iter_end() then you need to grab 1796 * your own reference first using drm_connector_get(). 1797 */ 1798 #define drm_for_each_connector_iter(connector, iter) \ 1799 while ((connector = drm_connector_list_iter_next(iter))) 1800 1801 /** 1802 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders 1803 * @connector: &struct drm_connector pointer 1804 * @encoder: &struct drm_encoder pointer used as cursor 1805 */ 1806 #define drm_connector_for_each_possible_encoder(connector, encoder) \ 1807 drm_for_each_encoder_mask(encoder, (connector)->dev, \ 1808 (connector)->possible_encoders) 1809 1810 #endif 1811