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