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_tv_connector_state - TV connector related states 468 * @subconnector: selected subconnector 469 * @margins: margins (all margins are expressed in pixels) 470 * @margins.left: left margin 471 * @margins.right: right margin 472 * @margins.top: top margin 473 * @margins.bottom: bottom margin 474 * @mode: TV mode 475 * @brightness: brightness in percent 476 * @contrast: contrast in percent 477 * @flicker_reduction: flicker reduction in percent 478 * @overscan: overscan in percent 479 * @saturation: saturation in percent 480 * @hue: hue in percent 481 */ 482 struct drm_tv_connector_state { 483 enum drm_mode_subconnector subconnector; 484 struct { 485 unsigned int left; 486 unsigned int right; 487 unsigned int top; 488 unsigned int bottom; 489 } margins; 490 unsigned int mode; 491 unsigned int brightness; 492 unsigned int contrast; 493 unsigned int flicker_reduction; 494 unsigned int overscan; 495 unsigned int saturation; 496 unsigned int hue; 497 }; 498 499 /** 500 * struct drm_connector_state - mutable connector state 501 */ 502 struct drm_connector_state { 503 /** @connector: backpointer to the connector */ 504 struct drm_connector *connector; 505 506 /** 507 * @crtc: CRTC to connect connector to, NULL if disabled. 508 * 509 * Do not change this directly, use drm_atomic_set_crtc_for_connector() 510 * instead. 511 */ 512 struct drm_crtc *crtc; 513 514 /** 515 * @best_encoder: 516 * 517 * Used by the atomic helpers to select the encoder, through the 518 * &drm_connector_helper_funcs.atomic_best_encoder or 519 * &drm_connector_helper_funcs.best_encoder callbacks. 520 */ 521 struct drm_encoder *best_encoder; 522 523 /** 524 * @link_status: Connector link_status to keep track of whether link is 525 * GOOD or BAD to notify userspace if retraining is necessary. 526 */ 527 enum drm_link_status link_status; 528 529 /** @state: backpointer to global drm_atomic_state */ 530 struct drm_atomic_state *state; 531 532 /** 533 * @commit: Tracks the pending commit to prevent use-after-free conditions. 534 * 535 * Is only set when @crtc is NULL. 536 */ 537 struct drm_crtc_commit *commit; 538 539 /** @tv: TV connector state */ 540 struct drm_tv_connector_state tv; 541 542 /** 543 * @picture_aspect_ratio: Connector property to control the 544 * HDMI infoframe aspect ratio setting. 545 * 546 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the 547 * values for &enum hdmi_picture_aspect 548 */ 549 enum hdmi_picture_aspect picture_aspect_ratio; 550 551 /** 552 * @content_type: Connector property to control the 553 * HDMI infoframe content type setting. 554 * The %DRM_MODE_CONTENT_TYPE_\* values much 555 * match the values. 556 */ 557 unsigned int content_type; 558 559 /** 560 * @scaling_mode: Connector property to control the 561 * upscaling, mostly used for built-in panels. 562 */ 563 unsigned int scaling_mode; 564 565 /** 566 * @content_protection: Connector property to request content 567 * protection. This is most commonly used for HDCP. 568 */ 569 unsigned int content_protection; 570 571 /** 572 * @colorspace: State variable for Connector property to request 573 * colorspace change on Sink. This is most commonly used to switch 574 * to wider color gamuts like BT2020. 575 */ 576 u32 colorspace; 577 578 /** 579 * @writeback_job: Writeback job for writeback connectors 580 * 581 * Holds the framebuffer and out-fence for a writeback connector. As 582 * the writeback completion may be asynchronous to the normal commit 583 * cycle, the writeback job lifetime is managed separately from the 584 * normal atomic state by this object. 585 * 586 * See also: drm_writeback_queue_job() and 587 * drm_writeback_signal_completion() 588 */ 589 struct drm_writeback_job *writeback_job; 590 591 /** 592 * @max_requested_bpc: Connector property to limit the maximum bit 593 * depth of the pixels. 594 */ 595 u8 max_requested_bpc; 596 597 /** 598 * @max_bpc: Connector max_bpc based on the requested max_bpc property 599 * and the connector bpc limitations obtained from edid. 600 */ 601 u8 max_bpc; 602 }; 603 604 /** 605 * struct drm_connector_funcs - control connectors on a given device 606 * 607 * Each CRTC may have one or more connectors attached to it. The functions 608 * below allow the core DRM code to control connectors, enumerate available modes, 609 * etc. 610 */ 611 struct drm_connector_funcs { 612 /** 613 * @dpms: 614 * 615 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS 616 * is exposed as a standard property on the connector, but diverted to 617 * this callback in the drm core. Note that atomic drivers don't 618 * implement the 4 level DPMS support on the connector any more, but 619 * instead only have an on/off "ACTIVE" property on the CRTC object. 620 * 621 * This hook is not used by atomic drivers, remapping of the legacy DPMS 622 * property is entirely handled in the DRM core. 623 * 624 * RETURNS: 625 * 626 * 0 on success or a negative error code on failure. 627 */ 628 int (*dpms)(struct drm_connector *connector, int mode); 629 630 /** 631 * @reset: 632 * 633 * Reset connector hardware and software state to off. This function isn't 634 * called by the core directly, only through drm_mode_config_reset(). 635 * It's not a helper hook only for historical reasons. 636 * 637 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset 638 * atomic state using this hook. 639 */ 640 void (*reset)(struct drm_connector *connector); 641 642 /** 643 * @detect: 644 * 645 * Check to see if anything is attached to the connector. The parameter 646 * force is set to false whilst polling, true when checking the 647 * connector due to a user request. force can be used by the driver to 648 * avoid expensive, destructive operations during automated probing. 649 * 650 * This callback is optional, if not implemented the connector will be 651 * considered as always being attached. 652 * 653 * FIXME: 654 * 655 * Note that this hook is only called by the probe helper. It's not in 656 * the helper library vtable purely for historical reasons. The only DRM 657 * core entry point to probe connector state is @fill_modes. 658 * 659 * Note that the helper library will already hold 660 * &drm_mode_config.connection_mutex. Drivers which need to grab additional 661 * locks to avoid races with concurrent modeset changes need to use 662 * &drm_connector_helper_funcs.detect_ctx instead. 663 * 664 * RETURNS: 665 * 666 * drm_connector_status indicating the connector's status. 667 */ 668 enum drm_connector_status (*detect)(struct drm_connector *connector, 669 bool force); 670 671 /** 672 * @force: 673 * 674 * This function is called to update internal encoder state when the 675 * connector is forced to a certain state by userspace, either through 676 * the sysfs interfaces or on the kernel cmdline. In that case the 677 * @detect callback isn't called. 678 * 679 * FIXME: 680 * 681 * Note that this hook is only called by the probe helper. It's not in 682 * the helper library vtable purely for historical reasons. The only DRM 683 * core entry point to probe connector state is @fill_modes. 684 */ 685 void (*force)(struct drm_connector *connector); 686 687 /** 688 * @fill_modes: 689 * 690 * Entry point for output detection and basic mode validation. The 691 * driver should reprobe the output if needed (e.g. when hotplug 692 * handling is unreliable), add all detected modes to &drm_connector.modes 693 * and filter out any the device can't support in any configuration. It 694 * also needs to filter out any modes wider or higher than the 695 * parameters max_width and max_height indicate. 696 * 697 * The drivers must also prune any modes no longer valid from 698 * &drm_connector.modes. Furthermore it must update 699 * &drm_connector.status and &drm_connector.edid. If no EDID has been 700 * received for this output connector->edid must be NULL. 701 * 702 * Drivers using the probe helpers should use 703 * drm_helper_probe_single_connector_modes() to implement this 704 * function. 705 * 706 * RETURNS: 707 * 708 * The number of modes detected and filled into &drm_connector.modes. 709 */ 710 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height); 711 712 /** 713 * @set_property: 714 * 715 * This is the legacy entry point to update a property attached to the 716 * connector. 717 * 718 * This callback is optional if the driver does not support any legacy 719 * driver-private properties. For atomic drivers it is not used because 720 * property handling is done entirely in the DRM core. 721 * 722 * RETURNS: 723 * 724 * 0 on success or a negative error code on failure. 725 */ 726 int (*set_property)(struct drm_connector *connector, struct drm_property *property, 727 uint64_t val); 728 729 /** 730 * @late_register: 731 * 732 * This optional hook can be used to register additional userspace 733 * interfaces attached to the connector, light backlight control, i2c, 734 * DP aux or similar interfaces. It is called late in the driver load 735 * sequence from drm_connector_register() when registering all the 736 * core drm connector interfaces. Everything added from this callback 737 * should be unregistered in the early_unregister callback. 738 * 739 * This is called while holding &drm_connector.mutex. 740 * 741 * Returns: 742 * 743 * 0 on success, or a negative error code on failure. 744 */ 745 int (*late_register)(struct drm_connector *connector); 746 747 /** 748 * @early_unregister: 749 * 750 * This optional hook should be used to unregister the additional 751 * userspace interfaces attached to the connector from 752 * late_register(). It is called from drm_connector_unregister(), 753 * early in the driver unload sequence to disable userspace access 754 * before data structures are torndown. 755 * 756 * This is called while holding &drm_connector.mutex. 757 */ 758 void (*early_unregister)(struct drm_connector *connector); 759 760 /** 761 * @destroy: 762 * 763 * Clean up connector resources. This is called at driver unload time 764 * through drm_mode_config_cleanup(). It can also be called at runtime 765 * when a connector is being hot-unplugged for drivers that support 766 * connector hotplugging (e.g. DisplayPort MST). 767 */ 768 void (*destroy)(struct drm_connector *connector); 769 770 /** 771 * @atomic_duplicate_state: 772 * 773 * Duplicate the current atomic state for this connector and return it. 774 * The core and helpers guarantee that any atomic state duplicated with 775 * this hook and still owned by the caller (i.e. not transferred to the 776 * driver by calling &drm_mode_config_funcs.atomic_commit) will be 777 * cleaned up by calling the @atomic_destroy_state hook in this 778 * structure. 779 * 780 * This callback is mandatory for atomic drivers. 781 * 782 * Atomic drivers which don't subclass &struct drm_connector_state should use 783 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the 784 * state structure to extend it with driver-private state should use 785 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is 786 * duplicated in a consistent fashion across drivers. 787 * 788 * It is an error to call this hook before &drm_connector.state has been 789 * initialized correctly. 790 * 791 * NOTE: 792 * 793 * If the duplicate state references refcounted resources this hook must 794 * acquire a reference for each of them. The driver must release these 795 * references again in @atomic_destroy_state. 796 * 797 * RETURNS: 798 * 799 * Duplicated atomic state or NULL when the allocation failed. 800 */ 801 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector); 802 803 /** 804 * @atomic_destroy_state: 805 * 806 * Destroy a state duplicated with @atomic_duplicate_state and release 807 * or unreference all resources it references 808 * 809 * This callback is mandatory for atomic drivers. 810 */ 811 void (*atomic_destroy_state)(struct drm_connector *connector, 812 struct drm_connector_state *state); 813 814 /** 815 * @atomic_set_property: 816 * 817 * Decode a driver-private property value and store the decoded value 818 * into the passed-in state structure. Since the atomic core decodes all 819 * standardized properties (even for extensions beyond the core set of 820 * properties which might not be implemented by all drivers) this 821 * requires drivers to subclass the state structure. 822 * 823 * Such driver-private properties should really only be implemented for 824 * truly hardware/vendor specific state. Instead it is preferred to 825 * standardize atomic extension and decode the properties used to expose 826 * such an extension in the core. 827 * 828 * Do not call this function directly, use 829 * drm_atomic_connector_set_property() instead. 830 * 831 * This callback is optional if the driver does not support any 832 * driver-private atomic properties. 833 * 834 * NOTE: 835 * 836 * This function is called in the state assembly phase of atomic 837 * modesets, which can be aborted for any reason (including on 838 * userspace's request to just check whether a configuration would be 839 * possible). Drivers MUST NOT touch any persistent state (hardware or 840 * software) or data structures except the passed in @state parameter. 841 * 842 * Also since userspace controls in which order properties are set this 843 * function must not do any input validation (since the state update is 844 * incomplete and hence likely inconsistent). Instead any such input 845 * validation must be done in the various atomic_check callbacks. 846 * 847 * RETURNS: 848 * 849 * 0 if the property has been found, -EINVAL if the property isn't 850 * implemented by the driver (which shouldn't ever happen, the core only 851 * asks for properties attached to this connector). No other validation 852 * is allowed by the driver. The core already checks that the property 853 * value is within the range (integer, valid enum value, ...) the driver 854 * set when registering the property. 855 */ 856 int (*atomic_set_property)(struct drm_connector *connector, 857 struct drm_connector_state *state, 858 struct drm_property *property, 859 uint64_t val); 860 861 /** 862 * @atomic_get_property: 863 * 864 * Reads out the decoded driver-private property. This is used to 865 * implement the GETCONNECTOR IOCTL. 866 * 867 * Do not call this function directly, use 868 * drm_atomic_connector_get_property() instead. 869 * 870 * This callback is optional if the driver does not support any 871 * driver-private atomic properties. 872 * 873 * RETURNS: 874 * 875 * 0 on success, -EINVAL if the property isn't implemented by the 876 * driver (which shouldn't ever happen, the core only asks for 877 * properties attached to this connector). 878 */ 879 int (*atomic_get_property)(struct drm_connector *connector, 880 const struct drm_connector_state *state, 881 struct drm_property *property, 882 uint64_t *val); 883 884 /** 885 * @atomic_print_state: 886 * 887 * If driver subclasses &struct drm_connector_state, it should implement 888 * this optional hook for printing additional driver specific state. 889 * 890 * Do not call this directly, use drm_atomic_connector_print_state() 891 * instead. 892 */ 893 void (*atomic_print_state)(struct drm_printer *p, 894 const struct drm_connector_state *state); 895 }; 896 897 /* mode specified on the command line */ 898 struct drm_cmdline_mode { 899 bool specified; 900 bool refresh_specified; 901 bool bpp_specified; 902 int xres, yres; 903 int bpp; 904 int refresh; 905 bool rb; 906 bool interlace; 907 bool cvt; 908 bool margins; 909 enum drm_connector_force force; 910 }; 911 912 /** 913 * struct drm_connector - central DRM connector control structure 914 * 915 * Each connector may be connected to one or more CRTCs, or may be clonable by 916 * another connector if they can share a CRTC. Each connector also has a specific 917 * position in the broader display (referred to as a 'screen' though it could 918 * span multiple monitors). 919 */ 920 struct drm_connector { 921 /** @dev: parent DRM device */ 922 struct drm_device *dev; 923 /** @kdev: kernel device for sysfs attributes */ 924 struct device *kdev; 925 /** @attr: sysfs attributes */ 926 struct device_attribute *attr; 927 928 /** 929 * @head: 930 * 931 * List of all connectors on a @dev, linked from 932 * &drm_mode_config.connector_list. Protected by 933 * &drm_mode_config.connector_list_lock, but please only use 934 * &drm_connector_list_iter to walk this list. 935 */ 936 struct list_head head; 937 938 /** @base: base KMS object */ 939 struct drm_mode_object base; 940 941 /** @name: human readable name, can be overwritten by the driver */ 942 char *name; 943 944 /** 945 * @mutex: Lock for general connector state, but currently only protects 946 * @registered. Most of the connector state is still protected by 947 * &drm_mode_config.mutex. 948 */ 949 struct mutex mutex; 950 951 /** 952 * @index: Compacted connector index, which matches the position inside 953 * the mode_config.list for drivers not supporting hot-add/removing. Can 954 * be used as an array index. It is invariant over the lifetime of the 955 * connector. 956 */ 957 unsigned index; 958 959 /** 960 * @connector_type: 961 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h 962 */ 963 int connector_type; 964 /** @connector_type_id: index into connector type enum */ 965 int connector_type_id; 966 /** 967 * @interlace_allowed: 968 * Can this connector handle interlaced modes? Only used by 969 * drm_helper_probe_single_connector_modes() for mode filtering. 970 */ 971 bool interlace_allowed; 972 /** 973 * @doublescan_allowed: 974 * Can this connector handle doublescan? Only used by 975 * drm_helper_probe_single_connector_modes() for mode filtering. 976 */ 977 bool doublescan_allowed; 978 /** 979 * @stereo_allowed: 980 * Can this connector handle stereo modes? Only used by 981 * drm_helper_probe_single_connector_modes() for mode filtering. 982 */ 983 bool stereo_allowed; 984 985 /** 986 * @ycbcr_420_allowed : This bool indicates if this connector is 987 * capable of handling YCBCR 420 output. While parsing the EDID 988 * blocks it's very helpful to know if the source is capable of 989 * handling YCBCR 420 outputs. 990 */ 991 bool ycbcr_420_allowed; 992 993 /** 994 * @registration_state: Is this connector initializing, exposed 995 * (registered) with userspace, or unregistered? 996 * 997 * Protected by @mutex. 998 */ 999 enum drm_connector_registration_state registration_state; 1000 1001 /** 1002 * @modes: 1003 * Modes available on this connector (from fill_modes() + user). 1004 * Protected by &drm_mode_config.mutex. 1005 */ 1006 struct list_head modes; 1007 1008 /** 1009 * @status: 1010 * One of the drm_connector_status enums (connected, not, or unknown). 1011 * Protected by &drm_mode_config.mutex. 1012 */ 1013 enum drm_connector_status status; 1014 1015 /** 1016 * @probed_modes: 1017 * These are modes added by probing with DDC or the BIOS, before 1018 * filtering is applied. Used by the probe helpers. Protected by 1019 * &drm_mode_config.mutex. 1020 */ 1021 struct list_head probed_modes; 1022 1023 /** 1024 * @display_info: Display information is filled from EDID information 1025 * when a display is detected. For non hot-pluggable displays such as 1026 * flat panels in embedded systems, the driver should initialize the 1027 * &drm_display_info.width_mm and &drm_display_info.height_mm fields 1028 * with the physical size of the display. 1029 * 1030 * Protected by &drm_mode_config.mutex. 1031 */ 1032 struct drm_display_info display_info; 1033 1034 /** @funcs: connector control functions */ 1035 const struct drm_connector_funcs *funcs; 1036 1037 /** 1038 * @edid_blob_ptr: DRM property containing EDID if present. Protected by 1039 * &drm_mode_config.mutex. This should be updated only by calling 1040 * drm_connector_update_edid_property(). 1041 */ 1042 struct drm_property_blob *edid_blob_ptr; 1043 1044 /** @properties: property tracking for this connector */ 1045 struct drm_object_properties properties; 1046 1047 /** 1048 * @scaling_mode_property: Optional atomic property to control the 1049 * upscaling. See drm_connector_attach_content_protection_property(). 1050 */ 1051 struct drm_property *scaling_mode_property; 1052 1053 /** 1054 * @vrr_capable_property: Optional property to help userspace 1055 * query hardware support for variable refresh rate on a connector. 1056 * connector. Drivers can add the property to a connector by 1057 * calling drm_connector_attach_vrr_capable_property(). 1058 * 1059 * This should be updated only by calling 1060 * drm_connector_set_vrr_capable_property(). 1061 */ 1062 struct drm_property *vrr_capable_property; 1063 1064 /** 1065 * @content_protection_property: DRM ENUM property for content 1066 * protection. See drm_connector_attach_content_protection_property(). 1067 */ 1068 struct drm_property *content_protection_property; 1069 1070 /** 1071 * @colorspace_property: Connector property to set the suitable 1072 * colorspace supported by the sink. 1073 */ 1074 struct drm_property *colorspace_property; 1075 1076 /** 1077 * @path_blob_ptr: 1078 * 1079 * DRM blob property data for the DP MST path property. This should only 1080 * be updated by calling drm_connector_set_path_property(). 1081 */ 1082 struct drm_property_blob *path_blob_ptr; 1083 1084 /** 1085 * @max_bpc_property: Default connector property for the max bpc to be 1086 * driven out of the connector. 1087 */ 1088 struct drm_property *max_bpc_property; 1089 1090 #define DRM_CONNECTOR_POLL_HPD (1 << 0) 1091 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1) 1092 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2) 1093 1094 /** 1095 * @polled: 1096 * 1097 * Connector polling mode, a combination of 1098 * 1099 * DRM_CONNECTOR_POLL_HPD 1100 * The connector generates hotplug events and doesn't need to be 1101 * periodically polled. The CONNECT and DISCONNECT flags must not 1102 * be set together with the HPD flag. 1103 * 1104 * DRM_CONNECTOR_POLL_CONNECT 1105 * Periodically poll the connector for connection. 1106 * 1107 * DRM_CONNECTOR_POLL_DISCONNECT 1108 * Periodically poll the connector for disconnection, without 1109 * causing flickering even when the connector is in use. DACs should 1110 * rarely do this without a lot of testing. 1111 * 1112 * Set to 0 for connectors that don't support connection status 1113 * discovery. 1114 */ 1115 uint8_t polled; 1116 1117 /** 1118 * @dpms: Current dpms state. For legacy drivers the 1119 * &drm_connector_funcs.dpms callback must update this. For atomic 1120 * drivers, this is handled by the core atomic code, and drivers must 1121 * only take &drm_crtc_state.active into account. 1122 */ 1123 int dpms; 1124 1125 /** @helper_private: mid-layer private data */ 1126 const struct drm_connector_helper_funcs *helper_private; 1127 1128 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */ 1129 struct drm_cmdline_mode cmdline_mode; 1130 /** @force: a DRM_FORCE_<foo> state for forced mode sets */ 1131 enum drm_connector_force force; 1132 /** @override_edid: has the EDID been overwritten through debugfs for testing? */ 1133 bool override_edid; 1134 1135 #define DRM_CONNECTOR_MAX_ENCODER 3 1136 /** 1137 * @encoder_ids: Valid encoders for this connector. Please only use 1138 * drm_connector_for_each_possible_encoder() to enumerate these. 1139 */ 1140 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER]; 1141 1142 /** 1143 * @encoder: Currently bound encoder driving this connector, if any. 1144 * Only really meaningful for non-atomic drivers. Atomic drivers should 1145 * instead look at &drm_connector_state.best_encoder, and in case they 1146 * need the CRTC driving this output, &drm_connector_state.crtc. 1147 */ 1148 struct drm_encoder *encoder; 1149 1150 #define MAX_ELD_BYTES 128 1151 /** @eld: EDID-like data, if present */ 1152 uint8_t eld[MAX_ELD_BYTES]; 1153 /** @latency_present: AV delay info from ELD, if found */ 1154 bool latency_present[2]; 1155 /** 1156 * @video_latency: Video latency info from ELD, if found. 1157 * [0]: progressive, [1]: interlaced 1158 */ 1159 int video_latency[2]; 1160 /** 1161 * @audio_latency: audio latency info from ELD, if found 1162 * [0]: progressive, [1]: interlaced 1163 */ 1164 int audio_latency[2]; 1165 /** 1166 * @null_edid_counter: track sinks that give us all zeros for the EDID. 1167 * Needed to workaround some HW bugs where we get all 0s 1168 */ 1169 int null_edid_counter; 1170 1171 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */ 1172 unsigned bad_edid_counter; 1173 1174 /** 1175 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used 1176 * in Displayport compliance testing - Displayport Link CTS Core 1.2 1177 * rev1.1 4.2.2.6 1178 */ 1179 bool edid_corrupt; 1180 1181 /** @debugfs_entry: debugfs directory for this connector */ 1182 struct dentry *debugfs_entry; 1183 1184 /** 1185 * @state: 1186 * 1187 * Current atomic state for this connector. 1188 * 1189 * This is protected by &drm_mode_config.connection_mutex. Note that 1190 * nonblocking atomic commits access the current connector state without 1191 * taking locks. Either by going through the &struct drm_atomic_state 1192 * pointers, see for_each_oldnew_connector_in_state(), 1193 * for_each_old_connector_in_state() and 1194 * for_each_new_connector_in_state(). Or through careful ordering of 1195 * atomic commit operations as implemented in the atomic helpers, see 1196 * &struct drm_crtc_commit. 1197 */ 1198 struct drm_connector_state *state; 1199 1200 /* DisplayID bits. FIXME: Extract into a substruct? */ 1201 1202 /** 1203 * @tile_blob_ptr: 1204 * 1205 * DRM blob property data for the tile property (used mostly by DP MST). 1206 * This is meant for screens which are driven through separate display 1207 * pipelines represented by &drm_crtc, which might not be running with 1208 * genlocked clocks. For tiled panels which are genlocked, like 1209 * dual-link LVDS or dual-link DSI, the driver should try to not expose 1210 * the tiling and virtualize both &drm_crtc and &drm_plane if needed. 1211 * 1212 * This should only be updated by calling 1213 * drm_connector_set_tile_property(). 1214 */ 1215 struct drm_property_blob *tile_blob_ptr; 1216 1217 /** @has_tile: is this connector connected to a tiled monitor */ 1218 bool has_tile; 1219 /** @tile_group: tile group for the connected monitor */ 1220 struct drm_tile_group *tile_group; 1221 /** @tile_is_single_monitor: whether the tile is one monitor housing */ 1222 bool tile_is_single_monitor; 1223 1224 /** @num_h_tile: number of horizontal tiles in the tile group */ 1225 /** @num_v_tile: number of vertical tiles in the tile group */ 1226 uint8_t num_h_tile, num_v_tile; 1227 /** @tile_h_loc: horizontal location of this tile */ 1228 /** @tile_v_loc: vertical location of this tile */ 1229 uint8_t tile_h_loc, tile_v_loc; 1230 /** @tile_h_size: horizontal size of this tile. */ 1231 /** @tile_v_size: vertical size of this tile. */ 1232 uint16_t tile_h_size, tile_v_size; 1233 1234 /** 1235 * @free_node: 1236 * 1237 * List used only by &drm_connector_list_iter to be able to clean up a 1238 * connector from any context, in conjunction with 1239 * &drm_mode_config.connector_free_work. 1240 */ 1241 struct llist_node free_node; 1242 }; 1243 1244 #define obj_to_connector(x) container_of(x, struct drm_connector, base) 1245 1246 int drm_connector_init(struct drm_device *dev, 1247 struct drm_connector *connector, 1248 const struct drm_connector_funcs *funcs, 1249 int connector_type); 1250 void drm_connector_attach_edid_property(struct drm_connector *connector); 1251 int drm_connector_register(struct drm_connector *connector); 1252 void drm_connector_unregister(struct drm_connector *connector); 1253 int drm_connector_attach_encoder(struct drm_connector *connector, 1254 struct drm_encoder *encoder); 1255 1256 void drm_connector_cleanup(struct drm_connector *connector); 1257 1258 static inline unsigned int drm_connector_index(const struct drm_connector *connector) 1259 { 1260 return connector->index; 1261 } 1262 1263 static inline u32 drm_connector_mask(const struct drm_connector *connector) 1264 { 1265 return 1 << connector->index; 1266 } 1267 1268 /** 1269 * drm_connector_lookup - lookup connector object 1270 * @dev: DRM device 1271 * @file_priv: drm file to check for lease against. 1272 * @id: connector object id 1273 * 1274 * This function looks up the connector object specified by id 1275 * add takes a reference to it. 1276 */ 1277 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev, 1278 struct drm_file *file_priv, 1279 uint32_t id) 1280 { 1281 struct drm_mode_object *mo; 1282 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR); 1283 return mo ? obj_to_connector(mo) : NULL; 1284 } 1285 1286 /** 1287 * drm_connector_get - acquire a connector reference 1288 * @connector: DRM connector 1289 * 1290 * This function increments the connector's refcount. 1291 */ 1292 static inline void drm_connector_get(struct drm_connector *connector) 1293 { 1294 drm_mode_object_get(&connector->base); 1295 } 1296 1297 /** 1298 * drm_connector_put - release a connector reference 1299 * @connector: DRM connector 1300 * 1301 * This function decrements the connector's reference count and frees the 1302 * object if the reference count drops to zero. 1303 */ 1304 static inline void drm_connector_put(struct drm_connector *connector) 1305 { 1306 drm_mode_object_put(&connector->base); 1307 } 1308 1309 /** 1310 * drm_connector_is_unregistered - has the connector been unregistered from 1311 * userspace? 1312 * @connector: DRM connector 1313 * 1314 * Checks whether or not @connector has been unregistered from userspace. 1315 * 1316 * Returns: 1317 * True if the connector was unregistered, false if the connector is 1318 * registered or has not yet been registered with userspace. 1319 */ 1320 static inline bool 1321 drm_connector_is_unregistered(struct drm_connector *connector) 1322 { 1323 return READ_ONCE(connector->registration_state) == 1324 DRM_CONNECTOR_UNREGISTERED; 1325 } 1326 1327 const char *drm_get_connector_status_name(enum drm_connector_status status); 1328 const char *drm_get_subpixel_order_name(enum subpixel_order order); 1329 const char *drm_get_dpms_name(int val); 1330 const char *drm_get_dvi_i_subconnector_name(int val); 1331 const char *drm_get_dvi_i_select_name(int val); 1332 const char *drm_get_tv_subconnector_name(int val); 1333 const char *drm_get_tv_select_name(int val); 1334 const char *drm_get_content_protection_name(int val); 1335 1336 int drm_mode_create_dvi_i_properties(struct drm_device *dev); 1337 int drm_mode_create_tv_margin_properties(struct drm_device *dev); 1338 int drm_mode_create_tv_properties(struct drm_device *dev, 1339 unsigned int num_modes, 1340 const char * const modes[]); 1341 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn); 1342 int drm_mode_create_scaling_mode_property(struct drm_device *dev); 1343 int drm_connector_attach_content_type_property(struct drm_connector *dev); 1344 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector, 1345 u32 scaling_mode_mask); 1346 int drm_connector_attach_vrr_capable_property( 1347 struct drm_connector *connector); 1348 int drm_connector_attach_content_protection_property( 1349 struct drm_connector *connector); 1350 int drm_mode_create_aspect_ratio_property(struct drm_device *dev); 1351 int drm_mode_create_colorspace_property(struct drm_connector *connector); 1352 int drm_mode_create_content_type_property(struct drm_device *dev); 1353 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame, 1354 const struct drm_connector_state *conn_state); 1355 1356 int drm_mode_create_suggested_offset_properties(struct drm_device *dev); 1357 1358 int drm_connector_set_path_property(struct drm_connector *connector, 1359 const char *path); 1360 int drm_connector_set_tile_property(struct drm_connector *connector); 1361 int drm_connector_update_edid_property(struct drm_connector *connector, 1362 const struct edid *edid); 1363 void drm_connector_set_link_status_property(struct drm_connector *connector, 1364 uint64_t link_status); 1365 void drm_connector_set_vrr_capable_property( 1366 struct drm_connector *connector, bool capable); 1367 int drm_connector_init_panel_orientation_property( 1368 struct drm_connector *connector, int width, int height); 1369 int drm_connector_attach_max_bpc_property(struct drm_connector *connector, 1370 int min, int max); 1371 1372 /** 1373 * struct drm_tile_group - Tile group metadata 1374 * @refcount: reference count 1375 * @dev: DRM device 1376 * @id: tile group id exposed to userspace 1377 * @group_data: Sink-private data identifying this group 1378 * 1379 * @group_data corresponds to displayid vend/prod/serial for external screens 1380 * with an EDID. 1381 */ 1382 struct drm_tile_group { 1383 struct kref refcount; 1384 struct drm_device *dev; 1385 int id; 1386 u8 group_data[8]; 1387 }; 1388 1389 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev, 1390 char topology[8]); 1391 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev, 1392 char topology[8]); 1393 void drm_mode_put_tile_group(struct drm_device *dev, 1394 struct drm_tile_group *tg); 1395 1396 /** 1397 * struct drm_connector_list_iter - connector_list iterator 1398 * 1399 * This iterator tracks state needed to be able to walk the connector_list 1400 * within struct drm_mode_config. Only use together with 1401 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and 1402 * drm_connector_list_iter_next() respectively the convenience macro 1403 * drm_for_each_connector_iter(). 1404 */ 1405 struct drm_connector_list_iter { 1406 /* private: */ 1407 struct drm_device *dev; 1408 struct drm_connector *conn; 1409 }; 1410 1411 void drm_connector_list_iter_begin(struct drm_device *dev, 1412 struct drm_connector_list_iter *iter); 1413 struct drm_connector * 1414 drm_connector_list_iter_next(struct drm_connector_list_iter *iter); 1415 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter); 1416 1417 bool drm_connector_has_possible_encoder(struct drm_connector *connector, 1418 struct drm_encoder *encoder); 1419 1420 /** 1421 * drm_for_each_connector_iter - connector_list iterator macro 1422 * @connector: &struct drm_connector pointer used as cursor 1423 * @iter: &struct drm_connector_list_iter 1424 * 1425 * Note that @connector is only valid within the list body, if you want to use 1426 * @connector after calling drm_connector_list_iter_end() then you need to grab 1427 * your own reference first using drm_connector_get(). 1428 */ 1429 #define drm_for_each_connector_iter(connector, iter) \ 1430 while ((connector = drm_connector_list_iter_next(iter))) 1431 1432 /** 1433 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders 1434 * @connector: &struct drm_connector pointer 1435 * @encoder: &struct drm_encoder pointer used as cursor 1436 * @__i: int iteration cursor, for macro-internal use 1437 */ 1438 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \ 1439 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \ 1440 (connector)->encoder_ids[(__i)] != 0; (__i)++) \ 1441 for_each_if((encoder) = \ 1442 drm_encoder_find((connector)->dev, NULL, \ 1443 (connector)->encoder_ids[(__i)])) \ 1444 1445 #endif 1446