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