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_dc_modes: Mask of supported hdmi deep color modes. Even
570 * more stuff redundant with @bus_formats.
571 */
572 u8 edid_hdmi_dc_modes;
573
574 /**
575 * @cea_rev: CEA revision of the HDMI sink.
576 */
577 u8 cea_rev;
578
579 /**
580 * @hdmi: advance features of a HDMI sink.
581 */
582 struct drm_hdmi_info hdmi;
583
584 /**
585 * @non_desktop: Non desktop display (HMD).
586 */
587 bool non_desktop;
588
589 /**
590 * @monitor_range: Frequency range supported by monitor range descriptor
591 */
592 struct drm_monitor_range_info monitor_range;
593
594 /**
595 * @mso_stream_count: eDP Multi-SST Operation (MSO) stream count from
596 * the DisplayID VESA vendor block. 0 for conventional Single-Stream
597 * Transport (SST), or 2 or 4 MSO streams.
598 */
599 u8 mso_stream_count;
600
601 /**
602 * @mso_pixel_overlap: eDP MSO segment pixel overlap, 0-8 pixels.
603 */
604 u8 mso_pixel_overlap;
605 };
606
607 int drm_display_info_set_bus_formats(struct drm_display_info *info,
608 const u32 *formats,
609 unsigned int num_formats);
610
611 /**
612 * struct drm_connector_tv_margins - TV connector related margins
613 *
614 * Describes the margins in pixels to put around the image on TV
615 * connectors to deal with overscan.
616 */
617 struct drm_connector_tv_margins {
618 /**
619 * @bottom: Bottom margin in pixels.
620 */
621 unsigned int bottom;
622
623 /**
624 * @left: Left margin in pixels.
625 */
626 unsigned int left;
627
628 /**
629 * @right: Right margin in pixels.
630 */
631 unsigned int right;
632
633 /**
634 * @top: Top margin in pixels.
635 */
636 unsigned int top;
637 };
638
639 /**
640 * struct drm_tv_connector_state - TV connector related states
641 * @subconnector: selected subconnector
642 * @margins: TV margins
643 * @mode: TV mode
644 * @brightness: brightness in percent
645 * @contrast: contrast in percent
646 * @flicker_reduction: flicker reduction in percent
647 * @overscan: overscan in percent
648 * @saturation: saturation in percent
649 * @hue: hue in percent
650 */
651 struct drm_tv_connector_state {
652 enum drm_mode_subconnector subconnector;
653 struct drm_connector_tv_margins margins;
654 unsigned int mode;
655 unsigned int brightness;
656 unsigned int contrast;
657 unsigned int flicker_reduction;
658 unsigned int overscan;
659 unsigned int saturation;
660 unsigned int hue;
661 };
662
663 /**
664 * struct drm_connector_state - mutable connector state
665 */
666 struct drm_connector_state {
667 /** @connector: backpointer to the connector */
668 struct drm_connector *connector;
669
670 /**
671 * @crtc: CRTC to connect connector to, NULL if disabled.
672 *
673 * Do not change this directly, use drm_atomic_set_crtc_for_connector()
674 * instead.
675 */
676 struct drm_crtc *crtc;
677
678 /**
679 * @best_encoder:
680 *
681 * Used by the atomic helpers to select the encoder, through the
682 * &drm_connector_helper_funcs.atomic_best_encoder or
683 * &drm_connector_helper_funcs.best_encoder callbacks.
684 *
685 * This is also used in the atomic helpers to map encoders to their
686 * current and previous connectors, see
687 * drm_atomic_get_old_connector_for_encoder() and
688 * drm_atomic_get_new_connector_for_encoder().
689 *
690 * NOTE: Atomic drivers must fill this out (either themselves or through
691 * helpers), for otherwise the GETCONNECTOR and GETENCODER IOCTLs will
692 * not return correct data to userspace.
693 */
694 struct drm_encoder *best_encoder;
695
696 /**
697 * @link_status: Connector link_status to keep track of whether link is
698 * GOOD or BAD to notify userspace if retraining is necessary.
699 */
700 enum drm_link_status link_status;
701
702 /** @state: backpointer to global drm_atomic_state */
703 struct drm_atomic_state *state;
704
705 /**
706 * @commit: Tracks the pending commit to prevent use-after-free conditions.
707 *
708 * Is only set when @crtc is NULL.
709 */
710 struct drm_crtc_commit *commit;
711
712 /** @tv: TV connector state */
713 struct drm_tv_connector_state tv;
714
715 /**
716 * @self_refresh_aware:
717 *
718 * This tracks whether a connector is aware of the self refresh state.
719 * It should be set to true for those connector implementations which
720 * understand the self refresh state. This is needed since the crtc
721 * registers the self refresh helpers and it doesn't know if the
722 * connectors downstream have implemented self refresh entry/exit.
723 *
724 * Drivers should set this to true in atomic_check if they know how to
725 * handle self_refresh requests.
726 */
727 bool self_refresh_aware;
728
729 /**
730 * @picture_aspect_ratio: Connector property to control the
731 * HDMI infoframe aspect ratio setting.
732 *
733 * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
734 * values for &enum hdmi_picture_aspect
735 */
736 enum hdmi_picture_aspect picture_aspect_ratio;
737
738 /**
739 * @content_type: Connector property to control the
740 * HDMI infoframe content type setting.
741 * The %DRM_MODE_CONTENT_TYPE_\* values much
742 * match the values.
743 */
744 unsigned int content_type;
745
746 /**
747 * @hdcp_content_type: Connector property to pass the type of
748 * protected content. This is most commonly used for HDCP.
749 */
750 unsigned int hdcp_content_type;
751
752 /**
753 * @scaling_mode: Connector property to control the
754 * upscaling, mostly used for built-in panels.
755 */
756 unsigned int scaling_mode;
757
758 /**
759 * @content_protection: Connector property to request content
760 * protection. This is most commonly used for HDCP.
761 */
762 unsigned int content_protection;
763
764 /**
765 * @colorspace: State variable for Connector property to request
766 * colorspace change on Sink. This is most commonly used to switch
767 * to wider color gamuts like BT2020.
768 */
769 u32 colorspace;
770
771 /**
772 * @writeback_job: Writeback job for writeback connectors
773 *
774 * Holds the framebuffer and out-fence for a writeback connector. As
775 * the writeback completion may be asynchronous to the normal commit
776 * cycle, the writeback job lifetime is managed separately from the
777 * normal atomic state by this object.
778 *
779 * See also: drm_writeback_queue_job() and
780 * drm_writeback_signal_completion()
781 */
782 struct drm_writeback_job *writeback_job;
783
784 /**
785 * @max_requested_bpc: Connector property to limit the maximum bit
786 * depth of the pixels.
787 */
788 u8 max_requested_bpc;
789
790 /**
791 * @max_bpc: Connector max_bpc based on the requested max_bpc property
792 * and the connector bpc limitations obtained from edid.
793 */
794 u8 max_bpc;
795
796 /**
797 * @hdr_output_metadata:
798 * DRM blob property for HDR output metadata
799 */
800 struct drm_property_blob *hdr_output_metadata;
801 };
802
803 /**
804 * struct drm_connector_funcs - control connectors on a given device
805 *
806 * Each CRTC may have one or more connectors attached to it. The functions
807 * below allow the core DRM code to control connectors, enumerate available modes,
808 * etc.
809 */
810 struct drm_connector_funcs {
811 /**
812 * @dpms:
813 *
814 * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
815 * is exposed as a standard property on the connector, but diverted to
816 * this callback in the drm core. Note that atomic drivers don't
817 * implement the 4 level DPMS support on the connector any more, but
818 * instead only have an on/off "ACTIVE" property on the CRTC object.
819 *
820 * This hook is not used by atomic drivers, remapping of the legacy DPMS
821 * property is entirely handled in the DRM core.
822 *
823 * RETURNS:
824 *
825 * 0 on success or a negative error code on failure.
826 */
827 int (*dpms)(struct drm_connector *connector, int mode);
828
829 /**
830 * @reset:
831 *
832 * Reset connector hardware and software state to off. This function isn't
833 * called by the core directly, only through drm_mode_config_reset().
834 * It's not a helper hook only for historical reasons.
835 *
836 * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
837 * atomic state using this hook.
838 */
839 void (*reset)(struct drm_connector *connector);
840
841 /**
842 * @detect:
843 *
844 * Check to see if anything is attached to the connector. The parameter
845 * force is set to false whilst polling, true when checking the
846 * connector due to a user request. force can be used by the driver to
847 * avoid expensive, destructive operations during automated probing.
848 *
849 * This callback is optional, if not implemented the connector will be
850 * considered as always being attached.
851 *
852 * FIXME:
853 *
854 * Note that this hook is only called by the probe helper. It's not in
855 * the helper library vtable purely for historical reasons. The only DRM
856 * core entry point to probe connector state is @fill_modes.
857 *
858 * Note that the helper library will already hold
859 * &drm_mode_config.connection_mutex. Drivers which need to grab additional
860 * locks to avoid races with concurrent modeset changes need to use
861 * &drm_connector_helper_funcs.detect_ctx instead.
862 *
863 * Also note that this callback can be called no matter the
864 * state the connector is in. Drivers that need the underlying
865 * device to be powered to perform the detection will first need
866 * to make sure it's been properly enabled.
867 *
868 * RETURNS:
869 *
870 * drm_connector_status indicating the connector's status.
871 */
872 enum drm_connector_status (*detect)(struct drm_connector *connector,
873 bool force);
874
875 /**
876 * @force:
877 *
878 * This function is called to update internal encoder state when the
879 * connector is forced to a certain state by userspace, either through
880 * the sysfs interfaces or on the kernel cmdline. In that case the
881 * @detect callback isn't called.
882 *
883 * FIXME:
884 *
885 * Note that this hook is only called by the probe helper. It's not in
886 * the helper library vtable purely for historical reasons. The only DRM
887 * core entry point to probe connector state is @fill_modes.
888 */
889 void (*force)(struct drm_connector *connector);
890
891 /**
892 * @fill_modes:
893 *
894 * Entry point for output detection and basic mode validation. The
895 * driver should reprobe the output if needed (e.g. when hotplug
896 * handling is unreliable), add all detected modes to &drm_connector.modes
897 * and filter out any the device can't support in any configuration. It
898 * also needs to filter out any modes wider or higher than the
899 * parameters max_width and max_height indicate.
900 *
901 * The drivers must also prune any modes no longer valid from
902 * &drm_connector.modes. Furthermore it must update
903 * &drm_connector.status and &drm_connector.edid. If no EDID has been
904 * received for this output connector->edid must be NULL.
905 *
906 * Drivers using the probe helpers should use
907 * drm_helper_probe_single_connector_modes() to implement this
908 * function.
909 *
910 * RETURNS:
911 *
912 * The number of modes detected and filled into &drm_connector.modes.
913 */
914 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
915
916 /**
917 * @set_property:
918 *
919 * This is the legacy entry point to update a property attached to the
920 * connector.
921 *
922 * This callback is optional if the driver does not support any legacy
923 * driver-private properties. For atomic drivers it is not used because
924 * property handling is done entirely in the DRM core.
925 *
926 * RETURNS:
927 *
928 * 0 on success or a negative error code on failure.
929 */
930 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
931 uint64_t val);
932
933 /**
934 * @late_register:
935 *
936 * This optional hook can be used to register additional userspace
937 * interfaces attached to the connector, light backlight control, i2c,
938 * DP aux or similar interfaces. It is called late in the driver load
939 * sequence from drm_connector_register() when registering all the
940 * core drm connector interfaces. Everything added from this callback
941 * should be unregistered in the early_unregister callback.
942 *
943 * This is called while holding &drm_connector.mutex.
944 *
945 * Returns:
946 *
947 * 0 on success, or a negative error code on failure.
948 */
949 int (*late_register)(struct drm_connector *connector);
950
951 /**
952 * @early_unregister:
953 *
954 * This optional hook should be used to unregister the additional
955 * userspace interfaces attached to the connector from
956 * late_register(). It is called from drm_connector_unregister(),
957 * early in the driver unload sequence to disable userspace access
958 * before data structures are torndown.
959 *
960 * This is called while holding &drm_connector.mutex.
961 */
962 void (*early_unregister)(struct drm_connector *connector);
963
964 /**
965 * @destroy:
966 *
967 * Clean up connector resources. This is called at driver unload time
968 * through drm_mode_config_cleanup(). It can also be called at runtime
969 * when a connector is being hot-unplugged for drivers that support
970 * connector hotplugging (e.g. DisplayPort MST).
971 */
972 void (*destroy)(struct drm_connector *connector);
973
974 /**
975 * @atomic_duplicate_state:
976 *
977 * Duplicate the current atomic state for this connector and return it.
978 * The core and helpers guarantee that any atomic state duplicated with
979 * this hook and still owned by the caller (i.e. not transferred to the
980 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
981 * cleaned up by calling the @atomic_destroy_state hook in this
982 * structure.
983 *
984 * This callback is mandatory for atomic drivers.
985 *
986 * Atomic drivers which don't subclass &struct drm_connector_state should use
987 * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
988 * state structure to extend it with driver-private state should use
989 * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
990 * duplicated in a consistent fashion across drivers.
991 *
992 * It is an error to call this hook before &drm_connector.state has been
993 * initialized correctly.
994 *
995 * NOTE:
996 *
997 * If the duplicate state references refcounted resources this hook must
998 * acquire a reference for each of them. The driver must release these
999 * references again in @atomic_destroy_state.
1000 *
1001 * RETURNS:
1002 *
1003 * Duplicated atomic state or NULL when the allocation failed.
1004 */
1005 struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
1006
1007 /**
1008 * @atomic_destroy_state:
1009 *
1010 * Destroy a state duplicated with @atomic_duplicate_state and release
1011 * or unreference all resources it references
1012 *
1013 * This callback is mandatory for atomic drivers.
1014 */
1015 void (*atomic_destroy_state)(struct drm_connector *connector,
1016 struct drm_connector_state *state);
1017
1018 /**
1019 * @atomic_set_property:
1020 *
1021 * Decode a driver-private property value and store the decoded value
1022 * into the passed-in state structure. Since the atomic core decodes all
1023 * standardized properties (even for extensions beyond the core set of
1024 * properties which might not be implemented by all drivers) this
1025 * requires drivers to subclass the state structure.
1026 *
1027 * Such driver-private properties should really only be implemented for
1028 * truly hardware/vendor specific state. Instead it is preferred to
1029 * standardize atomic extension and decode the properties used to expose
1030 * such an extension in the core.
1031 *
1032 * Do not call this function directly, use
1033 * drm_atomic_connector_set_property() instead.
1034 *
1035 * This callback is optional if the driver does not support any
1036 * driver-private atomic properties.
1037 *
1038 * NOTE:
1039 *
1040 * This function is called in the state assembly phase of atomic
1041 * modesets, which can be aborted for any reason (including on
1042 * userspace's request to just check whether a configuration would be
1043 * possible). Drivers MUST NOT touch any persistent state (hardware or
1044 * software) or data structures except the passed in @state parameter.
1045 *
1046 * Also since userspace controls in which order properties are set this
1047 * function must not do any input validation (since the state update is
1048 * incomplete and hence likely inconsistent). Instead any such input
1049 * validation must be done in the various atomic_check callbacks.
1050 *
1051 * RETURNS:
1052 *
1053 * 0 if the property has been found, -EINVAL if the property isn't
1054 * implemented by the driver (which shouldn't ever happen, the core only
1055 * asks for properties attached to this connector). No other validation
1056 * is allowed by the driver. The core already checks that the property
1057 * value is within the range (integer, valid enum value, ...) the driver
1058 * set when registering the property.
1059 */
1060 int (*atomic_set_property)(struct drm_connector *connector,
1061 struct drm_connector_state *state,
1062 struct drm_property *property,
1063 uint64_t val);
1064
1065 /**
1066 * @atomic_get_property:
1067 *
1068 * Reads out the decoded driver-private property. This is used to
1069 * implement the GETCONNECTOR IOCTL.
1070 *
1071 * Do not call this function directly, use
1072 * drm_atomic_connector_get_property() instead.
1073 *
1074 * This callback is optional if the driver does not support any
1075 * driver-private atomic properties.
1076 *
1077 * RETURNS:
1078 *
1079 * 0 on success, -EINVAL if the property isn't implemented by the
1080 * driver (which shouldn't ever happen, the core only asks for
1081 * properties attached to this connector).
1082 */
1083 int (*atomic_get_property)(struct drm_connector *connector,
1084 const struct drm_connector_state *state,
1085 struct drm_property *property,
1086 uint64_t *val);
1087
1088 /**
1089 * @atomic_print_state:
1090 *
1091 * If driver subclasses &struct drm_connector_state, it should implement
1092 * this optional hook for printing additional driver specific state.
1093 *
1094 * Do not call this directly, use drm_atomic_connector_print_state()
1095 * instead.
1096 */
1097 void (*atomic_print_state)(struct drm_printer *p,
1098 const struct drm_connector_state *state);
1099
1100 /**
1101 * @oob_hotplug_event:
1102 *
1103 * This will get called when a hotplug-event for a drm-connector
1104 * has been received from a source outside the display driver / device.
1105 */
1106 void (*oob_hotplug_event)(struct drm_connector *connector);
1107 };
1108
1109 /**
1110 * struct drm_cmdline_mode - DRM Mode passed through the kernel command-line
1111 *
1112 * Each connector can have an initial mode with additional options
1113 * passed through the kernel command line. This structure allows to
1114 * express those parameters and will be filled by the command-line
1115 * parser.
1116 */
1117 struct drm_cmdline_mode {
1118 /**
1119 * @name:
1120 *
1121 * Name of the mode.
1122 */
1123 char name[DRM_DISPLAY_MODE_LEN];
1124
1125 /**
1126 * @specified:
1127 *
1128 * Has a mode been read from the command-line?
1129 */
1130 bool specified;
1131
1132 /**
1133 * @refresh_specified:
1134 *
1135 * Did the mode have a preferred refresh rate?
1136 */
1137 bool refresh_specified;
1138
1139 /**
1140 * @bpp_specified:
1141 *
1142 * Did the mode have a preferred BPP?
1143 */
1144 bool bpp_specified;
1145
1146 /**
1147 * @xres:
1148 *
1149 * Active resolution on the X axis, in pixels.
1150 */
1151 int xres;
1152
1153 /**
1154 * @yres:
1155 *
1156 * Active resolution on the Y axis, in pixels.
1157 */
1158 int yres;
1159
1160 /**
1161 * @bpp:
1162 *
1163 * Bits per pixels for the mode.
1164 */
1165 int bpp;
1166
1167 /**
1168 * @refresh:
1169 *
1170 * Refresh rate, in Hertz.
1171 */
1172 int refresh;
1173
1174 /**
1175 * @rb:
1176 *
1177 * Do we need to use reduced blanking?
1178 */
1179 bool rb;
1180
1181 /**
1182 * @interlace:
1183 *
1184 * The mode is interlaced.
1185 */
1186 bool interlace;
1187
1188 /**
1189 * @cvt:
1190 *
1191 * The timings will be calculated using the VESA Coordinated
1192 * Video Timings instead of looking up the mode from a table.
1193 */
1194 bool cvt;
1195
1196 /**
1197 * @margins:
1198 *
1199 * Add margins to the mode calculation (1.8% of xres rounded
1200 * down to 8 pixels and 1.8% of yres).
1201 */
1202 bool margins;
1203
1204 /**
1205 * @force:
1206 *
1207 * Ignore the hotplug state of the connector, and force its
1208 * state to one of the DRM_FORCE_* values.
1209 */
1210 enum drm_connector_force force;
1211
1212 /**
1213 * @rotation_reflection:
1214 *
1215 * Initial rotation and reflection of the mode setup from the
1216 * command line. See DRM_MODE_ROTATE_* and
1217 * DRM_MODE_REFLECT_*. The only rotations supported are
1218 * DRM_MODE_ROTATE_0 and DRM_MODE_ROTATE_180.
1219 */
1220 unsigned int rotation_reflection;
1221
1222 /**
1223 * @panel_orientation:
1224 *
1225 * drm-connector "panel orientation" property override value,
1226 * DRM_MODE_PANEL_ORIENTATION_UNKNOWN if not set.
1227 */
1228 enum drm_panel_orientation panel_orientation;
1229
1230 /**
1231 * @tv_margins: TV margins to apply to the mode.
1232 */
1233 struct drm_connector_tv_margins tv_margins;
1234 };
1235
1236 /**
1237 * struct drm_connector - central DRM connector control structure
1238 *
1239 * Each connector may be connected to one or more CRTCs, or may be clonable by
1240 * another connector if they can share a CRTC. Each connector also has a specific
1241 * position in the broader display (referred to as a 'screen' though it could
1242 * span multiple monitors).
1243 */
1244 struct drm_connector {
1245 /** @dev: parent DRM device */
1246 struct drm_device *dev;
1247 /** @kdev: kernel device for sysfs attributes */
1248 struct device *kdev;
1249 /** @attr: sysfs attributes */
1250 struct device_attribute *attr;
1251 /**
1252 * @fwnode: associated fwnode supplied by platform firmware
1253 *
1254 * Drivers can set this to associate a fwnode with a connector, drivers
1255 * are expected to get a reference on the fwnode when setting this.
1256 * drm_connector_cleanup() will call fwnode_handle_put() on this.
1257 */
1258 struct fwnode_handle *fwnode;
1259
1260 /**
1261 * @head:
1262 *
1263 * List of all connectors on a @dev, linked from
1264 * &drm_mode_config.connector_list. Protected by
1265 * &drm_mode_config.connector_list_lock, but please only use
1266 * &drm_connector_list_iter to walk this list.
1267 */
1268 struct list_head head;
1269
1270 /**
1271 * @global_connector_list_entry:
1272 *
1273 * Connector entry in the global connector-list, used by
1274 * drm_connector_find_by_fwnode().
1275 */
1276 struct list_head global_connector_list_entry;
1277
1278 /** @base: base KMS object */
1279 struct drm_mode_object base;
1280
1281 /** @name: human readable name, can be overwritten by the driver */
1282 char *name;
1283
1284 /**
1285 * @mutex: Lock for general connector state, but currently only protects
1286 * @registered. Most of the connector state is still protected by
1287 * &drm_mode_config.mutex.
1288 */
1289 struct mutex mutex;
1290
1291 /**
1292 * @index: Compacted connector index, which matches the position inside
1293 * the mode_config.list for drivers not supporting hot-add/removing. Can
1294 * be used as an array index. It is invariant over the lifetime of the
1295 * connector.
1296 */
1297 unsigned index;
1298
1299 /**
1300 * @connector_type:
1301 * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
1302 */
1303 int connector_type;
1304 /** @connector_type_id: index into connector type enum */
1305 int connector_type_id;
1306 /**
1307 * @interlace_allowed:
1308 * Can this connector handle interlaced modes? Only used by
1309 * drm_helper_probe_single_connector_modes() for mode filtering.
1310 */
1311 bool interlace_allowed;
1312 /**
1313 * @doublescan_allowed:
1314 * Can this connector handle doublescan? Only used by
1315 * drm_helper_probe_single_connector_modes() for mode filtering.
1316 */
1317 bool doublescan_allowed;
1318 /**
1319 * @stereo_allowed:
1320 * Can this connector handle stereo modes? Only used by
1321 * drm_helper_probe_single_connector_modes() for mode filtering.
1322 */
1323 bool stereo_allowed;
1324
1325 /**
1326 * @ycbcr_420_allowed : This bool indicates if this connector is
1327 * capable of handling YCBCR 420 output. While parsing the EDID
1328 * blocks it's very helpful to know if the source is capable of
1329 * handling YCBCR 420 outputs.
1330 */
1331 bool ycbcr_420_allowed;
1332
1333 /**
1334 * @registration_state: Is this connector initializing, exposed
1335 * (registered) with userspace, or unregistered?
1336 *
1337 * Protected by @mutex.
1338 */
1339 enum drm_connector_registration_state registration_state;
1340
1341 /**
1342 * @modes:
1343 * Modes available on this connector (from fill_modes() + user).
1344 * Protected by &drm_mode_config.mutex.
1345 */
1346 struct list_head modes;
1347
1348 /**
1349 * @status:
1350 * One of the drm_connector_status enums (connected, not, or unknown).
1351 * Protected by &drm_mode_config.mutex.
1352 */
1353 enum drm_connector_status status;
1354
1355 /**
1356 * @probed_modes:
1357 * These are modes added by probing with DDC or the BIOS, before
1358 * filtering is applied. Used by the probe helpers. Protected by
1359 * &drm_mode_config.mutex.
1360 */
1361 struct list_head probed_modes;
1362
1363 /**
1364 * @display_info: Display information is filled from EDID information
1365 * when a display is detected. For non hot-pluggable displays such as
1366 * flat panels in embedded systems, the driver should initialize the
1367 * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1368 * with the physical size of the display.
1369 *
1370 * Protected by &drm_mode_config.mutex.
1371 */
1372 struct drm_display_info display_info;
1373
1374 /** @funcs: connector control functions */
1375 const struct drm_connector_funcs *funcs;
1376
1377 /**
1378 * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1379 * &drm_mode_config.mutex. This should be updated only by calling
1380 * drm_connector_update_edid_property().
1381 */
1382 struct drm_property_blob *edid_blob_ptr;
1383
1384 /** @properties: property tracking for this connector */
1385 struct drm_object_properties properties;
1386
1387 /**
1388 * @scaling_mode_property: Optional atomic property to control the
1389 * upscaling. See drm_connector_attach_content_protection_property().
1390 */
1391 struct drm_property *scaling_mode_property;
1392
1393 /**
1394 * @vrr_capable_property: Optional property to help userspace
1395 * query hardware support for variable refresh rate on a connector.
1396 * connector. Drivers can add the property to a connector by
1397 * calling drm_connector_attach_vrr_capable_property().
1398 *
1399 * This should be updated only by calling
1400 * drm_connector_set_vrr_capable_property().
1401 */
1402 struct drm_property *vrr_capable_property;
1403
1404 /**
1405 * @colorspace_property: Connector property to set the suitable
1406 * colorspace supported by the sink.
1407 */
1408 struct drm_property *colorspace_property;
1409
1410 /**
1411 * @path_blob_ptr:
1412 *
1413 * DRM blob property data for the DP MST path property. This should only
1414 * be updated by calling drm_connector_set_path_property().
1415 */
1416 struct drm_property_blob *path_blob_ptr;
1417
1418 /**
1419 * @max_bpc_property: Default connector property for the max bpc to be
1420 * driven out of the connector.
1421 */
1422 struct drm_property *max_bpc_property;
1423
1424 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1425 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1426 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1427
1428 /**
1429 * @polled:
1430 *
1431 * Connector polling mode, a combination of
1432 *
1433 * DRM_CONNECTOR_POLL_HPD
1434 * The connector generates hotplug events and doesn't need to be
1435 * periodically polled. The CONNECT and DISCONNECT flags must not
1436 * be set together with the HPD flag.
1437 *
1438 * DRM_CONNECTOR_POLL_CONNECT
1439 * Periodically poll the connector for connection.
1440 *
1441 * DRM_CONNECTOR_POLL_DISCONNECT
1442 * Periodically poll the connector for disconnection, without
1443 * causing flickering even when the connector is in use. DACs should
1444 * rarely do this without a lot of testing.
1445 *
1446 * Set to 0 for connectors that don't support connection status
1447 * discovery.
1448 */
1449 uint8_t polled;
1450
1451 /**
1452 * @dpms: Current dpms state. For legacy drivers the
1453 * &drm_connector_funcs.dpms callback must update this. For atomic
1454 * drivers, this is handled by the core atomic code, and drivers must
1455 * only take &drm_crtc_state.active into account.
1456 */
1457 int dpms;
1458
1459 /** @helper_private: mid-layer private data */
1460 const struct drm_connector_helper_funcs *helper_private;
1461
1462 /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1463 struct drm_cmdline_mode cmdline_mode;
1464 /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1465 enum drm_connector_force force;
1466 /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1467 bool override_edid;
1468 /** @epoch_counter: used to detect any other changes in connector, besides status */
1469 u64 epoch_counter;
1470
1471 /**
1472 * @possible_encoders: Bit mask of encoders that can drive this
1473 * connector, drm_encoder_index() determines the index into the bitfield
1474 * and the bits are set with drm_connector_attach_encoder().
1475 */
1476 u32 possible_encoders;
1477
1478 /**
1479 * @encoder: Currently bound encoder driving this connector, if any.
1480 * Only really meaningful for non-atomic drivers. Atomic drivers should
1481 * instead look at &drm_connector_state.best_encoder, and in case they
1482 * need the CRTC driving this output, &drm_connector_state.crtc.
1483 */
1484 struct drm_encoder *encoder;
1485
1486 #define MAX_ELD_BYTES 128
1487 /** @eld: EDID-like data, if present */
1488 uint8_t eld[MAX_ELD_BYTES];
1489 /** @latency_present: AV delay info from ELD, if found */
1490 bool latency_present[2];
1491 /**
1492 * @video_latency: Video latency info from ELD, if found.
1493 * [0]: progressive, [1]: interlaced
1494 */
1495 int video_latency[2];
1496 /**
1497 * @audio_latency: audio latency info from ELD, if found
1498 * [0]: progressive, [1]: interlaced
1499 */
1500 int audio_latency[2];
1501
1502 /**
1503 * @ddc: associated ddc adapter.
1504 * A connector usually has its associated ddc adapter. If a driver uses
1505 * this field, then an appropriate symbolic link is created in connector
1506 * sysfs directory to make it easy for the user to tell which i2c
1507 * adapter is for a particular display.
1508 *
1509 * The field should be set by calling drm_connector_init_with_ddc().
1510 */
1511 struct i2c_adapter *ddc;
1512
1513 /**
1514 * @null_edid_counter: track sinks that give us all zeros for the EDID.
1515 * Needed to workaround some HW bugs where we get all 0s
1516 */
1517 int null_edid_counter;
1518
1519 /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1520 unsigned bad_edid_counter;
1521
1522 /**
1523 * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1524 * in Displayport compliance testing - Displayport Link CTS Core 1.2
1525 * rev1.1 4.2.2.6
1526 */
1527 bool edid_corrupt;
1528 /**
1529 * @real_edid_checksum: real edid checksum for corrupted edid block.
1530 * Required in Displayport 1.4 compliance testing
1531 * rev1.1 4.2.2.6
1532 */
1533 u8 real_edid_checksum;
1534
1535 /** @debugfs_entry: debugfs directory for this connector */
1536 struct dentry *debugfs_entry;
1537
1538 /**
1539 * @state:
1540 *
1541 * Current atomic state for this connector.
1542 *
1543 * This is protected by &drm_mode_config.connection_mutex. Note that
1544 * nonblocking atomic commits access the current connector state without
1545 * taking locks. Either by going through the &struct drm_atomic_state
1546 * pointers, see for_each_oldnew_connector_in_state(),
1547 * for_each_old_connector_in_state() and
1548 * for_each_new_connector_in_state(). Or through careful ordering of
1549 * atomic commit operations as implemented in the atomic helpers, see
1550 * &struct drm_crtc_commit.
1551 */
1552 struct drm_connector_state *state;
1553
1554 /* DisplayID bits. FIXME: Extract into a substruct? */
1555
1556 /**
1557 * @tile_blob_ptr:
1558 *
1559 * DRM blob property data for the tile property (used mostly by DP MST).
1560 * This is meant for screens which are driven through separate display
1561 * pipelines represented by &drm_crtc, which might not be running with
1562 * genlocked clocks. For tiled panels which are genlocked, like
1563 * dual-link LVDS or dual-link DSI, the driver should try to not expose
1564 * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1565 *
1566 * This should only be updated by calling
1567 * drm_connector_set_tile_property().
1568 */
1569 struct drm_property_blob *tile_blob_ptr;
1570
1571 /** @has_tile: is this connector connected to a tiled monitor */
1572 bool has_tile;
1573 /** @tile_group: tile group for the connected monitor */
1574 struct drm_tile_group *tile_group;
1575 /** @tile_is_single_monitor: whether the tile is one monitor housing */
1576 bool tile_is_single_monitor;
1577
1578 /** @num_h_tile: number of horizontal tiles in the tile group */
1579 /** @num_v_tile: number of vertical tiles in the tile group */
1580 uint8_t num_h_tile, num_v_tile;
1581 /** @tile_h_loc: horizontal location of this tile */
1582 /** @tile_v_loc: vertical location of this tile */
1583 uint8_t tile_h_loc, tile_v_loc;
1584 /** @tile_h_size: horizontal size of this tile. */
1585 /** @tile_v_size: vertical size of this tile. */
1586 uint16_t tile_h_size, tile_v_size;
1587
1588 /**
1589 * @free_node:
1590 *
1591 * List used only by &drm_connector_list_iter to be able to clean up a
1592 * connector from any context, in conjunction with
1593 * &drm_mode_config.connector_free_work.
1594 */
1595 struct llist_node free_node;
1596
1597 /** @hdr_sink_metadata: HDR Metadata Information read from sink */
1598 struct hdr_sink_metadata hdr_sink_metadata;
1599 };
1600
1601 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1602
1603 int drm_connector_init(struct drm_device *dev,
1604 struct drm_connector *connector,
1605 const struct drm_connector_funcs *funcs,
1606 int connector_type);
1607 int drm_connector_init_with_ddc(struct drm_device *dev,
1608 struct drm_connector *connector,
1609 const struct drm_connector_funcs *funcs,
1610 int connector_type,
1611 struct i2c_adapter *ddc);
1612 void drm_connector_attach_edid_property(struct drm_connector *connector);
1613 int drm_connector_register(struct drm_connector *connector);
1614 void drm_connector_unregister(struct drm_connector *connector);
1615 int drm_connector_attach_encoder(struct drm_connector *connector,
1616 struct drm_encoder *encoder);
1617
1618 void drm_connector_cleanup(struct drm_connector *connector);
1619
drm_connector_index(const struct drm_connector * connector)1620 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1621 {
1622 return connector->index;
1623 }
1624
drm_connector_mask(const struct drm_connector * connector)1625 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1626 {
1627 return 1 << connector->index;
1628 }
1629
1630 /**
1631 * drm_connector_lookup - lookup connector object
1632 * @dev: DRM device
1633 * @file_priv: drm file to check for lease against.
1634 * @id: connector object id
1635 *
1636 * This function looks up the connector object specified by id
1637 * add takes a reference to it.
1638 */
drm_connector_lookup(struct drm_device * dev,struct drm_file * file_priv,uint32_t id)1639 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1640 struct drm_file *file_priv,
1641 uint32_t id)
1642 {
1643 struct drm_mode_object *mo;
1644 mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1645 return mo ? obj_to_connector(mo) : NULL;
1646 }
1647
1648 /**
1649 * drm_connector_get - acquire a connector reference
1650 * @connector: DRM connector
1651 *
1652 * This function increments the connector's refcount.
1653 */
drm_connector_get(struct drm_connector * connector)1654 static inline void drm_connector_get(struct drm_connector *connector)
1655 {
1656 drm_mode_object_get(&connector->base);
1657 }
1658
1659 /**
1660 * drm_connector_put - release a connector reference
1661 * @connector: DRM connector
1662 *
1663 * This function decrements the connector's reference count and frees the
1664 * object if the reference count drops to zero.
1665 */
drm_connector_put(struct drm_connector * connector)1666 static inline void drm_connector_put(struct drm_connector *connector)
1667 {
1668 drm_mode_object_put(&connector->base);
1669 }
1670
1671 /**
1672 * drm_connector_is_unregistered - has the connector been unregistered from
1673 * userspace?
1674 * @connector: DRM connector
1675 *
1676 * Checks whether or not @connector has been unregistered from userspace.
1677 *
1678 * Returns:
1679 * True if the connector was unregistered, false if the connector is
1680 * registered or has not yet been registered with userspace.
1681 */
1682 static inline bool
drm_connector_is_unregistered(struct drm_connector * connector)1683 drm_connector_is_unregistered(struct drm_connector *connector)
1684 {
1685 return READ_ONCE(connector->registration_state) ==
1686 DRM_CONNECTOR_UNREGISTERED;
1687 }
1688
1689 void drm_connector_oob_hotplug_event(struct fwnode_handle *connector_fwnode);
1690 const char *drm_get_connector_type_name(unsigned int connector_type);
1691 const char *drm_get_connector_status_name(enum drm_connector_status status);
1692 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1693 const char *drm_get_dpms_name(int val);
1694 const char *drm_get_dvi_i_subconnector_name(int val);
1695 const char *drm_get_dvi_i_select_name(int val);
1696 const char *drm_get_tv_subconnector_name(int val);
1697 const char *drm_get_tv_select_name(int val);
1698 const char *drm_get_dp_subconnector_name(int val);
1699 const char *drm_get_content_protection_name(int val);
1700 const char *drm_get_hdcp_content_type_name(int val);
1701
1702 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1703 void drm_connector_attach_dp_subconnector_property(struct drm_connector *connector);
1704
1705 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1706 int drm_mode_create_tv_properties(struct drm_device *dev,
1707 unsigned int num_modes,
1708 const char * const modes[]);
1709 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1710 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1711 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1712 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1713 u32 scaling_mode_mask);
1714 int drm_connector_attach_vrr_capable_property(
1715 struct drm_connector *connector);
1716 int drm_connector_attach_colorspace_property(struct drm_connector *connector);
1717 int drm_connector_attach_hdr_output_metadata_property(struct drm_connector *connector);
1718 bool drm_connector_atomic_hdr_metadata_equal(struct drm_connector_state *old_state,
1719 struct drm_connector_state *new_state);
1720 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1721 int drm_mode_create_hdmi_colorspace_property(struct drm_connector *connector);
1722 int drm_mode_create_dp_colorspace_property(struct drm_connector *connector);
1723 int drm_mode_create_content_type_property(struct drm_device *dev);
1724 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1725 const struct drm_connector_state *conn_state);
1726
1727 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1728
1729 int drm_connector_set_path_property(struct drm_connector *connector,
1730 const char *path);
1731 int drm_connector_set_tile_property(struct drm_connector *connector);
1732 int drm_connector_update_edid_property(struct drm_connector *connector,
1733 const struct edid *edid);
1734 void drm_connector_set_link_status_property(struct drm_connector *connector,
1735 uint64_t link_status);
1736 void drm_connector_set_vrr_capable_property(
1737 struct drm_connector *connector, bool capable);
1738 int drm_connector_set_panel_orientation(
1739 struct drm_connector *connector,
1740 enum drm_panel_orientation panel_orientation);
1741 int drm_connector_set_panel_orientation_with_quirk(
1742 struct drm_connector *connector,
1743 enum drm_panel_orientation panel_orientation,
1744 int width, int height);
1745 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1746 int min, int max);
1747
1748 /**
1749 * struct drm_tile_group - Tile group metadata
1750 * @refcount: reference count
1751 * @dev: DRM device
1752 * @id: tile group id exposed to userspace
1753 * @group_data: Sink-private data identifying this group
1754 *
1755 * @group_data corresponds to displayid vend/prod/serial for external screens
1756 * with an EDID.
1757 */
1758 struct drm_tile_group {
1759 struct kref refcount;
1760 struct drm_device *dev;
1761 int id;
1762 u8 group_data[8];
1763 };
1764
1765 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1766 const char topology[8]);
1767 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1768 const char topology[8]);
1769 void drm_mode_put_tile_group(struct drm_device *dev,
1770 struct drm_tile_group *tg);
1771
1772 /**
1773 * struct drm_connector_list_iter - connector_list iterator
1774 *
1775 * This iterator tracks state needed to be able to walk the connector_list
1776 * within struct drm_mode_config. Only use together with
1777 * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1778 * drm_connector_list_iter_next() respectively the convenience macro
1779 * drm_for_each_connector_iter().
1780 *
1781 * Note that the return value of drm_connector_list_iter_next() is only valid
1782 * up to the next drm_connector_list_iter_next() or
1783 * drm_connector_list_iter_end() call. If you want to use the connector later,
1784 * then you need to grab your own reference first using drm_connector_get().
1785 */
1786 struct drm_connector_list_iter {
1787 /* private: */
1788 struct drm_device *dev;
1789 struct drm_connector *conn;
1790 };
1791
1792 void drm_connector_list_iter_begin(struct drm_device *dev,
1793 struct drm_connector_list_iter *iter);
1794 struct drm_connector *
1795 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1796 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1797
1798 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1799 struct drm_encoder *encoder);
1800
1801 /**
1802 * drm_for_each_connector_iter - connector_list iterator macro
1803 * @connector: &struct drm_connector pointer used as cursor
1804 * @iter: &struct drm_connector_list_iter
1805 *
1806 * Note that @connector is only valid within the list body, if you want to use
1807 * @connector after calling drm_connector_list_iter_end() then you need to grab
1808 * your own reference first using drm_connector_get().
1809 */
1810 #define drm_for_each_connector_iter(connector, iter) \
1811 while ((connector = drm_connector_list_iter_next(iter)))
1812
1813 /**
1814 * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1815 * @connector: &struct drm_connector pointer
1816 * @encoder: &struct drm_encoder pointer used as cursor
1817 */
1818 #define drm_connector_for_each_possible_encoder(connector, encoder) \
1819 drm_for_each_encoder_mask(encoder, (connector)->dev, \
1820 (connector)->possible_encoders)
1821
1822 #endif
1823