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