1/*
2 * Copyright (c) 2016 Intel Corporation
3 *
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.
13 *
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
20 * OF THIS SOFTWARE.
21 */
22
23#ifndef __DRM_CONNECTOR_H__
24#define __DRM_CONNECTOR_H__
25
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>
32
33#include <uapi/drm/drm_mode.h>
34
35struct drm_connector_helper_funcs;
36struct drm_modeset_acquire_ctx;
37struct drm_device;
38struct drm_crtc;
39struct drm_encoder;
40struct drm_property;
41struct drm_property_blob;
42struct drm_printer;
43struct edid;
44
45enum drm_connector_force {
46 DRM_FORCE_UNSPECIFIED,
47 DRM_FORCE_OFF,
48 DRM_FORCE_ON, /* force on analog part normally */
49 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
50};
51
52/**
53 * enum drm_connector_status - status for a &drm_connector
54 *
55 * This enum is used to track the connector status. There are no separate
56 * #defines for the uapi!
57 */
58enum drm_connector_status {
59 /**
60 * @connector_status_connected: The connector is definitely connected to
61 * a sink device, and can be enabled.
62 */
63 connector_status_connected = 1,
64 /**
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.
70 */
71 connector_status_disconnected = 2,
72 /**
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.
81 */
82 connector_status_unknown = 3,
83};
84
85/**
86 * enum drm_connector_registration_status - userspace registration status for
87 * a &drm_connector
88 *
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.
92 */
93enum drm_connector_registration_state {
94 /**
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
98 * modified.
99 */
100 DRM_CONNECTOR_INITIALIZING = 0,
101
102 /**
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.
107 */
108 DRM_CONNECTOR_REGISTERED = 1,
109
110 /**
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
117 * may be modified:
118 *
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
121 * to On.
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
125 * one is not.
126 * - Removing a CRTC from an unregistered connector is OK, but new
127 * CRTCs may never be assigned to an unregistered connector.
128 */
129 DRM_CONNECTOR_UNREGISTERED = 2,
130};
131
132enum subpixel_order {
133 SubPixelUnknown = 0,
134 SubPixelHorizontalRGB,
135 SubPixelHorizontalBGR,
136 SubPixelVerticalRGB,
137 SubPixelVerticalBGR,
138 SubPixelNone,
139
140};
141
142/**
143 * struct drm_scrambling: sink's scrambling support.
144 */
145struct drm_scrambling {
146 /**
147 * @supported: scrambling supported for rates > 340 Mhz.
148 */
149 bool supported;
150 /**
151 * @low_rates: scrambling supported for rates <= 340 Mhz.
152 */
153 bool low_rates;
154};
155
156/*
157 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
158 *
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.
161 */
162struct drm_scdc {
163 /**
164 * @supported: status control & data channel present.
165 */
166 bool supported;
167 /**
168 * @read_request: sink is capable of generating scdc read request.
169 */
170 bool read_request;
171 /**
172 * @scrambling: sink's scrambling capabilities
173 */
174 struct drm_scrambling scrambling;
175};
176
177
178/**
179 * struct drm_hdmi_info - runtime information about the connected HDMI sink
180 *
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).
183 */
184struct drm_hdmi_info {
185 /** @scdc: sink's scdc support and capabilities */
186 struct drm_scdc scdc;
187
188 /**
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
192 * upto 128 VICs;
193 */
194 unsigned long y420_vdb_modes[BITS_TO_LONGS(128)];
195
196 /**
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
200 * 128 VICs;
201 */
202 unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)];
203
204 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
205 u64 y420_cmdb_map;
206
207 /** @y420_dc_modes: bitmap of deep color support index */
208 u8 y420_dc_modes;
209};
210
211/**
212 * enum drm_link_status - connector's link_status property value
213 *
214 * This enum is used as the connector's link status property value.
215 * It is set to the values defined in uapi.
216 *
217 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
218 * link training
219 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
220 * failure
221 */
222enum drm_link_status {
223 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
224 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
225};
226
227/**
228 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
229 *
230 * This enum is used to track the (LCD) panel orientation. There are no
231 * separate #defines for the uapi!
232 *
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
237 * attached.
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.
247 */
248enum 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,
254};
255
256/**
257 * struct drm_display_info - runtime data about the connected sink
258 *
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.
263 *
264 * For sinks which provide an EDID this can be filled out by calling
265 * drm_add_edid_modes().
266 */
267struct drm_display_info {
268 /**
269 * @name: Name of the display.
270 */
271 char name[DRM_DISPLAY_INFO_LEN];
272
273 /**
274 * @width_mm: Physical width in mm.
275 */
276 unsigned int width_mm;
277 /**
278 * @height_mm: Physical height in mm.
279 */
280 unsigned int height_mm;
281
282 /**
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.
286 */
287 unsigned int pixel_clock;
288 /**
289 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
290 */
291 unsigned int bpc;
292
293 /**
294 * @subpixel_order: Subpixel order of LCD panels.
295 */
296 enum subpixel_order subpixel_order;
297
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)
302
303 /**
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.
309 */
310 int panel_orientation;
311
312 /**
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.
317 */
318 u32 color_formats;
319
320 /**
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.
324 */
325 const u32 *bus_formats;
326 /**
327 * @num_bus_formats: Size of @bus_formats array.
328 */
329 unsigned int num_bus_formats;
330
331#define DRM_BUS_FLAG_DE_LOW (1<<0)
332#define DRM_BUS_FLAG_DE_HIGH (1<<1)
333/* drive data on pos. edge */
334#define DRM_BUS_FLAG_PIXDATA_POSEDGE (1<<2)
335/* drive data on neg. edge */
336#define DRM_BUS_FLAG_PIXDATA_NEGEDGE (1<<3)
337/* data is transmitted MSB to LSB on the bus */
338#define DRM_BUS_FLAG_DATA_MSB_TO_LSB (1<<4)
339/* data is transmitted LSB to MSB on the bus */
340#define DRM_BUS_FLAG_DATA_LSB_TO_MSB (1<<5)
341/* drive sync on pos. edge */
342#define DRM_BUS_FLAG_SYNC_POSEDGE (1<<6)
343/* drive sync on neg. edge */
344#define DRM_BUS_FLAG_SYNC_NEGEDGE (1<<7)
345
346 /**
347 * @bus_flags: Additional information (like pixel signal polarity) for
348 * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines.
349 */
350 u32 bus_flags;
351
352 /**
353 * @max_tmds_clock: Maximum TMDS clock rate supported by the
354 * sink in kHz. 0 means undefined.
355 */
356 int max_tmds_clock;
357
358 /**
359 * @dvi_dual: Dual-link DVI sink?
360 */
361 bool dvi_dual;
362
363 /**
364 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
365 */
366 bool has_hdmi_infoframe;
367
368 /**
369 * @rgb_quant_range_selectable: Does the sink support selecting
370 * the RGB quantization range?
371 */
372 bool rgb_quant_range_selectable;
373
374 /**
375 * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
376 * more stuff redundant with @bus_formats.
377 */
378 u8 edid_hdmi_dc_modes;
379
380 /**
381 * @cea_rev: CEA revision of the HDMI sink.
382 */
383 u8 cea_rev;
384
385 /**
386 * @hdmi: advance features of a HDMI sink.
387 */
388 struct drm_hdmi_info hdmi;
389
390 /**
391 * @non_desktop: Non desktop display (HMD).
392 */
393 bool non_desktop;
394};
395
396int drm_display_info_set_bus_formats(struct drm_display_info *info,
397 const u32 *formats,
398 unsigned int num_formats);
399
400/**
401 * struct drm_tv_connector_state - TV connector related states
402 * @subconnector: selected subconnector
403 * @margins: margins (all margins are expressed in pixels)
404 * @margins.left: left margin
405 * @margins.right: right margin
406 * @margins.top: top margin
407 * @margins.bottom: bottom margin
408 * @mode: TV mode
409 * @brightness: brightness in percent
410 * @contrast: contrast in percent
411 * @flicker_reduction: flicker reduction in percent
412 * @overscan: overscan in percent
413 * @saturation: saturation in percent
414 * @hue: hue in percent
415 */
416struct drm_tv_connector_state {
417 enum drm_mode_subconnector subconnector;
418 struct {
419 unsigned int left;
420 unsigned int right;
421 unsigned int top;
422 unsigned int bottom;
423 } margins;
424 unsigned int mode;
425 unsigned int brightness;
426 unsigned int contrast;
427 unsigned int flicker_reduction;
428 unsigned int overscan;
429 unsigned int saturation;
430 unsigned int hue;
431};
432
433/**
434 * struct drm_connector_state - mutable connector state
435 */
436struct drm_connector_state {
437 /** @connector: backpointer to the connector */
438 struct drm_connector *connector;
439
440 /**
441 * @crtc: CRTC to connect connector to, NULL if disabled.
442 *
443 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
444 * instead.
445 */
446 struct drm_crtc *crtc;
447
448 /**
449 * @best_encoder:
450 *
451 * Used by the atomic helpers to select the encoder, through the
452 * &drm_connector_helper_funcs.atomic_best_encoder or
453 * &drm_connector_helper_funcs.best_encoder callbacks.
454 */
455 struct drm_encoder *best_encoder;
456
457 /**
458 * @link_status: Connector link_status to keep track of whether link is
459 * GOOD or BAD to notify userspace if retraining is necessary.
460 */
461 enum drm_link_status link_status;
462
463 /** @state: backpointer to global drm_atomic_state */
464 struct drm_atomic_state *state;
465
466 /**
467 * @commit: Tracks the pending commit to prevent use-after-free conditions.
468 *
469 * Is only set when @crtc is NULL.
470 */
471 struct drm_crtc_commit *commit;
472
473 /** @tv: TV connector state */
474 struct drm_tv_connector_state tv;
475
476 /**
477 * @picture_aspect_ratio: Connector property to control the
478 * HDMI infoframe aspect ratio setting.
479 *
480 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
481 * values for &enum hdmi_picture_aspect
482 */
483 enum hdmi_picture_aspect picture_aspect_ratio;
484
485 /**
486 * @content_type: Connector property to control the
487 * HDMI infoframe content type setting.
488 * The %DRM_MODE_CONTENT_TYPE_\* values much
489 * match the values.
490 */
491 unsigned int content_type;
492
493 /**
494 * @scaling_mode: Connector property to control the
495 * upscaling, mostly used for built-in panels.
496 */
497 unsigned int scaling_mode;
498
499 /**
500 * @content_protection: Connector property to request content
501 * protection. This is most commonly used for HDCP.
502 */
503 unsigned int content_protection;
504
505 /**
506 * @writeback_job: Writeback job for writeback connectors
507 *
508 * Holds the framebuffer and out-fence for a writeback connector. As
509 * the writeback completion may be asynchronous to the normal commit
510 * cycle, the writeback job lifetime is managed separately from the
511 * normal atomic state by this object.
512 *
513 * See also: drm_writeback_queue_job() and
514 * drm_writeback_signal_completion()
515 */
516 struct drm_writeback_job *writeback_job;
517
518 /**
519 * @max_requested_bpc: Connector property to limit the maximum bit
520 * depth of the pixels.
521 */
522 u8 max_requested_bpc;
523
524 /**
525 * @max_bpc: Connector max_bpc based on the requested max_bpc property
526 * and the connector bpc limitations obtained from edid.
527 */
528 u8 max_bpc;
529};
530
531/**
532 * struct drm_connector_funcs - control connectors on a given device
533 *
534 * Each CRTC may have one or more connectors attached to it. The functions
535 * below allow the core DRM code to control connectors, enumerate available modes,
536 * etc.
537 */
538struct drm_connector_funcs {
539 /**
540 * @dpms:
541 *
542 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
543 * is exposed as a standard property on the connector, but diverted to
544 * this callback in the drm core. Note that atomic drivers don't
545 * implement the 4 level DPMS support on the connector any more, but
546 * instead only have an on/off "ACTIVE" property on the CRTC object.
547 *
548 * This hook is not used by atomic drivers, remapping of the legacy DPMS
549 * property is entirely handled in the DRM core.
550 *
551 * RETURNS:
552 *
553 * 0 on success or a negative error code on failure.
554 */
555 int (*dpms)(struct drm_connector *connector, int mode);
556
557 /**
558 * @reset:
559 *
560 * Reset connector hardware and software state to off. This function isn't
561 * called by the core directly, only through drm_mode_config_reset().
562 * It's not a helper hook only for historical reasons.
563 *
564 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
565 * atomic state using this hook.
566 */
567 void (*reset)(struct drm_connector *connector);
568
569 /**
570 * @detect:
571 *
572 * Check to see if anything is attached to the connector. The parameter
573 * force is set to false whilst polling, true when checking the
574 * connector due to a user request. force can be used by the driver to
575 * avoid expensive, destructive operations during automated probing.
576 *
577 * This callback is optional, if not implemented the connector will be
578 * considered as always being attached.
579 *
580 * FIXME:
581 *
582 * Note that this hook is only called by the probe helper. It's not in
583 * the helper library vtable purely for historical reasons. The only DRM
584 * core entry point to probe connector state is @fill_modes.
585 *
586 * Note that the helper library will already hold
587 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
588 * locks to avoid races with concurrent modeset changes need to use
589 * &drm_connector_helper_funcs.detect_ctx instead.
590 *
591 * RETURNS:
592 *
593 * drm_connector_status indicating the connector's status.
594 */
595 enum drm_connector_status (*detect)(struct drm_connector *connector,
596 bool force);
597
598 /**
599 * @force:
600 *
601 * This function is called to update internal encoder state when the
602 * connector is forced to a certain state by userspace, either through
603 * the sysfs interfaces or on the kernel cmdline. In that case the
604 * @detect callback isn't called.
605 *
606 * FIXME:
607 *
608 * Note that this hook is only called by the probe helper. It's not in
609 * the helper library vtable purely for historical reasons. The only DRM
610 * core entry point to probe connector state is @fill_modes.
611 */
612 void (*force)(struct drm_connector *connector);
613
614 /**
615 * @fill_modes:
616 *
617 * Entry point for output detection and basic mode validation. The
618 * driver should reprobe the output if needed (e.g. when hotplug
619 * handling is unreliable), add all detected modes to &drm_connector.modes
620 * and filter out any the device can't support in any configuration. It
621 * also needs to filter out any modes wider or higher than the
622 * parameters max_width and max_height indicate.
623 *
624 * The drivers must also prune any modes no longer valid from
625 * &drm_connector.modes. Furthermore it must update
626 * &drm_connector.status and &drm_connector.edid. If no EDID has been
627 * received for this output connector->edid must be NULL.
628 *
629 * Drivers using the probe helpers should use
630 * drm_helper_probe_single_connector_modes() to implement this
631 * function.
632 *
633 * RETURNS:
634 *
635 * The number of modes detected and filled into &drm_connector.modes.
636 */
637 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
638
639 /**
640 * @set_property:
641 *
642 * This is the legacy entry point to update a property attached to the
643 * connector.
644 *
645 * This callback is optional if the driver does not support any legacy
646 * driver-private properties. For atomic drivers it is not used because
647 * property handling is done entirely in the DRM core.
648 *
649 * RETURNS:
650 *
651 * 0 on success or a negative error code on failure.
652 */
653 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
654 uint64_t val);
655
656 /**
657 * @late_register:
658 *
659 * This optional hook can be used to register additional userspace
660 * interfaces attached to the connector, light backlight control, i2c,
661 * DP aux or similar interfaces. It is called late in the driver load
662 * sequence from drm_connector_register() when registering all the
663 * core drm connector interfaces. Everything added from this callback
664 * should be unregistered in the early_unregister callback.
665 *
666 * This is called while holding &drm_connector.mutex.
667 *
668 * Returns:
669 *
670 * 0 on success, or a negative error code on failure.
671 */
672 int (*late_register)(struct drm_connector *connector);
673
674 /**
675 * @early_unregister:
676 *
677 * This optional hook should be used to unregister the additional
678 * userspace interfaces attached to the connector from
679 * late_register(). It is called from drm_connector_unregister(),
680 * early in the driver unload sequence to disable userspace access
681 * before data structures are torndown.
682 *
683 * This is called while holding &drm_connector.mutex.
684 */
685 void (*early_unregister)(struct drm_connector *connector);
686
687 /**
688 * @destroy:
689 *
690 * Clean up connector resources. This is called at driver unload time
691 * through drm_mode_config_cleanup(). It can also be called at runtime
692 * when a connector is being hot-unplugged for drivers that support
693 * connector hotplugging (e.g. DisplayPort MST).
694 */
695 void (*destroy)(struct drm_connector *connector);
696
697 /**
698 * @atomic_duplicate_state:
699 *
700 * Duplicate the current atomic state for this connector and return it.
701 * The core and helpers guarantee that any atomic state duplicated with
702 * this hook and still owned by the caller (i.e. not transferred to the
703 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
704 * cleaned up by calling the @atomic_destroy_state hook in this
705 * structure.
706 *
707 * This callback is mandatory for atomic drivers.
708 *
709 * Atomic drivers which don't subclass &struct drm_connector_state should use
710 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
711 * state structure to extend it with driver-private state should use
712 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
713 * duplicated in a consistent fashion across drivers.
714 *
715 * It is an error to call this hook before &drm_connector.state has been
716 * initialized correctly.
717 *
718 * NOTE:
719 *
720 * If the duplicate state references refcounted resources this hook must
721 * acquire a reference for each of them. The driver must release these
722 * references again in @atomic_destroy_state.
723 *
724 * RETURNS:
725 *
726 * Duplicated atomic state or NULL when the allocation failed.
727 */
728 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
729
730 /**
731 * @atomic_destroy_state:
732 *
733 * Destroy a state duplicated with @atomic_duplicate_state and release
734 * or unreference all resources it references
735 *
736 * This callback is mandatory for atomic drivers.
737 */
738 void (*atomic_destroy_state)(struct drm_connector *connector,
739 struct drm_connector_state *state);
740
741 /**
742 * @atomic_set_property:
743 *
744 * Decode a driver-private property value and store the decoded value
745 * into the passed-in state structure. Since the atomic core decodes all
746 * standardized properties (even for extensions beyond the core set of
747 * properties which might not be implemented by all drivers) this
748 * requires drivers to subclass the state structure.
749 *
750 * Such driver-private properties should really only be implemented for
751 * truly hardware/vendor specific state. Instead it is preferred to
752 * standardize atomic extension and decode the properties used to expose
753 * such an extension in the core.
754 *
755 * Do not call this function directly, use
756 * drm_atomic_connector_set_property() instead.
757 *
758 * This callback is optional if the driver does not support any
759 * driver-private atomic properties.
760 *
761 * NOTE:
762 *
763 * This function is called in the state assembly phase of atomic
764 * modesets, which can be aborted for any reason (including on
765 * userspace's request to just check whether a configuration would be
766 * possible). Drivers MUST NOT touch any persistent state (hardware or
767 * software) or data structures except the passed in @state parameter.
768 *
769 * Also since userspace controls in which order properties are set this
770 * function must not do any input validation (since the state update is
771 * incomplete and hence likely inconsistent). Instead any such input
772 * validation must be done in the various atomic_check callbacks.
773 *
774 * RETURNS:
775 *
776 * 0 if the property has been found, -EINVAL if the property isn't
777 * implemented by the driver (which shouldn't ever happen, the core only
778 * asks for properties attached to this connector). No other validation
779 * is allowed by the driver. The core already checks that the property
780 * value is within the range (integer, valid enum value, ...) the driver
781 * set when registering the property.
782 */
783 int (*atomic_set_property)(struct drm_connector *connector,
784 struct drm_connector_state *state,
785 struct drm_property *property,
786 uint64_t val);
787
788 /**
789 * @atomic_get_property:
790 *
791 * Reads out the decoded driver-private property. This is used to
792 * implement the GETCONNECTOR IOCTL.
793 *
794 * Do not call this function directly, use
795 * drm_atomic_connector_get_property() instead.
796 *
797 * This callback is optional if the driver does not support any
798 * driver-private atomic properties.
799 *
800 * RETURNS:
801 *
802 * 0 on success, -EINVAL if the property isn't implemented by the
803 * driver (which shouldn't ever happen, the core only asks for
804 * properties attached to this connector).
805 */
806 int (*atomic_get_property)(struct drm_connector *connector,
807 const struct drm_connector_state *state,
808 struct drm_property *property,
809 uint64_t *val);
810
811 /**
812 * @atomic_print_state:
813 *
814 * If driver subclasses &struct drm_connector_state, it should implement
815 * this optional hook for printing additional driver specific state.
816 *
817 * Do not call this directly, use drm_atomic_connector_print_state()
818 * instead.
819 */
820 void (*atomic_print_state)(struct drm_printer *p,
821 const struct drm_connector_state *state);
822};
823
824/* mode specified on the command line */
825struct drm_cmdline_mode {
826 bool specified;
827 bool refresh_specified;
828 bool bpp_specified;
829 int xres, yres;
830 int bpp;
831 int refresh;
832 bool rb;
833 bool interlace;
834 bool cvt;
835 bool margins;
836 enum drm_connector_force force;
837};
838
839/**
840 * struct drm_connector - central DRM connector control structure
841 *
842 * Each connector may be connected to one or more CRTCs, or may be clonable by
843 * another connector if they can share a CRTC. Each connector also has a specific
844 * position in the broader display (referred to as a 'screen' though it could
845 * span multiple monitors).
846 */
847struct drm_connector {
848 /** @dev: parent DRM device */
849 struct drm_device *dev;
850 /** @kdev: kernel device for sysfs attributes */
851 struct device *kdev;
852 /** @attr: sysfs attributes */
853 struct device_attribute *attr;
854
855 /**
856 * @head:
857 *
858 * List of all connectors on a @dev, linked from
859 * &drm_mode_config.connector_list. Protected by
860 * &drm_mode_config.connector_list_lock, but please only use
861 * &drm_connector_list_iter to walk this list.
862 */
863 struct list_head head;
864
865 /** @base: base KMS object */
866 struct drm_mode_object base;
867
868 /** @name: human readable name, can be overwritten by the driver */
869 char *name;
870
871 /**
872 * @mutex: Lock for general connector state, but currently only protects
873 * @registered. Most of the connector state is still protected by
874 * &drm_mode_config.mutex.
875 */
876 struct mutex mutex;
877
878 /**
879 * @index: Compacted connector index, which matches the position inside
880 * the mode_config.list for drivers not supporting hot-add/removing. Can
881 * be used as an array index. It is invariant over the lifetime of the
882 * connector.
883 */
884 unsigned index;
885
886 /**
887 * @connector_type:
888 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
889 */
890 int connector_type;
891 /** @connector_type_id: index into connector type enum */
892 int connector_type_id;
893 /**
894 * @interlace_allowed:
895 * Can this connector handle interlaced modes? Only used by
896 * drm_helper_probe_single_connector_modes() for mode filtering.
897 */
898 bool interlace_allowed;
899 /**
900 * @doublescan_allowed:
901 * Can this connector handle doublescan? Only used by
902 * drm_helper_probe_single_connector_modes() for mode filtering.
903 */
904 bool doublescan_allowed;
905 /**
906 * @stereo_allowed:
907 * Can this connector handle stereo modes? Only used by
908 * drm_helper_probe_single_connector_modes() for mode filtering.
909 */
910 bool stereo_allowed;
911
912 /**
913 * @ycbcr_420_allowed : This bool indicates if this connector is
914 * capable of handling YCBCR 420 output. While parsing the EDID
915 * blocks it's very helpful to know if the source is capable of
916 * handling YCBCR 420 outputs.
917 */
918 bool ycbcr_420_allowed;
919
920 /**
921 * @registration_state: Is this connector initializing, exposed
922 * (registered) with userspace, or unregistered?
923 *
924 * Protected by @mutex.
925 */
926 enum drm_connector_registration_state registration_state;
927
928 /**
929 * @modes:
930 * Modes available on this connector (from fill_modes() + user).
931 * Protected by &drm_mode_config.mutex.
932 */
933 struct list_head modes;
934
935 /**
936 * @status:
937 * One of the drm_connector_status enums (connected, not, or unknown).
938 * Protected by &drm_mode_config.mutex.
939 */
940 enum drm_connector_status status;
941
942 /**
943 * @probed_modes:
944 * These are modes added by probing with DDC or the BIOS, before
945 * filtering is applied. Used by the probe helpers. Protected by
946 * &drm_mode_config.mutex.
947 */
948 struct list_head probed_modes;
949
950 /**
951 * @display_info: Display information is filled from EDID information
952 * when a display is detected. For non hot-pluggable displays such as
953 * flat panels in embedded systems, the driver should initialize the
954 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
955 * with the physical size of the display.
956 *
957 * Protected by &drm_mode_config.mutex.
958 */
959 struct drm_display_info display_info;
960
961 /** @funcs: connector control functions */
962 const struct drm_connector_funcs *funcs;
963
964 /**
965 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
966 * &drm_mode_config.mutex. This should be updated only by calling
967 * drm_connector_update_edid_property().
968 */
969 struct drm_property_blob *edid_blob_ptr;
970
971 /** @properties: property tracking for this connector */
972 struct drm_object_properties properties;
973
974 /**
975 * @scaling_mode_property: Optional atomic property to control the
976 * upscaling. See drm_connector_attach_content_protection_property().
977 */
978 struct drm_property *scaling_mode_property;
979
980 /**
981 * @vrr_capable_property: Optional property to help userspace
982 * query hardware support for variable refresh rate on a connector.
983 * connector. Drivers can add the property to a connector by
984 * calling drm_connector_attach_vrr_capable_property().
985 *
986 * This should be updated only by calling
987 * drm_connector_set_vrr_capable_property().
988 */
989 struct drm_property *vrr_capable_property;
990
991 /**
992 * @content_protection_property: DRM ENUM property for content
993 * protection. See drm_connector_attach_content_protection_property().
994 */
995 struct drm_property *content_protection_property;
996
997 /**
998 * @path_blob_ptr:
999 *
1000 * DRM blob property data for the DP MST path property. This should only
1001 * be updated by calling drm_connector_set_path_property().
1002 */
1003 struct drm_property_blob *path_blob_ptr;
1004
1005 /**
1006 * @max_bpc_property: Default connector property for the max bpc to be
1007 * driven out of the connector.
1008 */
1009 struct drm_property *max_bpc_property;
1010
1011#define DRM_CONNECTOR_POLL_HPD (1 << 0)
1012#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1013#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1014
1015 /**
1016 * @polled:
1017 *
1018 * Connector polling mode, a combination of
1019 *
1020 * DRM_CONNECTOR_POLL_HPD
1021 * The connector generates hotplug events and doesn't need to be
1022 * periodically polled. The CONNECT and DISCONNECT flags must not
1023 * be set together with the HPD flag.
1024 *
1025 * DRM_CONNECTOR_POLL_CONNECT
1026 * Periodically poll the connector for connection.
1027 *
1028 * DRM_CONNECTOR_POLL_DISCONNECT
1029 * Periodically poll the connector for disconnection, without
1030 * causing flickering even when the connector is in use. DACs should
1031 * rarely do this without a lot of testing.
1032 *
1033 * Set to 0 for connectors that don't support connection status
1034 * discovery.
1035 */
1036 uint8_t polled;
1037
1038 /**
1039 * @dpms: Current dpms state. For legacy drivers the
1040 * &drm_connector_funcs.dpms callback must update this. For atomic
1041 * drivers, this is handled by the core atomic code, and drivers must
1042 * only take &drm_crtc_state.active into account.
1043 */
1044 int dpms;
1045
1046 /** @helper_private: mid-layer private data */
1047 const struct drm_connector_helper_funcs *helper_private;
1048
1049 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1050 struct drm_cmdline_mode cmdline_mode;
1051 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1052 enum drm_connector_force force;
1053 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1054 bool override_edid;
1055
1056#define DRM_CONNECTOR_MAX_ENCODER 3
1057 /**
1058 * @encoder_ids: Valid encoders for this connector. Please only use
1059 * drm_connector_for_each_possible_encoder() to enumerate these.
1060 */
1061 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
1062
1063 /**
1064 * @encoder: Currently bound encoder driving this connector, if any.
1065 * Only really meaningful for non-atomic drivers. Atomic drivers should
1066 * instead look at &drm_connector_state.best_encoder, and in case they
1067 * need the CRTC driving this output, &drm_connector_state.crtc.
1068 */
1069 struct drm_encoder *encoder;
1070
1071#define MAX_ELD_BYTES 128
1072 /** @eld: EDID-like data, if present */
1073 uint8_t eld[MAX_ELD_BYTES];
1074 /** @latency_present: AV delay info from ELD, if found */
1075 bool latency_present[2];
1076 /**
1077 * @video_latency: Video latency info from ELD, if found.
1078 * [0]: progressive, [1]: interlaced
1079 */
1080 int video_latency[2];
1081 /**
1082 * @audio_latency: audio latency info from ELD, if found
1083 * [0]: progressive, [1]: interlaced
1084 */
1085 int audio_latency[2];
1086 /**
1087 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1088 * Needed to workaround some HW bugs where we get all 0s
1089 */
1090 int null_edid_counter;
1091
1092 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1093 unsigned bad_edid_counter;
1094
1095 /**
1096 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1097 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1098 * rev1.1 4.2.2.6
1099 */
1100 bool edid_corrupt;
1101
1102 /** @debugfs_entry: debugfs directory for this connector */
1103 struct dentry *debugfs_entry;
1104
1105 /**
1106 * @state:
1107 *
1108 * Current atomic state for this connector.
1109 *
1110 * This is protected by &drm_mode_config.connection_mutex. Note that
1111 * nonblocking atomic commits access the current connector state without
1112 * taking locks. Either by going through the &struct drm_atomic_state
1113 * pointers, see for_each_oldnew_connector_in_state(),
1114 * for_each_old_connector_in_state() and
1115 * for_each_new_connector_in_state(). Or through careful ordering of
1116 * atomic commit operations as implemented in the atomic helpers, see
1117 * &struct drm_crtc_commit.
1118 */
1119 struct drm_connector_state *state;
1120
1121 /* DisplayID bits. FIXME: Extract into a substruct? */
1122
1123 /**
1124 * @tile_blob_ptr:
1125 *
1126 * DRM blob property data for the tile property (used mostly by DP MST).
1127 * This is meant for screens which are driven through separate display
1128 * pipelines represented by &drm_crtc, which might not be running with
1129 * genlocked clocks. For tiled panels which are genlocked, like
1130 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1131 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1132 *
1133 * This should only be updated by calling
1134 * drm_connector_set_tile_property().
1135 */
1136 struct drm_property_blob *tile_blob_ptr;
1137
1138 /** @has_tile: is this connector connected to a tiled monitor */
1139 bool has_tile;
1140 /** @tile_group: tile group for the connected monitor */
1141 struct drm_tile_group *tile_group;
1142 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1143 bool tile_is_single_monitor;
1144
1145 /** @num_h_tile: number of horizontal tiles in the tile group */
1146 /** @num_v_tile: number of vertical tiles in the tile group */
1147 uint8_t num_h_tile, num_v_tile;
1148 /** @tile_h_loc: horizontal location of this tile */
1149 /** @tile_v_loc: vertical location of this tile */
1150 uint8_t tile_h_loc, tile_v_loc;
1151 /** @tile_h_size: horizontal size of this tile. */
1152 /** @tile_v_size: vertical size of this tile. */
1153 uint16_t tile_h_size, tile_v_size;
1154
1155 /**
1156 * @free_node:
1157 *
1158 * List used only by &drm_connector_list_iter to be able to clean up a
1159 * connector from any context, in conjunction with
1160 * &drm_mode_config.connector_free_work.
1161 */
1162 struct llist_node free_node;
1163};
1164
1165#define obj_to_connector(x) container_of(x, struct drm_connector, base)
1166
1167int drm_connector_init(struct drm_device *dev,
1168 struct drm_connector *connector,
1169 const struct drm_connector_funcs *funcs,
1170 int connector_type);
1171void drm_connector_attach_edid_property(struct drm_connector *connector);
1172int drm_connector_register(struct drm_connector *connector);
1173void drm_connector_unregister(struct drm_connector *connector);
1174int drm_connector_attach_encoder(struct drm_connector *connector,
1175 struct drm_encoder *encoder);
1176
1177void drm_connector_cleanup(struct drm_connector *connector);
1178
1179static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1180{
1181 return connector->index;
1182}
1183
1184static inline u32 drm_connector_mask(const struct drm_connector *connector)
1185{
1186 return 1 << connector->index;
1187}
1188
1189/**
1190 * drm_connector_lookup - lookup connector object
1191 * @dev: DRM device
1192 * @file_priv: drm file to check for lease against.
1193 * @id: connector object id
1194 *
1195 * This function looks up the connector object specified by id
1196 * add takes a reference to it.
1197 */
1198static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1199 struct drm_file *file_priv,
1200 uint32_t id)
1201{
1202 struct drm_mode_object *mo;
1203 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1204 return mo ? obj_to_connector(mo) : NULL;
1205}
1206
1207/**
1208 * drm_connector_get - acquire a connector reference
1209 * @connector: DRM connector
1210 *
1211 * This function increments the connector's refcount.
1212 */
1213static inline void drm_connector_get(struct drm_connector *connector)
1214{
1215 drm_mode_object_get(&connector->base);
1216}
1217
1218/**
1219 * drm_connector_put - release a connector reference
1220 * @connector: DRM connector
1221 *
1222 * This function decrements the connector's reference count and frees the
1223 * object if the reference count drops to zero.
1224 */
1225static inline void drm_connector_put(struct drm_connector *connector)
1226{
1227 drm_mode_object_put(&connector->base);
1228}
1229
1230/**
1231 * drm_connector_is_unregistered - has the connector been unregistered from
1232 * userspace?
1233 * @connector: DRM connector
1234 *
1235 * Checks whether or not @connector has been unregistered from userspace.
1236 *
1237 * Returns:
1238 * True if the connector was unregistered, false if the connector is
1239 * registered or has not yet been registered with userspace.
1240 */
1241static inline bool
1242drm_connector_is_unregistered(struct drm_connector *connector)
1243{
1244 return READ_ONCE(connector->registration_state) ==
1245 DRM_CONNECTOR_UNREGISTERED;
1246}
1247
1248const char *drm_get_connector_status_name(enum drm_connector_status status);
1249const char *drm_get_subpixel_order_name(enum subpixel_order order);
1250const char *drm_get_dpms_name(int val);
1251const char *drm_get_dvi_i_subconnector_name(int val);
1252const char *drm_get_dvi_i_select_name(int val);
1253const char *drm_get_tv_subconnector_name(int val);
1254const char *drm_get_tv_select_name(int val);
1255const char *drm_get_content_protection_name(int val);
1256
1257int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1258int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1259int drm_mode_create_tv_properties(struct drm_device *dev,
1260 unsigned int num_modes,
1261 const char * const modes[]);
1262void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1263int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1264int drm_connector_attach_content_type_property(struct drm_connector *dev);
1265int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1266 u32 scaling_mode_mask);
1267int drm_connector_attach_vrr_capable_property(
1268 struct drm_connector *connector);
1269int drm_connector_attach_content_protection_property(
1270 struct drm_connector *connector);
1271int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1272int drm_mode_create_content_type_property(struct drm_device *dev);
1273void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1274 const struct drm_connector_state *conn_state);
1275
1276int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1277
1278int drm_connector_set_path_property(struct drm_connector *connector,
1279 const char *path);
1280int drm_connector_set_tile_property(struct drm_connector *connector);
1281int drm_connector_update_edid_property(struct drm_connector *connector,
1282 const struct edid *edid);
1283void drm_connector_set_link_status_property(struct drm_connector *connector,
1284 uint64_t link_status);
1285void drm_connector_set_vrr_capable_property(
1286 struct drm_connector *connector, bool capable);
1287int drm_connector_init_panel_orientation_property(
1288 struct drm_connector *connector, int width, int height);
1289int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1290 int min, int max);
1291
1292/**
1293 * struct drm_tile_group - Tile group metadata
1294 * @refcount: reference count
1295 * @dev: DRM device
1296 * @id: tile group id exposed to userspace
1297 * @group_data: Sink-private data identifying this group
1298 *
1299 * @group_data corresponds to displayid vend/prod/serial for external screens
1300 * with an EDID.
1301 */
1302struct drm_tile_group {
1303 struct kref refcount;
1304 struct drm_device *dev;
1305 int id;
1306 u8 group_data[8];
1307};
1308
1309struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1310 char topology[8]);
1311struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1312 char topology[8]);
1313void drm_mode_put_tile_group(struct drm_device *dev,
1314 struct drm_tile_group *tg);
1315
1316/**
1317 * struct drm_connector_list_iter - connector_list iterator
1318 *
1319 * This iterator tracks state needed to be able to walk the connector_list
1320 * within struct drm_mode_config. Only use together with
1321 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1322 * drm_connector_list_iter_next() respectively the convenience macro
1323 * drm_for_each_connector_iter().
1324 */
1325struct drm_connector_list_iter {
1326/* private: */
1327 struct drm_device *dev;
1328 struct drm_connector *conn;
1329};
1330
1331void drm_connector_list_iter_begin(struct drm_device *dev,
1332 struct drm_connector_list_iter *iter);
1333struct drm_connector *
1334drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1335void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1336
1337bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1338 struct drm_encoder *encoder);
1339
1340/**
1341 * drm_for_each_connector_iter - connector_list iterator macro
1342 * @connector: &struct drm_connector pointer used as cursor
1343 * @iter: &struct drm_connector_list_iter
1344 *
1345 * Note that @connector is only valid within the list body, if you want to use
1346 * @connector after calling drm_connector_list_iter_end() then you need to grab
1347 * your own reference first using drm_connector_get().
1348 */
1349#define drm_for_each_connector_iter(connector, iter) \
1350 while ((connector = drm_connector_list_iter_next(iter)))
1351
1352/**
1353 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1354 * @connector: &struct drm_connector pointer
1355 * @encoder: &struct drm_encoder pointer used as cursor
1356 * @__i: int iteration cursor, for macro-internal use
1357 */
1358#define drm_connector_for_each_possible_encoder(connector, encoder, __i) \
1359 for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \
1360 (connector)->encoder_ids[(__i)] != 0; (__i)++) \
1361 for_each_if((encoder) = \
1362 drm_encoder_find((connector)->dev, NULL, \
1363 (connector)->encoder_ids[(__i)])) \
1364
1365#endif
1366