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