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