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>
34 #include <uapi/drm/drm_mode.h>
36 struct drm_connector_helper_funcs;
37 struct drm_modeset_acquire_ctx;
43 struct drm_property_blob;
45 struct drm_privacy_screen;
49 enum drm_connector_force {
50 DRM_FORCE_UNSPECIFIED,
52 DRM_FORCE_ON, /* force on analog part normally */
53 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
57 * enum drm_connector_status - status for a &drm_connector
59 * This enum is used to track the connector status. There are no separate
60 * #defines for the uapi!
62 enum drm_connector_status {
64 * @connector_status_connected: The connector is definitely connected to
65 * a sink device, and can be enabled.
67 connector_status_connected = 1,
69 * @connector_status_disconnected: The connector isn't connected to a
70 * sink device which can be autodetect. For digital outputs like DP or
71 * HDMI (which can be realiable probed) this means there's really
72 * nothing there. It is driver-dependent whether a connector with this
73 * status can be lit up or not.
75 connector_status_disconnected = 2,
77 * @connector_status_unknown: The connector's status could not be
78 * reliably detected. This happens when probing would either cause
79 * flicker (like load-detection when the connector is in use), or when a
80 * hardware resource isn't available (like when load-detection needs a
81 * free CRTC). It should be possible to light up the connector with one
82 * of the listed fallback modes. For default configuration userspace
83 * should only try to light up connectors with unknown status when
84 * there's not connector with @connector_status_connected.
86 connector_status_unknown = 3,
90 * enum drm_connector_registration_state - userspace registration status for
93 * This enum is used to track the status of initializing a connector and
94 * registering it with userspace, so that DRM can prevent bogus modesets on
95 * connectors that no longer exist.
97 enum drm_connector_registration_state {
99 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
100 * but has yet to be exposed to userspace. There should be no
101 * additional restrictions to how the state of this connector may be
104 DRM_CONNECTOR_INITIALIZING = 0,
107 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
108 * and registered with sysfs, as such it has been exposed to
109 * userspace. There should be no additional restrictions to how the
110 * state of this connector may be modified.
112 DRM_CONNECTOR_REGISTERED = 1,
115 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
116 * to userspace and has since been unregistered and removed from
117 * userspace, or the connector was unregistered before it had a chance
118 * to be exposed to userspace (e.g. still in the
119 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
120 * unregistered, there are additional restrictions to how its state
123 * - An unregistered connector may only have its DPMS changed from
124 * On->Off. Once DPMS is changed to Off, it may not be switched back
126 * - Modesets are not allowed on unregistered connectors, unless they
127 * would result in disabling its assigned CRTCs. This means
128 * disabling a CRTC on an unregistered connector is OK, but enabling
130 * - Removing a CRTC from an unregistered connector is OK, but new
131 * CRTCs may never be assigned to an unregistered connector.
133 DRM_CONNECTOR_UNREGISTERED = 2,
136 enum subpixel_order {
138 SubPixelHorizontalRGB,
139 SubPixelHorizontalBGR,
147 * struct drm_scrambling: sink's scrambling support.
149 struct drm_scrambling {
151 * @supported: scrambling supported for rates > 340 Mhz.
155 * @low_rates: scrambling supported for rates <= 340 Mhz.
161 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
163 * Provides SCDC register support and capabilities related information on a
164 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
168 * @supported: status control & data channel present.
172 * @read_request: sink is capable of generating scdc read request.
176 * @scrambling: sink's scrambling capabilities
178 struct drm_scrambling scrambling;
182 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink
184 * Describes the DSC support provided by HDMI 2.1 sink.
185 * The information is fetched fom additional HFVSDB blocks defined
188 struct drm_hdmi_dsc_cap {
189 /** @v_1p2: flag for dsc1.2 version support by sink */
192 /** @native_420: Does sink support DSC with 4:2:0 compression */
196 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2
202 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc
206 /** @max_slices: maximum number of Horizontal slices supported by */
209 /** @clk_per_slice : max pixel clock in MHz supported per slice */
212 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */
215 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */
216 u8 max_frl_rate_per_lane;
218 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/
219 u8 total_chunk_kbytes;
223 * struct drm_hdmi_info - runtime information about the connected HDMI sink
225 * Describes if a given display supports advanced HDMI 2.0 features.
226 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
228 struct drm_hdmi_info {
229 /** @scdc: sink's scdc support and capabilities */
230 struct drm_scdc scdc;
233 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
234 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
235 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
238 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
241 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
242 * output also, along with normal HDMI outputs. The max VIC defined by
243 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
246 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
248 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
251 /** @y420_dc_modes: bitmap of deep color support index */
254 /** @max_frl_rate_per_lane: support fixed rate link */
255 u8 max_frl_rate_per_lane;
257 /** @max_lanes: supported by sink */
260 /** @dsc_cap: DSC capabilities of the sink */
261 struct drm_hdmi_dsc_cap dsc_cap;
265 * enum drm_link_status - connector's link_status property value
267 * This enum is used as the connector's link status property value.
268 * It is set to the values defined in uapi.
270 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
272 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
275 enum drm_link_status {
276 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
277 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
281 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
283 * This enum is used to track the (LCD) panel orientation. There are no
284 * separate #defines for the uapi!
286 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
287 * panel orientation information (normal
288 * for non panels) in this case the "panel
289 * orientation" connector prop will not be
291 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
292 * top side of the device's casing.
293 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
294 * bottom side of the device's casing, iow
295 * the panel is mounted upside-down.
296 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
297 * top side of the device's casing.
298 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
299 * top side of the device's casing.
301 enum drm_panel_orientation {
302 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
303 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
304 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
305 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
306 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
310 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
313 * This struct is used to store a frequency range supported by panel
314 * as parsed from EDID's detailed monitor range descriptor block.
316 * @min_vfreq: This is the min supported refresh rate in Hz from
317 * EDID's detailed monitor range.
318 * @max_vfreq: This is the max supported refresh rate in Hz from
319 * EDID's detailed monitor range
321 struct drm_monitor_range_info {
327 * struct drm_luminance_range_info - Panel's luminance range for
328 * &drm_display_info. Calculated using data in EDID
330 * This struct is used to store a luminance range supported by panel
331 * as calculated using data from EDID's static hdr metadata.
333 * @min_luminance: This is the min supported luminance value
335 * @max_luminance: This is the max supported luminance value
337 struct drm_luminance_range_info {
343 * enum drm_privacy_screen_status - privacy screen status
345 * This enum is used to track and control the state of the integrated privacy
346 * screen present on some display panels, via the "privacy-screen sw-state"
347 * and "privacy-screen hw-state" properties. Note the _LOCKED enum values
348 * are only valid for the "privacy-screen hw-state" property.
350 * @PRIVACY_SCREEN_DISABLED:
351 * The privacy-screen on the panel is disabled
352 * @PRIVACY_SCREEN_ENABLED:
353 * The privacy-screen on the panel is enabled
354 * @PRIVACY_SCREEN_DISABLED_LOCKED:
355 * The privacy-screen on the panel is disabled and locked (cannot be changed)
356 * @PRIVACY_SCREEN_ENABLED_LOCKED:
357 * The privacy-screen on the panel is enabled and locked (cannot be changed)
359 enum drm_privacy_screen_status {
360 PRIVACY_SCREEN_DISABLED = 0,
361 PRIVACY_SCREEN_ENABLED,
362 PRIVACY_SCREEN_DISABLED_LOCKED,
363 PRIVACY_SCREEN_ENABLED_LOCKED,
367 * This is a consolidated colorimetry list supported by HDMI and
368 * DP protocol standard. The respective connectors will register
369 * a property with the subset of this list (supported by that
370 * respective protocol). Userspace will set the colorspace through
371 * a colorspace property which will be created and exposed to
375 /* For Default case, driver will set the colorspace */
376 #define DRM_MODE_COLORIMETRY_DEFAULT 0
377 /* CEA 861 Normal Colorimetry options */
378 #define DRM_MODE_COLORIMETRY_NO_DATA 0
379 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC 1
380 #define DRM_MODE_COLORIMETRY_BT709_YCC 2
381 /* CEA 861 Extended Colorimetry Options */
382 #define DRM_MODE_COLORIMETRY_XVYCC_601 3
383 #define DRM_MODE_COLORIMETRY_XVYCC_709 4
384 #define DRM_MODE_COLORIMETRY_SYCC_601 5
385 #define DRM_MODE_COLORIMETRY_OPYCC_601 6
386 #define DRM_MODE_COLORIMETRY_OPRGB 7
387 #define DRM_MODE_COLORIMETRY_BT2020_CYCC 8
388 #define DRM_MODE_COLORIMETRY_BT2020_RGB 9
389 #define DRM_MODE_COLORIMETRY_BT2020_YCC 10
390 /* Additional Colorimetry extension added as part of CTA 861.G */
391 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 11
392 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER 12
393 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
394 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED 13
395 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT 14
396 #define DRM_MODE_COLORIMETRY_BT601_YCC 15
399 * enum drm_bus_flags - bus_flags info for &drm_display_info
401 * This enum defines signal polarities and clock edge information for signals on
402 * a bus as bitmask flags.
404 * The clock edge information is conveyed by two sets of symbols,
405 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
406 * used to describe a bus from the point of view of the transmitter, the
407 * \*_DRIVE_\* flags should be used. When used from the point of view of the
408 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
409 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
410 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
411 * respectively. This simplifies code as signals are usually sampled on the
412 * opposite edge of the driving edge. Transmitters and receivers may however
413 * need to take other signal timings into account to convert between driving
418 * @DRM_BUS_FLAG_DE_LOW:
420 * The Data Enable signal is active low
422 DRM_BUS_FLAG_DE_LOW = BIT(0),
425 * @DRM_BUS_FLAG_DE_HIGH:
427 * The Data Enable signal is active high
429 DRM_BUS_FLAG_DE_HIGH = BIT(1),
432 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
434 * Data is driven on the rising edge of the pixel clock
436 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
439 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
441 * Data is driven on the falling edge of the pixel clock
443 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
446 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
448 * Data is sampled on the rising edge of the pixel clock
450 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
453 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
455 * Data is sampled on the falling edge of the pixel clock
457 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
460 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
462 * Data is transmitted MSB to LSB on the bus
464 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
467 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
469 * Data is transmitted LSB to MSB on the bus
471 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
474 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
476 * Sync signals are driven on the rising edge of the pixel clock
478 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
481 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
483 * Sync signals are driven on the falling edge of the pixel clock
485 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
488 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
490 * Sync signals are sampled on the rising edge of the pixel clock
492 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
495 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
497 * Sync signals are sampled on the falling edge of the pixel clock
499 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
502 * @DRM_BUS_FLAG_SHARP_SIGNALS:
504 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
506 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
510 * struct drm_display_info - runtime data about the connected sink
512 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
513 * fixed display sinks like built-in panels there's not much difference between
514 * this and &struct drm_connector. But for sinks with a real cable this
515 * structure is meant to describe all the things at the other end of the cable.
517 * For sinks which provide an EDID this can be filled out by calling
518 * drm_add_edid_modes().
520 struct drm_display_info {
522 * @width_mm: Physical width in mm.
524 unsigned int width_mm;
527 * @height_mm: Physical height in mm.
529 unsigned int height_mm;
532 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
537 * @subpixel_order: Subpixel order of LCD panels.
539 enum subpixel_order subpixel_order;
541 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
542 #define DRM_COLOR_FORMAT_YCBCR444 (1<<1)
543 #define DRM_COLOR_FORMAT_YCBCR422 (1<<2)
544 #define DRM_COLOR_FORMAT_YCBCR420 (1<<3)
547 * @panel_orientation: Read only connector property for built-in panels,
548 * indicating the orientation of the panel vs the device's casing.
549 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
550 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
551 * fb to compensate and gets exported as prop to userspace.
553 int panel_orientation;
556 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
557 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
558 * as used to describe the pixel format in framebuffers, and also don't
559 * match the formats in @bus_formats which are shared with v4l.
564 * @bus_formats: Pixel data format on the wire, somewhat redundant with
565 * @color_formats. Array of size @num_bus_formats encoded using
566 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
568 const u32 *bus_formats;
570 * @num_bus_formats: Size of @bus_formats array.
572 unsigned int num_bus_formats;
575 * @bus_flags: Additional information (like pixel signal polarity) for
576 * the pixel data on the bus, using &enum drm_bus_flags values
582 * @max_tmds_clock: Maximum TMDS clock rate supported by the
583 * sink in kHz. 0 means undefined.
588 * @dvi_dual: Dual-link DVI sink?
593 * @is_hdmi: True if the sink is an HDMI device.
595 * This field shall be used instead of calling
596 * drm_detect_hdmi_monitor() when possible.
601 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
603 bool has_hdmi_infoframe;
606 * @rgb_quant_range_selectable: Does the sink support selecting
607 * the RGB quantization range?
609 bool rgb_quant_range_selectable;
612 * @edid_hdmi_rgb444_dc_modes: Mask of supported hdmi deep color modes
613 * in RGB 4:4:4. Even more stuff redundant with @bus_formats.
615 u8 edid_hdmi_rgb444_dc_modes;
618 * @edid_hdmi_ycbcr444_dc_modes: Mask of supported hdmi deep color
619 * modes in YCbCr 4:4:4. Even more stuff redundant with @bus_formats.
621 u8 edid_hdmi_ycbcr444_dc_modes;
624 * @cea_rev: CEA revision of the HDMI sink.
629 * @hdmi: advance features of a HDMI sink.
631 struct drm_hdmi_info hdmi;
634 * @non_desktop: Non desktop display (HMD).
639 * @monitor_range: Frequency range supported by monitor range descriptor
641 struct drm_monitor_range_info monitor_range;
644 * @luminance_range: Luminance range supported by panel
646 struct drm_luminance_range_info luminance_range;
649 * @mso_stream_count: eDP Multi-SST Operation (MSO) stream count from
650 * the DisplayID VESA vendor block. 0 for conventional Single-Stream
651 * Transport (SST), or 2 or 4 MSO streams.
656 * @mso_pixel_overlap: eDP MSO segment pixel overlap, 0-8 pixels.
658 u8 mso_pixel_overlap;
661 * @max_dsc_bpp: Maximum DSC target bitrate, if it is set to 0 the
662 * monitor's default value is used instead.
667 int drm_display_info_set_bus_formats(struct drm_display_info *info,
669 unsigned int num_formats);
672 * struct drm_connector_tv_margins - TV connector related margins
674 * Describes the margins in pixels to put around the image on TV
675 * connectors to deal with overscan.
677 struct drm_connector_tv_margins {
679 * @bottom: Bottom margin in pixels.
684 * @left: Left margin in pixels.
689 * @right: Right margin in pixels.
694 * @top: Top margin in pixels.
700 * struct drm_tv_connector_state - TV connector related states
701 * @select_subconnector: selected subconnector
702 * @subconnector: detected subconnector
703 * @margins: TV margins
705 * @brightness: brightness in percent
706 * @contrast: contrast in percent
707 * @flicker_reduction: flicker reduction in percent
708 * @overscan: overscan in percent
709 * @saturation: saturation in percent
710 * @hue: hue in percent
712 struct drm_tv_connector_state {
713 enum drm_mode_subconnector select_subconnector;
714 enum drm_mode_subconnector subconnector;
715 struct drm_connector_tv_margins margins;
717 unsigned int brightness;
718 unsigned int contrast;
719 unsigned int flicker_reduction;
720 unsigned int overscan;
721 unsigned int saturation;
726 * struct drm_connector_state - mutable connector state
728 struct drm_connector_state {
729 /** @connector: backpointer to the connector */
730 struct drm_connector *connector;
733 * @crtc: CRTC to connect connector to, NULL if disabled.
735 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
738 struct drm_crtc *crtc;
743 * Used by the atomic helpers to select the encoder, through the
744 * &drm_connector_helper_funcs.atomic_best_encoder or
745 * &drm_connector_helper_funcs.best_encoder callbacks.
747 * This is also used in the atomic helpers to map encoders to their
748 * current and previous connectors, see
749 * drm_atomic_get_old_connector_for_encoder() and
750 * drm_atomic_get_new_connector_for_encoder().
752 * NOTE: Atomic drivers must fill this out (either themselves or through
753 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
754 * not return correct data to userspace.
756 struct drm_encoder *best_encoder;
759 * @link_status: Connector link_status to keep track of whether link is
760 * GOOD or BAD to notify userspace if retraining is necessary.
762 enum drm_link_status link_status;
764 /** @state: backpointer to global drm_atomic_state */
765 struct drm_atomic_state *state;
768 * @commit: Tracks the pending commit to prevent use-after-free conditions.
770 * Is only set when @crtc is NULL.
772 struct drm_crtc_commit *commit;
774 /** @tv: TV connector state */
775 struct drm_tv_connector_state tv;
778 * @self_refresh_aware:
780 * This tracks whether a connector is aware of the self refresh state.
781 * It should be set to true for those connector implementations which
782 * understand the self refresh state. This is needed since the crtc
783 * registers the self refresh helpers and it doesn't know if the
784 * connectors downstream have implemented self refresh entry/exit.
786 * Drivers should set this to true in atomic_check if they know how to
787 * handle self_refresh requests.
789 bool self_refresh_aware;
792 * @picture_aspect_ratio: Connector property to control the
793 * HDMI infoframe aspect ratio setting.
795 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
796 * values for &enum hdmi_picture_aspect
798 enum hdmi_picture_aspect picture_aspect_ratio;
801 * @content_type: Connector property to control the
802 * HDMI infoframe content type setting.
803 * The %DRM_MODE_CONTENT_TYPE_\* values much
806 unsigned int content_type;
809 * @hdcp_content_type: Connector property to pass the type of
810 * protected content. This is most commonly used for HDCP.
812 unsigned int hdcp_content_type;
815 * @scaling_mode: Connector property to control the
816 * upscaling, mostly used for built-in panels.
818 unsigned int scaling_mode;
821 * @content_protection: Connector property to request content
822 * protection. This is most commonly used for HDCP.
824 unsigned int content_protection;
827 * @colorspace: State variable for Connector property to request
828 * colorspace change on Sink. This is most commonly used to switch
829 * to wider color gamuts like BT2020.
834 * @writeback_job: Writeback job for writeback connectors
836 * Holds the framebuffer and out-fence for a writeback connector. As
837 * the writeback completion may be asynchronous to the normal commit
838 * cycle, the writeback job lifetime is managed separately from the
839 * normal atomic state by this object.
841 * See also: drm_writeback_queue_job() and
842 * drm_writeback_signal_completion()
844 struct drm_writeback_job *writeback_job;
847 * @max_requested_bpc: Connector property to limit the maximum bit
848 * depth of the pixels.
850 u8 max_requested_bpc;
853 * @max_bpc: Connector max_bpc based on the requested max_bpc property
854 * and the connector bpc limitations obtained from edid.
859 * @privacy_screen_sw_state: See :ref:`Standard Connector
860 * Properties<standard_connector_properties>`
862 enum drm_privacy_screen_status privacy_screen_sw_state;
865 * @hdr_output_metadata:
866 * DRM blob property for HDR output metadata
868 struct drm_property_blob *hdr_output_metadata;
872 * struct drm_connector_funcs - control connectors on a given device
874 * Each CRTC may have one or more connectors attached to it. The functions
875 * below allow the core DRM code to control connectors, enumerate available modes,
878 struct drm_connector_funcs {
882 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
883 * is exposed as a standard property on the connector, but diverted to
884 * this callback in the drm core. Note that atomic drivers don't
885 * implement the 4 level DPMS support on the connector any more, but
886 * instead only have an on/off "ACTIVE" property on the CRTC object.
888 * This hook is not used by atomic drivers, remapping of the legacy DPMS
889 * property is entirely handled in the DRM core.
893 * 0 on success or a negative error code on failure.
895 int (*dpms)(struct drm_connector *connector, int mode);
900 * Reset connector hardware and software state to off. This function isn't
901 * called by the core directly, only through drm_mode_config_reset().
902 * It's not a helper hook only for historical reasons.
904 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
905 * atomic state using this hook.
907 void (*reset)(struct drm_connector *connector);
912 * Check to see if anything is attached to the connector. The parameter
913 * force is set to false whilst polling, true when checking the
914 * connector due to a user request. force can be used by the driver to
915 * avoid expensive, destructive operations during automated probing.
917 * This callback is optional, if not implemented the connector will be
918 * considered as always being attached.
922 * Note that this hook is only called by the probe helper. It's not in
923 * the helper library vtable purely for historical reasons. The only DRM
924 * core entry point to probe connector state is @fill_modes.
926 * Note that the helper library will already hold
927 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
928 * locks to avoid races with concurrent modeset changes need to use
929 * &drm_connector_helper_funcs.detect_ctx instead.
931 * Also note that this callback can be called no matter the
932 * state the connector is in. Drivers that need the underlying
933 * device to be powered to perform the detection will first need
934 * to make sure it's been properly enabled.
938 * drm_connector_status indicating the connector's status.
940 enum drm_connector_status (*detect)(struct drm_connector *connector,
946 * This function is called to update internal encoder state when the
947 * connector is forced to a certain state by userspace, either through
948 * the sysfs interfaces or on the kernel cmdline. In that case the
949 * @detect callback isn't called.
953 * Note that this hook is only called by the probe helper. It's not in
954 * the helper library vtable purely for historical reasons. The only DRM
955 * core entry point to probe connector state is @fill_modes.
957 void (*force)(struct drm_connector *connector);
962 * Entry point for output detection and basic mode validation. The
963 * driver should reprobe the output if needed (e.g. when hotplug
964 * handling is unreliable), add all detected modes to &drm_connector.modes
965 * and filter out any the device can't support in any configuration. It
966 * also needs to filter out any modes wider or higher than the
967 * parameters max_width and max_height indicate.
969 * The drivers must also prune any modes no longer valid from
970 * &drm_connector.modes. Furthermore it must update
971 * &drm_connector.status and &drm_connector.edid. If no EDID has been
972 * received for this output connector->edid must be NULL.
974 * Drivers using the probe helpers should use
975 * drm_helper_probe_single_connector_modes() to implement this
980 * The number of modes detected and filled into &drm_connector.modes.
982 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
987 * This is the legacy entry point to update a property attached to the
990 * This callback is optional if the driver does not support any legacy
991 * driver-private properties. For atomic drivers it is not used because
992 * property handling is done entirely in the DRM core.
996 * 0 on success or a negative error code on failure.
998 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
1004 * This optional hook can be used to register additional userspace
1005 * interfaces attached to the connector, light backlight control, i2c,
1006 * DP aux or similar interfaces. It is called late in the driver load
1007 * sequence from drm_connector_register() when registering all the
1008 * core drm connector interfaces. Everything added from this callback
1009 * should be unregistered in the early_unregister callback.
1011 * This is called while holding &drm_connector.mutex.
1015 * 0 on success, or a negative error code on failure.
1017 int (*late_register)(struct drm_connector *connector);
1020 * @early_unregister:
1022 * This optional hook should be used to unregister the additional
1023 * userspace interfaces attached to the connector from
1024 * late_register(). It is called from drm_connector_unregister(),
1025 * early in the driver unload sequence to disable userspace access
1026 * before data structures are torndown.
1028 * This is called while holding &drm_connector.mutex.
1030 void (*early_unregister)(struct drm_connector *connector);
1035 * Clean up connector resources. This is called at driver unload time
1036 * through drm_mode_config_cleanup(). It can also be called at runtime
1037 * when a connector is being hot-unplugged for drivers that support
1038 * connector hotplugging (e.g. DisplayPort MST).
1040 void (*destroy)(struct drm_connector *connector);
1043 * @atomic_duplicate_state:
1045 * Duplicate the current atomic state for this connector and return it.
1046 * The core and helpers guarantee that any atomic state duplicated with
1047 * this hook and still owned by the caller (i.e. not transferred to the
1048 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
1049 * cleaned up by calling the @atomic_destroy_state hook in this
1052 * This callback is mandatory for atomic drivers.
1054 * Atomic drivers which don't subclass &struct drm_connector_state should use
1055 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
1056 * state structure to extend it with driver-private state should use
1057 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
1058 * duplicated in a consistent fashion across drivers.
1060 * It is an error to call this hook before &drm_connector.state has been
1061 * initialized correctly.
1065 * If the duplicate state references refcounted resources this hook must
1066 * acquire a reference for each of them. The driver must release these
1067 * references again in @atomic_destroy_state.
1071 * Duplicated atomic state or NULL when the allocation failed.
1073 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1076 * @atomic_destroy_state:
1078 * Destroy a state duplicated with @atomic_duplicate_state and release
1079 * or unreference all resources it references
1081 * This callback is mandatory for atomic drivers.
1083 void (*atomic_destroy_state)(struct drm_connector *connector,
1084 struct drm_connector_state *state);
1087 * @atomic_set_property:
1089 * Decode a driver-private property value and store the decoded value
1090 * into the passed-in state structure. Since the atomic core decodes all
1091 * standardized properties (even for extensions beyond the core set of
1092 * properties which might not be implemented by all drivers) this
1093 * requires drivers to subclass the state structure.
1095 * Such driver-private properties should really only be implemented for
1096 * truly hardware/vendor specific state. Instead it is preferred to
1097 * standardize atomic extension and decode the properties used to expose
1098 * such an extension in the core.
1100 * Do not call this function directly, use
1101 * drm_atomic_connector_set_property() instead.
1103 * This callback is optional if the driver does not support any
1104 * driver-private atomic properties.
1108 * This function is called in the state assembly phase of atomic
1109 * modesets, which can be aborted for any reason (including on
1110 * userspace's request to just check whether a configuration would be
1111 * possible). Drivers MUST NOT touch any persistent state (hardware or
1112 * software) or data structures except the passed in @state parameter.
1114 * Also since userspace controls in which order properties are set this
1115 * function must not do any input validation (since the state update is
1116 * incomplete and hence likely inconsistent). Instead any such input
1117 * validation must be done in the various atomic_check callbacks.
1121 * 0 if the property has been found, -EINVAL if the property isn't
1122 * implemented by the driver (which shouldn't ever happen, the core only
1123 * asks for properties attached to this connector). No other validation
1124 * is allowed by the driver. The core already checks that the property
1125 * value is within the range (integer, valid enum value, ...) the driver
1126 * set when registering the property.
1128 int (*atomic_set_property)(struct drm_connector *connector,
1129 struct drm_connector_state *state,
1130 struct drm_property *property,
1134 * @atomic_get_property:
1136 * Reads out the decoded driver-private property. This is used to
1137 * implement the GETCONNECTOR IOCTL.
1139 * Do not call this function directly, use
1140 * drm_atomic_connector_get_property() instead.
1142 * This callback is optional if the driver does not support any
1143 * driver-private atomic properties.
1147 * 0 on success, -EINVAL if the property isn't implemented by the
1148 * driver (which shouldn't ever happen, the core only asks for
1149 * properties attached to this connector).
1151 int (*atomic_get_property)(struct drm_connector *connector,
1152 const struct drm_connector_state *state,
1153 struct drm_property *property,
1157 * @atomic_print_state:
1159 * If driver subclasses &struct drm_connector_state, it should implement
1160 * this optional hook for printing additional driver specific state.
1162 * Do not call this directly, use drm_atomic_connector_print_state()
1165 void (*atomic_print_state)(struct drm_printer *p,
1166 const struct drm_connector_state *state);
1169 * @oob_hotplug_event:
1171 * This will get called when a hotplug-event for a drm-connector
1172 * has been received from a source outside the display driver / device.
1174 void (*oob_hotplug_event)(struct drm_connector *connector);
1179 * Allows connectors to create connector-specific debugfs files.
1181 void (*debugfs_init)(struct drm_connector *connector, struct dentry *root);
1185 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1187 * Each connector can have an initial mode with additional options
1188 * passed through the kernel command line. This structure allows to
1189 * express those parameters and will be filled by the command-line
1192 struct drm_cmdline_mode {
1198 char name[DRM_DISPLAY_MODE_LEN];
1203 * Has a mode been read from the command-line?
1208 * @refresh_specified:
1210 * Did the mode have a preferred refresh rate?
1212 bool refresh_specified;
1217 * Did the mode have a preferred BPP?
1224 * Pixel Clock in kHz. Optional.
1226 unsigned int pixel_clock;
1231 * Active resolution on the X axis, in pixels.
1238 * Active resolution on the Y axis, in pixels.
1245 * Bits per pixels for the mode.
1252 * Refresh rate, in Hertz.
1259 * Do we need to use reduced blanking?
1266 * The mode is interlaced.
1273 * The timings will be calculated using the VESA Coordinated
1274 * Video Timings instead of looking up the mode from a table.
1281 * Add margins to the mode calculation (1.8% of xres rounded
1282 * down to 8 pixels and 1.8% of yres).
1289 * Ignore the hotplug state of the connector, and force its
1290 * state to one of the DRM_FORCE_* values.
1292 enum drm_connector_force force;
1295 * @rotation_reflection:
1297 * Initial rotation and reflection of the mode setup from the
1298 * command line. See DRM_MODE_ROTATE_* and
1299 * DRM_MODE_REFLECT_*. The only rotations supported are
1300 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1302 unsigned int rotation_reflection;
1305 * @panel_orientation:
1307 * drm-connector "panel orientation" property override value,
1308 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1310 enum drm_panel_orientation panel_orientation;
1313 * @tv_margins: TV margins to apply to the mode.
1315 struct drm_connector_tv_margins tv_margins;
1319 * struct drm_connector - central DRM connector control structure
1321 * Each connector may be connected to one or more CRTCs, or may be clonable by
1322 * another connector if they can share a CRTC. Each connector also has a specific
1323 * position in the broader display (referred to as a 'screen' though it could
1324 * span multiple monitors).
1326 struct drm_connector {
1327 /** @dev: parent DRM device */
1328 struct drm_device *dev;
1329 /** @kdev: kernel device for sysfs attributes */
1330 struct device *kdev;
1331 /** @attr: sysfs attributes */
1332 struct device_attribute *attr;
1334 * @fwnode: associated fwnode supplied by platform firmware
1336 * Drivers can set this to associate a fwnode with a connector, drivers
1337 * are expected to get a reference on the fwnode when setting this.
1338 * drm_connector_cleanup() will call fwnode_handle_put() on this.
1340 struct fwnode_handle *fwnode;
1345 * List of all connectors on a @dev, linked from
1346 * &drm_mode_config.connector_list. Protected by
1347 * &drm_mode_config.connector_list_lock, but please only use
1348 * &drm_connector_list_iter to walk this list.
1350 struct list_head head;
1353 * @global_connector_list_entry:
1355 * Connector entry in the global connector-list, used by
1356 * drm_connector_find_by_fwnode().
1358 struct list_head global_connector_list_entry;
1360 /** @base: base KMS object */
1361 struct drm_mode_object base;
1363 /** @name: human readable name, can be overwritten by the driver */
1367 * @mutex: Lock for general connector state, but currently only protects
1368 * @registered. Most of the connector state is still protected by
1369 * &drm_mode_config.mutex.
1374 * @index: Compacted connector index, which matches the position inside
1375 * the mode_config.list for drivers not supporting hot-add/removing. Can
1376 * be used as an array index. It is invariant over the lifetime of the
1383 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1386 /** @connector_type_id: index into connector type enum */
1387 int connector_type_id;
1389 * @interlace_allowed:
1390 * Can this connector handle interlaced modes? Only used by
1391 * drm_helper_probe_single_connector_modes() for mode filtering.
1393 bool interlace_allowed;
1395 * @doublescan_allowed:
1396 * Can this connector handle doublescan? Only used by
1397 * drm_helper_probe_single_connector_modes() for mode filtering.
1399 bool doublescan_allowed;
1402 * Can this connector handle stereo modes? Only used by
1403 * drm_helper_probe_single_connector_modes() for mode filtering.
1405 bool stereo_allowed;
1408 * @ycbcr_420_allowed : This bool indicates if this connector is
1409 * capable of handling YCBCR 420 output. While parsing the EDID
1410 * blocks it's very helpful to know if the source is capable of
1411 * handling YCBCR 420 outputs.
1413 bool ycbcr_420_allowed;
1416 * @registration_state: Is this connector initializing, exposed
1417 * (registered) with userspace, or unregistered?
1419 * Protected by @mutex.
1421 enum drm_connector_registration_state registration_state;
1425 * Modes available on this connector (from fill_modes() + user).
1426 * Protected by &drm_mode_config.mutex.
1428 struct list_head modes;
1432 * One of the drm_connector_status enums (connected, not, or unknown).
1433 * Protected by &drm_mode_config.mutex.
1435 enum drm_connector_status status;
1439 * These are modes added by probing with DDC or the BIOS, before
1440 * filtering is applied. Used by the probe helpers. Protected by
1441 * &drm_mode_config.mutex.
1443 struct list_head probed_modes;
1446 * @display_info: Display information is filled from EDID information
1447 * when a display is detected. For non hot-pluggable displays such as
1448 * flat panels in embedded systems, the driver should initialize the
1449 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1450 * with the physical size of the display.
1452 * Protected by &drm_mode_config.mutex.
1454 struct drm_display_info display_info;
1456 /** @funcs: connector control functions */
1457 const struct drm_connector_funcs *funcs;
1460 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1461 * &drm_mode_config.mutex. This should be updated only by calling
1462 * drm_connector_update_edid_property().
1464 struct drm_property_blob *edid_blob_ptr;
1466 /** @properties: property tracking for this connector */
1467 struct drm_object_properties properties;
1470 * @scaling_mode_property: Optional atomic property to control the
1471 * upscaling. See drm_connector_attach_content_protection_property().
1473 struct drm_property *scaling_mode_property;
1476 * @vrr_capable_property: Optional property to help userspace
1477 * query hardware support for variable refresh rate on a connector.
1478 * connector. Drivers can add the property to a connector by
1479 * calling drm_connector_attach_vrr_capable_property().
1481 * This should be updated only by calling
1482 * drm_connector_set_vrr_capable_property().
1484 struct drm_property *vrr_capable_property;
1487 * @colorspace_property: Connector property to set the suitable
1488 * colorspace supported by the sink.
1490 struct drm_property *colorspace_property;
1495 * DRM blob property data for the DP MST path property. This should only
1496 * be updated by calling drm_connector_set_path_property().
1498 struct drm_property_blob *path_blob_ptr;
1501 * @max_bpc_property: Default connector property for the max bpc to be
1502 * driven out of the connector.
1504 struct drm_property *max_bpc_property;
1506 /** @privacy_screen: drm_privacy_screen for this connector, or NULL. */
1507 struct drm_privacy_screen *privacy_screen;
1509 /** @privacy_screen_notifier: privacy-screen notifier_block */
1510 struct notifier_block privacy_screen_notifier;
1513 * @privacy_screen_sw_state_property: Optional atomic property for the
1514 * connector to control the integrated privacy screen.
1516 struct drm_property *privacy_screen_sw_state_property;
1519 * @privacy_screen_hw_state_property: Optional atomic property for the
1520 * connector to report the actual integrated privacy screen state.
1522 struct drm_property *privacy_screen_hw_state_property;
1524 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1525 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1526 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1531 * Connector polling mode, a combination of
1533 * DRM_CONNECTOR_POLL_HPD
1534 * The connector generates hotplug events and doesn't need to be
1535 * periodically polled. The CONNECT and DISCONNECT flags must not
1536 * be set together with the HPD flag.
1538 * DRM_CONNECTOR_POLL_CONNECT
1539 * Periodically poll the connector for connection.
1541 * DRM_CONNECTOR_POLL_DISCONNECT
1542 * Periodically poll the connector for disconnection, without
1543 * causing flickering even when the connector is in use. DACs should
1544 * rarely do this without a lot of testing.
1546 * Set to 0 for connectors that don't support connection status
1552 * @dpms: Current dpms state. For legacy drivers the
1553 * &drm_connector_funcs.dpms callback must update this. For atomic
1554 * drivers, this is handled by the core atomic code, and drivers must
1555 * only take &drm_crtc_state.active into account.
1559 /** @helper_private: mid-layer private data */
1560 const struct drm_connector_helper_funcs *helper_private;
1562 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1563 struct drm_cmdline_mode cmdline_mode;
1564 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1565 enum drm_connector_force force;
1568 * @edid_override: Override EDID set via debugfs.
1570 * Do not modify or access outside of the drm_edid_override_* family of
1573 const struct drm_edid *edid_override;
1576 * @edid_override_mutex: Protect access to edid_override.
1578 struct mutex edid_override_mutex;
1580 /** @epoch_counter: used to detect any other changes in connector, besides status */
1584 * @possible_encoders: Bit mask of encoders that can drive this
1585 * connector, drm_encoder_index() determines the index into the bitfield
1586 * and the bits are set with drm_connector_attach_encoder().
1588 u32 possible_encoders;
1591 * @encoder: Currently bound encoder driving this connector, if any.
1592 * Only really meaningful for non-atomic drivers. Atomic drivers should
1593 * instead look at &drm_connector_state.best_encoder, and in case they
1594 * need the CRTC driving this output, &drm_connector_state.crtc.
1596 struct drm_encoder *encoder;
1598 #define MAX_ELD_BYTES 128
1599 /** @eld: EDID-like data, if present */
1600 uint8_t eld[MAX_ELD_BYTES];
1601 /** @latency_present: AV delay info from ELD, if found */
1602 bool latency_present[2];
1604 * @video_latency: Video latency info from ELD, if found.
1605 * [0]: progressive, [1]: interlaced
1607 int video_latency[2];
1609 * @audio_latency: audio latency info from ELD, if found
1610 * [0]: progressive, [1]: interlaced
1612 int audio_latency[2];
1615 * @ddc: associated ddc adapter.
1616 * A connector usually has its associated ddc adapter. If a driver uses
1617 * this field, then an appropriate symbolic link is created in connector
1618 * sysfs directory to make it easy for the user to tell which i2c
1619 * adapter is for a particular display.
1621 * The field should be set by calling drm_connector_init_with_ddc().
1623 struct i2c_adapter *ddc;
1626 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1627 * Needed to workaround some HW bugs where we get all 0s
1629 int null_edid_counter;
1631 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1632 unsigned bad_edid_counter;
1635 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1636 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1641 * @real_edid_checksum: real edid checksum for corrupted edid block.
1642 * Required in Displayport 1.4 compliance testing
1645 u8 real_edid_checksum;
1647 /** @debugfs_entry: debugfs directory for this connector */
1648 struct dentry *debugfs_entry;
1653 * Current atomic state for this connector.
1655 * This is protected by &drm_mode_config.connection_mutex. Note that
1656 * nonblocking atomic commits access the current connector state without
1657 * taking locks. Either by going through the &struct drm_atomic_state
1658 * pointers, see for_each_oldnew_connector_in_state(),
1659 * for_each_old_connector_in_state() and
1660 * for_each_new_connector_in_state(). Or through careful ordering of
1661 * atomic commit operations as implemented in the atomic helpers, see
1662 * &struct drm_crtc_commit.
1664 struct drm_connector_state *state;
1666 /* DisplayID bits. FIXME: Extract into a substruct? */
1671 * DRM blob property data for the tile property (used mostly by DP MST).
1672 * This is meant for screens which are driven through separate display
1673 * pipelines represented by &drm_crtc, which might not be running with
1674 * genlocked clocks. For tiled panels which are genlocked, like
1675 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1676 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1678 * This should only be updated by calling
1679 * drm_connector_set_tile_property().
1681 struct drm_property_blob *tile_blob_ptr;
1683 /** @has_tile: is this connector connected to a tiled monitor */
1685 /** @tile_group: tile group for the connected monitor */
1686 struct drm_tile_group *tile_group;
1687 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1688 bool tile_is_single_monitor;
1690 /** @num_h_tile: number of horizontal tiles in the tile group */
1691 /** @num_v_tile: number of vertical tiles in the tile group */
1692 uint8_t num_h_tile, num_v_tile;
1693 /** @tile_h_loc: horizontal location of this tile */
1694 /** @tile_v_loc: vertical location of this tile */
1695 uint8_t tile_h_loc, tile_v_loc;
1696 /** @tile_h_size: horizontal size of this tile. */
1697 /** @tile_v_size: vertical size of this tile. */
1698 uint16_t tile_h_size, tile_v_size;
1703 * List used only by &drm_connector_list_iter to be able to clean up a
1704 * connector from any context, in conjunction with
1705 * &drm_mode_config.connector_free_work.
1707 struct llist_node free_node;
1709 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1710 struct hdr_sink_metadata hdr_sink_metadata;
1713 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1715 int drm_connector_init(struct drm_device *dev,
1716 struct drm_connector *connector,
1717 const struct drm_connector_funcs *funcs,
1718 int connector_type);
1719 int drm_connector_init_with_ddc(struct drm_device *dev,
1720 struct drm_connector *connector,
1721 const struct drm_connector_funcs *funcs,
1723 struct i2c_adapter *ddc);
1724 int drmm_connector_init(struct drm_device *dev,
1725 struct drm_connector *connector,
1726 const struct drm_connector_funcs *funcs,
1728 struct i2c_adapter *ddc);
1729 void drm_connector_attach_edid_property(struct drm_connector *connector);
1730 int drm_connector_register(struct drm_connector *connector);
1731 void drm_connector_unregister(struct drm_connector *connector);
1732 int drm_connector_attach_encoder(struct drm_connector *connector,
1733 struct drm_encoder *encoder);
1735 void drm_connector_cleanup(struct drm_connector *connector);
1737 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1739 return connector->index;
1742 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1744 return 1 << connector->index;
1748 * drm_connector_lookup - lookup connector object
1750 * @file_priv: drm file to check for lease against.
1751 * @id: connector object id
1753 * This function looks up the connector object specified by id
1754 * add takes a reference to it.
1756 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1757 struct drm_file *file_priv,
1760 struct drm_mode_object *mo;
1761 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1762 return mo ? obj_to_connector(mo) : NULL;
1766 * drm_connector_get - acquire a connector reference
1767 * @connector: DRM connector
1769 * This function increments the connector's refcount.
1771 static inline void drm_connector_get(struct drm_connector *connector)
1773 drm_mode_object_get(&connector->base);
1777 * drm_connector_put - release a connector reference
1778 * @connector: DRM connector
1780 * This function decrements the connector's reference count and frees the
1781 * object if the reference count drops to zero.
1783 static inline void drm_connector_put(struct drm_connector *connector)
1785 drm_mode_object_put(&connector->base);
1789 * drm_connector_is_unregistered - has the connector been unregistered from
1791 * @connector: DRM connector
1793 * Checks whether or not @connector has been unregistered from userspace.
1796 * True if the connector was unregistered, false if the connector is
1797 * registered or has not yet been registered with userspace.
1800 drm_connector_is_unregistered(struct drm_connector *connector)
1802 return READ_ONCE(connector->registration_state) ==
1803 DRM_CONNECTOR_UNREGISTERED;
1806 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode);
1807 const char *drm_get_connector_type_name(unsigned int connector_type);
1808 const char *drm_get_connector_status_name(enum drm_connector_status status);
1809 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1810 const char *drm_get_dpms_name(int val);
1811 const char *drm_get_dvi_i_subconnector_name(int val);
1812 const char *drm_get_dvi_i_select_name(int val);
1813 const char *drm_get_tv_subconnector_name(int val);
1814 const char *drm_get_tv_select_name(int val);
1815 const char *drm_get_dp_subconnector_name(int val);
1816 const char *drm_get_content_protection_name(int val);
1817 const char *drm_get_hdcp_content_type_name(int val);
1819 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1820 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
1822 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1823 int drm_mode_create_tv_properties(struct drm_device *dev,
1824 unsigned int num_modes,
1825 const char * const modes[]);
1826 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1827 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1828 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1829 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1830 u32 scaling_mode_mask);
1831 int drm_connector_attach_vrr_capable_property(
1832 struct drm_connector *connector);
1833 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
1834 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
1835 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
1836 struct drm_connector_state *new_state);
1837 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1838 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector);
1839 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector);
1840 int drm_mode_create_content_type_property(struct drm_device *dev);
1841 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1843 int drm_connector_set_path_property(struct drm_connector *connector,
1845 int drm_connector_set_tile_property(struct drm_connector *connector);
1846 int drm_connector_update_edid_property(struct drm_connector *connector,
1847 const struct edid *edid);
1848 void drm_connector_set_link_status_property(struct drm_connector *connector,
1849 uint64_t link_status);
1850 void drm_connector_set_vrr_capable_property(
1851 struct drm_connector *connector, bool capable);
1852 int drm_connector_set_panel_orientation(
1853 struct drm_connector *connector,
1854 enum drm_panel_orientation panel_orientation);
1855 int drm_connector_set_panel_orientation_with_quirk(
1856 struct drm_connector *connector,
1857 enum drm_panel_orientation panel_orientation,
1858 int width, int height);
1859 int drm_connector_set_orientation_from_panel(
1860 struct drm_connector *connector,
1861 struct drm_panel *panel);
1862 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1864 void drm_connector_create_privacy_screen_properties(struct drm_connector *conn);
1865 void drm_connector_attach_privacy_screen_properties(struct drm_connector *conn);
1866 void drm_connector_attach_privacy_screen_provider(
1867 struct drm_connector *connector, struct drm_privacy_screen *priv);
1868 void drm_connector_update_privacy_screen(const struct drm_connector_state *connector_state);
1871 * struct drm_tile_group - Tile group metadata
1872 * @refcount: reference count
1874 * @id: tile group id exposed to userspace
1875 * @group_data: Sink-private data identifying this group
1877 * @group_data corresponds to displayid vend/prod/serial for external screens
1880 struct drm_tile_group {
1881 struct kref refcount;
1882 struct drm_device *dev;
1887 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1888 const char topology[8]);
1889 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1890 const char topology[8]);
1891 void drm_mode_put_tile_group(struct drm_device *dev,
1892 struct drm_tile_group *tg);
1895 * struct drm_connector_list_iter - connector_list iterator
1897 * This iterator tracks state needed to be able to walk the connector_list
1898 * within struct drm_mode_config. Only use together with
1899 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1900 * drm_connector_list_iter_next() respectively the convenience macro
1901 * drm_for_each_connector_iter().
1903 * Note that the return value of drm_connector_list_iter_next() is only valid
1904 * up to the next drm_connector_list_iter_next() or
1905 * drm_connector_list_iter_end() call. If you want to use the connector later,
1906 * then you need to grab your own reference first using drm_connector_get().
1908 struct drm_connector_list_iter {
1910 struct drm_device *dev;
1911 struct drm_connector *conn;
1914 void drm_connector_list_iter_begin(struct drm_device *dev,
1915 struct drm_connector_list_iter *iter);
1916 struct drm_connector *
1917 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1918 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1920 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1921 struct drm_encoder *encoder);
1924 * drm_for_each_connector_iter - connector_list iterator macro
1925 * @connector: &struct drm_connector pointer used as cursor
1926 * @iter: &struct drm_connector_list_iter
1928 * Note that @connector is only valid within the list body, if you want to use
1929 * @connector after calling drm_connector_list_iter_end() then you need to grab
1930 * your own reference first using drm_connector_get().
1932 #define drm_for_each_connector_iter(connector, iter) \
1933 while ((connector = drm_connector_list_iter_next(iter)))
1936 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1937 * @connector: &struct drm_connector pointer
1938 * @encoder: &struct drm_encoder pointer used as cursor
1940 #define drm_connector_for_each_possible_encoder(connector, encoder) \
1941 drm_for_each_encoder_mask(encoder, (connector)->dev, \
1942 (connector)->possible_encoders)