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