xref: /dragonfly/sys/dev/drm/include/drm/drm_crtc.h (revision 38b720cd)
1 /*
2  * Copyright © 2006 Keith Packard
3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
5  *   Jesse Barnes <jesse.barnes@intel.com>
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the "Software"),
9  * to deal in the Software without restriction, including without limitation
10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11  * and/or sell copies of the Software, and to permit persons to whom the
12  * Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23  * OTHER DEALINGS IN THE SOFTWARE.
24  */
25 #ifndef __DRM_CRTC_H__
26 #define __DRM_CRTC_H__
27 
28 #include <linux/i2c.h>
29 #include <linux/spinlock.h>
30 #include <linux/types.h>
31 #include <linux/idr.h>
32 #include <linux/fb.h>
33 #include <linux/hdmi.h>
34 #include <uapi_drm/drm_mode.h>
35 #include <uapi_drm/drm_fourcc.h>
36 #include <drm/drm_modeset_lock.h>
37 
38 struct drm_device;
39 struct drm_mode_set;
40 struct drm_framebuffer;
41 struct drm_object_properties;
42 struct drm_file;
43 struct drm_clip_rect;
44 struct device_node;
45 struct fence;
46 
47 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
48 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
49 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
50 #define DRM_MODE_OBJECT_MODE 0xdededede
51 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
52 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
53 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
54 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
55 #define DRM_MODE_OBJECT_ANY 0
56 
57 struct drm_mode_object {
58 	uint32_t id;
59 	uint32_t type;
60 	struct drm_object_properties *properties;
61 };
62 
63 #define DRM_OBJECT_MAX_PROPERTY 24
64 struct drm_object_properties {
65 	int count, atomic_count;
66 	/* NOTE: if we ever start dynamically destroying properties (ie.
67 	 * not at drm_mode_config_cleanup() time), then we'd have to do
68 	 * a better job of detaching property from mode objects to avoid
69 	 * dangling property pointers:
70 	 */
71 	struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
72 	/* do not read/write values directly, but use drm_object_property_get_value()
73 	 * and drm_object_property_set_value():
74 	 */
75 	uint64_t values[DRM_OBJECT_MAX_PROPERTY];
76 };
77 
78 static inline int64_t U642I64(uint64_t val)
79 {
80 	return (int64_t)*((int64_t *)&val);
81 }
82 static inline uint64_t I642U64(int64_t val)
83 {
84 	return (uint64_t)*((uint64_t *)&val);
85 }
86 
87 /* rotation property bits */
88 #define DRM_ROTATE_MASK 0x0f
89 #define DRM_ROTATE_0	0
90 #define DRM_ROTATE_90	1
91 #define DRM_ROTATE_180	2
92 #define DRM_ROTATE_270	3
93 #define DRM_REFLECT_MASK (~DRM_ROTATE_MASK)
94 #define DRM_REFLECT_X	4
95 #define DRM_REFLECT_Y	5
96 
97 enum drm_connector_force {
98 	DRM_FORCE_UNSPECIFIED,
99 	DRM_FORCE_OFF,
100 	DRM_FORCE_ON,         /* force on analog part normally */
101 	DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
102 };
103 
104 #include <drm/drm_modes.h>
105 
106 enum drm_connector_status {
107 	connector_status_connected = 1,
108 	connector_status_disconnected = 2,
109 	connector_status_unknown = 3,
110 };
111 
112 enum subpixel_order {
113 	SubPixelUnknown = 0,
114 	SubPixelHorizontalRGB,
115 	SubPixelHorizontalBGR,
116 	SubPixelVerticalRGB,
117 	SubPixelVerticalBGR,
118 	SubPixelNone,
119 };
120 
121 #define DRM_COLOR_FORMAT_RGB444		(1<<0)
122 #define DRM_COLOR_FORMAT_YCRCB444	(1<<1)
123 #define DRM_COLOR_FORMAT_YCRCB422	(1<<2)
124 /*
125  * Describes a given display (e.g. CRT or flat panel) and its limitations.
126  */
127 struct drm_display_info {
128 	char name[DRM_DISPLAY_INFO_LEN];
129 
130 	/* Physical size */
131         unsigned int width_mm;
132 	unsigned int height_mm;
133 
134 	/* Clock limits FIXME: storage format */
135 	unsigned int min_vfreq, max_vfreq;
136 	unsigned int min_hfreq, max_hfreq;
137 	unsigned int pixel_clock;
138 	unsigned int bpc;
139 
140 	enum subpixel_order subpixel_order;
141 	u32 color_formats;
142 
143 	u32 *bus_formats;
144 	unsigned int num_bus_formats;
145 
146 	/* Mask of supported hdmi deep color modes */
147 	u8 edid_hdmi_dc_modes;
148 
149 	u8 cea_rev;
150 };
151 
152 /* data corresponds to displayid vend/prod/serial */
153 struct drm_tile_group {
154 	struct kref refcount;
155 	struct drm_device *dev;
156 	int id;
157 	u8 group_data[8];
158 };
159 
160 struct drm_framebuffer_funcs {
161 	/* note: use drm_framebuffer_remove() */
162 	void (*destroy)(struct drm_framebuffer *framebuffer);
163 	int (*create_handle)(struct drm_framebuffer *fb,
164 			     struct drm_file *file_priv,
165 			     unsigned int *handle);
166 	/*
167 	 * Optional callback for the dirty fb ioctl.
168 	 *
169 	 * Userspace can notify the driver via this callback
170 	 * that a area of the framebuffer has changed and should
171 	 * be flushed to the display hardware.
172 	 *
173 	 * See documentation in drm_mode.h for the struct
174 	 * drm_mode_fb_dirty_cmd for more information as all
175 	 * the semantics and arguments have a one to one mapping
176 	 * on this function.
177 	 */
178 	int (*dirty)(struct drm_framebuffer *framebuffer,
179 		     struct drm_file *file_priv, unsigned flags,
180 		     unsigned color, struct drm_clip_rect *clips,
181 		     unsigned num_clips);
182 };
183 
184 struct drm_framebuffer {
185 	struct drm_device *dev;
186 	/*
187 	 * Note that the fb is refcounted for the benefit of driver internals,
188 	 * for example some hw, disabling a CRTC/plane is asynchronous, and
189 	 * scanout does not actually complete until the next vblank.  So some
190 	 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
191 	 * should be deferred.  In cases like this, the driver would like to
192 	 * hold a ref to the fb even though it has already been removed from
193 	 * userspace perspective.
194 	 */
195 	struct kref refcount;
196 	/*
197 	 * Place on the dev->mode_config.fb_list, access protected by
198 	 * dev->mode_config.fb_lock.
199 	 */
200 	struct list_head head;
201 	struct drm_mode_object base;
202 	const struct drm_framebuffer_funcs *funcs;
203 	unsigned int pitches[4];
204 	unsigned int offsets[4];
205 	uint64_t modifier[4];
206 	unsigned int width;
207 	unsigned int height;
208 	/* depth can be 15 or 16 */
209 	unsigned int depth;
210 	int bits_per_pixel;
211 	int flags;
212 	uint32_t pixel_format; /* fourcc format */
213 	struct list_head filp_head;
214 };
215 
216 struct drm_property_blob {
217 	struct drm_mode_object base;
218 	struct drm_device *dev;
219 	struct kref refcount;
220 	struct list_head head_global;
221 	struct list_head head_file;
222 	size_t length;
223 	unsigned char data[];
224 };
225 
226 struct drm_property_enum {
227 	uint64_t value;
228 	struct list_head head;
229 	char name[DRM_PROP_NAME_LEN];
230 };
231 
232 struct drm_property {
233 	struct list_head head;
234 	struct drm_mode_object base;
235 	uint32_t flags;
236 	char name[DRM_PROP_NAME_LEN];
237 	uint32_t num_values;
238 	uint64_t *values;
239 	struct drm_device *dev;
240 
241 	struct list_head enum_list;
242 };
243 
244 struct drm_crtc;
245 struct drm_connector;
246 struct drm_encoder;
247 struct drm_pending_vblank_event;
248 struct drm_plane;
249 struct drm_bridge;
250 struct drm_atomic_state;
251 
252 /**
253  * struct drm_crtc_state - mutable CRTC state
254  * @crtc: backpointer to the CRTC
255  * @enable: whether the CRTC should be enabled, gates all other state
256  * @active: whether the CRTC is actively displaying (used for DPMS)
257  * @planes_changed: planes on this crtc are updated
258  * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
259  * @active_changed: crtc_state->active has been toggled.
260  * @connectors_changed: connectors to this crtc have been updated
261  * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
262  * @last_vblank_count: for helpers and drivers to capture the vblank of the
263  * 	update to ensure framebuffer cleanup isn't done too early
264  * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
265  * @mode: current mode timings
266  * @event: optional pointer to a DRM event to signal upon completion of the
267  * 	state update
268  * @state: backpointer to global drm_atomic_state
269  *
270  * Note that the distinction between @enable and @active is rather subtile:
271  * Flipping @active while @enable is set without changing anything else may
272  * never return in a failure from the ->atomic_check callback. Userspace assumes
273  * that a DPMS On will always succeed. In other words: @enable controls resource
274  * assignment, @active controls the actual hardware state.
275  */
276 struct drm_crtc_state {
277 	struct drm_crtc *crtc;
278 
279 	bool enable;
280 	bool active;
281 
282 	/* computed state bits used by helpers and drivers */
283 	bool planes_changed : 1;
284 	bool mode_changed : 1;
285 	bool active_changed : 1;
286 	bool connectors_changed : 1;
287 
288 	/* attached planes bitmask:
289 	 * WARNING: transitional helpers do not maintain plane_mask so
290 	 * drivers not converted over to atomic helpers should not rely
291 	 * on plane_mask being accurate!
292 	 */
293 	u32 plane_mask;
294 
295 	/* last_vblank_count: for vblank waits before cleanup */
296 	u32 last_vblank_count;
297 
298 	/* adjusted_mode: for use by helpers and drivers */
299 	struct drm_display_mode adjusted_mode;
300 
301 	struct drm_display_mode mode;
302 
303 	/* blob property to expose current mode to atomic userspace */
304 	struct drm_property_blob *mode_blob;
305 
306 	struct drm_pending_vblank_event *event;
307 
308 	struct drm_atomic_state *state;
309 };
310 
311 /**
312  * struct drm_crtc_funcs - control CRTCs for a given device
313  * @save: save CRTC state
314  * @restore: restore CRTC state
315  * @reset: reset CRTC after state has been invalidated (e.g. resume)
316  * @cursor_set: setup the cursor
317  * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
318  * @cursor_move: move the cursor
319  * @gamma_set: specify color ramp for CRTC
320  * @destroy: deinit and free object
321  * @set_property: called when a property is changed
322  * @set_config: apply a new CRTC configuration
323  * @page_flip: initiate a page flip
324  * @atomic_duplicate_state: duplicate the atomic state for this CRTC
325  * @atomic_destroy_state: destroy an atomic state for this CRTC
326  * @atomic_set_property: set a property on an atomic state for this CRTC
327  *    (do not call directly, use drm_atomic_crtc_set_property())
328  * @atomic_get_property: get a property on an atomic state for this CRTC
329  *    (do not call directly, use drm_atomic_crtc_get_property())
330  *
331  * The drm_crtc_funcs structure is the central CRTC management structure
332  * in the DRM.  Each CRTC controls one or more connectors (note that the name
333  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
334  * connectors, not just CRTs).
335  *
336  * Each driver is responsible for filling out this structure at startup time,
337  * in addition to providing other modesetting features, like i2c and DDC
338  * bus accessors.
339  */
340 struct drm_crtc_funcs {
341 	/* Save CRTC state */
342 	void (*save)(struct drm_crtc *crtc); /* suspend? */
343 	/* Restore CRTC state */
344 	void (*restore)(struct drm_crtc *crtc); /* resume? */
345 	/* Reset CRTC state */
346 	void (*reset)(struct drm_crtc *crtc);
347 
348 	/* cursor controls */
349 	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
350 			  uint32_t handle, uint32_t width, uint32_t height);
351 	int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
352 			   uint32_t handle, uint32_t width, uint32_t height,
353 			   int32_t hot_x, int32_t hot_y);
354 	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
355 
356 	/* Set gamma on the CRTC */
357 	void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
358 			  uint32_t start, uint32_t size);
359 	/* Object destroy routine */
360 	void (*destroy)(struct drm_crtc *crtc);
361 
362 	int (*set_config)(struct drm_mode_set *set);
363 
364 	/*
365 	 * Flip to the given framebuffer.  This implements the page
366 	 * flip ioctl described in drm_mode.h, specifically, the
367 	 * implementation must return immediately and block all
368 	 * rendering to the current fb until the flip has completed.
369 	 * If userspace set the event flag in the ioctl, the event
370 	 * argument will point to an event to send back when the flip
371 	 * completes, otherwise it will be NULL.
372 	 */
373 	int (*page_flip)(struct drm_crtc *crtc,
374 			 struct drm_framebuffer *fb,
375 			 struct drm_pending_vblank_event *event,
376 			 uint32_t flags);
377 
378 	int (*set_property)(struct drm_crtc *crtc,
379 			    struct drm_property *property, uint64_t val);
380 
381 	/* atomic update handling */
382 	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
383 	void (*atomic_destroy_state)(struct drm_crtc *crtc,
384 				     struct drm_crtc_state *state);
385 	int (*atomic_set_property)(struct drm_crtc *crtc,
386 				   struct drm_crtc_state *state,
387 				   struct drm_property *property,
388 				   uint64_t val);
389 	int (*atomic_get_property)(struct drm_crtc *crtc,
390 				   const struct drm_crtc_state *state,
391 				   struct drm_property *property,
392 				   uint64_t *val);
393 };
394 
395 /**
396  * struct drm_crtc - central CRTC control structure
397  * @dev: parent DRM device
398  * @port: OF node used by drm_of_find_possible_crtcs()
399  * @head: list management
400  * @mutex: per-CRTC locking
401  * @base: base KMS object for ID tracking etc.
402  * @primary: primary plane for this CRTC
403  * @cursor: cursor plane for this CRTC
404  * @cursor_x: current x position of the cursor, used for universal cursor planes
405  * @cursor_y: current y position of the cursor, used for universal cursor planes
406  * @enabled: is this CRTC enabled?
407  * @mode: current mode timings
408  * @hwmode: mode timings as programmed to hw regs
409  * @x: x position on screen
410  * @y: y position on screen
411  * @funcs: CRTC control functions
412  * @gamma_size: size of gamma ramp
413  * @gamma_store: gamma ramp values
414  * @helper_private: mid-layer private data
415  * @properties: property tracking for this CRTC
416  * @state: current atomic state for this CRTC
417  * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
418  * 	legacy ioctls
419  *
420  * Each CRTC may have one or more connectors associated with it.  This structure
421  * allows the CRTC to be controlled.
422  */
423 struct drm_crtc {
424 	struct drm_device *dev;
425 	struct device_node *port;
426 	struct list_head head;
427 
428 	/*
429 	 * crtc mutex
430 	 *
431 	 * This provides a read lock for the overall crtc state (mode, dpms
432 	 * state, ...) and a write lock for everything which can be update
433 	 * without a full modeset (fb, cursor data, ...)
434 	 */
435 	struct drm_modeset_lock mutex;
436 
437 	struct drm_mode_object base;
438 
439 	/* primary and cursor planes for CRTC */
440 	struct drm_plane *primary;
441 	struct drm_plane *cursor;
442 
443 	/* position of cursor plane on crtc */
444 	int cursor_x;
445 	int cursor_y;
446 
447 	bool enabled;
448 
449 	/* Requested mode from modesetting. */
450 	struct drm_display_mode mode;
451 
452 	/* Programmed mode in hw, after adjustments for encoders,
453 	 * crtc, panel scaling etc. Needed for timestamping etc.
454 	 */
455 	struct drm_display_mode hwmode;
456 
457 	int x, y;
458 	const struct drm_crtc_funcs *funcs;
459 
460 	/* CRTC gamma size for reporting to userspace */
461 	uint32_t gamma_size;
462 	uint16_t *gamma_store;
463 
464 	/* if you are using the helper */
465 	const void *helper_private;
466 
467 	struct drm_object_properties properties;
468 
469 	struct drm_crtc_state *state;
470 
471 	/*
472 	 * For legacy crtc ioctls so that atomic drivers can get at the locking
473 	 * acquire context.
474 	 */
475 	struct drm_modeset_acquire_ctx *acquire_ctx;
476 };
477 
478 /**
479  * struct drm_connector_state - mutable connector state
480  * @connector: backpointer to the connector
481  * @crtc: CRTC to connect connector to, NULL if disabled
482  * @best_encoder: can be used by helpers and drivers to select the encoder
483  * @state: backpointer to global drm_atomic_state
484  */
485 struct drm_connector_state {
486 	struct drm_connector *connector;
487 
488 	struct drm_crtc *crtc;  /* do not write directly, use drm_atomic_set_crtc_for_connector() */
489 
490 	struct drm_encoder *best_encoder;
491 
492 	struct drm_atomic_state *state;
493 };
494 
495 /**
496  * struct drm_connector_funcs - control connectors on a given device
497  * @dpms: set power state
498  * @save: save connector state
499  * @restore: restore connector state
500  * @reset: reset connector after state has been invalidated (e.g. resume)
501  * @detect: is this connector active?
502  * @fill_modes: fill mode list for this connector
503  * @set_property: property for this connector may need an update
504  * @destroy: make object go away
505  * @force: notify the driver that the connector is forced on
506  * @atomic_duplicate_state: duplicate the atomic state for this connector
507  * @atomic_destroy_state: destroy an atomic state for this connector
508  * @atomic_set_property: set a property on an atomic state for this connector
509  *    (do not call directly, use drm_atomic_connector_set_property())
510  * @atomic_get_property: get a property on an atomic state for this connector
511  *    (do not call directly, use drm_atomic_connector_get_property())
512  *
513  * Each CRTC may have one or more connectors attached to it.  The functions
514  * below allow the core DRM code to control connectors, enumerate available modes,
515  * etc.
516  */
517 struct drm_connector_funcs {
518 	int (*dpms)(struct drm_connector *connector, int mode);
519 	void (*save)(struct drm_connector *connector);
520 	void (*restore)(struct drm_connector *connector);
521 	void (*reset)(struct drm_connector *connector);
522 
523 	/* Check to see if anything is attached to the connector.
524 	 * @force is set to false whilst polling, true when checking the
525 	 * connector due to user request. @force can be used by the driver
526 	 * to avoid expensive, destructive operations during automated
527 	 * probing.
528 	 */
529 	enum drm_connector_status (*detect)(struct drm_connector *connector,
530 					    bool force);
531 	int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
532 	int (*set_property)(struct drm_connector *connector, struct drm_property *property,
533 			     uint64_t val);
534 	void (*destroy)(struct drm_connector *connector);
535 	void (*force)(struct drm_connector *connector);
536 
537 	/* atomic update handling */
538 	struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
539 	void (*atomic_destroy_state)(struct drm_connector *connector,
540 				     struct drm_connector_state *state);
541 	int (*atomic_set_property)(struct drm_connector *connector,
542 				   struct drm_connector_state *state,
543 				   struct drm_property *property,
544 				   uint64_t val);
545 	int (*atomic_get_property)(struct drm_connector *connector,
546 				   const struct drm_connector_state *state,
547 				   struct drm_property *property,
548 				   uint64_t *val);
549 };
550 
551 /**
552  * struct drm_encoder_funcs - encoder controls
553  * @reset: reset state (e.g. at init or resume time)
554  * @destroy: cleanup and free associated data
555  *
556  * Encoders sit between CRTCs and connectors.
557  */
558 struct drm_encoder_funcs {
559 	void (*reset)(struct drm_encoder *encoder);
560 	void (*destroy)(struct drm_encoder *encoder);
561 };
562 
563 #define DRM_CONNECTOR_MAX_ENCODER 3
564 
565 /**
566  * struct drm_encoder - central DRM encoder structure
567  * @dev: parent DRM device
568  * @head: list management
569  * @base: base KMS object
570  * @name: encoder name
571  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
572  * @possible_crtcs: bitmask of potential CRTC bindings
573  * @possible_clones: bitmask of potential sibling encoders for cloning
574  * @crtc: currently bound CRTC
575  * @bridge: bridge associated to the encoder
576  * @funcs: control functions
577  * @helper_private: mid-layer private data
578  *
579  * CRTCs drive pixels to encoders, which convert them into signals
580  * appropriate for a given connector or set of connectors.
581  */
582 struct drm_encoder {
583 	struct drm_device *dev;
584 	struct list_head head;
585 
586 	struct drm_mode_object base;
587 	char *name;
588 	int encoder_type;
589 	uint32_t possible_crtcs;
590 	uint32_t possible_clones;
591 
592 	struct drm_crtc *crtc;
593 	struct drm_bridge *bridge;
594 	const struct drm_encoder_funcs *funcs;
595 	void *helper_private;
596 };
597 
598 /* should we poll this connector for connects and disconnects */
599 /* hot plug detectable */
600 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
601 /* poll for connections */
602 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
603 /* can cleanly poll for disconnections without flickering the screen */
604 /* DACs should rarely do this without a lot of testing */
605 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
606 
607 #define MAX_ELD_BYTES	128
608 
609 /**
610  * struct drm_connector - central DRM connector control structure
611  * @dev: parent DRM device
612  * @kdev: kernel device for sysfs attributes
613  * @attr: sysfs attributes
614  * @head: list management
615  * @base: base KMS object
616  * @name: connector name
617  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
618  * @connector_type_id: index into connector type enum
619  * @interlace_allowed: can this connector handle interlaced modes?
620  * @doublescan_allowed: can this connector handle doublescan?
621  * @stereo_allowed: can this connector handle stereo modes?
622  * @modes: modes available on this connector (from fill_modes() + user)
623  * @status: one of the drm_connector_status enums (connected, not, or unknown)
624  * @probed_modes: list of modes derived directly from the display
625  * @display_info: information about attached display (e.g. from EDID)
626  * @funcs: connector control functions
627  * @edid_blob_ptr: DRM property containing EDID if present
628  * @properties: property tracking for this connector
629  * @path_blob_ptr: DRM blob property data for the DP MST path property
630  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
631  * @dpms: current dpms state
632  * @helper_private: mid-layer private data
633  * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
634  * @force: a %DRM_FORCE_<foo> state for forced mode sets
635  * @override_edid: has the EDID been overwritten through debugfs for testing?
636  * @encoder_ids: valid encoders for this connector
637  * @encoder: encoder driving this connector, if any
638  * @eld: EDID-like data, if present
639  * @dvi_dual: dual link DVI, if found
640  * @max_tmds_clock: max clock rate, if found
641  * @latency_present: AV delay info from ELD, if found
642  * @video_latency: video latency info from ELD, if found
643  * @audio_latency: audio latency info from ELD, if found
644  * @null_edid_counter: track sinks that give us all zeros for the EDID
645  * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
646  * @edid_corrupt: indicates whether the last read EDID was corrupt
647  * @debugfs_entry: debugfs directory for this connector
648  * @state: current atomic state for this connector
649  * @has_tile: is this connector connected to a tiled monitor
650  * @tile_group: tile group for the connected monitor
651  * @tile_is_single_monitor: whether the tile is one monitor housing
652  * @num_h_tile: number of horizontal tiles in the tile group
653  * @num_v_tile: number of vertical tiles in the tile group
654  * @tile_h_loc: horizontal location of this tile
655  * @tile_v_loc: vertical location of this tile
656  * @tile_h_size: horizontal size of this tile.
657  * @tile_v_size: vertical size of this tile.
658  *
659  * Each connector may be connected to one or more CRTCs, or may be clonable by
660  * another connector if they can share a CRTC.  Each connector also has a specific
661  * position in the broader display (referred to as a 'screen' though it could
662  * span multiple monitors).
663  */
664 struct drm_connector {
665 	struct drm_device *dev;
666 	struct device *kdev;
667 	struct device_attribute *attr;
668 	struct list_head head;
669 
670 	struct drm_mode_object base;
671 
672 	char *name;
673 	int connector_type;
674 	int connector_type_id;
675 	bool interlace_allowed;
676 	bool doublescan_allowed;
677 	bool stereo_allowed;
678 	struct list_head modes; /* list of modes on this connector */
679 
680 	enum drm_connector_status status;
681 
682 	/* these are modes added by probing with DDC or the BIOS */
683 	struct list_head probed_modes;
684 
685 	struct drm_display_info display_info;
686 	const struct drm_connector_funcs *funcs;
687 
688 	struct drm_property_blob *edid_blob_ptr;
689 	struct drm_object_properties properties;
690 
691 	struct drm_property_blob *path_blob_ptr;
692 
693 	struct drm_property_blob *tile_blob_ptr;
694 
695 	uint8_t polled; /* DRM_CONNECTOR_POLL_* */
696 
697 	/* requested DPMS state */
698 	int dpms;
699 
700 	void *helper_private;
701 
702 	/* forced on connector */
703 	struct drm_cmdline_mode cmdline_mode;
704 	enum drm_connector_force force;
705 	bool override_edid;
706 	uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
707 	struct drm_encoder *encoder; /* currently active encoder */
708 
709 	/* EDID bits */
710 	uint8_t eld[MAX_ELD_BYTES];
711 	bool dvi_dual;
712 	int max_tmds_clock;	/* in MHz */
713 	bool latency_present[2];
714 	int video_latency[2];	/* [0]: progressive, [1]: interlaced */
715 	int audio_latency[2];
716 	int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
717 	unsigned bad_edid_counter;
718 
719 	/* Flag for raw EDID header corruption - used in Displayport
720 	 * compliance testing - * Displayport Link CTS Core 1.2 rev1.1 4.2.2.6
721 	 */
722 	bool edid_corrupt;
723 
724 	struct dentry *debugfs_entry;
725 
726 	struct drm_connector_state *state;
727 
728 	/* DisplayID bits */
729 	bool has_tile;
730 	struct drm_tile_group *tile_group;
731 	bool tile_is_single_monitor;
732 
733 	uint8_t num_h_tile, num_v_tile;
734 	uint8_t tile_h_loc, tile_v_loc;
735 	uint16_t tile_h_size, tile_v_size;
736 };
737 
738 /**
739  * struct drm_plane_state - mutable plane state
740  * @plane: backpointer to the plane
741  * @crtc: currently bound CRTC, NULL if disabled
742  * @fb: currently bound framebuffer
743  * @fence: optional fence to wait for before scanning out @fb
744  * @crtc_x: left position of visible portion of plane on crtc
745  * @crtc_y: upper position of visible portion of plane on crtc
746  * @crtc_w: width of visible portion of plane on crtc
747  * @crtc_h: height of visible portion of plane on crtc
748  * @src_x: left position of visible portion of plane within
749  *	plane (in 16.16)
750  * @src_y: upper position of visible portion of plane within
751  *	plane (in 16.16)
752  * @src_w: width of visible portion of plane (in 16.16)
753  * @src_h: height of visible portion of plane (in 16.16)
754  * @state: backpointer to global drm_atomic_state
755  */
756 struct drm_plane_state {
757 	struct drm_plane *plane;
758 
759 	struct drm_crtc *crtc;   /* do not write directly, use drm_atomic_set_crtc_for_plane() */
760 	struct drm_framebuffer *fb;  /* do not write directly, use drm_atomic_set_fb_for_plane() */
761 	/* XXX: implement linux/fence.h first */
762 	/* struct fence *fence; */
763 
764 	/* Signed dest location allows it to be partially off screen */
765 	int32_t crtc_x, crtc_y;
766 	uint32_t crtc_w, crtc_h;
767 
768 	/* Source values are 16.16 fixed point */
769 	uint32_t src_x, src_y;
770 	uint32_t src_h, src_w;
771 
772 	/* Plane rotation */
773 	unsigned int rotation;
774 
775 	struct drm_atomic_state *state;
776 };
777 
778 
779 /**
780  * struct drm_plane_funcs - driver plane control functions
781  * @update_plane: update the plane configuration
782  * @disable_plane: shut down the plane
783  * @destroy: clean up plane resources
784  * @reset: reset plane after state has been invalidated (e.g. resume)
785  * @set_property: called when a property is changed
786  * @atomic_duplicate_state: duplicate the atomic state for this plane
787  * @atomic_destroy_state: destroy an atomic state for this plane
788  * @atomic_set_property: set a property on an atomic state for this plane
789  *    (do not call directly, use drm_atomic_plane_set_property())
790  * @atomic_get_property: get a property on an atomic state for this plane
791  *    (do not call directly, use drm_atomic_plane_get_property())
792  */
793 struct drm_plane_funcs {
794 	int (*update_plane)(struct drm_plane *plane,
795 			    struct drm_crtc *crtc, struct drm_framebuffer *fb,
796 			    int crtc_x, int crtc_y,
797 			    unsigned int crtc_w, unsigned int crtc_h,
798 			    uint32_t src_x, uint32_t src_y,
799 			    uint32_t src_w, uint32_t src_h);
800 	int (*disable_plane)(struct drm_plane *plane);
801 	void (*destroy)(struct drm_plane *plane);
802 	void (*reset)(struct drm_plane *plane);
803 
804 	int (*set_property)(struct drm_plane *plane,
805 			    struct drm_property *property, uint64_t val);
806 
807 	/* atomic update handling */
808 	struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
809 	void (*atomic_destroy_state)(struct drm_plane *plane,
810 				     struct drm_plane_state *state);
811 	int (*atomic_set_property)(struct drm_plane *plane,
812 				   struct drm_plane_state *state,
813 				   struct drm_property *property,
814 				   uint64_t val);
815 	int (*atomic_get_property)(struct drm_plane *plane,
816 				   const struct drm_plane_state *state,
817 				   struct drm_property *property,
818 				   uint64_t *val);
819 };
820 
821 enum drm_plane_type {
822 	DRM_PLANE_TYPE_OVERLAY,
823 	DRM_PLANE_TYPE_PRIMARY,
824 	DRM_PLANE_TYPE_CURSOR,
825 };
826 
827 /**
828  * struct drm_plane - central DRM plane control structure
829  * @dev: DRM device this plane belongs to
830  * @head: for list management
831  * @base: base mode object
832  * @possible_crtcs: pipes this plane can be bound to
833  * @format_types: array of formats supported by this plane
834  * @format_count: number of formats supported
835  * @format_default: driver hasn't supplied supported formats for the plane
836  * @crtc: currently bound CRTC
837  * @fb: currently bound fb
838  * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
839  * 	drm_mode_set_config_internal() to implement correct refcounting.
840  * @funcs: helper functions
841  * @properties: property tracking for this plane
842  * @type: type of plane (overlay, primary, cursor)
843  * @state: current atomic state for this plane
844  */
845 struct drm_plane {
846 	struct drm_device *dev;
847 	struct list_head head;
848 
849 	struct drm_modeset_lock mutex;
850 
851 	struct drm_mode_object base;
852 
853 	uint32_t possible_crtcs;
854 	uint32_t *format_types;
855 	unsigned int format_count;
856 	bool format_default;
857 
858 	struct drm_crtc *crtc;
859 	struct drm_framebuffer *fb;
860 
861 	struct drm_framebuffer *old_fb;
862 
863 	const struct drm_plane_funcs *funcs;
864 
865 	struct drm_object_properties properties;
866 
867 	enum drm_plane_type type;
868 
869 	const void *helper_private;
870 
871 	struct drm_plane_state *state;
872 };
873 
874 /**
875  * struct drm_bridge_funcs - drm_bridge control functions
876  * @attach: Called during drm_bridge_attach
877  * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
878  * @disable: Called right before encoder prepare, disables the bridge
879  * @post_disable: Called right after encoder prepare, for lockstepped disable
880  * @mode_set: Set this mode to the bridge
881  * @pre_enable: Called right before encoder commit, for lockstepped commit
882  * @enable: Called right after encoder commit, enables the bridge
883  */
884 struct drm_bridge_funcs {
885 	int (*attach)(struct drm_bridge *bridge);
886 	bool (*mode_fixup)(struct drm_bridge *bridge,
887 			   const struct drm_display_mode *mode,
888 			   struct drm_display_mode *adjusted_mode);
889 	void (*disable)(struct drm_bridge *bridge);
890 	void (*post_disable)(struct drm_bridge *bridge);
891 	void (*mode_set)(struct drm_bridge *bridge,
892 			 struct drm_display_mode *mode,
893 			 struct drm_display_mode *adjusted_mode);
894 	void (*pre_enable)(struct drm_bridge *bridge);
895 	void (*enable)(struct drm_bridge *bridge);
896 };
897 
898 /**
899  * struct drm_bridge - central DRM bridge control structure
900  * @dev: DRM device this bridge belongs to
901  * @encoder: encoder to which this bridge is connected
902  * @next: the next bridge in the encoder chain
903  * @of_node: device node pointer to the bridge
904  * @list: to keep track of all added bridges
905  * @funcs: control functions
906  * @driver_private: pointer to the bridge driver's internal context
907  */
908 struct drm_bridge {
909 	struct drm_device *dev;
910 	struct drm_encoder *encoder;
911 	struct drm_bridge *next;
912 #ifdef CONFIG_OF
913 	struct device_node *of_node;
914 #endif
915 	struct list_head list;
916 
917 	const struct drm_bridge_funcs *funcs;
918 	void *driver_private;
919 };
920 
921 /**
922  * struct drm_atomic_state - the global state object for atomic updates
923  * @dev: parent DRM device
924  * @allow_modeset: allow full modeset
925  * @legacy_cursor_update: hint to enforce legacy cursor ioctl semantics
926  * @planes: pointer to array of plane pointers
927  * @plane_states: pointer to array of plane states pointers
928  * @crtcs: pointer to array of CRTC pointers
929  * @crtc_states: pointer to array of CRTC states pointers
930  * @num_connector: size of the @connectors and @connector_states arrays
931  * @connectors: pointer to array of connector pointers
932  * @connector_states: pointer to array of connector states pointers
933  * @acquire_ctx: acquire context for this atomic modeset state update
934  */
935 struct drm_atomic_state {
936 	struct drm_device *dev;
937 	bool allow_modeset : 1;
938 	bool legacy_cursor_update : 1;
939 	struct drm_plane **planes;
940 	struct drm_plane_state **plane_states;
941 	struct drm_crtc **crtcs;
942 	struct drm_crtc_state **crtc_states;
943 	int num_connector;
944 	struct drm_connector **connectors;
945 	struct drm_connector_state **connector_states;
946 
947 	struct drm_modeset_acquire_ctx *acquire_ctx;
948 };
949 
950 
951 /**
952  * struct drm_mode_set - new values for a CRTC config change
953  * @fb: framebuffer to use for new config
954  * @crtc: CRTC whose configuration we're about to change
955  * @mode: mode timings to use
956  * @x: position of this CRTC relative to @fb
957  * @y: position of this CRTC relative to @fb
958  * @connectors: array of connectors to drive with this CRTC if possible
959  * @num_connectors: size of @connectors array
960  *
961  * Represents a single crtc the connectors that it drives with what mode
962  * and from which framebuffer it scans out from.
963  *
964  * This is used to set modes.
965  */
966 struct drm_mode_set {
967 	struct drm_framebuffer *fb;
968 	struct drm_crtc *crtc;
969 	struct drm_display_mode *mode;
970 
971 	uint32_t x;
972 	uint32_t y;
973 
974 	struct drm_connector **connectors;
975 	size_t num_connectors;
976 };
977 
978 /**
979  * struct drm_mode_config_funcs - basic driver provided mode setting functions
980  * @fb_create: create a new framebuffer object
981  * @output_poll_changed: function to handle output configuration changes
982  * @atomic_check: check whether a given atomic state update is possible
983  * @atomic_commit: commit an atomic state update previously verified with
984  * 	atomic_check()
985  * @atomic_state_alloc: allocate a new atomic state
986  * @atomic_state_clear: clear the atomic state
987  * @atomic_state_free: free the atomic state
988  *
989  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
990  * involve drivers.
991  */
992 struct drm_mode_config_funcs {
993 	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
994 					     struct drm_file *file_priv,
995 					     struct drm_mode_fb_cmd2 *mode_cmd);
996 	void (*output_poll_changed)(struct drm_device *dev);
997 
998 	int (*atomic_check)(struct drm_device *dev,
999 			    struct drm_atomic_state *a);
1000 	int (*atomic_commit)(struct drm_device *dev,
1001 			     struct drm_atomic_state *a,
1002 			     bool async);
1003 	struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1004 	void (*atomic_state_clear)(struct drm_atomic_state *state);
1005 	void (*atomic_state_free)(struct drm_atomic_state *state);
1006 };
1007 
1008 /**
1009  * struct drm_mode_config - Mode configuration control structure
1010  * @mutex: mutex protecting KMS related lists and structures
1011  * @connection_mutex: ww mutex protecting connector state and routing
1012  * @acquire_ctx: global implicit acquire context used by atomic drivers for
1013  * 	legacy ioctls
1014  * @idr_mutex: mutex for KMS ID allocation and management
1015  * @crtc_idr: main KMS ID tracking object
1016  * @fb_lock: mutex to protect fb state and lists
1017  * @num_fb: number of fbs available
1018  * @fb_list: list of framebuffers available
1019  * @num_connector: number of connectors on this device
1020  * @connector_list: list of connector objects
1021  * @num_encoder: number of encoders on this device
1022  * @encoder_list: list of encoder objects
1023  * @num_overlay_plane: number of overlay planes on this device
1024  * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
1025  * @plane_list: list of plane objects
1026  * @num_crtc: number of CRTCs on this device
1027  * @crtc_list: list of CRTC objects
1028  * @property_list: list of property objects
1029  * @min_width: minimum pixel width on this device
1030  * @min_height: minimum pixel height on this device
1031  * @max_width: maximum pixel width on this device
1032  * @max_height: maximum pixel height on this device
1033  * @funcs: core driver provided mode setting functions
1034  * @fb_base: base address of the framebuffer
1035  * @poll_enabled: track polling support for this device
1036  * @poll_running: track polling status for this device
1037  * @output_poll_work: delayed work for polling in process context
1038  * @property_blob_list: list of all the blob property objects
1039  * @blob_lock: mutex for blob property allocation and management
1040  * @*_property: core property tracking
1041  * @preferred_depth: preferred RBG pixel depth, used by fb helpers
1042  * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
1043  * @async_page_flip: does this device support async flips on the primary plane?
1044  * @cursor_width: hint to userspace for max cursor width
1045  * @cursor_height: hint to userspace for max cursor height
1046  *
1047  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
1048  * enumerated by the driver are added here, as are global properties.  Some
1049  * global restrictions are also here, e.g. dimension restrictions.
1050  */
1051 struct drm_mode_config {
1052 	struct lock mutex; /* protects configuration (mode lists etc.) */
1053 	struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
1054 	struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
1055 	struct lock idr_mutex; /* for IDR management */
1056 	struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1057 	struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
1058 	/* this is limited to one for now */
1059 
1060 	struct lock fb_lock; /* proctects global and per-file fb lists */
1061 	int num_fb;
1062 	struct list_head fb_list;
1063 
1064 	int num_connector;
1065 	struct list_head connector_list;
1066 	int num_encoder;
1067 	struct list_head encoder_list;
1068 
1069 	/*
1070 	 * Track # of overlay planes separately from # of total planes.  By
1071 	 * default we only advertise overlay planes to userspace; if userspace
1072 	 * sets the "universal plane" capability bit, we'll go ahead and
1073 	 * expose all planes.
1074 	 */
1075 	int num_overlay_plane;
1076 	int num_total_plane;
1077 	struct list_head plane_list;
1078 
1079 	int num_crtc;
1080 	struct list_head crtc_list;
1081 
1082 	struct list_head property_list;
1083 
1084 	int min_width, min_height;
1085 	int max_width, max_height;
1086 	const struct drm_mode_config_funcs *funcs;
1087 	resource_size_t fb_base;
1088 
1089 	/* output poll support */
1090 	bool poll_enabled;
1091 	bool poll_running;
1092 	bool delayed_event;
1093 	struct delayed_work output_poll_work;
1094 
1095 	struct lock blob_lock;
1096 
1097 	/* pointers to standard properties */
1098 	struct list_head property_blob_list;
1099 	struct drm_property *edid_property;
1100 	struct drm_property *dpms_property;
1101 	struct drm_property *path_property;
1102 	struct drm_property *tile_property;
1103 	struct drm_property *plane_type_property;
1104 	struct drm_property *rotation_property;
1105 	struct drm_property *prop_src_x;
1106 	struct drm_property *prop_src_y;
1107 	struct drm_property *prop_src_w;
1108 	struct drm_property *prop_src_h;
1109 	struct drm_property *prop_crtc_x;
1110 	struct drm_property *prop_crtc_y;
1111 	struct drm_property *prop_crtc_w;
1112 	struct drm_property *prop_crtc_h;
1113 	struct drm_property *prop_fb_id;
1114 	struct drm_property *prop_crtc_id;
1115 	struct drm_property *prop_active;
1116 	struct drm_property *prop_mode_id;
1117 
1118 	/* DVI-I properties */
1119 	struct drm_property *dvi_i_subconnector_property;
1120 	struct drm_property *dvi_i_select_subconnector_property;
1121 
1122 	/* TV properties */
1123 	struct drm_property *tv_subconnector_property;
1124 	struct drm_property *tv_select_subconnector_property;
1125 	struct drm_property *tv_mode_property;
1126 	struct drm_property *tv_left_margin_property;
1127 	struct drm_property *tv_right_margin_property;
1128 	struct drm_property *tv_top_margin_property;
1129 	struct drm_property *tv_bottom_margin_property;
1130 	struct drm_property *tv_brightness_property;
1131 	struct drm_property *tv_contrast_property;
1132 	struct drm_property *tv_flicker_reduction_property;
1133 	struct drm_property *tv_overscan_property;
1134 	struct drm_property *tv_saturation_property;
1135 	struct drm_property *tv_hue_property;
1136 
1137 	/* Optional properties */
1138 	struct drm_property *scaling_mode_property;
1139 	struct drm_property *aspect_ratio_property;
1140 	struct drm_property *dirty_info_property;
1141 
1142 	/* properties for virtual machine layout */
1143 	struct drm_property *suggested_x_property;
1144 	struct drm_property *suggested_y_property;
1145 
1146 	/* dumb ioctl parameters */
1147 	uint32_t preferred_depth, prefer_shadow;
1148 
1149 	/* whether async page flip is supported or not */
1150 	bool async_page_flip;
1151 
1152 	/* whether the driver supports fb modifiers */
1153 	bool allow_fb_modifiers;
1154 
1155 	/* cursor size */
1156 	uint32_t cursor_width, cursor_height;
1157 };
1158 
1159 /**
1160  * drm_for_each_plane_mask - iterate over planes specified by bitmask
1161  * @plane: the loop cursor
1162  * @dev: the DRM device
1163  * @plane_mask: bitmask of plane indices
1164  *
1165  * Iterate over all planes specified by bitmask.
1166  */
1167 #define drm_for_each_plane_mask(plane, dev, plane_mask) \
1168 	list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
1169 		if ((plane_mask) & (1 << drm_plane_index(plane)))
1170 
1171 
1172 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
1173 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
1174 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
1175 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
1176 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
1177 #define obj_to_property(x) container_of(x, struct drm_property, base)
1178 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
1179 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
1180 
1181 struct drm_prop_enum_list {
1182 	int type;
1183 	char *name;
1184 };
1185 
1186 extern int drm_crtc_init_with_planes(struct drm_device *dev,
1187 				     struct drm_crtc *crtc,
1188 				     struct drm_plane *primary,
1189 				     struct drm_plane *cursor,
1190 				     const struct drm_crtc_funcs *funcs);
1191 extern int drm_crtc_init(struct drm_device *dev,
1192 			 struct drm_crtc *crtc,
1193 			 const struct drm_crtc_funcs *funcs);
1194 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1195 extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
1196 
1197 /**
1198  * drm_crtc_mask - find the mask of a registered CRTC
1199  * @crtc: CRTC to find mask for
1200  *
1201  * Given a registered CRTC, return the mask bit of that CRTC for an
1202  * encoder's possible_crtcs field.
1203  */
1204 static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
1205 {
1206 	return 1 << drm_crtc_index(crtc);
1207 }
1208 
1209 extern void drm_connector_ida_init(void);
1210 extern void drm_connector_ida_destroy(void);
1211 extern int drm_connector_init(struct drm_device *dev,
1212 			      struct drm_connector *connector,
1213 			      const struct drm_connector_funcs *funcs,
1214 			      int connector_type);
1215 int drm_connector_register(struct drm_connector *connector);
1216 void drm_connector_unregister(struct drm_connector *connector);
1217 
1218 extern void drm_connector_cleanup(struct drm_connector *connector);
1219 extern unsigned int drm_connector_index(struct drm_connector *connector);
1220 /* helper to unplug all connectors from sysfs for device */
1221 extern void drm_connector_unplug_all(struct drm_device *dev);
1222 
1223 extern int drm_bridge_add(struct drm_bridge *bridge);
1224 extern void drm_bridge_remove(struct drm_bridge *bridge);
1225 extern struct drm_bridge *of_drm_find_bridge(struct device_node *np);
1226 extern int drm_bridge_attach(struct drm_device *dev, struct drm_bridge *bridge);
1227 
1228 bool drm_bridge_mode_fixup(struct drm_bridge *bridge,
1229 			const struct drm_display_mode *mode,
1230 			struct drm_display_mode *adjusted_mode);
1231 void drm_bridge_disable(struct drm_bridge *bridge);
1232 void drm_bridge_post_disable(struct drm_bridge *bridge);
1233 void drm_bridge_mode_set(struct drm_bridge *bridge,
1234 			struct drm_display_mode *mode,
1235 			struct drm_display_mode *adjusted_mode);
1236 void drm_bridge_pre_enable(struct drm_bridge *bridge);
1237 void drm_bridge_enable(struct drm_bridge *bridge);
1238 
1239 extern int drm_encoder_init(struct drm_device *dev,
1240 			    struct drm_encoder *encoder,
1241 			    const struct drm_encoder_funcs *funcs,
1242 			    int encoder_type);
1243 
1244 /**
1245  * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
1246  * @encoder: encoder to test
1247  * @crtc: crtc to test
1248  *
1249  * Return false if @encoder can't be driven by @crtc, true otherwise.
1250  */
1251 static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
1252 				       struct drm_crtc *crtc)
1253 {
1254 	return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
1255 }
1256 
1257 extern int drm_universal_plane_init(struct drm_device *dev,
1258 				    struct drm_plane *plane,
1259 				    unsigned long possible_crtcs,
1260 				    const struct drm_plane_funcs *funcs,
1261 				    const uint32_t *formats,
1262 				    unsigned int format_count,
1263 				    enum drm_plane_type type);
1264 extern int drm_plane_init(struct drm_device *dev,
1265 			  struct drm_plane *plane,
1266 			  unsigned long possible_crtcs,
1267 			  const struct drm_plane_funcs *funcs,
1268 			  const uint32_t *formats, unsigned int format_count,
1269 			  bool is_primary);
1270 extern void drm_plane_cleanup(struct drm_plane *plane);
1271 extern unsigned int drm_plane_index(struct drm_plane *plane);
1272 extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1273 extern void drm_plane_force_disable(struct drm_plane *plane);
1274 extern int drm_plane_check_pixel_format(const struct drm_plane *plane,
1275 					u32 format);
1276 extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
1277 				   int *hdisplay, int *vdisplay);
1278 extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
1279 				   int x, int y,
1280 				   const struct drm_display_mode *mode,
1281 				   const struct drm_framebuffer *fb);
1282 
1283 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
1284 
1285 extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1286 extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1287 extern const char *drm_get_dpms_name(int val);
1288 extern const char *drm_get_dvi_i_subconnector_name(int val);
1289 extern const char *drm_get_dvi_i_select_name(int val);
1290 extern const char *drm_get_tv_subconnector_name(int val);
1291 extern const char *drm_get_tv_select_name(int val);
1292 extern void drm_fb_release(struct drm_file *file_priv);
1293 extern void drm_property_destroy_user_blobs(struct drm_device *dev,
1294                                             struct drm_file *file_priv);
1295 extern bool drm_probe_ddc(struct i2c_adapter *adapter);
1296 extern struct edid *drm_get_edid(struct drm_connector *connector,
1297 				 struct i2c_adapter *adapter);
1298 extern struct edid *drm_get_edid_iic(struct drm_connector *connector,
1299 				     device_t adapter);
1300 extern struct edid *drm_edid_duplicate(const struct edid *edid);
1301 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1302 extern void drm_mode_config_init(struct drm_device *dev);
1303 extern void drm_mode_config_reset(struct drm_device *dev);
1304 extern void drm_mode_config_cleanup(struct drm_device *dev);
1305 
1306 extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1307 						const char *path);
1308 int drm_mode_connector_set_tile_property(struct drm_connector *connector);
1309 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1310 						   const struct edid *edid);
1311 
1312 extern int drm_display_info_set_bus_formats(struct drm_display_info *info,
1313 					    const u32 *formats,
1314 					    unsigned int num_formats);
1315 
1316 static inline bool drm_property_type_is(struct drm_property *property,
1317 		uint32_t type)
1318 {
1319 	/* instanceof for props.. handles extended type vs original types: */
1320 	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1321 		return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
1322 	return property->flags & type;
1323 }
1324 
1325 static inline bool drm_property_type_valid(struct drm_property *property)
1326 {
1327 	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
1328 		return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1329 	return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
1330 }
1331 
1332 extern int drm_object_property_set_value(struct drm_mode_object *obj,
1333 					 struct drm_property *property,
1334 					 uint64_t val);
1335 extern int drm_object_property_get_value(struct drm_mode_object *obj,
1336 					 struct drm_property *property,
1337 					 uint64_t *value);
1338 extern int drm_framebuffer_init(struct drm_device *dev,
1339 				struct drm_framebuffer *fb,
1340 				const struct drm_framebuffer_funcs *funcs);
1341 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1342 						      uint32_t id);
1343 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1344 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1345 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
1346 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1347 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
1348 
1349 extern void drm_object_attach_property(struct drm_mode_object *obj,
1350 				       struct drm_property *property,
1351 				       uint64_t init_val);
1352 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1353 						const char *name, int num_values);
1354 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1355 					 const char *name,
1356 					 const struct drm_prop_enum_list *props,
1357 					 int num_values);
1358 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1359 					 int flags, const char *name,
1360 					 const struct drm_prop_enum_list *props,
1361 					 int num_props,
1362 					 uint64_t supported_bits);
1363 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1364 					 const char *name,
1365 					 uint64_t min, uint64_t max);
1366 struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1367 					 int flags, const char *name,
1368 					 int64_t min, int64_t max);
1369 struct drm_property *drm_property_create_object(struct drm_device *dev,
1370 					 int flags, const char *name, uint32_t type);
1371 struct drm_property *drm_property_create_bool(struct drm_device *dev, int flags,
1372 					 const char *name);
1373 struct drm_property_blob *drm_property_create_blob(struct drm_device *dev,
1374                                                    size_t length,
1375                                                    const void *data);
1376 struct drm_property_blob *drm_property_lookup_blob(struct drm_device *dev,
1377                                                    uint32_t id);
1378 struct drm_property_blob *drm_property_reference_blob(struct drm_property_blob *blob);
1379 void drm_property_unreference_blob(struct drm_property_blob *blob);
1380 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1381 extern int drm_property_add_enum(struct drm_property *property, int index,
1382 				 uint64_t value, const char *name);
1383 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1384 extern int drm_mode_create_tv_properties(struct drm_device *dev,
1385 					 unsigned int num_modes,
1386 					 const char * const modes[]);
1387 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1388 extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1389 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1390 extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
1391 extern bool drm_property_change_valid_get(struct drm_property *property,
1392 					 uint64_t value, struct drm_mode_object **ref);
1393 extern void drm_property_change_valid_put(struct drm_property *property,
1394 		struct drm_mode_object *ref);
1395 
1396 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1397 					     struct drm_encoder *encoder);
1398 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1399 					 int gamma_size);
1400 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1401 		uint32_t id, uint32_t type);
1402 
1403 /* IOCTLs */
1404 extern int drm_mode_getresources(struct drm_device *dev,
1405 				 void *data, struct drm_file *file_priv);
1406 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1407 				   struct drm_file *file_priv);
1408 extern int drm_mode_getcrtc(struct drm_device *dev,
1409 			    void *data, struct drm_file *file_priv);
1410 extern int drm_mode_getconnector(struct drm_device *dev,
1411 			      void *data, struct drm_file *file_priv);
1412 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1413 extern int drm_mode_setcrtc(struct drm_device *dev,
1414 			    void *data, struct drm_file *file_priv);
1415 extern int drm_mode_getplane(struct drm_device *dev,
1416 			       void *data, struct drm_file *file_priv);
1417 extern int drm_mode_setplane(struct drm_device *dev,
1418 			       void *data, struct drm_file *file_priv);
1419 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1420 				void *data, struct drm_file *file_priv);
1421 extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1422 				void *data, struct drm_file *file_priv);
1423 extern int drm_mode_addfb(struct drm_device *dev,
1424 			  void *data, struct drm_file *file_priv);
1425 extern int drm_mode_addfb2(struct drm_device *dev,
1426 			   void *data, struct drm_file *file_priv);
1427 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1428 extern int drm_mode_rmfb(struct drm_device *dev,
1429 			 void *data, struct drm_file *file_priv);
1430 extern int drm_mode_getfb(struct drm_device *dev,
1431 			  void *data, struct drm_file *file_priv);
1432 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1433 				  void *data, struct drm_file *file_priv);
1434 
1435 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1436 				      void *data, struct drm_file *file_priv);
1437 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1438 				  void *data, struct drm_file *file_priv);
1439 extern int drm_mode_createblob_ioctl(struct drm_device *dev,
1440 				     void *data, struct drm_file *file_priv);
1441 extern int drm_mode_destroyblob_ioctl(struct drm_device *dev,
1442 				      void *data, struct drm_file *file_priv);
1443 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1444 					      void *data, struct drm_file *file_priv);
1445 extern int drm_mode_getencoder(struct drm_device *dev,
1446 			       void *data, struct drm_file *file_priv);
1447 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1448 				    void *data, struct drm_file *file_priv);
1449 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1450 				    void *data, struct drm_file *file_priv);
1451 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1452 extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1453 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1454 extern bool drm_detect_monitor_audio(struct edid *edid);
1455 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1456 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1457 				    void *data, struct drm_file *file_priv);
1458 extern int drm_add_modes_noedid(struct drm_connector *connector,
1459 				int hdisplay, int vdisplay);
1460 extern void drm_set_preferred_mode(struct drm_connector *connector,
1461 				   int hpref, int vpref);
1462 
1463 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1464 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
1465 				 bool *edid_corrupt);
1466 extern bool drm_edid_is_valid(struct edid *edid);
1467 
1468 extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
1469 							 char topology[8]);
1470 extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
1471 					       char topology[8]);
1472 extern void drm_mode_put_tile_group(struct drm_device *dev,
1473 				   struct drm_tile_group *tg);
1474 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1475 					   int hsize, int vsize, int fresh,
1476 					   bool rb);
1477 
1478 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1479 				      void *data, struct drm_file *file_priv);
1480 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1481 				    void *data, struct drm_file *file_priv);
1482 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1483 				      void *data, struct drm_file *file_priv);
1484 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1485 					     struct drm_file *file_priv);
1486 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1487 					   struct drm_file *file_priv);
1488 extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1489 				       struct drm_property *property,
1490 				       uint64_t value);
1491 
1492 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1493 				 int *bpp);
1494 extern int drm_format_num_planes(uint32_t format);
1495 extern int drm_format_plane_cpp(uint32_t format, int plane);
1496 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1497 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1498 extern const char *drm_get_format_name(uint32_t format);
1499 extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1500 							      unsigned int supported_rotations);
1501 extern unsigned int drm_rotation_simplify(unsigned int rotation,
1502 					  unsigned int supported_rotations);
1503 
1504 /* Helpers */
1505 
1506 static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1507 		uint32_t id)
1508 {
1509 	struct drm_mode_object *mo;
1510 	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1511 	return mo ? obj_to_plane(mo) : NULL;
1512 }
1513 
1514 static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1515 	uint32_t id)
1516 {
1517 	struct drm_mode_object *mo;
1518 	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1519 	return mo ? obj_to_crtc(mo) : NULL;
1520 }
1521 
1522 static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1523 	uint32_t id)
1524 {
1525 	struct drm_mode_object *mo;
1526 	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1527 	return mo ? obj_to_encoder(mo) : NULL;
1528 }
1529 
1530 static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1531 		uint32_t id)
1532 {
1533 	struct drm_mode_object *mo;
1534 	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1535 	return mo ? obj_to_connector(mo) : NULL;
1536 }
1537 
1538 static inline struct drm_property *drm_property_find(struct drm_device *dev,
1539 		uint32_t id)
1540 {
1541 	struct drm_mode_object *mo;
1542 	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1543 	return mo ? obj_to_property(mo) : NULL;
1544 }
1545 
1546 /* Plane list iterator for legacy (overlay only) planes. */
1547 #define drm_for_each_legacy_plane(plane, dev) \
1548 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1549 		if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1550 
1551 #define drm_for_each_plane(plane, dev) \
1552 	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)
1553 
1554 #define drm_for_each_crtc(crtc, dev) \
1555 	list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
1556 
1557 static inline void
1558 assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
1559 {
1560 	/*
1561 	 * The connector hotadd/remove code currently grabs both locks when
1562 	 * updating lists. Hence readers need only hold either of them to be
1563 	 * safe and the check amounts to
1564 	 *
1565 	 * WARN_ON(not_holding(A) && not_holding(B)).
1566 	 */
1567 	WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
1568 		!drm_modeset_is_locked(&mode_config->connection_mutex));
1569 }
1570 
1571 #define drm_for_each_connector(connector, dev) \
1572 	for (assert_drm_connector_list_read_locked(&(dev)->mode_config),	\
1573 	     connector = list_first_entry(&(dev)->mode_config.connector_list,	\
1574 					  struct drm_connector, head);		\
1575 	     &connector->head != (&(dev)->mode_config.connector_list);		\
1576 	     connector = list_next_entry(connector, head))
1577 
1578 #define drm_for_each_encoder(encoder, dev) \
1579 	list_for_each_entry(encoder, &(dev)->mode_config.encoder_list, head)
1580 
1581 #define drm_for_each_fb(fb, dev) \
1582 	for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)),		\
1583 	     fb = list_first_entry(&(dev)->mode_config.fb_list,	\
1584 					  struct drm_framebuffer, head);	\
1585 	     &fb->head != (&(dev)->mode_config.fb_list);			\
1586 	     fb = list_next_entry(fb, head))
1587 
1588 #endif /* __DRM_CRTC_H__ */
1589