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