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