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