Debian Codegraph @

include/drm/drm_connector.h

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