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