Merge tag 'xfs-4.15-fixes-5' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[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/ctype.h>
28 #include <linux/hdmi.h>
29 #include <drm/drm_mode_object.h>
30
31 #include <uapi/drm/drm_mode.h>
32
33 struct drm_connector_helper_funcs;
34 struct drm_modeset_acquire_ctx;
35 struct drm_device;
36 struct drm_crtc;
37 struct drm_encoder;
38 struct drm_property;
39 struct drm_property_blob;
40 struct drm_printer;
41 struct edid;
42
43 enum drm_connector_force {
44         DRM_FORCE_UNSPECIFIED,
45         DRM_FORCE_OFF,
46         DRM_FORCE_ON,         /* force on analog part normally */
47         DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
48 };
49
50 /**
51  * enum drm_connector_status - status for a &drm_connector
52  *
53  * This enum is used to track the connector status. There are no separate
54  * #defines for the uapi!
55  */
56 enum drm_connector_status {
57         /**
58          * @connector_status_connected: The connector is definitely connected to
59          * a sink device, and can be enabled.
60          */
61         connector_status_connected = 1,
62         /**
63          * @connector_status_disconnected: The connector isn't connected to a
64          * sink device which can be autodetect. For digital outputs like DP or
65          * HDMI (which can be realiable probed) this means there's really
66          * nothing there. It is driver-dependent whether a connector with this
67          * status can be lit up or not.
68          */
69         connector_status_disconnected = 2,
70         /**
71          * @connector_status_unknown: The connector's status could not be
72          * reliably detected. This happens when probing would either cause
73          * flicker (like load-detection when the connector is in use), or when a
74          * hardware resource isn't available (like when load-detection needs a
75          * free CRTC). It should be possible to light up the connector with one
76          * of the listed fallback modes. For default configuration userspace
77          * should only try to light up connectors with unknown status when
78          * there's not connector with @connector_status_connected.
79          */
80         connector_status_unknown = 3,
81 };
82
83 enum subpixel_order {
84         SubPixelUnknown = 0,
85         SubPixelHorizontalRGB,
86         SubPixelHorizontalBGR,
87         SubPixelVerticalRGB,
88         SubPixelVerticalBGR,
89         SubPixelNone,
90
91 };
92
93 /**
94  * struct drm_scrambling: sink's scrambling support.
95  */
96 struct drm_scrambling {
97         /**
98          * @supported: scrambling supported for rates > 340 Mhz.
99          */
100         bool supported;
101         /**
102          * @low_rates: scrambling supported for rates <= 340 Mhz.
103          */
104         bool low_rates;
105 };
106
107 /*
108  * struct drm_scdc - Information about scdc capabilities of a HDMI 2.0 sink
109  *
110  * Provides SCDC register support and capabilities related information on a
111  * HDMI 2.0 sink. In case of a HDMI 1.4 sink, all parameter must be 0.
112  */
113 struct drm_scdc {
114         /**
115          * @supported: status control & data channel present.
116          */
117         bool supported;
118         /**
119          * @read_request: sink is capable of generating scdc read request.
120          */
121         bool read_request;
122         /**
123          * @scrambling: sink's scrambling capabilities
124          */
125         struct drm_scrambling scrambling;
126 };
127
128
129 /**
130  * struct drm_hdmi_info - runtime information about the connected HDMI sink
131  *
132  * Describes if a given display supports advanced HDMI 2.0 features.
133  * This information is available in CEA-861-F extension blocks (like HF-VSDB).
134  */
135 struct drm_hdmi_info {
136         /** @scdc: sink's scdc support and capabilities */
137         struct drm_scdc scdc;
138
139         /**
140          * @y420_vdb_modes: bitmap of modes which can support ycbcr420
141          * output only (not normal RGB/YCBCR444/422 outputs). There are total
142          * 107 VICs defined by CEA-861-F spec, so the size is 128 bits to map
143          * upto 128 VICs;
144          */
145         unsigned long y420_vdb_modes[BITS_TO_LONGS(128)];
146
147         /**
148          * @y420_cmdb_modes: bitmap of modes which can support ycbcr420
149          * output also, along with normal HDMI outputs. There are total 107
150          * VICs defined by CEA-861-F spec, so the size is 128 bits to map upto
151          * 128 VICs;
152          */
153         unsigned long y420_cmdb_modes[BITS_TO_LONGS(128)];
154
155         /** @y420_cmdb_map: bitmap of SVD index, to extraxt vcb modes */
156         u64 y420_cmdb_map;
157
158         /** @y420_dc_modes: bitmap of deep color support index */
159         u8 y420_dc_modes;
160 };
161
162 /**
163  * enum drm_link_status - connector's link_status property value
164  *
165  * This enum is used as the connector's link status property value.
166  * It is set to the values defined in uapi.
167  *
168  * @DRM_LINK_STATUS_GOOD: DP Link is Good as a result of successful
169  *                        link training
170  * @DRM_LINK_STATUS_BAD: DP Link is BAD as a result of link training
171  *                       failure
172  */
173 enum drm_link_status {
174         DRM_LINK_STATUS_GOOD = DRM_MODE_LINK_STATUS_GOOD,
175         DRM_LINK_STATUS_BAD = DRM_MODE_LINK_STATUS_BAD,
176 };
177
178 /**
179  * struct drm_display_info - runtime data about the connected sink
180  *
181  * Describes a given display (e.g. CRT or flat panel) and its limitations. For
182  * fixed display sinks like built-in panels there's not much difference between
183  * this and &struct drm_connector. But for sinks with a real cable this
184  * structure is meant to describe all the things at the other end of the cable.
185  *
186  * For sinks which provide an EDID this can be filled out by calling
187  * drm_add_edid_modes().
188  */
189 struct drm_display_info {
190         /**
191          * @name: Name of the display.
192          */
193         char name[DRM_DISPLAY_INFO_LEN];
194
195         /**
196          * @width_mm: Physical width in mm.
197          */
198         unsigned int width_mm;
199         /**
200          * @height_mm: Physical height in mm.
201          */
202         unsigned int height_mm;
203
204         /**
205          * @pixel_clock: Maximum pixel clock supported by the sink, in units of
206          * 100Hz. This mismatches the clock in &drm_display_mode (which is in
207          * kHZ), because that's what the EDID uses as base unit.
208          */
209         unsigned int pixel_clock;
210         /**
211          * @bpc: Maximum bits per color channel. Used by HDMI and DP outputs.
212          */
213         unsigned int bpc;
214
215         /**
216          * @subpixel_order: Subpixel order of LCD panels.
217          */
218         enum subpixel_order subpixel_order;
219
220 #define DRM_COLOR_FORMAT_RGB444         (1<<0)
221 #define DRM_COLOR_FORMAT_YCRCB444       (1<<1)
222 #define DRM_COLOR_FORMAT_YCRCB422       (1<<2)
223 #define DRM_COLOR_FORMAT_YCRCB420       (1<<3)
224
225         /**
226          * @color_formats: HDMI Color formats, selects between RGB and YCrCb
227          * modes. Used DRM_COLOR_FORMAT\_ defines, which are _not_ the same ones
228          * as used to describe the pixel format in framebuffers, and also don't
229          * match the formats in @bus_formats which are shared with v4l.
230          */
231         u32 color_formats;
232
233         /**
234          * @bus_formats: Pixel data format on the wire, somewhat redundant with
235          * @color_formats. Array of size @num_bus_formats encoded using
236          * MEDIA_BUS_FMT\_ defines shared with v4l and media drivers.
237          */
238         const u32 *bus_formats;
239         /**
240          * @num_bus_formats: Size of @bus_formats array.
241          */
242         unsigned int num_bus_formats;
243
244 #define DRM_BUS_FLAG_DE_LOW             (1<<0)
245 #define DRM_BUS_FLAG_DE_HIGH            (1<<1)
246 /* drive data on pos. edge */
247 #define DRM_BUS_FLAG_PIXDATA_POSEDGE    (1<<2)
248 /* drive data on neg. edge */
249 #define DRM_BUS_FLAG_PIXDATA_NEGEDGE    (1<<3)
250 /* data is transmitted MSB to LSB on the bus */
251 #define DRM_BUS_FLAG_DATA_MSB_TO_LSB    (1<<4)
252 /* data is transmitted LSB to MSB on the bus */
253 #define DRM_BUS_FLAG_DATA_LSB_TO_MSB    (1<<5)
254
255         /**
256          * @bus_flags: Additional information (like pixel signal polarity) for
257          * the pixel data on the bus, using DRM_BUS_FLAGS\_ defines.
258          */
259         u32 bus_flags;
260
261         /**
262          * @max_tmds_clock: Maximum TMDS clock rate supported by the
263          * sink in kHz. 0 means undefined.
264          */
265         int max_tmds_clock;
266
267         /**
268          * @dvi_dual: Dual-link DVI sink?
269          */
270         bool dvi_dual;
271
272         /**
273          * @edid_hdmi_dc_modes: Mask of supported hdmi deep color modes. Even
274          * more stuff redundant with @bus_formats.
275          */
276         u8 edid_hdmi_dc_modes;
277
278         /**
279          * @cea_rev: CEA revision of the HDMI sink.
280          */
281         u8 cea_rev;
282
283         /**
284          * @hdmi: advance features of a HDMI sink.
285          */
286         struct drm_hdmi_info hdmi;
287
288         /**
289          * @non_desktop: Non desktop display (HMD).
290          */
291         bool non_desktop;
292 };
293
294 int drm_display_info_set_bus_formats(struct drm_display_info *info,
295                                      const u32 *formats,
296                                      unsigned int num_formats);
297
298 /**
299  * struct drm_tv_connector_state - TV connector related states
300  * @subconnector: selected subconnector
301  * @margins: left/right/top/bottom margins
302  * @mode: TV mode
303  * @brightness: brightness in percent
304  * @contrast: contrast in percent
305  * @flicker_reduction: flicker reduction in percent
306  * @overscan: overscan in percent
307  * @saturation: saturation in percent
308  * @hue: hue in percent
309  */
310 struct drm_tv_connector_state {
311         enum drm_mode_subconnector subconnector;
312         struct {
313                 unsigned int left;
314                 unsigned int right;
315                 unsigned int top;
316                 unsigned int bottom;
317         } margins;
318         unsigned int mode;
319         unsigned int brightness;
320         unsigned int contrast;
321         unsigned int flicker_reduction;
322         unsigned int overscan;
323         unsigned int saturation;
324         unsigned int hue;
325 };
326
327 /**
328  * struct drm_connector_state - mutable connector state
329  * @connector: backpointer to the connector
330  * @best_encoder: can be used by helpers and drivers to select the encoder
331  * @state: backpointer to global drm_atomic_state
332  * @tv: TV connector state
333  */
334 struct drm_connector_state {
335         struct drm_connector *connector;
336
337         /**
338          * @crtc: CRTC to connect connector to, NULL if disabled.
339          *
340          * Do not change this directly, use drm_atomic_set_crtc_for_connector()
341          * instead.
342          */
343         struct drm_crtc *crtc;
344
345         struct drm_encoder *best_encoder;
346
347         /**
348          * @link_status: Connector link_status to keep track of whether link is
349          * GOOD or BAD to notify userspace if retraining is necessary.
350          */
351         enum drm_link_status link_status;
352
353         struct drm_atomic_state *state;
354
355         /**
356          * @commit: Tracks the pending commit to prevent use-after-free conditions.
357          *
358          * Is only set when @crtc is NULL.
359          */
360         struct drm_crtc_commit *commit;
361
362         struct drm_tv_connector_state tv;
363
364         /**
365          * @picture_aspect_ratio: Connector property to control the
366          * HDMI infoframe aspect ratio setting.
367          *
368          * The %DRM_MODE_PICTURE_ASPECT_\* values much match the
369          * values for &enum hdmi_picture_aspect
370          */
371         enum hdmi_picture_aspect picture_aspect_ratio;
372
373         /**
374          * @scaling_mode: Connector property to control the
375          * upscaling, mostly used for built-in panels.
376          */
377         unsigned int scaling_mode;
378 };
379
380 /**
381  * struct drm_connector_funcs - control connectors on a given device
382  *
383  * Each CRTC may have one or more connectors attached to it.  The functions
384  * below allow the core DRM code to control connectors, enumerate available modes,
385  * etc.
386  */
387 struct drm_connector_funcs {
388         /**
389          * @dpms:
390          *
391          * Legacy entry point to set the per-connector DPMS state. Legacy DPMS
392          * is exposed as a standard property on the connector, but diverted to
393          * this callback in the drm core. Note that atomic drivers don't
394          * implement the 4 level DPMS support on the connector any more, but
395          * instead only have an on/off "ACTIVE" property on the CRTC object.
396          *
397          * This hook is not used by atomic drivers, remapping of the legacy DPMS
398          * property is entirely handled in the DRM core.
399          *
400          * RETURNS:
401          *
402          * 0 on success or a negative error code on failure.
403          */
404         int (*dpms)(struct drm_connector *connector, int mode);
405
406         /**
407          * @reset:
408          *
409          * Reset connector hardware and software state to off. This function isn't
410          * called by the core directly, only through drm_mode_config_reset().
411          * It's not a helper hook only for historical reasons.
412          *
413          * Atomic drivers can use drm_atomic_helper_connector_reset() to reset
414          * atomic state using this hook.
415          */
416         void (*reset)(struct drm_connector *connector);
417
418         /**
419          * @detect:
420          *
421          * Check to see if anything is attached to the connector. The parameter
422          * force is set to false whilst polling, true when checking the
423          * connector due to a user request. force can be used by the driver to
424          * avoid expensive, destructive operations during automated probing.
425          *
426          * This callback is optional, if not implemented the connector will be
427          * considered as always being attached.
428          *
429          * FIXME:
430          *
431          * Note that this hook is only called by the probe helper. It's not in
432          * the helper library vtable purely for historical reasons. The only DRM
433          * core entry point to probe connector state is @fill_modes.
434          *
435          * Note that the helper library will already hold
436          * &drm_mode_config.connection_mutex. Drivers which need to grab additional
437          * locks to avoid races with concurrent modeset changes need to use
438          * &drm_connector_helper_funcs.detect_ctx instead.
439          *
440          * RETURNS:
441          *
442          * drm_connector_status indicating the connector's status.
443          */
444         enum drm_connector_status (*detect)(struct drm_connector *connector,
445                                             bool force);
446
447         /**
448          * @force:
449          *
450          * This function is called to update internal encoder state when the
451          * connector is forced to a certain state by userspace, either through
452          * the sysfs interfaces or on the kernel cmdline. In that case the
453          * @detect callback isn't called.
454          *
455          * FIXME:
456          *
457          * Note that this hook is only called by the probe helper. It's not in
458          * the helper library vtable purely for historical reasons. The only DRM
459          * core entry point to probe connector state is @fill_modes.
460          */
461         void (*force)(struct drm_connector *connector);
462
463         /**
464          * @fill_modes:
465          *
466          * Entry point for output detection and basic mode validation. The
467          * driver should reprobe the output if needed (e.g. when hotplug
468          * handling is unreliable), add all detected modes to &drm_connector.modes
469          * and filter out any the device can't support in any configuration. It
470          * also needs to filter out any modes wider or higher than the
471          * parameters max_width and max_height indicate.
472          *
473          * The drivers must also prune any modes no longer valid from
474          * &drm_connector.modes. Furthermore it must update
475          * &drm_connector.status and &drm_connector.edid.  If no EDID has been
476          * received for this output connector->edid must be NULL.
477          *
478          * Drivers using the probe helpers should use
479          * drm_helper_probe_single_connector_modes() or
480          * drm_helper_probe_single_connector_modes_nomerge() to implement this
481          * function.
482          *
483          * RETURNS:
484          *
485          * The number of modes detected and filled into &drm_connector.modes.
486          */
487         int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
488
489         /**
490          * @set_property:
491          *
492          * This is the legacy entry point to update a property attached to the
493          * connector.
494          *
495          * This callback is optional if the driver does not support any legacy
496          * driver-private properties. For atomic drivers it is not used because
497          * property handling is done entirely in the DRM core.
498          *
499          * RETURNS:
500          *
501          * 0 on success or a negative error code on failure.
502          */
503         int (*set_property)(struct drm_connector *connector, struct drm_property *property,
504                              uint64_t val);
505
506         /**
507          * @late_register:
508          *
509          * This optional hook can be used to register additional userspace
510          * interfaces attached to the connector, light backlight control, i2c,
511          * DP aux or similar interfaces. It is called late in the driver load
512          * sequence from drm_connector_register() when registering all the
513          * core drm connector interfaces. Everything added from this callback
514          * should be unregistered in the early_unregister callback.
515          *
516          * This is called while holding &drm_connector.mutex.
517          *
518          * Returns:
519          *
520          * 0 on success, or a negative error code on failure.
521          */
522         int (*late_register)(struct drm_connector *connector);
523
524         /**
525          * @early_unregister:
526          *
527          * This optional hook should be used to unregister the additional
528          * userspace interfaces attached to the connector from
529          * late_register(). It is called from drm_connector_unregister(),
530          * early in the driver unload sequence to disable userspace access
531          * before data structures are torndown.
532          *
533          * This is called while holding &drm_connector.mutex.
534          */
535         void (*early_unregister)(struct drm_connector *connector);
536
537         /**
538          * @destroy:
539          *
540          * Clean up connector resources. This is called at driver unload time
541          * through drm_mode_config_cleanup(). It can also be called at runtime
542          * when a connector is being hot-unplugged for drivers that support
543          * connector hotplugging (e.g. DisplayPort MST).
544          */
545         void (*destroy)(struct drm_connector *connector);
546
547         /**
548          * @atomic_duplicate_state:
549          *
550          * Duplicate the current atomic state for this connector and return it.
551          * The core and helpers guarantee that any atomic state duplicated with
552          * this hook and still owned by the caller (i.e. not transferred to the
553          * driver by calling &drm_mode_config_funcs.atomic_commit) will be
554          * cleaned up by calling the @atomic_destroy_state hook in this
555          * structure.
556          *
557          * Atomic drivers which don't subclass &struct drm_connector_state should use
558          * drm_atomic_helper_connector_duplicate_state(). Drivers that subclass the
559          * state structure to extend it with driver-private state should use
560          * __drm_atomic_helper_connector_duplicate_state() to make sure shared state is
561          * duplicated in a consistent fashion across drivers.
562          *
563          * It is an error to call this hook before &drm_connector.state has been
564          * initialized correctly.
565          *
566          * NOTE:
567          *
568          * If the duplicate state references refcounted resources this hook must
569          * acquire a reference for each of them. The driver must release these
570          * references again in @atomic_destroy_state.
571          *
572          * RETURNS:
573          *
574          * Duplicated atomic state or NULL when the allocation failed.
575          */
576         struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
577
578         /**
579          * @atomic_destroy_state:
580          *
581          * Destroy a state duplicated with @atomic_duplicate_state and release
582          * or unreference all resources it references
583          */
584         void (*atomic_destroy_state)(struct drm_connector *connector,
585                                      struct drm_connector_state *state);
586
587         /**
588          * @atomic_set_property:
589          *
590          * Decode a driver-private property value and store the decoded value
591          * into the passed-in state structure. Since the atomic core decodes all
592          * standardized properties (even for extensions beyond the core set of
593          * properties which might not be implemented by all drivers) this
594          * requires drivers to subclass the state structure.
595          *
596          * Such driver-private properties should really only be implemented for
597          * truly hardware/vendor specific state. Instead it is preferred to
598          * standardize atomic extension and decode the properties used to expose
599          * such an extension in the core.
600          *
601          * Do not call this function directly, use
602          * drm_atomic_connector_set_property() instead.
603          *
604          * This callback is optional if the driver does not support any
605          * driver-private atomic properties.
606          *
607          * NOTE:
608          *
609          * This function is called in the state assembly phase of atomic
610          * modesets, which can be aborted for any reason (including on
611          * userspace's request to just check whether a configuration would be
612          * possible). Drivers MUST NOT touch any persistent state (hardware or
613          * software) or data structures except the passed in @state parameter.
614          *
615          * Also since userspace controls in which order properties are set this
616          * function must not do any input validation (since the state update is
617          * incomplete and hence likely inconsistent). Instead any such input
618          * validation must be done in the various atomic_check callbacks.
619          *
620          * RETURNS:
621          *
622          * 0 if the property has been found, -EINVAL if the property isn't
623          * implemented by the driver (which shouldn't ever happen, the core only
624          * asks for properties attached to this connector). No other validation
625          * is allowed by the driver. The core already checks that the property
626          * value is within the range (integer, valid enum value, ...) the driver
627          * set when registering the property.
628          */
629         int (*atomic_set_property)(struct drm_connector *connector,
630                                    struct drm_connector_state *state,
631                                    struct drm_property *property,
632                                    uint64_t val);
633
634         /**
635          * @atomic_get_property:
636          *
637          * Reads out the decoded driver-private property. This is used to
638          * implement the GETCONNECTOR IOCTL.
639          *
640          * Do not call this function directly, use
641          * drm_atomic_connector_get_property() instead.
642          *
643          * This callback is optional if the driver does not support any
644          * driver-private atomic properties.
645          *
646          * RETURNS:
647          *
648          * 0 on success, -EINVAL if the property isn't implemented by the
649          * driver (which shouldn't ever happen, the core only asks for
650          * properties attached to this connector).
651          */
652         int (*atomic_get_property)(struct drm_connector *connector,
653                                    const struct drm_connector_state *state,
654                                    struct drm_property *property,
655                                    uint64_t *val);
656
657         /**
658          * @atomic_print_state:
659          *
660          * If driver subclasses &struct drm_connector_state, it should implement
661          * this optional hook for printing additional driver specific state.
662          *
663          * Do not call this directly, use drm_atomic_connector_print_state()
664          * instead.
665          */
666         void (*atomic_print_state)(struct drm_printer *p,
667                                    const struct drm_connector_state *state);
668 };
669
670 /* mode specified on the command line */
671 struct drm_cmdline_mode {
672         bool specified;
673         bool refresh_specified;
674         bool bpp_specified;
675         int xres, yres;
676         int bpp;
677         int refresh;
678         bool rb;
679         bool interlace;
680         bool cvt;
681         bool margins;
682         enum drm_connector_force force;
683 };
684
685 /**
686  * struct drm_connector - central DRM connector control structure
687  * @dev: parent DRM device
688  * @kdev: kernel device for sysfs attributes
689  * @attr: sysfs attributes
690  * @head: list management
691  * @base: base KMS object
692  * @name: human readable name, can be overwritten by the driver
693  * @connector_type: one of the DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
694  * @connector_type_id: index into connector type enum
695  * @interlace_allowed: can this connector handle interlaced modes?
696  * @doublescan_allowed: can this connector handle doublescan?
697  * @stereo_allowed: can this connector handle stereo modes?
698  * @funcs: connector control functions
699  * @edid_blob_ptr: DRM property containing EDID if present
700  * @properties: property tracking for this connector
701  * @dpms: current dpms state
702  * @helper_private: mid-layer private data
703  * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
704  * @force: a DRM_FORCE_<foo> state for forced mode sets
705  * @override_edid: has the EDID been overwritten through debugfs for testing?
706  * @encoder_ids: valid encoders for this connector
707  * @encoder: encoder driving this connector, if any
708  * @eld: EDID-like data, if present
709  * @latency_present: AV delay info from ELD, if found
710  * @video_latency: video latency info from ELD, if found
711  * @audio_latency: audio latency info from ELD, if found
712  * @null_edid_counter: track sinks that give us all zeros for the EDID
713  * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
714  * @edid_corrupt: indicates whether the last read EDID was corrupt
715  * @debugfs_entry: debugfs directory for this connector
716  * @has_tile: is this connector connected to a tiled monitor
717  * @tile_group: tile group for the connected monitor
718  * @tile_is_single_monitor: whether the tile is one monitor housing
719  * @num_h_tile: number of horizontal tiles in the tile group
720  * @num_v_tile: number of vertical tiles in the tile group
721  * @tile_h_loc: horizontal location of this tile
722  * @tile_v_loc: vertical location of this tile
723  * @tile_h_size: horizontal size of this tile.
724  * @tile_v_size: vertical size of this tile.
725  * @scaling_mode_property:  Optional atomic property to control the upscaling.
726  *
727  * Each connector may be connected to one or more CRTCs, or may be clonable by
728  * another connector if they can share a CRTC.  Each connector also has a specific
729  * position in the broader display (referred to as a 'screen' though it could
730  * span multiple monitors).
731  */
732 struct drm_connector {
733         struct drm_device *dev;
734         struct device *kdev;
735         struct device_attribute *attr;
736         struct list_head head;
737
738         struct drm_mode_object base;
739
740         char *name;
741
742         /**
743          * @mutex: Lock for general connector state, but currently only protects
744          * @registered. Most of the connector state is still protected by
745          * &drm_mode_config.mutex.
746          */
747         struct mutex mutex;
748
749         /**
750          * @index: Compacted connector index, which matches the position inside
751          * the mode_config.list for drivers not supporting hot-add/removing. Can
752          * be used as an array index. It is invariant over the lifetime of the
753          * connector.
754          */
755         unsigned index;
756
757         int connector_type;
758         int connector_type_id;
759         bool interlace_allowed;
760         bool doublescan_allowed;
761         bool stereo_allowed;
762
763         /**
764          * @ycbcr_420_allowed : This bool indicates if this connector is
765          * capable of handling YCBCR 420 output. While parsing the EDID
766          * blocks, its very helpful to know, if the source is capable of
767          * handling YCBCR 420 outputs.
768          */
769         bool ycbcr_420_allowed;
770
771         /**
772          * @registered: Is this connector exposed (registered) with userspace?
773          * Protected by @mutex.
774          */
775         bool registered;
776
777         /**
778          * @modes:
779          * Modes available on this connector (from fill_modes() + user).
780          * Protected by &drm_mode_config.mutex.
781          */
782         struct list_head modes;
783
784         /**
785          * @status:
786          * One of the drm_connector_status enums (connected, not, or unknown).
787          * Protected by &drm_mode_config.mutex.
788          */
789         enum drm_connector_status status;
790
791         /**
792          * @probed_modes:
793          * These are modes added by probing with DDC or the BIOS, before
794          * filtering is applied. Used by the probe helpers. Protected by
795          * &drm_mode_config.mutex.
796          */
797         struct list_head probed_modes;
798
799         /**
800          * @display_info: Display information is filled from EDID information
801          * when a display is detected. For non hot-pluggable displays such as
802          * flat panels in embedded systems, the driver should initialize the
803          * &drm_display_info.width_mm and &drm_display_info.height_mm fields
804          * with the physical size of the display.
805          *
806          * Protected by &drm_mode_config.mutex.
807          */
808         struct drm_display_info display_info;
809         const struct drm_connector_funcs *funcs;
810
811         struct drm_property_blob *edid_blob_ptr;
812         struct drm_object_properties properties;
813
814         struct drm_property *scaling_mode_property;
815
816         /**
817          * @path_blob_ptr:
818          *
819          * DRM blob property data for the DP MST path property.
820          */
821         struct drm_property_blob *path_blob_ptr;
822
823         /**
824          * @tile_blob_ptr:
825          *
826          * DRM blob property data for the tile property (used mostly by DP MST).
827          * This is meant for screens which are driven through separate display
828          * pipelines represented by &drm_crtc, which might not be running with
829          * genlocked clocks. For tiled panels which are genlocked, like
830          * dual-link LVDS or dual-link DSI, the driver should try to not expose
831          * the tiling and virtualize both &drm_crtc and &drm_plane if needed.
832          */
833         struct drm_property_blob *tile_blob_ptr;
834
835 /* should we poll this connector for connects and disconnects */
836 /* hot plug detectable */
837 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
838 /* poll for connections */
839 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
840 /* can cleanly poll for disconnections without flickering the screen */
841 /* DACs should rarely do this without a lot of testing */
842 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
843
844         /**
845          * @polled:
846          *
847          * Connector polling mode, a combination of
848          *
849          * DRM_CONNECTOR_POLL_HPD
850          *     The connector generates hotplug events and doesn't need to be
851          *     periodically polled. The CONNECT and DISCONNECT flags must not
852          *     be set together with the HPD flag.
853          *
854          * DRM_CONNECTOR_POLL_CONNECT
855          *     Periodically poll the connector for connection.
856          *
857          * DRM_CONNECTOR_POLL_DISCONNECT
858          *     Periodically poll the connector for disconnection.
859          *
860          * Set to 0 for connectors that don't support connection status
861          * discovery.
862          */
863         uint8_t polled;
864
865         /* requested DPMS state */
866         int dpms;
867
868         const struct drm_connector_helper_funcs *helper_private;
869
870         /* forced on connector */
871         struct drm_cmdline_mode cmdline_mode;
872         enum drm_connector_force force;
873         bool override_edid;
874
875 #define DRM_CONNECTOR_MAX_ENCODER 3
876         uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
877         struct drm_encoder *encoder; /* currently active encoder */
878
879 #define MAX_ELD_BYTES   128
880         /* EDID bits */
881         uint8_t eld[MAX_ELD_BYTES];
882         bool latency_present[2];
883         int video_latency[2];   /* [0]: progressive, [1]: interlaced */
884         int audio_latency[2];
885         int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
886         unsigned bad_edid_counter;
887
888         /* Flag for raw EDID header corruption - used in Displayport
889          * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
890          */
891         bool edid_corrupt;
892
893         struct dentry *debugfs_entry;
894
895         /**
896          * @state:
897          *
898          * Current atomic state for this connector.
899          *
900          * This is protected by @drm_mode_config.connection_mutex. Note that
901          * nonblocking atomic commits access the current connector state without
902          * taking locks. Either by going through the &struct drm_atomic_state
903          * pointers, see for_each_oldnew_connector_in_state(),
904          * for_each_old_connector_in_state() and
905          * for_each_new_connector_in_state(). Or through careful ordering of
906          * atomic commit operations as implemented in the atomic helpers, see
907          * &struct drm_crtc_commit.
908          */
909         struct drm_connector_state *state;
910
911         /* DisplayID bits */
912         bool has_tile;
913         struct drm_tile_group *tile_group;
914         bool tile_is_single_monitor;
915
916         uint8_t num_h_tile, num_v_tile;
917         uint8_t tile_h_loc, tile_v_loc;
918         uint16_t tile_h_size, tile_v_size;
919
920         /**
921          * @free_work:
922          *
923          * Work used only by &drm_connector_iter to be able to clean up a
924          * connector from any context.
925          */
926         struct work_struct free_work;
927 };
928
929 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
930
931 int drm_connector_init(struct drm_device *dev,
932                        struct drm_connector *connector,
933                        const struct drm_connector_funcs *funcs,
934                        int connector_type);
935 int drm_connector_register(struct drm_connector *connector);
936 void drm_connector_unregister(struct drm_connector *connector);
937 int drm_mode_connector_attach_encoder(struct drm_connector *connector,
938                                       struct drm_encoder *encoder);
939
940 void drm_connector_cleanup(struct drm_connector *connector);
941 static inline unsigned drm_connector_index(struct drm_connector *connector)
942 {
943         return connector->index;
944 }
945
946 /**
947  * drm_connector_lookup - lookup connector object
948  * @dev: DRM device
949  * @file_priv: drm file to check for lease against.
950  * @id: connector object id
951  *
952  * This function looks up the connector object specified by id
953  * add takes a reference to it.
954  */
955 static inline struct drm_connector *drm_connector_lookup(struct drm_device *dev,
956                 struct drm_file *file_priv,
957                 uint32_t id)
958 {
959         struct drm_mode_object *mo;
960         mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CONNECTOR);
961         return mo ? obj_to_connector(mo) : NULL;
962 }
963
964 /**
965  * drm_connector_get - acquire a connector reference
966  * @connector: DRM connector
967  *
968  * This function increments the connector's refcount.
969  */
970 static inline void drm_connector_get(struct drm_connector *connector)
971 {
972         drm_mode_object_get(&connector->base);
973 }
974
975 /**
976  * drm_connector_put - release a connector reference
977  * @connector: DRM connector
978  *
979  * This function decrements the connector's reference count and frees the
980  * object if the reference count drops to zero.
981  */
982 static inline void drm_connector_put(struct drm_connector *connector)
983 {
984         drm_mode_object_put(&connector->base);
985 }
986
987 /**
988  * drm_connector_reference - acquire a connector reference
989  * @connector: DRM connector
990  *
991  * This is a compatibility alias for drm_connector_get() and should not be
992  * used by new code.
993  */
994 static inline void drm_connector_reference(struct drm_connector *connector)
995 {
996         drm_connector_get(connector);
997 }
998
999 /**
1000  * drm_connector_unreference - release a connector reference
1001  * @connector: DRM connector
1002  *
1003  * This is a compatibility alias for drm_connector_put() and should not be
1004  * used by new code.
1005  */
1006 static inline void drm_connector_unreference(struct drm_connector *connector)
1007 {
1008         drm_connector_put(connector);
1009 }
1010
1011 const char *drm_get_connector_status_name(enum drm_connector_status status);
1012 const char *drm_get_subpixel_order_name(enum subpixel_order order);
1013 const char *drm_get_dpms_name(int val);
1014 const char *drm_get_dvi_i_subconnector_name(int val);
1015 const char *drm_get_dvi_i_select_name(int val);
1016 const char *drm_get_tv_subconnector_name(int val);
1017 const char *drm_get_tv_select_name(int val);
1018
1019 int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1020 int drm_mode_create_tv_properties(struct drm_device *dev,
1021                                   unsigned int num_modes,
1022                                   const char * const modes[]);
1023 int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1024 int drm_connector_attach_scaling_mode_property(struct drm_connector *connector,
1025                                                u32 scaling_mode_mask);
1026 int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1027 int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1028
1029 int drm_mode_connector_set_path_property(struct drm_connector *connector,
1030                                          const char *path);
1031 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1032 int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1033                                             const struct edid *edid);
1034 void drm_mode_connector_set_link_status_property(struct drm_connector *connector,
1035                                                  uint64_t link_status);
1036
1037 /**
1038  * struct drm_tile_group - Tile group metadata
1039  * @refcount: reference count
1040  * @dev: DRM device
1041  * @id: tile group id exposed to userspace
1042  * @group_data: Sink-private data identifying this group
1043  *
1044  * @group_data corresponds to displayid vend/prod/serial for external screens
1045  * with an EDID.
1046  */
1047 struct drm_tile_group {
1048         struct kref refcount;
1049         struct drm_device *dev;
1050         int id;
1051         u8 group_data[8];
1052 };
1053
1054 struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1055                                                   char topology[8]);
1056 struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1057                                                char topology[8]);
1058 void drm_mode_put_tile_group(struct drm_device *dev,
1059                              struct drm_tile_group *tg);
1060
1061 /**
1062  * struct drm_connector_list_iter - connector_list iterator
1063  *
1064  * This iterator tracks state needed to be able to walk the connector_list
1065  * within struct drm_mode_config. Only use together with
1066  * drm_connector_list_iter_begin(), drm_connector_list_iter_end() and
1067  * drm_connector_list_iter_next() respectively the convenience macro
1068  * drm_for_each_connector_iter().
1069  */
1070 struct drm_connector_list_iter {
1071 /* private: */
1072         struct drm_device *dev;
1073         struct drm_connector *conn;
1074 };
1075
1076 void drm_connector_list_iter_begin(struct drm_device *dev,
1077                                    struct drm_connector_list_iter *iter);
1078 struct drm_connector *
1079 drm_connector_list_iter_next(struct drm_connector_list_iter *iter);
1080 void drm_connector_list_iter_end(struct drm_connector_list_iter *iter);
1081
1082 /**
1083  * drm_for_each_connector_iter - connector_list iterator macro
1084  * @connector: &struct drm_connector pointer used as cursor
1085  * @iter: &struct drm_connector_list_iter
1086  *
1087  * Note that @connector is only valid within the list body, if you want to use
1088  * @connector after calling drm_connector_list_iter_end() then you need to grab
1089  * your own reference first using drm_connector_get().
1090  */
1091 #define drm_for_each_connector_iter(connector, iter) \
1092         while ((connector = drm_connector_list_iter_next(iter)))
1093
1094 #endif