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/ctype.h>
28 #include <drm/drm_mode_object.h>
30 struct drm_connector_helper_funcs;
35 struct drm_property_blob;
38 enum drm_connector_force {
39 DRM_FORCE_UNSPECIFIED,
41 DRM_FORCE_ON, /* force on analog part normally */
42 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
46 * enum drm_connector_status - status for a &drm_connector
48 * This enum is used to track the connector status. There are no separate
49 * #defines for the uapi!
51 enum drm_connector_status {
53 * @connector_status_connected: The connector is definitely connected to
54 * a sink device, and can be enabled.
56 connector_status_connected = 1,
58 * @connector_status_disconnected: The connector isn't connected to a
59 * sink device which can be autodetect. For digital outputs like DP or
60 * HDMI (which can be realiable probed) this means there's really
61 * nothing there. It is driver-dependent whether a connector with this
62 * status can be lit up or not.
64 connector_status_disconnected = 2,
66 * @connector_status_unknown: The connector's status could not be
67 * reliably detected. This happens when probing would either cause
68 * flicker (like load-detection when the connector is in use), or when a
69 * hardware resource isn't available (like when load-detection needs a
70 * free CRTC). It should be possible to light up the connector with one
71 * of the listed fallback modes. For default configuration userspace
72 * should only try to light up connectors with unknown status when
73 * there's not connector with @connector_status_connected.
75 connector_status_unknown = 3,
80 SubPixelHorizontalRGB,
81 SubPixelHorizontalBGR,
88 * struct drm_display_info - runtime data about the connected sink
90 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
91 * fixed display sinks like built-in panels there's not much difference between
92 * this and struct &drm_connector. But for sinks with a real cable this
93 * structure is meant to describe all the things at the other end of the cable.
95 * For sinks which provide an EDID this can be filled out by calling
96 * drm_add_edid_modes().
98 struct drm_display_info {
100 * @name: Name of the display.
102 char name[DRM_DISPLAY_INFO_LEN];
105 * @width_mm: Physical width in mm.
107 unsigned int width_mm;
109 * @height_mm: Physical height in mm.
111 unsigned int height_mm;
114 * @pixel_clock: Maximum pixel clock supported by the sink, in units of
115 * 100Hz. This mismatches the clok in &drm_display_mode (which is in
116 * kHZ), because that's what the EDID uses as base unit.
118 unsigned int pixel_clock;
120 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
125 * @subpixel_order: Subpixel order of LCD panels.
127 enum subpixel_order subpixel_order;
129 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
130 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
131 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
134 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
135 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
136 * as used to describe the pixel format in framebuffers, and also don't
137 * match the formats in @bus_formats which are shared with v4l.
142 * @bus_formats: Pixel data format on the wire, somewhat redundant with
143 * @color_formats. Array of size @num_bus_formats encoded using
144 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
146 const u32 *bus_formats;
148 * @num_bus_formats: Size of @bus_formats array.
150 unsigned int num_bus_formats;
152 #define DRM_BUS_FLAG_DE_LOW (1<<0)
153 #define DRM_BUS_FLAG_DE_HIGH (1<<1)
154 /* drive data on pos. edge */
155 #define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
156 /* drive data on neg. edge */
157 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
160 * @bus_flags: Additional information (like pixel signal polarity) for
161 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines.
166 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
167 * more stuff redundant with @bus_formats.
169 u8 edid_hdmi_dc_modes;
172 * @cea_rev: CEA revision of the HDMI sink.
177 int drm_display_info_set_bus_formats(struct drm_display_info *info,
179 unsigned int num_formats);
182 * struct drm_connector_state - mutable connector state
183 * @connector: backpointer to the connector
184 * @best_encoder: can be used by helpers and drivers to select the encoder
185 * @state: backpointer to global drm_atomic_state
187 struct drm_connector_state {
188 struct drm_connector *connector;
191 * @crtc: CRTC to connect connector to, NULL if disabled.
193 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
196 struct drm_crtc *crtc;
198 struct drm_encoder *best_encoder;
200 struct drm_atomic_state *state;
204 * struct drm_connector_funcs - control connectors on a given device
206 * Each CRTC may have one or more connectors attached to it. The functions
207 * below allow the core DRM code to control connectors, enumerate available modes,
210 struct drm_connector_funcs {
214 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
215 * is exposed as a standard property on the connector, but diverted to
216 * this callback in the drm core. Note that atomic drivers don't
217 * implement the 4 level DPMS support on the connector any more, but
218 * instead only have an on/off "ACTIVE" property on the CRTC object.
220 * Drivers implementing atomic modeset should use
221 * drm_atomic_helper_connector_dpms() to implement this hook.
225 * 0 on success or a negative error code on failure.
227 int (*dpms)(struct drm_connector *connector, int mode);
232 * Reset connector hardware and software state to off. This function isn't
233 * called by the core directly, only through drm_mode_config_reset().
234 * It's not a helper hook only for historical reasons.
236 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
237 * atomic state using this hook.
239 void (*reset)(struct drm_connector *connector);
244 * Check to see if anything is attached to the connector. The parameter
245 * force is set to false whilst polling, true when checking the
246 * connector due to a user request. force can be used by the driver to
247 * avoid expensive, destructive operations during automated probing.
251 * Note that this hook is only called by the probe helper. It's not in
252 * the helper library vtable purely for historical reasons. The only DRM
253 * core entry point to probe connector state is @fill_modes.
257 * drm_connector_status indicating the connector's status.
259 enum drm_connector_status (*detect)(struct drm_connector *connector,
265 * This function is called to update internal encoder state when the
266 * connector is forced to a certain state by userspace, either through
267 * the sysfs interfaces or on the kernel cmdline. In that case the
268 * @detect callback isn't called.
272 * Note that this hook is only called by the probe helper. It's not in
273 * the helper library vtable purely for historical reasons. The only DRM
274 * core entry point to probe connector state is @fill_modes.
276 void (*force)(struct drm_connector *connector);
281 * Entry point for output detection and basic mode validation. The
282 * driver should reprobe the output if needed (e.g. when hotplug
283 * handling is unreliable), add all detected modes to connector->modes
284 * and filter out any the device can't support in any configuration. It
285 * also needs to filter out any modes wider or higher than the
286 * parameters max_width and max_height indicate.
288 * The drivers must also prune any modes no longer valid from
289 * connector->modes. Furthermore it must update connector->status and
290 * connector->edid. If no EDID has been received for this output
291 * connector->edid must be NULL.
293 * Drivers using the probe helpers should use
294 * drm_helper_probe_single_connector_modes() or
295 * drm_helper_probe_single_connector_modes_nomerge() to implement this
300 * The number of modes detected and filled into connector->modes.
302 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
307 * This is the legacy entry point to update a property attached to the
310 * Drivers implementing atomic modeset should use
311 * drm_atomic_helper_connector_set_property() to implement this hook.
313 * This callback is optional if the driver does not support any legacy
314 * driver-private properties.
318 * 0 on success or a negative error code on failure.
320 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
326 * This optional hook can be used to register additional userspace
327 * interfaces attached to the connector, light backlight control, i2c,
328 * DP aux or similar interfaces. It is called late in the driver load
329 * sequence from drm_connector_register() when registering all the
330 * core drm connector interfaces. Everything added from this callback
331 * should be unregistered in the early_unregister callback.
335 * 0 on success, or a negative error code on failure.
337 int (*late_register)(struct drm_connector *connector);
342 * This optional hook should be used to unregister the additional
343 * userspace interfaces attached to the connector from
344 * late_unregister(). It is called from drm_connector_unregister(),
345 * early in the driver unload sequence to disable userspace access
346 * before data structures are torndown.
348 void (*early_unregister)(struct drm_connector *connector);
353 * Clean up connector resources. This is called at driver unload time
354 * through drm_mode_config_cleanup(). It can also be called at runtime
355 * when a connector is being hot-unplugged for drivers that support
356 * connector hotplugging (e.g. DisplayPort MST).
358 void (*destroy)(struct drm_connector *connector);
361 * @atomic_duplicate_state:
363 * Duplicate the current atomic state for this connector and return it.
364 * The core and helpers gurantee that any atomic state duplicated with
365 * this hook and still owned by the caller (i.e. not transferred to the
366 * driver by calling ->atomic_commit() from struct
367 * &drm_mode_config_funcs) will be cleaned up by calling the
368 * @atomic_destroy_state hook in this structure.
370 * Atomic drivers which don't subclass struct &drm_connector_state should use
371 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
372 * state structure to extend it with driver-private state should use
373 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
374 * duplicated in a consistent fashion across drivers.
376 * It is an error to call this hook before connector->state has been
377 * initialized correctly.
381 * If the duplicate state references refcounted resources this hook must
382 * acquire a reference for each of them. The driver must release these
383 * references again in @atomic_destroy_state.
387 * Duplicated atomic state or NULL when the allocation failed.
389 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
392 * @atomic_destroy_state:
394 * Destroy a state duplicated with @atomic_duplicate_state and release
395 * or unreference all resources it references
397 void (*atomic_destroy_state)(struct drm_connector *connector,
398 struct drm_connector_state *state);
401 * @atomic_set_property:
403 * Decode a driver-private property value and store the decoded value
404 * into the passed-in state structure. Since the atomic core decodes all
405 * standardized properties (even for extensions beyond the core set of
406 * properties which might not be implemented by all drivers) this
407 * requires drivers to subclass the state structure.
409 * Such driver-private properties should really only be implemented for
410 * truly hardware/vendor specific state. Instead it is preferred to
411 * standardize atomic extension and decode the properties used to expose
412 * such an extension in the core.
414 * Do not call this function directly, use
415 * drm_atomic_connector_set_property() instead.
417 * This callback is optional if the driver does not support any
418 * driver-private atomic properties.
422 * This function is called in the state assembly phase of atomic
423 * modesets, which can be aborted for any reason (including on
424 * userspace's request to just check whether a configuration would be
425 * possible). Drivers MUST NOT touch any persistent state (hardware or
426 * software) or data structures except the passed in @state parameter.
428 * Also since userspace controls in which order properties are set this
429 * function must not do any input validation (since the state update is
430 * incomplete and hence likely inconsistent). Instead any such input
431 * validation must be done in the various atomic_check callbacks.
435 * 0 if the property has been found, -EINVAL if the property isn't
436 * implemented by the driver (which shouldn't ever happen, the core only
437 * asks for properties attached to this connector). No other validation
438 * is allowed by the driver. The core already checks that the property
439 * value is within the range (integer, valid enum value, ...) the driver
440 * set when registering the property.
442 int (*atomic_set_property)(struct drm_connector *connector,
443 struct drm_connector_state *state,
444 struct drm_property *property,
448 * @atomic_get_property:
450 * Reads out the decoded driver-private property. This is used to
451 * implement the GETCONNECTOR IOCTL.
453 * Do not call this function directly, use
454 * drm_atomic_connector_get_property() instead.
456 * This callback is optional if the driver does not support any
457 * driver-private atomic properties.
461 * 0 on success, -EINVAL if the property isn't implemented by the
462 * driver (which shouldn't ever happen, the core only asks for
463 * properties attached to this connector).
465 int (*atomic_get_property)(struct drm_connector *connector,
466 const struct drm_connector_state *state,
467 struct drm_property *property,
471 /* mode specified on the command line */
472 struct drm_cmdline_mode {
474 bool refresh_specified;
483 enum drm_connector_force force;
487 * struct drm_connector - central DRM connector control structure
488 * @dev: parent DRM device
489 * @kdev: kernel device for sysfs attributes
490 * @attr: sysfs attributes
491 * @head: list management
492 * @base: base KMS object
493 * @name: human readable name, can be overwritten by the driver
494 * @connector_type: one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
495 * @connector_type_id: index into connector type enum
496 * @interlace_allowed: can this connector handle interlaced modes?
497 * @doublescan_allowed: can this connector handle doublescan?
498 * @stereo_allowed: can this connector handle stereo modes?
499 * @registered: is this connector exposed (registered) with userspace?
500 * @modes: modes available on this connector (from fill_modes() + user)
501 * @status: one of the drm_connector_status enums (connected, not, or unknown)
502 * @probed_modes: list of modes derived directly from the display
503 * @funcs: connector control functions
504 * @edid_blob_ptr: DRM property containing EDID if present
505 * @properties: property tracking for this connector
506 * @dpms: current dpms state
507 * @helper_private: mid-layer private data
508 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
509 * @force: a DRM_FORCE_<foo> state for forced mode sets
510 * @override_edid: has the EDID been overwritten through debugfs for testing?
511 * @encoder_ids: valid encoders for this connector
512 * @encoder: encoder driving this connector, if any
513 * @eld: EDID-like data, if present
514 * @dvi_dual: dual link DVI, if found
515 * @max_tmds_clock: max clock rate, if found
516 * @latency_present: AV delay info from ELD, if found
517 * @video_latency: video latency info from ELD, if found
518 * @audio_latency: audio latency info from ELD, if found
519 * @null_edid_counter: track sinks that give us all zeros for the EDID
520 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
521 * @edid_corrupt: indicates whether the last read EDID was corrupt
522 * @debugfs_entry: debugfs directory for this connector
523 * @state: current atomic state for this connector
524 * @has_tile: is this connector connected to a tiled monitor
525 * @tile_group: tile group for the connected monitor
526 * @tile_is_single_monitor: whether the tile is one monitor housing
527 * @num_h_tile: number of horizontal tiles in the tile group
528 * @num_v_tile: number of vertical tiles in the tile group
529 * @tile_h_loc: horizontal location of this tile
530 * @tile_v_loc: vertical location of this tile
531 * @tile_h_size: horizontal size of this tile.
532 * @tile_v_size: vertical size of this tile.
534 * Each connector may be connected to one or more CRTCs, or may be clonable by
535 * another connector if they can share a CRTC. Each connector also has a specific
536 * position in the broader display (referred to as a 'screen' though it could
537 * span multiple monitors).
539 struct drm_connector {
540 struct drm_device *dev;
542 struct device_attribute *attr;
543 struct list_head head;
545 struct drm_mode_object base;
550 * @index: Compacted connector index, which matches the position inside
551 * the mode_config.list for drivers not supporting hot-add/removing. Can
552 * be used as an array index. It is invariant over the lifetime of the
558 int connector_type_id;
559 bool interlace_allowed;
560 bool doublescan_allowed;
563 struct list_head modes; /* list of modes on this connector */
565 enum drm_connector_status status;
567 /* these are modes added by probing with DDC or the BIOS */
568 struct list_head probed_modes;
571 * @display_info: Display information is filled from EDID information
572 * when a display is detected. For non hot-pluggable displays such as
573 * flat panels in embedded systems, the driver should initialize the
574 * display_info.width_mm and display_info.height_mm fields with the
575 * physical size of the display.
577 struct drm_display_info display_info;
578 const struct drm_connector_funcs *funcs;
580 struct drm_property_blob *edid_blob_ptr;
581 struct drm_object_properties properties;
586 * DRM blob property data for the DP MST path property.
588 struct drm_property_blob *path_blob_ptr;
593 * DRM blob property data for the tile property (used mostly by DP MST).
594 * This is meant for screens which are driven through separate display
595 * pipelines represented by &drm_crtc, which might not be running with
596 * genlocked clocks. For tiled panels which are genlocked, like
597 * dual-link LVDS or dual-link DSI, the driver should try to not expose
598 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
600 struct drm_property_blob *tile_blob_ptr;
602 /* should we poll this connector for connects and disconnects */
603 /* hot plug detectable */
604 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
605 /* poll for connections */
606 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
607 /* can cleanly poll for disconnections without flickering the screen */
608 /* DACs should rarely do this without a lot of testing */
609 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
614 * Connector polling mode, a combination of
616 * DRM_CONNECTOR_POLL_HPD
617 * The connector generates hotplug events and doesn't need to be
618 * periodically polled. The CONNECT and DISCONNECT flags must not
619 * be set together with the HPD flag.
621 * DRM_CONNECTOR_POLL_CONNECT
622 * Periodically poll the connector for connection.
624 * DRM_CONNECTOR_POLL_DISCONNECT
625 * Periodically poll the connector for disconnection.
627 * Set to 0 for connectors that don't support connection status
632 /* requested DPMS state */
635 const struct drm_connector_helper_funcs *helper_private;
637 /* forced on connector */
638 struct drm_cmdline_mode cmdline_mode;
639 enum drm_connector_force force;
642 #define DRM_CONNECTOR_MAX_ENCODER 3
643 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
644 struct drm_encoder *encoder; /* currently active encoder */
646 #define MAX_ELD_BYTES 128
648 uint8_t eld[MAX_ELD_BYTES];
650 int max_tmds_clock; /* in MHz */
651 bool latency_present[2];
652 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
653 int audio_latency[2];
654 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
655 unsigned bad_edid_counter;
657 /* Flag for raw EDID header corruption - used in Displayport
658 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
662 struct dentry *debugfs_entry;
664 struct drm_connector_state *state;
668 struct drm_tile_group *tile_group;
669 bool tile_is_single_monitor;
671 uint8_t num_h_tile, num_v_tile;
672 uint8_t tile_h_loc, tile_v_loc;
673 uint16_t tile_h_size, tile_v_size;
676 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
678 int drm_connector_init(struct drm_device *dev,
679 struct drm_connector *connector,
680 const struct drm_connector_funcs *funcs,
682 int drm_connector_register(struct drm_connector *connector);
683 void drm_connector_unregister(struct drm_connector *connector);
684 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
685 struct drm_encoder *encoder);
687 void drm_connector_cleanup(struct drm_connector *connector);
688 static inline unsigned drm_connector_index(struct drm_connector *connector)
690 return connector->index;
694 * drm_connector_lookup - lookup connector object
696 * @id: connector object id
698 * This function looks up the connector object specified by id
699 * add takes a reference to it.
701 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
704 struct drm_mode_object *mo;
705 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
706 return mo ? obj_to_connector(mo) : NULL;
710 * drm_connector_reference - incr the connector refcnt
711 * @connector: connector
713 * This function increments the connector's refcount.
715 static inline void drm_connector_reference(struct drm_connector *connector)
717 drm_mode_object_reference(&connector->base);
721 * drm_connector_unreference - unref a connector
722 * @connector: connector to unref
724 * This function decrements the connector's refcount and frees it if it drops to zero.
726 static inline void drm_connector_unreference(struct drm_connector *connector)
728 drm_mode_object_unreference(&connector->base);
731 const char *drm_get_connector_status_name(enum drm_connector_status status);
732 const char *drm_get_subpixel_order_name(enum subpixel_order order);
733 const char *drm_get_dpms_name(int val);
734 const char *drm_get_dvi_i_subconnector_name(int val);
735 const char *drm_get_dvi_i_select_name(int val);
736 const char *drm_get_tv_subconnector_name(int val);
737 const char *drm_get_tv_select_name(int val);
739 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
740 int drm_mode_create_tv_properties(struct drm_device *dev,
741 unsigned int num_modes,
742 const char * const modes[]);
743 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
744 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
745 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
747 int drm_mode_connector_set_path_property(struct drm_connector *connector,
749 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
750 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
751 const struct edid *edid);
754 * drm_for_each_connector - iterate over all connectors
755 * @connector: the loop cursor
756 * @dev: the DRM device
758 * Iterate over all connectors of @dev.
760 #define drm_for_each_connector(connector, dev) \
761 for (assert_drm_connector_list_read_locked(&(dev)->mode_config), \
762 connector = list_first_entry(&(dev)->mode_config.connector_list, \
763 struct drm_connector, head); \
764 &connector->head != (&(dev)->mode_config.connector_list); \
765 connector = list_next_entry(connector, head))