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;
45 enum drm_connector_force {
46 DRM_FORCE_UNSPECIFIED,
48 DRM_FORCE_ON, /* force on analog part normally */
49 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
53 * enum drm_connector_status - status for a &drm_connector
55 * This enum is used to track the connector status. There are no separate
56 * #defines for the uapi!
58 enum drm_connector_status {
60 * @connector_status_connected: The connector is definitely connected to
61 * a sink device, and can be enabled.
63 connector_status_connected = 1,
65 * @connector_status_disconnected: The connector isn't connected to a
66 * sink device which can be autodetect. For digital outputs like DP or
67 * HDMI (which can be realiable probed) this means there's really
68 * nothing there. It is driver-dependent whether a connector with this
69 * status can be lit up or not.
71 connector_status_disconnected = 2,
73 * @connector_status_unknown: The connector's status could not be
74 * reliably detected. This happens when probing would either cause
75 * flicker (like load-detection when the connector is in use), or when a
76 * hardware resource isn't available (like when load-detection needs a
77 * free CRTC). It should be possible to light up the connector with one
78 * of the listed fallback modes. For default configuration userspace
79 * should only try to light up connectors with unknown status when
80 * there's not connector with @connector_status_connected.
82 connector_status_unknown = 3,
86 * enum drm_connector_registration_status - userspace registration status for
89 * This enum is used to track the status of initializing a connector and
90 * registering it with userspace, so that DRM can prevent bogus modesets on
91 * connectors that no longer exist.
93 enum drm_connector_registration_state {
95 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
96 * but has yet to be exposed to userspace. There should be no
97 * additional restrictions to how the state of this connector may be
100 DRM_CONNECTOR_INITIALIZING = 0,
103 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
104 * and registered with sysfs, as such it has been exposed to
105 * userspace. There should be no additional restrictions to how the
106 * state of this connector may be modified.
108 DRM_CONNECTOR_REGISTERED = 1,
111 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
112 * to userspace and has since been unregistered and removed from
113 * userspace, or the connector was unregistered before it had a chance
114 * to be exposed to userspace (e.g. still in the
115 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
116 * unregistered, there are additional restrictions to how its state
119 * - An unregistered connector may only have its DPMS changed from
120 * On->Off. Once DPMS is changed to Off, it may not be switched back
122 * - Modesets are not allowed on unregistered connectors, unless they
123 * would result in disabling its assigned CRTCs. This means
124 * disabling a CRTC on an unregistered connector is OK, but enabling
126 * - Removing a CRTC from an unregistered connector is OK, but new
127 * CRTCs may never be assigned to an unregistered connector.
129 DRM_CONNECTOR_UNREGISTERED = 2,
132 enum subpixel_order {
134 SubPixelHorizontalRGB,
135 SubPixelHorizontalBGR,
143 * struct drm_scrambling: sink's scrambling support.
145 struct drm_scrambling {
147 * @supported: scrambling supported for rates > 340 Mhz.
151 * @low_rates: scrambling supported for rates <= 340 Mhz.
157 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
159 * Provides SCDC register support and capabilities related information on a
160 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
164 * @supported: status control & data channel present.
168 * @read_request: sink is capable of generating scdc read request.
172 * @scrambling: sink's scrambling capabilities
174 struct drm_scrambling scrambling;
179 * struct drm_hdmi_info - runtime information about the connected HDMI sink
181 * Describes if a given display supports advanced HDMI 2.0 features.
182 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
184 struct drm_hdmi_info {
185 /** @scdc: sink's scdc support and capabilities */
186 struct drm_scdc scdc;
189 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
190 * output only (not normal RGB/YCBCR444/422 outputs). There are total
191 * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map
194 unsigned long y420_vdb_modes[BITS_TO_LONGS(128)];
197 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
198 * output also, along with normal HDMI outputs. There are total 107
199 * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto
202 unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)];
204 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
207 /** @y420_dc_modes: bitmap of deep color support index */
212 * enum drm_link_status - connector's link_status property value
214 * This enum is used as the connector's link status property value.
215 * It is set to the values defined in uapi.
217 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
219 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
222 enum drm_link_status {
223 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
224 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
228 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
230 * This enum is used to track the (LCD) panel orientation. There are no
231 * separate #defines for the uapi!
233 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
234 * panel orientation information (normal
235 * for non panels) in this case the "panel
236 * orientation" connector prop will not be
238 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
239 * top side of the device's casing.
240 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
241 * bottom side of the device's casing, iow
242 * the panel is mounted upside-down.
243 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
244 * top side of the device's casing.
245 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
246 * top side of the device's casing.
248 enum drm_panel_orientation {
249 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
250 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
251 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
252 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
253 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
257 * This is a consolidated colorimetry list supported by HDMI and
258 * DP protocol standard. The respective connectors will register
259 * a property with the subset of this list (supported by that
260 * respective protocol). Userspace will set the colorspace through
261 * a colorspace property which will be created and exposed to
265 /* For Default case, driver will set the colorspace */
266 #define DRM_MODE_COLORIMETRY_DEFAULT 0
267 /* CEA 861 Normal Colorimetry options */
268 #define DRM_MODE_COLORIMETRY_NO_DATA 0
269 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC 1
270 #define DRM_MODE_COLORIMETRY_BT709_YCC 2
271 /* CEA 861 Extended Colorimetry Options */
272 #define DRM_MODE_COLORIMETRY_XVYCC_601 3
273 #define DRM_MODE_COLORIMETRY_XVYCC_709 4
274 #define DRM_MODE_COLORIMETRY_SYCC_601 5
275 #define DRM_MODE_COLORIMETRY_OPYCC_601 6
276 #define DRM_MODE_COLORIMETRY_OPRGB 7
277 #define DRM_MODE_COLORIMETRY_BT2020_CYCC 8
278 #define DRM_MODE_COLORIMETRY_BT2020_RGB 9
279 #define DRM_MODE_COLORIMETRY_BT2020_YCC 10
280 /* Additional Colorimetry extension added as part of CTA 861.G */
281 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 11
282 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER 12
285 * struct drm_display_info - runtime data about the connected sink
287 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
288 * fixed display sinks like built-in panels there's not much difference between
289 * this and &struct drm_connector. But for sinks with a real cable this
290 * structure is meant to describe all the things at the other end of the cable.
292 * For sinks which provide an EDID this can be filled out by calling
293 * drm_add_edid_modes().
295 struct drm_display_info {
297 * @name: Name of the display.
299 char name[DRM_DISPLAY_INFO_LEN];
302 * @width_mm: Physical width in mm.
304 unsigned int width_mm;
306 * @height_mm: Physical height in mm.
308 unsigned int height_mm;
311 * @pixel_clock: Maximum pixel clock supported by the sink, in units of
312 * 100Hz. This mismatches the clock in &drm_display_mode (which is in
313 * kHZ), because that's what the EDID uses as base unit.
315 unsigned int pixel_clock;
317 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
322 * @subpixel_order: Subpixel order of LCD panels.
324 enum subpixel_order subpixel_order;
326 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
327 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
328 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
329 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3)
332 * @panel_orientation: Read only connector property for built-in panels,
333 * indicating the orientation of the panel vs the device's casing.
334 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
335 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
336 * fb to compensate and gets exported as prop to userspace.
338 int panel_orientation;
341 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
342 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
343 * as used to describe the pixel format in framebuffers, and also don't
344 * match the formats in @bus_formats which are shared with v4l.
349 * @bus_formats: Pixel data format on the wire, somewhat redundant with
350 * @color_formats. Array of size @num_bus_formats encoded using
351 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
353 const u32 *bus_formats;
355 * @num_bus_formats: Size of @bus_formats array.
357 unsigned int num_bus_formats;
359 #define DRM_BUS_FLAG_DE_LOW (1<<0)
360 #define DRM_BUS_FLAG_DE_HIGH (1<<1)
361 /* drive data on pos. edge */
362 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
363 /* drive data on neg. edge */
364 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
365 /* data is transmitted MSB to LSB on the bus */
366 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4)
367 /* data is transmitted LSB to MSB on the bus */
368 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5)
369 /* drive sync on pos. edge */
370 #define DRM_BUS_FLAG_SYNC_POSEDGE (1<<6)
371 /* drive sync on neg. edge */
372 #define DRM_BUS_FLAG_SYNC_NEGEDGE (1<<7)
375 * @bus_flags: Additional information (like pixel signal polarity) for
376 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines.
381 * @max_tmds_clock: Maximum TMDS clock rate supported by the
382 * sink in kHz. 0 means undefined.
387 * @dvi_dual: Dual-link DVI sink?
392 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
394 bool has_hdmi_infoframe;
397 * @rgb_quant_range_selectable: Does the sink support selecting
398 * the RGB quantization range?
400 bool rgb_quant_range_selectable;
403 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
404 * more stuff redundant with @bus_formats.
406 u8 edid_hdmi_dc_modes;
409 * @cea_rev: CEA revision of the HDMI sink.
414 * @hdmi: advance features of a HDMI sink.
416 struct drm_hdmi_info hdmi;
419 * @non_desktop: Non desktop display (HMD).
424 int drm_display_info_set_bus_formats(struct drm_display_info *info,
426 unsigned int num_formats);
429 * struct drm_tv_connector_state - TV connector related states
430 * @subconnector: selected subconnector
431 * @margins: margins (all margins are expressed in pixels)
432 * @margins.left: left margin
433 * @margins.right: right margin
434 * @margins.top: top margin
435 * @margins.bottom: bottom margin
437 * @brightness: brightness in percent
438 * @contrast: contrast in percent
439 * @flicker_reduction: flicker reduction in percent
440 * @overscan: overscan in percent
441 * @saturation: saturation in percent
442 * @hue: hue in percent
444 struct drm_tv_connector_state {
445 enum drm_mode_subconnector subconnector;
453 unsigned int brightness;
454 unsigned int contrast;
455 unsigned int flicker_reduction;
456 unsigned int overscan;
457 unsigned int saturation;
462 * struct drm_connector_state - mutable connector state
464 struct drm_connector_state {
465 /** @connector: backpointer to the connector */
466 struct drm_connector *connector;
469 * @crtc: CRTC to connect connector to, NULL if disabled.
471 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
474 struct drm_crtc *crtc;
479 * Used by the atomic helpers to select the encoder, through the
480 * &drm_connector_helper_funcs.atomic_best_encoder or
481 * &drm_connector_helper_funcs.best_encoder callbacks.
483 struct drm_encoder *best_encoder;
486 * @link_status: Connector link_status to keep track of whether link is
487 * GOOD or BAD to notify userspace if retraining is necessary.
489 enum drm_link_status link_status;
491 /** @state: backpointer to global drm_atomic_state */
492 struct drm_atomic_state *state;
495 * @commit: Tracks the pending commit to prevent use-after-free conditions.
497 * Is only set when @crtc is NULL.
499 struct drm_crtc_commit *commit;
501 /** @tv: TV connector state */
502 struct drm_tv_connector_state tv;
505 * @picture_aspect_ratio: Connector property to control the
506 * HDMI infoframe aspect ratio setting.
508 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
509 * values for &enum hdmi_picture_aspect
511 enum hdmi_picture_aspect picture_aspect_ratio;
514 * @content_type: Connector property to control the
515 * HDMI infoframe content type setting.
516 * The %DRM_MODE_CONTENT_TYPE_\* values much
519 unsigned int content_type;
522 * @scaling_mode: Connector property to control the
523 * upscaling, mostly used for built-in panels.
525 unsigned int scaling_mode;
528 * @content_protection: Connector property to request content
529 * protection. This is most commonly used for HDCP.
531 unsigned int content_protection;
534 * @colorspace: State variable for Connector property to request
535 * colorspace change on Sink. This is most commonly used to switch
536 * to wider color gamuts like BT2020.
541 * @writeback_job: Writeback job for writeback connectors
543 * Holds the framebuffer and out-fence for a writeback connector. As
544 * the writeback completion may be asynchronous to the normal commit
545 * cycle, the writeback job lifetime is managed separately from the
546 * normal atomic state by this object.
548 * See also: drm_writeback_queue_job() and
549 * drm_writeback_signal_completion()
551 struct drm_writeback_job *writeback_job;
554 * @max_requested_bpc: Connector property to limit the maximum bit
555 * depth of the pixels.
557 u8 max_requested_bpc;
560 * @max_bpc: Connector max_bpc based on the requested max_bpc property
561 * and the connector bpc limitations obtained from edid.
567 * struct drm_connector_funcs - control connectors on a given device
569 * Each CRTC may have one or more connectors attached to it. The functions
570 * below allow the core DRM code to control connectors, enumerate available modes,
573 struct drm_connector_funcs {
577 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
578 * is exposed as a standard property on the connector, but diverted to
579 * this callback in the drm core. Note that atomic drivers don't
580 * implement the 4 level DPMS support on the connector any more, but
581 * instead only have an on/off "ACTIVE" property on the CRTC object.
583 * This hook is not used by atomic drivers, remapping of the legacy DPMS
584 * property is entirely handled in the DRM core.
588 * 0 on success or a negative error code on failure.
590 int (*dpms)(struct drm_connector *connector, int mode);
595 * Reset connector hardware and software state to off. This function isn't
596 * called by the core directly, only through drm_mode_config_reset().
597 * It's not a helper hook only for historical reasons.
599 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
600 * atomic state using this hook.
602 void (*reset)(struct drm_connector *connector);
607 * Check to see if anything is attached to the connector. The parameter
608 * force is set to false whilst polling, true when checking the
609 * connector due to a user request. force can be used by the driver to
610 * avoid expensive, destructive operations during automated probing.
612 * This callback is optional, if not implemented the connector will be
613 * considered as always being attached.
617 * Note that this hook is only called by the probe helper. It's not in
618 * the helper library vtable purely for historical reasons. The only DRM
619 * core entry point to probe connector state is @fill_modes.
621 * Note that the helper library will already hold
622 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
623 * locks to avoid races with concurrent modeset changes need to use
624 * &drm_connector_helper_funcs.detect_ctx instead.
628 * drm_connector_status indicating the connector's status.
630 enum drm_connector_status (*detect)(struct drm_connector *connector,
636 * This function is called to update internal encoder state when the
637 * connector is forced to a certain state by userspace, either through
638 * the sysfs interfaces or on the kernel cmdline. In that case the
639 * @detect callback isn't called.
643 * Note that this hook is only called by the probe helper. It's not in
644 * the helper library vtable purely for historical reasons. The only DRM
645 * core entry point to probe connector state is @fill_modes.
647 void (*force)(struct drm_connector *connector);
652 * Entry point for output detection and basic mode validation. The
653 * driver should reprobe the output if needed (e.g. when hotplug
654 * handling is unreliable), add all detected modes to &drm_connector.modes
655 * and filter out any the device can't support in any configuration. It
656 * also needs to filter out any modes wider or higher than the
657 * parameters max_width and max_height indicate.
659 * The drivers must also prune any modes no longer valid from
660 * &drm_connector.modes. Furthermore it must update
661 * &drm_connector.status and &drm_connector.edid. If no EDID has been
662 * received for this output connector->edid must be NULL.
664 * Drivers using the probe helpers should use
665 * drm_helper_probe_single_connector_modes() to implement this
670 * The number of modes detected and filled into &drm_connector.modes.
672 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
677 * This is the legacy entry point to update a property attached to the
680 * This callback is optional if the driver does not support any legacy
681 * driver-private properties. For atomic drivers it is not used because
682 * property handling is done entirely in the DRM core.
686 * 0 on success or a negative error code on failure.
688 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
694 * This optional hook can be used to register additional userspace
695 * interfaces attached to the connector, light backlight control, i2c,
696 * DP aux or similar interfaces. It is called late in the driver load
697 * sequence from drm_connector_register() when registering all the
698 * core drm connector interfaces. Everything added from this callback
699 * should be unregistered in the early_unregister callback.
701 * This is called while holding &drm_connector.mutex.
705 * 0 on success, or a negative error code on failure.
707 int (*late_register)(struct drm_connector *connector);
712 * This optional hook should be used to unregister the additional
713 * userspace interfaces attached to the connector from
714 * late_register(). It is called from drm_connector_unregister(),
715 * early in the driver unload sequence to disable userspace access
716 * before data structures are torndown.
718 * This is called while holding &drm_connector.mutex.
720 void (*early_unregister)(struct drm_connector *connector);
725 * Clean up connector resources. This is called at driver unload time
726 * through drm_mode_config_cleanup(). It can also be called at runtime
727 * when a connector is being hot-unplugged for drivers that support
728 * connector hotplugging (e.g. DisplayPort MST).
730 void (*destroy)(struct drm_connector *connector);
733 * @atomic_duplicate_state:
735 * Duplicate the current atomic state for this connector and return it.
736 * The core and helpers guarantee that any atomic state duplicated with
737 * this hook and still owned by the caller (i.e. not transferred to the
738 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
739 * cleaned up by calling the @atomic_destroy_state hook in this
742 * This callback is mandatory for atomic drivers.
744 * Atomic drivers which don't subclass &struct drm_connector_state should use
745 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
746 * state structure to extend it with driver-private state should use
747 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
748 * duplicated in a consistent fashion across drivers.
750 * It is an error to call this hook before &drm_connector.state has been
751 * initialized correctly.
755 * If the duplicate state references refcounted resources this hook must
756 * acquire a reference for each of them. The driver must release these
757 * references again in @atomic_destroy_state.
761 * Duplicated atomic state or NULL when the allocation failed.
763 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
766 * @atomic_destroy_state:
768 * Destroy a state duplicated with @atomic_duplicate_state and release
769 * or unreference all resources it references
771 * This callback is mandatory for atomic drivers.
773 void (*atomic_destroy_state)(struct drm_connector *connector,
774 struct drm_connector_state *state);
777 * @atomic_set_property:
779 * Decode a driver-private property value and store the decoded value
780 * into the passed-in state structure. Since the atomic core decodes all
781 * standardized properties (even for extensions beyond the core set of
782 * properties which might not be implemented by all drivers) this
783 * requires drivers to subclass the state structure.
785 * Such driver-private properties should really only be implemented for
786 * truly hardware/vendor specific state. Instead it is preferred to
787 * standardize atomic extension and decode the properties used to expose
788 * such an extension in the core.
790 * Do not call this function directly, use
791 * drm_atomic_connector_set_property() instead.
793 * This callback is optional if the driver does not support any
794 * driver-private atomic properties.
798 * This function is called in the state assembly phase of atomic
799 * modesets, which can be aborted for any reason (including on
800 * userspace's request to just check whether a configuration would be
801 * possible). Drivers MUST NOT touch any persistent state (hardware or
802 * software) or data structures except the passed in @state parameter.
804 * Also since userspace controls in which order properties are set this
805 * function must not do any input validation (since the state update is
806 * incomplete and hence likely inconsistent). Instead any such input
807 * validation must be done in the various atomic_check callbacks.
811 * 0 if the property has been found, -EINVAL if the property isn't
812 * implemented by the driver (which shouldn't ever happen, the core only
813 * asks for properties attached to this connector). No other validation
814 * is allowed by the driver. The core already checks that the property
815 * value is within the range (integer, valid enum value, ...) the driver
816 * set when registering the property.
818 int (*atomic_set_property)(struct drm_connector *connector,
819 struct drm_connector_state *state,
820 struct drm_property *property,
824 * @atomic_get_property:
826 * Reads out the decoded driver-private property. This is used to
827 * implement the GETCONNECTOR IOCTL.
829 * Do not call this function directly, use
830 * drm_atomic_connector_get_property() instead.
832 * This callback is optional if the driver does not support any
833 * driver-private atomic properties.
837 * 0 on success, -EINVAL if the property isn't implemented by the
838 * driver (which shouldn't ever happen, the core only asks for
839 * properties attached to this connector).
841 int (*atomic_get_property)(struct drm_connector *connector,
842 const struct drm_connector_state *state,
843 struct drm_property *property,
847 * @atomic_print_state:
849 * If driver subclasses &struct drm_connector_state, it should implement
850 * this optional hook for printing additional driver specific state.
852 * Do not call this directly, use drm_atomic_connector_print_state()
855 void (*atomic_print_state)(struct drm_printer *p,
856 const struct drm_connector_state *state);
859 /* mode specified on the command line */
860 struct drm_cmdline_mode {
862 bool refresh_specified;
871 enum drm_connector_force force;
875 * struct drm_connector - central DRM connector control structure
877 * Each connector may be connected to one or more CRTCs, or may be clonable by
878 * another connector if they can share a CRTC. Each connector also has a specific
879 * position in the broader display (referred to as a 'screen' though it could
880 * span multiple monitors).
882 struct drm_connector {
883 /** @dev: parent DRM device */
884 struct drm_device *dev;
885 /** @kdev: kernel device for sysfs attributes */
887 /** @attr: sysfs attributes */
888 struct device_attribute *attr;
893 * List of all connectors on a @dev, linked from
894 * &drm_mode_config.connector_list. Protected by
895 * &drm_mode_config.connector_list_lock, but please only use
896 * &drm_connector_list_iter to walk this list.
898 struct list_head head;
900 /** @base: base KMS object */
901 struct drm_mode_object base;
903 /** @name: human readable name, can be overwritten by the driver */
907 * @mutex: Lock for general connector state, but currently only protects
908 * @registered. Most of the connector state is still protected by
909 * &drm_mode_config.mutex.
914 * @index: Compacted connector index, which matches the position inside
915 * the mode_config.list for drivers not supporting hot-add/removing. Can
916 * be used as an array index. It is invariant over the lifetime of the
923 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
926 /** @connector_type_id: index into connector type enum */
927 int connector_type_id;
929 * @interlace_allowed:
930 * Can this connector handle interlaced modes? Only used by
931 * drm_helper_probe_single_connector_modes() for mode filtering.
933 bool interlace_allowed;
935 * @doublescan_allowed:
936 * Can this connector handle doublescan? Only used by
937 * drm_helper_probe_single_connector_modes() for mode filtering.
939 bool doublescan_allowed;
942 * Can this connector handle stereo modes? Only used by
943 * drm_helper_probe_single_connector_modes() for mode filtering.
948 * @ycbcr_420_allowed : This bool indicates if this connector is
949 * capable of handling YCBCR 420 output. While parsing the EDID
950 * blocks it's very helpful to know if the source is capable of
951 * handling YCBCR 420 outputs.
953 bool ycbcr_420_allowed;
956 * @registration_state: Is this connector initializing, exposed
957 * (registered) with userspace, or unregistered?
959 * Protected by @mutex.
961 enum drm_connector_registration_state registration_state;
965 * Modes available on this connector (from fill_modes() + user).
966 * Protected by &drm_mode_config.mutex.
968 struct list_head modes;
972 * One of the drm_connector_status enums (connected, not, or unknown).
973 * Protected by &drm_mode_config.mutex.
975 enum drm_connector_status status;
979 * These are modes added by probing with DDC or the BIOS, before
980 * filtering is applied. Used by the probe helpers. Protected by
981 * &drm_mode_config.mutex.
983 struct list_head probed_modes;
986 * @display_info: Display information is filled from EDID information
987 * when a display is detected. For non hot-pluggable displays such as
988 * flat panels in embedded systems, the driver should initialize the
989 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
990 * with the physical size of the display.
992 * Protected by &drm_mode_config.mutex.
994 struct drm_display_info display_info;
996 /** @funcs: connector control functions */
997 const struct drm_connector_funcs *funcs;
1000 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1001 * &drm_mode_config.mutex. This should be updated only by calling
1002 * drm_connector_update_edid_property().
1004 struct drm_property_blob *edid_blob_ptr;
1006 /** @properties: property tracking for this connector */
1007 struct drm_object_properties properties;
1010 * @scaling_mode_property: Optional atomic property to control the
1011 * upscaling. See drm_connector_attach_content_protection_property().
1013 struct drm_property *scaling_mode_property;
1016 * @vrr_capable_property: Optional property to help userspace
1017 * query hardware support for variable refresh rate on a connector.
1018 * connector. Drivers can add the property to a connector by
1019 * calling drm_connector_attach_vrr_capable_property().
1021 * This should be updated only by calling
1022 * drm_connector_set_vrr_capable_property().
1024 struct drm_property *vrr_capable_property;
1027 * @content_protection_property: DRM ENUM property for content
1028 * protection. See drm_connector_attach_content_protection_property().
1030 struct drm_property *content_protection_property;
1033 * @colorspace_property: Connector property to set the suitable
1034 * colorspace supported by the sink.
1036 struct drm_property *colorspace_property;
1041 * DRM blob property data for the DP MST path property. This should only
1042 * be updated by calling drm_connector_set_path_property().
1044 struct drm_property_blob *path_blob_ptr;
1047 * @max_bpc_property: Default connector property for the max bpc to be
1048 * driven out of the connector.
1050 struct drm_property *max_bpc_property;
1052 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1053 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1054 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1059 * Connector polling mode, a combination of
1061 * DRM_CONNECTOR_POLL_HPD
1062 * The connector generates hotplug events and doesn't need to be
1063 * periodically polled. The CONNECT and DISCONNECT flags must not
1064 * be set together with the HPD flag.
1066 * DRM_CONNECTOR_POLL_CONNECT
1067 * Periodically poll the connector for connection.
1069 * DRM_CONNECTOR_POLL_DISCONNECT
1070 * Periodically poll the connector for disconnection, without
1071 * causing flickering even when the connector is in use. DACs should
1072 * rarely do this without a lot of testing.
1074 * Set to 0 for connectors that don't support connection status
1080 * @dpms: Current dpms state. For legacy drivers the
1081 * &drm_connector_funcs.dpms callback must update this. For atomic
1082 * drivers, this is handled by the core atomic code, and drivers must
1083 * only take &drm_crtc_state.active into account.
1087 /** @helper_private: mid-layer private data */
1088 const struct drm_connector_helper_funcs *helper_private;
1090 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1091 struct drm_cmdline_mode cmdline_mode;
1092 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1093 enum drm_connector_force force;
1094 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1097 #define DRM_CONNECTOR_MAX_ENCODER 3
1099 * @encoder_ids: Valid encoders for this connector. Please only use
1100 * drm_connector_for_each_possible_encoder() to enumerate these.
1102 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
1105 * @encoder: Currently bound encoder driving this connector, if any.
1106 * Only really meaningful for non-atomic drivers. Atomic drivers should
1107 * instead look at &drm_connector_state.best_encoder, and in case they
1108 * need the CRTC driving this output, &drm_connector_state.crtc.
1110 struct drm_encoder *encoder;
1112 #define MAX_ELD_BYTES 128
1113 /** @eld: EDID-like data, if present */
1114 uint8_t eld[MAX_ELD_BYTES];
1115 /** @latency_present: AV delay info from ELD, if found */
1116 bool latency_present[2];
1118 * @video_latency: Video latency info from ELD, if found.
1119 * [0]: progressive, [1]: interlaced
1121 int video_latency[2];
1123 * @audio_latency: audio latency info from ELD, if found
1124 * [0]: progressive, [1]: interlaced
1126 int audio_latency[2];
1128 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1129 * Needed to workaround some HW bugs where we get all 0s
1131 int null_edid_counter;
1133 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1134 unsigned bad_edid_counter;
1137 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1138 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1143 /** @debugfs_entry: debugfs directory for this connector */
1144 struct dentry *debugfs_entry;
1149 * Current atomic state for this connector.
1151 * This is protected by &drm_mode_config.connection_mutex. Note that
1152 * nonblocking atomic commits access the current connector state without
1153 * taking locks. Either by going through the &struct drm_atomic_state
1154 * pointers, see for_each_oldnew_connector_in_state(),
1155 * for_each_old_connector_in_state() and
1156 * for_each_new_connector_in_state(). Or through careful ordering of
1157 * atomic commit operations as implemented in the atomic helpers, see
1158 * &struct drm_crtc_commit.
1160 struct drm_connector_state *state;
1162 /* DisplayID bits. FIXME: Extract into a substruct? */
1167 * DRM blob property data for the tile property (used mostly by DP MST).
1168 * This is meant for screens which are driven through separate display
1169 * pipelines represented by &drm_crtc, which might not be running with
1170 * genlocked clocks. For tiled panels which are genlocked, like
1171 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1172 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1174 * This should only be updated by calling
1175 * drm_connector_set_tile_property().
1177 struct drm_property_blob *tile_blob_ptr;
1179 /** @has_tile: is this connector connected to a tiled monitor */
1181 /** @tile_group: tile group for the connected monitor */
1182 struct drm_tile_group *tile_group;
1183 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1184 bool tile_is_single_monitor;
1186 /** @num_h_tile: number of horizontal tiles in the tile group */
1187 /** @num_v_tile: number of vertical tiles in the tile group */
1188 uint8_t num_h_tile, num_v_tile;
1189 /** @tile_h_loc: horizontal location of this tile */
1190 /** @tile_v_loc: vertical location of this tile */
1191 uint8_t tile_h_loc, tile_v_loc;
1192 /** @tile_h_size: horizontal size of this tile. */
1193 /** @tile_v_size: vertical size of this tile. */
1194 uint16_t tile_h_size, tile_v_size;
1199 * List used only by &drm_connector_list_iter to be able to clean up a
1200 * connector from any context, in conjunction with
1201 * &drm_mode_config.connector_free_work.
1203 struct llist_node free_node;
1206 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1208 int drm_connector_init(struct drm_device *dev,
1209 struct drm_connector *connector,
1210 const struct drm_connector_funcs *funcs,
1211 int connector_type);
1212 void drm_connector_attach_edid_property(struct drm_connector *connector);
1213 int drm_connector_register(struct drm_connector *connector);
1214 void drm_connector_unregister(struct drm_connector *connector);
1215 int drm_connector_attach_encoder(struct drm_connector *connector,
1216 struct drm_encoder *encoder);
1218 void drm_connector_cleanup(struct drm_connector *connector);
1220 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1222 return connector->index;
1225 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1227 return 1 << connector->index;
1231 * drm_connector_lookup - lookup connector object
1233 * @file_priv: drm file to check for lease against.
1234 * @id: connector object id
1236 * This function looks up the connector object specified by id
1237 * add takes a reference to it.
1239 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1240 struct drm_file *file_priv,
1243 struct drm_mode_object *mo;
1244 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1245 return mo ? obj_to_connector(mo) : NULL;
1249 * drm_connector_get - acquire a connector reference
1250 * @connector: DRM connector
1252 * This function increments the connector's refcount.
1254 static inline void drm_connector_get(struct drm_connector *connector)
1256 drm_mode_object_get(&connector->base);
1260 * drm_connector_put - release a connector reference
1261 * @connector: DRM connector
1263 * This function decrements the connector's reference count and frees the
1264 * object if the reference count drops to zero.
1266 static inline void drm_connector_put(struct drm_connector *connector)
1268 drm_mode_object_put(&connector->base);
1272 * drm_connector_is_unregistered - has the connector been unregistered from
1274 * @connector: DRM connector
1276 * Checks whether or not @connector has been unregistered from userspace.
1279 * True if the connector was unregistered, false if the connector is
1280 * registered or has not yet been registered with userspace.
1283 drm_connector_is_unregistered(struct drm_connector *connector)
1285 return READ_ONCE(connector->registration_state) ==
1286 DRM_CONNECTOR_UNREGISTERED;
1289 const char *drm_get_connector_status_name(enum drm_connector_status status);
1290 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1291 const char *drm_get_dpms_name(int val);
1292 const char *drm_get_dvi_i_subconnector_name(int val);
1293 const char *drm_get_dvi_i_select_name(int val);
1294 const char *drm_get_tv_subconnector_name(int val);
1295 const char *drm_get_tv_select_name(int val);
1296 const char *drm_get_content_protection_name(int val);
1298 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1299 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1300 int drm_mode_create_tv_properties(struct drm_device *dev,
1301 unsigned int num_modes,
1302 const char * const modes[]);
1303 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1304 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1305 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1306 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1307 u32 scaling_mode_mask);
1308 int drm_connector_attach_vrr_capable_property(
1309 struct drm_connector *connector);
1310 int drm_connector_attach_content_protection_property(
1311 struct drm_connector *connector);
1312 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1313 int drm_mode_create_colorspace_property(struct drm_connector *connector);
1314 int drm_mode_create_content_type_property(struct drm_device *dev);
1315 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1316 const struct drm_connector_state *conn_state);
1318 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1320 int drm_connector_set_path_property(struct drm_connector *connector,
1322 int drm_connector_set_tile_property(struct drm_connector *connector);
1323 int drm_connector_update_edid_property(struct drm_connector *connector,
1324 const struct edid *edid);
1325 void drm_connector_set_link_status_property(struct drm_connector *connector,
1326 uint64_t link_status);
1327 void drm_connector_set_vrr_capable_property(
1328 struct drm_connector *connector, bool capable);
1329 int drm_connector_init_panel_orientation_property(
1330 struct drm_connector *connector, int width, int height);
1331 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1335 * struct drm_tile_group - Tile group metadata
1336 * @refcount: reference count
1338 * @id: tile group id exposed to userspace
1339 * @group_data: Sink-private data identifying this group
1341 * @group_data corresponds to displayid vend/prod/serial for external screens
1344 struct drm_tile_group {
1345 struct kref refcount;
1346 struct drm_device *dev;
1351 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1353 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1355 void drm_mode_put_tile_group(struct drm_device *dev,
1356 struct drm_tile_group *tg);
1359 * struct drm_connector_list_iter - connector_list iterator
1361 * This iterator tracks state needed to be able to walk the connector_list
1362 * within struct drm_mode_config. Only use together with
1363 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1364 * drm_connector_list_iter_next() respectively the convenience macro
1365 * drm_for_each_connector_iter().
1367 struct drm_connector_list_iter {
1369 struct drm_device *dev;
1370 struct drm_connector *conn;
1373 void drm_connector_list_iter_begin(struct drm_device *dev,
1374 struct drm_connector_list_iter *iter);
1375 struct drm_connector *
1376 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1377 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1379 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1380 struct drm_encoder *encoder);
1383 * drm_for_each_connector_iter - connector_list iterator macro
1384 * @connector: &struct drm_connector pointer used as cursor
1385 * @iter: &struct drm_connector_list_iter
1387 * Note that @connector is only valid within the list body, if you want to use
1388 * @connector after calling drm_connector_list_iter_end() then you need to grab
1389 * your own reference first using drm_connector_get().
1391 #define drm_for_each_connector_iter(connector, iter) \
1392 while ((connector = drm_connector_list_iter_next(iter)))
1395 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1396 * @connector: &struct drm_connector pointer
1397 * @encoder: &struct drm_encoder pointer used as cursor
1398 * @__i: int iteration cursor, for macro-internal use
1400 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \
1401 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \
1402 (connector)->encoder_ids[(__i)] != 0; (__i)++) \
1403 for_each_if((encoder) = \
1404 drm_encoder_find((connector)->dev, NULL, \
1405 (connector)->encoder_ids[(__i)])) \