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