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,
203 DRM_MODE_TV_MODE_MAX,
207 * struct drm_scrambling: sink's scrambling support.
209 struct drm_scrambling {
211 * @supported: scrambling supported for rates > 340 Mhz.
215 * @low_rates: scrambling supported for rates <= 340 Mhz.
221 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
223 * Provides SCDC register support and capabilities related information on a
224 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
228 * @supported: status control & data channel present.
232 * @read_request: sink is capable of generating scdc read request.
236 * @scrambling: sink's scrambling capabilities
238 struct drm_scrambling scrambling;
242 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink
244 * Describes the DSC support provided by HDMI 2.1 sink.
245 * The information is fetched fom additional HFVSDB blocks defined
248 struct drm_hdmi_dsc_cap {
249 /** @v_1p2: flag for dsc1.2 version support by sink */
252 /** @native_420: Does sink support DSC with 4:2:0 compression */
256 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2
262 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc
266 /** @max_slices: maximum number of Horizontal slices supported by */
269 /** @clk_per_slice : max pixel clock in MHz supported per slice */
272 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */
275 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */
276 u8 max_frl_rate_per_lane;
278 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/
279 u8 total_chunk_kbytes;
283 * struct drm_hdmi_info - runtime information about the connected HDMI sink
285 * Describes if a given display supports advanced HDMI 2.0 features.
286 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
288 struct drm_hdmi_info {
289 /** @scdc: sink's scdc support and capabilities */
290 struct drm_scdc scdc;
293 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
294 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
295 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
298 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
301 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
302 * output also, along with normal HDMI outputs. The max VIC defined by
303 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
306 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
308 /** @y420_dc_modes: bitmap of deep color support index */
311 /** @max_frl_rate_per_lane: support fixed rate link */
312 u8 max_frl_rate_per_lane;
314 /** @max_lanes: supported by sink */
317 /** @dsc_cap: DSC capabilities of the sink */
318 struct drm_hdmi_dsc_cap dsc_cap;
322 * enum drm_link_status - connector's link_status property value
324 * This enum is used as the connector's link status property value.
325 * It is set to the values defined in uapi.
327 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
329 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
332 enum drm_link_status {
333 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
334 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
338 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
340 * This enum is used to track the (LCD) panel orientation. There are no
341 * separate #defines for the uapi!
343 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
344 * panel orientation information (normal
345 * for non panels) in this case the "panel
346 * orientation" connector prop will not be
348 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
349 * top side of the device's casing.
350 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
351 * bottom side of the device's casing, iow
352 * the panel is mounted upside-down.
353 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
354 * top side of the device's casing.
355 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
356 * top side of the device's casing.
358 enum drm_panel_orientation {
359 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
360 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
361 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
362 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
363 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
367 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
370 * This struct is used to store a frequency range supported by panel
371 * as parsed from EDID's detailed monitor range descriptor block.
373 * @min_vfreq: This is the min supported refresh rate in Hz from
374 * EDID's detailed monitor range.
375 * @max_vfreq: This is the max supported refresh rate in Hz from
376 * EDID's detailed monitor range
378 struct drm_monitor_range_info {
384 * struct drm_luminance_range_info - Panel's luminance range for
385 * &drm_display_info. Calculated using data in EDID
387 * This struct is used to store a luminance range supported by panel
388 * as calculated using data from EDID's static hdr metadata.
390 * @min_luminance: This is the min supported luminance value
392 * @max_luminance: This is the max supported luminance value
394 struct drm_luminance_range_info {
400 * enum drm_privacy_screen_status - privacy screen status
402 * This enum is used to track and control the state of the integrated privacy
403 * screen present on some display panels, via the "privacy-screen sw-state"
404 * and "privacy-screen hw-state" properties. Note the _LOCKED enum values
405 * are only valid for the "privacy-screen hw-state" property.
407 * @PRIVACY_SCREEN_DISABLED:
408 * The privacy-screen on the panel is disabled
409 * @PRIVACY_SCREEN_ENABLED:
410 * The privacy-screen on the panel is enabled
411 * @PRIVACY_SCREEN_DISABLED_LOCKED:
412 * The privacy-screen on the panel is disabled and locked (cannot be changed)
413 * @PRIVACY_SCREEN_ENABLED_LOCKED:
414 * The privacy-screen on the panel is enabled and locked (cannot be changed)
416 enum drm_privacy_screen_status {
417 PRIVACY_SCREEN_DISABLED = 0,
418 PRIVACY_SCREEN_ENABLED,
419 PRIVACY_SCREEN_DISABLED_LOCKED,
420 PRIVACY_SCREEN_ENABLED_LOCKED,
424 * enum drm_colorspace - color space
426 * This enum is a consolidated colorimetry list supported by HDMI and
427 * DP protocol standard. The respective connectors will register
428 * a property with the subset of this list (supported by that
429 * respective protocol). Userspace will set the colorspace through
430 * a colorspace property which will be created and exposed to
433 * DP definitions come from the DP v2.0 spec
434 * HDMI definitions come from the CTA-861-H spec
436 * A note on YCC and RGB variants:
438 * Since userspace is not aware of the encoding on the wire
439 * (RGB or YCbCr), drivers are free to pick the appropriate
440 * variant, regardless of what userspace selects. E.g., if
441 * BT2020_RGB is selected by userspace a driver will pick
442 * BT2020_YCC if the encoding on the wire is YUV444 or YUV420.
444 * @DRM_MODE_COLORIMETRY_DEFAULT:
445 * Driver specific behavior.
446 * @DRM_MODE_COLORIMETRY_NO_DATA:
447 * Driver specific behavior.
448 * @DRM_MODE_COLORIMETRY_SMPTE_170M_YCC:
450 * SMPTE ST 170M colorimetry format
451 * @DRM_MODE_COLORIMETRY_BT709_YCC:
453 * ITU-R BT.709 colorimetry format
454 * @DRM_MODE_COLORIMETRY_XVYCC_601:
456 * xvYCC601 colorimetry format
457 * @DRM_MODE_COLORIMETRY_XVYCC_709:
459 * xvYCC709 colorimetry format
460 * @DRM_MODE_COLORIMETRY_SYCC_601:
462 * sYCC601 colorimetry format
463 * @DRM_MODE_COLORIMETRY_OPYCC_601:
465 * opYCC601 colorimetry format
466 * @DRM_MODE_COLORIMETRY_OPRGB:
468 * opRGB colorimetry format
469 * @DRM_MODE_COLORIMETRY_BT2020_CYCC:
471 * ITU-R BT.2020 Y'c C'bc C'rc (constant luminance) colorimetry format
472 * @DRM_MODE_COLORIMETRY_BT2020_RGB:
474 * ITU-R BT.2020 R' G' B' colorimetry format
475 * @DRM_MODE_COLORIMETRY_BT2020_YCC:
477 * ITU-R BT.2020 Y' C'b C'r colorimetry format
478 * @DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65:
480 * SMPTE ST 2113 P3D65 colorimetry format
481 * @DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER:
483 * SMPTE ST 2113 P3DCI colorimetry format
484 * @DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED:
486 * RGB wide gamut fixed point colorimetry format
487 * @DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT:
489 * RGB wide gamut floating point
490 * (scRGB (IEC 61966-2-2)) colorimetry format
491 * @DRM_MODE_COLORIMETRY_BT601_YCC:
493 * ITU-R BT.601 colorimetry format
494 * The DP spec does not say whether this is the 525 or the 625
497 enum drm_colorspace {
498 /* For Default case, driver will set the colorspace */
499 DRM_MODE_COLORIMETRY_DEFAULT = 0,
500 /* CEA 861 Normal Colorimetry options */
501 DRM_MODE_COLORIMETRY_NO_DATA = 0,
502 DRM_MODE_COLORIMETRY_SMPTE_170M_YCC = 1,
503 DRM_MODE_COLORIMETRY_BT709_YCC = 2,
504 /* CEA 861 Extended Colorimetry Options */
505 DRM_MODE_COLORIMETRY_XVYCC_601 = 3,
506 DRM_MODE_COLORIMETRY_XVYCC_709 = 4,
507 DRM_MODE_COLORIMETRY_SYCC_601 = 5,
508 DRM_MODE_COLORIMETRY_OPYCC_601 = 6,
509 DRM_MODE_COLORIMETRY_OPRGB = 7,
510 DRM_MODE_COLORIMETRY_BT2020_CYCC = 8,
511 DRM_MODE_COLORIMETRY_BT2020_RGB = 9,
512 DRM_MODE_COLORIMETRY_BT2020_YCC = 10,
513 /* Additional Colorimetry extension added as part of CTA 861.G */
514 DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 = 11,
515 DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER = 12,
516 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
517 DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED = 13,
518 DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT = 14,
519 DRM_MODE_COLORIMETRY_BT601_YCC = 15,
520 /* not a valid value; merely used for counting */
521 DRM_MODE_COLORIMETRY_COUNT
525 * enum drm_bus_flags - bus_flags info for &drm_display_info
527 * This enum defines signal polarities and clock edge information for signals on
528 * a bus as bitmask flags.
530 * The clock edge information is conveyed by two sets of symbols,
531 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
532 * used to describe a bus from the point of view of the transmitter, the
533 * \*_DRIVE_\* flags should be used. When used from the point of view of the
534 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
535 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
536 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
537 * respectively. This simplifies code as signals are usually sampled on the
538 * opposite edge of the driving edge. Transmitters and receivers may however
539 * need to take other signal timings into account to convert between driving
544 * @DRM_BUS_FLAG_DE_LOW:
546 * The Data Enable signal is active low
548 DRM_BUS_FLAG_DE_LOW = BIT(0),
551 * @DRM_BUS_FLAG_DE_HIGH:
553 * The Data Enable signal is active high
555 DRM_BUS_FLAG_DE_HIGH = BIT(1),
558 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
560 * Data is driven on the rising edge of the pixel clock
562 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
565 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
567 * Data is driven on the falling edge of the pixel clock
569 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
572 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
574 * Data is sampled on the rising edge of the pixel clock
576 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
579 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
581 * Data is sampled on the falling edge of the pixel clock
583 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
586 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
588 * Data is transmitted MSB to LSB on the bus
590 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
593 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
595 * Data is transmitted LSB to MSB on the bus
597 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
600 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
602 * Sync signals are driven on the rising edge of the pixel clock
604 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
607 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
609 * Sync signals are driven on the falling edge of the pixel clock
611 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
614 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
616 * Sync signals are sampled on the rising edge of the pixel clock
618 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
621 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
623 * Sync signals are sampled on the falling edge of the pixel clock
625 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
628 * @DRM_BUS_FLAG_SHARP_SIGNALS:
630 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
632 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
636 * struct drm_display_info - runtime data about the connected sink
638 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
639 * fixed display sinks like built-in panels there's not much difference between
640 * this and &struct drm_connector. But for sinks with a real cable this
641 * structure is meant to describe all the things at the other end of the cable.
643 * For sinks which provide an EDID this can be filled out by calling
644 * drm_add_edid_modes().
646 struct drm_display_info {
648 * @width_mm: Physical width in mm.
650 unsigned int width_mm;
653 * @height_mm: Physical height in mm.
655 unsigned int height_mm;
658 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
663 * @subpixel_order: Subpixel order of LCD panels.
665 enum subpixel_order subpixel_order;
667 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
668 #define DRM_COLOR_FORMAT_YCBCR444 (1<<1)
669 #define DRM_COLOR_FORMAT_YCBCR422 (1<<2)
670 #define DRM_COLOR_FORMAT_YCBCR420 (1<<3)
673 * @panel_orientation: Read only connector property for built-in panels,
674 * indicating the orientation of the panel vs the device's casing.
675 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
676 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
677 * fb to compensate and gets exported as prop to userspace.
679 int panel_orientation;
682 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
683 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
684 * as used to describe the pixel format in framebuffers, and also don't
685 * match the formats in @bus_formats which are shared with v4l.
690 * @bus_formats: Pixel data format on the wire, somewhat redundant with
691 * @color_formats. Array of size @num_bus_formats encoded using
692 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
694 const u32 *bus_formats;
696 * @num_bus_formats: Size of @bus_formats array.
698 unsigned int num_bus_formats;
701 * @bus_flags: Additional information (like pixel signal polarity) for
702 * the pixel data on the bus, using &enum drm_bus_flags values
708 * @max_tmds_clock: Maximum TMDS clock rate supported by the
709 * sink in kHz. 0 means undefined.
714 * @dvi_dual: Dual-link DVI sink?
719 * @is_hdmi: True if the sink is an HDMI device.
721 * This field shall be used instead of calling
722 * drm_detect_hdmi_monitor() when possible.
727 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
729 bool has_hdmi_infoframe;
732 * @rgb_quant_range_selectable: Does the sink support selecting
733 * the RGB quantization range?
735 bool rgb_quant_range_selectable;
738 * @edid_hdmi_rgb444_dc_modes: Mask of supported hdmi deep color modes
739 * in RGB 4:4:4. Even more stuff redundant with @bus_formats.
741 u8 edid_hdmi_rgb444_dc_modes;
744 * @edid_hdmi_ycbcr444_dc_modes: Mask of supported hdmi deep color
745 * modes in YCbCr 4:4:4. Even more stuff redundant with @bus_formats.
747 u8 edid_hdmi_ycbcr444_dc_modes;
750 * @cea_rev: CEA revision of the HDMI sink.
755 * @hdmi: advance features of a HDMI sink.
757 struct drm_hdmi_info hdmi;
760 * @non_desktop: Non desktop display (HMD).
765 * @monitor_range: Frequency range supported by monitor range descriptor
767 struct drm_monitor_range_info monitor_range;
770 * @luminance_range: Luminance range supported by panel
772 struct drm_luminance_range_info luminance_range;
775 * @mso_stream_count: eDP Multi-SST Operation (MSO) stream count from
776 * the DisplayID VESA vendor block. 0 for conventional Single-Stream
777 * Transport (SST), or 2 or 4 MSO streams.
782 * @mso_pixel_overlap: eDP MSO segment pixel overlap, 0-8 pixels.
784 u8 mso_pixel_overlap;
787 * @max_dsc_bpp: Maximum DSC target bitrate, if it is set to 0 the
788 * monitor's default value is used instead.
793 * @vics: Array of vics_len VICs. Internal to EDID parsing.
798 * @vics_len: Number of elements in vics. Internal to EDID parsing.
803 * @quirks: EDID based quirks. Internal to EDID parsing.
808 int drm_display_info_set_bus_formats(struct drm_display_info *info,
810 unsigned int num_formats);
813 * struct drm_connector_tv_margins - TV connector related margins
815 * Describes the margins in pixels to put around the image on TV
816 * connectors to deal with overscan.
818 struct drm_connector_tv_margins {
820 * @bottom: Bottom margin in pixels.
825 * @left: Left margin in pixels.
830 * @right: Right margin in pixels.
835 * @top: Top margin in pixels.
841 * struct drm_tv_connector_state - TV connector related states
842 * @select_subconnector: selected subconnector
843 * @subconnector: detected subconnector
844 * @margins: TV margins
845 * @legacy_mode: Legacy TV mode, driver specific value
847 * @brightness: brightness in percent
848 * @contrast: contrast in percent
849 * @flicker_reduction: flicker reduction in percent
850 * @overscan: overscan in percent
851 * @saturation: saturation in percent
852 * @hue: hue in percent
854 struct drm_tv_connector_state {
855 enum drm_mode_subconnector select_subconnector;
856 enum drm_mode_subconnector subconnector;
857 struct drm_connector_tv_margins margins;
858 unsigned int legacy_mode;
860 unsigned int brightness;
861 unsigned int contrast;
862 unsigned int flicker_reduction;
863 unsigned int overscan;
864 unsigned int saturation;
869 * struct drm_connector_state - mutable connector state
871 struct drm_connector_state {
872 /** @connector: backpointer to the connector */
873 struct drm_connector *connector;
876 * @crtc: CRTC to connect connector to, NULL if disabled.
878 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
881 struct drm_crtc *crtc;
886 * Used by the atomic helpers to select the encoder, through the
887 * &drm_connector_helper_funcs.atomic_best_encoder or
888 * &drm_connector_helper_funcs.best_encoder callbacks.
890 * This is also used in the atomic helpers to map encoders to their
891 * current and previous connectors, see
892 * drm_atomic_get_old_connector_for_encoder() and
893 * drm_atomic_get_new_connector_for_encoder().
895 * NOTE: Atomic drivers must fill this out (either themselves or through
896 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
897 * not return correct data to userspace.
899 struct drm_encoder *best_encoder;
902 * @link_status: Connector link_status to keep track of whether link is
903 * GOOD or BAD to notify userspace if retraining is necessary.
905 enum drm_link_status link_status;
907 /** @state: backpointer to global drm_atomic_state */
908 struct drm_atomic_state *state;
911 * @commit: Tracks the pending commit to prevent use-after-free conditions.
913 * Is only set when @crtc is NULL.
915 struct drm_crtc_commit *commit;
917 /** @tv: TV connector state */
918 struct drm_tv_connector_state tv;
921 * @self_refresh_aware:
923 * This tracks whether a connector is aware of the self refresh state.
924 * It should be set to true for those connector implementations which
925 * understand the self refresh state. This is needed since the crtc
926 * registers the self refresh helpers and it doesn't know if the
927 * connectors downstream have implemented self refresh entry/exit.
929 * Drivers should set this to true in atomic_check if they know how to
930 * handle self_refresh requests.
932 bool self_refresh_aware;
935 * @picture_aspect_ratio: Connector property to control the
936 * HDMI infoframe aspect ratio setting.
938 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
939 * values for &enum hdmi_picture_aspect
941 enum hdmi_picture_aspect picture_aspect_ratio;
944 * @content_type: Connector property to control the
945 * HDMI infoframe content type setting.
946 * The %DRM_MODE_CONTENT_TYPE_\* values much
949 unsigned int content_type;
952 * @hdcp_content_type: Connector property to pass the type of
953 * protected content. This is most commonly used for HDCP.
955 unsigned int hdcp_content_type;
958 * @scaling_mode: Connector property to control the
959 * upscaling, mostly used for built-in panels.
961 unsigned int scaling_mode;
964 * @content_protection: Connector property to request content
965 * protection. This is most commonly used for HDCP.
967 unsigned int content_protection;
970 * @colorspace: State variable for Connector property to request
971 * colorspace change on Sink. This is most commonly used to switch
972 * to wider color gamuts like BT2020.
974 enum drm_colorspace colorspace;
977 * @writeback_job: Writeback job for writeback connectors
979 * Holds the framebuffer and out-fence for a writeback connector. As
980 * the writeback completion may be asynchronous to the normal commit
981 * cycle, the writeback job lifetime is managed separately from the
982 * normal atomic state by this object.
984 * See also: drm_writeback_queue_job() and
985 * drm_writeback_signal_completion()
987 struct drm_writeback_job *writeback_job;
990 * @max_requested_bpc: Connector property to limit the maximum bit
991 * depth of the pixels.
993 u8 max_requested_bpc;
996 * @max_bpc: Connector max_bpc based on the requested max_bpc property
997 * and the connector bpc limitations obtained from edid.
1002 * @privacy_screen_sw_state: See :ref:`Standard Connector
1003 * Properties<standard_connector_properties>`
1005 enum drm_privacy_screen_status privacy_screen_sw_state;
1008 * @hdr_output_metadata:
1009 * DRM blob property for HDR output metadata
1011 struct drm_property_blob *hdr_output_metadata;
1015 * struct drm_connector_funcs - control connectors on a given device
1017 * Each CRTC may have one or more connectors attached to it. The functions
1018 * below allow the core DRM code to control connectors, enumerate available modes,
1021 struct drm_connector_funcs {
1025 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
1026 * is exposed as a standard property on the connector, but diverted to
1027 * this callback in the drm core. Note that atomic drivers don't
1028 * implement the 4 level DPMS support on the connector any more, but
1029 * instead only have an on/off "ACTIVE" property on the CRTC object.
1031 * This hook is not used by atomic drivers, remapping of the legacy DPMS
1032 * property is entirely handled in the DRM core.
1036 * 0 on success or a negative error code on failure.
1038 int (*dpms)(struct drm_connector *connector, int mode);
1043 * Reset connector hardware and software state to off. This function isn't
1044 * called by the core directly, only through drm_mode_config_reset().
1045 * It's not a helper hook only for historical reasons.
1047 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
1048 * atomic state using this hook.
1050 void (*reset)(struct drm_connector *connector);
1055 * Check to see if anything is attached to the connector. The parameter
1056 * force is set to false whilst polling, true when checking the
1057 * connector due to a user request. force can be used by the driver to
1058 * avoid expensive, destructive operations during automated probing.
1060 * This callback is optional, if not implemented the connector will be
1061 * considered as always being attached.
1065 * Note that this hook is only called by the probe helper. It's not in
1066 * the helper library vtable purely for historical reasons. The only DRM
1067 * core entry point to probe connector state is @fill_modes.
1069 * Note that the helper library will already hold
1070 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
1071 * locks to avoid races with concurrent modeset changes need to use
1072 * &drm_connector_helper_funcs.detect_ctx instead.
1074 * Also note that this callback can be called no matter the
1075 * state the connector is in. Drivers that need the underlying
1076 * device to be powered to perform the detection will first need
1077 * to make sure it's been properly enabled.
1081 * drm_connector_status indicating the connector's status.
1083 enum drm_connector_status (*detect)(struct drm_connector *connector,
1089 * This function is called to update internal encoder state when the
1090 * connector is forced to a certain state by userspace, either through
1091 * the sysfs interfaces or on the kernel cmdline. In that case the
1092 * @detect callback isn't called.
1096 * Note that this hook is only called by the probe helper. It's not in
1097 * the helper library vtable purely for historical reasons. The only DRM
1098 * core entry point to probe connector state is @fill_modes.
1100 void (*force)(struct drm_connector *connector);
1105 * Entry point for output detection and basic mode validation. The
1106 * driver should reprobe the output if needed (e.g. when hotplug
1107 * handling is unreliable), add all detected modes to &drm_connector.modes
1108 * and filter out any the device can't support in any configuration. It
1109 * also needs to filter out any modes wider or higher than the
1110 * parameters max_width and max_height indicate.
1112 * The drivers must also prune any modes no longer valid from
1113 * &drm_connector.modes. Furthermore it must update
1114 * &drm_connector.status and &drm_connector.edid. If no EDID has been
1115 * received for this output connector->edid must be NULL.
1117 * Drivers using the probe helpers should use
1118 * drm_helper_probe_single_connector_modes() to implement this
1123 * The number of modes detected and filled into &drm_connector.modes.
1125 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
1130 * This is the legacy entry point to update a property attached to the
1133 * This callback is optional if the driver does not support any legacy
1134 * driver-private properties. For atomic drivers it is not used because
1135 * property handling is done entirely in the DRM core.
1139 * 0 on success or a negative error code on failure.
1141 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
1147 * This optional hook can be used to register additional userspace
1148 * interfaces attached to the connector, light backlight control, i2c,
1149 * DP aux or similar interfaces. It is called late in the driver load
1150 * sequence from drm_connector_register() when registering all the
1151 * core drm connector interfaces. Everything added from this callback
1152 * should be unregistered in the early_unregister callback.
1154 * This is called while holding &drm_connector.mutex.
1158 * 0 on success, or a negative error code on failure.
1160 int (*late_register)(struct drm_connector *connector);
1163 * @early_unregister:
1165 * This optional hook should be used to unregister the additional
1166 * userspace interfaces attached to the connector from
1167 * late_register(). It is called from drm_connector_unregister(),
1168 * early in the driver unload sequence to disable userspace access
1169 * before data structures are torndown.
1171 * This is called while holding &drm_connector.mutex.
1173 void (*early_unregister)(struct drm_connector *connector);
1178 * Clean up connector resources. This is called at driver unload time
1179 * through drm_mode_config_cleanup(). It can also be called at runtime
1180 * when a connector is being hot-unplugged for drivers that support
1181 * connector hotplugging (e.g. DisplayPort MST).
1183 void (*destroy)(struct drm_connector *connector);
1186 * @atomic_duplicate_state:
1188 * Duplicate the current atomic state for this connector and return it.
1189 * The core and helpers guarantee that any atomic state duplicated with
1190 * this hook and still owned by the caller (i.e. not transferred to the
1191 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
1192 * cleaned up by calling the @atomic_destroy_state hook in this
1195 * This callback is mandatory for atomic drivers.
1197 * Atomic drivers which don't subclass &struct drm_connector_state should use
1198 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
1199 * state structure to extend it with driver-private state should use
1200 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
1201 * duplicated in a consistent fashion across drivers.
1203 * It is an error to call this hook before &drm_connector.state has been
1204 * initialized correctly.
1208 * If the duplicate state references refcounted resources this hook must
1209 * acquire a reference for each of them. The driver must release these
1210 * references again in @atomic_destroy_state.
1214 * Duplicated atomic state or NULL when the allocation failed.
1216 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1219 * @atomic_destroy_state:
1221 * Destroy a state duplicated with @atomic_duplicate_state and release
1222 * or unreference all resources it references
1224 * This callback is mandatory for atomic drivers.
1226 void (*atomic_destroy_state)(struct drm_connector *connector,
1227 struct drm_connector_state *state);
1230 * @atomic_set_property:
1232 * Decode a driver-private property value and store the decoded value
1233 * into the passed-in state structure. Since the atomic core decodes all
1234 * standardized properties (even for extensions beyond the core set of
1235 * properties which might not be implemented by all drivers) this
1236 * requires drivers to subclass the state structure.
1238 * Such driver-private properties should really only be implemented for
1239 * truly hardware/vendor specific state. Instead it is preferred to
1240 * standardize atomic extension and decode the properties used to expose
1241 * such an extension in the core.
1243 * Do not call this function directly, use
1244 * drm_atomic_connector_set_property() instead.
1246 * This callback is optional if the driver does not support any
1247 * driver-private atomic properties.
1251 * This function is called in the state assembly phase of atomic
1252 * modesets, which can be aborted for any reason (including on
1253 * userspace's request to just check whether a configuration would be
1254 * possible). Drivers MUST NOT touch any persistent state (hardware or
1255 * software) or data structures except the passed in @state parameter.
1257 * Also since userspace controls in which order properties are set this
1258 * function must not do any input validation (since the state update is
1259 * incomplete and hence likely inconsistent). Instead any such input
1260 * validation must be done in the various atomic_check callbacks.
1264 * 0 if the property has been found, -EINVAL if the property isn't
1265 * implemented by the driver (which shouldn't ever happen, the core only
1266 * asks for properties attached to this connector). No other validation
1267 * is allowed by the driver. The core already checks that the property
1268 * value is within the range (integer, valid enum value, ...) the driver
1269 * set when registering the property.
1271 int (*atomic_set_property)(struct drm_connector *connector,
1272 struct drm_connector_state *state,
1273 struct drm_property *property,
1277 * @atomic_get_property:
1279 * Reads out the decoded driver-private property. This is used to
1280 * implement the GETCONNECTOR IOCTL.
1282 * Do not call this function directly, use
1283 * drm_atomic_connector_get_property() instead.
1285 * This callback is optional if the driver does not support any
1286 * driver-private atomic properties.
1290 * 0 on success, -EINVAL if the property isn't implemented by the
1291 * driver (which shouldn't ever happen, the core only asks for
1292 * properties attached to this connector).
1294 int (*atomic_get_property)(struct drm_connector *connector,
1295 const struct drm_connector_state *state,
1296 struct drm_property *property,
1300 * @atomic_print_state:
1302 * If driver subclasses &struct drm_connector_state, it should implement
1303 * this optional hook for printing additional driver specific state.
1305 * Do not call this directly, use drm_atomic_connector_print_state()
1308 void (*atomic_print_state)(struct drm_printer *p,
1309 const struct drm_connector_state *state);
1312 * @oob_hotplug_event:
1314 * This will get called when a hotplug-event for a drm-connector
1315 * has been received from a source outside the display driver / device.
1317 void (*oob_hotplug_event)(struct drm_connector *connector);
1322 * Allows connectors to create connector-specific debugfs files.
1324 void (*debugfs_init)(struct drm_connector *connector, struct dentry *root);
1328 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1330 * Each connector can have an initial mode with additional options
1331 * passed through the kernel command line. This structure allows to
1332 * express those parameters and will be filled by the command-line
1335 struct drm_cmdline_mode {
1341 char name[DRM_DISPLAY_MODE_LEN];
1346 * Has a mode been read from the command-line?
1351 * @refresh_specified:
1353 * Did the mode have a preferred refresh rate?
1355 bool refresh_specified;
1360 * Did the mode have a preferred BPP?
1367 * Pixel Clock in kHz. Optional.
1369 unsigned int pixel_clock;
1374 * Active resolution on the X axis, in pixels.
1381 * Active resolution on the Y axis, in pixels.
1388 * Bits per pixels for the mode.
1395 * Refresh rate, in Hertz.
1402 * Do we need to use reduced blanking?
1409 * The mode is interlaced.
1416 * The timings will be calculated using the VESA Coordinated
1417 * Video Timings instead of looking up the mode from a table.
1424 * Add margins to the mode calculation (1.8% of xres rounded
1425 * down to 8 pixels and 1.8% of yres).
1432 * Ignore the hotplug state of the connector, and force its
1433 * state to one of the DRM_FORCE_* values.
1435 enum drm_connector_force force;
1438 * @rotation_reflection:
1440 * Initial rotation and reflection of the mode setup from the
1441 * command line. See DRM_MODE_ROTATE_* and
1442 * DRM_MODE_REFLECT_*. The only rotations supported are
1443 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1445 unsigned int rotation_reflection;
1448 * @panel_orientation:
1450 * drm-connector "panel orientation" property override value,
1451 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1453 enum drm_panel_orientation panel_orientation;
1456 * @tv_margins: TV margins to apply to the mode.
1458 struct drm_connector_tv_margins tv_margins;
1461 * @tv_mode: TV mode standard. See DRM_MODE_TV_MODE_*.
1463 enum drm_connector_tv_mode tv_mode;
1466 * @tv_mode_specified:
1468 * Did the mode have a preferred TV mode?
1470 bool tv_mode_specified;
1474 * struct drm_connector - central DRM connector control structure
1476 * Each connector may be connected to one or more CRTCs, or may be clonable by
1477 * another connector if they can share a CRTC. Each connector also has a specific
1478 * position in the broader display (referred to as a 'screen' though it could
1479 * span multiple monitors).
1481 struct drm_connector {
1482 /** @dev: parent DRM device */
1483 struct drm_device *dev;
1484 /** @kdev: kernel device for sysfs attributes */
1485 struct device *kdev;
1486 /** @attr: sysfs attributes */
1487 struct device_attribute *attr;
1489 * @fwnode: associated fwnode supplied by platform firmware
1491 * Drivers can set this to associate a fwnode with a connector, drivers
1492 * are expected to get a reference on the fwnode when setting this.
1493 * drm_connector_cleanup() will call fwnode_handle_put() on this.
1495 struct fwnode_handle *fwnode;
1500 * List of all connectors on a @dev, linked from
1501 * &drm_mode_config.connector_list. Protected by
1502 * &drm_mode_config.connector_list_lock, but please only use
1503 * &drm_connector_list_iter to walk this list.
1505 struct list_head head;
1508 * @global_connector_list_entry:
1510 * Connector entry in the global connector-list, used by
1511 * drm_connector_find_by_fwnode().
1513 struct list_head global_connector_list_entry;
1515 /** @base: base KMS object */
1516 struct drm_mode_object base;
1518 /** @name: human readable name, can be overwritten by the driver */
1522 * @mutex: Lock for general connector state, but currently only protects
1523 * @registered. Most of the connector state is still protected by
1524 * &drm_mode_config.mutex.
1529 * @index: Compacted connector index, which matches the position inside
1530 * the mode_config.list for drivers not supporting hot-add/removing. Can
1531 * be used as an array index. It is invariant over the lifetime of the
1538 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1541 /** @connector_type_id: index into connector type enum */
1542 int connector_type_id;
1544 * @interlace_allowed:
1545 * Can this connector handle interlaced modes? Only used by
1546 * drm_helper_probe_single_connector_modes() for mode filtering.
1548 bool interlace_allowed;
1550 * @doublescan_allowed:
1551 * Can this connector handle doublescan? Only used by
1552 * drm_helper_probe_single_connector_modes() for mode filtering.
1554 bool doublescan_allowed;
1557 * Can this connector handle stereo modes? Only used by
1558 * drm_helper_probe_single_connector_modes() for mode filtering.
1560 bool stereo_allowed;
1563 * @ycbcr_420_allowed : This bool indicates if this connector is
1564 * capable of handling YCBCR 420 output. While parsing the EDID
1565 * blocks it's very helpful to know if the source is capable of
1566 * handling YCBCR 420 outputs.
1568 bool ycbcr_420_allowed;
1571 * @registration_state: Is this connector initializing, exposed
1572 * (registered) with userspace, or unregistered?
1574 * Protected by @mutex.
1576 enum drm_connector_registration_state registration_state;
1580 * Modes available on this connector (from fill_modes() + user).
1581 * Protected by &drm_mode_config.mutex.
1583 struct list_head modes;
1587 * One of the drm_connector_status enums (connected, not, or unknown).
1588 * Protected by &drm_mode_config.mutex.
1590 enum drm_connector_status status;
1594 * These are modes added by probing with DDC or the BIOS, before
1595 * filtering is applied. Used by the probe helpers. Protected by
1596 * &drm_mode_config.mutex.
1598 struct list_head probed_modes;
1601 * @display_info: Display information is filled from EDID information
1602 * when a display is detected. For non hot-pluggable displays such as
1603 * flat panels in embedded systems, the driver should initialize the
1604 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1605 * with the physical size of the display.
1607 * Protected by &drm_mode_config.mutex.
1609 struct drm_display_info display_info;
1611 /** @funcs: connector control functions */
1612 const struct drm_connector_funcs *funcs;
1615 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1616 * &drm_mode_config.mutex. This should be updated only by calling
1617 * drm_connector_update_edid_property().
1619 struct drm_property_blob *edid_blob_ptr;
1621 /** @properties: property tracking for this connector */
1622 struct drm_object_properties properties;
1625 * @scaling_mode_property: Optional atomic property to control the
1626 * upscaling. See drm_connector_attach_content_protection_property().
1628 struct drm_property *scaling_mode_property;
1631 * @vrr_capable_property: Optional property to help userspace
1632 * query hardware support for variable refresh rate on a connector.
1633 * connector. Drivers can add the property to a connector by
1634 * calling drm_connector_attach_vrr_capable_property().
1636 * This should be updated only by calling
1637 * drm_connector_set_vrr_capable_property().
1639 struct drm_property *vrr_capable_property;
1642 * @colorspace_property: Connector property to set the suitable
1643 * colorspace supported by the sink.
1645 struct drm_property *colorspace_property;
1650 * DRM blob property data for the DP MST path property. This should only
1651 * be updated by calling drm_connector_set_path_property().
1653 struct drm_property_blob *path_blob_ptr;
1656 * @max_bpc_property: Default connector property for the max bpc to be
1657 * driven out of the connector.
1659 struct drm_property *max_bpc_property;
1661 /** @privacy_screen: drm_privacy_screen for this connector, or NULL. */
1662 struct drm_privacy_screen *privacy_screen;
1664 /** @privacy_screen_notifier: privacy-screen notifier_block */
1665 struct notifier_block privacy_screen_notifier;
1668 * @privacy_screen_sw_state_property: Optional atomic property for the
1669 * connector to control the integrated privacy screen.
1671 struct drm_property *privacy_screen_sw_state_property;
1674 * @privacy_screen_hw_state_property: Optional atomic property for the
1675 * connector to report the actual integrated privacy screen state.
1677 struct drm_property *privacy_screen_hw_state_property;
1679 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1680 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1681 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1686 * Connector polling mode, a combination of
1688 * DRM_CONNECTOR_POLL_HPD
1689 * The connector generates hotplug events and doesn't need to be
1690 * periodically polled. The CONNECT and DISCONNECT flags must not
1691 * be set together with the HPD flag.
1693 * DRM_CONNECTOR_POLL_CONNECT
1694 * Periodically poll the connector for connection.
1696 * DRM_CONNECTOR_POLL_DISCONNECT
1697 * Periodically poll the connector for disconnection, without
1698 * causing flickering even when the connector is in use. DACs should
1699 * rarely do this without a lot of testing.
1701 * Set to 0 for connectors that don't support connection status
1707 * @dpms: Current dpms state. For legacy drivers the
1708 * &drm_connector_funcs.dpms callback must update this. For atomic
1709 * drivers, this is handled by the core atomic code, and drivers must
1710 * only take &drm_crtc_state.active into account.
1714 /** @helper_private: mid-layer private data */
1715 const struct drm_connector_helper_funcs *helper_private;
1717 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1718 struct drm_cmdline_mode cmdline_mode;
1719 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1720 enum drm_connector_force force;
1723 * @edid_override: Override EDID set via debugfs.
1725 * Do not modify or access outside of the drm_edid_override_* family of
1728 const struct drm_edid *edid_override;
1731 * @edid_override_mutex: Protect access to edid_override.
1733 struct mutex edid_override_mutex;
1735 /** @epoch_counter: used to detect any other changes in connector, besides status */
1739 * @possible_encoders: Bit mask of encoders that can drive this
1740 * connector, drm_encoder_index() determines the index into the bitfield
1741 * and the bits are set with drm_connector_attach_encoder().
1743 u32 possible_encoders;
1746 * @encoder: Currently bound encoder driving this connector, if any.
1747 * Only really meaningful for non-atomic drivers. Atomic drivers should
1748 * instead look at &drm_connector_state.best_encoder, and in case they
1749 * need the CRTC driving this output, &drm_connector_state.crtc.
1751 struct drm_encoder *encoder;
1753 #define MAX_ELD_BYTES 128
1754 /** @eld: EDID-like data, if present */
1755 uint8_t eld[MAX_ELD_BYTES];
1756 /** @latency_present: AV delay info from ELD, if found */
1757 bool latency_present[2];
1759 * @video_latency: Video latency info from ELD, if found.
1760 * [0]: progressive, [1]: interlaced
1762 int video_latency[2];
1764 * @audio_latency: audio latency info from ELD, if found
1765 * [0]: progressive, [1]: interlaced
1767 int audio_latency[2];
1770 * @ddc: associated ddc adapter.
1771 * A connector usually has its associated ddc adapter. If a driver uses
1772 * this field, then an appropriate symbolic link is created in connector
1773 * sysfs directory to make it easy for the user to tell which i2c
1774 * adapter is for a particular display.
1776 * The field should be set by calling drm_connector_init_with_ddc().
1778 struct i2c_adapter *ddc;
1781 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1782 * Needed to workaround some HW bugs where we get all 0s
1784 int null_edid_counter;
1786 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1787 unsigned bad_edid_counter;
1790 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1791 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1796 * @real_edid_checksum: real edid checksum for corrupted edid block.
1797 * Required in Displayport 1.4 compliance testing
1800 u8 real_edid_checksum;
1802 /** @debugfs_entry: debugfs directory for this connector */
1803 struct dentry *debugfs_entry;
1808 * Current atomic state for this connector.
1810 * This is protected by &drm_mode_config.connection_mutex. Note that
1811 * nonblocking atomic commits access the current connector state without
1812 * taking locks. Either by going through the &struct drm_atomic_state
1813 * pointers, see for_each_oldnew_connector_in_state(),
1814 * for_each_old_connector_in_state() and
1815 * for_each_new_connector_in_state(). Or through careful ordering of
1816 * atomic commit operations as implemented in the atomic helpers, see
1817 * &struct drm_crtc_commit.
1819 struct drm_connector_state *state;
1821 /* DisplayID bits. FIXME: Extract into a substruct? */
1826 * DRM blob property data for the tile property (used mostly by DP MST).
1827 * This is meant for screens which are driven through separate display
1828 * pipelines represented by &drm_crtc, which might not be running with
1829 * genlocked clocks. For tiled panels which are genlocked, like
1830 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1831 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1833 * This should only be updated by calling
1834 * drm_connector_set_tile_property().
1836 struct drm_property_blob *tile_blob_ptr;
1838 /** @has_tile: is this connector connected to a tiled monitor */
1840 /** @tile_group: tile group for the connected monitor */
1841 struct drm_tile_group *tile_group;
1842 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1843 bool tile_is_single_monitor;
1845 /** @num_h_tile: number of horizontal tiles in the tile group */
1846 /** @num_v_tile: number of vertical tiles in the tile group */
1847 uint8_t num_h_tile, num_v_tile;
1848 /** @tile_h_loc: horizontal location of this tile */
1849 /** @tile_v_loc: vertical location of this tile */
1850 uint8_t tile_h_loc, tile_v_loc;
1851 /** @tile_h_size: horizontal size of this tile. */
1852 /** @tile_v_size: vertical size of this tile. */
1853 uint16_t tile_h_size, tile_v_size;
1858 * List used only by &drm_connector_list_iter to be able to clean up a
1859 * connector from any context, in conjunction with
1860 * &drm_mode_config.connector_free_work.
1862 struct llist_node free_node;
1864 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1865 struct hdr_sink_metadata hdr_sink_metadata;
1868 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1870 int drm_connector_init(struct drm_device *dev,
1871 struct drm_connector *connector,
1872 const struct drm_connector_funcs *funcs,
1873 int connector_type);
1874 int drm_connector_init_with_ddc(struct drm_device *dev,
1875 struct drm_connector *connector,
1876 const struct drm_connector_funcs *funcs,
1878 struct i2c_adapter *ddc);
1879 int drmm_connector_init(struct drm_device *dev,
1880 struct drm_connector *connector,
1881 const struct drm_connector_funcs *funcs,
1883 struct i2c_adapter *ddc);
1884 void drm_connector_attach_edid_property(struct drm_connector *connector);
1885 int drm_connector_register(struct drm_connector *connector);
1886 void drm_connector_unregister(struct drm_connector *connector);
1887 int drm_connector_attach_encoder(struct drm_connector *connector,
1888 struct drm_encoder *encoder);
1890 void drm_connector_cleanup(struct drm_connector *connector);
1892 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1894 return connector->index;
1897 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1899 return 1 << connector->index;
1903 * drm_connector_lookup - lookup connector object
1905 * @file_priv: drm file to check for lease against.
1906 * @id: connector object id
1908 * This function looks up the connector object specified by id
1909 * add takes a reference to it.
1911 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1912 struct drm_file *file_priv,
1915 struct drm_mode_object *mo;
1916 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1917 return mo ? obj_to_connector(mo) : NULL;
1921 * drm_connector_get - acquire a connector reference
1922 * @connector: DRM connector
1924 * This function increments the connector's refcount.
1926 static inline void drm_connector_get(struct drm_connector *connector)
1928 drm_mode_object_get(&connector->base);
1932 * drm_connector_put - release a connector reference
1933 * @connector: DRM connector
1935 * This function decrements the connector's reference count and frees the
1936 * object if the reference count drops to zero.
1938 static inline void drm_connector_put(struct drm_connector *connector)
1940 drm_mode_object_put(&connector->base);
1944 * drm_connector_is_unregistered - has the connector been unregistered from
1946 * @connector: DRM connector
1948 * Checks whether or not @connector has been unregistered from userspace.
1951 * True if the connector was unregistered, false if the connector is
1952 * registered or has not yet been registered with userspace.
1955 drm_connector_is_unregistered(struct drm_connector *connector)
1957 return READ_ONCE(connector->registration_state) ==
1958 DRM_CONNECTOR_UNREGISTERED;
1961 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode);
1962 const char *drm_get_connector_type_name(unsigned int connector_type);
1963 const char *drm_get_connector_status_name(enum drm_connector_status status);
1964 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1965 const char *drm_get_dpms_name(int val);
1966 const char *drm_get_dvi_i_subconnector_name(int val);
1967 const char *drm_get_dvi_i_select_name(int val);
1968 const char *drm_get_tv_mode_name(int val);
1969 const char *drm_get_tv_subconnector_name(int val);
1970 const char *drm_get_tv_select_name(int val);
1971 const char *drm_get_dp_subconnector_name(int val);
1972 const char *drm_get_content_protection_name(int val);
1973 const char *drm_get_hdcp_content_type_name(int val);
1975 int drm_get_tv_mode_from_name(const char *name, size_t len);
1977 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1978 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
1980 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1981 int drm_mode_create_tv_properties_legacy(struct drm_device *dev,
1982 unsigned int num_modes,
1983 const char * const modes[]);
1984 int drm_mode_create_tv_properties(struct drm_device *dev,
1985 unsigned int supported_tv_modes);
1986 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1987 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1988 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1989 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1990 u32 scaling_mode_mask);
1991 int drm_connector_attach_vrr_capable_property(
1992 struct drm_connector *connector);
1993 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
1994 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
1995 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
1996 struct drm_connector_state *new_state);
1997 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1998 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector,
1999 u32 supported_colorspaces);
2000 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector,
2001 u32 supported_colorspaces);
2002 int drm_mode_create_content_type_property(struct drm_device *dev);
2003 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
2005 int drm_connector_set_path_property(struct drm_connector *connector,
2007 int drm_connector_set_tile_property(struct drm_connector *connector);
2008 int drm_connector_update_edid_property(struct drm_connector *connector,
2009 const struct edid *edid);
2010 void drm_connector_set_link_status_property(struct drm_connector *connector,
2011 uint64_t link_status);
2012 void drm_connector_set_vrr_capable_property(
2013 struct drm_connector *connector, bool capable);
2014 int drm_connector_set_panel_orientation(
2015 struct drm_connector *connector,
2016 enum drm_panel_orientation panel_orientation);
2017 int drm_connector_set_panel_orientation_with_quirk(
2018 struct drm_connector *connector,
2019 enum drm_panel_orientation panel_orientation,
2020 int width, int height);
2021 int drm_connector_set_orientation_from_panel(
2022 struct drm_connector *connector,
2023 struct drm_panel *panel);
2024 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
2026 void drm_connector_create_privacy_screen_properties(struct drm_connector *conn);
2027 void drm_connector_attach_privacy_screen_properties(struct drm_connector *conn);
2028 void drm_connector_attach_privacy_screen_provider(
2029 struct drm_connector *connector, struct drm_privacy_screen *priv);
2030 void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state);
2033 * struct drm_tile_group - Tile group metadata
2034 * @refcount: reference count
2036 * @id: tile group id exposed to userspace
2037 * @group_data: Sink-private data identifying this group
2039 * @group_data corresponds to displayid vend/prod/serial for external screens
2042 struct drm_tile_group {
2043 struct kref refcount;
2044 struct drm_device *dev;
2049 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
2050 const char topology[8]);
2051 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
2052 const char topology[8]);
2053 void drm_mode_put_tile_group(struct drm_device *dev,
2054 struct drm_tile_group *tg);
2057 * struct drm_connector_list_iter - connector_list iterator
2059 * This iterator tracks state needed to be able to walk the connector_list
2060 * within struct drm_mode_config. Only use together with
2061 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
2062 * drm_connector_list_iter_next() respectively the convenience macro
2063 * drm_for_each_connector_iter().
2065 * Note that the return value of drm_connector_list_iter_next() is only valid
2066 * up to the next drm_connector_list_iter_next() or
2067 * drm_connector_list_iter_end() call. If you want to use the connector later,
2068 * then you need to grab your own reference first using drm_connector_get().
2070 struct drm_connector_list_iter {
2072 struct drm_device *dev;
2073 struct drm_connector *conn;
2076 void drm_connector_list_iter_begin(struct drm_device *dev,
2077 struct drm_connector_list_iter *iter);
2078 struct drm_connector *
2079 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
2080 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
2082 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
2083 struct drm_encoder *encoder);
2084 const char *drm_get_colorspace_name(enum drm_colorspace colorspace);
2087 * drm_for_each_connector_iter - connector_list iterator macro
2088 * @connector: &struct drm_connector pointer used as cursor
2089 * @iter: &struct drm_connector_list_iter
2091 * Note that @connector is only valid within the list body, if you want to use
2092 * @connector after calling drm_connector_list_iter_end() then you need to grab
2093 * your own reference first using drm_connector_get().
2095 #define drm_for_each_connector_iter(connector, iter) \
2096 while ((connector = drm_connector_list_iter_next(iter)))
2099 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
2100 * @connector: &struct drm_connector pointer
2101 * @encoder: &struct drm_encoder pointer used as cursor
2103 #define drm_connector_for_each_possible_encoder(connector, encoder) \
2104 drm_for_each_encoder_mask(encoder, (connector)->dev, \
2105 (connector)->possible_encoders)