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