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