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,
87 SubPixelHorizontalRGB
,
88 SubPixelHorizontalBGR
,
96 * struct drm_scrambling: sink's scrambling support.
98 struct drm_scrambling
{
100 * @supported: scrambling supported for rates > 340 Mhz.
104 * @low_rates: scrambling supported for rates <= 340 Mhz.
110 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
112 * Provides SCDC register support and capabilities related information on a
113 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
117 * @supported: status control & data channel present.
121 * @read_request: sink is capable of generating scdc read request.
125 * @scrambling: sink's scrambling capabilities
127 struct drm_scrambling scrambling
;
132 * struct drm_hdmi_info - runtime information about the connected HDMI sink
134 * Describes if a given display supports advanced HDMI 2.0 features.
135 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
137 struct drm_hdmi_info
{
138 /** @scdc: sink's scdc support and capabilities */
139 struct drm_scdc scdc
;
142 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
143 * output only (not normal RGB/YCBCR444/422 outputs). There are total
144 * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map
147 unsigned long y420_vdb_modes
[BITS_TO_LONGS(128)];
150 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
151 * output also, along with normal HDMI outputs. There are total 107
152 * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto
155 unsigned long y420_cmdb_modes
[BITS_TO_LONGS(128)];
157 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
160 /** @y420_dc_modes: bitmap of deep color support index */
165 * enum drm_link_status - connector's link_status property value
167 * This enum is used as the connector's link status property value.
168 * It is set to the values defined in uapi.
170 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
172 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
175 enum drm_link_status
{
176 DRM_LINK_STATUS_GOOD
= DRM_MODE_LINK_STATUS_GOOD
,
177 DRM_LINK_STATUS_BAD
= DRM_MODE_LINK_STATUS_BAD
,
181 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
183 * This enum is used to track the (LCD) panel orientation. There are no
184 * separate #defines for the uapi!
186 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
187 * panel orientation information (normal
188 * for non panels) in this case the "panel
189 * orientation" connector prop will not be
191 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
192 * top side of the device's casing.
193 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
194 * bottom side of the device's casing, iow
195 * the panel is mounted upside-down.
196 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
197 * top side of the device's casing.
198 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
199 * top side of the device's casing.
201 enum drm_panel_orientation
{
202 DRM_MODE_PANEL_ORIENTATION_UNKNOWN
= -1,
203 DRM_MODE_PANEL_ORIENTATION_NORMAL
= 0,
204 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP
,
205 DRM_MODE_PANEL_ORIENTATION_LEFT_UP
,
206 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP
,
210 * struct drm_display_info - runtime data about the connected sink
212 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
213 * fixed display sinks like built-in panels there's not much difference between
214 * this and &struct drm_connector. But for sinks with a real cable this
215 * structure is meant to describe all the things at the other end of the cable.
217 * For sinks which provide an EDID this can be filled out by calling
218 * drm_add_edid_modes().
220 struct drm_display_info
{
222 * @name: Name of the display.
224 char name
[DRM_DISPLAY_INFO_LEN
];
227 * @width_mm: Physical width in mm.
229 unsigned int width_mm
;
231 * @height_mm: Physical height in mm.
233 unsigned int height_mm
;
236 * @pixel_clock: Maximum pixel clock supported by the sink, in units of
237 * 100Hz. This mismatches the clock in &drm_display_mode (which is in
238 * kHZ), because that's what the EDID uses as base unit.
240 unsigned int pixel_clock
;
242 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
247 * @subpixel_order: Subpixel order of LCD panels.
249 enum subpixel_order subpixel_order
;
251 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
252 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
253 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
254 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3)
257 * @panel_orientation: Read only connector property for built-in panels,
258 * indicating the orientation of the panel vs the device's casing.
259 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
260 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
261 * fb to compensate and gets exported as prop to userspace.
263 int panel_orientation
;
266 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
267 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
268 * as used to describe the pixel format in framebuffers, and also don't
269 * match the formats in @bus_formats which are shared with v4l.
274 * @bus_formats: Pixel data format on the wire, somewhat redundant with
275 * @color_formats. Array of size @num_bus_formats encoded using
276 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
278 const u32
*bus_formats
;
280 * @num_bus_formats: Size of @bus_formats array.
282 unsigned int num_bus_formats
;
284 #define DRM_BUS_FLAG_DE_LOW (1<<0)
285 #define DRM_BUS_FLAG_DE_HIGH (1<<1)
286 /* drive data on pos. edge */
287 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
288 /* drive data on neg. edge */
289 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
290 /* data is transmitted MSB to LSB on the bus */
291 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4)
292 /* data is transmitted LSB to MSB on the bus */
293 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5)
294 /* drive sync on pos. edge */
295 #define DRM_BUS_FLAG_SYNC_POSEDGE (1<<6)
296 /* drive sync on neg. edge */
297 #define DRM_BUS_FLAG_SYNC_NEGEDGE (1<<7)
300 * @bus_flags: Additional information (like pixel signal polarity) for
301 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines.
306 * @max_tmds_clock: Maximum TMDS clock rate supported by the
307 * sink in kHz. 0 means undefined.
312 * @dvi_dual: Dual-link DVI sink?
317 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
319 bool has_hdmi_infoframe
;
322 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
323 * more stuff redundant with @bus_formats.
325 u8 edid_hdmi_dc_modes
;
328 * @cea_rev: CEA revision of the HDMI sink.
333 * @hdmi: advance features of a HDMI sink.
335 struct drm_hdmi_info hdmi
;
338 * @non_desktop: Non desktop display (HMD).
343 int drm_display_info_set_bus_formats(struct drm_display_info
*info
,
345 unsigned int num_formats
);
348 * struct drm_tv_connector_state - TV connector related states
349 * @subconnector: selected subconnector
351 * @margins.left: left margin
352 * @margins.right: right margin
353 * @margins.top: top margin
354 * @margins.bottom: bottom margin
356 * @brightness: brightness in percent
357 * @contrast: contrast in percent
358 * @flicker_reduction: flicker reduction in percent
359 * @overscan: overscan in percent
360 * @saturation: saturation in percent
361 * @hue: hue in percent
363 struct drm_tv_connector_state
{
364 enum drm_mode_subconnector subconnector
;
372 unsigned int brightness
;
373 unsigned int contrast
;
374 unsigned int flicker_reduction
;
375 unsigned int overscan
;
376 unsigned int saturation
;
381 * struct drm_connector_state - mutable connector state
383 struct drm_connector_state
{
384 /** @connector: backpointer to the connector */
385 struct drm_connector
*connector
;
388 * @crtc: CRTC to connect connector to, NULL if disabled.
390 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
393 struct drm_crtc
*crtc
;
398 * Used by the atomic helpers to select the encoder, through the
399 * &drm_connector_helper_funcs.atomic_best_encoder or
400 * &drm_connector_helper_funcs.best_encoder callbacks.
402 struct drm_encoder
*best_encoder
;
405 * @link_status: Connector link_status to keep track of whether link is
406 * GOOD or BAD to notify userspace if retraining is necessary.
408 enum drm_link_status link_status
;
410 /** @state: backpointer to global drm_atomic_state */
411 struct drm_atomic_state
*state
;
414 * @commit: Tracks the pending commit to prevent use-after-free conditions.
416 * Is only set when @crtc is NULL.
418 struct drm_crtc_commit
*commit
;
420 /** @tv: TV connector state */
421 struct drm_tv_connector_state tv
;
424 * @picture_aspect_ratio: Connector property to control the
425 * HDMI infoframe aspect ratio setting.
427 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
428 * values for &enum hdmi_picture_aspect
430 enum hdmi_picture_aspect picture_aspect_ratio
;
433 * @content_type: Connector property to control the
434 * HDMI infoframe content type setting.
435 * The %DRM_MODE_CONTENT_TYPE_\* values much
438 unsigned int content_type
;
441 * @scaling_mode: Connector property to control the
442 * upscaling, mostly used for built-in panels.
444 unsigned int scaling_mode
;
447 * @content_protection: Connector property to request content
448 * protection. This is most commonly used for HDCP.
450 unsigned int content_protection
;
453 * @writeback_job: Writeback job for writeback connectors
455 * Holds the framebuffer and out-fence for a writeback connector. As
456 * the writeback completion may be asynchronous to the normal commit
457 * cycle, the writeback job lifetime is managed separately from the
458 * normal atomic state by this object.
460 * See also: drm_writeback_queue_job() and
461 * drm_writeback_signal_completion()
463 struct drm_writeback_job
*writeback_job
;
467 * struct drm_connector_funcs - control connectors on a given device
469 * Each CRTC may have one or more connectors attached to it. The functions
470 * below allow the core DRM code to control connectors, enumerate available modes,
473 struct drm_connector_funcs
{
477 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
478 * is exposed as a standard property on the connector, but diverted to
479 * this callback in the drm core. Note that atomic drivers don't
480 * implement the 4 level DPMS support on the connector any more, but
481 * instead only have an on/off "ACTIVE" property on the CRTC object.
483 * This hook is not used by atomic drivers, remapping of the legacy DPMS
484 * property is entirely handled in the DRM core.
488 * 0 on success or a negative error code on failure.
490 int (*dpms
)(struct drm_connector
*connector
, int mode
);
495 * Reset connector hardware and software state to off. This function isn't
496 * called by the core directly, only through drm_mode_config_reset().
497 * It's not a helper hook only for historical reasons.
499 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
500 * atomic state using this hook.
502 void (*reset
)(struct drm_connector
*connector
);
507 * Check to see if anything is attached to the connector. The parameter
508 * force is set to false whilst polling, true when checking the
509 * connector due to a user request. force can be used by the driver to
510 * avoid expensive, destructive operations during automated probing.
512 * This callback is optional, if not implemented the connector will be
513 * considered as always being attached.
517 * Note that this hook is only called by the probe helper. It's not in
518 * the helper library vtable purely for historical reasons. The only DRM
519 * core entry point to probe connector state is @fill_modes.
521 * Note that the helper library will already hold
522 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
523 * locks to avoid races with concurrent modeset changes need to use
524 * &drm_connector_helper_funcs.detect_ctx instead.
528 * drm_connector_status indicating the connector's status.
530 enum drm_connector_status (*detect
)(struct drm_connector
*connector
,
536 * This function is called to update internal encoder state when the
537 * connector is forced to a certain state by userspace, either through
538 * the sysfs interfaces or on the kernel cmdline. In that case the
539 * @detect callback isn't called.
543 * Note that this hook is only called by the probe helper. It's not in
544 * the helper library vtable purely for historical reasons. The only DRM
545 * core entry point to probe connector state is @fill_modes.
547 void (*force
)(struct drm_connector
*connector
);
552 * Entry point for output detection and basic mode validation. The
553 * driver should reprobe the output if needed (e.g. when hotplug
554 * handling is unreliable), add all detected modes to &drm_connector.modes
555 * and filter out any the device can't support in any configuration. It
556 * also needs to filter out any modes wider or higher than the
557 * parameters max_width and max_height indicate.
559 * The drivers must also prune any modes no longer valid from
560 * &drm_connector.modes. Furthermore it must update
561 * &drm_connector.status and &drm_connector.edid. If no EDID has been
562 * received for this output connector->edid must be NULL.
564 * Drivers using the probe helpers should use
565 * drm_helper_probe_single_connector_modes() to implement this
570 * The number of modes detected and filled into &drm_connector.modes.
572 int (*fill_modes
)(struct drm_connector
*connector
, uint32_t max_width
, uint32_t max_height
);
577 * This is the legacy entry point to update a property attached to the
580 * This callback is optional if the driver does not support any legacy
581 * driver-private properties. For atomic drivers it is not used because
582 * property handling is done entirely in the DRM core.
586 * 0 on success or a negative error code on failure.
588 int (*set_property
)(struct drm_connector
*connector
, struct drm_property
*property
,
594 * This optional hook can be used to register additional userspace
595 * interfaces attached to the connector, light backlight control, i2c,
596 * DP aux or similar interfaces. It is called late in the driver load
597 * sequence from drm_connector_register() when registering all the
598 * core drm connector interfaces. Everything added from this callback
599 * should be unregistered in the early_unregister callback.
601 * This is called while holding &drm_connector.mutex.
605 * 0 on success, or a negative error code on failure.
607 int (*late_register
)(struct drm_connector
*connector
);
612 * This optional hook should be used to unregister the additional
613 * userspace interfaces attached to the connector from
614 * late_register(). It is called from drm_connector_unregister(),
615 * early in the driver unload sequence to disable userspace access
616 * before data structures are torndown.
618 * This is called while holding &drm_connector.mutex.
620 void (*early_unregister
)(struct drm_connector
*connector
);
625 * Clean up connector resources. This is called at driver unload time
626 * through drm_mode_config_cleanup(). It can also be called at runtime
627 * when a connector is being hot-unplugged for drivers that support
628 * connector hotplugging (e.g. DisplayPort MST).
630 void (*destroy
)(struct drm_connector
*connector
);
633 * @atomic_duplicate_state:
635 * Duplicate the current atomic state for this connector and return it.
636 * The core and helpers guarantee that any atomic state duplicated with
637 * this hook and still owned by the caller (i.e. not transferred to the
638 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
639 * cleaned up by calling the @atomic_destroy_state hook in this
642 * This callback is mandatory for atomic drivers.
644 * Atomic drivers which don't subclass &struct drm_connector_state should use
645 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
646 * state structure to extend it with driver-private state should use
647 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
648 * duplicated in a consistent fashion across drivers.
650 * It is an error to call this hook before &drm_connector.state has been
651 * initialized correctly.
655 * If the duplicate state references refcounted resources this hook must
656 * acquire a reference for each of them. The driver must release these
657 * references again in @atomic_destroy_state.
661 * Duplicated atomic state or NULL when the allocation failed.
663 struct drm_connector_state
*(*atomic_duplicate_state
)(struct drm_connector
*connector
);
666 * @atomic_destroy_state:
668 * Destroy a state duplicated with @atomic_duplicate_state and release
669 * or unreference all resources it references
671 * This callback is mandatory for atomic drivers.
673 void (*atomic_destroy_state
)(struct drm_connector
*connector
,
674 struct drm_connector_state
*state
);
677 * @atomic_set_property:
679 * Decode a driver-private property value and store the decoded value
680 * into the passed-in state structure. Since the atomic core decodes all
681 * standardized properties (even for extensions beyond the core set of
682 * properties which might not be implemented by all drivers) this
683 * requires drivers to subclass the state structure.
685 * Such driver-private properties should really only be implemented for
686 * truly hardware/vendor specific state. Instead it is preferred to
687 * standardize atomic extension and decode the properties used to expose
688 * such an extension in the core.
690 * Do not call this function directly, use
691 * drm_atomic_connector_set_property() instead.
693 * This callback is optional if the driver does not support any
694 * driver-private atomic properties.
698 * This function is called in the state assembly phase of atomic
699 * modesets, which can be aborted for any reason (including on
700 * userspace's request to just check whether a configuration would be
701 * possible). Drivers MUST NOT touch any persistent state (hardware or
702 * software) or data structures except the passed in @state parameter.
704 * Also since userspace controls in which order properties are set this
705 * function must not do any input validation (since the state update is
706 * incomplete and hence likely inconsistent). Instead any such input
707 * validation must be done in the various atomic_check callbacks.
711 * 0 if the property has been found, -EINVAL if the property isn't
712 * implemented by the driver (which shouldn't ever happen, the core only
713 * asks for properties attached to this connector). No other validation
714 * is allowed by the driver. The core already checks that the property
715 * value is within the range (integer, valid enum value, ...) the driver
716 * set when registering the property.
718 int (*atomic_set_property
)(struct drm_connector
*connector
,
719 struct drm_connector_state
*state
,
720 struct drm_property
*property
,
724 * @atomic_get_property:
726 * Reads out the decoded driver-private property. This is used to
727 * implement the GETCONNECTOR IOCTL.
729 * Do not call this function directly, use
730 * drm_atomic_connector_get_property() instead.
732 * This callback is optional if the driver does not support any
733 * driver-private atomic properties.
737 * 0 on success, -EINVAL if the property isn't implemented by the
738 * driver (which shouldn't ever happen, the core only asks for
739 * properties attached to this connector).
741 int (*atomic_get_property
)(struct drm_connector
*connector
,
742 const struct drm_connector_state
*state
,
743 struct drm_property
*property
,
747 * @atomic_print_state:
749 * If driver subclasses &struct drm_connector_state, it should implement
750 * this optional hook for printing additional driver specific state.
752 * Do not call this directly, use drm_atomic_connector_print_state()
755 void (*atomic_print_state
)(struct drm_printer
*p
,
756 const struct drm_connector_state
*state
);
759 /* mode specified on the command line */
760 struct drm_cmdline_mode
{
762 bool refresh_specified
;
771 enum drm_connector_force force
;
775 * struct drm_connector - central DRM connector control structure
777 * Each connector may be connected to one or more CRTCs, or may be clonable by
778 * another connector if they can share a CRTC. Each connector also has a specific
779 * position in the broader display (referred to as a 'screen' though it could
780 * span multiple monitors).
782 struct drm_connector
{
783 /** @dev: parent DRM device */
784 struct drm_device
*dev
;
785 /** @kdev: kernel device for sysfs attributes */
787 /** @attr: sysfs attributes */
788 struct device_attribute
*attr
;
793 * List of all connectors on a @dev, linked from
794 * &drm_mode_config.connector_list. Protected by
795 * &drm_mode_config.connector_list_lock, but please only use
796 * &drm_connector_list_iter to walk this list.
798 struct list_head head
;
800 /** @base: base KMS object */
801 struct drm_mode_object base
;
803 /** @name: human readable name, can be overwritten by the driver */
807 * @mutex: Lock for general connector state, but currently only protects
808 * @registered. Most of the connector state is still protected by
809 * &drm_mode_config.mutex.
814 * @index: Compacted connector index, which matches the position inside
815 * the mode_config.list for drivers not supporting hot-add/removing. Can
816 * be used as an array index. It is invariant over the lifetime of the
823 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
826 /** @connector_type_id: index into connector type enum */
827 int connector_type_id
;
829 * @interlace_allowed:
830 * Can this connector handle interlaced modes? Only used by
831 * drm_helper_probe_single_connector_modes() for mode filtering.
833 bool interlace_allowed
;
835 * @doublescan_allowed:
836 * Can this connector handle doublescan? Only used by
837 * drm_helper_probe_single_connector_modes() for mode filtering.
839 bool doublescan_allowed
;
842 * Can this connector handle stereo modes? Only used by
843 * drm_helper_probe_single_connector_modes() for mode filtering.
848 * @ycbcr_420_allowed : This bool indicates if this connector is
849 * capable of handling YCBCR 420 output. While parsing the EDID
850 * blocks, its very helpful to know, if the source is capable of
851 * handling YCBCR 420 outputs.
853 bool ycbcr_420_allowed
;
856 * @registered: Is this connector exposed (registered) with userspace?
857 * Protected by @mutex.
863 * Modes available on this connector (from fill_modes() + user).
864 * Protected by &drm_mode_config.mutex.
866 struct list_head modes
;
870 * One of the drm_connector_status enums (connected, not, or unknown).
871 * Protected by &drm_mode_config.mutex.
873 enum drm_connector_status status
;
877 * These are modes added by probing with DDC or the BIOS, before
878 * filtering is applied. Used by the probe helpers. Protected by
879 * &drm_mode_config.mutex.
881 struct list_head probed_modes
;
884 * @display_info: Display information is filled from EDID information
885 * when a display is detected. For non hot-pluggable displays such as
886 * flat panels in embedded systems, the driver should initialize the
887 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
888 * with the physical size of the display.
890 * Protected by &drm_mode_config.mutex.
892 struct drm_display_info display_info
;
894 /** @funcs: connector control functions */
895 const struct drm_connector_funcs
*funcs
;
898 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
899 * &drm_mode_config.mutex. This should be updated only by calling
900 * drm_connector_update_edid_property().
902 struct drm_property_blob
*edid_blob_ptr
;
904 /** @properties: property tracking for this connector */
905 struct drm_object_properties properties
;
908 * @scaling_mode_property: Optional atomic property to control the
909 * upscaling. See drm_connector_attach_content_protection_property().
911 struct drm_property
*scaling_mode_property
;
914 * @content_protection_property: DRM ENUM property for content
915 * protection. See drm_connector_attach_content_protection_property().
917 struct drm_property
*content_protection_property
;
922 * DRM blob property data for the DP MST path property. This should only
923 * be updated by calling drm_connector_set_path_property().
925 struct drm_property_blob
*path_blob_ptr
;
927 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
928 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
929 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
934 * Connector polling mode, a combination of
936 * DRM_CONNECTOR_POLL_HPD
937 * The connector generates hotplug events and doesn't need to be
938 * periodically polled. The CONNECT and DISCONNECT flags must not
939 * be set together with the HPD flag.
941 * DRM_CONNECTOR_POLL_CONNECT
942 * Periodically poll the connector for connection.
944 * DRM_CONNECTOR_POLL_DISCONNECT
945 * Periodically poll the connector for disconnection, without
946 * causing flickering even when the connector is in use. DACs should
947 * rarely do this without a lot of testing.
949 * Set to 0 for connectors that don't support connection status
955 * @dpms: Current dpms state. For legacy drivers the
956 * &drm_connector_funcs.dpms callback must update this. For atomic
957 * drivers, this is handled by the core atomic code, and drivers must
958 * only take &drm_crtc_state.active into account.
962 /** @helper_private: mid-layer private data */
963 const struct drm_connector_helper_funcs
*helper_private
;
965 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
966 struct drm_cmdline_mode cmdline_mode
;
967 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
968 enum drm_connector_force force
;
969 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
972 #define DRM_CONNECTOR_MAX_ENCODER 3
974 * @encoder_ids: Valid encoders for this connector. Please only use
975 * drm_connector_for_each_possible_encoder() to enumerate these.
977 uint32_t encoder_ids
[DRM_CONNECTOR_MAX_ENCODER
];
980 * @encoder: Currently bound encoder driving this connector, if any.
981 * Only really meaningful for non-atomic drivers. Atomic drivers should
982 * instead look at &drm_connector_state.best_encoder, and in case they
983 * need the CRTC driving this output, &drm_connector_state.crtc.
985 struct drm_encoder
*encoder
;
987 #define MAX_ELD_BYTES 128
988 /** @eld: EDID-like data, if present */
989 uint8_t eld
[MAX_ELD_BYTES
];
990 /** @latency_present: AV delay info from ELD, if found */
991 bool latency_present
[2];
993 * @video_latency: Video latency info from ELD, if found.
994 * [0]: progressive, [1]: interlaced
996 int video_latency
[2];
998 * @audio_latency: audio latency info from ELD, if found
999 * [0]: progressive, [1]: interlaced
1001 int audio_latency
[2];
1003 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1004 * Needed to workaround some HW bugs where we get all 0s
1006 int null_edid_counter
;
1008 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1009 unsigned bad_edid_counter
;
1012 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1013 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1018 /** @debugfs_entry: debugfs directory for this connector */
1019 struct dentry
*debugfs_entry
;
1024 * Current atomic state for this connector.
1026 * This is protected by &drm_mode_config.connection_mutex. Note that
1027 * nonblocking atomic commits access the current connector state without
1028 * taking locks. Either by going through the &struct drm_atomic_state
1029 * pointers, see for_each_oldnew_connector_in_state(),
1030 * for_each_old_connector_in_state() and
1031 * for_each_new_connector_in_state(). Or through careful ordering of
1032 * atomic commit operations as implemented in the atomic helpers, see
1033 * &struct drm_crtc_commit.
1035 struct drm_connector_state
*state
;
1037 /* DisplayID bits. FIXME: Extract into a substruct? */
1042 * DRM blob property data for the tile property (used mostly by DP MST).
1043 * This is meant for screens which are driven through separate display
1044 * pipelines represented by &drm_crtc, which might not be running with
1045 * genlocked clocks. For tiled panels which are genlocked, like
1046 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1047 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1049 * This should only be updated by calling
1050 * drm_connector_set_tile_property().
1052 struct drm_property_blob
*tile_blob_ptr
;
1054 /** @has_tile: is this connector connected to a tiled monitor */
1056 /** @tile_group: tile group for the connected monitor */
1057 struct drm_tile_group
*tile_group
;
1058 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1059 bool tile_is_single_monitor
;
1061 /** @num_h_tile: number of horizontal tiles in the tile group */
1062 /** @num_v_tile: number of vertical tiles in the tile group */
1063 uint8_t num_h_tile
, num_v_tile
;
1064 /** @tile_h_loc: horizontal location of this tile */
1065 /** @tile_v_loc: vertical location of this tile */
1066 uint8_t tile_h_loc
, tile_v_loc
;
1067 /** @tile_h_size: horizontal size of this tile. */
1068 /** @tile_v_size: vertical size of this tile. */
1069 uint16_t tile_h_size
, tile_v_size
;
1074 * List used only by &drm_connector_list_iter to be able to clean up a
1075 * connector from any context, in conjunction with
1076 * &drm_mode_config.connector_free_work.
1078 struct llist_node free_node
;
1081 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1083 int drm_connector_init(struct drm_device
*dev
,
1084 struct drm_connector
*connector
,
1085 const struct drm_connector_funcs
*funcs
,
1086 int connector_type
);
1087 int drm_connector_register(struct drm_connector
*connector
);
1088 void drm_connector_unregister(struct drm_connector
*connector
);
1089 int drm_connector_attach_encoder(struct drm_connector
*connector
,
1090 struct drm_encoder
*encoder
);
1092 void drm_connector_cleanup(struct drm_connector
*connector
);
1094 static inline unsigned int drm_connector_index(const struct drm_connector
*connector
)
1096 return connector
->index
;
1099 static inline u32
drm_connector_mask(const struct drm_connector
*connector
)
1101 return 1 << connector
->index
;
1105 * drm_connector_lookup - lookup connector object
1107 * @file_priv: drm file to check for lease against.
1108 * @id: connector object id
1110 * This function looks up the connector object specified by id
1111 * add takes a reference to it.
1113 static inline struct drm_connector
*drm_connector_lookup(struct drm_device
*dev
,
1114 struct drm_file
*file_priv
,
1117 struct drm_mode_object
*mo
;
1118 mo
= drm_mode_object_find(dev
, file_priv
, id
, DRM_MODE_OBJECT_CONNECTOR
);
1119 return mo
? obj_to_connector(mo
) : NULL
;
1123 * drm_connector_get - acquire a connector reference
1124 * @connector: DRM connector
1126 * This function increments the connector's refcount.
1128 static inline void drm_connector_get(struct drm_connector
*connector
)
1130 drm_mode_object_get(&connector
->base
);
1134 * drm_connector_put - release a connector reference
1135 * @connector: DRM connector
1137 * This function decrements the connector's reference count and frees the
1138 * object if the reference count drops to zero.
1140 static inline void drm_connector_put(struct drm_connector
*connector
)
1142 drm_mode_object_put(&connector
->base
);
1146 * drm_connector_reference - acquire a connector reference
1147 * @connector: DRM connector
1149 * This is a compatibility alias for drm_connector_get() and should not be
1152 static inline void drm_connector_reference(struct drm_connector
*connector
)
1154 drm_connector_get(connector
);
1158 * drm_connector_unreference - release a connector reference
1159 * @connector: DRM connector
1161 * This is a compatibility alias for drm_connector_put() and should not be
1164 static inline void drm_connector_unreference(struct drm_connector
*connector
)
1166 drm_connector_put(connector
);
1169 const char *drm_get_connector_status_name(enum drm_connector_status status
);
1170 const char *drm_get_subpixel_order_name(enum subpixel_order order
);
1171 const char *drm_get_dpms_name(int val
);
1172 const char *drm_get_dvi_i_subconnector_name(int val
);
1173 const char *drm_get_dvi_i_select_name(int val
);
1174 const char *drm_get_tv_subconnector_name(int val
);
1175 const char *drm_get_tv_select_name(int val
);
1176 const char *drm_get_content_protection_name(int val
);
1178 int drm_mode_create_dvi_i_properties(struct drm_device
*dev
);
1179 int drm_mode_create_tv_properties(struct drm_device
*dev
,
1180 unsigned int num_modes
,
1181 const char * const modes
[]);
1182 int drm_mode_create_scaling_mode_property(struct drm_device
*dev
);
1183 int drm_connector_attach_content_type_property(struct drm_connector
*dev
);
1184 int drm_connector_attach_scaling_mode_property(struct drm_connector
*connector
,
1185 u32 scaling_mode_mask
);
1186 int drm_connector_attach_content_protection_property(
1187 struct drm_connector
*connector
);
1188 int drm_mode_create_aspect_ratio_property(struct drm_device
*dev
);
1189 int drm_mode_create_content_type_property(struct drm_device
*dev
);
1190 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe
*frame
,
1191 const struct drm_connector_state
*conn_state
);
1193 int drm_mode_create_suggested_offset_properties(struct drm_device
*dev
);
1195 int drm_connector_set_path_property(struct drm_connector
*connector
,
1197 int drm_connector_set_tile_property(struct drm_connector
*connector
);
1198 int drm_connector_update_edid_property(struct drm_connector
*connector
,
1199 const struct edid
*edid
);
1200 void drm_connector_set_link_status_property(struct drm_connector
*connector
,
1201 uint64_t link_status
);
1202 int drm_connector_init_panel_orientation_property(
1203 struct drm_connector
*connector
, int width
, int height
);
1206 * struct drm_tile_group - Tile group metadata
1207 * @refcount: reference count
1209 * @id: tile group id exposed to userspace
1210 * @group_data: Sink-private data identifying this group
1212 * @group_data corresponds to displayid vend/prod/serial for external screens
1215 struct drm_tile_group
{
1216 struct kref refcount
;
1217 struct drm_device
*dev
;
1222 struct drm_tile_group
*drm_mode_create_tile_group(struct drm_device
*dev
,
1224 struct drm_tile_group
*drm_mode_get_tile_group(struct drm_device
*dev
,
1226 void drm_mode_put_tile_group(struct drm_device
*dev
,
1227 struct drm_tile_group
*tg
);
1230 * struct drm_connector_list_iter - connector_list iterator
1232 * This iterator tracks state needed to be able to walk the connector_list
1233 * within struct drm_mode_config. Only use together with
1234 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1235 * drm_connector_list_iter_next() respectively the convenience macro
1236 * drm_for_each_connector_iter().
1238 struct drm_connector_list_iter
{
1240 struct drm_device
*dev
;
1241 struct drm_connector
*conn
;
1244 void drm_connector_list_iter_begin(struct drm_device
*dev
,
1245 struct drm_connector_list_iter
*iter
);
1246 struct drm_connector
*
1247 drm_connector_list_iter_next(struct drm_connector_list_iter
*iter
);
1248 void drm_connector_list_iter_end(struct drm_connector_list_iter
*iter
);
1250 bool drm_connector_has_possible_encoder(struct drm_connector
*connector
,
1251 struct drm_encoder
*encoder
);
1254 * drm_for_each_connector_iter - connector_list iterator macro
1255 * @connector: &struct drm_connector pointer used as cursor
1256 * @iter: &struct drm_connector_list_iter
1258 * Note that @connector is only valid within the list body, if you want to use
1259 * @connector after calling drm_connector_list_iter_end() then you need to grab
1260 * your own reference first using drm_connector_get().
1262 #define drm_for_each_connector_iter(connector, iter) \
1263 while ((connector = drm_connector_list_iter_next(iter)))
1266 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1267 * @connector: &struct drm_connector pointer
1268 * @encoder: &struct drm_encoder pointer used as cursor
1269 * @__i: int iteration cursor, for macro-internal use
1271 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \
1272 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \
1273 (connector)->encoder_ids[(__i)] != 0; (__i)++) \
1274 for_each_if((encoder) = \
1275 drm_encoder_find((connector)->dev, NULL, \
1276 (connector)->encoder_ids[(__i)])) \