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
35 struct drm_connector_helper_funcs;
36 struct drm_modeset_acquire_ctx;
37 struct drm_device;
38 struct drm_crtc;
39 struct drm_encoder;
40 struct drm_property;
41 struct drm_property_blob;
42 struct drm_printer;
43 struct edid;
44 struct i2c_adapter;
45
46 enum drm_connector_force {
47 DRM_FORCE_UNSPECIFIED,
48 DRM_FORCE_OFF,
49 DRM_FORCE_ON, /* force on analog part normally */
50 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
51 };
52
53 /**
54 * enum drm_connector_status - status for a &drm_connector
55 *
56 * This enum is used to track the connector status. There are no separate
57 * #defines for the uapi!
58 */
59 enum drm_connector_status {
60 /**
61 * @connector_status_connected: The connector is definitely connected to
62 * a sink device, and can be enabled.
63 */
64 connector_status_connected = 1,
65 /**
66 * @connector_status_disconnected: The connector isn't connected to a
67 * sink device which can be autodetect. For digital outputs like DP or
68 * HDMI (which can be realiable probed) this means there's really
69 * nothing there. It is driver-dependent whether a connector with this
70 * status can be lit up or not.
71 */
72 connector_status_disconnected = 2,
73 /**
74 * @connector_status_unknown: The connector's status could not be
75 * reliably detected. This happens when probing would either cause
76 * flicker (like load-detection when the connector is in use), or when a
77 * hardware resource isn't available (like when load-detection needs a
78 * free CRTC). It should be possible to light up the connector with one
79 * of the listed fallback modes. For default configuration userspace
80 * should only try to light up connectors with unknown status when
81 * there's not connector with @connector_status_connected.
82 */
83 connector_status_unknown = 3,
84 };
85
86 /**
87 * enum drm_connector_registration_state - userspace registration status for
88 * a &drm_connector
89 *
90 * This enum is used to track the status of initializing a connector and
91 * registering it with userspace, so that DRM can prevent bogus modesets on
92 * connectors that no longer exist.
93 */
94 enum drm_connector_registration_state {
95 /**
96 * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
97 * but has yet to be exposed to userspace. There should be no
98 * additional restrictions to how the state of this connector may be
99 * modified.
100 */
101 DRM_CONNECTOR_INITIALIZING = 0,
102
103 /**
104 * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
105 * and registered with sysfs, as such it has been exposed to
106 * userspace. There should be no additional restrictions to how the
107 * state of this connector may be modified.
108 */
109 DRM_CONNECTOR_REGISTERED = 1,
110
111 /**
112 * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
113 * to userspace and has since been unregistered and removed from
114 * userspace, or the connector was unregistered before it had a chance
115 * to be exposed to userspace (e.g. still in the
116 * @DRM_CONNECTOR_INITIALIZING state). When a connector is
117 * unregistered, there are additional restrictions to how its state
118 * may be modified:
119 *
120 * - An unregistered connector may only have its DPMS changed from
121 * On->Off. Once DPMS is changed to Off, it may not be switched back
122 * to On.
123 * - Modesets are not allowed on unregistered connectors, unless they
124 * would result in disabling its assigned CRTCs. This means
125 * disabling a CRTC on an unregistered connector is OK, but enabling
126 * one is not.
127 * - Removing a CRTC from an unregistered connector is OK, but new
128 * CRTCs may never be assigned to an unregistered connector.
129 */
130 DRM_CONNECTOR_UNREGISTERED = 2,
131 };
132
133 enum subpixel_order {
134 SubPixelUnknown = 0,
135 SubPixelHorizontalRGB,
136 SubPixelHorizontalBGR,
137 SubPixelVerticalRGB,
138 SubPixelVerticalBGR,
139 SubPixelNone,
140
141 };
142
143 /**
144 * struct drm_scrambling: sink's scrambling support.
145 */
146 struct drm_scrambling {
147 /**
148 * @supported: scrambling supported for rates > 340 Mhz.
149 */
150 bool supported;
151 /**
152 * @low_rates: scrambling supported for rates <= 340 Mhz.
153 */
154 bool low_rates;
155 };
156
157 /*
158 * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
159 *
160 * Provides SCDC register support and capabilities related information on a
161 * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
162 */
163 struct drm_scdc {
164 /**
165 * @supported: status control & data channel present.
166 */
167 bool supported;
168 /**
169 * @read_request: sink is capable of generating scdc read request.
170 */
171 bool read_request;
172 /**
173 * @scrambling: sink's scrambling capabilities
174 */
175 struct drm_scrambling scrambling;
176 };
177
178 /**
179 * struct drm_hdmi_dsc_cap - DSC capabilities of HDMI sink
180 *
181 * Describes the DSC support provided by HDMI 2.1 sink.
182 * The information is fetched fom additional HFVSDB blocks defined
183 * for HDMI 2.1.
184 */
185 struct drm_hdmi_dsc_cap {
186 /** @v_1p2: flag for dsc1.2 version support by sink */
187 bool v_1p2;
188
189 /** @native_420: Does sink support DSC with 4:2:0 compression */
190 bool native_420;
191
192 /**
193 * @all_bpp: Does sink support all bpp with 4:4:4: or 4:2:2
194 * compressed formats
195 */
196 bool all_bpp;
197
198 /**
199 * @bpc_supported: compressed bpc supported by sink : 10, 12 or 16 bpc
200 */
201 u8 bpc_supported;
202
203 /** @max_slices: maximum number of Horizontal slices supported by */
204 u8 max_slices;
205
206 /** @clk_per_slice : max pixel clock in MHz supported per slice */
207 int clk_per_slice;
208
209 /** @max_lanes : dsc max lanes supported for Fixed rate Link training */
210 u8 max_lanes;
211
212 /** @max_frl_rate_per_lane : maximum frl rate with DSC per lane */
213 u8 max_frl_rate_per_lane;
214
215 /** @total_chunk_kbytes: max size of chunks in KBs supported per line*/
216 u8 total_chunk_kbytes;
217 };
218
219 /**
220 * struct drm_hdmi_info - runtime information about the connected HDMI sink
221 *
222 * Describes if a given display supports advanced HDMI 2.0 features.
223 * This information is available in CEA-861-F extension blocks (like HF-VSDB).
224 */
225 struct drm_hdmi_info {
226 /** @scdc: sink's scdc support and capabilities */
227 struct drm_scdc scdc;
228
229 /**
230 * @y420_vdb_modes: bitmap of modes which can support ycbcr420
231 * output only (not normal RGB/YCBCR444/422 outputs). The max VIC
232 * defined by the CEA-861-G spec is 219, so the size is 256 bits to map
233 * up to 256 VICs.
234 */
235 unsigned long y420_vdb_modes[BITS_TO_LONGS(256)];
236
237 /**
238 * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
239 * output also, along with normal HDMI outputs. The max VIC defined by
240 * the CEA-861-G spec is 219, so the size is 256 bits to map up to 256
241 * VICs.
242 */
243 unsigned long y420_cmdb_modes[BITS_TO_LONGS(256)];
244
245 /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
246 u64 y420_cmdb_map;
247
248 /** @y420_dc_modes: bitmap of deep color support index */
249 u8 y420_dc_modes;
250
251 /** @max_frl_rate_per_lane: support fixed rate link */
252 u8 max_frl_rate_per_lane;
253
254 /** @max_lanes: supported by sink */
255 u8 max_lanes;
256
257 /** @dsc_cap: DSC capabilities of the sink */
258 struct drm_hdmi_dsc_cap dsc_cap;
259 };
260
261 /**
262 * enum drm_link_status - connector's link_status property value
263 *
264 * This enum is used as the connector's link status property value.
265 * It is set to the values defined in uapi.
266 *
267 * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
268 * link training
269 * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
270 * failure
271 */
272 enum drm_link_status {
273 DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
274 DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
275 };
276
277 /**
278 * enum drm_panel_orientation - panel_orientation info for &drm_display_info
279 *
280 * This enum is used to track the (LCD) panel orientation. There are no
281 * separate #defines for the uapi!
282 *
283 * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
284 * panel orientation information (normal
285 * for non panels) in this case the "panel
286 * orientation" connector prop will not be
287 * attached.
288 * @DRM_MODE_PANEL_ORIENTATION_NORMAL: The top side of the panel matches the
289 * top side of the device's casing.
290 * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
291 * bottom side of the device's casing, iow
292 * the panel is mounted upside-down.
293 * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
294 * top side of the device's casing.
295 * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
296 * top side of the device's casing.
297 */
298 enum drm_panel_orientation {
299 DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
300 DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
301 DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
302 DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
303 DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
304 };
305
306 /**
307 * struct drm_monitor_range_info - Panel's Monitor range in EDID for
308 * &drm_display_info
309 *
310 * This struct is used to store a frequency range supported by panel
311 * as parsed from EDID's detailed monitor range descriptor block.
312 *
313 * @min_vfreq: This is the min supported refresh rate in Hz from
314 * EDID's detailed monitor range.
315 * @max_vfreq: This is the max supported refresh rate in Hz from
316 * EDID's detailed monitor range
317 */
318 struct drm_monitor_range_info {
319 u8 min_vfreq;
320 u8 max_vfreq;
321 };
322
323 /*
324 * This is a consolidated colorimetry list supported by HDMI and
325 * DP protocol standard. The respective connectors will register
326 * a property with the subset of this list (supported by that
327 * respective protocol). Userspace will set the colorspace through
328 * a colorspace property which will be created and exposed to
329 * userspace.
330 */
331
332 /* For Default case, driver will set the colorspace */
333 #define DRM_MODE_COLORIMETRY_DEFAULT 0
334 /* CEA 861 Normal Colorimetry options */
335 #define DRM_MODE_COLORIMETRY_NO_DATA 0
336 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC 1
337 #define DRM_MODE_COLORIMETRY_BT709_YCC 2
338 /* CEA 861 Extended Colorimetry Options */
339 #define DRM_MODE_COLORIMETRY_XVYCC_601 3
340 #define DRM_MODE_COLORIMETRY_XVYCC_709 4
341 #define DRM_MODE_COLORIMETRY_SYCC_601 5
342 #define DRM_MODE_COLORIMETRY_OPYCC_601 6
343 #define DRM_MODE_COLORIMETRY_OPRGB 7
344 #define DRM_MODE_COLORIMETRY_BT2020_CYCC 8
345 #define DRM_MODE_COLORIMETRY_BT2020_RGB 9
346 #define DRM_MODE_COLORIMETRY_BT2020_YCC 10
347 /* Additional Colorimetry extension added as part of CTA 861.G */
348 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65 11
349 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER 12
350 /* Additional Colorimetry Options added for DP 1.4a VSC Colorimetry Format */
351 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FIXED 13
352 #define DRM_MODE_COLORIMETRY_RGB_WIDE_FLOAT 14
353 #define DRM_MODE_COLORIMETRY_BT601_YCC 15
354
355 /**
356 * enum drm_bus_flags - bus_flags info for &drm_display_info
357 *
358 * This enum defines signal polarities and clock edge information for signals on
359 * a bus as bitmask flags.
360 *
361 * The clock edge information is conveyed by two sets of symbols,
362 * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
363 * used to describe a bus from the point of view of the transmitter, the
364 * \*_DRIVE_\* flags should be used. When used from the point of view of the
365 * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
366 * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
367 * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
368 * respectively. This simplifies code as signals are usually sampled on the
369 * opposite edge of the driving edge. Transmitters and receivers may however
370 * need to take other signal timings into account to convert between driving
371 * and sample edges.
372 */
373 enum drm_bus_flags {
374 /**
375 * @DRM_BUS_FLAG_DE_LOW:
376 *
377 * The Data Enable signal is active low
378 */
379 DRM_BUS_FLAG_DE_LOW = BIT(0),
380
381 /**
382 * @DRM_BUS_FLAG_DE_HIGH:
383 *
384 * The Data Enable signal is active high
385 */
386 DRM_BUS_FLAG_DE_HIGH = BIT(1),
387
388 /**
389 * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE:
390 *
391 * Data is driven on the rising edge of the pixel clock
392 */
393 DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = BIT(2),
394
395 /**
396 * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE:
397 *
398 * Data is driven on the falling edge of the pixel clock
399 */
400 DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = BIT(3),
401
402 /**
403 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE:
404 *
405 * Data is sampled on the rising edge of the pixel clock
406 */
407 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE,
408
409 /**
410 * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE:
411 *
412 * Data is sampled on the falling edge of the pixel clock
413 */
414 DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE,
415
416 /**
417 * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:
418 *
419 * Data is transmitted MSB to LSB on the bus
420 */
421 DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
422
423 /**
424 * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:
425 *
426 * Data is transmitted LSB to MSB on the bus
427 */
428 DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
429
430 /**
431 * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:
432 *
433 * Sync signals are driven on the rising edge of the pixel clock
434 */
435 DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = BIT(6),
436
437 /**
438 * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:
439 *
440 * Sync signals are driven on the falling edge of the pixel clock
441 */
442 DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = BIT(7),
443
444 /**
445 * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:
446 *
447 * Sync signals are sampled on the rising edge of the pixel clock
448 */
449 DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE,
450
451 /**
452 * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:
453 *
454 * Sync signals are sampled on the falling edge of the pixel clock
455 */
456 DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE,
457
458 /**
459 * @DRM_BUS_FLAG_SHARP_SIGNALS:
460 *
461 * Set if the Sharp-specific signals (SPL, CLS, PS, REV) must be used
462 */
463 DRM_BUS_FLAG_SHARP_SIGNALS = BIT(8),
464 };
465
466 /**
467 * struct drm_display_info - runtime data about the connected sink
468 *
469 * Describes a given display (e.g. CRT or flat panel) and its limitations. For
470 * fixed display sinks like built-in panels there's not much difference between
471 * this and &struct drm_connector. But for sinks with a real cable this
472 * structure is meant to describe all the things at the other end of the cable.
473 *
474 * For sinks which provide an EDID this can be filled out by calling
475 * drm_add_edid_modes().
476 */
477 struct drm_display_info {
478 /**
479 * @width_mm: Physical width in mm.
480 */
481 unsigned int width_mm;
482
483 /**
484 * @height_mm: Physical height in mm.
485 */
486 unsigned int height_mm;
487
488 /**
489 * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
490 */
491 unsigned int bpc;
492
493 /**
494 * @subpixel_order: Subpixel order of LCD panels.
495 */
496 enum subpixel_order subpixel_order;
497
498 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
499 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
500 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
501 #define DRM_COLOR_FORMAT_YCRCB420 (1<<3)
502
503 /**
504 * @panel_orientation: Read only connector property for built-in panels,
505 * indicating the orientation of the panel vs the device's casing.
506 * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
507 * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
508 * fb to compensate and gets exported as prop to userspace.
509 */
510 int panel_orientation;
511
512 /**
513 * @color_formats: HDMI Color formats, selects between RGB and YCrCb
514 * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
515 * as used to describe the pixel format in framebuffers, and also don't
516 * match the formats in @bus_formats which are shared with v4l.
517 */
518 u32 color_formats;
519
520 /**
521 * @bus_formats: Pixel data format on the wire, somewhat redundant with
522 * @color_formats. Array of size @num_bus_formats encoded using
523 * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
524 */
525 const u32 *bus_formats;
526 /**
527 * @num_bus_formats: Size of @bus_formats array.
528 */
529 unsigned int num_bus_formats;
530
531 /**
532 * @bus_flags: Additional information (like pixel signal polarity) for
533 * the pixel data on the bus, using &enum drm_bus_flags values
534 * DRM_BUS_FLAGS\_.
535 */
536 u32 bus_flags;
537
538 /**
539 * @max_tmds_clock: Maximum TMDS clock rate supported by the
540 * sink in kHz. 0 means undefined.
541 */
542 int max_tmds_clock;
543
544 /**
545 * @dvi_dual: Dual-link DVI sink?
546 */
547 bool dvi_dual;
548
549 /**
550 * @is_hdmi: True if the sink is an HDMI device.
551 *
552 * This field shall be used instead of calling
553 * drm_detect_hdmi_monitor() when possible.
554 */
555 bool is_hdmi;
556
557 /**
558 * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
559 */
560 bool has_hdmi_infoframe;
561
562 /**
563 * @rgb_quant_range_selectable: Does the sink support selecting
564 * the RGB quantization range?
565 */
566 bool rgb_quant_range_selectable;
567
568 /**
569 * @edid_hdmi_rgb444_dc_modes: Mask of supported hdmi deep color modes
570 * in RGB 4:4:4. Even more stuff redundant with @bus_formats.
571 */
572 u8 edid_hdmi_rgb444_dc_modes;
573
574 /**
575 * @edid_hdmi_ycbcr444_dc_modes: Mask of supported hdmi deep color
576 * modes in YCbCr 4:4:4. Even more stuff redundant with @bus_formats.
577 */
578 u8 edid_hdmi_ycbcr444_dc_modes;
579
580 /**
581 * @cea_rev: CEA revision of the HDMI sink.
582 */
583 u8 cea_rev;
584
585 /**
586 * @hdmi: advance features of a HDMI sink.
587 */
588 struct drm_hdmi_info hdmi;
589
590 /**
591 * @non_desktop: Non desktop display (HMD).
592 */
593 bool non_desktop;
594
595 /**
596 * @monitor_range: Frequency range supported by monitor range descriptor
597 */
598 struct drm_monitor_range_info monitor_range;
599 };
600
601 int drm_display_info_set_bus_formats(struct drm_display_info *info,
602 const u32 *formats,
603 unsigned int num_formats);
604
605 /**
606 * struct drm_connector_tv_margins - TV connector related margins
607 *
608 * Describes the margins in pixels to put around the image on TV
609 * connectors to deal with overscan.
610 */
611 struct drm_connector_tv_margins {
612 /**
613 * @bottom: Bottom margin in pixels.
614 */
615 unsigned int bottom;
616
617 /**
618 * @left: Left margin in pixels.
619 */
620 unsigned int left;
621
622 /**
623 * @right: Right margin in pixels.
624 */
625 unsigned int right;
626
627 /**
628 * @top: Top margin in pixels.
629 */
630 unsigned int top;
631 };
632
633 /**
634 * struct drm_tv_connector_state - TV connector related states
635 * @subconnector: selected subconnector
636 * @margins: TV margins
637 * @mode: TV mode
638 * @brightness: brightness in percent
639 * @contrast: contrast in percent
640 * @flicker_reduction: flicker reduction in percent
641 * @overscan: overscan in percent
642 * @saturation: saturation in percent
643 * @hue: hue in percent
644 */
645 struct drm_tv_connector_state {
646 enum drm_mode_subconnector subconnector;
647 struct drm_connector_tv_margins margins;
648 unsigned int mode;
649 unsigned int brightness;
650 unsigned int contrast;
651 unsigned int flicker_reduction;
652 unsigned int overscan;
653 unsigned int saturation;
654 unsigned int hue;
655 };
656
657 /**
658 * struct drm_connector_state - mutable connector state
659 */
660 struct drm_connector_state {
661 /** @connector: backpointer to the connector */
662 struct drm_connector *connector;
663
664 /**
665 * @crtc: CRTC to connect connector to, NULL if disabled.
666 *
667 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
668 * instead.
669 */
670 struct drm_crtc *crtc;
671
672 /**
673 * @best_encoder:
674 *
675 * Used by the atomic helpers to select the encoder, through the
676 * &drm_connector_helper_funcs.atomic_best_encoder or
677 * &drm_connector_helper_funcs.best_encoder callbacks.
678 *
679 * This is also used in the atomic helpers to map encoders to their
680 * current and previous connectors, see
681 * drm_atomic_get_old_connector_for_encoder() and
682 * drm_atomic_get_new_connector_for_encoder().
683 *
684 * NOTE: Atomic drivers must fill this out (either themselves or through
685 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
686 * not return correct data to userspace.
687 */
688 struct drm_encoder *best_encoder;
689
690 /**
691 * @link_status: Connector link_status to keep track of whether link is
692 * GOOD or BAD to notify userspace if retraining is necessary.
693 */
694 enum drm_link_status link_status;
695
696 /** @state: backpointer to global drm_atomic_state */
697 struct drm_atomic_state *state;
698
699 /**
700 * @commit: Tracks the pending commit to prevent use-after-free conditions.
701 *
702 * Is only set when @crtc is NULL.
703 */
704 struct drm_crtc_commit *commit;
705
706 /** @tv: TV connector state */
707 struct drm_tv_connector_state tv;
708
709 /**
710 * @self_refresh_aware:
711 *
712 * This tracks whether a connector is aware of the self refresh state.
713 * It should be set to true for those connector implementations which
714 * understand the self refresh state. This is needed since the crtc
715 * registers the self refresh helpers and it doesn't know if the
716 * connectors downstream have implemented self refresh entry/exit.
717 *
718 * Drivers should set this to true in atomic_check if they know how to
719 * handle self_refresh requests.
720 */
721 bool self_refresh_aware;
722
723 /**
724 * @picture_aspect_ratio: Connector property to control the
725 * HDMI infoframe aspect ratio setting.
726 *
727 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
728 * values for &enum hdmi_picture_aspect
729 */
730 enum hdmi_picture_aspect picture_aspect_ratio;
731
732 /**
733 * @content_type: Connector property to control the
734 * HDMI infoframe content type setting.
735 * The %DRM_MODE_CONTENT_TYPE_\* values much
736 * match the values.
737 */
738 unsigned int content_type;
739
740 /**
741 * @hdcp_content_type: Connector property to pass the type of
742 * protected content. This is most commonly used for HDCP.
743 */
744 unsigned int hdcp_content_type;
745
746 /**
747 * @scaling_mode: Connector property to control the
748 * upscaling, mostly used for built-in panels.
749 */
750 unsigned int scaling_mode;
751
752 /**
753 * @content_protection: Connector property to request content
754 * protection. This is most commonly used for HDCP.
755 */
756 unsigned int content_protection;
757
758 /**
759 * @colorspace: State variable for Connector property to request
760 * colorspace change on Sink. This is most commonly used to switch
761 * to wider color gamuts like BT2020.
762 */
763 u32 colorspace;
764
765 /**
766 * @writeback_job: Writeback job for writeback connectors
767 *
768 * Holds the framebuffer and out-fence for a writeback connector. As
769 * the writeback completion may be asynchronous to the normal commit
770 * cycle, the writeback job lifetime is managed separately from the
771 * normal atomic state by this object.
772 *
773 * See also: drm_writeback_queue_job() and
774 * drm_writeback_signal_completion()
775 */
776 struct drm_writeback_job *writeback_job;
777
778 /**
779 * @max_requested_bpc: Connector property to limit the maximum bit
780 * depth of the pixels.
781 */
782 u8 max_requested_bpc;
783
784 /**
785 * @max_bpc: Connector max_bpc based on the requested max_bpc property
786 * and the connector bpc limitations obtained from edid.
787 */
788 u8 max_bpc;
789
790 /**
791 * @hdr_output_metadata:
792 * DRM blob property for HDR output metadata
793 */
794 struct drm_property_blob *hdr_output_metadata;
795 };
796
797 /**
798 * struct drm_connector_funcs - control connectors on a given device
799 *
800 * Each CRTC may have one or more connectors attached to it. The functions
801 * below allow the core DRM code to control connectors, enumerate available modes,
802 * etc.
803 */
804 struct drm_connector_funcs {
805 /**
806 * @dpms:
807 *
808 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
809 * is exposed as a standard property on the connector, but diverted to
810 * this callback in the drm core. Note that atomic drivers don't
811 * implement the 4 level DPMS support on the connector any more, but
812 * instead only have an on/off "ACTIVE" property on the CRTC object.
813 *
814 * This hook is not used by atomic drivers, remapping of the legacy DPMS
815 * property is entirely handled in the DRM core.
816 *
817 * RETURNS:
818 *
819 * 0 on success or a negative error code on failure.
820 */
821 int (*dpms)(struct drm_connector *connector, int mode);
822
823 /**
824 * @reset:
825 *
826 * Reset connector hardware and software state to off. This function isn't
827 * called by the core directly, only through drm_mode_config_reset().
828 * It's not a helper hook only for historical reasons.
829 *
830 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
831 * atomic state using this hook.
832 */
833 void (*reset)(struct drm_connector *connector);
834
835 /**
836 * @detect:
837 *
838 * Check to see if anything is attached to the connector. The parameter
839 * force is set to false whilst polling, true when checking the
840 * connector due to a user request. force can be used by the driver to
841 * avoid expensive, destructive operations during automated probing.
842 *
843 * This callback is optional, if not implemented the connector will be
844 * considered as always being attached.
845 *
846 * FIXME:
847 *
848 * Note that this hook is only called by the probe helper. It's not in
849 * the helper library vtable purely for historical reasons. The only DRM
850 * core entry point to probe connector state is @fill_modes.
851 *
852 * Note that the helper library will already hold
853 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
854 * locks to avoid races with concurrent modeset changes need to use
855 * &drm_connector_helper_funcs.detect_ctx instead.
856 *
857 * Also note that this callback can be called no matter the
858 * state the connector is in. Drivers that need the underlying
859 * device to be powered to perform the detection will first need
860 * to make sure it's been properly enabled.
861 *
862 * RETURNS:
863 *
864 * drm_connector_status indicating the connector's status.
865 */
866 enum drm_connector_status (*detect)(struct drm_connector *connector,
867 bool force);
868
869 /**
870 * @force:
871 *
872 * This function is called to update internal encoder state when the
873 * connector is forced to a certain state by userspace, either through
874 * the sysfs interfaces or on the kernel cmdline. In that case the
875 * @detect callback isn't called.
876 *
877 * FIXME:
878 *
879 * Note that this hook is only called by the probe helper. It's not in
880 * the helper library vtable purely for historical reasons. The only DRM
881 * core entry point to probe connector state is @fill_modes.
882 */
883 void (*force)(struct drm_connector *connector);
884
885 /**
886 * @fill_modes:
887 *
888 * Entry point for output detection and basic mode validation. The
889 * driver should reprobe the output if needed (e.g. when hotplug
890 * handling is unreliable), add all detected modes to &drm_connector.modes
891 * and filter out any the device can't support in any configuration. It
892 * also needs to filter out any modes wider or higher than the
893 * parameters max_width and max_height indicate.
894 *
895 * The drivers must also prune any modes no longer valid from
896 * &drm_connector.modes. Furthermore it must update
897 * &drm_connector.status and &drm_connector.edid. If no EDID has been
898 * received for this output connector->edid must be NULL.
899 *
900 * Drivers using the probe helpers should use
901 * drm_helper_probe_single_connector_modes() to implement this
902 * function.
903 *
904 * RETURNS:
905 *
906 * The number of modes detected and filled into &drm_connector.modes.
907 */
908 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
909
910 /**
911 * @set_property:
912 *
913 * This is the legacy entry point to update a property attached to the
914 * connector.
915 *
916 * This callback is optional if the driver does not support any legacy
917 * driver-private properties. For atomic drivers it is not used because
918 * property handling is done entirely in the DRM core.
919 *
920 * RETURNS:
921 *
922 * 0 on success or a negative error code on failure.
923 */
924 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
925 uint64_t val);
926
927 /**
928 * @late_register:
929 *
930 * This optional hook can be used to register additional userspace
931 * interfaces attached to the connector, light backlight control, i2c,
932 * DP aux or similar interfaces. It is called late in the driver load
933 * sequence from drm_connector_register() when registering all the
934 * core drm connector interfaces. Everything added from this callback
935 * should be unregistered in the early_unregister callback.
936 *
937 * This is called while holding &drm_connector.mutex.
938 *
939 * Returns:
940 *
941 * 0 on success, or a negative error code on failure.
942 */
943 int (*late_register)(struct drm_connector *connector);
944
945 /**
946 * @early_unregister:
947 *
948 * This optional hook should be used to unregister the additional
949 * userspace interfaces attached to the connector from
950 * late_register(). It is called from drm_connector_unregister(),
951 * early in the driver unload sequence to disable userspace access
952 * before data structures are torndown.
953 *
954 * This is called while holding &drm_connector.mutex.
955 */
956 void (*early_unregister)(struct drm_connector *connector);
957
958 /**
959 * @destroy:
960 *
961 * Clean up connector resources. This is called at driver unload time
962 * through drm_mode_config_cleanup(). It can also be called at runtime
963 * when a connector is being hot-unplugged for drivers that support
964 * connector hotplugging (e.g. DisplayPort MST).
965 */
966 void (*destroy)(struct drm_connector *connector);
967
968 /**
969 * @atomic_duplicate_state:
970 *
971 * Duplicate the current atomic state for this connector and return it.
972 * The core and helpers guarantee that any atomic state duplicated with
973 * this hook and still owned by the caller (i.e. not transferred to the
974 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
975 * cleaned up by calling the @atomic_destroy_state hook in this
976 * structure.
977 *
978 * This callback is mandatory for atomic drivers.
979 *
980 * Atomic drivers which don't subclass &struct drm_connector_state should use
981 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
982 * state structure to extend it with driver-private state should use
983 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
984 * duplicated in a consistent fashion across drivers.
985 *
986 * It is an error to call this hook before &drm_connector.state has been
987 * initialized correctly.
988 *
989 * NOTE:
990 *
991 * If the duplicate state references refcounted resources this hook must
992 * acquire a reference for each of them. The driver must release these
993 * references again in @atomic_destroy_state.
994 *
995 * RETURNS:
996 *
997 * Duplicated atomic state or NULL when the allocation failed.
998 */
999 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1000
1001 /**
1002 * @atomic_destroy_state:
1003 *
1004 * Destroy a state duplicated with @atomic_duplicate_state and release
1005 * or unreference all resources it references
1006 *
1007 * This callback is mandatory for atomic drivers.
1008 */
1009 void (*atomic_destroy_state)(struct drm_connector *connector,
1010 struct drm_connector_state *state);
1011
1012 /**
1013 * @atomic_set_property:
1014 *
1015 * Decode a driver-private property value and store the decoded value
1016 * into the passed-in state structure. Since the atomic core decodes all
1017 * standardized properties (even for extensions beyond the core set of
1018 * properties which might not be implemented by all drivers) this
1019 * requires drivers to subclass the state structure.
1020 *
1021 * Such driver-private properties should really only be implemented for
1022 * truly hardware/vendor specific state. Instead it is preferred to
1023 * standardize atomic extension and decode the properties used to expose
1024 * such an extension in the core.
1025 *
1026 * Do not call this function directly, use
1027 * drm_atomic_connector_set_property() instead.
1028 *
1029 * This callback is optional if the driver does not support any
1030 * driver-private atomic properties.
1031 *
1032 * NOTE:
1033 *
1034 * This function is called in the state assembly phase of atomic
1035 * modesets, which can be aborted for any reason (including on
1036 * userspace's request to just check whether a configuration would be
1037 * possible). Drivers MUST NOT touch any persistent state (hardware or
1038 * software) or data structures except the passed in @state parameter.
1039 *
1040 * Also since userspace controls in which order properties are set this
1041 * function must not do any input validation (since the state update is
1042 * incomplete and hence likely inconsistent). Instead any such input
1043 * validation must be done in the various atomic_check callbacks.
1044 *
1045 * RETURNS:
1046 *
1047 * 0 if the property has been found, -EINVAL if the property isn't
1048 * implemented by the driver (which shouldn't ever happen, the core only
1049 * asks for properties attached to this connector). No other validation
1050 * is allowed by the driver. The core already checks that the property
1051 * value is within the range (integer, valid enum value, ...) the driver
1052 * set when registering the property.
1053 */
1054 int (*atomic_set_property)(struct drm_connector *connector,
1055 struct drm_connector_state *state,
1056 struct drm_property *property,
1057 uint64_t val);
1058
1059 /**
1060 * @atomic_get_property:
1061 *
1062 * Reads out the decoded driver-private property. This is used to
1063 * implement the GETCONNECTOR IOCTL.
1064 *
1065 * Do not call this function directly, use
1066 * drm_atomic_connector_get_property() instead.
1067 *
1068 * This callback is optional if the driver does not support any
1069 * driver-private atomic properties.
1070 *
1071 * RETURNS:
1072 *
1073 * 0 on success, -EINVAL if the property isn't implemented by the
1074 * driver (which shouldn't ever happen, the core only asks for
1075 * properties attached to this connector).
1076 */
1077 int (*atomic_get_property)(struct drm_connector *connector,
1078 const struct drm_connector_state *state,
1079 struct drm_property *property,
1080 uint64_t *val);
1081
1082 /**
1083 * @atomic_print_state:
1084 *
1085 * If driver subclasses &struct drm_connector_state, it should implement
1086 * this optional hook for printing additional driver specific state.
1087 *
1088 * Do not call this directly, use drm_atomic_connector_print_state()
1089 * instead.
1090 */
1091 void (*atomic_print_state)(struct drm_printer *p,
1092 const struct drm_connector_state *state);
1093 };
1094
1095 /**
1096 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1097 *
1098 * Each connector can have an initial mode with additional options
1099 * passed through the kernel command line. This structure allows to
1100 * express those parameters and will be filled by the command-line
1101 * parser.
1102 */
1103 struct drm_cmdline_mode {
1104 /**
1105 * @name:
1106 *
1107 * Name of the mode.
1108 */
1109 char name[DRM_DISPLAY_MODE_LEN];
1110
1111 /**
1112 * @specified:
1113 *
1114 * Has a mode been read from the command-line?
1115 */
1116 bool specified;
1117
1118 /**
1119 * @refresh_specified:
1120 *
1121 * Did the mode have a preferred refresh rate?
1122 */
1123 bool refresh_specified;
1124
1125 /**
1126 * @bpp_specified:
1127 *
1128 * Did the mode have a preferred BPP?
1129 */
1130 bool bpp_specified;
1131
1132 /**
1133 * @xres:
1134 *
1135 * Active resolution on the X axis, in pixels.
1136 */
1137 int xres;
1138
1139 /**
1140 * @yres:
1141 *
1142 * Active resolution on the Y axis, in pixels.
1143 */
1144 int yres;
1145
1146 /**
1147 * @bpp:
1148 *
1149 * Bits per pixels for the mode.
1150 */
1151 int bpp;
1152
1153 /**
1154 * @refresh:
1155 *
1156 * Refresh rate, in Hertz.
1157 */
1158 int refresh;
1159
1160 /**
1161 * @rb:
1162 *
1163 * Do we need to use reduced blanking?
1164 */
1165 bool rb;
1166
1167 /**
1168 * @interlace:
1169 *
1170 * The mode is interlaced.
1171 */
1172 bool interlace;
1173
1174 /**
1175 * @cvt:
1176 *
1177 * The timings will be calculated using the VESA Coordinated
1178 * Video Timings instead of looking up the mode from a table.
1179 */
1180 bool cvt;
1181
1182 /**
1183 * @margins:
1184 *
1185 * Add margins to the mode calculation (1.8% of xres rounded
1186 * down to 8 pixels and 1.8% of yres).
1187 */
1188 bool margins;
1189
1190 /**
1191 * @force:
1192 *
1193 * Ignore the hotplug state of the connector, and force its
1194 * state to one of the DRM_FORCE_* values.
1195 */
1196 enum drm_connector_force force;
1197
1198 /**
1199 * @rotation_reflection:
1200 *
1201 * Initial rotation and reflection of the mode setup from the
1202 * command line. See DRM_MODE_ROTATE_* and
1203 * DRM_MODE_REFLECT_*. The only rotations supported are
1204 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1205 */
1206 unsigned int rotation_reflection;
1207
1208 /**
1209 * @panel_orientation:
1210 *
1211 * drm-connector "panel orientation" property override value,
1212 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1213 */
1214 enum drm_panel_orientation panel_orientation;
1215
1216 /**
1217 * @tv_margins: TV margins to apply to the mode.
1218 */
1219 struct drm_connector_tv_margins tv_margins;
1220 };
1221
1222 /**
1223 * struct drm_connector - central DRM connector control structure
1224 *
1225 * Each connector may be connected to one or more CRTCs, or may be clonable by
1226 * another connector if they can share a CRTC. Each connector also has a specific
1227 * position in the broader display (referred to as a 'screen' though it could
1228 * span multiple monitors).
1229 */
1230 struct drm_connector {
1231 /** @dev: parent DRM device */
1232 struct drm_device *dev;
1233 /** @kdev: kernel device for sysfs attributes */
1234 struct device *kdev;
1235 /** @attr: sysfs attributes */
1236 struct device_attribute *attr;
1237
1238 /**
1239 * @head:
1240 *
1241 * List of all connectors on a @dev, linked from
1242 * &drm_mode_config.connector_list. Protected by
1243 * &drm_mode_config.connector_list_lock, but please only use
1244 * &drm_connector_list_iter to walk this list.
1245 */
1246 struct list_head head;
1247
1248 /** @base: base KMS object */
1249 struct drm_mode_object base;
1250
1251 /** @name: human readable name, can be overwritten by the driver */
1252 char *name;
1253
1254 /**
1255 * @mutex: Lock for general connector state, but currently only protects
1256 * @registered. Most of the connector state is still protected by
1257 * &drm_mode_config.mutex.
1258 */
1259 struct mutex mutex;
1260
1261 /**
1262 * @index: Compacted connector index, which matches the position inside
1263 * the mode_config.list for drivers not supporting hot-add/removing. Can
1264 * be used as an array index. It is invariant over the lifetime of the
1265 * connector.
1266 */
1267 unsigned index;
1268
1269 /**
1270 * @connector_type:
1271 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1272 */
1273 int connector_type;
1274 /** @connector_type_id: index into connector type enum */
1275 int connector_type_id;
1276 /**
1277 * @interlace_allowed:
1278 * Can this connector handle interlaced modes? Only used by
1279 * drm_helper_probe_single_connector_modes() for mode filtering.
1280 */
1281 bool interlace_allowed;
1282 /**
1283 * @doublescan_allowed:
1284 * Can this connector handle doublescan? Only used by
1285 * drm_helper_probe_single_connector_modes() for mode filtering.
1286 */
1287 bool doublescan_allowed;
1288 /**
1289 * @stereo_allowed:
1290 * Can this connector handle stereo modes? Only used by
1291 * drm_helper_probe_single_connector_modes() for mode filtering.
1292 */
1293 bool stereo_allowed;
1294
1295 /**
1296 * @ycbcr_420_allowed : This bool indicates if this connector is
1297 * capable of handling YCBCR 420 output. While parsing the EDID
1298 * blocks it's very helpful to know if the source is capable of
1299 * handling YCBCR 420 outputs.
1300 */
1301 bool ycbcr_420_allowed;
1302
1303 /**
1304 * @registration_state: Is this connector initializing, exposed
1305 * (registered) with userspace, or unregistered?
1306 *
1307 * Protected by @mutex.
1308 */
1309 enum drm_connector_registration_state registration_state;
1310
1311 /**
1312 * @modes:
1313 * Modes available on this connector (from fill_modes() + user).
1314 * Protected by &drm_mode_config.mutex.
1315 */
1316 struct list_head modes;
1317
1318 /**
1319 * @status:
1320 * One of the drm_connector_status enums (connected, not, or unknown).
1321 * Protected by &drm_mode_config.mutex.
1322 */
1323 enum drm_connector_status status;
1324
1325 /**
1326 * @probed_modes:
1327 * These are modes added by probing with DDC or the BIOS, before
1328 * filtering is applied. Used by the probe helpers. Protected by
1329 * &drm_mode_config.mutex.
1330 */
1331 struct list_head probed_modes;
1332
1333 /**
1334 * @display_info: Display information is filled from EDID information
1335 * when a display is detected. For non hot-pluggable displays such as
1336 * flat panels in embedded systems, the driver should initialize the
1337 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1338 * with the physical size of the display.
1339 *
1340 * Protected by &drm_mode_config.mutex.
1341 */
1342 struct drm_display_info display_info;
1343
1344 /** @funcs: connector control functions */
1345 const struct drm_connector_funcs *funcs;
1346
1347 /**
1348 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1349 * &drm_mode_config.mutex. This should be updated only by calling
1350 * drm_connector_update_edid_property().
1351 */
1352 struct drm_property_blob *edid_blob_ptr;
1353
1354 /** @properties: property tracking for this connector */
1355 struct drm_object_properties properties;
1356
1357 /**
1358 * @scaling_mode_property: Optional atomic property to control the
1359 * upscaling. See drm_connector_attach_content_protection_property().
1360 */
1361 struct drm_property *scaling_mode_property;
1362
1363 /**
1364 * @vrr_capable_property: Optional property to help userspace
1365 * query hardware support for variable refresh rate on a connector.
1366 * connector. Drivers can add the property to a connector by
1367 * calling drm_connector_attach_vrr_capable_property().
1368 *
1369 * This should be updated only by calling
1370 * drm_connector_set_vrr_capable_property().
1371 */
1372 struct drm_property *vrr_capable_property;
1373
1374 /**
1375 * @colorspace_property: Connector property to set the suitable
1376 * colorspace supported by the sink.
1377 */
1378 struct drm_property *colorspace_property;
1379
1380 /**
1381 * @path_blob_ptr:
1382 *
1383 * DRM blob property data for the DP MST path property. This should only
1384 * be updated by calling drm_connector_set_path_property().
1385 */
1386 struct drm_property_blob *path_blob_ptr;
1387
1388 /**
1389 * @max_bpc_property: Default connector property for the max bpc to be
1390 * driven out of the connector.
1391 */
1392 struct drm_property *max_bpc_property;
1393
1394 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1395 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1396 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1397
1398 /**
1399 * @polled:
1400 *
1401 * Connector polling mode, a combination of
1402 *
1403 * DRM_CONNECTOR_POLL_HPD
1404 * The connector generates hotplug events and doesn't need to be
1405 * periodically polled. The CONNECT and DISCONNECT flags must not
1406 * be set together with the HPD flag.
1407 *
1408 * DRM_CONNECTOR_POLL_CONNECT
1409 * Periodically poll the connector for connection.
1410 *
1411 * DRM_CONNECTOR_POLL_DISCONNECT
1412 * Periodically poll the connector for disconnection, without
1413 * causing flickering even when the connector is in use. DACs should
1414 * rarely do this without a lot of testing.
1415 *
1416 * Set to 0 for connectors that don't support connection status
1417 * discovery.
1418 */
1419 uint8_t polled;
1420
1421 /**
1422 * @dpms: Current dpms state. For legacy drivers the
1423 * &drm_connector_funcs.dpms callback must update this. For atomic
1424 * drivers, this is handled by the core atomic code, and drivers must
1425 * only take &drm_crtc_state.active into account.
1426 */
1427 int dpms;
1428
1429 /** @helper_private: mid-layer private data */
1430 const struct drm_connector_helper_funcs *helper_private;
1431
1432 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1433 struct drm_cmdline_mode cmdline_mode;
1434 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1435 enum drm_connector_force force;
1436 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1437 bool override_edid;
1438 /** @epoch_counter: used to detect any other changes in connector, besides status */
1439 u64 epoch_counter;
1440
1441 /**
1442 * @possible_encoders: Bit mask of encoders that can drive this
1443 * connector, drm_encoder_index() determines the index into the bitfield
1444 * and the bits are set with drm_connector_attach_encoder().
1445 */
1446 u32 possible_encoders;
1447
1448 /**
1449 * @encoder: Currently bound encoder driving this connector, if any.
1450 * Only really meaningful for non-atomic drivers. Atomic drivers should
1451 * instead look at &drm_connector_state.best_encoder, and in case they
1452 * need the CRTC driving this output, &drm_connector_state.crtc.
1453 */
1454 struct drm_encoder *encoder;
1455
1456 #define MAX_ELD_BYTES 128
1457 /** @eld: EDID-like data, if present */
1458 uint8_t eld[MAX_ELD_BYTES];
1459 /** @latency_present: AV delay info from ELD, if found */
1460 bool latency_present[2];
1461 /**
1462 * @video_latency: Video latency info from ELD, if found.
1463 * [0]: progressive, [1]: interlaced
1464 */
1465 int video_latency[2];
1466 /**
1467 * @audio_latency: audio latency info from ELD, if found
1468 * [0]: progressive, [1]: interlaced
1469 */
1470 int audio_latency[2];
1471
1472 /**
1473 * @ddc: associated ddc adapter.
1474 * A connector usually has its associated ddc adapter. If a driver uses
1475 * this field, then an appropriate symbolic link is created in connector
1476 * sysfs directory to make it easy for the user to tell which i2c
1477 * adapter is for a particular display.
1478 *
1479 * The field should be set by calling drm_connector_init_with_ddc().
1480 */
1481 struct i2c_adapter *ddc;
1482
1483 /**
1484 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1485 * Needed to workaround some HW bugs where we get all 0s
1486 */
1487 int null_edid_counter;
1488
1489 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1490 unsigned bad_edid_counter;
1491
1492 /**
1493 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1494 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1495 * rev1.1 4.2.2.6
1496 */
1497 bool edid_corrupt;
1498 /**
1499 * @real_edid_checksum: real edid checksum for corrupted edid block.
1500 * Required in Displayport 1.4 compliance testing
1501 * rev1.1 4.2.2.6
1502 */
1503 u8 real_edid_checksum;
1504
1505 /** @debugfs_entry: debugfs directory for this connector */
1506 struct dentry *debugfs_entry;
1507
1508 /**
1509 * @state:
1510 *
1511 * Current atomic state for this connector.
1512 *
1513 * This is protected by &drm_mode_config.connection_mutex. Note that
1514 * nonblocking atomic commits access the current connector state without
1515 * taking locks. Either by going through the &struct drm_atomic_state
1516 * pointers, see for_each_oldnew_connector_in_state(),
1517 * for_each_old_connector_in_state() and
1518 * for_each_new_connector_in_state(). Or through careful ordering of
1519 * atomic commit operations as implemented in the atomic helpers, see
1520 * &struct drm_crtc_commit.
1521 */
1522 struct drm_connector_state *state;
1523
1524 /* DisplayID bits. FIXME: Extract into a substruct? */
1525
1526 /**
1527 * @tile_blob_ptr:
1528 *
1529 * DRM blob property data for the tile property (used mostly by DP MST).
1530 * This is meant for screens which are driven through separate display
1531 * pipelines represented by &drm_crtc, which might not be running with
1532 * genlocked clocks. For tiled panels which are genlocked, like
1533 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1534 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1535 *
1536 * This should only be updated by calling
1537 * drm_connector_set_tile_property().
1538 */
1539 struct drm_property_blob *tile_blob_ptr;
1540
1541 /** @has_tile: is this connector connected to a tiled monitor */
1542 bool has_tile;
1543 /** @tile_group: tile group for the connected monitor */
1544 struct drm_tile_group *tile_group;
1545 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1546 bool tile_is_single_monitor;
1547
1548 /** @num_h_tile: number of horizontal tiles in the tile group */
1549 /** @num_v_tile: number of vertical tiles in the tile group */
1550 uint8_t num_h_tile, num_v_tile;
1551 /** @tile_h_loc: horizontal location of this tile */
1552 /** @tile_v_loc: vertical location of this tile */
1553 uint8_t tile_h_loc, tile_v_loc;
1554 /** @tile_h_size: horizontal size of this tile. */
1555 /** @tile_v_size: vertical size of this tile. */
1556 uint16_t tile_h_size, tile_v_size;
1557
1558 /**
1559 * @free_node:
1560 *
1561 * List used only by &drm_connector_list_iter to be able to clean up a
1562 * connector from any context, in conjunction with
1563 * &drm_mode_config.connector_free_work.
1564 */
1565 struct llist_node free_node;
1566
1567 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1568 struct hdr_sink_metadata hdr_sink_metadata;
1569 };
1570
1571 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1572
1573 int drm_connector_init(struct drm_device *dev,
1574 struct drm_connector *connector,
1575 const struct drm_connector_funcs *funcs,
1576 int connector_type);
1577 int drm_connector_init_with_ddc(struct drm_device *dev,
1578 struct drm_connector *connector,
1579 const struct drm_connector_funcs *funcs,
1580 int connector_type,
1581 struct i2c_adapter *ddc);
1582 void drm_connector_attach_edid_property(struct drm_connector *connector);
1583 int drm_connector_register(struct drm_connector *connector);
1584 void drm_connector_unregister(struct drm_connector *connector);
1585 int drm_connector_attach_encoder(struct drm_connector *connector,
1586 struct drm_encoder *encoder);
1587
1588 void drm_connector_cleanup(struct drm_connector *connector);
1589
drm_connector_index(const struct drm_connector * connector)1590 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1591 {
1592 return connector->index;
1593 }
1594
drm_connector_mask(const struct drm_connector * connector)1595 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1596 {
1597 return 1 << connector->index;
1598 }
1599
1600 /**
1601 * drm_connector_lookup - lookup connector object
1602 * @dev: DRM device
1603 * @file_priv: drm file to check for lease against.
1604 * @id: connector object id
1605 *
1606 * This function looks up the connector object specified by id
1607 * add takes a reference to it.
1608 */
drm_connector_lookup(struct drm_device * dev,struct drm_file * file_priv,uint32_t id)1609 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1610 struct drm_file *file_priv,
1611 uint32_t id)
1612 {
1613 struct drm_mode_object *mo;
1614 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1615 return mo ? obj_to_connector(mo) : NULL;
1616 }
1617
1618 /**
1619 * drm_connector_get - acquire a connector reference
1620 * @connector: DRM connector
1621 *
1622 * This function increments the connector's refcount.
1623 */
drm_connector_get(struct drm_connector * connector)1624 static inline void drm_connector_get(struct drm_connector *connector)
1625 {
1626 drm_mode_object_get(&connector->base);
1627 }
1628
1629 /**
1630 * drm_connector_put - release a connector reference
1631 * @connector: DRM connector
1632 *
1633 * This function decrements the connector's reference count and frees the
1634 * object if the reference count drops to zero.
1635 */
drm_connector_put(struct drm_connector * connector)1636 static inline void drm_connector_put(struct drm_connector *connector)
1637 {
1638 drm_mode_object_put(&connector->base);
1639 }
1640
1641 /**
1642 * drm_connector_is_unregistered - has the connector been unregistered from
1643 * userspace?
1644 * @connector: DRM connector
1645 *
1646 * Checks whether or not @connector has been unregistered from userspace.
1647 *
1648 * Returns:
1649 * True if the connector was unregistered, false if the connector is
1650 * registered or has not yet been registered with userspace.
1651 */
1652 static inline bool
drm_connector_is_unregistered(struct drm_connector * connector)1653 drm_connector_is_unregistered(struct drm_connector *connector)
1654 {
1655 return READ_ONCE(connector->registration_state) ==
1656 DRM_CONNECTOR_UNREGISTERED;
1657 }
1658
1659 const char *drm_get_connector_type_name(unsigned int connector_type);
1660 const char *drm_get_connector_status_name(enum drm_connector_status status);
1661 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1662 const char *drm_get_dpms_name(int val);
1663 const char *drm_get_dvi_i_subconnector_name(int val);
1664 const char *drm_get_dvi_i_select_name(int val);
1665 const char *drm_get_tv_subconnector_name(int val);
1666 const char *drm_get_tv_select_name(int val);
1667 const char *drm_get_dp_subconnector_name(int val);
1668 const char *drm_get_content_protection_name(int val);
1669 const char *drm_get_hdcp_content_type_name(int val);
1670
1671 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1672 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
1673
1674 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1675 int drm_mode_create_tv_properties(struct drm_device *dev,
1676 unsigned int num_modes,
1677 const char * const modes[]);
1678 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1679 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1680 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1681 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1682 u32 scaling_mode_mask);
1683 int drm_connector_attach_vrr_capable_property(
1684 struct drm_connector *connector);
1685 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
1686 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
1687 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
1688 struct drm_connector_state *new_state);
1689 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1690 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector);
1691 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector);
1692 int drm_mode_create_content_type_property(struct drm_device *dev);
1693 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1694 const struct drm_connector_state *conn_state);
1695
1696 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1697
1698 int drm_connector_set_path_property(struct drm_connector *connector,
1699 const char *path);
1700 int drm_connector_set_tile_property(struct drm_connector *connector);
1701 int drm_connector_update_edid_property(struct drm_connector *connector,
1702 const struct edid *edid);
1703 void drm_connector_set_link_status_property(struct drm_connector *connector,
1704 uint64_t link_status);
1705 void drm_connector_set_vrr_capable_property(
1706 struct drm_connector *connector, bool capable);
1707 int drm_connector_set_panel_orientation(
1708 struct drm_connector *connector,
1709 enum drm_panel_orientation panel_orientation);
1710 int drm_connector_set_panel_orientation_with_quirk(
1711 struct drm_connector *connector,
1712 enum drm_panel_orientation panel_orientation,
1713 int width, int height);
1714 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1715 int min, int max);
1716
1717 /**
1718 * struct drm_tile_group - Tile group metadata
1719 * @refcount: reference count
1720 * @dev: DRM device
1721 * @id: tile group id exposed to userspace
1722 * @group_data: Sink-private data identifying this group
1723 *
1724 * @group_data corresponds to displayid vend/prod/serial for external screens
1725 * with an EDID.
1726 */
1727 struct drm_tile_group {
1728 struct kref refcount;
1729 struct drm_device *dev;
1730 int id;
1731 u8 group_data[8];
1732 };
1733
1734 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1735 const char topology[8]);
1736 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1737 const char topology[8]);
1738 void drm_mode_put_tile_group(struct drm_device *dev,
1739 struct drm_tile_group *tg);
1740
1741 /**
1742 * struct drm_connector_list_iter - connector_list iterator
1743 *
1744 * This iterator tracks state needed to be able to walk the connector_list
1745 * within struct drm_mode_config. Only use together with
1746 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1747 * drm_connector_list_iter_next() respectively the convenience macro
1748 * drm_for_each_connector_iter().
1749 *
1750 * Note that the return value of drm_connector_list_iter_next() is only valid
1751 * up to the next drm_connector_list_iter_next() or
1752 * drm_connector_list_iter_end() call. If you want to use the connector later,
1753 * then you need to grab your own reference first using drm_connector_get().
1754 */
1755 struct drm_connector_list_iter {
1756 /* private: */
1757 struct drm_device *dev;
1758 struct drm_connector *conn;
1759 };
1760
1761 void drm_connector_list_iter_begin(struct drm_device *dev,
1762 struct drm_connector_list_iter *iter);
1763 struct drm_connector *
1764 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1765 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1766
1767 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1768 struct drm_encoder *encoder);
1769
1770 /**
1771 * drm_for_each_connector_iter - connector_list iterator macro
1772 * @connector: &struct drm_connector pointer used as cursor
1773 * @iter: &struct drm_connector_list_iter
1774 *
1775 * Note that @connector is only valid within the list body, if you want to use
1776 * @connector after calling drm_connector_list_iter_end() then you need to grab
1777 * your own reference first using drm_connector_get().
1778 */
1779 #define drm_for_each_connector_iter(connector, iter) \
1780 while ((connector = drm_connector_list_iter_next(iter)))
1781
1782 /**
1783 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1784 * @connector: &struct drm_connector pointer
1785 * @encoder: &struct drm_encoder pointer used as cursor
1786 */
1787 #define drm_connector_for_each_possible_encoder(connector, encoder) \
1788 drm_for_each_encoder_mask(encoder, (connector)->dev, \
1789 (connector)->possible_encoders)
1790
1791 #endif
1792