5e41942e5679d152f1166f46665469805c69e856
[sfrench/cifs-2.6.git] / include / drm / drm_connector.h
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 <drm/drm_mode_object.h>
31 #include <drm/drm_util.h>
32
33 #include <uapi/drm/drm_mode.h>
34
35 struct drm_connector_helper_funcs;
36 struct drm_modeset_acquire_ctx;
37 struct drm_device;
38 struct drm_crtc;
39 struct drm_encoder;
40 struct drm_property;
41 struct drm_property_blob;
42 struct drm_printer;
43 struct edid;
44
45 enum drm_connector_force {
46         DRM_FORCE_UNSPECIFIED,
47         DRM_FORCE_OFF,
48         DRM_FORCE_ON,         /* force on analog part normally */
49         DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
50 };
51
52 /**
53  * enum drm_connector_status - status for a &drm_connector
54  *
55  * This enum is used to track the connector status. There are no separate
56  * #defines for the uapi!
57  */
58 enum drm_connector_status {
59         /**
60          * @connector_status_connected: The connector is definitely connected to
61          * a sink device, and can be enabled.
62          */
63         connector_status_connected = 1,
64         /**
65          * @connector_status_disconnected: The connector isn't connected to a
66          * sink device which can be autodetect. For digital outputs like DP or
67          * HDMI (which can be realiable probed) this means there's really
68          * nothing there. It is driver-dependent whether a connector with this
69          * status can be lit up or not.
70          */
71         connector_status_disconnected = 2,
72         /**
73          * @connector_status_unknown: The connector's status could not be
74          * reliably detected. This happens when probing would either cause
75          * flicker (like load-detection when the connector is in use), or when a
76          * hardware resource isn't available (like when load-detection needs a
77          * free CRTC). It should be possible to light up the connector with one
78          * of the listed fallback modes. For default configuration userspace
79          * should only try to light up connectors with unknown status when
80          * there's not connector with @connector_status_connected.
81          */
82         connector_status_unknown = 3,
83 };
84
85 /**
86  * enum drm_connector_registration_status - userspace registration status for
87  * a &drm_connector
88  *
89  * This enum is used to track the status of initializing a connector and
90  * registering it with userspace, so that DRM can prevent bogus modesets on
91  * connectors that no longer exist.
92  */
93 enum drm_connector_registration_state {
94         /**
95          * @DRM_CONNECTOR_INITIALIZING: The connector has just been created,
96          * but has yet to be exposed to userspace. There should be no
97          * additional restrictions to how the state of this connector may be
98          * modified.
99          */
100         DRM_CONNECTOR_INITIALIZING = 0,
101
102         /**
103          * @DRM_CONNECTOR_REGISTERED: The connector has been fully initialized
104          * and registered with sysfs, as such it has been exposed to
105          * userspace. There should be no additional restrictions to how the
106          * state of this connector may be modified.
107          */
108         DRM_CONNECTOR_REGISTERED = 1,
109
110         /**
111          * @DRM_CONNECTOR_UNREGISTERED: The connector has either been exposed
112          * to userspace and has since been unregistered and removed from
113          * userspace, or the connector was unregistered before it had a chance
114          * to be exposed to userspace (e.g. still in the
115          * @DRM_CONNECTOR_INITIALIZING state). When a connector is
116          * unregistered, there are additional restrictions to how its state
117          * may be modified:
118          *
119          * - An unregistered connector may only have its DPMS changed from
120          *   On->Off. Once DPMS is changed to Off, it may not be switched back
121          *   to On.
122          * - Modesets are not allowed on unregistered connectors, unless they
123          *   would result in disabling its assigned CRTCs. This means
124          *   disabling a CRTC on an unregistered connector is OK, but enabling
125          *   one is not.
126          * - Removing a CRTC from an unregistered connector is OK, but new
127          *   CRTCs may never be assigned to an unregistered connector.
128          */
129         DRM_CONNECTOR_UNREGISTERED = 2,
130 };
131
132 enum subpixel_order {
133         SubPixelUnknown = 0,
134         SubPixelHorizontalRGB,
135         SubPixelHorizontalBGR,
136         SubPixelVerticalRGB,
137         SubPixelVerticalBGR,
138         SubPixelNone,
139
140 };
141
142 /**
143  * struct drm_scrambling: sink's scrambling support.
144  */
145 struct drm_scrambling {
146         /**
147          * @supported: scrambling supported for rates > 340 Mhz.
148          */
149         bool supported;
150         /**
151          * @low_rates: scrambling supported for rates <= 340 Mhz.
152          */
153         bool low_rates;
154 };
155
156 /*
157  * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
158  *
159  * Provides SCDC register support and capabilities related information on a
160  * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
161  */
162 struct drm_scdc {
163         /**
164          * @supported: status control & data channel present.
165          */
166         bool supported;
167         /**
168          * @read_request: sink is capable of generating scdc read request.
169          */
170         bool read_request;
171         /**
172          * @scrambling: sink's scrambling capabilities
173          */
174         struct drm_scrambling scrambling;
175 };
176
177
178 /**
179  * struct drm_hdmi_info - runtime information about the connected HDMI sink
180  *
181  * Describes if a given display supports advanced HDMI 2.0 features.
182  * This information is available in CEA-861-F extension blocks (like HF-VSDB).
183  */
184 struct drm_hdmi_info {
185         /** @scdc: sink's scdc support and capabilities */
186         struct drm_scdc scdc;
187
188         /**
189          * @y420_vdb_modes: bitmap of modes which can support ycbcr420
190          * output only (not normal RGB/YCBCR444/422 outputs). There are total
191          * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map
192          * upto 128 VICs;
193          */
194         unsigned long y420_vdb_modes[BITS_TO_LONGS(128)];
195
196         /**
197          * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
198          * output also, along with normal HDMI outputs. There are total 107
199          * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto
200          * 128 VICs;
201          */
202         unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)];
203
204         /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
205         u64 y420_cmdb_map;
206
207         /** @y420_dc_modes: bitmap of deep color support index */
208         u8 y420_dc_modes;
209 };
210
211 /**
212  * enum drm_link_status - connector's link_status property value
213  *
214  * This enum is used as the connector's link status property value.
215  * It is set to the values defined in uapi.
216  *
217  * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
218  *                        link training
219  * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
220  *                       failure
221  */
222 enum drm_link_status {
223         DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
224         DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
225 };
226
227 /**
228  * enum drm_panel_orientation - panel_orientation info for &drm_display_info
229  *
230  * This enum is used to track the (LCD) panel orientation. There are no
231  * separate #defines for the uapi!
232  *
233  * @DRM_MODE_PANEL_ORIENTATION_UNKNOWN: The drm driver has not provided any
234  *                                      panel orientation information (normal
235  *                                      for non panels) in this case the "panel
236  *                                      orientation" connector prop will not be
237  *                                      attached.
238  * @DRM_MODE_PANEL_ORIENTATION_NORMAL:  The top side of the panel matches the
239  *                                      top side of the device's casing.
240  * @DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP: The top side of the panel matches the
241  *                                      bottom side of the device's casing, iow
242  *                                      the panel is mounted upside-down.
243  * @DRM_MODE_PANEL_ORIENTATION_LEFT_UP: The left side of the panel matches the
244  *                                      top side of the device's casing.
245  * @DRM_MODE_PANEL_ORIENTATION_RIGHT_UP: The right side of the panel matches the
246  *                                      top side of the device's casing.
247  */
248 enum drm_panel_orientation {
249         DRM_MODE_PANEL_ORIENTATION_UNKNOWN = -1,
250         DRM_MODE_PANEL_ORIENTATION_NORMAL = 0,
251         DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP,
252         DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
253         DRM_MODE_PANEL_ORIENTATION_RIGHT_UP,
254 };
255
256 /*
257  * This is a consolidated colorimetry list supported by HDMI and
258  * DP protocol standard. The respective connectors will register
259  * a property with the subset of this list (supported by that
260  * respective protocol). Userspace will set the colorspace through
261  * a colorspace property which will be created and exposed to
262  * userspace.
263  */
264
265 /* For Default case, driver will set the colorspace */
266 #define DRM_MODE_COLORIMETRY_DEFAULT                    0
267 /* CEA 861 Normal Colorimetry options */
268 #define DRM_MODE_COLORIMETRY_NO_DATA                    0
269 #define DRM_MODE_COLORIMETRY_SMPTE_170M_YCC             1
270 #define DRM_MODE_COLORIMETRY_BT709_YCC                  2
271 /* CEA 861 Extended Colorimetry Options */
272 #define DRM_MODE_COLORIMETRY_XVYCC_601                  3
273 #define DRM_MODE_COLORIMETRY_XVYCC_709                  4
274 #define DRM_MODE_COLORIMETRY_SYCC_601                   5
275 #define DRM_MODE_COLORIMETRY_OPYCC_601                  6
276 #define DRM_MODE_COLORIMETRY_OPRGB                      7
277 #define DRM_MODE_COLORIMETRY_BT2020_CYCC                8
278 #define DRM_MODE_COLORIMETRY_BT2020_RGB                 9
279 #define DRM_MODE_COLORIMETRY_BT2020_YCC                 10
280 /* Additional Colorimetry extension added as part of CTA 861.G */
281 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_D65             11
282 #define DRM_MODE_COLORIMETRY_DCI_P3_RGB_THEATER         12
283
284 /**
285  * enum drm_bus_flags - bus_flags info for &drm_display_info
286  *
287  * This enum defines signal polarities and clock edge information for signals on
288  * a bus as bitmask flags.
289  *
290  * The clock edge information is conveyed by two sets of symbols,
291  * DRM_BUS_FLAGS_*_DRIVE_\* and DRM_BUS_FLAGS_*_SAMPLE_\*. When this enum is
292  * used to describe a bus from the point of view of the transmitter, the
293  * \*_DRIVE_\* flags should be used. When used from the point of view of the
294  * receiver, the \*_SAMPLE_\* flags should be used. The \*_DRIVE_\* and
295  * \*_SAMPLE_\* flags alias each other, with the \*_SAMPLE_POSEDGE and
296  * \*_SAMPLE_NEGEDGE flags being equal to \*_DRIVE_NEGEDGE and \*_DRIVE_POSEDGE
297  * respectively. This simplifies code as signals are usually sampled on the
298  * opposite edge of the driving edge. Transmitters and receivers may however
299  * need to take other signal timings into account to convert between driving
300  * and sample edges.
301  *
302  * @DRM_BUS_FLAG_DE_LOW:                The Data Enable signal is active low
303  * @DRM_BUS_FLAG_DE_HIGH:               The Data Enable signal is active high
304  * @DRM_BUS_FLAG_PIXDATA_POSEDGE:       Legacy value, do not use
305  * @DRM_BUS_FLAG_PIXDATA_NEGEDGE:       Legacy value, do not use
306  * @DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE: Data is driven on the rising edge of
307  *                                      the pixel clock
308  * @DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE: Data is driven on the falling edge of
309  *                                      the pixel clock
310  * @DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE: Data is sampled on the rising edge of
311  *                                      the pixel clock
312  * @DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE: Data is sampled on the falling edge of
313  *                                      the pixel clock
314  * @DRM_BUS_FLAG_DATA_MSB_TO_LSB:       Data is transmitted MSB to LSB on the bus
315  * @DRM_BUS_FLAG_DATA_LSB_TO_MSB:       Data is transmitted LSB to MSB on the bus
316  * @DRM_BUS_FLAG_SYNC_POSEDGE:          Legacy value, do not use
317  * @DRM_BUS_FLAG_SYNC_NEGEDGE:          Legacy value, do not use
318  * @DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE:    Sync signals are driven on the rising
319  *                                      edge of the pixel clock
320  * @DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE:    Sync signals are driven on the falling
321  *                                      edge of the pixel clock
322  * @DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE:   Sync signals are sampled on the rising
323  *                                      edge of the pixel clock
324  * @DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE:   Sync signals are sampled on the falling
325  *                                      edge of the pixel clock
326  */
327 enum drm_bus_flags {
328         DRM_BUS_FLAG_DE_LOW = BIT(0),
329         DRM_BUS_FLAG_DE_HIGH = BIT(1),
330         DRM_BUS_FLAG_PIXDATA_POSEDGE = BIT(2),
331         DRM_BUS_FLAG_PIXDATA_NEGEDGE = BIT(3),
332         DRM_BUS_FLAG_PIXDATA_DRIVE_POSEDGE = DRM_BUS_FLAG_PIXDATA_POSEDGE,
333         DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_NEGEDGE,
334         DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE = DRM_BUS_FLAG_PIXDATA_NEGEDGE,
335         DRM_BUS_FLAG_PIXDATA_SAMPLE_NEGEDGE = DRM_BUS_FLAG_PIXDATA_POSEDGE,
336         DRM_BUS_FLAG_DATA_MSB_TO_LSB = BIT(4),
337         DRM_BUS_FLAG_DATA_LSB_TO_MSB = BIT(5),
338         DRM_BUS_FLAG_SYNC_POSEDGE = BIT(6),
339         DRM_BUS_FLAG_SYNC_NEGEDGE = BIT(7),
340         DRM_BUS_FLAG_SYNC_DRIVE_POSEDGE = DRM_BUS_FLAG_SYNC_POSEDGE,
341         DRM_BUS_FLAG_SYNC_DRIVE_NEGEDGE = DRM_BUS_FLAG_SYNC_NEGEDGE,
342         DRM_BUS_FLAG_SYNC_SAMPLE_POSEDGE = DRM_BUS_FLAG_SYNC_NEGEDGE,
343         DRM_BUS_FLAG_SYNC_SAMPLE_NEGEDGE = DRM_BUS_FLAG_SYNC_POSEDGE,
344 };
345
346 /**
347  * struct drm_display_info - runtime data about the connected sink
348  *
349  * Describes a given display (e.g. CRT or flat panel) and its limitations. For
350  * fixed display sinks like built-in panels there's not much difference between
351  * this and &struct drm_connector. But for sinks with a real cable this
352  * structure is meant to describe all the things at the other end of the cable.
353  *
354  * For sinks which provide an EDID this can be filled out by calling
355  * drm_add_edid_modes().
356  */
357 struct drm_display_info {
358         /**
359          * @width_mm: Physical width in mm.
360          */
361         unsigned int width_mm;
362
363         /**
364          * @height_mm: Physical height in mm.
365          */
366         unsigned int height_mm;
367
368         /**
369          * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
370          */
371         unsigned int bpc;
372
373         /**
374          * @subpixel_order: Subpixel order of LCD panels.
375          */
376         enum subpixel_order subpixel_order;
377
378 #define DRM_COLOR_FORMAT_RGB444         (1<<0)
379 #define DRM_COLOR_FORMAT_YCRCB444       (1<<1)
380 #define DRM_COLOR_FORMAT_YCRCB422       (1<<2)
381 #define DRM_COLOR_FORMAT_YCRCB420       (1<<3)
382
383         /**
384          * @panel_orientation: Read only connector property for built-in panels,
385          * indicating the orientation of the panel vs the device's casing.
386          * drm_connector_init() sets this to DRM_MODE_PANEL_ORIENTATION_UNKNOWN.
387          * When not UNKNOWN this gets used by the drm_fb_helpers to rotate the
388          * fb to compensate and gets exported as prop to userspace.
389          */
390         int panel_orientation;
391
392         /**
393          * @color_formats: HDMI Color formats, selects between RGB and YCrCb
394          * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
395          * as used to describe the pixel format in framebuffers, and also don't
396          * match the formats in @bus_formats which are shared with v4l.
397          */
398         u32 color_formats;
399
400         /**
401          * @bus_formats: Pixel data format on the wire, somewhat redundant with
402          * @color_formats. Array of size @num_bus_formats encoded using
403          * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
404          */
405         const u32 *bus_formats;
406         /**
407          * @num_bus_formats: Size of @bus_formats array.
408          */
409         unsigned int num_bus_formats;
410
411         /**
412          * @bus_flags: Additional information (like pixel signal polarity) for
413          * the pixel data on the bus, using &enum drm_bus_flags values
414          * DRM_BUS_FLAGS\_.
415          */
416         u32 bus_flags;
417
418         /**
419          * @max_tmds_clock: Maximum TMDS clock rate supported by the
420          * sink in kHz. 0 means undefined.
421          */
422         int max_tmds_clock;
423
424         /**
425          * @dvi_dual: Dual-link DVI sink?
426          */
427         bool dvi_dual;
428
429         /**
430          * @has_hdmi_infoframe: Does the sink support the HDMI infoframe?
431          */
432         bool has_hdmi_infoframe;
433
434         /**
435          * @rgb_quant_range_selectable: Does the sink support selecting
436          * the RGB quantization range?
437          */
438         bool rgb_quant_range_selectable;
439
440         /**
441          * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
442          * more stuff redundant with @bus_formats.
443          */
444         u8 edid_hdmi_dc_modes;
445
446         /**
447          * @cea_rev: CEA revision of the HDMI sink.
448          */
449         u8 cea_rev;
450
451         /**
452          * @hdmi: advance features of a HDMI sink.
453          */
454         struct drm_hdmi_info hdmi;
455
456         /**
457          * @non_desktop: Non desktop display (HMD).
458          */
459         bool non_desktop;
460 };
461
462 int drm_display_info_set_bus_formats(struct drm_display_info *info,
463                                      const u32 *formats,
464                                      unsigned int num_formats);
465
466 /**
467  * struct drm_tv_connector_state - TV connector related states
468  * @subconnector: selected subconnector
469  * @margins: margins (all margins are expressed in pixels)
470  * @margins.left: left margin
471  * @margins.right: right margin
472  * @margins.top: top margin
473  * @margins.bottom: bottom margin
474  * @mode: TV mode
475  * @brightness: brightness in percent
476  * @contrast: contrast in percent
477  * @flicker_reduction: flicker reduction in percent
478  * @overscan: overscan in percent
479  * @saturation: saturation in percent
480  * @hue: hue in percent
481  */
482 struct drm_tv_connector_state {
483         enum drm_mode_subconnector subconnector;
484         struct {
485                 unsigned int left;
486                 unsigned int right;
487                 unsigned int top;
488                 unsigned int bottom;
489         } margins;
490         unsigned int mode;
491         unsigned int brightness;
492         unsigned int contrast;
493         unsigned int flicker_reduction;
494         unsigned int overscan;
495         unsigned int saturation;
496         unsigned int hue;
497 };
498
499 /**
500  * struct drm_connector_state - mutable connector state
501  */
502 struct drm_connector_state {
503         /** @connector: backpointer to the connector */
504         struct drm_connector *connector;
505
506         /**
507          * @crtc: CRTC to connect connector to, NULL if disabled.
508          *
509          * Do not change this directly, use drm_atomic_set_crtc_for_connector()
510          * instead.
511          */
512         struct drm_crtc *crtc;
513
514         /**
515          * @best_encoder:
516          *
517          * Used by the atomic helpers to select the encoder, through the
518          * &drm_connector_helper_funcs.atomic_best_encoder or
519          * &drm_connector_helper_funcs.best_encoder callbacks.
520          */
521         struct drm_encoder *best_encoder;
522
523         /**
524          * @link_status: Connector link_status to keep track of whether link is
525          * GOOD or BAD to notify userspace if retraining is necessary.
526          */
527         enum drm_link_status link_status;
528
529         /** @state: backpointer to global drm_atomic_state */
530         struct drm_atomic_state *state;
531
532         /**
533          * @commit: Tracks the pending commit to prevent use-after-free conditions.
534          *
535          * Is only set when @crtc is NULL.
536          */
537         struct drm_crtc_commit *commit;
538
539         /** @tv: TV connector state */
540         struct drm_tv_connector_state tv;
541
542         /**
543          * @picture_aspect_ratio: Connector property to control the
544          * HDMI infoframe aspect ratio setting.
545          *
546          * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
547          * values for &enum hdmi_picture_aspect
548          */
549         enum hdmi_picture_aspect picture_aspect_ratio;
550
551         /**
552          * @content_type: Connector property to control the
553          * HDMI infoframe content type setting.
554          * The %DRM_MODE_CONTENT_TYPE_\* values much
555          * match the values.
556          */
557         unsigned int content_type;
558
559         /**
560          * @scaling_mode: Connector property to control the
561          * upscaling, mostly used for built-in panels.
562          */
563         unsigned int scaling_mode;
564
565         /**
566          * @content_protection: Connector property to request content
567          * protection. This is most commonly used for HDCP.
568          */
569         unsigned int content_protection;
570
571         /**
572          * @colorspace: State variable for Connector property to request
573          * colorspace change on Sink. This is most commonly used to switch
574          * to wider color gamuts like BT2020.
575          */
576         u32 colorspace;
577
578         /**
579          * @writeback_job: Writeback job for writeback connectors
580          *
581          * Holds the framebuffer and out-fence for a writeback connector. As
582          * the writeback completion may be asynchronous to the normal commit
583          * cycle, the writeback job lifetime is managed separately from the
584          * normal atomic state by this object.
585          *
586          * See also: drm_writeback_queue_job() and
587          * drm_writeback_signal_completion()
588          */
589         struct drm_writeback_job *writeback_job;
590
591         /**
592          * @max_requested_bpc: Connector property to limit the maximum bit
593          * depth of the pixels.
594          */
595         u8 max_requested_bpc;
596
597         /**
598          * @max_bpc: Connector max_bpc based on the requested max_bpc property
599          * and the connector bpc limitations obtained from edid.
600          */
601         u8 max_bpc;
602 };
603
604 /**
605  * struct drm_connector_funcs - control connectors on a given device
606  *
607  * Each CRTC may have one or more connectors attached to it.  The functions
608  * below allow the core DRM code to control connectors, enumerate available modes,
609  * etc.
610  */
611 struct drm_connector_funcs {
612         /**
613          * @dpms:
614          *
615          * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
616          * is exposed as a standard property on the connector, but diverted to
617          * this callback in the drm core. Note that atomic drivers don't
618          * implement the 4 level DPMS support on the connector any more, but
619          * instead only have an on/off "ACTIVE" property on the CRTC object.
620          *
621          * This hook is not used by atomic drivers, remapping of the legacy DPMS
622          * property is entirely handled in the DRM core.
623          *
624          * RETURNS:
625          *
626          * 0 on success or a negative error code on failure.
627          */
628         int (*dpms)(struct drm_connector *connector, int mode);
629
630         /**
631          * @reset:
632          *
633          * Reset connector hardware and software state to off. This function isn't
634          * called by the core directly, only through drm_mode_config_reset().
635          * It's not a helper hook only for historical reasons.
636          *
637          * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
638          * atomic state using this hook.
639          */
640         void (*reset)(struct drm_connector *connector);
641
642         /**
643          * @detect:
644          *
645          * Check to see if anything is attached to the connector. The parameter
646          * force is set to false whilst polling, true when checking the
647          * connector due to a user request. force can be used by the driver to
648          * avoid expensive, destructive operations during automated probing.
649          *
650          * This callback is optional, if not implemented the connector will be
651          * considered as always being attached.
652          *
653          * FIXME:
654          *
655          * Note that this hook is only called by the probe helper. It's not in
656          * the helper library vtable purely for historical reasons. The only DRM
657          * core entry point to probe connector state is @fill_modes.
658          *
659          * Note that the helper library will already hold
660          * &drm_mode_config.connection_mutex. Drivers which need to grab additional
661          * locks to avoid races with concurrent modeset changes need to use
662          * &drm_connector_helper_funcs.detect_ctx instead.
663          *
664          * RETURNS:
665          *
666          * drm_connector_status indicating the connector's status.
667          */
668         enum drm_connector_status (*detect)(struct drm_connector *connector,
669                                             bool force);
670
671         /**
672          * @force:
673          *
674          * This function is called to update internal encoder state when the
675          * connector is forced to a certain state by userspace, either through
676          * the sysfs interfaces or on the kernel cmdline. In that case the
677          * @detect callback isn't called.
678          *
679          * FIXME:
680          *
681          * Note that this hook is only called by the probe helper. It's not in
682          * the helper library vtable purely for historical reasons. The only DRM
683          * core entry point to probe connector state is @fill_modes.
684          */
685         void (*force)(struct drm_connector *connector);
686
687         /**
688          * @fill_modes:
689          *
690          * Entry point for output detection and basic mode validation. The
691          * driver should reprobe the output if needed (e.g. when hotplug
692          * handling is unreliable), add all detected modes to &drm_connector.modes
693          * and filter out any the device can't support in any configuration. It
694          * also needs to filter out any modes wider or higher than the
695          * parameters max_width and max_height indicate.
696          *
697          * The drivers must also prune any modes no longer valid from
698          * &drm_connector.modes. Furthermore it must update
699          * &drm_connector.status and &drm_connector.edid.  If no EDID has been
700          * received for this output connector->edid must be NULL.
701          *
702          * Drivers using the probe helpers should use
703          * drm_helper_probe_single_connector_modes() to implement this
704          * function.
705          *
706          * RETURNS:
707          *
708          * The number of modes detected and filled into &drm_connector.modes.
709          */
710         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
711
712         /**
713          * @set_property:
714          *
715          * This is the legacy entry point to update a property attached to the
716          * connector.
717          *
718          * This callback is optional if the driver does not support any legacy
719          * driver-private properties. For atomic drivers it is not used because
720          * property handling is done entirely in the DRM core.
721          *
722          * RETURNS:
723          *
724          * 0 on success or a negative error code on failure.
725          */
726         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
727                              uint64_t val);
728
729         /**
730          * @late_register:
731          *
732          * This optional hook can be used to register additional userspace
733          * interfaces attached to the connector, light backlight control, i2c,
734          * DP aux or similar interfaces. It is called late in the driver load
735          * sequence from drm_connector_register() when registering all the
736          * core drm connector interfaces. Everything added from this callback
737          * should be unregistered in the early_unregister callback.
738          *
739          * This is called while holding &drm_connector.mutex.
740          *
741          * Returns:
742          *
743          * 0 on success, or a negative error code on failure.
744          */
745         int (*late_register)(struct drm_connector *connector);
746
747         /**
748          * @early_unregister:
749          *
750          * This optional hook should be used to unregister the additional
751          * userspace interfaces attached to the connector from
752          * late_register(). It is called from drm_connector_unregister(),
753          * early in the driver unload sequence to disable userspace access
754          * before data structures are torndown.
755          *
756          * This is called while holding &drm_connector.mutex.
757          */
758         void (*early_unregister)(struct drm_connector *connector);
759
760         /**
761          * @destroy:
762          *
763          * Clean up connector resources. This is called at driver unload time
764          * through drm_mode_config_cleanup(). It can also be called at runtime
765          * when a connector is being hot-unplugged for drivers that support
766          * connector hotplugging (e.g. DisplayPort MST).
767          */
768         void (*destroy)(struct drm_connector *connector);
769
770         /**
771          * @atomic_duplicate_state:
772          *
773          * Duplicate the current atomic state for this connector and return it.
774          * The core and helpers guarantee that any atomic state duplicated with
775          * this hook and still owned by the caller (i.e. not transferred to the
776          * driver by calling &drm_mode_config_funcs.atomic_commit) will be
777          * cleaned up by calling the @atomic_destroy_state hook in this
778          * structure.
779          *
780          * This callback is mandatory for atomic drivers.
781          *
782          * Atomic drivers which don't subclass &struct drm_connector_state should use
783          * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
784          * state structure to extend it with driver-private state should use
785          * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
786          * duplicated in a consistent fashion across drivers.
787          *
788          * It is an error to call this hook before &drm_connector.state has been
789          * initialized correctly.
790          *
791          * NOTE:
792          *
793          * If the duplicate state references refcounted resources this hook must
794          * acquire a reference for each of them. The driver must release these
795          * references again in @atomic_destroy_state.
796          *
797          * RETURNS:
798          *
799          * Duplicated atomic state or NULL when the allocation failed.
800          */
801         struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
802
803         /**
804          * @atomic_destroy_state:
805          *
806          * Destroy a state duplicated with @atomic_duplicate_state and release
807          * or unreference all resources it references
808          *
809          * This callback is mandatory for atomic drivers.
810          */
811         void (*atomic_destroy_state)(struct drm_connector *connector,
812                                      struct drm_connector_state *state);
813
814         /**
815          * @atomic_set_property:
816          *
817          * Decode a driver-private property value and store the decoded value
818          * into the passed-in state structure. Since the atomic core decodes all
819          * standardized properties (even for extensions beyond the core set of
820          * properties which might not be implemented by all drivers) this
821          * requires drivers to subclass the state structure.
822          *
823          * Such driver-private properties should really only be implemented for
824          * truly hardware/vendor specific state. Instead it is preferred to
825          * standardize atomic extension and decode the properties used to expose
826          * such an extension in the core.
827          *
828          * Do not call this function directly, use
829          * drm_atomic_connector_set_property() instead.
830          *
831          * This callback is optional if the driver does not support any
832          * driver-private atomic properties.
833          *
834          * NOTE:
835          *
836          * This function is called in the state assembly phase of atomic
837          * modesets, which can be aborted for any reason (including on
838          * userspace's request to just check whether a configuration would be
839          * possible). Drivers MUST NOT touch any persistent state (hardware or
840          * software) or data structures except the passed in @state parameter.
841          *
842          * Also since userspace controls in which order properties are set this
843          * function must not do any input validation (since the state update is
844          * incomplete and hence likely inconsistent). Instead any such input
845          * validation must be done in the various atomic_check callbacks.
846          *
847          * RETURNS:
848          *
849          * 0 if the property has been found, -EINVAL if the property isn't
850          * implemented by the driver (which shouldn't ever happen, the core only
851          * asks for properties attached to this connector). No other validation
852          * is allowed by the driver. The core already checks that the property
853          * value is within the range (integer, valid enum value, ...) the driver
854          * set when registering the property.
855          */
856         int (*atomic_set_property)(struct drm_connector *connector,
857                                    struct drm_connector_state *state,
858                                    struct drm_property *property,
859                                    uint64_t val);
860
861         /**
862          * @atomic_get_property:
863          *
864          * Reads out the decoded driver-private property. This is used to
865          * implement the GETCONNECTOR IOCTL.
866          *
867          * Do not call this function directly, use
868          * drm_atomic_connector_get_property() instead.
869          *
870          * This callback is optional if the driver does not support any
871          * driver-private atomic properties.
872          *
873          * RETURNS:
874          *
875          * 0 on success, -EINVAL if the property isn't implemented by the
876          * driver (which shouldn't ever happen, the core only asks for
877          * properties attached to this connector).
878          */
879         int (*atomic_get_property)(struct drm_connector *connector,
880                                    const struct drm_connector_state *state,
881                                    struct drm_property *property,
882                                    uint64_t *val);
883
884         /**
885          * @atomic_print_state:
886          *
887          * If driver subclasses &struct drm_connector_state, it should implement
888          * this optional hook for printing additional driver specific state.
889          *
890          * Do not call this directly, use drm_atomic_connector_print_state()
891          * instead.
892          */
893         void (*atomic_print_state)(struct drm_printer *p,
894                                    const struct drm_connector_state *state);
895 };
896
897 /* mode specified on the command line */
898 struct drm_cmdline_mode {
899         bool specified;
900         bool refresh_specified;
901         bool bpp_specified;
902         int xres, yres;
903         int bpp;
904         int refresh;
905         bool rb;
906         bool interlace;
907         bool cvt;
908         bool margins;
909         enum drm_connector_force force;
910 };
911
912 /**
913  * struct drm_connector - central DRM connector control structure
914  *
915  * Each connector may be connected to one or more CRTCs, or may be clonable by
916  * another connector if they can share a CRTC.  Each connector also has a specific
917  * position in the broader display (referred to as a 'screen' though it could
918  * span multiple monitors).
919  */
920 struct drm_connector {
921         /** @dev: parent DRM device */
922         struct drm_device *dev;
923         /** @kdev: kernel device for sysfs attributes */
924         struct device *kdev;
925         /** @attr: sysfs attributes */
926         struct device_attribute *attr;
927
928         /**
929          * @head:
930          *
931          * List of all connectors on a @dev, linked from
932          * &drm_mode_config.connector_list. Protected by
933          * &drm_mode_config.connector_list_lock, but please only use
934          * &drm_connector_list_iter to walk this list.
935          */
936         struct list_head head;
937
938         /** @base: base KMS object */
939         struct drm_mode_object base;
940
941         /** @name: human readable name, can be overwritten by the driver */
942         char *name;
943
944         /**
945          * @mutex: Lock for general connector state, but currently only protects
946          * @registered. Most of the connector state is still protected by
947          * &drm_mode_config.mutex.
948          */
949         struct mutex mutex;
950
951         /**
952          * @index: Compacted connector index, which matches the position inside
953          * the mode_config.list for drivers not supporting hot-add/removing. Can
954          * be used as an array index. It is invariant over the lifetime of the
955          * connector.
956          */
957         unsigned index;
958
959         /**
960          * @connector_type:
961          * one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
962          */
963         int connector_type;
964         /** @connector_type_id: index into connector type enum */
965         int connector_type_id;
966         /**
967          * @interlace_allowed:
968          * Can this connector handle interlaced modes? Only used by
969          * drm_helper_probe_single_connector_modes() for mode filtering.
970          */
971         bool interlace_allowed;
972         /**
973          * @doublescan_allowed:
974          * Can this connector handle doublescan? Only used by
975          * drm_helper_probe_single_connector_modes() for mode filtering.
976          */
977         bool doublescan_allowed;
978         /**
979          * @stereo_allowed:
980          * Can this connector handle stereo modes? Only used by
981          * drm_helper_probe_single_connector_modes() for mode filtering.
982          */
983         bool stereo_allowed;
984
985         /**
986          * @ycbcr_420_allowed : This bool indicates if this connector is
987          * capable of handling YCBCR 420 output. While parsing the EDID
988          * blocks it's very helpful to know if the source is capable of
989          * handling YCBCR 420 outputs.
990          */
991         bool ycbcr_420_allowed;
992
993         /**
994          * @registration_state: Is this connector initializing, exposed
995          * (registered) with userspace, or unregistered?
996          *
997          * Protected by @mutex.
998          */
999         enum drm_connector_registration_state registration_state;
1000
1001         /**
1002          * @modes:
1003          * Modes available on this connector (from fill_modes() + user).
1004          * Protected by &drm_mode_config.mutex.
1005          */
1006         struct list_head modes;
1007
1008         /**
1009          * @status:
1010          * One of the drm_connector_status enums (connected, not, or unknown).
1011          * Protected by &drm_mode_config.mutex.
1012          */
1013         enum drm_connector_status status;
1014
1015         /**
1016          * @probed_modes:
1017          * These are modes added by probing with DDC or the BIOS, before
1018          * filtering is applied. Used by the probe helpers. Protected by
1019          * &drm_mode_config.mutex.
1020          */
1021         struct list_head probed_modes;
1022
1023         /**
1024          * @display_info: Display information is filled from EDID information
1025          * when a display is detected. For non hot-pluggable displays such as
1026          * flat panels in embedded systems, the driver should initialize the
1027          * &drm_display_info.width_mm and &drm_display_info.height_mm fields
1028          * with the physical size of the display.
1029          *
1030          * Protected by &drm_mode_config.mutex.
1031          */
1032         struct drm_display_info display_info;
1033
1034         /** @funcs: connector control functions */
1035         const struct drm_connector_funcs *funcs;
1036
1037         /**
1038          * @edid_blob_ptr: DRM property containing EDID if present. Protected by
1039          * &drm_mode_config.mutex. This should be updated only by calling
1040          * drm_connector_update_edid_property().
1041          */
1042         struct drm_property_blob *edid_blob_ptr;
1043
1044         /** @properties: property tracking for this connector */
1045         struct drm_object_properties properties;
1046
1047         /**
1048          * @scaling_mode_property: Optional atomic property to control the
1049          * upscaling. See drm_connector_attach_content_protection_property().
1050          */
1051         struct drm_property *scaling_mode_property;
1052
1053         /**
1054          * @vrr_capable_property: Optional property to help userspace
1055          * query hardware support for variable refresh rate on a connector.
1056          * connector. Drivers can add the property to a connector by
1057          * calling drm_connector_attach_vrr_capable_property().
1058          *
1059          * This should be updated only by calling
1060          * drm_connector_set_vrr_capable_property().
1061          */
1062         struct drm_property *vrr_capable_property;
1063
1064         /**
1065          * @colorspace_property: Connector property to set the suitable
1066          * colorspace supported by the sink.
1067          */
1068         struct drm_property *colorspace_property;
1069
1070         /**
1071          * @path_blob_ptr:
1072          *
1073          * DRM blob property data for the DP MST path property. This should only
1074          * be updated by calling drm_connector_set_path_property().
1075          */
1076         struct drm_property_blob *path_blob_ptr;
1077
1078         /**
1079          * @max_bpc_property: Default connector property for the max bpc to be
1080          * driven out of the connector.
1081          */
1082         struct drm_property *max_bpc_property;
1083
1084 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
1085 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
1086 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
1087
1088         /**
1089          * @polled:
1090          *
1091          * Connector polling mode, a combination of
1092          *
1093          * DRM_CONNECTOR_POLL_HPD
1094          *     The connector generates hotplug events and doesn't need to be
1095          *     periodically polled. The CONNECT and DISCONNECT flags must not
1096          *     be set together with the HPD flag.
1097          *
1098          * DRM_CONNECTOR_POLL_CONNECT
1099          *     Periodically poll the connector for connection.
1100          *
1101          * DRM_CONNECTOR_POLL_DISCONNECT
1102          *     Periodically poll the connector for disconnection, without
1103          *     causing flickering even when the connector is in use. DACs should
1104          *     rarely do this without a lot of testing.
1105          *
1106          * Set to 0 for connectors that don't support connection status
1107          * discovery.
1108          */
1109         uint8_t polled;
1110
1111         /**
1112          * @dpms: Current dpms state. For legacy drivers the
1113          * &drm_connector_funcs.dpms callback must update this. For atomic
1114          * drivers, this is handled by the core atomic code, and drivers must
1115          * only take &drm_crtc_state.active into account.
1116          */
1117         int dpms;
1118
1119         /** @helper_private: mid-layer private data */
1120         const struct drm_connector_helper_funcs *helper_private;
1121
1122         /** @cmdline_mode: mode line parsed from the kernel cmdline for this connector */
1123         struct drm_cmdline_mode cmdline_mode;
1124         /** @force: a DRM_FORCE_<foo> state for forced mode sets */
1125         enum drm_connector_force force;
1126         /** @override_edid: has the EDID been overwritten through debugfs for testing? */
1127         bool override_edid;
1128
1129 #define DRM_CONNECTOR_MAX_ENCODER 3
1130         /**
1131          * @encoder_ids: Valid encoders for this connector. Please only use
1132          * drm_connector_for_each_possible_encoder() to enumerate these.
1133          */
1134         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
1135
1136         /**
1137          * @encoder: Currently bound encoder driving this connector, if any.
1138          * Only really meaningful for non-atomic drivers. Atomic drivers should
1139          * instead look at &drm_connector_state.best_encoder, and in case they
1140          * need the CRTC driving this output, &drm_connector_state.crtc.
1141          */
1142         struct drm_encoder *encoder;
1143
1144 #define MAX_ELD_BYTES   128
1145         /** @eld: EDID-like data, if present */
1146         uint8_t eld[MAX_ELD_BYTES];
1147         /** @latency_present: AV delay info from ELD, if found */
1148         bool latency_present[2];
1149         /**
1150          * @video_latency: Video latency info from ELD, if found.
1151          * [0]: progressive, [1]: interlaced
1152          */
1153         int video_latency[2];
1154         /**
1155          * @audio_latency: audio latency info from ELD, if found
1156          * [0]: progressive, [1]: interlaced
1157          */
1158         int audio_latency[2];
1159         /**
1160          * @null_edid_counter: track sinks that give us all zeros for the EDID.
1161          * Needed to workaround some HW bugs where we get all 0s
1162          */
1163         int null_edid_counter;
1164
1165         /** @bad_edid_counter: track sinks that give us an EDID with invalid checksum */
1166         unsigned bad_edid_counter;
1167
1168         /**
1169          * @edid_corrupt: Indicates whether the last read EDID was corrupt. Used
1170          * in Displayport compliance testing - Displayport Link CTS Core 1.2
1171          * rev1.1 4.2.2.6
1172          */
1173         bool edid_corrupt;
1174
1175         /** @debugfs_entry: debugfs directory for this connector */
1176         struct dentry *debugfs_entry;
1177
1178         /**
1179          * @state:
1180          *
1181          * Current atomic state for this connector.
1182          *
1183          * This is protected by &drm_mode_config.connection_mutex. Note that
1184          * nonblocking atomic commits access the current connector state without
1185          * taking locks. Either by going through the &struct drm_atomic_state
1186          * pointers, see for_each_oldnew_connector_in_state(),
1187          * for_each_old_connector_in_state() and
1188          * for_each_new_connector_in_state(). Or through careful ordering of
1189          * atomic commit operations as implemented in the atomic helpers, see
1190          * &struct drm_crtc_commit.
1191          */
1192         struct drm_connector_state *state;
1193
1194         /* DisplayID bits. FIXME: Extract into a substruct? */
1195
1196         /**
1197          * @tile_blob_ptr:
1198          *
1199          * DRM blob property data for the tile property (used mostly by DP MST).
1200          * This is meant for screens which are driven through separate display
1201          * pipelines represented by &drm_crtc, which might not be running with
1202          * genlocked clocks. For tiled panels which are genlocked, like
1203          * dual-link LVDS or dual-link DSI, the driver should try to not expose
1204          * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
1205          *
1206          * This should only be updated by calling
1207          * drm_connector_set_tile_property().
1208          */
1209         struct drm_property_blob *tile_blob_ptr;
1210
1211         /** @has_tile: is this connector connected to a tiled monitor */
1212         bool has_tile;
1213         /** @tile_group: tile group for the connected monitor */
1214         struct drm_tile_group *tile_group;
1215         /** @tile_is_single_monitor: whether the tile is one monitor housing */
1216         bool tile_is_single_monitor;
1217
1218         /** @num_h_tile: number of horizontal tiles in the tile group */
1219         /** @num_v_tile: number of vertical tiles in the tile group */
1220         uint8_t num_h_tile, num_v_tile;
1221         /** @tile_h_loc: horizontal location of this tile */
1222         /** @tile_v_loc: vertical location of this tile */
1223         uint8_t tile_h_loc, tile_v_loc;
1224         /** @tile_h_size: horizontal size of this tile. */
1225         /** @tile_v_size: vertical size of this tile. */
1226         uint16_t tile_h_size, tile_v_size;
1227
1228         /**
1229          * @free_node:
1230          *
1231          * List used only by &drm_connector_list_iter to be able to clean up a
1232          * connector from any context, in conjunction with
1233          * &drm_mode_config.connector_free_work.
1234          */
1235         struct llist_node free_node;
1236 };
1237
1238 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1239
1240 int drm_connector_init(struct drm_device *dev,
1241                        struct drm_connector *connector,
1242                        const struct drm_connector_funcs *funcs,
1243                        int connector_type);
1244 void drm_connector_attach_edid_property(struct drm_connector *connector);
1245 int drm_connector_register(struct drm_connector *connector);
1246 void drm_connector_unregister(struct drm_connector *connector);
1247 int drm_connector_attach_encoder(struct drm_connector *connector,
1248                                       struct drm_encoder *encoder);
1249
1250 void drm_connector_cleanup(struct drm_connector *connector);
1251
1252 static inline unsigned int drm_connector_index(const struct drm_connector *connector)
1253 {
1254         return connector->index;
1255 }
1256
1257 static inline u32 drm_connector_mask(const struct drm_connector *connector)
1258 {
1259         return 1 << connector->index;
1260 }
1261
1262 /**
1263  * drm_connector_lookup - lookup connector object
1264  * @dev: DRM device
1265  * @file_priv: drm file to check for lease against.
1266  * @id: connector object id
1267  *
1268  * This function looks up the connector object specified by id
1269  * add takes a reference to it.
1270  */
1271 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
1272                 struct drm_file *file_priv,
1273                 uint32_t id)
1274 {
1275         struct drm_mode_object *mo;
1276         mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
1277         return mo ? obj_to_connector(mo) : NULL;
1278 }
1279
1280 /**
1281  * drm_connector_get - acquire a connector reference
1282  * @connector: DRM connector
1283  *
1284  * This function increments the connector's refcount.
1285  */
1286 static inline void drm_connector_get(struct drm_connector *connector)
1287 {
1288         drm_mode_object_get(&connector->base);
1289 }
1290
1291 /**
1292  * drm_connector_put - release a connector reference
1293  * @connector: DRM connector
1294  *
1295  * This function decrements the connector's reference count and frees the
1296  * object if the reference count drops to zero.
1297  */
1298 static inline void drm_connector_put(struct drm_connector *connector)
1299 {
1300         drm_mode_object_put(&connector->base);
1301 }
1302
1303 /**
1304  * drm_connector_is_unregistered - has the connector been unregistered from
1305  * userspace?
1306  * @connector: DRM connector
1307  *
1308  * Checks whether or not @connector has been unregistered from userspace.
1309  *
1310  * Returns:
1311  * True if the connector was unregistered, false if the connector is
1312  * registered or has not yet been registered with userspace.
1313  */
1314 static inline bool
1315 drm_connector_is_unregistered(struct drm_connector *connector)
1316 {
1317         return READ_ONCE(connector->registration_state) ==
1318                 DRM_CONNECTOR_UNREGISTERED;
1319 }
1320
1321 const char *drm_get_connector_status_name(enum drm_connector_status status);
1322 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1323 const char *drm_get_dpms_name(int val);
1324 const char *drm_get_dvi_i_subconnector_name(int val);
1325 const char *drm_get_dvi_i_select_name(int val);
1326 const char *drm_get_tv_subconnector_name(int val);
1327 const char *drm_get_tv_select_name(int val);
1328 const char *drm_get_content_protection_name(int val);
1329
1330 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1331 int drm_mode_create_tv_margin_properties(struct drm_device *dev);
1332 int drm_mode_create_tv_properties(struct drm_device *dev,
1333                                   unsigned int num_modes,
1334                                   const char * const modes[]);
1335 void drm_connector_attach_tv_margin_properties(struct drm_connector *conn);
1336 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1337 int drm_connector_attach_content_type_property(struct drm_connector *dev);
1338 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1339                                                u32 scaling_mode_mask);
1340 int drm_connector_attach_vrr_capable_property(
1341                 struct drm_connector *connector);
1342 int drm_connector_attach_content_protection_property(
1343                 struct drm_connector *connector);
1344 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1345 int drm_mode_create_colorspace_property(struct drm_connector *connector);
1346 int drm_mode_create_content_type_property(struct drm_device *dev);
1347 void drm_hdmi_avi_infoframe_content_type(struct hdmi_avi_infoframe *frame,
1348                                          const struct drm_connector_state *conn_state);
1349
1350 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1351
1352 int drm_connector_set_path_property(struct drm_connector *connector,
1353                                     const char *path);
1354 int drm_connector_set_tile_property(struct drm_connector *connector);
1355 int drm_connector_update_edid_property(struct drm_connector *connector,
1356                                        const struct edid *edid);
1357 void drm_connector_set_link_status_property(struct drm_connector *connector,
1358                                             uint64_t link_status);
1359 void drm_connector_set_vrr_capable_property(
1360                 struct drm_connector *connector, bool capable);
1361 int drm_connector_init_panel_orientation_property(
1362         struct drm_connector *connector, int width, int height);
1363 int drm_connector_attach_max_bpc_property(struct drm_connector *connector,
1364                                           int min, int max);
1365
1366 /**
1367  * struct drm_tile_group - Tile group metadata
1368  * @refcount: reference count
1369  * @dev: DRM device
1370  * @id: tile group id exposed to userspace
1371  * @group_data: Sink-private data identifying this group
1372  *
1373  * @group_data corresponds to displayid vend/prod/serial for external screens
1374  * with an EDID.
1375  */
1376 struct drm_tile_group {
1377         struct kref refcount;
1378         struct drm_device *dev;
1379         int id;
1380         u8 group_data[8];
1381 };
1382
1383 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1384                                                   char topology[8]);
1385 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1386                                                char topology[8]);
1387 void drm_mode_put_tile_group(struct drm_device *dev,
1388                              struct drm_tile_group *tg);
1389
1390 /**
1391  * struct drm_connector_list_iter - connector_list iterator
1392  *
1393  * This iterator tracks state needed to be able to walk the connector_list
1394  * within struct drm_mode_config. Only use together with
1395  * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1396  * drm_connector_list_iter_next() respectively the convenience macro
1397  * drm_for_each_connector_iter().
1398  */
1399 struct drm_connector_list_iter {
1400 /* private: */
1401         struct drm_device *dev;
1402         struct drm_connector *conn;
1403 };
1404
1405 void drm_connector_list_iter_begin(struct drm_device *dev,
1406                                    struct drm_connector_list_iter *iter);
1407 struct drm_connector *
1408 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1409 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1410
1411 bool drm_connector_has_possible_encoder(struct drm_connector *connector,
1412                                         struct drm_encoder *encoder);
1413
1414 /**
1415  * drm_for_each_connector_iter - connector_list iterator macro
1416  * @connector: &struct drm_connector pointer used as cursor
1417  * @iter: &struct drm_connector_list_iter
1418  *
1419  * Note that @connector is only valid within the list body, if you want to use
1420  * @connector after calling drm_connector_list_iter_end() then you need to grab
1421  * your own reference first using drm_connector_get().
1422  */
1423 #define drm_for_each_connector_iter(connector, iter) \
1424         while ((connector = drm_connector_list_iter_next(iter)))
1425
1426 /**
1427  * drm_connector_for_each_possible_encoder - iterate connector's possible encoders
1428  * @connector: &struct drm_connector pointer
1429  * @encoder: &struct drm_encoder pointer used as cursor
1430  * @__i: int iteration cursor, for macro-internal use
1431  */
1432 #define drm_connector_for_each_possible_encoder(connector, encoder, __i) \
1433         for ((__i) = 0; (__i) < ARRAY_SIZE((connector)->encoder_ids) && \
1434                      (connector)->encoder_ids[(__i)] != 0; (__i)++) \
1435                 for_each_if((encoder) = \
1436                             drm_encoder_find((connector)->dev, NULL, \
1437                                              (connector)->encoder_ids[(__i)])) \
1438
1439 #endif