2 * Copyright (c) 2016 Intel Corporation
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.
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
23 #ifndef __DRM_CONNECTOR_H__
24 #define __DRM_CONNECTOR_H__
26 #include <linux/list.h>
27 #include <linux/llist.h>
28 #include <linux/ctype.h>
29 #include <linux/hdmi.h>
30 #include <linux/notifier.h>
31 #include <drm/drm_mode_object.h>
32 #include <drm/drm_util.h>
33 #include <drm/drm_property.h>
35 #include <uapi/drm/drm_mode.h>
37 struct drm_connector_helper_funcs;
38 struct drm_modeset_acquire_ctx;
44 struct drm_property_blob;
46 struct drm_privacy_screen;
50 enum drm_connector_force {
51 DRM_FORCE_UNSPECIFIED,
53 DRM_FORCE_ON, /* force on analog part normally */
54 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
58 * enum drm_connector_status - status for a &drm_connector
60 * This enum is used to track the connector status. There are no separate
61 * #defines for the uapi!
63 enum drm_connector_status {
65 * @connector_status_connected: The connector is definitely connected to
66 * a sink device, and can be enabled.
68 connector_status_connected = 1,
70 * @connector_status_disconnected: The connector isn't connected to a
71 * sink device which can be autodetect. For digital outputs like DP or
72 * HDMI (which can be realiable probed) this means there's really
73 * nothing there. It is driver-dependent whether a connector with this
74 * status can be lit up or not.
76 connector_status_disconnected = 2,
78 * @connector_status_unknown: The connector's status could not be
79 * reliably detected. This happens when probing would either cause
80 * flicker (like load-detection when the connector is in use), or when a
81 * hardware resource isn't available (like when load-detection needs a
82 * free CRTC). It should be possible to light up the connector with one
83 * of the listed fallback modes. For default configuration userspace
84 * should only try to light up connectors with unknown status when
85 * there's not connector with @connector_status_connected.
87 connector_status_unknown = 3,
91 * enum drm_connector_registration_state - userspace registration status for
94 * This enum is used to track the status of initializing a connector and
95 * registering it with userspace, so that DRM can prevent bogus modesets on
96 * connectors that no longer exist.
98 enum drm_connector_registration_state {
100 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
101 * but has yet to be exposed to userspace. There should be no
102 * additional restrictions to how the state of this connector may be
105 DRM_CONNECTOR_INITIALIZING = 0,
108 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
109 * and registered with sysfs, as such it has been exposed to
110 * userspace. There should be no additional restrictions to how the
111 * state of this connector may be modified.
113 DRM_CONNECTOR_REGISTERED = 1,
116 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
117 * to userspace and has since been unregistered and removed from
118 * userspace, or the connector was unregistered before it had a chance
119 * to be exposed to userspace (e.g. still in the
120 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
121 * unregistered, there are additional restrictions to how its state
124 * - An unregistered connector may only have its DPMS changed from
125 * On->Off. Once DPMS is changed to Off, it may not be switched back
127 * - Modesets are not allowed on unregistered connectors, unless they
128 * would result in disabling its assigned CRTCs. This means
129 * disabling a CRTC on an unregistered connector is OK, but enabling
131 * - Removing a CRTC from an unregistered connector is OK, but new
132 * CRTCs may never be assigned to an unregistered connector.
134 DRM_CONNECTOR_UNREGISTERED = 2,
137 enum subpixel_order {
139 SubPixelHorizontalRGB,
140 SubPixelHorizontalBGR,
148 * enum drm_connector_tv_mode - Analog TV output mode
150 * This enum is used to indicate the TV output mode used on an analog TV
153 * WARNING: The values of this enum is uABI since they're exposed in the
154 * "TV mode" connector property.
156 enum drm_connector_tv_mode {
158 * @DRM_MODE_TV_MODE_NTSC: CCIR System M (aka 525-lines)
159 * together with the NTSC Color Encoding.
161 DRM_MODE_TV_MODE_NTSC,
164 * @DRM_MODE_TV_MODE_NTSC_443: Variant of
165 * @DRM_MODE_TV_MODE_NTSC. Uses a color subcarrier frequency
168 DRM_MODE_TV_MODE_NTSC_443,
171 * @DRM_MODE_TV_MODE_NTSC_J: Variant of @DRM_MODE_TV_MODE_NTSC
172 * used in Japan. Uses a black level equals to the blanking
175 DRM_MODE_TV_MODE_NTSC_J,
178 * @DRM_MODE_TV_MODE_PAL: CCIR System B together with the PAL
181 DRM_MODE_TV_MODE_PAL,
184 * @DRM_MODE_TV_MODE_PAL_M: CCIR System M (aka 525-lines)
185 * together with the PAL color encoding
187 DRM_MODE_TV_MODE_PAL_M,
190 * @DRM_MODE_TV_MODE_PAL_N: CCIR System N together with the PAL
191 * color encoding. It uses 625 lines, but has a color subcarrier
192 * frequency of 3.58MHz, the SECAM color space, and narrower
193 * channels compared to most of the other PAL variants.
195 DRM_MODE_TV_MODE_PAL_N,
198 * @DRM_MODE_TV_MODE_SECAM: CCIR System B together with the
199 * SECAM color system.
201 DRM_MODE_TV_MODE_SECAM,
204 * @DRM_MODE_TV_MODE_MAX: Number of analog TV output modes.
206 * Internal implementation detail; this is not uABI.
208 DRM_MODE_TV_MODE_MAX,
212 * struct drm_scrambling: sink's scrambling support.
214 struct drm_scrambling {
216 * @supported: scrambling supported for rates > 340 Mhz.
220 * @low_rates: scrambling supported for rates <= 340 Mhz.
226 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
228 * Provides SCDC register support and capabilities related information on a
229 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
233 * @supported: status control & data channel present.
237 * @read_request: sink is capable of generating scdc read request.
241 * @scrambling: sink's scrambling capabilities
243 struct drm_scrambling scrambling;
247 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink
249 * Describes the DSC support provided by HDMI 2.1 sink.
250 * The information is fetched fom additional HFVSDB blocks defined
253 struct drm_hdmi_dsc_cap {
254 /** @v_1p2: flag for dsc1.2 version support by sink */
257 /** @native_420: Does sink support DSC with 4:2:0 compression */
261 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2
267 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc
271 /** @max_slices: maximum number of Horizontal slices supported by */
274 /** @clk_per_slice : max pixel clock in MHz supported per slice */
277 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */
280 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */
281 u8 max_frl_rate_per_lane;
283 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/
284 u8 total_chunk_kbytes;
288 * struct drm_hdmi_info - runtime information about the connected HDMI sink
290 * Describes if a given display supports advanced HDMI 2.0 features.
291 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
293 struct drm_hdmi_info {
294 /** @scdc: sink's scdc support and capabilities */
295 struct drm_scdc scdc;
298 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
299 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
300 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
303 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
306 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
307 * output also, along with normal HDMI outputs. The max VIC defined by
308 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
311 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
313 /** @y420_dc_modes: bitmap of deep color support index */
316 /** @max_frl_rate_per_lane: support fixed rate link */
317 u8 max_frl_rate_per_lane;
319 /** @max_lanes: supported by sink */
322 /** @dsc_cap: DSC capabilities of the sink */
323 struct drm_hdmi_dsc_cap dsc_cap;
327 * enum drm_link_status - connector's link_status property value
329 * This enum is used as the connector's link status property value.
330 * It is set to the values defined in uapi.
332 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
334 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
337 enum drm_link_status {
338 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
339 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
343 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
345 * This enum is used to track the (LCD) panel orientation. There are no
346 * separate #defines for the uapi!
348 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
349 * panel orientation information (normal
350 * for non panels) in this case the "panel
351 * orientation" connector prop will not be
353 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
354 * top side of the device's casing.
355 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
356 * bottom side of the device's casing, iow
357 * the panel is mounted upside-down.
358 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
359 * top side of the device's casing.
360 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
361 * top side of the device's casing.
363 enum drm_panel_orientation {
364 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
365 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
366 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
367 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
368 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
372 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
375 * This struct is used to store a frequency range supported by panel
376 * as parsed from EDID's detailed monitor range descriptor block.
378 * @min_vfreq: This is the min supported refresh rate in Hz from
379 * EDID's detailed monitor range.
380 * @max_vfreq: This is the max supported refresh rate in Hz from
381 * EDID's detailed monitor range
383 struct drm_monitor_range_info {
389 * struct drm_luminance_range_info - Panel's luminance range for
390 * &drm_display_info. Calculated using data in EDID
392 * This struct is used to store a luminance range supported by panel
393 * as calculated using data from EDID's static hdr metadata.
395 * @min_luminance: This is the min supported luminance value
397 * @max_luminance: This is the max supported luminance value
399 struct drm_luminance_range_info {
405 * enum drm_privacy_screen_status - privacy screen status
407 * This enum is used to track and control the state of the integrated privacy
408 * screen present on some display panels, via the "privacy-screen sw-state"
409 * and "privacy-screen hw-state" properties. Note the _LOCKED enum values
410 * are only valid for the "privacy-screen hw-state" property.
412 * @PRIVACY_SCREEN_DISABLED:
413 * The privacy-screen on the panel is disabled
414 * @PRIVACY_SCREEN_ENABLED:
415 * The privacy-screen on the panel is enabled
416 * @PRIVACY_SCREEN_DISABLED_LOCKED:
417 * The privacy-screen on the panel is disabled and locked (cannot be changed)
418 * @PRIVACY_SCREEN_ENABLED_LOCKED:
419 * The privacy-screen on the panel is enabled and locked (cannot be changed)
421 enum drm_privacy_screen_status {
422 PRIVACY_SCREEN_DISABLED = 0,
423 PRIVACY_SCREEN_ENABLED,
424 PRIVACY_SCREEN_DISABLED_LOCKED,
425 PRIVACY_SCREEN_ENABLED_LOCKED,
429 * enum drm_colorspace - color space
431 * This enum is a consolidated colorimetry list supported by HDMI and
432 * DP protocol standard. The respective connectors will register
433 * a property with the subset of this list (supported by that
434 * respective protocol). Userspace will set the colorspace through
435 * a colorspace property which will be created and exposed to
438 * DP definitions come from the DP v2.0 spec
439 * HDMI definitions come from the CTA-861-H spec
441 * A note on YCC and RGB variants:
443 * Since userspace is not aware of the encoding on the wire
444 * (RGB or YCbCr), drivers are free to pick the appropriate
445 * variant, regardless of what userspace selects. E.g., if
446 * BT2020_RGB is selected by userspace a driver will pick
447 * BT2020_YCC if the encoding on the wire is YUV444 or YUV420.
449 * @DRM_MODE_COLORIMETRY_DEFAULT:
450 * Driver specific behavior.
451 * @DRM_MODE_COLORIMETRY_NO_DATA:
452 * Driver specific behavior.
453 * @DRM_MODE_COLORIMETRY_SMPTE_170M_YCC:
455 * SMPTE ST 170M colorimetry format
456 * @DRM_MODE_COLORIMETRY_BT709_YCC:
458 * ITU-R BT.709 colorimetry format
459 * @DRM_MODE_COLORIMETRY_XVYCC_601:
461 * xvYCC601 colorimetry format
462 * @DRM_MODE_COLORIMETRY_XVYCC_709:
464 * xvYCC709 colorimetry format
465 * @DRM_MODE_COLORIMETRY_SYCC_601:
467 * sYCC601 colorimetry format
468 * @DRM_MODE_COLORIMETRY_OPYCC_601:
470 * opYCC601 colorimetry format
471 * @DRM_MODE_COLORIMETRY_OPRGB:
473 * opRGB colorimetry format
474 * @DRM_MODE_COLORIMETRY_BT2020_CYCC:
476 * ITU-R BT.2020 Y'c C'bc C'rc (constant luminance) colorimetry format
477 * @DRM_MODE_COLORIMETRY_BT2020_RGB:
479 * ITU-R BT.2020 R' G' B' colorimetry format
480 * @DRM_MODE_COLORIMETRY_BT2020_YCC:
482 * ITU-R BT.2020 Y' C'b C'r colorimetry format
483 * @DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65:
485 * SMPTE ST 2113 P3D65 colorimetry format
486 * @DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER:
488 * SMPTE ST 2113 P3DCI colorimetry format
489 * @DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED:
491 * RGB wide gamut fixed point colorimetry format
492 * @DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT:
494 * RGB wide gamut floating point
495 * (scRGB (IEC 61966-2-2)) colorimetry format
496 * @DRM_MODE_COLORIMETRY_BT601_YCC:
498 * ITU-R BT.601 colorimetry format
499 * The DP spec does not say whether this is the 525 or the 625
501 * @DRM_MODE_COLORIMETRY_COUNT:
502 * Not a valid value; merely used four counting
504 enum drm_colorspace {
505 /* For Default case, driver will set the colorspace */
506 DRM_MODE_COLORIMETRY_DEFAULT = 0,
507 /* CEA 861 Normal Colorimetry options */
508 DRM_MODE_COLORIMETRY_NO_DATA = 0,
509 DRM_MODE_COLORIMETRY_SMPTE_170M_YCC = 1,
510 DRM_MODE_COLORIMETRY_BT709_YCC = 2,
511 /* CEA 861 Extended Colorimetry Options */
512 DRM_MODE_COLORIMETRY_XVYCC_601 = 3,
513 DRM_MODE_COLORIMETRY_XVYCC_709 = 4,
514 DRM_MODE_COLORIMETRY_SYCC_601 = 5,
515 DRM_MODE_COLORIMETRY_OPYCC_601 = 6,
516 DRM_MODE_COLORIMETRY_OPRGB = 7,
517 DRM_MODE_COLORIMETRY_BT2020_CYCC = 8,
518 DRM_MODE_COLORIMETRY_BT2020_RGB = 9,
519 DRM_MODE_COLORIMETRY_BT2020_YCC = 10,
520 /* Additional Colorimetry extension added as part of CTA 861.G */
521 DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 = 11,
522 DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER = 12,
523 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
524 DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED = 13,
525 DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT = 14,
526 DRM_MODE_COLORIMETRY_BT601_YCC = 15,
527 DRM_MODE_COLORIMETRY_COUNT
531 * enum drm_bus_flags - bus_flags info for &drm_display_info
533 * This enum defines signal polarities and clock edge information for signals on
534 * a bus as bitmask flags.
536 * The clock edge information is conveyed by two sets of symbols,
537 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
538 * used to describe a bus from the point of view of the transmitter, the
539 * \*_DRIVE_\* flags should be used. When used from the point of view of the
540 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
541 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
542 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
543 * respectively. This simplifies code as signals are usually sampled on the
544 * opposite edge of the driving edge. Transmitters and receivers may however
545 * need to take other signal timings into account to convert between driving
550 * @DRM_BUS_FLAG_DE_LOW:
552 * The Data Enable signal is active low
554 DRM_BUS_FLAG_DE_LOW = BIT(0),
557 * @DRM_BUS_FLAG_DE_HIGH:
559 * The Data Enable signal is active high
561 DRM_BUS_FLAG_DE_HIGH = BIT(1),
564 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
566 * Data is driven on the rising edge of the pixel clock
568 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
571 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
573 * Data is driven on the falling edge of the pixel clock
575 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
578 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
580 * Data is sampled on the rising edge of the pixel clock
582 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
585 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
587 * Data is sampled on the falling edge of the pixel clock
589 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
592 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
594 * Data is transmitted MSB to LSB on the bus
596 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
599 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
601 * Data is transmitted LSB to MSB on the bus
603 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
606 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
608 * Sync signals are driven on the rising edge of the pixel clock
610 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
613 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
615 * Sync signals are driven on the falling edge of the pixel clock
617 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
620 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
622 * Sync signals are sampled on the rising edge of the pixel clock
624 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
627 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
629 * Sync signals are sampled on the falling edge of the pixel clock
631 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
634 * @DRM_BUS_FLAG_SHARP_SIGNALS:
636 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
638 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
642 * struct drm_display_info - runtime data about the connected sink
644 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
645 * fixed display sinks like built-in panels there's not much difference between
646 * this and &struct drm_connector. But for sinks with a real cable this
647 * structure is meant to describe all the things at the other end of the cable.
649 * For sinks which provide an EDID this can be filled out by calling
650 * drm_add_edid_modes().
652 struct drm_display_info {
654 * @width_mm: Physical width in mm.
656 unsigned int width_mm;
659 * @height_mm: Physical height in mm.
661 unsigned int height_mm;
664 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
669 * @subpixel_order: Subpixel order of LCD panels.
671 enum subpixel_order subpixel_order;
673 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
674 #define DRM_COLOR_FORMAT_YCBCR444 (1<<1)
675 #define DRM_COLOR_FORMAT_YCBCR422 (1<<2)
676 #define DRM_COLOR_FORMAT_YCBCR420 (1<<3)
679 * @panel_orientation: Read only connector property for built-in panels,
680 * indicating the orientation of the panel vs the device's casing.
681 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
682 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
683 * fb to compensate and gets exported as prop to userspace.
685 int panel_orientation;
688 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
689 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
690 * as used to describe the pixel format in framebuffers, and also don't
691 * match the formats in @bus_formats which are shared with v4l.
696 * @bus_formats: Pixel data format on the wire, somewhat redundant with
697 * @color_formats. Array of size @num_bus_formats encoded using
698 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
700 const u32 *bus_formats;
702 * @num_bus_formats: Size of @bus_formats array.
704 unsigned int num_bus_formats;
707 * @bus_flags: Additional information (like pixel signal polarity) for
708 * the pixel data on the bus, using &enum drm_bus_flags values
714 * @max_tmds_clock: Maximum TMDS clock rate supported by the
715 * sink in kHz. 0 means undefined.
720 * @dvi_dual: Dual-link DVI sink?
725 * @is_hdmi: True if the sink is an HDMI device.
727 * This field shall be used instead of calling
728 * drm_detect_hdmi_monitor() when possible.
733 * @has_audio: True if the sink supports audio.
735 * This field shall be used instead of calling
736 * drm_detect_monitor_audio() when possible.
741 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
743 bool has_hdmi_infoframe;
746 * @rgb_quant_range_selectable: Does the sink support selecting
747 * the RGB quantization range?
749 bool rgb_quant_range_selectable;
752 * @edid_hdmi_rgb444_dc_modes: Mask of supported hdmi deep color modes
753 * in RGB 4:4:4. Even more stuff redundant with @bus_formats.
755 u8 edid_hdmi_rgb444_dc_modes;
758 * @edid_hdmi_ycbcr444_dc_modes: Mask of supported hdmi deep color
759 * modes in YCbCr 4:4:4. Even more stuff redundant with @bus_formats.
761 u8 edid_hdmi_ycbcr444_dc_modes;
764 * @cea_rev: CEA revision of the HDMI sink.
769 * @hdmi: advance features of a HDMI sink.
771 struct drm_hdmi_info hdmi;
774 * @non_desktop: Non desktop display (HMD).
779 * @monitor_range: Frequency range supported by monitor range descriptor
781 struct drm_monitor_range_info monitor_range;
784 * @luminance_range: Luminance range supported by panel
786 struct drm_luminance_range_info luminance_range;
789 * @mso_stream_count: eDP Multi-SST Operation (MSO) stream count from
790 * the DisplayID VESA vendor block. 0 for conventional Single-Stream
791 * Transport (SST), or 2 or 4 MSO streams.
796 * @mso_pixel_overlap: eDP MSO segment pixel overlap, 0-8 pixels.
798 u8 mso_pixel_overlap;
801 * @max_dsc_bpp: Maximum DSC target bitrate, if it is set to 0 the
802 * monitor's default value is used instead.
807 * @vics: Array of vics_len VICs. Internal to EDID parsing.
812 * @vics_len: Number of elements in vics. Internal to EDID parsing.
817 * @quirks: EDID based quirks. Internal to EDID parsing.
822 * @source_physical_address: Source Physical Address from HDMI
823 * Vendor-Specific Data Block, for CEC usage.
825 * Defaults to CEC_PHYS_ADDR_INVALID (0xffff).
827 u16 source_physical_address;
830 int drm_display_info_set_bus_formats(struct drm_display_info *info,
832 unsigned int num_formats);
835 * struct drm_connector_tv_margins - TV connector related margins
837 * Describes the margins in pixels to put around the image on TV
838 * connectors to deal with overscan.
840 struct drm_connector_tv_margins {
842 * @bottom: Bottom margin in pixels.
847 * @left: Left margin in pixels.
852 * @right: Right margin in pixels.
857 * @top: Top margin in pixels.
863 * struct drm_tv_connector_state - TV connector related states
864 * @select_subconnector: selected subconnector
865 * @subconnector: detected subconnector
866 * @margins: TV margins
867 * @legacy_mode: Legacy TV mode, driver specific value
869 * @brightness: brightness in percent
870 * @contrast: contrast in percent
871 * @flicker_reduction: flicker reduction in percent
872 * @overscan: overscan in percent
873 * @saturation: saturation in percent
874 * @hue: hue in percent
876 struct drm_tv_connector_state {
877 enum drm_mode_subconnector select_subconnector;
878 enum drm_mode_subconnector subconnector;
879 struct drm_connector_tv_margins margins;
880 unsigned int legacy_mode;
882 unsigned int brightness;
883 unsigned int contrast;
884 unsigned int flicker_reduction;
885 unsigned int overscan;
886 unsigned int saturation;
891 * struct drm_connector_state - mutable connector state
893 struct drm_connector_state {
894 /** @connector: backpointer to the connector */
895 struct drm_connector *connector;
898 * @crtc: CRTC to connect connector to, NULL if disabled.
900 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
903 struct drm_crtc *crtc;
908 * Used by the atomic helpers to select the encoder, through the
909 * &drm_connector_helper_funcs.atomic_best_encoder or
910 * &drm_connector_helper_funcs.best_encoder callbacks.
912 * This is also used in the atomic helpers to map encoders to their
913 * current and previous connectors, see
914 * drm_atomic_get_old_connector_for_encoder() and
915 * drm_atomic_get_new_connector_for_encoder().
917 * NOTE: Atomic drivers must fill this out (either themselves or through
918 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
919 * not return correct data to userspace.
921 struct drm_encoder *best_encoder;
924 * @link_status: Connector link_status to keep track of whether link is
925 * GOOD or BAD to notify userspace if retraining is necessary.
927 enum drm_link_status link_status;
929 /** @state: backpointer to global drm_atomic_state */
930 struct drm_atomic_state *state;
933 * @commit: Tracks the pending commit to prevent use-after-free conditions.
935 * Is only set when @crtc is NULL.
937 struct drm_crtc_commit *commit;
939 /** @tv: TV connector state */
940 struct drm_tv_connector_state tv;
943 * @self_refresh_aware:
945 * This tracks whether a connector is aware of the self refresh state.
946 * It should be set to true for those connector implementations which
947 * understand the self refresh state. This is needed since the crtc
948 * registers the self refresh helpers and it doesn't know if the
949 * connectors downstream have implemented self refresh entry/exit.
951 * Drivers should set this to true in atomic_check if they know how to
952 * handle self_refresh requests.
954 bool self_refresh_aware;
957 * @picture_aspect_ratio: Connector property to control the
958 * HDMI infoframe aspect ratio setting.
960 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
961 * values for &enum hdmi_picture_aspect
963 enum hdmi_picture_aspect picture_aspect_ratio;
966 * @content_type: Connector property to control the
967 * HDMI infoframe content type setting.
968 * The %DRM_MODE_CONTENT_TYPE_\* values much
971 unsigned int content_type;
974 * @hdcp_content_type: Connector property to pass the type of
975 * protected content. This is most commonly used for HDCP.
977 unsigned int hdcp_content_type;
980 * @scaling_mode: Connector property to control the
981 * upscaling, mostly used for built-in panels.
983 unsigned int scaling_mode;
986 * @content_protection: Connector property to request content
987 * protection. This is most commonly used for HDCP.
989 unsigned int content_protection;
992 * @colorspace: State variable for Connector property to request
993 * colorspace change on Sink. This is most commonly used to switch
994 * to wider color gamuts like BT2020.
996 enum drm_colorspace colorspace;
999 * @writeback_job: Writeback job for writeback connectors
1001 * Holds the framebuffer and out-fence for a writeback connector. As
1002 * the writeback completion may be asynchronous to the normal commit
1003 * cycle, the writeback job lifetime is managed separately from the
1004 * normal atomic state by this object.
1006 * See also: drm_writeback_queue_job() and
1007 * drm_writeback_signal_completion()
1009 struct drm_writeback_job *writeback_job;
1012 * @max_requested_bpc: Connector property to limit the maximum bit
1013 * depth of the pixels.
1015 u8 max_requested_bpc;
1018 * @max_bpc: Connector max_bpc based on the requested max_bpc property
1019 * and the connector bpc limitations obtained from edid.
1024 * @privacy_screen_sw_state: See :ref:`Standard Connector
1025 * Properties<standard_connector_properties>`
1027 enum drm_privacy_screen_status privacy_screen_sw_state;
1030 * @hdr_output_metadata:
1031 * DRM blob property for HDR output metadata
1033 struct drm_property_blob *hdr_output_metadata;
1037 * struct drm_connector_funcs - control connectors on a given device
1039 * Each CRTC may have one or more connectors attached to it. The functions
1040 * below allow the core DRM code to control connectors, enumerate available modes,
1043 struct drm_connector_funcs {
1047 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
1048 * is exposed as a standard property on the connector, but diverted to
1049 * this callback in the drm core. Note that atomic drivers don't
1050 * implement the 4 level DPMS support on the connector any more, but
1051 * instead only have an on/off "ACTIVE" property on the CRTC object.
1053 * This hook is not used by atomic drivers, remapping of the legacy DPMS
1054 * property is entirely handled in the DRM core.
1058 * 0 on success or a negative error code on failure.
1060 int (*dpms)(struct drm_connector *connector, int mode);
1065 * Reset connector hardware and software state to off. This function isn't
1066 * called by the core directly, only through drm_mode_config_reset().
1067 * It's not a helper hook only for historical reasons.
1069 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
1070 * atomic state using this hook.
1072 void (*reset)(struct drm_connector *connector);
1077 * Check to see if anything is attached to the connector. The parameter
1078 * force is set to false whilst polling, true when checking the
1079 * connector due to a user request. force can be used by the driver to
1080 * avoid expensive, destructive operations during automated probing.
1082 * This callback is optional, if not implemented the connector will be
1083 * considered as always being attached.
1087 * Note that this hook is only called by the probe helper. It's not in
1088 * the helper library vtable purely for historical reasons. The only DRM
1089 * core entry point to probe connector state is @fill_modes.
1091 * Note that the helper library will already hold
1092 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
1093 * locks to avoid races with concurrent modeset changes need to use
1094 * &drm_connector_helper_funcs.detect_ctx instead.
1096 * Also note that this callback can be called no matter the
1097 * state the connector is in. Drivers that need the underlying
1098 * device to be powered to perform the detection will first need
1099 * to make sure it's been properly enabled.
1103 * drm_connector_status indicating the connector's status.
1105 enum drm_connector_status (*detect)(struct drm_connector *connector,
1111 * This function is called to update internal encoder state when the
1112 * connector is forced to a certain state by userspace, either through
1113 * the sysfs interfaces or on the kernel cmdline. In that case the
1114 * @detect callback isn't called.
1118 * Note that this hook is only called by the probe helper. It's not in
1119 * the helper library vtable purely for historical reasons. The only DRM
1120 * core entry point to probe connector state is @fill_modes.
1122 void (*force)(struct drm_connector *connector);
1127 * Entry point for output detection and basic mode validation. The
1128 * driver should reprobe the output if needed (e.g. when hotplug
1129 * handling is unreliable), add all detected modes to &drm_connector.modes
1130 * and filter out any the device can't support in any configuration. It
1131 * also needs to filter out any modes wider or higher than the
1132 * parameters max_width and max_height indicate.
1134 * The drivers must also prune any modes no longer valid from
1135 * &drm_connector.modes. Furthermore it must update
1136 * &drm_connector.status and &drm_connector.edid. If no EDID has been
1137 * received for this output connector->edid must be NULL.
1139 * Drivers using the probe helpers should use
1140 * drm_helper_probe_single_connector_modes() to implement this
1145 * The number of modes detected and filled into &drm_connector.modes.
1147 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
1152 * This is the legacy entry point to update a property attached to the
1155 * This callback is optional if the driver does not support any legacy
1156 * driver-private properties. For atomic drivers it is not used because
1157 * property handling is done entirely in the DRM core.
1161 * 0 on success or a negative error code on failure.
1163 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
1169 * This optional hook can be used to register additional userspace
1170 * interfaces attached to the connector, light backlight control, i2c,
1171 * DP aux or similar interfaces. It is called late in the driver load
1172 * sequence from drm_connector_register() when registering all the
1173 * core drm connector interfaces. Everything added from this callback
1174 * should be unregistered in the early_unregister callback.
1176 * This is called while holding &drm_connector.mutex.
1180 * 0 on success, or a negative error code on failure.
1182 int (*late_register)(struct drm_connector *connector);
1185 * @early_unregister:
1187 * This optional hook should be used to unregister the additional
1188 * userspace interfaces attached to the connector from
1189 * late_register(). It is called from drm_connector_unregister(),
1190 * early in the driver unload sequence to disable userspace access
1191 * before data structures are torndown.
1193 * This is called while holding &drm_connector.mutex.
1195 void (*early_unregister)(struct drm_connector *connector);
1200 * Clean up connector resources. This is called at driver unload time
1201 * through drm_mode_config_cleanup(). It can also be called at runtime
1202 * when a connector is being hot-unplugged for drivers that support
1203 * connector hotplugging (e.g. DisplayPort MST).
1205 void (*destroy)(struct drm_connector *connector);
1208 * @atomic_duplicate_state:
1210 * Duplicate the current atomic state for this connector and return it.
1211 * The core and helpers guarantee that any atomic state duplicated with
1212 * this hook and still owned by the caller (i.e. not transferred to the
1213 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
1214 * cleaned up by calling the @atomic_destroy_state hook in this
1217 * This callback is mandatory for atomic drivers.
1219 * Atomic drivers which don't subclass &struct drm_connector_state should use
1220 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
1221 * state structure to extend it with driver-private state should use
1222 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
1223 * duplicated in a consistent fashion across drivers.
1225 * It is an error to call this hook before &drm_connector.state has been
1226 * initialized correctly.
1230 * If the duplicate state references refcounted resources this hook must
1231 * acquire a reference for each of them. The driver must release these
1232 * references again in @atomic_destroy_state.
1236 * Duplicated atomic state or NULL when the allocation failed.
1238 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1241 * @atomic_destroy_state:
1243 * Destroy a state duplicated with @atomic_duplicate_state and release
1244 * or unreference all resources it references
1246 * This callback is mandatory for atomic drivers.
1248 void (*atomic_destroy_state)(struct drm_connector *connector,
1249 struct drm_connector_state *state);
1252 * @atomic_set_property:
1254 * Decode a driver-private property value and store the decoded value
1255 * into the passed-in state structure. Since the atomic core decodes all
1256 * standardized properties (even for extensions beyond the core set of
1257 * properties which might not be implemented by all drivers) this
1258 * requires drivers to subclass the state structure.
1260 * Such driver-private properties should really only be implemented for
1261 * truly hardware/vendor specific state. Instead it is preferred to
1262 * standardize atomic extension and decode the properties used to expose
1263 * such an extension in the core.
1265 * Do not call this function directly, use
1266 * drm_atomic_connector_set_property() instead.
1268 * This callback is optional if the driver does not support any
1269 * driver-private atomic properties.
1273 * This function is called in the state assembly phase of atomic
1274 * modesets, which can be aborted for any reason (including on
1275 * userspace's request to just check whether a configuration would be
1276 * possible). Drivers MUST NOT touch any persistent state (hardware or
1277 * software) or data structures except the passed in @state parameter.
1279 * Also since userspace controls in which order properties are set this
1280 * function must not do any input validation (since the state update is
1281 * incomplete and hence likely inconsistent). Instead any such input
1282 * validation must be done in the various atomic_check callbacks.
1286 * 0 if the property has been found, -EINVAL if the property isn't
1287 * implemented by the driver (which shouldn't ever happen, the core only
1288 * asks for properties attached to this connector). No other validation
1289 * is allowed by the driver. The core already checks that the property
1290 * value is within the range (integer, valid enum value, ...) the driver
1291 * set when registering the property.
1293 int (*atomic_set_property)(struct drm_connector *connector,
1294 struct drm_connector_state *state,
1295 struct drm_property *property,
1299 * @atomic_get_property:
1301 * Reads out the decoded driver-private property. This is used to
1302 * implement the GETCONNECTOR IOCTL.
1304 * Do not call this function directly, use
1305 * drm_atomic_connector_get_property() instead.
1307 * This callback is optional if the driver does not support any
1308 * driver-private atomic properties.
1312 * 0 on success, -EINVAL if the property isn't implemented by the
1313 * driver (which shouldn't ever happen, the core only asks for
1314 * properties attached to this connector).
1316 int (*atomic_get_property)(struct drm_connector *connector,
1317 const struct drm_connector_state *state,
1318 struct drm_property *property,
1322 * @atomic_print_state:
1324 * If driver subclasses &struct drm_connector_state, it should implement
1325 * this optional hook for printing additional driver specific state.
1327 * Do not call this directly, use drm_atomic_connector_print_state()
1330 void (*atomic_print_state)(struct drm_printer *p,
1331 const struct drm_connector_state *state);
1334 * @oob_hotplug_event:
1336 * This will get called when a hotplug-event for a drm-connector
1337 * has been received from a source outside the display driver / device.
1339 void (*oob_hotplug_event)(struct drm_connector *connector,
1340 enum drm_connector_status status);
1345 * Allows connectors to create connector-specific debugfs files.
1347 void (*debugfs_init)(struct drm_connector *connector, struct dentry *root);
1351 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1353 * Each connector can have an initial mode with additional options
1354 * passed through the kernel command line. This structure allows to
1355 * express those parameters and will be filled by the command-line
1358 struct drm_cmdline_mode {
1364 char name[DRM_DISPLAY_MODE_LEN];
1369 * Has a mode been read from the command-line?
1374 * @refresh_specified:
1376 * Did the mode have a preferred refresh rate?
1378 bool refresh_specified;
1383 * Did the mode have a preferred BPP?
1390 * Pixel Clock in kHz. Optional.
1392 unsigned int pixel_clock;
1397 * Active resolution on the X axis, in pixels.
1404 * Active resolution on the Y axis, in pixels.
1411 * Bits per pixels for the mode.
1418 * Refresh rate, in Hertz.
1425 * Do we need to use reduced blanking?
1432 * The mode is interlaced.
1439 * The timings will be calculated using the VESA Coordinated
1440 * Video Timings instead of looking up the mode from a table.
1447 * Add margins to the mode calculation (1.8% of xres rounded
1448 * down to 8 pixels and 1.8% of yres).
1455 * Ignore the hotplug state of the connector, and force its
1456 * state to one of the DRM_FORCE_* values.
1458 enum drm_connector_force force;
1461 * @rotation_reflection:
1463 * Initial rotation and reflection of the mode setup from the
1464 * command line. See DRM_MODE_ROTATE_* and
1465 * DRM_MODE_REFLECT_*. The only rotations supported are
1466 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1468 unsigned int rotation_reflection;
1471 * @panel_orientation:
1473 * drm-connector "panel orientation" property override value,
1474 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1476 enum drm_panel_orientation panel_orientation;
1479 * @tv_margins: TV margins to apply to the mode.
1481 struct drm_connector_tv_margins tv_margins;
1484 * @tv_mode: TV mode standard. See DRM_MODE_TV_MODE_*.
1486 enum drm_connector_tv_mode tv_mode;
1489 * @tv_mode_specified:
1491 * Did the mode have a preferred TV mode?
1493 bool tv_mode_specified;
1497 * struct drm_connector - central DRM connector control structure
1499 * Each connector may be connected to one or more CRTCs, or may be clonable by
1500 * another connector if they can share a CRTC. Each connector also has a specific
1501 * position in the broader display (referred to as a 'screen' though it could
1502 * span multiple monitors).
1504 struct drm_connector {
1505 /** @dev: parent DRM device */
1506 struct drm_device *dev;
1507 /** @kdev: kernel device for sysfs attributes */
1508 struct device *kdev;
1509 /** @attr: sysfs attributes */
1510 struct device_attribute *attr;
1512 * @fwnode: associated fwnode supplied by platform firmware
1514 * Drivers can set this to associate a fwnode with a connector, drivers
1515 * are expected to get a reference on the fwnode when setting this.
1516 * drm_connector_cleanup() will call fwnode_handle_put() on this.
1518 struct fwnode_handle *fwnode;
1523 * List of all connectors on a @dev, linked from
1524 * &drm_mode_config.connector_list. Protected by
1525 * &drm_mode_config.connector_list_lock, but please only use
1526 * &drm_connector_list_iter to walk this list.
1528 struct list_head head;
1531 * @global_connector_list_entry:
1533 * Connector entry in the global connector-list, used by
1534 * drm_connector_find_by_fwnode().
1536 struct list_head global_connector_list_entry;
1538 /** @base: base KMS object */
1539 struct drm_mode_object base;
1541 /** @name: human readable name, can be overwritten by the driver */
1545 * @mutex: Lock for general connector state, but currently only protects
1546 * @registered. Most of the connector state is still protected by
1547 * &drm_mode_config.mutex.
1552 * @index: Compacted connector index, which matches the position inside
1553 * the mode_config.list for drivers not supporting hot-add/removing. Can
1554 * be used as an array index. It is invariant over the lifetime of the
1561 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1564 /** @connector_type_id: index into connector type enum */
1565 int connector_type_id;
1567 * @interlace_allowed:
1568 * Can this connector handle interlaced modes? Only used by
1569 * drm_helper_probe_single_connector_modes() for mode filtering.
1571 bool interlace_allowed;
1573 * @doublescan_allowed:
1574 * Can this connector handle doublescan? Only used by
1575 * drm_helper_probe_single_connector_modes() for mode filtering.
1577 bool doublescan_allowed;
1580 * Can this connector handle stereo modes? Only used by
1581 * drm_helper_probe_single_connector_modes() for mode filtering.
1583 bool stereo_allowed;
1586 * @ycbcr_420_allowed : This bool indicates if this connector is
1587 * capable of handling YCBCR 420 output. While parsing the EDID
1588 * blocks it's very helpful to know if the source is capable of
1589 * handling YCBCR 420 outputs.
1591 bool ycbcr_420_allowed;
1594 * @registration_state: Is this connector initializing, exposed
1595 * (registered) with userspace, or unregistered?
1597 * Protected by @mutex.
1599 enum drm_connector_registration_state registration_state;
1603 * Modes available on this connector (from fill_modes() + user).
1604 * Protected by &drm_mode_config.mutex.
1606 struct list_head modes;
1610 * One of the drm_connector_status enums (connected, not, or unknown).
1611 * Protected by &drm_mode_config.mutex.
1613 enum drm_connector_status status;
1617 * These are modes added by probing with DDC or the BIOS, before
1618 * filtering is applied. Used by the probe helpers. Protected by
1619 * &drm_mode_config.mutex.
1621 struct list_head probed_modes;
1624 * @display_info: Display information is filled from EDID information
1625 * when a display is detected. For non hot-pluggable displays such as
1626 * flat panels in embedded systems, the driver should initialize the
1627 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1628 * with the physical size of the display.
1630 * Protected by &drm_mode_config.mutex.
1632 struct drm_display_info display_info;
1634 /** @funcs: connector control functions */
1635 const struct drm_connector_funcs *funcs;
1638 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1639 * &drm_mode_config.mutex. This should be updated only by calling
1640 * drm_connector_update_edid_property().
1642 struct drm_property_blob *edid_blob_ptr;
1644 /** @properties: property tracking for this connector */
1645 struct drm_object_properties properties;
1648 * @scaling_mode_property: Optional atomic property to control the
1649 * upscaling. See drm_connector_attach_content_protection_property().
1651 struct drm_property *scaling_mode_property;
1654 * @vrr_capable_property: Optional property to help userspace
1655 * query hardware support for variable refresh rate on a connector.
1656 * connector. Drivers can add the property to a connector by
1657 * calling drm_connector_attach_vrr_capable_property().
1659 * This should be updated only by calling
1660 * drm_connector_set_vrr_capable_property().
1662 struct drm_property *vrr_capable_property;
1665 * @colorspace_property: Connector property to set the suitable
1666 * colorspace supported by the sink.
1668 struct drm_property *colorspace_property;
1673 * DRM blob property data for the DP MST path property. This should only
1674 * be updated by calling drm_connector_set_path_property().
1676 struct drm_property_blob *path_blob_ptr;
1679 * @max_bpc_property: Default connector property for the max bpc to be
1680 * driven out of the connector.
1682 struct drm_property *max_bpc_property;
1684 /** @privacy_screen: drm_privacy_screen for this connector, or NULL. */
1685 struct drm_privacy_screen *privacy_screen;
1687 /** @privacy_screen_notifier: privacy-screen notifier_block */
1688 struct notifier_block privacy_screen_notifier;
1691 * @privacy_screen_sw_state_property: Optional atomic property for the
1692 * connector to control the integrated privacy screen.
1694 struct drm_property *privacy_screen_sw_state_property;
1697 * @privacy_screen_hw_state_property: Optional atomic property for the
1698 * connector to report the actual integrated privacy screen state.
1700 struct drm_property *privacy_screen_hw_state_property;
1702 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1703 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1704 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1709 * Connector polling mode, a combination of
1711 * DRM_CONNECTOR_POLL_HPD
1712 * The connector generates hotplug events and doesn't need to be
1713 * periodically polled. The CONNECT and DISCONNECT flags must not
1714 * be set together with the HPD flag.
1716 * DRM_CONNECTOR_POLL_CONNECT
1717 * Periodically poll the connector for connection.
1719 * DRM_CONNECTOR_POLL_DISCONNECT
1720 * Periodically poll the connector for disconnection, without
1721 * causing flickering even when the connector is in use. DACs should
1722 * rarely do this without a lot of testing.
1724 * Set to 0 for connectors that don't support connection status
1730 * @dpms: Current dpms state. For legacy drivers the
1731 * &drm_connector_funcs.dpms callback must update this. For atomic
1732 * drivers, this is handled by the core atomic code, and drivers must
1733 * only take &drm_crtc_state.active into account.
1737 /** @helper_private: mid-layer private data */
1738 const struct drm_connector_helper_funcs *helper_private;
1740 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1741 struct drm_cmdline_mode cmdline_mode;
1742 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1743 enum drm_connector_force force;
1746 * @edid_override: Override EDID set via debugfs.
1748 * Do not modify or access outside of the drm_edid_override_* family of
1751 const struct drm_edid *edid_override;
1754 * @edid_override_mutex: Protect access to edid_override.
1756 struct mutex edid_override_mutex;
1758 /** @epoch_counter: used to detect any other changes in connector, besides status */
1762 * @possible_encoders: Bit mask of encoders that can drive this
1763 * connector, drm_encoder_index() determines the index into the bitfield
1764 * and the bits are set with drm_connector_attach_encoder().
1766 u32 possible_encoders;
1769 * @encoder: Currently bound encoder driving this connector, if any.
1770 * Only really meaningful for non-atomic drivers. Atomic drivers should
1771 * instead look at &drm_connector_state.best_encoder, and in case they
1772 * need the CRTC driving this output, &drm_connector_state.crtc.
1774 struct drm_encoder *encoder;
1776 #define MAX_ELD_BYTES 128
1777 /** @eld: EDID-like data, if present */
1778 uint8_t eld[MAX_ELD_BYTES];
1779 /** @latency_present: AV delay info from ELD, if found */
1780 bool latency_present[2];
1782 * @video_latency: Video latency info from ELD, if found.
1783 * [0]: progressive, [1]: interlaced
1785 int video_latency[2];
1787 * @audio_latency: audio latency info from ELD, if found
1788 * [0]: progressive, [1]: interlaced
1790 int audio_latency[2];
1793 * @ddc: associated ddc adapter.
1794 * A connector usually has its associated ddc adapter. If a driver uses
1795 * this field, then an appropriate symbolic link is created in connector
1796 * sysfs directory to make it easy for the user to tell which i2c
1797 * adapter is for a particular display.
1799 * The field should be set by calling drm_connector_init_with_ddc().
1801 struct i2c_adapter *ddc;
1804 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1805 * Needed to workaround some HW bugs where we get all 0s
1807 int null_edid_counter;
1809 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1810 unsigned bad_edid_counter;
1813 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1814 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1819 * @real_edid_checksum: real edid checksum for corrupted edid block.
1820 * Required in Displayport 1.4 compliance testing
1823 u8 real_edid_checksum;
1825 /** @debugfs_entry: debugfs directory for this connector */
1826 struct dentry *debugfs_entry;
1831 * Current atomic state for this connector.
1833 * This is protected by &drm_mode_config.connection_mutex. Note that
1834 * nonblocking atomic commits access the current connector state without
1835 * taking locks. Either by going through the &struct drm_atomic_state
1836 * pointers, see for_each_oldnew_connector_in_state(),
1837 * for_each_old_connector_in_state() and
1838 * for_each_new_connector_in_state(). Or through careful ordering of
1839 * atomic commit operations as implemented in the atomic helpers, see
1840 * &struct drm_crtc_commit.
1842 struct drm_connector_state *state;
1844 /* DisplayID bits. FIXME: Extract into a substruct? */
1849 * DRM blob property data for the tile property (used mostly by DP MST).
1850 * This is meant for screens which are driven through separate display
1851 * pipelines represented by &drm_crtc, which might not be running with
1852 * genlocked clocks. For tiled panels which are genlocked, like
1853 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1854 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1856 * This should only be updated by calling
1857 * drm_connector_set_tile_property().
1859 struct drm_property_blob *tile_blob_ptr;
1861 /** @has_tile: is this connector connected to a tiled monitor */
1863 /** @tile_group: tile group for the connected monitor */
1864 struct drm_tile_group *tile_group;
1865 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1866 bool tile_is_single_monitor;
1868 /** @num_h_tile: number of horizontal tiles in the tile group */
1869 /** @num_v_tile: number of vertical tiles in the tile group */
1870 uint8_t num_h_tile, num_v_tile;
1871 /** @tile_h_loc: horizontal location of this tile */
1872 /** @tile_v_loc: vertical location of this tile */
1873 uint8_t tile_h_loc, tile_v_loc;
1874 /** @tile_h_size: horizontal size of this tile. */
1875 /** @tile_v_size: vertical size of this tile. */
1876 uint16_t tile_h_size, tile_v_size;
1881 * List used only by &drm_connector_list_iter to be able to clean up a
1882 * connector from any context, in conjunction with
1883 * &drm_mode_config.connector_free_work.
1885 struct llist_node free_node;
1887 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1888 struct hdr_sink_metadata hdr_sink_metadata;
1891 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1893 int drm_connector_init(struct drm_device *dev,
1894 struct drm_connector *connector,
1895 const struct drm_connector_funcs *funcs,
1896 int connector_type);
1897 int drm_connector_init_with_ddc(struct drm_device *dev,
1898 struct drm_connector *connector,
1899 const struct drm_connector_funcs *funcs,
1901 struct i2c_adapter *ddc);
1902 int drmm_connector_init(struct drm_device *dev,
1903 struct drm_connector *connector,
1904 const struct drm_connector_funcs *funcs,
1906 struct i2c_adapter *ddc);
1907 void drm_connector_attach_edid_property(struct drm_connector *connector);
1908 int drm_connector_register(struct drm_connector *connector);
1909 void drm_connector_unregister(struct drm_connector *connector);
1910 int drm_connector_attach_encoder(struct drm_connector *connector,
1911 struct drm_encoder *encoder);
1913 void drm_connector_cleanup(struct drm_connector *connector);
1915 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1917 return connector->index;
1920 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1922 return 1 << connector->index;
1926 * drm_connector_lookup - lookup connector object
1928 * @file_priv: drm file to check for lease against.
1929 * @id: connector object id
1931 * This function looks up the connector object specified by id
1932 * add takes a reference to it.
1934 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1935 struct drm_file *file_priv,
1938 struct drm_mode_object *mo;
1939 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1940 return mo ? obj_to_connector(mo) : NULL;
1944 * drm_connector_get - acquire a connector reference
1945 * @connector: DRM connector
1947 * This function increments the connector's refcount.
1949 static inline void drm_connector_get(struct drm_connector *connector)
1951 drm_mode_object_get(&connector->base);
1955 * drm_connector_put - release a connector reference
1956 * @connector: DRM connector
1958 * This function decrements the connector's reference count and frees the
1959 * object if the reference count drops to zero.
1961 static inline void drm_connector_put(struct drm_connector *connector)
1963 drm_mode_object_put(&connector->base);
1967 * drm_connector_is_unregistered - has the connector been unregistered from
1969 * @connector: DRM connector
1971 * Checks whether or not @connector has been unregistered from userspace.
1974 * True if the connector was unregistered, false if the connector is
1975 * registered or has not yet been registered with userspace.
1978 drm_connector_is_unregistered(struct drm_connector *connector)
1980 return READ_ONCE(connector->registration_state) ==
1981 DRM_CONNECTOR_UNREGISTERED;
1984 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode,
1985 enum drm_connector_status status);
1986 const char *drm_get_connector_type_name(unsigned int connector_type);
1987 const char *drm_get_connector_status_name(enum drm_connector_status status);
1988 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1989 const char *drm_get_dpms_name(int val);
1990 const char *drm_get_dvi_i_subconnector_name(int val);
1991 const char *drm_get_dvi_i_select_name(int val);
1992 const char *drm_get_tv_mode_name(int val);
1993 const char *drm_get_tv_subconnector_name(int val);
1994 const char *drm_get_tv_select_name(int val);
1995 const char *drm_get_dp_subconnector_name(int val);
1996 const char *drm_get_content_protection_name(int val);
1997 const char *drm_get_hdcp_content_type_name(int val);
1999 int drm_get_tv_mode_from_name(const char *name, size_t len);
2001 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
2002 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
2004 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
2005 int drm_mode_create_tv_properties_legacy(struct drm_device *dev,
2006 unsigned int num_modes,
2007 const char * const modes[]);
2008 int drm_mode_create_tv_properties(struct drm_device *dev,
2009 unsigned int supported_tv_modes);
2010 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
2011 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
2012 int drm_connector_attach_content_type_property(struct drm_connector *dev);
2013 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
2014 u32 scaling_mode_mask);
2015 int drm_connector_attach_vrr_capable_property(
2016 struct drm_connector *connector);
2017 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
2018 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
2019 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
2020 struct drm_connector_state *new_state);
2021 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
2022 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector,
2023 u32 supported_colorspaces);
2024 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector,
2025 u32 supported_colorspaces);
2026 int drm_mode_create_content_type_property(struct drm_device *dev);
2027 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
2029 int drm_connector_set_path_property(struct drm_connector *connector,
2031 int drm_connector_set_tile_property(struct drm_connector *connector);
2032 int drm_connector_update_edid_property(struct drm_connector *connector,
2033 const struct edid *edid);
2034 void drm_connector_set_link_status_property(struct drm_connector *connector,
2035 uint64_t link_status);
2036 void drm_connector_set_vrr_capable_property(
2037 struct drm_connector *connector, bool capable);
2038 int drm_connector_set_panel_orientation(
2039 struct drm_connector *connector,
2040 enum drm_panel_orientation panel_orientation);
2041 int drm_connector_set_panel_orientation_with_quirk(
2042 struct drm_connector *connector,
2043 enum drm_panel_orientation panel_orientation,
2044 int width, int height);
2045 int drm_connector_set_orientation_from_panel(
2046 struct drm_connector *connector,
2047 struct drm_panel *panel);
2048 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2050 void drm_connector_create_privacy_screen_properties(struct drm_connector *conn);
2051 void drm_connector_attach_privacy_screen_properties(struct drm_connector *conn);
2052 void drm_connector_attach_privacy_screen_provider(
2053 struct drm_connector *connector, struct drm_privacy_screen *priv);
2054 void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state);
2057 * struct drm_tile_group - Tile group metadata
2058 * @refcount: reference count
2060 * @id: tile group id exposed to userspace
2061 * @group_data: Sink-private data identifying this group
2063 * @group_data corresponds to displayid vend/prod/serial for external screens
2066 struct drm_tile_group {
2067 struct kref refcount;
2068 struct drm_device *dev;
2073 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2074 const char topology[8]);
2075 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2076 const char topology[8]);
2077 void drm_mode_put_tile_group(struct drm_device *dev,
2078 struct drm_tile_group *tg);
2081 * struct drm_connector_list_iter - connector_list iterator
2083 * This iterator tracks state needed to be able to walk the connector_list
2084 * within struct drm_mode_config. Only use together with
2085 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
2086 * drm_connector_list_iter_next() respectively the convenience macro
2087 * drm_for_each_connector_iter().
2089 * Note that the return value of drm_connector_list_iter_next() is only valid
2090 * up to the next drm_connector_list_iter_next() or
2091 * drm_connector_list_iter_end() call. If you want to use the connector later,
2092 * then you need to grab your own reference first using drm_connector_get().
2094 struct drm_connector_list_iter {
2096 struct drm_device *dev;
2097 struct drm_connector *conn;
2100 void drm_connector_list_iter_begin(struct drm_device *dev,
2101 struct drm_connector_list_iter *iter);
2102 struct drm_connector *
2103 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
2104 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
2106 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
2107 struct drm_encoder *encoder);
2108 const char *drm_get_colorspace_name(enum drm_colorspace colorspace);
2111 * drm_for_each_connector_iter - connector_list iterator macro
2112 * @connector: &struct drm_connector pointer used as cursor
2113 * @iter: &struct drm_connector_list_iter
2115 * Note that @connector is only valid within the list body, if you want to use
2116 * @connector after calling drm_connector_list_iter_end() then you need to grab
2117 * your own reference first using drm_connector_get().
2119 #define drm_for_each_connector_iter(connector, iter) \
2120 while ((connector = drm_connector_list_iter_next(iter)))
2123 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
2124 * @connector: &struct drm_connector pointer
2125 * @encoder: &struct drm_encoder pointer used as cursor
2127 #define drm_connector_for_each_possible_encoder(connector, encoder) \
2128 drm_for_each_encoder_mask(encoder, (connector)->dev, \
2129 (connector)->possible_encoders)