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