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