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 <drm/drm_mode_object.h>
31 #include <drm/drm_util.h>
33 #include <uapi/drm/drm_mode.h>
35 struct drm_connector_helper_funcs;
36 struct drm_modeset_acquire_ctx;
41 struct drm_property_blob;
46 enum drm_connector_force {
47 DRM_FORCE_UNSPECIFIED,
49 DRM_FORCE_ON, /* force on analog part normally */
50 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
54 * enum drm_connector_status - status for a &drm_connector
56 * This enum is used to track the connector status. There are no separate
57 * #defines for the uapi!
59 enum drm_connector_status {
61 * @connector_status_connected: The connector is definitely connected to
62 * a sink device, and can be enabled.
64 connector_status_connected = 1,
66 * @connector_status_disconnected: The connector isn't connected to a
67 * sink device which can be autodetect. For digital outputs like DP or
68 * HDMI (which can be realiable probed) this means there's really
69 * nothing there. It is driver-dependent whether a connector with this
70 * status can be lit up or not.
72 connector_status_disconnected = 2,
74 * @connector_status_unknown: The connector's status could not be
75 * reliably detected. This happens when probing would either cause
76 * flicker (like load-detection when the connector is in use), or when a
77 * hardware resource isn't available (like when load-detection needs a
78 * free CRTC). It should be possible to light up the connector with one
79 * of the listed fallback modes. For default configuration userspace
80 * should only try to light up connectors with unknown status when
81 * there's not connector with @connector_status_connected.
83 connector_status_unknown = 3,
87 * enum drm_connector_registration_state - userspace registration status for
90 * This enum is used to track the status of initializing a connector and
91 * registering it with userspace, so that DRM can prevent bogus modesets on
92 * connectors that no longer exist.
94 enum drm_connector_registration_state {
96 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
97 * but has yet to be exposed to userspace. There should be no
98 * additional restrictions to how the state of this connector may be
101 DRM_CONNECTOR_INITIALIZING = 0,
104 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
105 * and registered with sysfs, as such it has been exposed to
106 * userspace. There should be no additional restrictions to how the
107 * state of this connector may be modified.
109 DRM_CONNECTOR_REGISTERED = 1,
112 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
113 * to userspace and has since been unregistered and removed from
114 * userspace, or the connector was unregistered before it had a chance
115 * to be exposed to userspace (e.g. still in the
116 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
117 * unregistered, there are additional restrictions to how its state
120 * - An unregistered connector may only have its DPMS changed from
121 * On->Off. Once DPMS is changed to Off, it may not be switched back
123 * - Modesets are not allowed on unregistered connectors, unless they
124 * would result in disabling its assigned CRTCs. This means
125 * disabling a CRTC on an unregistered connector is OK, but enabling
127 * - Removing a CRTC from an unregistered connector is OK, but new
128 * CRTCs may never be assigned to an unregistered connector.
130 DRM_CONNECTOR_UNREGISTERED = 2,
133 enum subpixel_order {
135 SubPixelHorizontalRGB,
136 SubPixelHorizontalBGR,
144 * struct drm_scrambling: sink's scrambling support.
146 struct drm_scrambling {
148 * @supported: scrambling supported for rates > 340 Mhz.
152 * @low_rates: scrambling supported for rates <= 340 Mhz.
158 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
160 * Provides SCDC register support and capabilities related information on a
161 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
165 * @supported: status control & data channel present.
169 * @read_request: sink is capable of generating scdc read request.
173 * @scrambling: sink's scrambling capabilities
175 struct drm_scrambling scrambling;
179 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink
181 * Describes the DSC support provided by HDMI 2.1 sink.
182 * The information is fetched fom additional HFVSDB blocks defined
185 struct drm_hdmi_dsc_cap {
186 /** @v_1p2: flag for dsc1.2 version support by sink */
189 /** @native_420: Does sink support DSC with 4:2:0 compression */
193 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2
199 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc
203 /** @max_slices: maximum number of Horizontal slices supported by */
206 /** @clk_per_slice : max pixel clock in MHz supported per slice */
209 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */
212 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */
213 u8 max_frl_rate_per_lane;
215 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/
216 u8 total_chunk_kbytes;
220 * struct drm_hdmi_info - runtime information about the connected HDMI sink
222 * Describes if a given display supports advanced HDMI 2.0 features.
223 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
225 struct drm_hdmi_info {
226 /** @scdc: sink's scdc support and capabilities */
227 struct drm_scdc scdc;
230 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
231 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
232 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
235 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
238 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
239 * output also, along with normal HDMI outputs. The max VIC defined by
240 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
243 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
245 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
248 /** @y420_dc_modes: bitmap of deep color support index */
251 /** @max_frl_rate_per_lane: support fixed rate link */
252 u8 max_frl_rate_per_lane;
254 /** @max_lanes: supported by sink */
257 /** @dsc_cap: DSC capabilities of the sink */
258 struct drm_hdmi_dsc_cap dsc_cap;
262 * enum drm_link_status - connector's link_status property value
264 * This enum is used as the connector's link status property value.
265 * It is set to the values defined in uapi.
267 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
269 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
272 enum drm_link_status {
273 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
274 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
278 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
280 * This enum is used to track the (LCD) panel orientation. There are no
281 * separate #defines for the uapi!
283 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
284 * panel orientation information (normal
285 * for non panels) in this case the "panel
286 * orientation" connector prop will not be
288 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
289 * top side of the device's casing.
290 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
291 * bottom side of the device's casing, iow
292 * the panel is mounted upside-down.
293 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
294 * top side of the device's casing.
295 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
296 * top side of the device's casing.
298 enum drm_panel_orientation {
299 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
300 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
301 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
302 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
303 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
307 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
310 * This struct is used to store a frequency range supported by panel
311 * as parsed from EDID's detailed monitor range descriptor block.
313 * @min_vfreq: This is the min supported refresh rate in Hz from
314 * EDID's detailed monitor range.
315 * @max_vfreq: This is the max supported refresh rate in Hz from
316 * EDID's detailed monitor range
318 struct drm_monitor_range_info {
324 * This is a consolidated colorimetry list supported by HDMI and
325 * DP protocol standard. The respective connectors will register
326 * a property with the subset of this list (supported by that
327 * respective protocol). Userspace will set the colorspace through
328 * a colorspace property which will be created and exposed to
332 /* For Default case, driver will set the colorspace */
333 #define DRM_MODE_COLORIMETRY_DEFAULT 0
334 /* CEA 861 Normal Colorimetry options */
335 #define DRM_MODE_COLORIMETRY_NO_DATA 0
336 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC 1
337 #define DRM_MODE_COLORIMETRY_BT709_YCC 2
338 /* CEA 861 Extended Colorimetry Options */
339 #define DRM_MODE_COLORIMETRY_XVYCC_601 3
340 #define DRM_MODE_COLORIMETRY_XVYCC_709 4
341 #define DRM_MODE_COLORIMETRY_SYCC_601 5
342 #define DRM_MODE_COLORIMETRY_OPYCC_601 6
343 #define DRM_MODE_COLORIMETRY_OPRGB 7
344 #define DRM_MODE_COLORIMETRY_BT2020_CYCC 8
345 #define DRM_MODE_COLORIMETRY_BT2020_RGB 9
346 #define DRM_MODE_COLORIMETRY_BT2020_YCC 10
347 /* Additional Colorimetry extension added as part of CTA 861.G */
348 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 11
349 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER 12
350 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
351 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED 13
352 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT 14
353 #define DRM_MODE_COLORIMETRY_BT601_YCC 15
356 * enum drm_bus_flags - bus_flags info for &drm_display_info
358 * This enum defines signal polarities and clock edge information for signals on
359 * a bus as bitmask flags.
361 * The clock edge information is conveyed by two sets of symbols,
362 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
363 * used to describe a bus from the point of view of the transmitter, the
364 * \*_DRIVE_\* flags should be used. When used from the point of view of the
365 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
366 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
367 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
368 * respectively. This simplifies code as signals are usually sampled on the
369 * opposite edge of the driving edge. Transmitters and receivers may however
370 * need to take other signal timings into account to convert between driving
375 * @DRM_BUS_FLAG_DE_LOW:
377 * The Data Enable signal is active low
379 DRM_BUS_FLAG_DE_LOW = BIT(0),
382 * @DRM_BUS_FLAG_DE_HIGH:
384 * The Data Enable signal is active high
386 DRM_BUS_FLAG_DE_HIGH = BIT(1),
389 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
391 * Data is driven on the rising edge of the pixel clock
393 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
396 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
398 * Data is driven on the falling edge of the pixel clock
400 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
403 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
405 * Data is sampled on the rising edge of the pixel clock
407 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
410 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
412 * Data is sampled on the falling edge of the pixel clock
414 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
417 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
419 * Data is transmitted MSB to LSB on the bus
421 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
424 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
426 * Data is transmitted LSB to MSB on the bus
428 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
431 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
433 * Sync signals are driven on the rising edge of the pixel clock
435 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
438 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
440 * Sync signals are driven on the falling edge of the pixel clock
442 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
445 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
447 * Sync signals are sampled on the rising edge of the pixel clock
449 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
452 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
454 * Sync signals are sampled on the falling edge of the pixel clock
456 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
459 * @DRM_BUS_FLAG_SHARP_SIGNALS:
461 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
463 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
467 * struct drm_display_info - runtime data about the connected sink
469 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
470 * fixed display sinks like built-in panels there's not much difference between
471 * this and &struct drm_connector. But for sinks with a real cable this
472 * structure is meant to describe all the things at the other end of the cable.
474 * For sinks which provide an EDID this can be filled out by calling
475 * drm_add_edid_modes().
477 struct drm_display_info {
479 * @width_mm: Physical width in mm.
481 unsigned int width_mm;
484 * @height_mm: Physical height in mm.
486 unsigned int height_mm;
489 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
494 * @subpixel_order: Subpixel order of LCD panels.
496 enum subpixel_order subpixel_order;
498 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
499 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
500 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
501 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3)
504 * @panel_orientation: Read only connector property for built-in panels,
505 * indicating the orientation of the panel vs the device's casing.
506 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
507 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
508 * fb to compensate and gets exported as prop to userspace.
510 int panel_orientation;
513 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
514 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
515 * as used to describe the pixel format in framebuffers, and also don't
516 * match the formats in @bus_formats which are shared with v4l.
521 * @bus_formats: Pixel data format on the wire, somewhat redundant with
522 * @color_formats. Array of size @num_bus_formats encoded using
523 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
525 const u32 *bus_formats;
527 * @num_bus_formats: Size of @bus_formats array.
529 unsigned int num_bus_formats;
532 * @bus_flags: Additional information (like pixel signal polarity) for
533 * the pixel data on the bus, using &enum drm_bus_flags values
539 * @max_tmds_clock: Maximum TMDS clock rate supported by the
540 * sink in kHz. 0 means undefined.
545 * @dvi_dual: Dual-link DVI sink?
550 * @is_hdmi: True if the sink is an HDMI device.
552 * This field shall be used instead of calling
553 * drm_detect_hdmi_monitor() when possible.
558 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
560 bool has_hdmi_infoframe;
563 * @rgb_quant_range_selectable: Does the sink support selecting
564 * the RGB quantization range?
566 bool rgb_quant_range_selectable;
569 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
570 * more stuff redundant with @bus_formats.
572 u8 edid_hdmi_dc_modes;
575 * @cea_rev: CEA revision of the HDMI sink.
580 * @hdmi: advance features of a HDMI sink.
582 struct drm_hdmi_info hdmi;
585 * @non_desktop: Non desktop display (HMD).
590 * @monitor_range: Frequency range supported by monitor range descriptor
592 struct drm_monitor_range_info monitor_range;
595 * @mso_stream_count: eDP Multi-SST Operation (MSO) stream count from
596 * the DisplayID VESA vendor block. 0 for conventional Single-Stream
597 * Transport (SST), or 2 or 4 MSO streams.
602 * @mso_pixel_overlap: eDP MSO segment pixel overlap, 0-8 pixels.
604 u8 mso_pixel_overlap;
607 int drm_display_info_set_bus_formats(struct drm_display_info *info,
609 unsigned int num_formats);
612 * struct drm_connector_tv_margins - TV connector related margins
614 * Describes the margins in pixels to put around the image on TV
615 * connectors to deal with overscan.
617 struct drm_connector_tv_margins {
619 * @bottom: Bottom margin in pixels.
624 * @left: Left margin in pixels.
629 * @right: Right margin in pixels.
634 * @top: Top margin in pixels.
640 * struct drm_tv_connector_state - TV connector related states
641 * @subconnector: selected subconnector
642 * @margins: TV margins
644 * @brightness: brightness in percent
645 * @contrast: contrast in percent
646 * @flicker_reduction: flicker reduction in percent
647 * @overscan: overscan in percent
648 * @saturation: saturation in percent
649 * @hue: hue in percent
651 struct drm_tv_connector_state {
652 enum drm_mode_subconnector subconnector;
653 struct drm_connector_tv_margins margins;
655 unsigned int brightness;
656 unsigned int contrast;
657 unsigned int flicker_reduction;
658 unsigned int overscan;
659 unsigned int saturation;
664 * struct drm_connector_state - mutable connector state
666 struct drm_connector_state {
667 /** @connector: backpointer to the connector */
668 struct drm_connector *connector;
671 * @crtc: CRTC to connect connector to, NULL if disabled.
673 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
676 struct drm_crtc *crtc;
681 * Used by the atomic helpers to select the encoder, through the
682 * &drm_connector_helper_funcs.atomic_best_encoder or
683 * &drm_connector_helper_funcs.best_encoder callbacks.
685 * This is also used in the atomic helpers to map encoders to their
686 * current and previous connectors, see
687 * drm_atomic_get_old_connector_for_encoder() and
688 * drm_atomic_get_new_connector_for_encoder().
690 * NOTE: Atomic drivers must fill this out (either themselves or through
691 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
692 * not return correct data to userspace.
694 struct drm_encoder *best_encoder;
697 * @link_status: Connector link_status to keep track of whether link is
698 * GOOD or BAD to notify userspace if retraining is necessary.
700 enum drm_link_status link_status;
702 /** @state: backpointer to global drm_atomic_state */
703 struct drm_atomic_state *state;
706 * @commit: Tracks the pending commit to prevent use-after-free conditions.
708 * Is only set when @crtc is NULL.
710 struct drm_crtc_commit *commit;
712 /** @tv: TV connector state */
713 struct drm_tv_connector_state tv;
716 * @self_refresh_aware:
718 * This tracks whether a connector is aware of the self refresh state.
719 * It should be set to true for those connector implementations which
720 * understand the self refresh state. This is needed since the crtc
721 * registers the self refresh helpers and it doesn't know if the
722 * connectors downstream have implemented self refresh entry/exit.
724 * Drivers should set this to true in atomic_check if they know how to
725 * handle self_refresh requests.
727 bool self_refresh_aware;
730 * @picture_aspect_ratio: Connector property to control the
731 * HDMI infoframe aspect ratio setting.
733 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
734 * values for &enum hdmi_picture_aspect
736 enum hdmi_picture_aspect picture_aspect_ratio;
739 * @content_type: Connector property to control the
740 * HDMI infoframe content type setting.
741 * The %DRM_MODE_CONTENT_TYPE_\* values much
744 unsigned int content_type;
747 * @hdcp_content_type: Connector property to pass the type of
748 * protected content. This is most commonly used for HDCP.
750 unsigned int hdcp_content_type;
753 * @scaling_mode: Connector property to control the
754 * upscaling, mostly used for built-in panels.
756 unsigned int scaling_mode;
759 * @content_protection: Connector property to request content
760 * protection. This is most commonly used for HDCP.
762 unsigned int content_protection;
765 * @colorspace: State variable for Connector property to request
766 * colorspace change on Sink. This is most commonly used to switch
767 * to wider color gamuts like BT2020.
772 * @writeback_job: Writeback job for writeback connectors
774 * Holds the framebuffer and out-fence for a writeback connector. As
775 * the writeback completion may be asynchronous to the normal commit
776 * cycle, the writeback job lifetime is managed separately from the
777 * normal atomic state by this object.
779 * See also: drm_writeback_queue_job() and
780 * drm_writeback_signal_completion()
782 struct drm_writeback_job *writeback_job;
785 * @max_requested_bpc: Connector property to limit the maximum bit
786 * depth of the pixels.
788 u8 max_requested_bpc;
791 * @max_bpc: Connector max_bpc based on the requested max_bpc property
792 * and the connector bpc limitations obtained from edid.
797 * @hdr_output_metadata:
798 * DRM blob property for HDR output metadata
800 struct drm_property_blob *hdr_output_metadata;
804 * struct drm_connector_funcs - control connectors on a given device
806 * Each CRTC may have one or more connectors attached to it. The functions
807 * below allow the core DRM code to control connectors, enumerate available modes,
810 struct drm_connector_funcs {
814 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
815 * is exposed as a standard property on the connector, but diverted to
816 * this callback in the drm core. Note that atomic drivers don't
817 * implement the 4 level DPMS support on the connector any more, but
818 * instead only have an on/off "ACTIVE" property on the CRTC object.
820 * This hook is not used by atomic drivers, remapping of the legacy DPMS
821 * property is entirely handled in the DRM core.
825 * 0 on success or a negative error code on failure.
827 int (*dpms)(struct drm_connector *connector, int mode);
832 * Reset connector hardware and software state to off. This function isn't
833 * called by the core directly, only through drm_mode_config_reset().
834 * It's not a helper hook only for historical reasons.
836 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
837 * atomic state using this hook.
839 void (*reset)(struct drm_connector *connector);
844 * Check to see if anything is attached to the connector. The parameter
845 * force is set to false whilst polling, true when checking the
846 * connector due to a user request. force can be used by the driver to
847 * avoid expensive, destructive operations during automated probing.
849 * This callback is optional, if not implemented the connector will be
850 * considered as always being attached.
854 * Note that this hook is only called by the probe helper. It's not in
855 * the helper library vtable purely for historical reasons. The only DRM
856 * core entry point to probe connector state is @fill_modes.
858 * Note that the helper library will already hold
859 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
860 * locks to avoid races with concurrent modeset changes need to use
861 * &drm_connector_helper_funcs.detect_ctx instead.
863 * Also note that this callback can be called no matter the
864 * state the connector is in. Drivers that need the underlying
865 * device to be powered to perform the detection will first need
866 * to make sure it's been properly enabled.
870 * drm_connector_status indicating the connector's status.
872 enum drm_connector_status (*detect)(struct drm_connector *connector,
878 * This function is called to update internal encoder state when the
879 * connector is forced to a certain state by userspace, either through
880 * the sysfs interfaces or on the kernel cmdline. In that case the
881 * @detect callback isn't called.
885 * Note that this hook is only called by the probe helper. It's not in
886 * the helper library vtable purely for historical reasons. The only DRM
887 * core entry point to probe connector state is @fill_modes.
889 void (*force)(struct drm_connector *connector);
894 * Entry point for output detection and basic mode validation. The
895 * driver should reprobe the output if needed (e.g. when hotplug
896 * handling is unreliable), add all detected modes to &drm_connector.modes
897 * and filter out any the device can't support in any configuration. It
898 * also needs to filter out any modes wider or higher than the
899 * parameters max_width and max_height indicate.
901 * The drivers must also prune any modes no longer valid from
902 * &drm_connector.modes. Furthermore it must update
903 * &drm_connector.status and &drm_connector.edid. If no EDID has been
904 * received for this output connector->edid must be NULL.
906 * Drivers using the probe helpers should use
907 * drm_helper_probe_single_connector_modes() to implement this
912 * The number of modes detected and filled into &drm_connector.modes.
914 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
919 * This is the legacy entry point to update a property attached to the
922 * This callback is optional if the driver does not support any legacy
923 * driver-private properties. For atomic drivers it is not used because
924 * property handling is done entirely in the DRM core.
928 * 0 on success or a negative error code on failure.
930 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
936 * This optional hook can be used to register additional userspace
937 * interfaces attached to the connector, light backlight control, i2c,
938 * DP aux or similar interfaces. It is called late in the driver load
939 * sequence from drm_connector_register() when registering all the
940 * core drm connector interfaces. Everything added from this callback
941 * should be unregistered in the early_unregister callback.
943 * This is called while holding &drm_connector.mutex.
947 * 0 on success, or a negative error code on failure.
949 int (*late_register)(struct drm_connector *connector);
954 * This optional hook should be used to unregister the additional
955 * userspace interfaces attached to the connector from
956 * late_register(). It is called from drm_connector_unregister(),
957 * early in the driver unload sequence to disable userspace access
958 * before data structures are torndown.
960 * This is called while holding &drm_connector.mutex.
962 void (*early_unregister)(struct drm_connector *connector);
967 * Clean up connector resources. This is called at driver unload time
968 * through drm_mode_config_cleanup(). It can also be called at runtime
969 * when a connector is being hot-unplugged for drivers that support
970 * connector hotplugging (e.g. DisplayPort MST).
972 void (*destroy)(struct drm_connector *connector);
975 * @atomic_duplicate_state:
977 * Duplicate the current atomic state for this connector and return it.
978 * The core and helpers guarantee that any atomic state duplicated with
979 * this hook and still owned by the caller (i.e. not transferred to the
980 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
981 * cleaned up by calling the @atomic_destroy_state hook in this
984 * This callback is mandatory for atomic drivers.
986 * Atomic drivers which don't subclass &struct drm_connector_state should use
987 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
988 * state structure to extend it with driver-private state should use
989 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
990 * duplicated in a consistent fashion across drivers.
992 * It is an error to call this hook before &drm_connector.state has been
993 * initialized correctly.
997 * If the duplicate state references refcounted resources this hook must
998 * acquire a reference for each of them. The driver must release these
999 * references again in @atomic_destroy_state.
1003 * Duplicated atomic state or NULL when the allocation failed.
1005 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1008 * @atomic_destroy_state:
1010 * Destroy a state duplicated with @atomic_duplicate_state and release
1011 * or unreference all resources it references
1013 * This callback is mandatory for atomic drivers.
1015 void (*atomic_destroy_state)(struct drm_connector *connector,
1016 struct drm_connector_state *state);
1019 * @atomic_set_property:
1021 * Decode a driver-private property value and store the decoded value
1022 * into the passed-in state structure. Since the atomic core decodes all
1023 * standardized properties (even for extensions beyond the core set of
1024 * properties which might not be implemented by all drivers) this
1025 * requires drivers to subclass the state structure.
1027 * Such driver-private properties should really only be implemented for
1028 * truly hardware/vendor specific state. Instead it is preferred to
1029 * standardize atomic extension and decode the properties used to expose
1030 * such an extension in the core.
1032 * Do not call this function directly, use
1033 * drm_atomic_connector_set_property() instead.
1035 * This callback is optional if the driver does not support any
1036 * driver-private atomic properties.
1040 * This function is called in the state assembly phase of atomic
1041 * modesets, which can be aborted for any reason (including on
1042 * userspace's request to just check whether a configuration would be
1043 * possible). Drivers MUST NOT touch any persistent state (hardware or
1044 * software) or data structures except the passed in @state parameter.
1046 * Also since userspace controls in which order properties are set this
1047 * function must not do any input validation (since the state update is
1048 * incomplete and hence likely inconsistent). Instead any such input
1049 * validation must be done in the various atomic_check callbacks.
1053 * 0 if the property has been found, -EINVAL if the property isn't
1054 * implemented by the driver (which shouldn't ever happen, the core only
1055 * asks for properties attached to this connector). No other validation
1056 * is allowed by the driver. The core already checks that the property
1057 * value is within the range (integer, valid enum value, ...) the driver
1058 * set when registering the property.
1060 int (*atomic_set_property)(struct drm_connector *connector,
1061 struct drm_connector_state *state,
1062 struct drm_property *property,
1066 * @atomic_get_property:
1068 * Reads out the decoded driver-private property. This is used to
1069 * implement the GETCONNECTOR IOCTL.
1071 * Do not call this function directly, use
1072 * drm_atomic_connector_get_property() instead.
1074 * This callback is optional if the driver does not support any
1075 * driver-private atomic properties.
1079 * 0 on success, -EINVAL if the property isn't implemented by the
1080 * driver (which shouldn't ever happen, the core only asks for
1081 * properties attached to this connector).
1083 int (*atomic_get_property)(struct drm_connector *connector,
1084 const struct drm_connector_state *state,
1085 struct drm_property *property,
1089 * @atomic_print_state:
1091 * If driver subclasses &struct drm_connector_state, it should implement
1092 * this optional hook for printing additional driver specific state.
1094 * Do not call this directly, use drm_atomic_connector_print_state()
1097 void (*atomic_print_state)(struct drm_printer *p,
1098 const struct drm_connector_state *state);
1101 * @oob_hotplug_event:
1103 * This will get called when a hotplug-event for a drm-connector
1104 * has been received from a source outside the display driver / device.
1106 void (*oob_hotplug_event)(struct drm_connector *connector);
1110 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1112 * Each connector can have an initial mode with additional options
1113 * passed through the kernel command line. This structure allows to
1114 * express those parameters and will be filled by the command-line
1117 struct drm_cmdline_mode {
1123 char name[DRM_DISPLAY_MODE_LEN];
1128 * Has a mode been read from the command-line?
1133 * @refresh_specified:
1135 * Did the mode have a preferred refresh rate?
1137 bool refresh_specified;
1142 * Did the mode have a preferred BPP?
1149 * Active resolution on the X axis, in pixels.
1156 * Active resolution on the Y axis, in pixels.
1163 * Bits per pixels for the mode.
1170 * Refresh rate, in Hertz.
1177 * Do we need to use reduced blanking?
1184 * The mode is interlaced.
1191 * The timings will be calculated using the VESA Coordinated
1192 * Video Timings instead of looking up the mode from a table.
1199 * Add margins to the mode calculation (1.8% of xres rounded
1200 * down to 8 pixels and 1.8% of yres).
1207 * Ignore the hotplug state of the connector, and force its
1208 * state to one of the DRM_FORCE_* values.
1210 enum drm_connector_force force;
1213 * @rotation_reflection:
1215 * Initial rotation and reflection of the mode setup from the
1216 * command line. See DRM_MODE_ROTATE_* and
1217 * DRM_MODE_REFLECT_*. The only rotations supported are
1218 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1220 unsigned int rotation_reflection;
1223 * @panel_orientation:
1225 * drm-connector "panel orientation" property override value,
1226 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1228 enum drm_panel_orientation panel_orientation;
1231 * @tv_margins: TV margins to apply to the mode.
1233 struct drm_connector_tv_margins tv_margins;
1237 * struct drm_connector - central DRM connector control structure
1239 * Each connector may be connected to one or more CRTCs, or may be clonable by
1240 * another connector if they can share a CRTC. Each connector also has a specific
1241 * position in the broader display (referred to as a 'screen' though it could
1242 * span multiple monitors).
1244 struct drm_connector {
1245 /** @dev: parent DRM device */
1246 struct drm_device *dev;
1247 /** @kdev: kernel device for sysfs attributes */
1248 struct device *kdev;
1249 /** @attr: sysfs attributes */
1250 struct device_attribute *attr;
1252 * @fwnode: associated fwnode supplied by platform firmware
1254 * Drivers can set this to associate a fwnode with a connector, drivers
1255 * are expected to get a reference on the fwnode when setting this.
1256 * drm_connector_cleanup() will call fwnode_handle_put() on this.
1258 struct fwnode_handle *fwnode;
1263 * List of all connectors on a @dev, linked from
1264 * &drm_mode_config.connector_list. Protected by
1265 * &drm_mode_config.connector_list_lock, but please only use
1266 * &drm_connector_list_iter to walk this list.
1268 struct list_head head;
1271 * @global_connector_list_entry:
1273 * Connector entry in the global connector-list, used by
1274 * drm_connector_find_by_fwnode().
1276 struct list_head global_connector_list_entry;
1278 /** @base: base KMS object */
1279 struct drm_mode_object base;
1281 /** @name: human readable name, can be overwritten by the driver */
1285 * @mutex: Lock for general connector state, but currently only protects
1286 * @registered. Most of the connector state is still protected by
1287 * &drm_mode_config.mutex.
1292 * @index: Compacted connector index, which matches the position inside
1293 * the mode_config.list for drivers not supporting hot-add/removing. Can
1294 * be used as an array index. It is invariant over the lifetime of the
1301 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1304 /** @connector_type_id: index into connector type enum */
1305 int connector_type_id;
1307 * @interlace_allowed:
1308 * Can this connector handle interlaced modes? Only used by
1309 * drm_helper_probe_single_connector_modes() for mode filtering.
1311 bool interlace_allowed;
1313 * @doublescan_allowed:
1314 * Can this connector handle doublescan? Only used by
1315 * drm_helper_probe_single_connector_modes() for mode filtering.
1317 bool doublescan_allowed;
1320 * Can this connector handle stereo modes? Only used by
1321 * drm_helper_probe_single_connector_modes() for mode filtering.
1323 bool stereo_allowed;
1326 * @ycbcr_420_allowed : This bool indicates if this connector is
1327 * capable of handling YCBCR 420 output. While parsing the EDID
1328 * blocks it's very helpful to know if the source is capable of
1329 * handling YCBCR 420 outputs.
1331 bool ycbcr_420_allowed;
1334 * @registration_state: Is this connector initializing, exposed
1335 * (registered) with userspace, or unregistered?
1337 * Protected by @mutex.
1339 enum drm_connector_registration_state registration_state;
1343 * Modes available on this connector (from fill_modes() + user).
1344 * Protected by &drm_mode_config.mutex.
1346 struct list_head modes;
1350 * One of the drm_connector_status enums (connected, not, or unknown).
1351 * Protected by &drm_mode_config.mutex.
1353 enum drm_connector_status status;
1357 * These are modes added by probing with DDC or the BIOS, before
1358 * filtering is applied. Used by the probe helpers. Protected by
1359 * &drm_mode_config.mutex.
1361 struct list_head probed_modes;
1364 * @display_info: Display information is filled from EDID information
1365 * when a display is detected. For non hot-pluggable displays such as
1366 * flat panels in embedded systems, the driver should initialize the
1367 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1368 * with the physical size of the display.
1370 * Protected by &drm_mode_config.mutex.
1372 struct drm_display_info display_info;
1374 /** @funcs: connector control functions */
1375 const struct drm_connector_funcs *funcs;
1378 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1379 * &drm_mode_config.mutex. This should be updated only by calling
1380 * drm_connector_update_edid_property().
1382 struct drm_property_blob *edid_blob_ptr;
1384 /** @properties: property tracking for this connector */
1385 struct drm_object_properties properties;
1388 * @scaling_mode_property: Optional atomic property to control the
1389 * upscaling. See drm_connector_attach_content_protection_property().
1391 struct drm_property *scaling_mode_property;
1394 * @vrr_capable_property: Optional property to help userspace
1395 * query hardware support for variable refresh rate on a connector.
1396 * connector. Drivers can add the property to a connector by
1397 * calling drm_connector_attach_vrr_capable_property().
1399 * This should be updated only by calling
1400 * drm_connector_set_vrr_capable_property().
1402 struct drm_property *vrr_capable_property;
1405 * @colorspace_property: Connector property to set the suitable
1406 * colorspace supported by the sink.
1408 struct drm_property *colorspace_property;
1413 * DRM blob property data for the DP MST path property. This should only
1414 * be updated by calling drm_connector_set_path_property().
1416 struct drm_property_blob *path_blob_ptr;
1419 * @max_bpc_property: Default connector property for the max bpc to be
1420 * driven out of the connector.
1422 struct drm_property *max_bpc_property;
1424 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1425 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1426 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1431 * Connector polling mode, a combination of
1433 * DRM_CONNECTOR_POLL_HPD
1434 * The connector generates hotplug events and doesn't need to be
1435 * periodically polled. The CONNECT and DISCONNECT flags must not
1436 * be set together with the HPD flag.
1438 * DRM_CONNECTOR_POLL_CONNECT
1439 * Periodically poll the connector for connection.
1441 * DRM_CONNECTOR_POLL_DISCONNECT
1442 * Periodically poll the connector for disconnection, without
1443 * causing flickering even when the connector is in use. DACs should
1444 * rarely do this without a lot of testing.
1446 * Set to 0 for connectors that don't support connection status
1452 * @dpms: Current dpms state. For legacy drivers the
1453 * &drm_connector_funcs.dpms callback must update this. For atomic
1454 * drivers, this is handled by the core atomic code, and drivers must
1455 * only take &drm_crtc_state.active into account.
1459 /** @helper_private: mid-layer private data */
1460 const struct drm_connector_helper_funcs *helper_private;
1462 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1463 struct drm_cmdline_mode cmdline_mode;
1464 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1465 enum drm_connector_force force;
1466 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1468 /** @epoch_counter: used to detect any other changes in connector, besides status */
1472 * @possible_encoders: Bit mask of encoders that can drive this
1473 * connector, drm_encoder_index() determines the index into the bitfield
1474 * and the bits are set with drm_connector_attach_encoder().
1476 u32 possible_encoders;
1479 * @encoder: Currently bound encoder driving this connector, if any.
1480 * Only really meaningful for non-atomic drivers. Atomic drivers should
1481 * instead look at &drm_connector_state.best_encoder, and in case they
1482 * need the CRTC driving this output, &drm_connector_state.crtc.
1484 struct drm_encoder *encoder;
1486 #define MAX_ELD_BYTES 128
1487 /** @eld: EDID-like data, if present */
1488 uint8_t eld[MAX_ELD_BYTES];
1489 /** @latency_present: AV delay info from ELD, if found */
1490 bool latency_present[2];
1492 * @video_latency: Video latency info from ELD, if found.
1493 * [0]: progressive, [1]: interlaced
1495 int video_latency[2];
1497 * @audio_latency: audio latency info from ELD, if found
1498 * [0]: progressive, [1]: interlaced
1500 int audio_latency[2];
1503 * @ddc: associated ddc adapter.
1504 * A connector usually has its associated ddc adapter. If a driver uses
1505 * this field, then an appropriate symbolic link is created in connector
1506 * sysfs directory to make it easy for the user to tell which i2c
1507 * adapter is for a particular display.
1509 * The field should be set by calling drm_connector_init_with_ddc().
1511 struct i2c_adapter *ddc;
1514 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1515 * Needed to workaround some HW bugs where we get all 0s
1517 int null_edid_counter;
1519 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1520 unsigned bad_edid_counter;
1523 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1524 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1529 * @real_edid_checksum: real edid checksum for corrupted edid block.
1530 * Required in Displayport 1.4 compliance testing
1533 u8 real_edid_checksum;
1535 /** @debugfs_entry: debugfs directory for this connector */
1536 struct dentry *debugfs_entry;
1541 * Current atomic state for this connector.
1543 * This is protected by &drm_mode_config.connection_mutex. Note that
1544 * nonblocking atomic commits access the current connector state without
1545 * taking locks. Either by going through the &struct drm_atomic_state
1546 * pointers, see for_each_oldnew_connector_in_state(),
1547 * for_each_old_connector_in_state() and
1548 * for_each_new_connector_in_state(). Or through careful ordering of
1549 * atomic commit operations as implemented in the atomic helpers, see
1550 * &struct drm_crtc_commit.
1552 struct drm_connector_state *state;
1554 /* DisplayID bits. FIXME: Extract into a substruct? */
1559 * DRM blob property data for the tile property (used mostly by DP MST).
1560 * This is meant for screens which are driven through separate display
1561 * pipelines represented by &drm_crtc, which might not be running with
1562 * genlocked clocks. For tiled panels which are genlocked, like
1563 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1564 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1566 * This should only be updated by calling
1567 * drm_connector_set_tile_property().
1569 struct drm_property_blob *tile_blob_ptr;
1571 /** @has_tile: is this connector connected to a tiled monitor */
1573 /** @tile_group: tile group for the connected monitor */
1574 struct drm_tile_group *tile_group;
1575 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1576 bool tile_is_single_monitor;
1578 /** @num_h_tile: number of horizontal tiles in the tile group */
1579 /** @num_v_tile: number of vertical tiles in the tile group */
1580 uint8_t num_h_tile, num_v_tile;
1581 /** @tile_h_loc: horizontal location of this tile */
1582 /** @tile_v_loc: vertical location of this tile */
1583 uint8_t tile_h_loc, tile_v_loc;
1584 /** @tile_h_size: horizontal size of this tile. */
1585 /** @tile_v_size: vertical size of this tile. */
1586 uint16_t tile_h_size, tile_v_size;
1591 * List used only by &drm_connector_list_iter to be able to clean up a
1592 * connector from any context, in conjunction with
1593 * &drm_mode_config.connector_free_work.
1595 struct llist_node free_node;
1597 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1598 struct hdr_sink_metadata hdr_sink_metadata;
1601 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1603 int drm_connector_init(struct drm_device *dev,
1604 struct drm_connector *connector,
1605 const struct drm_connector_funcs *funcs,
1606 int connector_type);
1607 int drm_connector_init_with_ddc(struct drm_device *dev,
1608 struct drm_connector *connector,
1609 const struct drm_connector_funcs *funcs,
1611 struct i2c_adapter *ddc);
1612 void drm_connector_attach_edid_property(struct drm_connector *connector);
1613 int drm_connector_register(struct drm_connector *connector);
1614 void drm_connector_unregister(struct drm_connector *connector);
1615 int drm_connector_attach_encoder(struct drm_connector *connector,
1616 struct drm_encoder *encoder);
1618 void drm_connector_cleanup(struct drm_connector *connector);
1620 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1622 return connector->index;
1625 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1627 return 1 << connector->index;
1631 * drm_connector_lookup - lookup connector object
1633 * @file_priv: drm file to check for lease against.
1634 * @id: connector object id
1636 * This function looks up the connector object specified by id
1637 * add takes a reference to it.
1639 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1640 struct drm_file *file_priv,
1643 struct drm_mode_object *mo;
1644 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1645 return mo ? obj_to_connector(mo) : NULL;
1649 * drm_connector_get - acquire a connector reference
1650 * @connector: DRM connector
1652 * This function increments the connector's refcount.
1654 static inline void drm_connector_get(struct drm_connector *connector)
1656 drm_mode_object_get(&connector->base);
1660 * drm_connector_put - release a connector reference
1661 * @connector: DRM connector
1663 * This function decrements the connector's reference count and frees the
1664 * object if the reference count drops to zero.
1666 static inline void drm_connector_put(struct drm_connector *connector)
1668 drm_mode_object_put(&connector->base);
1672 * drm_connector_is_unregistered - has the connector been unregistered from
1674 * @connector: DRM connector
1676 * Checks whether or not @connector has been unregistered from userspace.
1679 * True if the connector was unregistered, false if the connector is
1680 * registered or has not yet been registered with userspace.
1683 drm_connector_is_unregistered(struct drm_connector *connector)
1685 return READ_ONCE(connector->registration_state) ==
1686 DRM_CONNECTOR_UNREGISTERED;
1689 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode);
1690 const char *drm_get_connector_type_name(unsigned int connector_type);
1691 const char *drm_get_connector_status_name(enum drm_connector_status status);
1692 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1693 const char *drm_get_dpms_name(int val);
1694 const char *drm_get_dvi_i_subconnector_name(int val);
1695 const char *drm_get_dvi_i_select_name(int val);
1696 const char *drm_get_tv_subconnector_name(int val);
1697 const char *drm_get_tv_select_name(int val);
1698 const char *drm_get_dp_subconnector_name(int val);
1699 const char *drm_get_content_protection_name(int val);
1700 const char *drm_get_hdcp_content_type_name(int val);
1702 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1703 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
1705 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1706 int drm_mode_create_tv_properties(struct drm_device *dev,
1707 unsigned int num_modes,
1708 const char * const modes[]);
1709 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1710 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1711 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1712 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1713 u32 scaling_mode_mask);
1714 int drm_connector_attach_vrr_capable_property(
1715 struct drm_connector *connector);
1716 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
1717 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
1718 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
1719 struct drm_connector_state *new_state);
1720 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1721 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector);
1722 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector);
1723 int drm_mode_create_content_type_property(struct drm_device *dev);
1724 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1725 const struct drm_connector_state *conn_state);
1727 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1729 int drm_connector_set_path_property(struct drm_connector *connector,
1731 int drm_connector_set_tile_property(struct drm_connector *connector);
1732 int drm_connector_update_edid_property(struct drm_connector *connector,
1733 const struct edid *edid);
1734 void drm_connector_set_link_status_property(struct drm_connector *connector,
1735 uint64_t link_status);
1736 void drm_connector_set_vrr_capable_property(
1737 struct drm_connector *connector, bool capable);
1738 int drm_connector_set_panel_orientation(
1739 struct drm_connector *connector,
1740 enum drm_panel_orientation panel_orientation);
1741 int drm_connector_set_panel_orientation_with_quirk(
1742 struct drm_connector *connector,
1743 enum drm_panel_orientation panel_orientation,
1744 int width, int height);
1745 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1749 * struct drm_tile_group - Tile group metadata
1750 * @refcount: reference count
1752 * @id: tile group id exposed to userspace
1753 * @group_data: Sink-private data identifying this group
1755 * @group_data corresponds to displayid vend/prod/serial for external screens
1758 struct drm_tile_group {
1759 struct kref refcount;
1760 struct drm_device *dev;
1765 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1766 const char topology[8]);
1767 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1768 const char topology[8]);
1769 void drm_mode_put_tile_group(struct drm_device *dev,
1770 struct drm_tile_group *tg);
1773 * struct drm_connector_list_iter - connector_list iterator
1775 * This iterator tracks state needed to be able to walk the connector_list
1776 * within struct drm_mode_config. Only use together with
1777 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1778 * drm_connector_list_iter_next() respectively the convenience macro
1779 * drm_for_each_connector_iter().
1781 * Note that the return value of drm_connector_list_iter_next() is only valid
1782 * up to the next drm_connector_list_iter_next() or
1783 * drm_connector_list_iter_end() call. If you want to use the connector later,
1784 * then you need to grab your own reference first using drm_connector_get().
1786 struct drm_connector_list_iter {
1788 struct drm_device *dev;
1789 struct drm_connector *conn;
1792 void drm_connector_list_iter_begin(struct drm_device *dev,
1793 struct drm_connector_list_iter *iter);
1794 struct drm_connector *
1795 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1796 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1798 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1799 struct drm_encoder *encoder);
1802 * drm_for_each_connector_iter - connector_list iterator macro
1803 * @connector: &struct drm_connector pointer used as cursor
1804 * @iter: &struct drm_connector_list_iter
1806 * Note that @connector is only valid within the list body, if you want to use
1807 * @connector after calling drm_connector_list_iter_end() then you need to grab
1808 * your own reference first using drm_connector_get().
1810 #define drm_for_each_connector_iter(connector, iter) \
1811 while ((connector = drm_connector_list_iter_next(iter)))
1814 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1815 * @connector: &struct drm_connector pointer
1816 * @encoder: &struct drm_encoder pointer used as cursor
1818 #define drm_connector_for_each_possible_encoder(connector, encoder) \
1819 drm_for_each_encoder_mask(encoder, (connector)->dev, \
1820 (connector)->possible_encoders)