xref: /dragonfly/sys/dev/drm/include/drm/drm_crtc.h (revision bb66151c)
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/types.h>
30 #include <linux/idr.h>
31 #include <uapi_drm/drm_mode.h>
32 
33 #include <uapi_drm/drm_fourcc.h>
34 
35 struct drm_device;
36 struct drm_mode_set;
37 struct drm_framebuffer;
38 struct drm_object_properties;
39 struct drm_file;
40 struct drm_clip_rect;
41 
42 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
43 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
44 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
45 #define DRM_MODE_OBJECT_MODE 0xdededede
46 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
47 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
48 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
49 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
50 
51 struct drm_mode_object {
52 	uint32_t id;
53 	uint32_t type;
54 	struct drm_object_properties *properties;
55 };
56 
57 #define DRM_OBJECT_MAX_PROPERTY 24
58 struct drm_object_properties {
59 	int count;
60 	uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
61 	uint64_t values[DRM_OBJECT_MAX_PROPERTY];
62 };
63 
64 /*
65  * Note on terminology:  here, for brevity and convenience, we refer to connector
66  * control chips as 'CRTCs'.  They can control any type of connector, VGA, LVDS,
67  * DVI, etc.  And 'screen' refers to the whole of the visible display, which
68  * may span multiple monitors (and therefore multiple CRTC and connector
69  * structures).
70  */
71 
72 enum drm_mode_status {
73     MODE_OK	= 0,	/* Mode OK */
74     MODE_HSYNC,		/* hsync out of range */
75     MODE_VSYNC,		/* vsync out of range */
76     MODE_H_ILLEGAL,	/* mode has illegal horizontal timings */
77     MODE_V_ILLEGAL,	/* mode has illegal horizontal timings */
78     MODE_BAD_WIDTH,	/* requires an unsupported linepitch */
79     MODE_NOMODE,	/* no mode with a matching name */
80     MODE_NO_INTERLACE,	/* interlaced mode not supported */
81     MODE_NO_DBLESCAN,	/* doublescan mode not supported */
82     MODE_NO_VSCAN,	/* multiscan mode not supported */
83     MODE_MEM,		/* insufficient video memory */
84     MODE_VIRTUAL_X,	/* mode width too large for specified virtual size */
85     MODE_VIRTUAL_Y,	/* mode height too large for specified virtual size */
86     MODE_MEM_VIRT,	/* insufficient video memory given virtual size */
87     MODE_NOCLOCK,	/* no fixed clock available */
88     MODE_CLOCK_HIGH,	/* clock required is too high */
89     MODE_CLOCK_LOW,	/* clock required is too low */
90     MODE_CLOCK_RANGE,	/* clock/mode isn't in a ClockRange */
91     MODE_BAD_HVALUE,	/* horizontal timing was out of range */
92     MODE_BAD_VVALUE,	/* vertical timing was out of range */
93     MODE_BAD_VSCAN,	/* VScan value out of range */
94     MODE_HSYNC_NARROW,	/* horizontal sync too narrow */
95     MODE_HSYNC_WIDE,	/* horizontal sync too wide */
96     MODE_HBLANK_NARROW,	/* horizontal blanking too narrow */
97     MODE_HBLANK_WIDE,	/* horizontal blanking too wide */
98     MODE_VSYNC_NARROW,	/* vertical sync too narrow */
99     MODE_VSYNC_WIDE,	/* vertical sync too wide */
100     MODE_VBLANK_NARROW,	/* vertical blanking too narrow */
101     MODE_VBLANK_WIDE,	/* vertical blanking too wide */
102     MODE_PANEL,         /* exceeds panel dimensions */
103     MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
104     MODE_ONE_WIDTH,     /* only one width is supported */
105     MODE_ONE_HEIGHT,    /* only one height is supported */
106     MODE_ONE_SIZE,      /* only one resolution is supported */
107     MODE_NO_REDUCED,    /* monitor doesn't accept reduced blanking */
108     MODE_UNVERIFIED = -3, /* mode needs to reverified */
109     MODE_BAD = -2,	/* unspecified reason */
110     MODE_ERROR	= -1	/* error condition */
111 };
112 
113 #define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
114 				    DRM_MODE_TYPE_CRTC_C)
115 
116 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
117 	.name = nm, .status = 0, .type = (t), .clock = (c), \
118 	.hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
119 	.htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
120 	.vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
121 	.vscan = (vs), .flags = (f), \
122 	.base.type = DRM_MODE_OBJECT_MODE
123 
124 #define CRTC_INTERLACE_HALVE_V 0x1 /* halve V values for interlacing */
125 
126 struct drm_display_mode {
127 	/* Header */
128 	struct list_head head;
129 	struct drm_mode_object base;
130 
131 	char name[DRM_DISPLAY_MODE_LEN];
132 
133 	enum drm_mode_status status;
134 	unsigned int type;
135 
136 	/* Proposed mode values */
137 	int clock;		/* in kHz */
138 	int hdisplay;
139 	int hsync_start;
140 	int hsync_end;
141 	int htotal;
142 	int hskew;
143 	int vdisplay;
144 	int vsync_start;
145 	int vsync_end;
146 	int vtotal;
147 	int vscan;
148 	unsigned int flags;
149 
150 	/* Addressable image size (may be 0 for projectors, etc.) */
151 	int width_mm;
152 	int height_mm;
153 
154 	/* Actual mode we give to hw */
155 	int clock_index;
156 	int synth_clock;
157 	int crtc_hdisplay;
158 	int crtc_hblank_start;
159 	int crtc_hblank_end;
160 	int crtc_hsync_start;
161 	int crtc_hsync_end;
162 	int crtc_htotal;
163 	int crtc_hskew;
164 	int crtc_vdisplay;
165 	int crtc_vblank_start;
166 	int crtc_vblank_end;
167 	int crtc_vsync_start;
168 	int crtc_vsync_end;
169 	int crtc_vtotal;
170 
171 	/* Driver private mode info */
172 	int private_size;
173 	int *private;
174 	int private_flags;
175 
176 	int vrefresh;		/* in Hz */
177 	int hsync;		/* in kHz */
178 };
179 
180 enum drm_connector_status {
181 	connector_status_connected = 1,
182 	connector_status_disconnected = 2,
183 	connector_status_unknown = 3,
184 };
185 
186 enum subpixel_order {
187 	SubPixelUnknown = 0,
188 	SubPixelHorizontalRGB,
189 	SubPixelHorizontalBGR,
190 	SubPixelVerticalRGB,
191 	SubPixelVerticalBGR,
192 	SubPixelNone,
193 };
194 
195 #define DRM_COLOR_FORMAT_RGB444		(1<<0)
196 #define DRM_COLOR_FORMAT_YCRCB444	(1<<1)
197 #define DRM_COLOR_FORMAT_YCRCB422	(1<<2)
198 /*
199  * Describes a given display (e.g. CRT or flat panel) and its limitations.
200  */
201 struct drm_display_info {
202 	char name[DRM_DISPLAY_INFO_LEN];
203 
204 	/* Physical size */
205         unsigned int width_mm;
206 	unsigned int height_mm;
207 
208 	/* Clock limits FIXME: storage format */
209 	unsigned int min_vfreq, max_vfreq;
210 	unsigned int min_hfreq, max_hfreq;
211 	unsigned int pixel_clock;
212 	unsigned int bpc;
213 
214 	enum subpixel_order subpixel_order;
215 	u32 color_formats;
216 
217 	u8 cea_rev;
218 };
219 
220 struct drm_framebuffer_funcs {
221 	/* note: use drm_framebuffer_remove() */
222 	void (*destroy)(struct drm_framebuffer *framebuffer);
223 	int (*create_handle)(struct drm_framebuffer *fb,
224 			     struct drm_file *file_priv,
225 			     unsigned int *handle);
226 	/**
227 	 * Optinal callback for the dirty fb ioctl.
228 	 *
229 	 * Userspace can notify the driver via this callback
230 	 * that a area of the framebuffer has changed and should
231 	 * be flushed to the display hardware.
232 	 *
233 	 * See documentation in drm_mode.h for the struct
234 	 * drm_mode_fb_dirty_cmd for more information as all
235 	 * the semantics and arguments have a one to one mapping
236 	 * on this function.
237 	 */
238 	int (*dirty)(struct drm_framebuffer *framebuffer,
239 		     struct drm_file *file_priv, unsigned flags,
240 		     unsigned color, struct drm_clip_rect *clips,
241 		     unsigned num_clips);
242 };
243 
244 struct drm_framebuffer {
245 	struct drm_device *dev;
246 	/*
247 	 * Note that the fb is refcounted for the benefit of driver internals,
248 	 * for example some hw, disabling a CRTC/plane is asynchronous, and
249 	 * scanout does not actually complete until the next vblank.  So some
250 	 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
251 	 * should be deferred.  In cases like this, the driver would like to
252 	 * hold a ref to the fb even though it has already been removed from
253 	 * userspace perspective.
254 	 */
255 	struct kref refcount;
256 	/*
257 	 * Place on the dev->mode_config.fb_list, access protected by
258 	 * dev->mode_config.fb_lock.
259 	 */
260 	struct list_head head;
261 	struct drm_mode_object base;
262 	const struct drm_framebuffer_funcs *funcs;
263 	unsigned int pitches[4];
264 	unsigned int offsets[4];
265 	unsigned int width;
266 	unsigned int height;
267 	/* depth can be 15 or 16 */
268 	unsigned int depth;
269 	int bits_per_pixel;
270 	int flags;
271 	uint32_t pixel_format; /* fourcc format */
272 	struct list_head filp_head;
273 	/* if you are using the helper */
274 	void *helper_private;
275 };
276 
277 struct drm_property_blob {
278 	struct drm_mode_object base;
279 	struct list_head head;
280 	unsigned int length;
281 	unsigned char data[];
282 };
283 
284 struct drm_property_enum {
285 	uint64_t value;
286 	struct list_head head;
287 	char name[DRM_PROP_NAME_LEN];
288 };
289 
290 struct drm_property {
291 	struct list_head head;
292 	struct drm_mode_object base;
293 	uint32_t flags;
294 	char name[DRM_PROP_NAME_LEN];
295 	uint32_t num_values;
296 	uint64_t *values;
297 
298 	struct list_head enum_blob_list;
299 };
300 
301 struct drm_crtc;
302 struct drm_connector;
303 struct drm_encoder;
304 struct drm_pending_vblank_event;
305 struct drm_plane;
306 
307 /**
308  * drm_crtc_funcs - control CRTCs for a given device
309  * @save: save CRTC state
310  * @restore: restore CRTC state
311  * @reset: reset CRTC after state has been invalidated (e.g. resume)
312  * @cursor_set: setup the cursor
313  * @cursor_move: move the cursor
314  * @gamma_set: specify color ramp for CRTC
315  * @destroy: deinit and free object
316  * @set_property: called when a property is changed
317  * @set_config: apply a new CRTC configuration
318  * @page_flip: initiate a page flip
319  *
320  * The drm_crtc_funcs structure is the central CRTC management structure
321  * in the DRM.  Each CRTC controls one or more connectors (note that the name
322  * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
323  * connectors, not just CRTs).
324  *
325  * Each driver is responsible for filling out this structure at startup time,
326  * in addition to providing other modesetting features, like i2c and DDC
327  * bus accessors.
328  */
329 struct drm_crtc_funcs {
330 	/* Save CRTC state */
331 	void (*save)(struct drm_crtc *crtc); /* suspend? */
332 	/* Restore CRTC state */
333 	void (*restore)(struct drm_crtc *crtc); /* resume? */
334 	/* Reset CRTC state */
335 	void (*reset)(struct drm_crtc *crtc);
336 
337 	/* cursor controls */
338 	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
339 			  uint32_t handle, uint32_t width, uint32_t height);
340 	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
341 
342 	/* Set gamma on the CRTC */
343 	void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
344 			  uint32_t start, uint32_t size);
345 	/* Object destroy routine */
346 	void (*destroy)(struct drm_crtc *crtc);
347 
348 	int (*set_config)(struct drm_mode_set *set);
349 
350 	/*
351 	 * Flip to the given framebuffer.  This implements the page
352 	 * flip ioctl described in drm_mode.h, specifically, the
353 	 * implementation must return immediately and block all
354 	 * rendering to the current fb until the flip has completed.
355 	 * If userspace set the event flag in the ioctl, the event
356 	 * argument will point to an event to send back when the flip
357 	 * completes, otherwise it will be NULL.
358 	 */
359 	int (*page_flip)(struct drm_crtc *crtc,
360 			 struct drm_framebuffer *fb,
361 			 struct drm_pending_vblank_event *event);
362 
363 	int (*set_property)(struct drm_crtc *crtc,
364 			    struct drm_property *property, uint64_t val);
365 };
366 
367 /**
368  * drm_crtc - central CRTC control structure
369  * @dev: parent DRM device
370  * @head: list management
371  * @base: base KMS object for ID tracking etc.
372  * @enabled: is this CRTC enabled?
373  * @mode: current mode timings
374  * @hwmode: mode timings as programmed to hw regs
375  * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
376  *    invert the width/height of the crtc.  This is used if the driver
377  *    is performing 90 or 270 degree rotated scanout
378  * @x: x position on screen
379  * @y: y position on screen
380  * @funcs: CRTC control functions
381  * @gamma_size: size of gamma ramp
382  * @gamma_store: gamma ramp values
383  * @framedur_ns: precise frame timing
384  * @framedur_ns: precise line timing
385  * @pixeldur_ns: precise pixel timing
386  * @helper_private: mid-layer private data
387  * @properties: property tracking for this CRTC
388  *
389  * Each CRTC may have one or more connectors associated with it.  This structure
390  * allows the CRTC to be controlled.
391  */
392 struct drm_crtc {
393 	struct drm_device *dev;
394 	struct list_head head;
395 
396 	/**
397 	 * crtc mutex
398 	 *
399 	 * This provides a read lock for the overall crtc state (mode, dpms
400 	 * state, ...) and a write lock for everything which can be update
401 	 * without a full modeset (fb, cursor data, ...)
402 	 */
403 	struct lock mutex;
404 
405 	struct drm_mode_object base;
406 
407 	/* framebuffer the connector is currently bound to */
408 	struct drm_framebuffer *fb;
409 
410 	bool enabled;
411 
412 	/* Requested mode from modesetting. */
413 	struct drm_display_mode mode;
414 
415 	/* Programmed mode in hw, after adjustments for encoders,
416 	 * crtc, panel scaling etc. Needed for timestamping etc.
417 	 */
418 	struct drm_display_mode hwmode;
419 
420 	bool invert_dimensions;
421 
422 	int x, y;
423 	const struct drm_crtc_funcs *funcs;
424 
425 	/* CRTC gamma size for reporting to userspace */
426 	uint32_t gamma_size;
427 	uint16_t *gamma_store;
428 
429 	/* Constants needed for precise vblank and swap timestamping. */
430 	s64 framedur_ns, linedur_ns, pixeldur_ns;
431 
432 	/* if you are using the helper */
433 	void *helper_private;
434 
435 	struct drm_object_properties properties;
436 };
437 
438 
439 /**
440  * drm_connector_funcs - control connectors on a given device
441  * @dpms: set power state (see drm_crtc_funcs above)
442  * @save: save connector state
443  * @restore: restore connector state
444  * @reset: reset connector after state has been invalidated (e.g. resume)
445  * @detect: is this connector active?
446  * @fill_modes: fill mode list for this connector
447  * @set_property: property for this connector may need an update
448  * @destroy: make object go away
449  * @force: notify the driver that the connector is forced on
450  *
451  * Each CRTC may have one or more connectors attached to it.  The functions
452  * below allow the core DRM code to control connectors, enumerate available modes,
453  * etc.
454  */
455 struct drm_connector_funcs {
456 	void (*dpms)(struct drm_connector *connector, int mode);
457 	void (*save)(struct drm_connector *connector);
458 	void (*restore)(struct drm_connector *connector);
459 	void (*reset)(struct drm_connector *connector);
460 
461 	/* Check to see if anything is attached to the connector.
462 	 * @force is set to false whilst polling, true when checking the
463 	 * connector due to user request. @force can be used by the driver
464 	 * to avoid expensive, destructive operations during automated
465 	 * probing.
466 	 */
467 	enum drm_connector_status (*detect)(struct drm_connector *connector,
468 					    bool force);
469 	int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
470 	int (*set_property)(struct drm_connector *connector, struct drm_property *property,
471 			     uint64_t val);
472 	void (*destroy)(struct drm_connector *connector);
473 	void (*force)(struct drm_connector *connector);
474 };
475 
476 /**
477  * drm_encoder_funcs - encoder controls
478  * @reset: reset state (e.g. at init or resume time)
479  * @destroy: cleanup and free associated data
480  *
481  * Encoders sit between CRTCs and connectors.
482  */
483 struct drm_encoder_funcs {
484 	void (*reset)(struct drm_encoder *encoder);
485 	void (*destroy)(struct drm_encoder *encoder);
486 };
487 
488 #define DRM_CONNECTOR_MAX_UMODES 16
489 #define DRM_CONNECTOR_LEN 32
490 #define DRM_CONNECTOR_MAX_ENCODER 3
491 
492 /**
493  * drm_encoder - central DRM encoder structure
494  * @dev: parent DRM device
495  * @head: list management
496  * @base: base KMS object
497  * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
498  * @possible_crtcs: bitmask of potential CRTC bindings
499  * @possible_clones: bitmask of potential sibling encoders for cloning
500  * @crtc: currently bound CRTC
501  * @funcs: control functions
502  * @helper_private: mid-layer private data
503  *
504  * CRTCs drive pixels to encoders, which convert them into signals
505  * appropriate for a given connector or set of connectors.
506  */
507 struct drm_encoder {
508 	struct drm_device *dev;
509 	struct list_head head;
510 
511 	struct drm_mode_object base;
512 	int encoder_type;
513 	uint32_t possible_crtcs;
514 	uint32_t possible_clones;
515 
516 	struct drm_crtc *crtc;
517 	const struct drm_encoder_funcs *funcs;
518 	void *helper_private;
519 };
520 
521 enum drm_connector_force {
522 	DRM_FORCE_UNSPECIFIED,
523 	DRM_FORCE_OFF,
524 	DRM_FORCE_ON,         /* force on analog part normally */
525 	DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
526 };
527 
528 /* should we poll this connector for connects and disconnects */
529 /* hot plug detectable */
530 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
531 /* poll for connections */
532 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
533 /* can cleanly poll for disconnections without flickering the screen */
534 /* DACs should rarely do this without a lot of testing */
535 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
536 
537 #define MAX_ELD_BYTES	128
538 
539 /**
540  * drm_connector - central DRM connector control structure
541  * @dev: parent DRM device
542  * @kdev: kernel device for sysfs attributes
543  * @attr: sysfs attributes
544  * @head: list management
545  * @base: base KMS object
546  * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
547  * @connector_type_id: index into connector type enum
548  * @interlace_allowed: can this connector handle interlaced modes?
549  * @doublescan_allowed: can this connector handle doublescan?
550  * @modes: modes available on this connector (from fill_modes() + user)
551  * @status: one of the drm_connector_status enums (connected, not, or unknown)
552  * @probed_modes: list of modes derived directly from the display
553  * @display_info: information about attached display (e.g. from EDID)
554  * @funcs: connector control functions
555  * @edid_blob_ptr: DRM property containing EDID if present
556  * @properties: property tracking for this connector
557  * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
558  * @dpms: current dpms state
559  * @helper_private: mid-layer private data
560  * @force: a %DRM_FORCE_<foo> state for forced mode sets
561  * @encoder_ids: valid encoders for this connector
562  * @encoder: encoder driving this connector, if any
563  * @eld: EDID-like data, if present
564  * @dvi_dual: dual link DVI, if found
565  * @max_tmds_clock: max clock rate, if found
566  * @latency_present: AV delay info from ELD, if found
567  * @video_latency: video latency info from ELD, if found
568  * @audio_latency: audio latency info from ELD, if found
569  * @null_edid_counter: track sinks that give us all zeros for the EDID
570  *
571  * Each connector may be connected to one or more CRTCs, or may be clonable by
572  * another connector if they can share a CRTC.  Each connector also has a specific
573  * position in the broader display (referred to as a 'screen' though it could
574  * span multiple monitors).
575  */
576 struct drm_connector {
577 	struct drm_device *dev;
578 	/* struct device kdev; XXXKIB */
579 	struct device_attribute *attr;
580 	struct list_head head;
581 
582 	struct drm_mode_object base;
583 
584 	int connector_type;
585 	int connector_type_id;
586 	bool interlace_allowed;
587 	bool doublescan_allowed;
588 	struct list_head modes; /* list of modes on this connector */
589 
590 	enum drm_connector_status status;
591 
592 	/* these are modes added by probing with DDC or the BIOS */
593 	struct list_head probed_modes;
594 
595 	struct drm_display_info display_info;
596 	const struct drm_connector_funcs *funcs;
597 
598 	struct drm_property_blob *edid_blob_ptr;
599 	struct drm_object_properties properties;
600 
601 	uint8_t polled; /* DRM_CONNECTOR_POLL_* */
602 
603 	/* requested DPMS state */
604 	int dpms;
605 
606 	void *helper_private;
607 
608 	/* forced on connector */
609 	enum drm_connector_force force;
610 	uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
611 	struct drm_encoder *encoder; /* currently active encoder */
612 
613 	/* EDID bits */
614 	uint8_t eld[MAX_ELD_BYTES];
615 	bool dvi_dual;
616 	int max_tmds_clock;	/* in MHz */
617 	bool latency_present[2];
618 	int video_latency[2];	/* [0]: progressive, [1]: interlaced */
619 	int audio_latency[2];
620 	int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
621 	unsigned bad_edid_counter;
622 };
623 
624 /**
625  * drm_plane_funcs - driver plane control functions
626  * @update_plane: update the plane configuration
627  * @disable_plane: shut down the plane
628  * @destroy: clean up plane resources
629  * @set_property: called when a property is changed
630  */
631 struct drm_plane_funcs {
632 	int (*update_plane)(struct drm_plane *plane,
633 			    struct drm_crtc *crtc, struct drm_framebuffer *fb,
634 			    int crtc_x, int crtc_y,
635 			    unsigned int crtc_w, unsigned int crtc_h,
636 			    uint32_t src_x, uint32_t src_y,
637 			    uint32_t src_w, uint32_t src_h);
638 	int (*disable_plane)(struct drm_plane *plane);
639 	void (*destroy)(struct drm_plane *plane);
640 
641 	int (*set_property)(struct drm_plane *plane,
642 			    struct drm_property *property, uint64_t val);
643 };
644 
645 /**
646  * drm_plane - central DRM plane control structure
647  * @dev: DRM device this plane belongs to
648  * @head: for list management
649  * @base: base mode object
650  * @possible_crtcs: pipes this plane can be bound to
651  * @format_types: array of formats supported by this plane
652  * @format_count: number of formats supported
653  * @crtc: currently bound CRTC
654  * @fb: currently bound fb
655  * @gamma_size: size of gamma table
656  * @gamma_store: gamma correction table
657  * @enabled: enabled flag
658  * @funcs: helper functions
659  * @helper_private: storage for drver layer
660  * @properties: property tracking for this plane
661  */
662 struct drm_plane {
663 	struct drm_device *dev;
664 	struct list_head head;
665 
666 	struct drm_mode_object base;
667 
668 	uint32_t possible_crtcs;
669 	uint32_t *format_types;
670 	uint32_t format_count;
671 
672 	struct drm_crtc *crtc;
673 	struct drm_framebuffer *fb;
674 
675 	/* CRTC gamma size for reporting to userspace */
676 	uint32_t gamma_size;
677 	uint16_t *gamma_store;
678 
679 	bool enabled;
680 
681 	const struct drm_plane_funcs *funcs;
682 	void *helper_private;
683 
684 	struct drm_object_properties properties;
685 };
686 
687 /**
688  * drm_mode_set - new values for a CRTC config change
689  * @head: list management
690  * @fb: framebuffer to use for new config
691  * @crtc: CRTC whose configuration we're about to change
692  * @mode: mode timings to use
693  * @x: position of this CRTC relative to @fb
694  * @y: position of this CRTC relative to @fb
695  * @connectors: array of connectors to drive with this CRTC if possible
696  * @num_connectors: size of @connectors array
697  *
698  * Represents a single crtc the connectors that it drives with what mode
699  * and from which framebuffer it scans out from.
700  *
701  * This is used to set modes.
702  */
703 struct drm_mode_set {
704 	struct drm_framebuffer *fb;
705 	struct drm_crtc *crtc;
706 	struct drm_display_mode *mode;
707 
708 	uint32_t x;
709 	uint32_t y;
710 
711 	struct drm_connector **connectors;
712 	size_t num_connectors;
713 };
714 
715 /**
716  * struct drm_mode_config_funcs - basic driver provided mode setting functions
717  * @fb_create: create a new framebuffer object
718  * @output_poll_changed: function to handle output configuration changes
719  *
720  * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
721  * involve drivers.
722  */
723 struct drm_mode_config_funcs {
724 	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
725 					     struct drm_file *file_priv,
726 					     struct drm_mode_fb_cmd2 *mode_cmd);
727 	void (*output_poll_changed)(struct drm_device *dev);
728 };
729 
730 /**
731  * drm_mode_group - group of mode setting resources for potential sub-grouping
732  * @num_crtcs: CRTC count
733  * @num_encoders: encoder count
734  * @num_connectors: connector count
735  * @id_list: list of KMS object IDs in this group
736  *
737  * Currently this simply tracks the global mode setting state.  But in the
738  * future it could allow groups of objects to be set aside into independent
739  * control groups for use by different user level processes (e.g. two X servers
740  * running simultaneously on different heads, each with their own mode
741  * configuration and freedom of mode setting).
742  */
743 struct drm_mode_group {
744 	uint32_t num_crtcs;
745 	uint32_t num_encoders;
746 	uint32_t num_connectors;
747 
748 	/* list of object IDs for this group */
749 	uint32_t *id_list;
750 };
751 
752 /**
753  * drm_mode_config - Mode configuration control structure
754  * @mutex: mutex protecting KMS related lists and structures
755  * @idr_mutex: mutex for KMS ID allocation and management
756  * @crtc_idr: main KMS ID tracking object
757  * @num_fb: number of fbs available
758  * @fb_list: list of framebuffers available
759  * @num_connector: number of connectors on this device
760  * @connector_list: list of connector objects
761  * @num_encoder: number of encoders on this device
762  * @encoder_list: list of encoder objects
763  * @num_crtc: number of CRTCs on this device
764  * @crtc_list: list of CRTC objects
765  * @min_width: minimum pixel width on this device
766  * @min_height: minimum pixel height on this device
767  * @max_width: maximum pixel width on this device
768  * @max_height: maximum pixel height on this device
769  * @funcs: core driver provided mode setting functions
770  * @fb_base: base address of the framebuffer
771  * @poll_enabled: track polling status for this device
772  * @output_poll_work: delayed work for polling in process context
773  * @*_property: core property tracking
774  *
775  * Core mode resource tracking structure.  All CRTC, encoders, and connectors
776  * enumerated by the driver are added here, as are global properties.  Some
777  * global restrictions are also here, e.g. dimension restrictions.
778  */
779 struct drm_mode_config {
780 	struct lock mutex; /* protects configuration (mode lists etc.) */
781 	struct lock idr_mutex; /* for IDR management */
782 	struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
783 	/* this is limited to one for now */
784 
785 
786 	/**
787 	 * fb_lock - mutex to protect fb state
788 	 *
789 	 * Besides the global fb list his also protects the fbs list in the
790 	 * file_priv
791 	 */
792 	struct lock fb_lock;
793 	int num_fb;
794 	struct list_head fb_list;
795 
796 	int num_connector;
797 	struct list_head connector_list;
798 	int num_encoder;
799 	struct list_head encoder_list;
800 	int num_plane;
801 	struct list_head plane_list;
802 
803 	int num_crtc;
804 	struct list_head crtc_list;
805 
806 	struct list_head property_list;
807 
808 	int min_width, min_height;
809 	int max_width, max_height;
810 	const struct drm_mode_config_funcs *funcs;
811 	resource_size_t fb_base;
812 
813 	/* output poll support */
814 	bool poll_enabled;
815 	bool poll_running;
816 	struct timeout_task output_poll_task;
817 
818 	/* pointers to standard properties */
819 	struct list_head property_blob_list;
820 	struct drm_property *edid_property;
821 	struct drm_property *dpms_property;
822 
823 	/* DVI-I properties */
824 	struct drm_property *dvi_i_subconnector_property;
825 	struct drm_property *dvi_i_select_subconnector_property;
826 
827 	/* TV properties */
828 	struct drm_property *tv_subconnector_property;
829 	struct drm_property *tv_select_subconnector_property;
830 	struct drm_property *tv_mode_property;
831 	struct drm_property *tv_left_margin_property;
832 	struct drm_property *tv_right_margin_property;
833 	struct drm_property *tv_top_margin_property;
834 	struct drm_property *tv_bottom_margin_property;
835 	struct drm_property *tv_brightness_property;
836 	struct drm_property *tv_contrast_property;
837 	struct drm_property *tv_flicker_reduction_property;
838 	struct drm_property *tv_overscan_property;
839 	struct drm_property *tv_saturation_property;
840 	struct drm_property *tv_hue_property;
841 
842 	/* Optional properties */
843 	struct drm_property *scaling_mode_property;
844 	struct drm_property *dithering_mode_property;
845 	struct drm_property *dirty_info_property;
846 
847 	/* dumb ioctl parameters */
848 	uint32_t preferred_depth, prefer_shadow;
849 };
850 
851 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
852 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
853 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
854 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
855 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
856 #define obj_to_property(x) container_of(x, struct drm_property, base)
857 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
858 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
859 
860 struct drm_prop_enum_list {
861 	int type;
862 	char *name;
863 };
864 
865 extern void drm_modeset_lock_all(struct drm_device *dev);
866 extern void drm_modeset_unlock_all(struct drm_device *dev);
867 extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
868 
869 extern int drm_crtc_init(struct drm_device *dev,
870 			 struct drm_crtc *crtc,
871 			 const struct drm_crtc_funcs *funcs);
872 extern void drm_crtc_cleanup(struct drm_crtc *crtc);
873 
874 extern int drm_connector_init(struct drm_device *dev,
875 			      struct drm_connector *connector,
876 			      const struct drm_connector_funcs *funcs,
877 			      int connector_type);
878 
879 extern void drm_connector_cleanup(struct drm_connector *connector);
880 /* helper to unplug all connectors from sysfs for device */
881 extern void drm_connector_unplug_all(struct drm_device *dev);
882 
883 extern int drm_encoder_init(struct drm_device *dev,
884 			    struct drm_encoder *encoder,
885 			    const struct drm_encoder_funcs *funcs,
886 			    int encoder_type);
887 
888 extern int drm_plane_init(struct drm_device *dev,
889 			  struct drm_plane *plane,
890 			  unsigned long possible_crtcs,
891 			  const struct drm_plane_funcs *funcs,
892 			  const uint32_t *formats, uint32_t format_count,
893 			  bool priv);
894 extern void drm_plane_cleanup(struct drm_plane *plane);
895 
896 extern void drm_encoder_cleanup(struct drm_encoder *encoder);
897 
898 extern char *drm_get_connector_name(struct drm_connector *connector);
899 extern char *drm_get_dpms_name(int val);
900 extern char *drm_get_dvi_i_subconnector_name(int val);
901 extern char *drm_get_dvi_i_select_name(int val);
902 extern char *drm_get_tv_subconnector_name(int val);
903 extern char *drm_get_tv_select_name(int val);
904 extern void drm_fb_release(struct drm_file *file_priv);
905 extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
906 extern bool drm_probe_ddc(device_t adapter);
907 extern struct edid *drm_get_edid(struct drm_connector *connector,
908 				 device_t adapter);
909 extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
910 extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
911 extern void drm_mode_remove(struct drm_connector *connector, struct drm_display_mode *mode);
912 extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src);
913 extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
914 						   const struct drm_display_mode *mode);
915 extern void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
916 extern void drm_mode_config_init(struct drm_device *dev);
917 extern void drm_mode_config_reset(struct drm_device *dev);
918 extern void drm_mode_config_cleanup(struct drm_device *dev);
919 extern void drm_mode_set_name(struct drm_display_mode *mode);
920 extern bool drm_mode_equal(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
921 extern bool drm_mode_equal_no_clocks(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
922 extern int drm_mode_width(const struct drm_display_mode *mode);
923 extern int drm_mode_height(const struct drm_display_mode *mode);
924 
925 /* for us by fb module */
926 extern struct drm_display_mode *drm_mode_create(struct drm_device *dev);
927 extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
928 extern void drm_mode_list_concat(struct list_head *head,
929 				 struct list_head *new);
930 extern void drm_mode_validate_size(struct drm_device *dev,
931 				   struct list_head *mode_list,
932 				   int maxX, int maxY, int maxPitch);
933 extern void drm_mode_validate_clocks(struct drm_device *dev,
934 				     struct list_head *mode_list,
935 				     int *min, int *max, int n_ranges);
936 extern void drm_mode_prune_invalid(struct drm_device *dev,
937 				   struct list_head *mode_list, bool verbose);
938 extern void drm_mode_sort(struct list_head *mode_list);
939 extern int drm_mode_hsync(const struct drm_display_mode *mode);
940 extern int drm_mode_vrefresh(const struct drm_display_mode *mode);
941 extern void drm_mode_set_crtcinfo(struct drm_display_mode *p,
942 				  int adjust_flags);
943 extern void drm_mode_connector_list_update(struct drm_connector *connector);
944 extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
945 						struct edid *edid);
946 extern int drm_object_property_set_value(struct drm_mode_object *obj,
947 					 struct drm_property *property,
948 					 uint64_t val);
949 extern int drm_object_property_get_value(struct drm_mode_object *obj,
950 					 struct drm_property *property,
951 					 uint64_t *value);
952 extern struct drm_display_mode *drm_crtc_mode_create(struct drm_device *dev);
953 extern void drm_framebuffer_set_object(struct drm_device *dev,
954 				       unsigned long handle);
955 extern int drm_framebuffer_init(struct drm_device *dev,
956 				struct drm_framebuffer *fb,
957 				const struct drm_framebuffer_funcs *funcs);
958 extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
959 						      uint32_t id);
960 extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
961 extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
962 extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
963 extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
964 extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
965 extern int drmfb_probe(struct drm_device *dev, struct drm_crtc *crtc);
966 extern int drmfb_remove(struct drm_device *dev, struct drm_framebuffer *fb);
967 extern void drm_crtc_probe_connector_modes(struct drm_device *dev, int maxX, int maxY);
968 extern bool drm_crtc_in_use(struct drm_crtc *crtc);
969 
970 extern void drm_object_attach_property(struct drm_mode_object *obj,
971 				       struct drm_property *property,
972 				       uint64_t init_val);
973 extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
974 						const char *name, int num_values);
975 extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
976 					 const char *name,
977 					 const struct drm_prop_enum_list *props,
978 					 int num_values);
979 struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
980 					 int flags, const char *name,
981 					 const struct drm_prop_enum_list *props,
982 					 int num_values);
983 struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
984 					 const char *name,
985 					 uint64_t min, uint64_t max);
986 extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
987 extern int drm_property_add_enum(struct drm_property *property, int index,
988 				 uint64_t value, const char *name);
989 extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
990 extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
991 				     char *formats[]);
992 extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
993 extern int drm_mode_create_dithering_property(struct drm_device *dev);
994 extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
995 extern char *drm_get_encoder_name(struct drm_encoder *encoder);
996 
997 extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
998 					     struct drm_encoder *encoder);
999 extern void drm_mode_connector_detach_encoder(struct drm_connector *connector,
1000 					   struct drm_encoder *encoder);
1001 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
1002 					 int gamma_size);
1003 extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1004 		uint32_t id, uint32_t type);
1005 /* IOCTLs */
1006 extern int drm_mode_getresources(struct drm_device *dev,
1007 				 void *data, struct drm_file *file_priv);
1008 extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1009 				   struct drm_file *file_priv);
1010 extern int drm_mode_getcrtc(struct drm_device *dev,
1011 			    void *data, struct drm_file *file_priv);
1012 extern int drm_mode_getconnector(struct drm_device *dev,
1013 			      void *data, struct drm_file *file_priv);
1014 extern int drm_mode_set_config_internal(struct drm_mode_set *set);
1015 extern int drm_mode_setcrtc(struct drm_device *dev,
1016 			    void *data, struct drm_file *file_priv);
1017 extern int drm_mode_getplane(struct drm_device *dev,
1018 			       void *data, struct drm_file *file_priv);
1019 extern int drm_mode_setplane(struct drm_device *dev,
1020 			       void *data, struct drm_file *file_priv);
1021 extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1022 				void *data, struct drm_file *file_priv);
1023 extern int drm_mode_addfb(struct drm_device *dev,
1024 			  void *data, struct drm_file *file_priv);
1025 extern int drm_mode_addfb2(struct drm_device *dev,
1026 			   void *data, struct drm_file *file_priv);
1027 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1028 extern int drm_mode_rmfb(struct drm_device *dev,
1029 			 void *data, struct drm_file *file_priv);
1030 extern int drm_mode_getfb(struct drm_device *dev,
1031 			  void *data, struct drm_file *file_priv);
1032 extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1033 				  void *data, struct drm_file *file_priv);
1034 
1035 extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1036 				      void *data, struct drm_file *file_priv);
1037 extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1038 				  void *data, struct drm_file *file_priv);
1039 extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1040 					      void *data, struct drm_file *file_priv);
1041 extern int drm_mode_hotplug_ioctl(struct drm_device *dev,
1042 				  void *data, struct drm_file *file_priv);
1043 extern int drm_mode_replacefb(struct drm_device *dev,
1044 			      void *data, struct drm_file *file_priv);
1045 extern int drm_mode_getencoder(struct drm_device *dev,
1046 			       void *data, struct drm_file *file_priv);
1047 extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1048 				    void *data, struct drm_file *file_priv);
1049 extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1050 				    void *data, struct drm_file *file_priv);
1051 extern u8 *drm_find_cea_extension(struct edid *edid);
1052 extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1053 extern bool drm_detect_hdmi_monitor(struct edid *edid);
1054 extern bool drm_detect_monitor_audio(struct edid *edid);
1055 extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1056 extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1057 				    void *data, struct drm_file *file_priv);
1058 extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
1059 				int hdisplay, int vdisplay, int vrefresh,
1060 				bool reduced, bool interlaced, bool margins);
1061 extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
1062 				int hdisplay, int vdisplay, int vrefresh,
1063 				bool interlaced, int margins);
1064 extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
1065 				int hdisplay, int vdisplay, int vrefresh,
1066 				bool interlaced, int margins, int GTF_M,
1067 				int GTF_2C, int GTF_K, int GTF_2J);
1068 extern int drm_add_modes_noedid(struct drm_connector *connector,
1069 				int hdisplay, int vdisplay);
1070 
1071 extern int drm_edid_header_is_valid(const u8 *raw_edid);
1072 extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1073 extern bool drm_edid_is_valid(struct edid *edid);
1074 struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1075 					   int hsize, int vsize, int fresh,
1076 					   bool rb);
1077 
1078 extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1079 				      void *data, struct drm_file *file_priv);
1080 extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1081 				    void *data, struct drm_file *file_priv);
1082 extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1083 				      void *data, struct drm_file *file_priv);
1084 extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1085 					     struct drm_file *file_priv);
1086 extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1087 					   struct drm_file *file_priv);
1088 
1089 extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1090 				 int *bpp);
1091 extern int drm_format_num_planes(uint32_t format);
1092 extern int drm_format_plane_cpp(uint32_t format, int plane);
1093 extern int drm_format_horz_chroma_subsampling(uint32_t format);
1094 extern int drm_format_vert_chroma_subsampling(uint32_t format);
1095 
1096 #endif /* __DRM_CRTC_H__ */
1097