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 * struct drm_display_info - runtime data about the connected sink
259 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
260 * fixed display sinks like built-in panels there's not much difference between
261 * this and &struct drm_connector. But for sinks with a real cable this
262 * structure is meant to describe all the things at the other end of the cable.
264 * For sinks which provide an EDID this can be filled out by calling
265 * drm_add_edid_modes().
267 struct drm_display_info {
269 * @name: Name of the display.
271 char name[DRM_DISPLAY_INFO_LEN];
274 * @width_mm: Physical width in mm.
276 unsigned int width_mm;
278 * @height_mm: Physical height in mm.
280 unsigned int height_mm;
283 * @pixel_clock: Maximum pixel clock supported by the sink, in units of
284 * 100Hz. This mismatches the clock in &drm_display_mode (which is in
285 * kHZ), because that's what the EDID uses as base unit.
287 unsigned int pixel_clock;
289 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
294 * @subpixel_order: Subpixel order of LCD panels.
296 enum subpixel_order subpixel_order;
298 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
299 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
300 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
301 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3)
304 * @panel_orientation: Read only connector property for built-in panels,
305 * indicating the orientation of the panel vs the device's casing.
306 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
307 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
308 * fb to compensate and gets exported as prop to userspace.
310 int panel_orientation;
313 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
314 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
315 * as used to describe the pixel format in framebuffers, and also don't
316 * match the formats in @bus_formats which are shared with v4l.
321 * @bus_formats: Pixel data format on the wire, somewhat redundant with
322 * @color_formats. Array of size @num_bus_formats encoded using
323 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
325 const u32 *bus_formats;
327 * @num_bus_formats: Size of @bus_formats array.
329 unsigned int num_bus_formats;
331 #define DRM_BUS_FLAG_DE_LOW (1<<0)
332 #define DRM_BUS_FLAG_DE_HIGH (1<<1)
335 * Don't use those two flags directly, use the DRM_BUS_FLAG_PIXDATA_DRIVE_*
336 * and DRM_BUS_FLAG_PIXDATA_SAMPLE_* variants to qualify the flags explicitly.
337 * The DRM_BUS_FLAG_PIXDATA_SAMPLE_* flags are defined as the opposite of the
338 * DRM_BUS_FLAG_PIXDATA_DRIVE_* flags to make code simpler, as signals are
339 * usually to be sampled on the opposite edge of the driving edge.
341 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
342 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
344 /* Drive data on rising edge */
345 #define DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE DRM_BUS_FLAG_PIXDATA_POSEDGE
346 /* Drive data on falling edge */
347 #define DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE DRM_BUS_FLAG_PIXDATA_NEGEDGE
348 /* Sample data on rising edge */
349 #define DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE DRM_BUS_FLAG_PIXDATA_NEGEDGE
350 /* Sample data on falling edge */
351 #define DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE DRM_BUS_FLAG_PIXDATA_POSEDGE
353 /* data is transmitted MSB to LSB on the bus */
354 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4)
355 /* data is transmitted LSB to MSB on the bus */
356 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5)
359 * Similarly to the DRM_BUS_FLAG_PIXDATA_* flags, don't use these two flags
360 * directly, use one of the DRM_BUS_FLAG_SYNC_(DRIVE|SAMPLE)_* instead.
362 #define DRM_BUS_FLAG_SYNC_POSEDGE (1<<6)
363 #define DRM_BUS_FLAG_SYNC_NEGEDGE (1<<7)
365 /* Drive sync on rising edge */
366 #define DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE DRM_BUS_FLAG_SYNC_POSEDGE
367 /* Drive sync on falling edge */
368 #define DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE DRM_BUS_FLAG_SYNC_NEGEDGE
369 /* Sample sync on rising edge */
370 #define DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE DRM_BUS_FLAG_SYNC_NEGEDGE
371 /* Sample sync on falling edge */
372 #define DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE DRM_BUS_FLAG_SYNC_POSEDGE
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 * @writeback_job: Writeback job for writeback connectors
536 * Holds the framebuffer and out-fence for a writeback connector. As
537 * the writeback completion may be asynchronous to the normal commit
538 * cycle, the writeback job lifetime is managed separately from the
539 * normal atomic state by this object.
541 * See also: drm_writeback_queue_job() and
542 * drm_writeback_signal_completion()
544 struct drm_writeback_job *writeback_job;
547 * @max_requested_bpc: Connector property to limit the maximum bit
548 * depth of the pixels.
550 u8 max_requested_bpc;
553 * @max_bpc: Connector max_bpc based on the requested max_bpc property
554 * and the connector bpc limitations obtained from edid.
560 * struct drm_connector_funcs - control connectors on a given device
562 * Each CRTC may have one or more connectors attached to it. The functions
563 * below allow the core DRM code to control connectors, enumerate available modes,
566 struct drm_connector_funcs {
570 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
571 * is exposed as a standard property on the connector, but diverted to
572 * this callback in the drm core. Note that atomic drivers don't
573 * implement the 4 level DPMS support on the connector any more, but
574 * instead only have an on/off "ACTIVE" property on the CRTC object.
576 * This hook is not used by atomic drivers, remapping of the legacy DPMS
577 * property is entirely handled in the DRM core.
581 * 0 on success or a negative error code on failure.
583 int (*dpms)(struct drm_connector *connector, int mode);
588 * Reset connector hardware and software state to off. This function isn't
589 * called by the core directly, only through drm_mode_config_reset().
590 * It's not a helper hook only for historical reasons.
592 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
593 * atomic state using this hook.
595 void (*reset)(struct drm_connector *connector);
600 * Check to see if anything is attached to the connector. The parameter
601 * force is set to false whilst polling, true when checking the
602 * connector due to a user request. force can be used by the driver to
603 * avoid expensive, destructive operations during automated probing.
605 * This callback is optional, if not implemented the connector will be
606 * considered as always being attached.
610 * Note that this hook is only called by the probe helper. It's not in
611 * the helper library vtable purely for historical reasons. The only DRM
612 * core entry point to probe connector state is @fill_modes.
614 * Note that the helper library will already hold
615 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
616 * locks to avoid races with concurrent modeset changes need to use
617 * &drm_connector_helper_funcs.detect_ctx instead.
621 * drm_connector_status indicating the connector's status.
623 enum drm_connector_status (*detect)(struct drm_connector *connector,
629 * This function is called to update internal encoder state when the
630 * connector is forced to a certain state by userspace, either through
631 * the sysfs interfaces or on the kernel cmdline. In that case the
632 * @detect callback isn't called.
636 * Note that this hook is only called by the probe helper. It's not in
637 * the helper library vtable purely for historical reasons. The only DRM
638 * core entry point to probe connector state is @fill_modes.
640 void (*force)(struct drm_connector *connector);
645 * Entry point for output detection and basic mode validation. The
646 * driver should reprobe the output if needed (e.g. when hotplug
647 * handling is unreliable), add all detected modes to &drm_connector.modes
648 * and filter out any the device can't support in any configuration. It
649 * also needs to filter out any modes wider or higher than the
650 * parameters max_width and max_height indicate.
652 * The drivers must also prune any modes no longer valid from
653 * &drm_connector.modes. Furthermore it must update
654 * &drm_connector.status and &drm_connector.edid. If no EDID has been
655 * received for this output connector->edid must be NULL.
657 * Drivers using the probe helpers should use
658 * drm_helper_probe_single_connector_modes() to implement this
663 * The number of modes detected and filled into &drm_connector.modes.
665 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
670 * This is the legacy entry point to update a property attached to the
673 * This callback is optional if the driver does not support any legacy
674 * driver-private properties. For atomic drivers it is not used because
675 * property handling is done entirely in the DRM core.
679 * 0 on success or a negative error code on failure.
681 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
687 * This optional hook can be used to register additional userspace
688 * interfaces attached to the connector, light backlight control, i2c,
689 * DP aux or similar interfaces. It is called late in the driver load
690 * sequence from drm_connector_register() when registering all the
691 * core drm connector interfaces. Everything added from this callback
692 * should be unregistered in the early_unregister callback.
694 * This is called while holding &drm_connector.mutex.
698 * 0 on success, or a negative error code on failure.
700 int (*late_register)(struct drm_connector *connector);
705 * This optional hook should be used to unregister the additional
706 * userspace interfaces attached to the connector from
707 * late_register(). It is called from drm_connector_unregister(),
708 * early in the driver unload sequence to disable userspace access
709 * before data structures are torndown.
711 * This is called while holding &drm_connector.mutex.
713 void (*early_unregister)(struct drm_connector *connector);
718 * Clean up connector resources. This is called at driver unload time
719 * through drm_mode_config_cleanup(). It can also be called at runtime
720 * when a connector is being hot-unplugged for drivers that support
721 * connector hotplugging (e.g. DisplayPort MST).
723 void (*destroy)(struct drm_connector *connector);
726 * @atomic_duplicate_state:
728 * Duplicate the current atomic state for this connector and return it.
729 * The core and helpers guarantee that any atomic state duplicated with
730 * this hook and still owned by the caller (i.e. not transferred to the
731 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
732 * cleaned up by calling the @atomic_destroy_state hook in this
735 * This callback is mandatory for atomic drivers.
737 * Atomic drivers which don't subclass &struct drm_connector_state should use
738 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
739 * state structure to extend it with driver-private state should use
740 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
741 * duplicated in a consistent fashion across drivers.
743 * It is an error to call this hook before &drm_connector.state has been
744 * initialized correctly.
748 * If the duplicate state references refcounted resources this hook must
749 * acquire a reference for each of them. The driver must release these
750 * references again in @atomic_destroy_state.
754 * Duplicated atomic state or NULL when the allocation failed.
756 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
759 * @atomic_destroy_state:
761 * Destroy a state duplicated with @atomic_duplicate_state and release
762 * or unreference all resources it references
764 * This callback is mandatory for atomic drivers.
766 void (*atomic_destroy_state)(struct drm_connector *connector,
767 struct drm_connector_state *state);
770 * @atomic_set_property:
772 * Decode a driver-private property value and store the decoded value
773 * into the passed-in state structure. Since the atomic core decodes all
774 * standardized properties (even for extensions beyond the core set of
775 * properties which might not be implemented by all drivers) this
776 * requires drivers to subclass the state structure.
778 * Such driver-private properties should really only be implemented for
779 * truly hardware/vendor specific state. Instead it is preferred to
780 * standardize atomic extension and decode the properties used to expose
781 * such an extension in the core.
783 * Do not call this function directly, use
784 * drm_atomic_connector_set_property() instead.
786 * This callback is optional if the driver does not support any
787 * driver-private atomic properties.
791 * This function is called in the state assembly phase of atomic
792 * modesets, which can be aborted for any reason (including on
793 * userspace's request to just check whether a configuration would be
794 * possible). Drivers MUST NOT touch any persistent state (hardware or
795 * software) or data structures except the passed in @state parameter.
797 * Also since userspace controls in which order properties are set this
798 * function must not do any input validation (since the state update is
799 * incomplete and hence likely inconsistent). Instead any such input
800 * validation must be done in the various atomic_check callbacks.
804 * 0 if the property has been found, -EINVAL if the property isn't
805 * implemented by the driver (which shouldn't ever happen, the core only
806 * asks for properties attached to this connector). No other validation
807 * is allowed by the driver. The core already checks that the property
808 * value is within the range (integer, valid enum value, ...) the driver
809 * set when registering the property.
811 int (*atomic_set_property)(struct drm_connector *connector,
812 struct drm_connector_state *state,
813 struct drm_property *property,
817 * @atomic_get_property:
819 * Reads out the decoded driver-private property. This is used to
820 * implement the GETCONNECTOR IOCTL.
822 * Do not call this function directly, use
823 * drm_atomic_connector_get_property() instead.
825 * This callback is optional if the driver does not support any
826 * driver-private atomic properties.
830 * 0 on success, -EINVAL if the property isn't implemented by the
831 * driver (which shouldn't ever happen, the core only asks for
832 * properties attached to this connector).
834 int (*atomic_get_property)(struct drm_connector *connector,
835 const struct drm_connector_state *state,
836 struct drm_property *property,
840 * @atomic_print_state:
842 * If driver subclasses &struct drm_connector_state, it should implement
843 * this optional hook for printing additional driver specific state.
845 * Do not call this directly, use drm_atomic_connector_print_state()
848 void (*atomic_print_state)(struct drm_printer *p,
849 const struct drm_connector_state *state);
852 /* mode specified on the command line */
853 struct drm_cmdline_mode {
855 bool refresh_specified;
864 enum drm_connector_force force;
868 * struct drm_connector - central DRM connector control structure
870 * Each connector may be connected to one or more CRTCs, or may be clonable by
871 * another connector if they can share a CRTC. Each connector also has a specific
872 * position in the broader display (referred to as a 'screen' though it could
873 * span multiple monitors).
875 struct drm_connector {
876 /** @dev: parent DRM device */
877 struct drm_device *dev;
878 /** @kdev: kernel device for sysfs attributes */
880 /** @attr: sysfs attributes */
881 struct device_attribute *attr;
886 * List of all connectors on a @dev, linked from
887 * &drm_mode_config.connector_list. Protected by
888 * &drm_mode_config.connector_list_lock, but please only use
889 * &drm_connector_list_iter to walk this list.
891 struct list_head head;
893 /** @base: base KMS object */
894 struct drm_mode_object base;
896 /** @name: human readable name, can be overwritten by the driver */
900 * @mutex: Lock for general connector state, but currently only protects
901 * @registered. Most of the connector state is still protected by
902 * &drm_mode_config.mutex.
907 * @index: Compacted connector index, which matches the position inside
908 * the mode_config.list for drivers not supporting hot-add/removing. Can
909 * be used as an array index. It is invariant over the lifetime of the
916 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
919 /** @connector_type_id: index into connector type enum */
920 int connector_type_id;
922 * @interlace_allowed:
923 * Can this connector handle interlaced modes? Only used by
924 * drm_helper_probe_single_connector_modes() for mode filtering.
926 bool interlace_allowed;
928 * @doublescan_allowed:
929 * Can this connector handle doublescan? Only used by
930 * drm_helper_probe_single_connector_modes() for mode filtering.
932 bool doublescan_allowed;
935 * Can this connector handle stereo modes? Only used by
936 * drm_helper_probe_single_connector_modes() for mode filtering.
941 * @ycbcr_420_allowed : This bool indicates if this connector is
942 * capable of handling YCBCR 420 output. While parsing the EDID
943 * blocks it's very helpful to know if the source is capable of
944 * handling YCBCR 420 outputs.
946 bool ycbcr_420_allowed;
949 * @registration_state: Is this connector initializing, exposed
950 * (registered) with userspace, or unregistered?
952 * Protected by @mutex.
954 enum drm_connector_registration_state registration_state;
958 * Modes available on this connector (from fill_modes() + user).
959 * Protected by &drm_mode_config.mutex.
961 struct list_head modes;
965 * One of the drm_connector_status enums (connected, not, or unknown).
966 * Protected by &drm_mode_config.mutex.
968 enum drm_connector_status status;
972 * These are modes added by probing with DDC or the BIOS, before
973 * filtering is applied. Used by the probe helpers. Protected by
974 * &drm_mode_config.mutex.
976 struct list_head probed_modes;
979 * @display_info: Display information is filled from EDID information
980 * when a display is detected. For non hot-pluggable displays such as
981 * flat panels in embedded systems, the driver should initialize the
982 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
983 * with the physical size of the display.
985 * Protected by &drm_mode_config.mutex.
987 struct drm_display_info display_info;
989 /** @funcs: connector control functions */
990 const struct drm_connector_funcs *funcs;
993 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
994 * &drm_mode_config.mutex. This should be updated only by calling
995 * drm_connector_update_edid_property().
997 struct drm_property_blob *edid_blob_ptr;
999 /** @properties: property tracking for this connector */
1000 struct drm_object_properties properties;
1003 * @scaling_mode_property: Optional atomic property to control the
1004 * upscaling. See drm_connector_attach_content_protection_property().
1006 struct drm_property *scaling_mode_property;
1009 * @vrr_capable_property: Optional property to help userspace
1010 * query hardware support for variable refresh rate on a connector.
1011 * connector. Drivers can add the property to a connector by
1012 * calling drm_connector_attach_vrr_capable_property().
1014 * This should be updated only by calling
1015 * drm_connector_set_vrr_capable_property().
1017 struct drm_property *vrr_capable_property;
1020 * @content_protection_property: DRM ENUM property for content
1021 * protection. See drm_connector_attach_content_protection_property().
1023 struct drm_property *content_protection_property;
1028 * DRM blob property data for the DP MST path property. This should only
1029 * be updated by calling drm_connector_set_path_property().
1031 struct drm_property_blob *path_blob_ptr;
1034 * @max_bpc_property: Default connector property for the max bpc to be
1035 * driven out of the connector.
1037 struct drm_property *max_bpc_property;
1039 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1040 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1041 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1046 * Connector polling mode, a combination of
1048 * DRM_CONNECTOR_POLL_HPD
1049 * The connector generates hotplug events and doesn't need to be
1050 * periodically polled. The CONNECT and DISCONNECT flags must not
1051 * be set together with the HPD flag.
1053 * DRM_CONNECTOR_POLL_CONNECT
1054 * Periodically poll the connector for connection.
1056 * DRM_CONNECTOR_POLL_DISCONNECT
1057 * Periodically poll the connector for disconnection, without
1058 * causing flickering even when the connector is in use. DACs should
1059 * rarely do this without a lot of testing.
1061 * Set to 0 for connectors that don't support connection status
1067 * @dpms: Current dpms state. For legacy drivers the
1068 * &drm_connector_funcs.dpms callback must update this. For atomic
1069 * drivers, this is handled by the core atomic code, and drivers must
1070 * only take &drm_crtc_state.active into account.
1074 /** @helper_private: mid-layer private data */
1075 const struct drm_connector_helper_funcs *helper_private;
1077 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1078 struct drm_cmdline_mode cmdline_mode;
1079 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1080 enum drm_connector_force force;
1081 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1084 #define DRM_CONNECTOR_MAX_ENCODER 3
1086 * @encoder_ids: Valid encoders for this connector. Please only use
1087 * drm_connector_for_each_possible_encoder() to enumerate these.
1089 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
1092 * @encoder: Currently bound encoder driving this connector, if any.
1093 * Only really meaningful for non-atomic drivers. Atomic drivers should
1094 * instead look at &drm_connector_state.best_encoder, and in case they
1095 * need the CRTC driving this output, &drm_connector_state.crtc.
1097 struct drm_encoder *encoder;
1099 #define MAX_ELD_BYTES 128
1100 /** @eld: EDID-like data, if present */
1101 uint8_t eld[MAX_ELD_BYTES];
1102 /** @latency_present: AV delay info from ELD, if found */
1103 bool latency_present[2];
1105 * @video_latency: Video latency info from ELD, if found.
1106 * [0]: progressive, [1]: interlaced
1108 int video_latency[2];
1110 * @audio_latency: audio latency info from ELD, if found
1111 * [0]: progressive, [1]: interlaced
1113 int audio_latency[2];
1115 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1116 * Needed to workaround some HW bugs where we get all 0s
1118 int null_edid_counter;
1120 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1121 unsigned bad_edid_counter;
1124 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1125 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1130 /** @debugfs_entry: debugfs directory for this connector */
1131 struct dentry *debugfs_entry;
1136 * Current atomic state for this connector.
1138 * This is protected by &drm_mode_config.connection_mutex. Note that
1139 * nonblocking atomic commits access the current connector state without
1140 * taking locks. Either by going through the &struct drm_atomic_state
1141 * pointers, see for_each_oldnew_connector_in_state(),
1142 * for_each_old_connector_in_state() and
1143 * for_each_new_connector_in_state(). Or through careful ordering of
1144 * atomic commit operations as implemented in the atomic helpers, see
1145 * &struct drm_crtc_commit.
1147 struct drm_connector_state *state;
1149 /* DisplayID bits. FIXME: Extract into a substruct? */
1154 * DRM blob property data for the tile property (used mostly by DP MST).
1155 * This is meant for screens which are driven through separate display
1156 * pipelines represented by &drm_crtc, which might not be running with
1157 * genlocked clocks. For tiled panels which are genlocked, like
1158 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1159 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1161 * This should only be updated by calling
1162 * drm_connector_set_tile_property().
1164 struct drm_property_blob *tile_blob_ptr;
1166 /** @has_tile: is this connector connected to a tiled monitor */
1168 /** @tile_group: tile group for the connected monitor */
1169 struct drm_tile_group *tile_group;
1170 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1171 bool tile_is_single_monitor;
1173 /** @num_h_tile: number of horizontal tiles in the tile group */
1174 /** @num_v_tile: number of vertical tiles in the tile group */
1175 uint8_t num_h_tile, num_v_tile;
1176 /** @tile_h_loc: horizontal location of this tile */
1177 /** @tile_v_loc: vertical location of this tile */
1178 uint8_t tile_h_loc, tile_v_loc;
1179 /** @tile_h_size: horizontal size of this tile. */
1180 /** @tile_v_size: vertical size of this tile. */
1181 uint16_t tile_h_size, tile_v_size;
1186 * List used only by &drm_connector_list_iter to be able to clean up a
1187 * connector from any context, in conjunction with
1188 * &drm_mode_config.connector_free_work.
1190 struct llist_node free_node;
1193 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1195 int drm_connector_init(struct drm_device *dev,
1196 struct drm_connector *connector,
1197 const struct drm_connector_funcs *funcs,
1198 int connector_type);
1199 void drm_connector_attach_edid_property(struct drm_connector *connector);
1200 int drm_connector_register(struct drm_connector *connector);
1201 void drm_connector_unregister(struct drm_connector *connector);
1202 int drm_connector_attach_encoder(struct drm_connector *connector,
1203 struct drm_encoder *encoder);
1205 void drm_connector_cleanup(struct drm_connector *connector);
1207 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1209 return connector->index;
1212 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1214 return 1 << connector->index;
1218 * drm_connector_lookup - lookup connector object
1220 * @file_priv: drm file to check for lease against.
1221 * @id: connector object id
1223 * This function looks up the connector object specified by id
1224 * add takes a reference to it.
1226 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1227 struct drm_file *file_priv,
1230 struct drm_mode_object *mo;
1231 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1232 return mo ? obj_to_connector(mo) : NULL;
1236 * drm_connector_get - acquire a connector reference
1237 * @connector: DRM connector
1239 * This function increments the connector's refcount.
1241 static inline void drm_connector_get(struct drm_connector *connector)
1243 drm_mode_object_get(&connector->base);
1247 * drm_connector_put - release a connector reference
1248 * @connector: DRM connector
1250 * This function decrements the connector's reference count and frees the
1251 * object if the reference count drops to zero.
1253 static inline void drm_connector_put(struct drm_connector *connector)
1255 drm_mode_object_put(&connector->base);
1259 * drm_connector_is_unregistered - has the connector been unregistered from
1261 * @connector: DRM connector
1263 * Checks whether or not @connector has been unregistered from userspace.
1266 * True if the connector was unregistered, false if the connector is
1267 * registered or has not yet been registered with userspace.
1270 drm_connector_is_unregistered(struct drm_connector *connector)
1272 return READ_ONCE(connector->registration_state) ==
1273 DRM_CONNECTOR_UNREGISTERED;
1276 const char *drm_get_connector_status_name(enum drm_connector_status status);
1277 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1278 const char *drm_get_dpms_name(int val);
1279 const char *drm_get_dvi_i_subconnector_name(int val);
1280 const char *drm_get_dvi_i_select_name(int val);
1281 const char *drm_get_tv_subconnector_name(int val);
1282 const char *drm_get_tv_select_name(int val);
1283 const char *drm_get_content_protection_name(int val);
1285 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1286 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1287 int drm_mode_create_tv_properties(struct drm_device *dev,
1288 unsigned int num_modes,
1289 const char * const modes[]);
1290 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1291 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1292 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1293 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1294 u32 scaling_mode_mask);
1295 int drm_connector_attach_vrr_capable_property(
1296 struct drm_connector *connector);
1297 int drm_connector_attach_content_protection_property(
1298 struct drm_connector *connector);
1299 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1300 int drm_mode_create_content_type_property(struct drm_device *dev);
1301 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1302 const struct drm_connector_state *conn_state);
1304 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1306 int drm_connector_set_path_property(struct drm_connector *connector,
1308 int drm_connector_set_tile_property(struct drm_connector *connector);
1309 int drm_connector_update_edid_property(struct drm_connector *connector,
1310 const struct edid *edid);
1311 void drm_connector_set_link_status_property(struct drm_connector *connector,
1312 uint64_t link_status);
1313 void drm_connector_set_vrr_capable_property(
1314 struct drm_connector *connector, bool capable);
1315 int drm_connector_init_panel_orientation_property(
1316 struct drm_connector *connector, int width, int height);
1317 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1321 * struct drm_tile_group - Tile group metadata
1322 * @refcount: reference count
1324 * @id: tile group id exposed to userspace
1325 * @group_data: Sink-private data identifying this group
1327 * @group_data corresponds to displayid vend/prod/serial for external screens
1330 struct drm_tile_group {
1331 struct kref refcount;
1332 struct drm_device *dev;
1337 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1339 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1341 void drm_mode_put_tile_group(struct drm_device *dev,
1342 struct drm_tile_group *tg);
1345 * struct drm_connector_list_iter - connector_list iterator
1347 * This iterator tracks state needed to be able to walk the connector_list
1348 * within struct drm_mode_config. Only use together with
1349 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1350 * drm_connector_list_iter_next() respectively the convenience macro
1351 * drm_for_each_connector_iter().
1353 struct drm_connector_list_iter {
1355 struct drm_device *dev;
1356 struct drm_connector *conn;
1359 void drm_connector_list_iter_begin(struct drm_device *dev,
1360 struct drm_connector_list_iter *iter);
1361 struct drm_connector *
1362 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1363 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1365 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1366 struct drm_encoder *encoder);
1369 * drm_for_each_connector_iter - connector_list iterator macro
1370 * @connector: &struct drm_connector pointer used as cursor
1371 * @iter: &struct drm_connector_list_iter
1373 * Note that @connector is only valid within the list body, if you want to use
1374 * @connector after calling drm_connector_list_iter_end() then you need to grab
1375 * your own reference first using drm_connector_get().
1377 #define drm_for_each_connector_iter(connector, iter) \
1378 while ((connector = drm_connector_list_iter_next(iter)))
1381 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1382 * @connector: &struct drm_connector pointer
1383 * @encoder: &struct drm_encoder pointer used as cursor
1384 * @__i: int iteration cursor, for macro-internal use
1386 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \
1387 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \
1388 (connector)->encoder_ids[(__i)] != 0; (__i)++) \
1389 for_each_if((encoder) = \
1390 drm_encoder_find((connector)->dev, NULL, \
1391 (connector)->encoder_ids[(__i)])) \