blob: 71727b6210ae57d5b064be1cab19a4dc660df6f8 [file] [log] [blame]
Dave Airlief453ba02008-11-07 14:05:41 -08001/*
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>
Dave Airlief453ba02008-11-07 14:05:41 -080032#include <linux/fb.h>
Vandana Kannan985e5dc2013-12-19 15:34:07 +053033#include <linux/hdmi.h>
David Howells19218e42012-10-02 18:01:03 +010034#include <drm/drm_mode.h>
Dave Airlief453ba02008-11-07 14:05:41 -080035
Jesse Barnes308e5bc2011-11-14 14:51:28 -080036#include <drm/drm_fourcc.h>
37
Dave Airlief453ba02008-11-07 14:05:41 -080038struct drm_device;
39struct drm_mode_set;
40struct drm_framebuffer;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030041struct drm_object_properties;
Thierry Reding595887e2012-11-21 15:00:47 +010042struct drm_file;
43struct drm_clip_rect;
Dave Airlief453ba02008-11-07 14:05:41 -080044
45#define DRM_MODE_OBJECT_CRTC 0xcccccccc
46#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
47#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
48#define DRM_MODE_OBJECT_MODE 0xdededede
49#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
50#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
51#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
Jesse Barnes8cf5c912011-11-14 14:51:27 -080052#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
Sean Paul3b336ec2013-08-14 16:47:37 -040053#define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
Dave Airlief453ba02008-11-07 14:05:41 -080054
55struct drm_mode_object {
56 uint32_t id;
57 uint32_t type;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030058 struct drm_object_properties *properties;
59};
60
Paulo Zanonife456162012-06-12 11:27:01 -030061#define DRM_OBJECT_MAX_PROPERTY 24
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030062struct drm_object_properties {
Paulo Zanoni7f88a9b2012-05-15 18:09:04 -030063 int count;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030064 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
65 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
Dave Airlief453ba02008-11-07 14:05:41 -080066};
67
68/*
69 * Note on terminology: here, for brevity and convenience, we refer to connector
70 * control chips as 'CRTCs'. They can control any type of connector, VGA, LVDS,
71 * DVI, etc. And 'screen' refers to the whole of the visible display, which
72 * may span multiple monitors (and therefore multiple CRTC and connector
73 * structures).
74 */
75
76enum drm_mode_status {
77 MODE_OK = 0, /* Mode OK */
78 MODE_HSYNC, /* hsync out of range */
79 MODE_VSYNC, /* vsync out of range */
80 MODE_H_ILLEGAL, /* mode has illegal horizontal timings */
81 MODE_V_ILLEGAL, /* mode has illegal horizontal timings */
82 MODE_BAD_WIDTH, /* requires an unsupported linepitch */
Lucas De Marchi25985ed2011-03-30 22:57:33 -030083 MODE_NOMODE, /* no mode with a matching name */
Dave Airlief453ba02008-11-07 14:05:41 -080084 MODE_NO_INTERLACE, /* interlaced mode not supported */
85 MODE_NO_DBLESCAN, /* doublescan mode not supported */
86 MODE_NO_VSCAN, /* multiscan mode not supported */
87 MODE_MEM, /* insufficient video memory */
88 MODE_VIRTUAL_X, /* mode width too large for specified virtual size */
89 MODE_VIRTUAL_Y, /* mode height too large for specified virtual size */
90 MODE_MEM_VIRT, /* insufficient video memory given virtual size */
91 MODE_NOCLOCK, /* no fixed clock available */
92 MODE_CLOCK_HIGH, /* clock required is too high */
93 MODE_CLOCK_LOW, /* clock required is too low */
94 MODE_CLOCK_RANGE, /* clock/mode isn't in a ClockRange */
95 MODE_BAD_HVALUE, /* horizontal timing was out of range */
96 MODE_BAD_VVALUE, /* vertical timing was out of range */
97 MODE_BAD_VSCAN, /* VScan value out of range */
98 MODE_HSYNC_NARROW, /* horizontal sync too narrow */
99 MODE_HSYNC_WIDE, /* horizontal sync too wide */
100 MODE_HBLANK_NARROW, /* horizontal blanking too narrow */
101 MODE_HBLANK_WIDE, /* horizontal blanking too wide */
102 MODE_VSYNC_NARROW, /* vertical sync too narrow */
103 MODE_VSYNC_WIDE, /* vertical sync too wide */
104 MODE_VBLANK_NARROW, /* vertical blanking too narrow */
105 MODE_VBLANK_WIDE, /* vertical blanking too wide */
106 MODE_PANEL, /* exceeds panel dimensions */
107 MODE_INTERLACE_WIDTH, /* width too large for interlaced mode */
108 MODE_ONE_WIDTH, /* only one width is supported */
109 MODE_ONE_HEIGHT, /* only one height is supported */
110 MODE_ONE_SIZE, /* only one resolution is supported */
111 MODE_NO_REDUCED, /* monitor doesn't accept reduced blanking */
Damien Lespiau560a0672013-09-25 16:45:29 +0100112 MODE_NO_STEREO, /* stereo modes not supported */
Dave Airlief453ba02008-11-07 14:05:41 -0800113 MODE_UNVERIFIED = -3, /* mode needs to reverified */
114 MODE_BAD = -2, /* unspecified reason */
115 MODE_ERROR = -1 /* error condition */
116};
117
118#define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
119 DRM_MODE_TYPE_CRTC_C)
120
121#define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
122 .name = nm, .status = 0, .type = (t), .clock = (c), \
123 .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
124 .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
125 .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
Ville Syrjälä67af1162013-04-24 19:07:15 +0300126 .vscan = (vs), .flags = (f), \
Ville Syrjälä22f5d112012-08-14 10:53:38 +0000127 .base.type = DRM_MODE_OBJECT_MODE
Dave Airlief453ba02008-11-07 14:05:41 -0800128
Damien Lespiau448cce22013-09-25 16:45:35 +0100129#define CRTC_INTERLACE_HALVE_V (1 << 0) /* halve V values for interlacing */
130#define CRTC_STEREO_DOUBLE (1 << 1) /* adjust timings for stereo modes */
Dave Airlief453ba02008-11-07 14:05:41 -0800131
Damien Lespiau5848ad42013-09-27 12:11:50 +0100132#define DRM_MODE_FLAG_3D_MAX DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF
133
Dave Airlief453ba02008-11-07 14:05:41 -0800134struct drm_display_mode {
135 /* Header */
136 struct list_head head;
137 struct drm_mode_object base;
138
139 char name[DRM_DISPLAY_MODE_LEN];
140
Dave Airlief453ba02008-11-07 14:05:41 -0800141 enum drm_mode_status status;
Ville Syrjälä2fcfc752012-03-13 12:35:39 +0200142 unsigned int type;
Dave Airlief453ba02008-11-07 14:05:41 -0800143
144 /* Proposed mode values */
Adam Jackson7ac96a92009-12-03 17:44:37 -0500145 int clock; /* in kHz */
Dave Airlief453ba02008-11-07 14:05:41 -0800146 int hdisplay;
147 int hsync_start;
148 int hsync_end;
149 int htotal;
150 int hskew;
151 int vdisplay;
152 int vsync_start;
153 int vsync_end;
154 int vtotal;
155 int vscan;
156 unsigned int flags;
157
158 /* Addressable image size (may be 0 for projectors, etc.) */
159 int width_mm;
160 int height_mm;
161
162 /* Actual mode we give to hw */
Damien Lespiaubde2dcf2013-09-25 16:45:34 +0100163 int crtc_clock; /* in KHz */
Dave Airlief453ba02008-11-07 14:05:41 -0800164 int crtc_hdisplay;
165 int crtc_hblank_start;
166 int crtc_hblank_end;
167 int crtc_hsync_start;
168 int crtc_hsync_end;
169 int crtc_htotal;
170 int crtc_hskew;
171 int crtc_vdisplay;
172 int crtc_vblank_start;
173 int crtc_vblank_end;
174 int crtc_vsync_start;
175 int crtc_vsync_end;
176 int crtc_vtotal;
Dave Airlief453ba02008-11-07 14:05:41 -0800177
178 /* Driver private mode info */
179 int private_size;
180 int *private;
181 int private_flags;
182
Adam Jackson7ac96a92009-12-03 17:44:37 -0500183 int vrefresh; /* in Hz */
184 int hsync; /* in kHz */
Vandana Kannan985e5dc2013-12-19 15:34:07 +0530185 enum hdmi_picture_aspect picture_aspect_ratio;
Dave Airlief453ba02008-11-07 14:05:41 -0800186};
187
Damien Lespiau4aa17cf2013-09-25 16:45:21 +0100188static inline bool drm_mode_is_stereo(const struct drm_display_mode *mode)
189{
190 return mode->flags & DRM_MODE_FLAG_3D_MASK;
191}
192
Dave Airlief453ba02008-11-07 14:05:41 -0800193enum drm_connector_status {
194 connector_status_connected = 1,
195 connector_status_disconnected = 2,
196 connector_status_unknown = 3,
197};
198
199enum subpixel_order {
200 SubPixelUnknown = 0,
201 SubPixelHorizontalRGB,
202 SubPixelHorizontalBGR,
203 SubPixelVerticalRGB,
204 SubPixelVerticalBGR,
205 SubPixelNone,
206};
207
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700208#define DRM_COLOR_FORMAT_RGB444 (1<<0)
209#define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
210#define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
Dave Airlief453ba02008-11-07 14:05:41 -0800211/*
212 * Describes a given display (e.g. CRT or flat panel) and its limitations.
213 */
214struct drm_display_info {
215 char name[DRM_DISPLAY_INFO_LEN];
Adam Jacksonfb439642010-08-03 14:38:16 -0400216
Dave Airlief453ba02008-11-07 14:05:41 -0800217 /* Physical size */
218 unsigned int width_mm;
219 unsigned int height_mm;
220
Dave Airlief453ba02008-11-07 14:05:41 -0800221 /* Clock limits FIXME: storage format */
222 unsigned int min_vfreq, max_vfreq;
223 unsigned int min_hfreq, max_hfreq;
224 unsigned int pixel_clock;
Jesse Barnes3b112282011-04-15 12:49:23 -0700225 unsigned int bpc;
Dave Airlief453ba02008-11-07 14:05:41 -0800226
Dave Airlief453ba02008-11-07 14:05:41 -0800227 enum subpixel_order subpixel_order;
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700228 u32 color_formats;
Dave Airlief453ba02008-11-07 14:05:41 -0800229
Jesse Barnesebec9a72011-08-03 09:22:54 -0700230 u8 cea_rev;
Dave Airlief453ba02008-11-07 14:05:41 -0800231};
232
233struct drm_framebuffer_funcs {
Rob Clarkf7eff602012-09-05 21:48:38 +0000234 /* note: use drm_framebuffer_remove() */
Dave Airlief453ba02008-11-07 14:05:41 -0800235 void (*destroy)(struct drm_framebuffer *framebuffer);
236 int (*create_handle)(struct drm_framebuffer *fb,
237 struct drm_file *file_priv,
238 unsigned int *handle);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000239 /**
240 * Optinal callback for the dirty fb ioctl.
241 *
242 * Userspace can notify the driver via this callback
243 * that a area of the framebuffer has changed and should
244 * be flushed to the display hardware.
245 *
246 * See documentation in drm_mode.h for the struct
247 * drm_mode_fb_dirty_cmd for more information as all
248 * the semantics and arguments have a one to one mapping
249 * on this function.
250 */
Thomas Hellstrom02b00162010-10-05 12:43:02 +0200251 int (*dirty)(struct drm_framebuffer *framebuffer,
252 struct drm_file *file_priv, unsigned flags,
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000253 unsigned color, struct drm_clip_rect *clips,
254 unsigned num_clips);
Dave Airlief453ba02008-11-07 14:05:41 -0800255};
256
257struct drm_framebuffer {
258 struct drm_device *dev;
Rob Clarkf7eff602012-09-05 21:48:38 +0000259 /*
260 * Note that the fb is refcounted for the benefit of driver internals,
261 * for example some hw, disabling a CRTC/plane is asynchronous, and
262 * scanout does not actually complete until the next vblank. So some
263 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
264 * should be deferred. In cases like this, the driver would like to
265 * hold a ref to the fb even though it has already been removed from
266 * userspace perspective.
267 */
268 struct kref refcount;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100269 /*
270 * Place on the dev->mode_config.fb_list, access protected by
271 * dev->mode_config.fb_lock.
272 */
Dave Airlief453ba02008-11-07 14:05:41 -0800273 struct list_head head;
274 struct drm_mode_object base;
275 const struct drm_framebuffer_funcs *funcs;
Ville Syrjälä01f2c772011-12-20 00:06:49 +0200276 unsigned int pitches[4];
277 unsigned int offsets[4];
Dave Airlief453ba02008-11-07 14:05:41 -0800278 unsigned int width;
279 unsigned int height;
280 /* depth can be 15 or 16 */
281 unsigned int depth;
282 int bits_per_pixel;
283 int flags;
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800284 uint32_t pixel_format; /* fourcc format */
Dave Airlief453ba02008-11-07 14:05:41 -0800285 struct list_head filp_head;
Dave Airlie785b93e2009-08-28 15:46:53 +1000286 /* if you are using the helper */
287 void *helper_private;
Dave Airlief453ba02008-11-07 14:05:41 -0800288};
289
290struct drm_property_blob {
291 struct drm_mode_object base;
292 struct list_head head;
293 unsigned int length;
Ville Syrjäläd63f5e62012-03-13 12:35:49 +0200294 unsigned char data[];
Dave Airlief453ba02008-11-07 14:05:41 -0800295};
296
297struct drm_property_enum {
298 uint64_t value;
299 struct list_head head;
300 char name[DRM_PROP_NAME_LEN];
301};
302
303struct drm_property {
304 struct list_head head;
305 struct drm_mode_object base;
306 uint32_t flags;
307 char name[DRM_PROP_NAME_LEN];
308 uint32_t num_values;
309 uint64_t *values;
310
311 struct list_head enum_blob_list;
312};
313
314struct drm_crtc;
315struct drm_connector;
316struct drm_encoder;
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500317struct drm_pending_vblank_event;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800318struct drm_plane;
Sean Paul3b336ec2013-08-14 16:47:37 -0400319struct drm_bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800320
321/**
322 * drm_crtc_funcs - control CRTCs for a given device
Dave Airlief453ba02008-11-07 14:05:41 -0800323 * @save: save CRTC state
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200324 * @restore: restore CRTC state
Christopher Harvey715f59c2013-04-05 15:28:32 +0000325 * @reset: reset CRTC after state has been invalidated (e.g. resume)
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200326 * @cursor_set: setup the cursor
327 * @cursor_move: move the cursor
Dave Airlief453ba02008-11-07 14:05:41 -0800328 * @gamma_set: specify color ramp for CRTC
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300329 * @destroy: deinit and free object
330 * @set_property: called when a property is changed
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200331 * @set_config: apply a new CRTC configuration
332 * @page_flip: initiate a page flip
Dave Airlief453ba02008-11-07 14:05:41 -0800333 *
334 * The drm_crtc_funcs structure is the central CRTC management structure
335 * in the DRM. Each CRTC controls one or more connectors (note that the name
336 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
337 * connectors, not just CRTs).
338 *
339 * Each driver is responsible for filling out this structure at startup time,
340 * in addition to providing other modesetting features, like i2c and DDC
341 * bus accessors.
342 */
343struct drm_crtc_funcs {
344 /* Save CRTC state */
345 void (*save)(struct drm_crtc *crtc); /* suspend? */
346 /* Restore CRTC state */
347 void (*restore)(struct drm_crtc *crtc); /* resume? */
Chris Wilsoneb033552011-01-24 15:11:08 +0000348 /* Reset CRTC state */
349 void (*reset)(struct drm_crtc *crtc);
Dave Airlief453ba02008-11-07 14:05:41 -0800350
351 /* cursor controls */
352 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
353 uint32_t handle, uint32_t width, uint32_t height);
Dave Airlie4c813d42013-06-20 11:48:52 +1000354 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
355 uint32_t handle, uint32_t width, uint32_t height,
356 int32_t hot_x, int32_t hot_y);
Dave Airlief453ba02008-11-07 14:05:41 -0800357 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
358
359 /* Set gamma on the CRTC */
360 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
James Simmons72034252010-08-03 01:33:19 +0100361 uint32_t start, uint32_t size);
Dave Airlief453ba02008-11-07 14:05:41 -0800362 /* Object destroy routine */
363 void (*destroy)(struct drm_crtc *crtc);
364
365 int (*set_config)(struct drm_mode_set *set);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500366
367 /*
368 * Flip to the given framebuffer. This implements the page
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300369 * flip ioctl described in drm_mode.h, specifically, the
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500370 * implementation must return immediately and block all
371 * rendering to the current fb until the flip has completed.
372 * If userspace set the event flag in the ioctl, the event
373 * argument will point to an event to send back when the flip
374 * completes, otherwise it will be NULL.
375 */
376 int (*page_flip)(struct drm_crtc *crtc,
377 struct drm_framebuffer *fb,
Keith Packarded8d1972013-07-22 18:49:58 -0700378 struct drm_pending_vblank_event *event,
379 uint32_t flags);
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300380
381 int (*set_property)(struct drm_crtc *crtc,
382 struct drm_property *property, uint64_t val);
Dave Airlief453ba02008-11-07 14:05:41 -0800383};
384
385/**
386 * drm_crtc - central CRTC control structure
Jesse Barnes77491632011-11-07 12:03:14 -0800387 * @dev: parent DRM device
388 * @head: list management
389 * @base: base KMS object for ID tracking etc.
Dave Airlief453ba02008-11-07 14:05:41 -0800390 * @enabled: is this CRTC enabled?
Jesse Barnes77491632011-11-07 12:03:14 -0800391 * @mode: current mode timings
392 * @hwmode: mode timings as programmed to hw regs
Rob Clark7c80e122012-09-04 16:35:56 +0000393 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
394 * invert the width/height of the crtc. This is used if the driver
395 * is performing 90 or 270 degree rotated scanout
Dave Airlief453ba02008-11-07 14:05:41 -0800396 * @x: x position on screen
397 * @y: y position on screen
Dave Airlief453ba02008-11-07 14:05:41 -0800398 * @funcs: CRTC control functions
Jesse Barnes77491632011-11-07 12:03:14 -0800399 * @gamma_size: size of gamma ramp
400 * @gamma_store: gamma ramp values
401 * @framedur_ns: precise frame timing
402 * @framedur_ns: precise line timing
403 * @pixeldur_ns: precise pixel timing
404 * @helper_private: mid-layer private data
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300405 * @properties: property tracking for this CRTC
Dave Airlief453ba02008-11-07 14:05:41 -0800406 *
407 * Each CRTC may have one or more connectors associated with it. This structure
408 * allows the CRTC to be controlled.
409 */
410struct drm_crtc {
411 struct drm_device *dev;
412 struct list_head head;
413
Daniel Vetter29494c12012-12-02 02:18:25 +0100414 /**
415 * crtc mutex
416 *
417 * This provides a read lock for the overall crtc state (mode, dpms
418 * state, ...) and a write lock for everything which can be update
419 * without a full modeset (fb, cursor data, ...)
420 */
421 struct mutex mutex;
422
Dave Airlief453ba02008-11-07 14:05:41 -0800423 struct drm_mode_object base;
424
425 /* framebuffer the connector is currently bound to */
426 struct drm_framebuffer *fb;
427
Daniel Vetter5cef29a2013-06-15 00:13:16 +0200428 /* Temporary tracking of the old fb while a modeset is ongoing. Used
429 * by drm_mode_set_config_internal to implement correct refcounting. */
430 struct drm_framebuffer *old_fb;
431
Dave Airlief453ba02008-11-07 14:05:41 -0800432 bool enabled;
433
Mario Kleiner27641c32010-10-23 04:20:23 +0200434 /* Requested mode from modesetting. */
Dave Airlief453ba02008-11-07 14:05:41 -0800435 struct drm_display_mode mode;
436
Mario Kleiner27641c32010-10-23 04:20:23 +0200437 /* Programmed mode in hw, after adjustments for encoders,
438 * crtc, panel scaling etc. Needed for timestamping etc.
439 */
440 struct drm_display_mode hwmode;
441
Rob Clark7c80e122012-09-04 16:35:56 +0000442 bool invert_dimensions;
443
Dave Airlief453ba02008-11-07 14:05:41 -0800444 int x, y;
Dave Airlief453ba02008-11-07 14:05:41 -0800445 const struct drm_crtc_funcs *funcs;
446
447 /* CRTC gamma size for reporting to userspace */
448 uint32_t gamma_size;
449 uint16_t *gamma_store;
450
Mario Kleiner27641c32010-10-23 04:20:23 +0200451 /* Constants needed for precise vblank and swap timestamping. */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300452 int framedur_ns, linedur_ns, pixeldur_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200453
Dave Airlief453ba02008-11-07 14:05:41 -0800454 /* if you are using the helper */
455 void *helper_private;
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300456
457 struct drm_object_properties properties;
Dave Airlief453ba02008-11-07 14:05:41 -0800458};
459
460
461/**
462 * drm_connector_funcs - control connectors on a given device
463 * @dpms: set power state (see drm_crtc_funcs above)
464 * @save: save connector state
465 * @restore: restore connector state
Christopher Harvey13bcf012013-03-07 10:42:25 -0500466 * @reset: reset connector after state has been invalidated (e.g. resume)
Dave Airlief453ba02008-11-07 14:05:41 -0800467 * @detect: is this connector active?
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200468 * @fill_modes: fill mode list for this connector
Christopher Harvey13bcf012013-03-07 10:42:25 -0500469 * @set_property: property for this connector may need an update
Dave Airlief453ba02008-11-07 14:05:41 -0800470 * @destroy: make object go away
Christopher Harvey13bcf012013-03-07 10:42:25 -0500471 * @force: notify the driver that the connector is forced on
Dave Airlief453ba02008-11-07 14:05:41 -0800472 *
473 * Each CRTC may have one or more connectors attached to it. The functions
474 * below allow the core DRM code to control connectors, enumerate available modes,
475 * etc.
476 */
477struct drm_connector_funcs {
478 void (*dpms)(struct drm_connector *connector, int mode);
479 void (*save)(struct drm_connector *connector);
480 void (*restore)(struct drm_connector *connector);
Chris Wilsoneb033552011-01-24 15:11:08 +0000481 void (*reset)(struct drm_connector *connector);
Chris Wilson930a9e22010-09-14 11:07:23 +0100482
483 /* Check to see if anything is attached to the connector.
484 * @force is set to false whilst polling, true when checking the
485 * connector due to user request. @force can be used by the driver
486 * to avoid expensive, destructive operations during automated
487 * probing.
488 */
Chris Wilson7b334fc2010-09-09 23:51:02 +0100489 enum drm_connector_status (*detect)(struct drm_connector *connector,
Chris Wilson930a9e22010-09-14 11:07:23 +0100490 bool force);
Jesse Barnes40a518d2009-01-12 12:05:32 -0800491 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
Dave Airlief453ba02008-11-07 14:05:41 -0800492 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
493 uint64_t val);
494 void (*destroy)(struct drm_connector *connector);
Dave Airlied50ba252009-09-23 14:44:08 +1000495 void (*force)(struct drm_connector *connector);
Dave Airlief453ba02008-11-07 14:05:41 -0800496};
497
Jesse Barnes6c3db922011-11-07 12:03:16 -0800498/**
499 * drm_encoder_funcs - encoder controls
500 * @reset: reset state (e.g. at init or resume time)
501 * @destroy: cleanup and free associated data
502 *
503 * Encoders sit between CRTCs and connectors.
504 */
Dave Airlief453ba02008-11-07 14:05:41 -0800505struct drm_encoder_funcs {
Chris Wilsoneb033552011-01-24 15:11:08 +0000506 void (*reset)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800507 void (*destroy)(struct drm_encoder *encoder);
508};
509
Ben Skeggsafe887d2012-01-12 16:00:57 +1000510#define DRM_CONNECTOR_MAX_ENCODER 3
Dave Airlief453ba02008-11-07 14:05:41 -0800511
512/**
513 * drm_encoder - central DRM encoder structure
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800514 * @dev: parent DRM device
515 * @head: list management
516 * @base: base KMS object
517 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
518 * @possible_crtcs: bitmask of potential CRTC bindings
519 * @possible_clones: bitmask of potential sibling encoders for cloning
520 * @crtc: currently bound CRTC
Sean Paul3b336ec2013-08-14 16:47:37 -0400521 * @bridge: bridge associated to the encoder
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800522 * @funcs: control functions
523 * @helper_private: mid-layer private data
524 *
525 * CRTCs drive pixels to encoders, which convert them into signals
526 * appropriate for a given connector or set of connectors.
Dave Airlief453ba02008-11-07 14:05:41 -0800527 */
528struct drm_encoder {
529 struct drm_device *dev;
530 struct list_head head;
531
532 struct drm_mode_object base;
533 int encoder_type;
534 uint32_t possible_crtcs;
535 uint32_t possible_clones;
536
537 struct drm_crtc *crtc;
Sean Paul3b336ec2013-08-14 16:47:37 -0400538 struct drm_bridge *bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800539 const struct drm_encoder_funcs *funcs;
540 void *helper_private;
541};
542
Dave Airlied50ba252009-09-23 14:44:08 +1000543enum drm_connector_force {
544 DRM_FORCE_UNSPECIFIED,
545 DRM_FORCE_OFF,
546 DRM_FORCE_ON, /* force on analog part normally */
547 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
548};
549
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000550/* should we poll this connector for connects and disconnects */
551/* hot plug detectable */
552#define DRM_CONNECTOR_POLL_HPD (1 << 0)
553/* poll for connections */
554#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
555/* can cleanly poll for disconnections without flickering the screen */
556/* DACs should rarely do this without a lot of testing */
557#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
558
Wu Fengguang76adaa342011-09-05 14:23:20 +0800559#define MAX_ELD_BYTES 128
560
Dave Airlief453ba02008-11-07 14:05:41 -0800561/**
562 * drm_connector - central DRM connector control structure
Jesse Barnes72252542011-11-07 12:03:18 -0800563 * @dev: parent DRM device
564 * @kdev: kernel device for sysfs attributes
565 * @attr: sysfs attributes
566 * @head: list management
567 * @base: base KMS object
568 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
569 * @connector_type_id: index into connector type enum
Dave Airlief453ba02008-11-07 14:05:41 -0800570 * @interlace_allowed: can this connector handle interlaced modes?
571 * @doublescan_allowed: can this connector handle doublescan?
Jesse Barnes72252542011-11-07 12:03:18 -0800572 * @modes: modes available on this connector (from fill_modes() + user)
573 * @status: one of the drm_connector_status enums (connected, not, or unknown)
574 * @probed_modes: list of modes derived directly from the display
575 * @display_info: information about attached display (e.g. from EDID)
Dave Airlief453ba02008-11-07 14:05:41 -0800576 * @funcs: connector control functions
Jesse Barnes72252542011-11-07 12:03:18 -0800577 * @edid_blob_ptr: DRM property containing EDID if present
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300578 * @properties: property tracking for this connector
Jesse Barnes72252542011-11-07 12:03:18 -0800579 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
580 * @dpms: current dpms state
581 * @helper_private: mid-layer private data
582 * @force: a %DRM_FORCE_<foo> state for forced mode sets
583 * @encoder_ids: valid encoders for this connector
584 * @encoder: encoder driving this connector, if any
585 * @eld: EDID-like data, if present
586 * @dvi_dual: dual link DVI, if found
587 * @max_tmds_clock: max clock rate, if found
588 * @latency_present: AV delay info from ELD, if found
589 * @video_latency: video latency info from ELD, if found
590 * @audio_latency: audio latency info from ELD, if found
591 * @null_edid_counter: track sinks that give us all zeros for the EDID
Dave Airlief453ba02008-11-07 14:05:41 -0800592 *
593 * Each connector may be connected to one or more CRTCs, or may be clonable by
594 * another connector if they can share a CRTC. Each connector also has a specific
595 * position in the broader display (referred to as a 'screen' though it could
596 * span multiple monitors).
597 */
598struct drm_connector {
599 struct drm_device *dev;
Dave Airlie5bdebb12013-10-11 14:07:25 +1000600 struct device *kdev;
Dave Airlief453ba02008-11-07 14:05:41 -0800601 struct device_attribute *attr;
602 struct list_head head;
603
604 struct drm_mode_object base;
605
606 int connector_type;
607 int connector_type_id;
608 bool interlace_allowed;
609 bool doublescan_allowed;
Damien Lespiau560a0672013-09-25 16:45:29 +0100610 bool stereo_allowed;
Dave Airlief453ba02008-11-07 14:05:41 -0800611 struct list_head modes; /* list of modes on this connector */
612
Dave Airlief453ba02008-11-07 14:05:41 -0800613 enum drm_connector_status status;
614
615 /* these are modes added by probing with DDC or the BIOS */
616 struct list_head probed_modes;
617
618 struct drm_display_info display_info;
619 const struct drm_connector_funcs *funcs;
620
Dave Airlief453ba02008-11-07 14:05:41 -0800621 struct drm_property_blob *edid_blob_ptr;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300622 struct drm_object_properties properties;
Dave Airlief453ba02008-11-07 14:05:41 -0800623
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000624 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
625
Keith Packardc9fb15f2009-05-30 20:42:28 -0700626 /* requested DPMS state */
627 int dpms;
628
Dave Airlief453ba02008-11-07 14:05:41 -0800629 void *helper_private;
630
Dave Airlied50ba252009-09-23 14:44:08 +1000631 /* forced on connector */
632 enum drm_connector_force force;
Dave Airlief453ba02008-11-07 14:05:41 -0800633 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
Dave Airlief453ba02008-11-07 14:05:41 -0800634 struct drm_encoder *encoder; /* currently active encoder */
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000635
Wu Fengguang76adaa342011-09-05 14:23:20 +0800636 /* EDID bits */
637 uint8_t eld[MAX_ELD_BYTES];
638 bool dvi_dual;
639 int max_tmds_clock; /* in MHz */
640 bool latency_present[2];
641 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
642 int audio_latency[2];
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000643 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
Jerome Glisse0b2443e2012-08-09 11:25:51 -0400644 unsigned bad_edid_counter;
Dave Airlief453ba02008-11-07 14:05:41 -0800645};
646
647/**
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800648 * drm_plane_funcs - driver plane control functions
649 * @update_plane: update the plane configuration
650 * @disable_plane: shut down the plane
651 * @destroy: clean up plane resources
Rob Clark4d939142012-05-17 02:23:27 -0600652 * @set_property: called when a property is changed
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800653 */
654struct drm_plane_funcs {
655 int (*update_plane)(struct drm_plane *plane,
656 struct drm_crtc *crtc, struct drm_framebuffer *fb,
657 int crtc_x, int crtc_y,
658 unsigned int crtc_w, unsigned int crtc_h,
659 uint32_t src_x, uint32_t src_y,
660 uint32_t src_w, uint32_t src_h);
661 int (*disable_plane)(struct drm_plane *plane);
662 void (*destroy)(struct drm_plane *plane);
Rob Clark4d939142012-05-17 02:23:27 -0600663
664 int (*set_property)(struct drm_plane *plane,
665 struct drm_property *property, uint64_t val);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800666};
667
668/**
669 * drm_plane - central DRM plane control structure
670 * @dev: DRM device this plane belongs to
671 * @head: for list management
672 * @base: base mode object
673 * @possible_crtcs: pipes this plane can be bound to
674 * @format_types: array of formats supported by this plane
675 * @format_count: number of formats supported
676 * @crtc: currently bound CRTC
677 * @fb: currently bound fb
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800678 * @funcs: helper functions
Rob Clark4d939142012-05-17 02:23:27 -0600679 * @properties: property tracking for this plane
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800680 */
681struct drm_plane {
682 struct drm_device *dev;
683 struct list_head head;
684
685 struct drm_mode_object base;
686
687 uint32_t possible_crtcs;
688 uint32_t *format_types;
689 uint32_t format_count;
690
691 struct drm_crtc *crtc;
692 struct drm_framebuffer *fb;
693
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800694 const struct drm_plane_funcs *funcs;
Rob Clark4d939142012-05-17 02:23:27 -0600695
696 struct drm_object_properties properties;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800697};
698
699/**
Sean Paul3b336ec2013-08-14 16:47:37 -0400700 * drm_bridge_funcs - drm_bridge control functions
701 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
702 * @disable: Called right before encoder prepare, disables the bridge
703 * @post_disable: Called right after encoder prepare, for lockstepped disable
704 * @mode_set: Set this mode to the bridge
705 * @pre_enable: Called right before encoder commit, for lockstepped commit
706 * @enable: Called right after encoder commit, enables the bridge
707 * @destroy: make object go away
708 */
709struct drm_bridge_funcs {
710 bool (*mode_fixup)(struct drm_bridge *bridge,
711 const struct drm_display_mode *mode,
712 struct drm_display_mode *adjusted_mode);
713 void (*disable)(struct drm_bridge *bridge);
714 void (*post_disable)(struct drm_bridge *bridge);
715 void (*mode_set)(struct drm_bridge *bridge,
716 struct drm_display_mode *mode,
717 struct drm_display_mode *adjusted_mode);
718 void (*pre_enable)(struct drm_bridge *bridge);
719 void (*enable)(struct drm_bridge *bridge);
720 void (*destroy)(struct drm_bridge *bridge);
721};
722
723/**
724 * drm_bridge - central DRM bridge control structure
725 * @dev: DRM device this bridge belongs to
726 * @head: list management
727 * @base: base mode object
728 * @funcs: control functions
729 * @driver_private: pointer to the bridge driver's internal context
730 */
731struct drm_bridge {
732 struct drm_device *dev;
733 struct list_head head;
734
735 struct drm_mode_object base;
736
737 const struct drm_bridge_funcs *funcs;
738 void *driver_private;
739};
740
741/**
Jesse Barnesef273512011-11-07 12:03:19 -0800742 * drm_mode_set - new values for a CRTC config change
743 * @head: list management
744 * @fb: framebuffer to use for new config
745 * @crtc: CRTC whose configuration we're about to change
746 * @mode: mode timings to use
747 * @x: position of this CRTC relative to @fb
748 * @y: position of this CRTC relative to @fb
749 * @connectors: array of connectors to drive with this CRTC if possible
750 * @num_connectors: size of @connectors array
Dave Airlief453ba02008-11-07 14:05:41 -0800751 *
752 * Represents a single crtc the connectors that it drives with what mode
753 * and from which framebuffer it scans out from.
754 *
755 * This is used to set modes.
756 */
757struct drm_mode_set {
Dave Airlief453ba02008-11-07 14:05:41 -0800758 struct drm_framebuffer *fb;
759 struct drm_crtc *crtc;
760 struct drm_display_mode *mode;
761
762 uint32_t x;
763 uint32_t y;
764
765 struct drm_connector **connectors;
766 size_t num_connectors;
767};
768
769/**
Jesse Barnes550cebc2011-11-07 12:03:20 -0800770 * struct drm_mode_config_funcs - basic driver provided mode setting functions
771 * @fb_create: create a new framebuffer object
772 * @output_poll_changed: function to handle output configuration changes
773 *
774 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
775 * involve drivers.
Dave Airlief453ba02008-11-07 14:05:41 -0800776 */
777struct drm_mode_config_funcs {
Jesse Barnes550cebc2011-11-07 12:03:20 -0800778 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
779 struct drm_file *file_priv,
780 struct drm_mode_fb_cmd2 *mode_cmd);
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000781 void (*output_poll_changed)(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800782};
783
Jesse Barnesc1aaca22011-11-07 12:03:21 -0800784/**
785 * drm_mode_group - group of mode setting resources for potential sub-grouping
786 * @num_crtcs: CRTC count
787 * @num_encoders: encoder count
788 * @num_connectors: connector count
789 * @id_list: list of KMS object IDs in this group
790 *
791 * Currently this simply tracks the global mode setting state. But in the
792 * future it could allow groups of objects to be set aside into independent
793 * control groups for use by different user level processes (e.g. two X servers
794 * running simultaneously on different heads, each with their own mode
795 * configuration and freedom of mode setting).
796 */
Dave Airlief453ba02008-11-07 14:05:41 -0800797struct drm_mode_group {
798 uint32_t num_crtcs;
799 uint32_t num_encoders;
800 uint32_t num_connectors;
Sean Paul3b336ec2013-08-14 16:47:37 -0400801 uint32_t num_bridges;
Dave Airlief453ba02008-11-07 14:05:41 -0800802
803 /* list of object IDs for this group */
804 uint32_t *id_list;
805};
806
807/**
808 * drm_mode_config - Mode configuration control structure
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800809 * @mutex: mutex protecting KMS related lists and structures
810 * @idr_mutex: mutex for KMS ID allocation and management
811 * @crtc_idr: main KMS ID tracking object
812 * @num_fb: number of fbs available
813 * @fb_list: list of framebuffers available
814 * @num_connector: number of connectors on this device
815 * @connector_list: list of connector objects
Sean Paul3b336ec2013-08-14 16:47:37 -0400816 * @num_bridge: number of bridges on this device
817 * @bridge_list: list of bridge objects
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800818 * @num_encoder: number of encoders on this device
819 * @encoder_list: list of encoder objects
820 * @num_crtc: number of CRTCs on this device
821 * @crtc_list: list of CRTC objects
822 * @min_width: minimum pixel width on this device
823 * @min_height: minimum pixel height on this device
824 * @max_width: maximum pixel width on this device
825 * @max_height: maximum pixel height on this device
826 * @funcs: core driver provided mode setting functions
827 * @fb_base: base address of the framebuffer
828 * @poll_enabled: track polling status for this device
829 * @output_poll_work: delayed work for polling in process context
830 * @*_property: core property tracking
Dave Airlief453ba02008-11-07 14:05:41 -0800831 *
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800832 * Core mode resource tracking structure. All CRTC, encoders, and connectors
833 * enumerated by the driver are added here, as are global properties. Some
834 * global restrictions are also here, e.g. dimension restrictions.
Dave Airlief453ba02008-11-07 14:05:41 -0800835 */
836struct drm_mode_config {
Jesse Barnesad2563c2009-01-19 17:21:45 +1000837 struct mutex mutex; /* protects configuration (mode lists etc.) */
838 struct mutex idr_mutex; /* for IDR management */
Dave Airlief453ba02008-11-07 14:05:41 -0800839 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
840 /* this is limited to one for now */
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100841
842
843 /**
844 * fb_lock - mutex to protect fb state
845 *
846 * Besides the global fb list his also protects the fbs list in the
847 * file_priv
848 */
849 struct mutex fb_lock;
Dave Airlief453ba02008-11-07 14:05:41 -0800850 int num_fb;
851 struct list_head fb_list;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100852
Dave Airlief453ba02008-11-07 14:05:41 -0800853 int num_connector;
854 struct list_head connector_list;
Sean Paul3b336ec2013-08-14 16:47:37 -0400855 int num_bridge;
856 struct list_head bridge_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800857 int num_encoder;
858 struct list_head encoder_list;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800859 int num_plane;
860 struct list_head plane_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800861
862 int num_crtc;
863 struct list_head crtc_list;
864
865 struct list_head property_list;
866
Dave Airlief453ba02008-11-07 14:05:41 -0800867 int min_width, min_height;
868 int max_width, max_height;
Laurent Pincharte6ecefa2012-05-17 13:27:23 +0200869 const struct drm_mode_config_funcs *funcs;
Benjamin Herrenschmidtd883f7f2009-02-02 16:55:45 +1100870 resource_size_t fb_base;
Dave Airlief453ba02008-11-07 14:05:41 -0800871
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000872 /* output poll support */
873 bool poll_enabled;
Daniel Vetter905bc9f2012-10-23 18:23:36 +0000874 bool poll_running;
Tejun Heo991ea752010-07-20 22:09:02 +0200875 struct delayed_work output_poll_work;
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000876
Dave Airlief453ba02008-11-07 14:05:41 -0800877 /* pointers to standard properties */
878 struct list_head property_blob_list;
879 struct drm_property *edid_property;
880 struct drm_property *dpms_property;
881
882 /* DVI-I properties */
883 struct drm_property *dvi_i_subconnector_property;
884 struct drm_property *dvi_i_select_subconnector_property;
885
886 /* TV properties */
887 struct drm_property *tv_subconnector_property;
888 struct drm_property *tv_select_subconnector_property;
889 struct drm_property *tv_mode_property;
890 struct drm_property *tv_left_margin_property;
891 struct drm_property *tv_right_margin_property;
892 struct drm_property *tv_top_margin_property;
893 struct drm_property *tv_bottom_margin_property;
Francisco Jerezb6b79022009-08-02 04:19:20 +0200894 struct drm_property *tv_brightness_property;
895 struct drm_property *tv_contrast_property;
896 struct drm_property *tv_flicker_reduction_property;
Francisco Jereza75f0232009-08-12 02:30:10 +0200897 struct drm_property *tv_overscan_property;
898 struct drm_property *tv_saturation_property;
899 struct drm_property *tv_hue_property;
Dave Airlief453ba02008-11-07 14:05:41 -0800900
901 /* Optional properties */
902 struct drm_property *scaling_mode_property;
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000903 struct drm_property *dirty_info_property;
Dave Airlie019d96c2011-09-29 16:20:42 +0100904
905 /* dumb ioctl parameters */
906 uint32_t preferred_depth, prefer_shadow;
Keith Packard62f21042013-07-22 18:50:00 -0700907
908 /* whether async page flip is supported or not */
909 bool async_page_flip;
Dave Airlief453ba02008-11-07 14:05:41 -0800910};
911
912#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
913#define obj_to_connector(x) container_of(x, struct drm_connector, base)
914#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
915#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
916#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
917#define obj_to_property(x) container_of(x, struct drm_property, base)
918#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800919#define obj_to_plane(x) container_of(x, struct drm_plane, base)
Dave Airlief453ba02008-11-07 14:05:41 -0800920
Sascha Hauer4a67d392012-02-06 10:58:17 +0100921struct drm_prop_enum_list {
922 int type;
923 char *name;
924};
Dave Airlief453ba02008-11-07 14:05:41 -0800925
Daniel Vetter84849902012-12-02 00:28:11 +0100926extern void drm_modeset_lock_all(struct drm_device *dev);
927extern void drm_modeset_unlock_all(struct drm_device *dev);
Daniel Vetter6aed8ec2013-01-20 17:32:21 +0100928extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
Daniel Vetter84849902012-12-02 00:28:11 +0100929
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200930extern int drm_crtc_init(struct drm_device *dev,
931 struct drm_crtc *crtc,
932 const struct drm_crtc_funcs *funcs);
Dave Airlief453ba02008-11-07 14:05:41 -0800933extern void drm_crtc_cleanup(struct drm_crtc *crtc);
Russell Kingdb5f7a62014-01-02 21:27:33 +0000934extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
935
936/**
937 * drm_crtc_mask - find the mask of a registered CRTC
938 * @crtc: CRTC to find mask for
939 *
940 * Given a registered CRTC, return the mask bit of that CRTC for an
941 * encoder's possible_crtcs field.
942 */
943static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
944{
945 return 1 << drm_crtc_index(crtc);
946}
Dave Airlief453ba02008-11-07 14:05:41 -0800947
Ilia Mirkinb21e3af2013-08-07 22:34:48 -0400948extern void drm_connector_ida_init(void);
949extern void drm_connector_ida_destroy(void);
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200950extern int drm_connector_init(struct drm_device *dev,
951 struct drm_connector *connector,
952 const struct drm_connector_funcs *funcs,
953 int connector_type);
Dave Airlief453ba02008-11-07 14:05:41 -0800954
955extern void drm_connector_cleanup(struct drm_connector *connector);
Dave Airliecbc7e222012-02-20 14:16:40 +0000956/* helper to unplug all connectors from sysfs for device */
957extern void drm_connector_unplug_all(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800958
Sean Paul3b336ec2013-08-14 16:47:37 -0400959extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
960 const struct drm_bridge_funcs *funcs);
961extern void drm_bridge_cleanup(struct drm_bridge *bridge);
962
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200963extern int drm_encoder_init(struct drm_device *dev,
964 struct drm_encoder *encoder,
965 const struct drm_encoder_funcs *funcs,
966 int encoder_type);
Dave Airlief453ba02008-11-07 14:05:41 -0800967
Thierry Reding3d887362014-01-13 14:33:20 +0100968/**
969 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
970 * @encoder: encoder to test
971 * @crtc: crtc to test
972 *
973 * Return false if @encoder can't be driven by @crtc, true otherwise.
974 */
975static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
976 struct drm_crtc *crtc)
977{
978 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
979}
980
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800981extern int drm_plane_init(struct drm_device *dev,
982 struct drm_plane *plane,
983 unsigned long possible_crtcs,
984 const struct drm_plane_funcs *funcs,
Rob Clark0a7eb242011-12-13 20:19:36 -0600985 const uint32_t *formats, uint32_t format_count,
986 bool priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800987extern void drm_plane_cleanup(struct drm_plane *plane);
Ville Syrjälä9125e612013-06-03 16:10:40 +0300988extern void drm_plane_force_disable(struct drm_plane *plane);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800989
Dave Airlief453ba02008-11-07 14:05:41 -0800990extern void drm_encoder_cleanup(struct drm_encoder *encoder);
991
Ville Syrjäläd20d3172013-06-07 15:43:07 +0000992extern const char *drm_get_connector_name(const struct drm_connector *connector);
993extern const char *drm_get_connector_status_name(enum drm_connector_status status);
994extern const char *drm_get_dpms_name(int val);
995extern const char *drm_get_dvi_i_subconnector_name(int val);
996extern const char *drm_get_dvi_i_select_name(int val);
997extern const char *drm_get_tv_subconnector_name(int val);
998extern const char *drm_get_tv_select_name(int val);
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500999extern void drm_fb_release(struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001000extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
Adam Jacksonfbff4692012-09-18 10:58:47 -04001001extern bool drm_probe_ddc(struct i2c_adapter *adapter);
Dave Airlief453ba02008-11-07 14:05:41 -08001002extern struct edid *drm_get_edid(struct drm_connector *connector,
1003 struct i2c_adapter *adapter);
Jani Nikula51f8da52013-09-27 15:08:27 +03001004extern struct edid *drm_edid_duplicate(const struct edid *edid);
Dave Airlief453ba02008-11-07 14:05:41 -08001005extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
1006extern void drm_mode_probed_add(struct drm_connector *connector, struct drm_display_mode *mode);
Ville Syrjäläc3c50e82012-03-13 12:35:51 +02001007extern void drm_mode_copy(struct drm_display_mode *dst, const struct drm_display_mode *src);
Dave Airlief453ba02008-11-07 14:05:41 -08001008extern struct drm_display_mode *drm_mode_duplicate(struct drm_device *dev,
Chris Wilsonb1f559e2011-01-26 09:49:47 +00001009 const struct drm_display_mode *mode);
Ville Syrjälä0b3904a2012-10-25 18:05:05 +00001010extern void drm_mode_debug_printmodeline(const struct drm_display_mode *mode);
Dave Airlief453ba02008-11-07 14:05:41 -08001011extern void drm_mode_config_init(struct drm_device *dev);
Chris Wilsoneb033552011-01-24 15:11:08 +00001012extern void drm_mode_config_reset(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -08001013extern void drm_mode_config_cleanup(struct drm_device *dev);
1014extern void drm_mode_set_name(struct drm_display_mode *mode);
Ville Syrjälä0b3904a2012-10-25 18:05:05 +00001015extern bool drm_mode_equal(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
Damien Lespiauf2ecf2e32013-09-25 16:45:27 +01001016extern bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode *mode1, const struct drm_display_mode *mode2);
Ville Syrjälä0b3904a2012-10-25 18:05:05 +00001017extern int drm_mode_width(const struct drm_display_mode *mode);
1018extern int drm_mode_height(const struct drm_display_mode *mode);
Dave Airlief453ba02008-11-07 14:05:41 -08001019
1020/* for us by fb module */
Dave Airlief453ba02008-11-07 14:05:41 -08001021extern struct drm_display_mode *drm_mode_create(struct drm_device *dev);
1022extern void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode);
Dave Airlief453ba02008-11-07 14:05:41 -08001023extern void drm_mode_validate_size(struct drm_device *dev,
1024 struct list_head *mode_list,
1025 int maxX, int maxY, int maxPitch);
1026extern void drm_mode_prune_invalid(struct drm_device *dev,
1027 struct list_head *mode_list, bool verbose);
1028extern void drm_mode_sort(struct list_head *mode_list);
Chris Wilsonb1f559e2011-01-26 09:49:47 +00001029extern int drm_mode_hsync(const struct drm_display_mode *mode);
1030extern int drm_mode_vrefresh(const struct drm_display_mode *mode);
Dave Airlief453ba02008-11-07 14:05:41 -08001031extern void drm_mode_set_crtcinfo(struct drm_display_mode *p,
1032 int adjust_flags);
1033extern void drm_mode_connector_list_update(struct drm_connector *connector);
1034extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1035 struct edid *edid);
Paulo Zanonic5431882012-05-15 18:09:02 -03001036extern int drm_object_property_set_value(struct drm_mode_object *obj,
1037 struct drm_property *property,
1038 uint64_t val);
1039extern int drm_object_property_get_value(struct drm_mode_object *obj,
1040 struct drm_property *property,
1041 uint64_t *value);
Dave Airlief453ba02008-11-07 14:05:41 -08001042extern int drm_framebuffer_init(struct drm_device *dev,
1043 struct drm_framebuffer *fb,
1044 const struct drm_framebuffer_funcs *funcs);
Daniel Vetter786b99e2012-12-02 21:53:40 +01001045extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1046 uint32_t id);
Rob Clarkf7eff602012-09-05 21:48:38 +00001047extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1048extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1049extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -08001050extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
Daniel Vetter36206362012-12-10 20:42:17 +01001051extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -08001052
Paulo Zanonic5431882012-05-15 18:09:02 -03001053extern void drm_object_attach_property(struct drm_mode_object *obj,
1054 struct drm_property *property,
1055 uint64_t init_val);
Dave Airlief453ba02008-11-07 14:05:41 -08001056extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1057 const char *name, int num_values);
Sascha Hauer4a67d392012-02-06 10:58:17 +01001058extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1059 const char *name,
1060 const struct drm_prop_enum_list *props,
1061 int num_values);
Rob Clark49e27542012-05-17 02:23:26 -06001062struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1063 int flags, const char *name,
1064 const struct drm_prop_enum_list *props,
1065 int num_values);
Sascha Hauerd9bc3c02012-02-06 10:58:18 +01001066struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1067 const char *name,
1068 uint64_t min, uint64_t max);
Dave Airlief453ba02008-11-07 14:05:41 -08001069extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1070extern int drm_property_add_enum(struct drm_property *property, int index,
1071 uint64_t value, const char *name);
1072extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1073extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1074 char *formats[]);
1075extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001076extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
Ville Syrjäläd20d3172013-06-07 15:43:07 +00001077extern const char *drm_get_encoder_name(const struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -08001078
1079extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1080 struct drm_encoder *encoder);
1081extern void drm_mode_connector_detach_encoder(struct drm_connector *connector,
1082 struct drm_encoder *encoder);
Sascha Hauer4cae5b82012-02-01 11:38:23 +01001083extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
Dave Airlief453ba02008-11-07 14:05:41 -08001084 int gamma_size);
Daniel Vetter7a9c9062009-09-15 22:57:31 +02001085extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1086 uint32_t id, uint32_t type);
Dave Airlief453ba02008-11-07 14:05:41 -08001087/* IOCTLs */
1088extern int drm_mode_getresources(struct drm_device *dev,
1089 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001090extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1091 struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001092extern int drm_mode_getcrtc(struct drm_device *dev,
1093 void *data, struct drm_file *file_priv);
1094extern int drm_mode_getconnector(struct drm_device *dev,
1095 void *data, struct drm_file *file_priv);
Daniel Vetter2d13b672012-12-11 13:47:23 +01001096extern int drm_mode_set_config_internal(struct drm_mode_set *set);
Dave Airlief453ba02008-11-07 14:05:41 -08001097extern int drm_mode_setcrtc(struct drm_device *dev,
1098 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001099extern int drm_mode_getplane(struct drm_device *dev,
1100 void *data, struct drm_file *file_priv);
1101extern int drm_mode_setplane(struct drm_device *dev,
1102 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001103extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1104 void *data, struct drm_file *file_priv);
Dave Airlie4c813d42013-06-20 11:48:52 +10001105extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1106 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001107extern int drm_mode_addfb(struct drm_device *dev,
1108 void *data, struct drm_file *file_priv);
Jesse Barnes308e5bc2011-11-14 14:51:28 -08001109extern int drm_mode_addfb2(struct drm_device *dev,
1110 void *data, struct drm_file *file_priv);
1111extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
Dave Airlief453ba02008-11-07 14:05:41 -08001112extern int drm_mode_rmfb(struct drm_device *dev,
1113 void *data, struct drm_file *file_priv);
1114extern int drm_mode_getfb(struct drm_device *dev,
1115 void *data, struct drm_file *file_priv);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001116extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1117 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001118
1119extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1120 void *data, struct drm_file *file_priv);
1121extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1122 void *data, struct drm_file *file_priv);
1123extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1124 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001125extern int drm_mode_getencoder(struct drm_device *dev,
1126 void *data, struct drm_file *file_priv);
1127extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1128 void *data, struct drm_file *file_priv);
1129extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1130 void *data, struct drm_file *file_priv);
Thierry Reding18316c82012-12-20 15:41:44 +01001131extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
Ma Lingf23c20c2009-03-26 19:26:23 +08001132extern bool drm_detect_hdmi_monitor(struct edid *edid);
Zhenyu Wang8fe97902010-09-19 14:27:28 +08001133extern bool drm_detect_monitor_audio(struct edid *edid);
Ville Syrjäläb1edd6a2013-01-17 16:31:30 +02001134extern bool drm_rgb_quant_range_selectable(struct edid *edid);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -05001135extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1136 void *data, struct drm_file *file_priv);
Zhao Yakuid782c3f2009-06-22 13:17:08 +08001137extern struct drm_display_mode *drm_cvt_mode(struct drm_device *dev,
1138 int hdisplay, int vdisplay, int vrefresh,
Dave Airlied50ba252009-09-23 14:44:08 +10001139 bool reduced, bool interlaced, bool margins);
Zhao Yakui26bbdad2009-06-22 13:17:09 +08001140extern struct drm_display_mode *drm_gtf_mode(struct drm_device *dev,
1141 int hdisplay, int vdisplay, int vrefresh,
1142 bool interlaced, int margins);
Adam Jackson7a374352010-03-29 21:43:30 +00001143extern struct drm_display_mode *drm_gtf_mode_complex(struct drm_device *dev,
1144 int hdisplay, int vdisplay, int vrefresh,
1145 bool interlaced, int margins, int GTF_M,
1146 int GTF_2C, int GTF_K, int GTF_2J);
Zhao Yakuif0fda0a2009-09-03 09:33:48 +08001147extern int drm_add_modes_noedid(struct drm_connector *connector,
1148 int hdisplay, int vdisplay);
Gerd Hoffmann3cf70da2013-10-11 10:01:08 +02001149extern void drm_set_preferred_mode(struct drm_connector *connector,
1150 int hpref, int vpref);
Alex Deucher3c537882010-02-05 04:21:19 -05001151
Thomas Reim051963d2011-07-29 14:28:57 +00001152extern int drm_edid_header_is_valid(const u8 *raw_edid);
Jerome Glisse0b2443e2012-08-09 11:25:51 -04001153extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
Alex Deucher3c537882010-02-05 04:21:19 -05001154extern bool drm_edid_is_valid(struct edid *edid);
Dave Airlie1d42bbc2010-05-07 05:02:30 +00001155struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
Adam Jacksonf6e252b2012-04-13 16:33:31 -04001156 int hsize, int vsize, int fresh,
1157 bool rb);
Dave Airlieff72145b2011-02-07 12:16:14 +10001158
1159extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1160 void *data, struct drm_file *file_priv);
1161extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1162 void *data, struct drm_file *file_priv);
1163extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1164 void *data, struct drm_file *file_priv);
Paulo Zanonic5431882012-05-15 18:09:02 -03001165extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1166 struct drm_file *file_priv);
1167extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1168 struct drm_file *file_priv);
Dave Airlie248dbc22011-11-29 20:02:54 +00001169
1170extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1171 int *bpp);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001172extern int drm_format_num_planes(uint32_t format);
Ville Syrjälä5a86bd52012-04-05 21:35:16 +03001173extern int drm_format_plane_cpp(uint32_t format, int plane);
Ville Syrjälä01b68b02012-04-05 21:35:17 +03001174extern int drm_format_horz_chroma_subsampling(uint32_t format);
1175extern int drm_format_vert_chroma_subsampling(uint32_t format);
Ville Syrjäläd20d3172013-06-07 15:43:07 +00001176extern const char *drm_get_format_name(uint32_t format);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001177
Russell King96f60e32012-08-15 13:59:49 +01001178/* Helpers */
1179static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1180 uint32_t id)
1181{
1182 struct drm_mode_object *mo;
1183 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1184 return mo ? obj_to_crtc(mo) : NULL;
1185}
1186
1187static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1188 uint32_t id)
1189{
1190 struct drm_mode_object *mo;
1191 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1192 return mo ? obj_to_encoder(mo) : NULL;
1193}
1194
Dave Airlief453ba02008-11-07 14:05:41 -08001195#endif /* __DRM_CRTC_H__ */