blob: c40070a92d6b43f055c77f749ec44afc713e031a [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 Herrmannd7d2c482014-08-29 12:12:40 +020034#include <uapi/drm/drm_mode.h>
35#include <uapi/drm/drm_fourcc.h>
Rob Clark51fd3712013-11-19 12:10:12 -050036#include <drm/drm_modeset_lock.h>
Jesse Barnes308e5bc2011-11-14 14:51:28 -080037
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;
Russell King7e435aa2014-06-15 11:07:12 +010044struct device_node;
Dave Airlief453ba02008-11-07 14:05:41 -080045
46#define DRM_MODE_OBJECT_CRTC 0xcccccccc
47#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
48#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
49#define DRM_MODE_OBJECT_MODE 0xdededede
50#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
51#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
52#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
Jesse Barnes8cf5c912011-11-14 14:51:27 -080053#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
Sean Paul3b336ec2013-08-14 16:47:37 -040054#define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
Rob Clark98f75de2014-05-30 11:37:03 -040055#define DRM_MODE_OBJECT_ANY 0
Dave Airlief453ba02008-11-07 14:05:41 -080056
57struct drm_mode_object {
58 uint32_t id;
59 uint32_t type;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030060 struct drm_object_properties *properties;
61};
62
Paulo Zanonife456162012-06-12 11:27:01 -030063#define DRM_OBJECT_MAX_PROPERTY 24
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030064struct drm_object_properties {
Paulo Zanoni7f88a9b2012-05-15 18:09:04 -030065 int count;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030066 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
67 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
Dave Airlief453ba02008-11-07 14:05:41 -080068};
69
Rob Clarkebc44cf2012-09-12 22:22:31 -050070static inline int64_t U642I64(uint64_t val)
71{
72 return (int64_t)*((int64_t *)&val);
73}
74static inline uint64_t I642U64(int64_t val)
75{
76 return (uint64_t)*((uint64_t *)&val);
77}
78
Ville Syrjälä06596962014-07-08 10:31:51 +053079/* rotation property bits */
80#define DRM_ROTATE_0 0
81#define DRM_ROTATE_90 1
82#define DRM_ROTATE_180 2
83#define DRM_ROTATE_270 3
84#define DRM_REFLECT_X 4
85#define DRM_REFLECT_Y 5
86
Daniel Vetter55310002014-01-23 15:52:20 +010087enum drm_connector_force {
88 DRM_FORCE_UNSPECIFIED,
89 DRM_FORCE_OFF,
90 DRM_FORCE_ON, /* force on analog part normally */
91 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
Dave Airlief453ba02008-11-07 14:05:41 -080092};
93
Daniel Vetter55310002014-01-23 15:52:20 +010094#include <drm/drm_modes.h>
Damien Lespiau4aa17cf2013-09-25 16:45:21 +010095
Dave Airlief453ba02008-11-07 14:05:41 -080096enum drm_connector_status {
97 connector_status_connected = 1,
98 connector_status_disconnected = 2,
99 connector_status_unknown = 3,
100};
101
102enum subpixel_order {
103 SubPixelUnknown = 0,
104 SubPixelHorizontalRGB,
105 SubPixelHorizontalBGR,
106 SubPixelVerticalRGB,
107 SubPixelVerticalBGR,
108 SubPixelNone,
109};
110
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700111#define DRM_COLOR_FORMAT_RGB444 (1<<0)
112#define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
113#define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
Dave Airlief453ba02008-11-07 14:05:41 -0800114/*
115 * Describes a given display (e.g. CRT or flat panel) and its limitations.
116 */
117struct drm_display_info {
118 char name[DRM_DISPLAY_INFO_LEN];
Adam Jacksonfb439642010-08-03 14:38:16 -0400119
Dave Airlief453ba02008-11-07 14:05:41 -0800120 /* Physical size */
121 unsigned int width_mm;
122 unsigned int height_mm;
123
Dave Airlief453ba02008-11-07 14:05:41 -0800124 /* Clock limits FIXME: storage format */
125 unsigned int min_vfreq, max_vfreq;
126 unsigned int min_hfreq, max_hfreq;
127 unsigned int pixel_clock;
Jesse Barnes3b112282011-04-15 12:49:23 -0700128 unsigned int bpc;
Dave Airlief453ba02008-11-07 14:05:41 -0800129
Dave Airlief453ba02008-11-07 14:05:41 -0800130 enum subpixel_order subpixel_order;
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700131 u32 color_formats;
Dave Airlief453ba02008-11-07 14:05:41 -0800132
Mario Kleiner5d02626d2014-06-05 09:52:10 -0400133 /* Mask of supported hdmi deep color modes */
134 u8 edid_hdmi_dc_modes;
135
Jesse Barnesebec9a72011-08-03 09:22:54 -0700136 u8 cea_rev;
Dave Airlief453ba02008-11-07 14:05:41 -0800137};
138
139struct drm_framebuffer_funcs {
Rob Clarkf7eff602012-09-05 21:48:38 +0000140 /* note: use drm_framebuffer_remove() */
Dave Airlief453ba02008-11-07 14:05:41 -0800141 void (*destroy)(struct drm_framebuffer *framebuffer);
142 int (*create_handle)(struct drm_framebuffer *fb,
143 struct drm_file *file_priv,
144 unsigned int *handle);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000145 /**
146 * Optinal callback for the dirty fb ioctl.
147 *
148 * Userspace can notify the driver via this callback
149 * that a area of the framebuffer has changed and should
150 * be flushed to the display hardware.
151 *
152 * See documentation in drm_mode.h for the struct
153 * drm_mode_fb_dirty_cmd for more information as all
154 * the semantics and arguments have a one to one mapping
155 * on this function.
156 */
Thomas Hellstrom02b00162010-10-05 12:43:02 +0200157 int (*dirty)(struct drm_framebuffer *framebuffer,
158 struct drm_file *file_priv, unsigned flags,
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000159 unsigned color, struct drm_clip_rect *clips,
160 unsigned num_clips);
Dave Airlief453ba02008-11-07 14:05:41 -0800161};
162
163struct drm_framebuffer {
164 struct drm_device *dev;
Rob Clarkf7eff602012-09-05 21:48:38 +0000165 /*
166 * Note that the fb is refcounted for the benefit of driver internals,
167 * for example some hw, disabling a CRTC/plane is asynchronous, and
168 * scanout does not actually complete until the next vblank. So some
169 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
170 * should be deferred. In cases like this, the driver would like to
171 * hold a ref to the fb even though it has already been removed from
172 * userspace perspective.
173 */
174 struct kref refcount;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100175 /*
176 * Place on the dev->mode_config.fb_list, access protected by
177 * dev->mode_config.fb_lock.
178 */
Dave Airlief453ba02008-11-07 14:05:41 -0800179 struct list_head head;
180 struct drm_mode_object base;
181 const struct drm_framebuffer_funcs *funcs;
Ville Syrjälä01f2c772011-12-20 00:06:49 +0200182 unsigned int pitches[4];
183 unsigned int offsets[4];
Dave Airlief453ba02008-11-07 14:05:41 -0800184 unsigned int width;
185 unsigned int height;
186 /* depth can be 15 or 16 */
187 unsigned int depth;
188 int bits_per_pixel;
189 int flags;
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800190 uint32_t pixel_format; /* fourcc format */
Dave Airlief453ba02008-11-07 14:05:41 -0800191 struct list_head filp_head;
Dave Airlie785b93e2009-08-28 15:46:53 +1000192 /* if you are using the helper */
193 void *helper_private;
Dave Airlief453ba02008-11-07 14:05:41 -0800194};
195
196struct drm_property_blob {
197 struct drm_mode_object base;
198 struct list_head head;
199 unsigned int length;
Ville Syrjäläd63f5e62012-03-13 12:35:49 +0200200 unsigned char data[];
Dave Airlief453ba02008-11-07 14:05:41 -0800201};
202
203struct drm_property_enum {
204 uint64_t value;
205 struct list_head head;
206 char name[DRM_PROP_NAME_LEN];
207};
208
209struct drm_property {
210 struct list_head head;
211 struct drm_mode_object base;
212 uint32_t flags;
213 char name[DRM_PROP_NAME_LEN];
214 uint32_t num_values;
215 uint64_t *values;
Rob Clark98f75de2014-05-30 11:37:03 -0400216 struct drm_device *dev;
Dave Airlief453ba02008-11-07 14:05:41 -0800217
218 struct list_head enum_blob_list;
219};
220
221struct drm_crtc;
222struct drm_connector;
223struct drm_encoder;
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500224struct drm_pending_vblank_event;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800225struct drm_plane;
Sean Paul3b336ec2013-08-14 16:47:37 -0400226struct drm_bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800227
228/**
229 * drm_crtc_funcs - control CRTCs for a given device
Dave Airlief453ba02008-11-07 14:05:41 -0800230 * @save: save CRTC state
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200231 * @restore: restore CRTC state
Christopher Harvey715f59c2013-04-05 15:28:32 +0000232 * @reset: reset CRTC after state has been invalidated (e.g. resume)
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200233 * @cursor_set: setup the cursor
234 * @cursor_move: move the cursor
Dave Airlief453ba02008-11-07 14:05:41 -0800235 * @gamma_set: specify color ramp for CRTC
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300236 * @destroy: deinit and free object
237 * @set_property: called when a property is changed
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200238 * @set_config: apply a new CRTC configuration
239 * @page_flip: initiate a page flip
Dave Airlief453ba02008-11-07 14:05:41 -0800240 *
241 * The drm_crtc_funcs structure is the central CRTC management structure
242 * in the DRM. Each CRTC controls one or more connectors (note that the name
243 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
244 * connectors, not just CRTs).
245 *
246 * Each driver is responsible for filling out this structure at startup time,
247 * in addition to providing other modesetting features, like i2c and DDC
248 * bus accessors.
249 */
250struct drm_crtc_funcs {
251 /* Save CRTC state */
252 void (*save)(struct drm_crtc *crtc); /* suspend? */
253 /* Restore CRTC state */
254 void (*restore)(struct drm_crtc *crtc); /* resume? */
Chris Wilsoneb033552011-01-24 15:11:08 +0000255 /* Reset CRTC state */
256 void (*reset)(struct drm_crtc *crtc);
Dave Airlief453ba02008-11-07 14:05:41 -0800257
258 /* cursor controls */
259 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
260 uint32_t handle, uint32_t width, uint32_t height);
Dave Airlie4c813d42013-06-20 11:48:52 +1000261 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
262 uint32_t handle, uint32_t width, uint32_t height,
263 int32_t hot_x, int32_t hot_y);
Dave Airlief453ba02008-11-07 14:05:41 -0800264 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
265
266 /* Set gamma on the CRTC */
267 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
James Simmons72034252010-08-03 01:33:19 +0100268 uint32_t start, uint32_t size);
Dave Airlief453ba02008-11-07 14:05:41 -0800269 /* Object destroy routine */
270 void (*destroy)(struct drm_crtc *crtc);
271
272 int (*set_config)(struct drm_mode_set *set);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500273
274 /*
275 * Flip to the given framebuffer. This implements the page
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300276 * flip ioctl described in drm_mode.h, specifically, the
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500277 * implementation must return immediately and block all
278 * rendering to the current fb until the flip has completed.
279 * If userspace set the event flag in the ioctl, the event
280 * argument will point to an event to send back when the flip
281 * completes, otherwise it will be NULL.
282 */
283 int (*page_flip)(struct drm_crtc *crtc,
284 struct drm_framebuffer *fb,
Keith Packarded8d1972013-07-22 18:49:58 -0700285 struct drm_pending_vblank_event *event,
286 uint32_t flags);
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300287
288 int (*set_property)(struct drm_crtc *crtc,
289 struct drm_property *property, uint64_t val);
Dave Airlief453ba02008-11-07 14:05:41 -0800290};
291
292/**
293 * drm_crtc - central CRTC control structure
Jesse Barnes77491632011-11-07 12:03:14 -0800294 * @dev: parent DRM device
295 * @head: list management
Rob Clark51fd3712013-11-19 12:10:12 -0500296 * @mutex: per-CRTC locking
Jesse Barnes77491632011-11-07 12:03:14 -0800297 * @base: base KMS object for ID tracking etc.
Matt Ropere13161a2014-04-01 15:22:38 -0700298 * @primary: primary plane for this CRTC
299 * @cursor: cursor plane for this CRTC
Dave Airlief453ba02008-11-07 14:05:41 -0800300 * @enabled: is this CRTC enabled?
Jesse Barnes77491632011-11-07 12:03:14 -0800301 * @mode: current mode timings
302 * @hwmode: mode timings as programmed to hw regs
Rob Clark7c80e122012-09-04 16:35:56 +0000303 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
304 * invert the width/height of the crtc. This is used if the driver
305 * is performing 90 or 270 degree rotated scanout
Dave Airlief453ba02008-11-07 14:05:41 -0800306 * @x: x position on screen
307 * @y: y position on screen
Dave Airlief453ba02008-11-07 14:05:41 -0800308 * @funcs: CRTC control functions
Jesse Barnes77491632011-11-07 12:03:14 -0800309 * @gamma_size: size of gamma ramp
310 * @gamma_store: gamma ramp values
311 * @framedur_ns: precise frame timing
312 * @framedur_ns: precise line timing
313 * @pixeldur_ns: precise pixel timing
314 * @helper_private: mid-layer private data
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300315 * @properties: property tracking for this CRTC
Dave Airlief453ba02008-11-07 14:05:41 -0800316 *
317 * Each CRTC may have one or more connectors associated with it. This structure
318 * allows the CRTC to be controlled.
319 */
320struct drm_crtc {
321 struct drm_device *dev;
Russell King7e435aa2014-06-15 11:07:12 +0100322 struct device_node *port;
Dave Airlief453ba02008-11-07 14:05:41 -0800323 struct list_head head;
324
Daniel Vetter29494c12012-12-02 02:18:25 +0100325 /**
326 * crtc mutex
327 *
328 * This provides a read lock for the overall crtc state (mode, dpms
329 * state, ...) and a write lock for everything which can be update
330 * without a full modeset (fb, cursor data, ...)
331 */
Rob Clark51fd3712013-11-19 12:10:12 -0500332 struct drm_modeset_lock mutex;
Daniel Vetter29494c12012-12-02 02:18:25 +0100333
Dave Airlief453ba02008-11-07 14:05:41 -0800334 struct drm_mode_object base;
335
Matt Ropere13161a2014-04-01 15:22:38 -0700336 /* primary and cursor planes for CRTC */
337 struct drm_plane *primary;
338 struct drm_plane *cursor;
339
Matt Roper161d0dc2014-06-10 08:28:10 -0700340 /* position of cursor plane on crtc */
341 int cursor_x;
342 int cursor_y;
343
Dave Airlief453ba02008-11-07 14:05:41 -0800344 bool enabled;
345
Mario Kleiner27641c32010-10-23 04:20:23 +0200346 /* Requested mode from modesetting. */
Dave Airlief453ba02008-11-07 14:05:41 -0800347 struct drm_display_mode mode;
348
Mario Kleiner27641c32010-10-23 04:20:23 +0200349 /* Programmed mode in hw, after adjustments for encoders,
350 * crtc, panel scaling etc. Needed for timestamping etc.
351 */
352 struct drm_display_mode hwmode;
353
Rob Clark7c80e122012-09-04 16:35:56 +0000354 bool invert_dimensions;
355
Dave Airlief453ba02008-11-07 14:05:41 -0800356 int x, y;
Dave Airlief453ba02008-11-07 14:05:41 -0800357 const struct drm_crtc_funcs *funcs;
358
359 /* CRTC gamma size for reporting to userspace */
360 uint32_t gamma_size;
361 uint16_t *gamma_store;
362
Mario Kleiner27641c32010-10-23 04:20:23 +0200363 /* Constants needed for precise vblank and swap timestamping. */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300364 int framedur_ns, linedur_ns, pixeldur_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200365
Dave Airlief453ba02008-11-07 14:05:41 -0800366 /* if you are using the helper */
367 void *helper_private;
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300368
369 struct drm_object_properties properties;
Daniel Vetterd059f652014-07-25 18:07:40 +0200370
371 /*
372 * For legacy crtc ioctls so that atomic drivers can get at the locking
373 * acquire context.
374 */
375 struct drm_modeset_acquire_ctx *acquire_ctx;
Dave Airlief453ba02008-11-07 14:05:41 -0800376};
377
378
379/**
380 * drm_connector_funcs - control connectors on a given device
381 * @dpms: set power state (see drm_crtc_funcs above)
382 * @save: save connector state
383 * @restore: restore connector state
Christopher Harvey13bcf012013-03-07 10:42:25 -0500384 * @reset: reset connector after state has been invalidated (e.g. resume)
Dave Airlief453ba02008-11-07 14:05:41 -0800385 * @detect: is this connector active?
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200386 * @fill_modes: fill mode list for this connector
Christopher Harvey13bcf012013-03-07 10:42:25 -0500387 * @set_property: property for this connector may need an update
Dave Airlief453ba02008-11-07 14:05:41 -0800388 * @destroy: make object go away
Christopher Harvey13bcf012013-03-07 10:42:25 -0500389 * @force: notify the driver that the connector is forced on
Dave Airlief453ba02008-11-07 14:05:41 -0800390 *
391 * Each CRTC may have one or more connectors attached to it. The functions
392 * below allow the core DRM code to control connectors, enumerate available modes,
393 * etc.
394 */
395struct drm_connector_funcs {
396 void (*dpms)(struct drm_connector *connector, int mode);
397 void (*save)(struct drm_connector *connector);
398 void (*restore)(struct drm_connector *connector);
Chris Wilsoneb033552011-01-24 15:11:08 +0000399 void (*reset)(struct drm_connector *connector);
Chris Wilson930a9e22010-09-14 11:07:23 +0100400
401 /* Check to see if anything is attached to the connector.
402 * @force is set to false whilst polling, true when checking the
403 * connector due to user request. @force can be used by the driver
404 * to avoid expensive, destructive operations during automated
405 * probing.
406 */
Chris Wilson7b334fc2010-09-09 23:51:02 +0100407 enum drm_connector_status (*detect)(struct drm_connector *connector,
Chris Wilson930a9e22010-09-14 11:07:23 +0100408 bool force);
Jesse Barnes40a518d2009-01-12 12:05:32 -0800409 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
Dave Airlief453ba02008-11-07 14:05:41 -0800410 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
411 uint64_t val);
412 void (*destroy)(struct drm_connector *connector);
Dave Airlied50ba252009-09-23 14:44:08 +1000413 void (*force)(struct drm_connector *connector);
Dave Airlief453ba02008-11-07 14:05:41 -0800414};
415
Jesse Barnes6c3db922011-11-07 12:03:16 -0800416/**
417 * drm_encoder_funcs - encoder controls
418 * @reset: reset state (e.g. at init or resume time)
419 * @destroy: cleanup and free associated data
420 *
421 * Encoders sit between CRTCs and connectors.
422 */
Dave Airlief453ba02008-11-07 14:05:41 -0800423struct drm_encoder_funcs {
Chris Wilsoneb033552011-01-24 15:11:08 +0000424 void (*reset)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800425 void (*destroy)(struct drm_encoder *encoder);
426};
427
Ben Skeggsafe887d2012-01-12 16:00:57 +1000428#define DRM_CONNECTOR_MAX_ENCODER 3
Dave Airlief453ba02008-11-07 14:05:41 -0800429
430/**
431 * drm_encoder - central DRM encoder structure
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800432 * @dev: parent DRM device
433 * @head: list management
434 * @base: base KMS object
Jani Nikulae5748942014-05-14 16:58:20 +0300435 * @name: encoder name
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800436 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
437 * @possible_crtcs: bitmask of potential CRTC bindings
438 * @possible_clones: bitmask of potential sibling encoders for cloning
439 * @crtc: currently bound CRTC
Sean Paul3b336ec2013-08-14 16:47:37 -0400440 * @bridge: bridge associated to the encoder
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800441 * @funcs: control functions
442 * @helper_private: mid-layer private data
443 *
444 * CRTCs drive pixels to encoders, which convert them into signals
445 * appropriate for a given connector or set of connectors.
Dave Airlief453ba02008-11-07 14:05:41 -0800446 */
447struct drm_encoder {
448 struct drm_device *dev;
449 struct list_head head;
450
451 struct drm_mode_object base;
Jani Nikulae5748942014-05-14 16:58:20 +0300452 char *name;
Dave Airlief453ba02008-11-07 14:05:41 -0800453 int encoder_type;
454 uint32_t possible_crtcs;
455 uint32_t possible_clones;
456
457 struct drm_crtc *crtc;
Sean Paul3b336ec2013-08-14 16:47:37 -0400458 struct drm_bridge *bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800459 const struct drm_encoder_funcs *funcs;
460 void *helper_private;
461};
462
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000463/* should we poll this connector for connects and disconnects */
464/* hot plug detectable */
465#define DRM_CONNECTOR_POLL_HPD (1 << 0)
466/* poll for connections */
467#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
468/* can cleanly poll for disconnections without flickering the screen */
469/* DACs should rarely do this without a lot of testing */
470#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
471
Wu Fengguang76adaa342011-09-05 14:23:20 +0800472#define MAX_ELD_BYTES 128
473
Dave Airlief453ba02008-11-07 14:05:41 -0800474/**
475 * drm_connector - central DRM connector control structure
Jesse Barnes72252542011-11-07 12:03:18 -0800476 * @dev: parent DRM device
477 * @kdev: kernel device for sysfs attributes
478 * @attr: sysfs attributes
479 * @head: list management
480 * @base: base KMS object
Jani Nikula2abdd312014-05-14 16:58:19 +0300481 * @name: connector name
Jesse Barnes72252542011-11-07 12:03:18 -0800482 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
483 * @connector_type_id: index into connector type enum
Dave Airlief453ba02008-11-07 14:05:41 -0800484 * @interlace_allowed: can this connector handle interlaced modes?
485 * @doublescan_allowed: can this connector handle doublescan?
Jesse Barnes72252542011-11-07 12:03:18 -0800486 * @modes: modes available on this connector (from fill_modes() + user)
487 * @status: one of the drm_connector_status enums (connected, not, or unknown)
488 * @probed_modes: list of modes derived directly from the display
489 * @display_info: information about attached display (e.g. from EDID)
Dave Airlief453ba02008-11-07 14:05:41 -0800490 * @funcs: connector control functions
Jesse Barnes72252542011-11-07 12:03:18 -0800491 * @edid_blob_ptr: DRM property containing EDID if present
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300492 * @properties: property tracking for this connector
Jesse Barnes72252542011-11-07 12:03:18 -0800493 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
494 * @dpms: current dpms state
495 * @helper_private: mid-layer private data
496 * @force: a %DRM_FORCE_<foo> state for forced mode sets
497 * @encoder_ids: valid encoders for this connector
498 * @encoder: encoder driving this connector, if any
499 * @eld: EDID-like data, if present
500 * @dvi_dual: dual link DVI, if found
501 * @max_tmds_clock: max clock rate, if found
502 * @latency_present: AV delay info from ELD, if found
503 * @video_latency: video latency info from ELD, if found
504 * @audio_latency: audio latency info from ELD, if found
505 * @null_edid_counter: track sinks that give us all zeros for the EDID
Dave Airlief453ba02008-11-07 14:05:41 -0800506 *
507 * Each connector may be connected to one or more CRTCs, or may be clonable by
508 * another connector if they can share a CRTC. Each connector also has a specific
509 * position in the broader display (referred to as a 'screen' though it could
510 * span multiple monitors).
511 */
512struct drm_connector {
513 struct drm_device *dev;
Dave Airlie5bdebb12013-10-11 14:07:25 +1000514 struct device *kdev;
Dave Airlief453ba02008-11-07 14:05:41 -0800515 struct device_attribute *attr;
516 struct list_head head;
517
518 struct drm_mode_object base;
519
Jani Nikula2abdd312014-05-14 16:58:19 +0300520 char *name;
Dave Airlief453ba02008-11-07 14:05:41 -0800521 int connector_type;
522 int connector_type_id;
523 bool interlace_allowed;
524 bool doublescan_allowed;
Damien Lespiau560a0672013-09-25 16:45:29 +0100525 bool stereo_allowed;
Dave Airlief453ba02008-11-07 14:05:41 -0800526 struct list_head modes; /* list of modes on this connector */
527
Dave Airlief453ba02008-11-07 14:05:41 -0800528 enum drm_connector_status status;
529
530 /* these are modes added by probing with DDC or the BIOS */
531 struct list_head probed_modes;
532
533 struct drm_display_info display_info;
534 const struct drm_connector_funcs *funcs;
535
Dave Airlief453ba02008-11-07 14:05:41 -0800536 struct drm_property_blob *edid_blob_ptr;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300537 struct drm_object_properties properties;
Dave Airlief453ba02008-11-07 14:05:41 -0800538
Dave Airlie43aba7e2014-06-05 14:01:31 +1000539 struct drm_property_blob *path_blob_ptr;
540
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000541 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
542
Keith Packardc9fb15f2009-05-30 20:42:28 -0700543 /* requested DPMS state */
544 int dpms;
545
Dave Airlief453ba02008-11-07 14:05:41 -0800546 void *helper_private;
547
Dave Airlied50ba252009-09-23 14:44:08 +1000548 /* forced on connector */
Chris Wilsoneaf99c72014-08-06 10:08:32 +0200549 struct drm_cmdline_mode cmdline_mode;
Dave Airlied50ba252009-09-23 14:44:08 +1000550 enum drm_connector_force force;
Thomas Wood4cf2b282014-06-18 17:52:33 +0100551 bool override_edid;
Dave Airlief453ba02008-11-07 14:05:41 -0800552 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
Dave Airlief453ba02008-11-07 14:05:41 -0800553 struct drm_encoder *encoder; /* currently active encoder */
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000554
Wu Fengguang76adaa342011-09-05 14:23:20 +0800555 /* EDID bits */
556 uint8_t eld[MAX_ELD_BYTES];
557 bool dvi_dual;
558 int max_tmds_clock; /* in MHz */
559 bool latency_present[2];
560 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
561 int audio_latency[2];
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000562 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
Jerome Glisse0b2443e2012-08-09 11:25:51 -0400563 unsigned bad_edid_counter;
Thomas Wood30f65702014-06-18 17:52:32 +0100564
565 struct dentry *debugfs_entry;
Dave Airlief453ba02008-11-07 14:05:41 -0800566};
567
568/**
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800569 * drm_plane_funcs - driver plane control functions
570 * @update_plane: update the plane configuration
571 * @disable_plane: shut down the plane
572 * @destroy: clean up plane resources
Rob Clark4d939142012-05-17 02:23:27 -0600573 * @set_property: called when a property is changed
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800574 */
575struct drm_plane_funcs {
576 int (*update_plane)(struct drm_plane *plane,
577 struct drm_crtc *crtc, struct drm_framebuffer *fb,
578 int crtc_x, int crtc_y,
579 unsigned int crtc_w, unsigned int crtc_h,
580 uint32_t src_x, uint32_t src_y,
581 uint32_t src_w, uint32_t src_h);
582 int (*disable_plane)(struct drm_plane *plane);
583 void (*destroy)(struct drm_plane *plane);
Daniel Vetter2a0d7cf2014-07-29 15:32:37 +0200584 void (*reset)(struct drm_plane *plane);
Rob Clark4d939142012-05-17 02:23:27 -0600585
586 int (*set_property)(struct drm_plane *plane,
587 struct drm_property *property, uint64_t val);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800588};
589
Matt Ropere27dde32014-04-01 15:22:30 -0700590enum drm_plane_type {
591 DRM_PLANE_TYPE_OVERLAY,
592 DRM_PLANE_TYPE_PRIMARY,
593 DRM_PLANE_TYPE_CURSOR,
594};
595
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800596/**
597 * drm_plane - central DRM plane control structure
598 * @dev: DRM device this plane belongs to
599 * @head: for list management
600 * @base: base mode object
601 * @possible_crtcs: pipes this plane can be bound to
602 * @format_types: array of formats supported by this plane
603 * @format_count: number of formats supported
604 * @crtc: currently bound CRTC
605 * @fb: currently bound fb
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800606 * @funcs: helper functions
Rob Clark4d939142012-05-17 02:23:27 -0600607 * @properties: property tracking for this plane
Matt Ropere27dde32014-04-01 15:22:30 -0700608 * @type: type of plane (overlay, primary, cursor)
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800609 */
610struct drm_plane {
611 struct drm_device *dev;
612 struct list_head head;
613
614 struct drm_mode_object base;
615
616 uint32_t possible_crtcs;
617 uint32_t *format_types;
618 uint32_t format_count;
619
620 struct drm_crtc *crtc;
621 struct drm_framebuffer *fb;
622
Daniel Vetter3d30a592014-07-27 13:42:42 +0200623 /* Temporary tracking of the old fb while a modeset is ongoing. Used
624 * by drm_mode_set_config_internal to implement correct refcounting. */
625 struct drm_framebuffer *old_fb;
626
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800627 const struct drm_plane_funcs *funcs;
Rob Clark4d939142012-05-17 02:23:27 -0600628
629 struct drm_object_properties properties;
Matt Ropere27dde32014-04-01 15:22:30 -0700630
631 enum drm_plane_type type;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800632};
633
634/**
Sean Paul3b336ec2013-08-14 16:47:37 -0400635 * drm_bridge_funcs - drm_bridge control functions
636 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
637 * @disable: Called right before encoder prepare, disables the bridge
638 * @post_disable: Called right after encoder prepare, for lockstepped disable
639 * @mode_set: Set this mode to the bridge
640 * @pre_enable: Called right before encoder commit, for lockstepped commit
641 * @enable: Called right after encoder commit, enables the bridge
642 * @destroy: make object go away
643 */
644struct drm_bridge_funcs {
645 bool (*mode_fixup)(struct drm_bridge *bridge,
646 const struct drm_display_mode *mode,
647 struct drm_display_mode *adjusted_mode);
648 void (*disable)(struct drm_bridge *bridge);
649 void (*post_disable)(struct drm_bridge *bridge);
650 void (*mode_set)(struct drm_bridge *bridge,
651 struct drm_display_mode *mode,
652 struct drm_display_mode *adjusted_mode);
653 void (*pre_enable)(struct drm_bridge *bridge);
654 void (*enable)(struct drm_bridge *bridge);
655 void (*destroy)(struct drm_bridge *bridge);
656};
657
658/**
659 * drm_bridge - central DRM bridge control structure
660 * @dev: DRM device this bridge belongs to
661 * @head: list management
662 * @base: base mode object
663 * @funcs: control functions
664 * @driver_private: pointer to the bridge driver's internal context
665 */
666struct drm_bridge {
667 struct drm_device *dev;
668 struct list_head head;
669
670 struct drm_mode_object base;
671
672 const struct drm_bridge_funcs *funcs;
673 void *driver_private;
674};
675
676/**
Jesse Barnesef273512011-11-07 12:03:19 -0800677 * drm_mode_set - new values for a CRTC config change
678 * @head: list management
679 * @fb: framebuffer to use for new config
680 * @crtc: CRTC whose configuration we're about to change
681 * @mode: mode timings to use
682 * @x: position of this CRTC relative to @fb
683 * @y: position of this CRTC relative to @fb
684 * @connectors: array of connectors to drive with this CRTC if possible
685 * @num_connectors: size of @connectors array
Dave Airlief453ba02008-11-07 14:05:41 -0800686 *
687 * Represents a single crtc the connectors that it drives with what mode
688 * and from which framebuffer it scans out from.
689 *
690 * This is used to set modes.
691 */
692struct drm_mode_set {
Dave Airlief453ba02008-11-07 14:05:41 -0800693 struct drm_framebuffer *fb;
694 struct drm_crtc *crtc;
695 struct drm_display_mode *mode;
696
697 uint32_t x;
698 uint32_t y;
699
700 struct drm_connector **connectors;
701 size_t num_connectors;
702};
703
704/**
Jesse Barnes550cebc2011-11-07 12:03:20 -0800705 * struct drm_mode_config_funcs - basic driver provided mode setting functions
706 * @fb_create: create a new framebuffer object
707 * @output_poll_changed: function to handle output configuration changes
708 *
709 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
710 * involve drivers.
Dave Airlief453ba02008-11-07 14:05:41 -0800711 */
712struct drm_mode_config_funcs {
Jesse Barnes550cebc2011-11-07 12:03:20 -0800713 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
714 struct drm_file *file_priv,
715 struct drm_mode_fb_cmd2 *mode_cmd);
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000716 void (*output_poll_changed)(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800717};
718
Jesse Barnesc1aaca22011-11-07 12:03:21 -0800719/**
720 * drm_mode_group - group of mode setting resources for potential sub-grouping
721 * @num_crtcs: CRTC count
722 * @num_encoders: encoder count
723 * @num_connectors: connector count
724 * @id_list: list of KMS object IDs in this group
725 *
726 * Currently this simply tracks the global mode setting state. But in the
727 * future it could allow groups of objects to be set aside into independent
728 * control groups for use by different user level processes (e.g. two X servers
729 * running simultaneously on different heads, each with their own mode
730 * configuration and freedom of mode setting).
731 */
Dave Airlief453ba02008-11-07 14:05:41 -0800732struct drm_mode_group {
733 uint32_t num_crtcs;
734 uint32_t num_encoders;
735 uint32_t num_connectors;
Sean Paul3b336ec2013-08-14 16:47:37 -0400736 uint32_t num_bridges;
Dave Airlief453ba02008-11-07 14:05:41 -0800737
738 /* list of object IDs for this group */
739 uint32_t *id_list;
740};
741
742/**
743 * drm_mode_config - Mode configuration control structure
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800744 * @mutex: mutex protecting KMS related lists and structures
745 * @idr_mutex: mutex for KMS ID allocation and management
746 * @crtc_idr: main KMS ID tracking object
747 * @num_fb: number of fbs available
748 * @fb_list: list of framebuffers available
749 * @num_connector: number of connectors on this device
750 * @connector_list: list of connector objects
Sean Paul3b336ec2013-08-14 16:47:37 -0400751 * @num_bridge: number of bridges on this device
752 * @bridge_list: list of bridge objects
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800753 * @num_encoder: number of encoders on this device
754 * @encoder_list: list of encoder objects
755 * @num_crtc: number of CRTCs on this device
756 * @crtc_list: list of CRTC objects
757 * @min_width: minimum pixel width on this device
758 * @min_height: minimum pixel height on this device
759 * @max_width: maximum pixel width on this device
760 * @max_height: maximum pixel height on this device
761 * @funcs: core driver provided mode setting functions
762 * @fb_base: base address of the framebuffer
763 * @poll_enabled: track polling status for this device
764 * @output_poll_work: delayed work for polling in process context
765 * @*_property: core property tracking
Dave Airlief453ba02008-11-07 14:05:41 -0800766 *
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800767 * Core mode resource tracking structure. All CRTC, encoders, and connectors
768 * enumerated by the driver are added here, as are global properties. Some
769 * global restrictions are also here, e.g. dimension restrictions.
Dave Airlief453ba02008-11-07 14:05:41 -0800770 */
771struct drm_mode_config {
Jesse Barnesad2563c2009-01-19 17:21:45 +1000772 struct mutex mutex; /* protects configuration (mode lists etc.) */
Rob Clark51fd3712013-11-19 12:10:12 -0500773 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
774 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
Jesse Barnesad2563c2009-01-19 17:21:45 +1000775 struct mutex idr_mutex; /* for IDR management */
Dave Airlief453ba02008-11-07 14:05:41 -0800776 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
777 /* this is limited to one for now */
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100778
779
780 /**
781 * fb_lock - mutex to protect fb state
782 *
783 * Besides the global fb list his also protects the fbs list in the
784 * file_priv
785 */
786 struct mutex fb_lock;
Dave Airlief453ba02008-11-07 14:05:41 -0800787 int num_fb;
788 struct list_head fb_list;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100789
Dave Airlief453ba02008-11-07 14:05:41 -0800790 int num_connector;
791 struct list_head connector_list;
Sean Paul3b336ec2013-08-14 16:47:37 -0400792 int num_bridge;
793 struct list_head bridge_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800794 int num_encoder;
795 struct list_head encoder_list;
Matt Ropere27dde32014-04-01 15:22:30 -0700796
797 /*
798 * Track # of overlay planes separately from # of total planes. By
799 * default we only advertise overlay planes to userspace; if userspace
800 * sets the "universal plane" capability bit, we'll go ahead and
801 * expose all planes.
802 */
803 int num_overlay_plane;
804 int num_total_plane;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800805 struct list_head plane_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800806
807 int num_crtc;
808 struct list_head crtc_list;
809
810 struct list_head property_list;
811
Dave Airlief453ba02008-11-07 14:05:41 -0800812 int min_width, min_height;
813 int max_width, max_height;
Laurent Pincharte6ecefa2012-05-17 13:27:23 +0200814 const struct drm_mode_config_funcs *funcs;
Benjamin Herrenschmidtd883f7f2009-02-02 16:55:45 +1100815 resource_size_t fb_base;
Dave Airlief453ba02008-11-07 14:05:41 -0800816
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000817 /* output poll support */
818 bool poll_enabled;
Daniel Vetter905bc9f2012-10-23 18:23:36 +0000819 bool poll_running;
Tejun Heo991ea752010-07-20 22:09:02 +0200820 struct delayed_work output_poll_work;
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000821
Dave Airlief453ba02008-11-07 14:05:41 -0800822 /* pointers to standard properties */
823 struct list_head property_blob_list;
824 struct drm_property *edid_property;
825 struct drm_property *dpms_property;
Dave Airlie43aba7e2014-06-05 14:01:31 +1000826 struct drm_property *path_property;
Rob Clark9922ab52014-04-01 20:16:57 -0400827 struct drm_property *plane_type_property;
Sonika Jindal2a297cc2014-08-05 11:26:54 +0530828 struct drm_property *rotation_property;
Dave Airlief453ba02008-11-07 14:05:41 -0800829
830 /* DVI-I properties */
831 struct drm_property *dvi_i_subconnector_property;
832 struct drm_property *dvi_i_select_subconnector_property;
833
834 /* TV properties */
835 struct drm_property *tv_subconnector_property;
836 struct drm_property *tv_select_subconnector_property;
837 struct drm_property *tv_mode_property;
838 struct drm_property *tv_left_margin_property;
839 struct drm_property *tv_right_margin_property;
840 struct drm_property *tv_top_margin_property;
841 struct drm_property *tv_bottom_margin_property;
Francisco Jerezb6b79022009-08-02 04:19:20 +0200842 struct drm_property *tv_brightness_property;
843 struct drm_property *tv_contrast_property;
844 struct drm_property *tv_flicker_reduction_property;
Francisco Jereza75f0232009-08-12 02:30:10 +0200845 struct drm_property *tv_overscan_property;
846 struct drm_property *tv_saturation_property;
847 struct drm_property *tv_hue_property;
Dave Airlief453ba02008-11-07 14:05:41 -0800848
849 /* Optional properties */
850 struct drm_property *scaling_mode_property;
Vandana Kannanff587e42014-06-11 10:46:48 +0530851 struct drm_property *aspect_ratio_property;
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000852 struct drm_property *dirty_info_property;
Dave Airlie019d96c2011-09-29 16:20:42 +0100853
854 /* dumb ioctl parameters */
855 uint32_t preferred_depth, prefer_shadow;
Keith Packard62f21042013-07-22 18:50:00 -0700856
857 /* whether async page flip is supported or not */
858 bool async_page_flip;
Alex Deucher8716ed42014-02-12 12:48:23 -0500859
860 /* cursor size */
861 uint32_t cursor_width, cursor_height;
Dave Airlief453ba02008-11-07 14:05:41 -0800862};
863
864#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
865#define obj_to_connector(x) container_of(x, struct drm_connector, base)
866#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
867#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
868#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
869#define obj_to_property(x) container_of(x, struct drm_property, base)
870#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800871#define obj_to_plane(x) container_of(x, struct drm_plane, base)
Dave Airlief453ba02008-11-07 14:05:41 -0800872
Sascha Hauer4a67d392012-02-06 10:58:17 +0100873struct drm_prop_enum_list {
874 int type;
875 char *name;
876};
Dave Airlief453ba02008-11-07 14:05:41 -0800877
Matt Ropere13161a2014-04-01 15:22:38 -0700878extern int drm_crtc_init_with_planes(struct drm_device *dev,
879 struct drm_crtc *crtc,
880 struct drm_plane *primary,
Matt Roperfc1d3e42014-06-10 08:28:11 -0700881 struct drm_plane *cursor,
Matt Ropere13161a2014-04-01 15:22:38 -0700882 const struct drm_crtc_funcs *funcs);
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200883extern int drm_crtc_init(struct drm_device *dev,
884 struct drm_crtc *crtc,
885 const struct drm_crtc_funcs *funcs);
Dave Airlief453ba02008-11-07 14:05:41 -0800886extern void drm_crtc_cleanup(struct drm_crtc *crtc);
Russell Kingdb5f7a62014-01-02 21:27:33 +0000887extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
888
889/**
890 * drm_crtc_mask - find the mask of a registered CRTC
891 * @crtc: CRTC to find mask for
892 *
893 * Given a registered CRTC, return the mask bit of that CRTC for an
894 * encoder's possible_crtcs field.
895 */
896static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
897{
898 return 1 << drm_crtc_index(crtc);
899}
Dave Airlief453ba02008-11-07 14:05:41 -0800900
Ilia Mirkinb21e3af2013-08-07 22:34:48 -0400901extern void drm_connector_ida_init(void);
902extern void drm_connector_ida_destroy(void);
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200903extern int drm_connector_init(struct drm_device *dev,
904 struct drm_connector *connector,
905 const struct drm_connector_funcs *funcs,
906 int connector_type);
Thomas Wood34ea3d32014-05-29 16:57:41 +0100907int drm_connector_register(struct drm_connector *connector);
908void drm_connector_unregister(struct drm_connector *connector);
Dave Airlief453ba02008-11-07 14:05:41 -0800909
910extern void drm_connector_cleanup(struct drm_connector *connector);
Daniel Vetter10f637b2014-07-29 13:47:11 +0200911extern unsigned int drm_connector_index(struct drm_connector *connector);
Dave Airliecbc7e222012-02-20 14:16:40 +0000912/* helper to unplug all connectors from sysfs for device */
913extern void drm_connector_unplug_all(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800914
Sean Paul3b336ec2013-08-14 16:47:37 -0400915extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
916 const struct drm_bridge_funcs *funcs);
917extern void drm_bridge_cleanup(struct drm_bridge *bridge);
918
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200919extern int drm_encoder_init(struct drm_device *dev,
920 struct drm_encoder *encoder,
921 const struct drm_encoder_funcs *funcs,
922 int encoder_type);
Dave Airlief453ba02008-11-07 14:05:41 -0800923
Thierry Reding3d887362014-01-13 14:33:20 +0100924/**
925 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
926 * @encoder: encoder to test
927 * @crtc: crtc to test
928 *
929 * Return false if @encoder can't be driven by @crtc, true otherwise.
930 */
931static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
932 struct drm_crtc *crtc)
933{
934 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
935}
936
Matt Roperdc415ff2014-04-01 15:22:36 -0700937extern int drm_universal_plane_init(struct drm_device *dev,
938 struct drm_plane *plane,
939 unsigned long possible_crtcs,
940 const struct drm_plane_funcs *funcs,
941 const uint32_t *formats,
942 uint32_t format_count,
943 enum drm_plane_type type);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800944extern int drm_plane_init(struct drm_device *dev,
945 struct drm_plane *plane,
946 unsigned long possible_crtcs,
947 const struct drm_plane_funcs *funcs,
Rob Clark0a7eb242011-12-13 20:19:36 -0600948 const uint32_t *formats, uint32_t format_count,
Matt Roperdc415ff2014-04-01 15:22:36 -0700949 bool is_primary);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800950extern void drm_plane_cleanup(struct drm_plane *plane);
Daniel Vetter10f637b2014-07-29 13:47:11 +0200951extern unsigned int drm_plane_index(struct drm_plane *plane);
Ville Syrjälä9125e612013-06-03 16:10:40 +0300952extern void drm_plane_force_disable(struct drm_plane *plane);
Matt Roperaf936292014-04-01 15:22:34 -0700953extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
954 int x, int y,
955 const struct drm_display_mode *mode,
956 const struct drm_framebuffer *fb);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800957
Dave Airlief453ba02008-11-07 14:05:41 -0800958extern void drm_encoder_cleanup(struct drm_encoder *encoder);
959
Ville Syrjäläd20d3172013-06-07 15:43:07 +0000960extern const char *drm_get_connector_status_name(enum drm_connector_status status);
Jesse Barnesac1bb362014-02-10 15:32:44 -0800961extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
Ville Syrjäläd20d3172013-06-07 15:43:07 +0000962extern const char *drm_get_dpms_name(int val);
963extern const char *drm_get_dvi_i_subconnector_name(int val);
964extern const char *drm_get_dvi_i_select_name(int val);
965extern const char *drm_get_tv_subconnector_name(int val);
966extern const char *drm_get_tv_select_name(int val);
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500967extern void drm_fb_release(struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -0800968extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
Dave Airliead222792014-05-02 13:22:19 +1000969extern void drm_mode_group_destroy(struct drm_mode_group *group);
Dave Airlie2390cd12014-06-05 14:01:29 +1000970extern void drm_reinit_primary_mode_group(struct drm_device *dev);
Adam Jacksonfbff4692012-09-18 10:58:47 -0400971extern bool drm_probe_ddc(struct i2c_adapter *adapter);
Dave Airlief453ba02008-11-07 14:05:41 -0800972extern struct edid *drm_get_edid(struct drm_connector *connector,
973 struct i2c_adapter *adapter);
Jani Nikula51f8da52013-09-27 15:08:27 +0300974extern struct edid *drm_edid_duplicate(const struct edid *edid);
Dave Airlief453ba02008-11-07 14:05:41 -0800975extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
Dave Airlief453ba02008-11-07 14:05:41 -0800976extern void drm_mode_config_init(struct drm_device *dev);
Chris Wilsoneb033552011-01-24 15:11:08 +0000977extern void drm_mode_config_reset(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800978extern void drm_mode_config_cleanup(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800979
Dave Airlie43aba7e2014-06-05 14:01:31 +1000980extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
981 char *path);
Dave Airlief453ba02008-11-07 14:05:41 -0800982extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
983 struct edid *edid);
Rob Clark5ea22f22014-05-30 11:34:01 -0400984
985static inline bool drm_property_type_is(struct drm_property *property,
986 uint32_t type)
987{
988 /* instanceof for props.. handles extended type vs original types: */
989 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
990 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
991 return property->flags & type;
992}
993
994static inline bool drm_property_type_valid(struct drm_property *property)
995{
996 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
997 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
998 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
999}
1000
Paulo Zanonic5431882012-05-15 18:09:02 -03001001extern int drm_object_property_set_value(struct drm_mode_object *obj,
1002 struct drm_property *property,
1003 uint64_t val);
1004extern int drm_object_property_get_value(struct drm_mode_object *obj,
1005 struct drm_property *property,
1006 uint64_t *value);
Dave Airlief453ba02008-11-07 14:05:41 -08001007extern int drm_framebuffer_init(struct drm_device *dev,
1008 struct drm_framebuffer *fb,
1009 const struct drm_framebuffer_funcs *funcs);
Daniel Vetter786b99e2012-12-02 21:53:40 +01001010extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
1011 uint32_t id);
Rob Clarkf7eff602012-09-05 21:48:38 +00001012extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
1013extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
1014extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -08001015extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
Daniel Vetter36206362012-12-10 20:42:17 +01001016extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -08001017
Paulo Zanonic5431882012-05-15 18:09:02 -03001018extern void drm_object_attach_property(struct drm_mode_object *obj,
1019 struct drm_property *property,
1020 uint64_t init_val);
Dave Airlief453ba02008-11-07 14:05:41 -08001021extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
1022 const char *name, int num_values);
Sascha Hauer4a67d392012-02-06 10:58:17 +01001023extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
1024 const char *name,
1025 const struct drm_prop_enum_list *props,
1026 int num_values);
Rob Clark49e27542012-05-17 02:23:26 -06001027struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
1028 int flags, const char *name,
1029 const struct drm_prop_enum_list *props,
Ville Syrjälä7689ffb2014-07-08 10:31:52 +05301030 int num_props,
1031 uint64_t supported_bits);
Sascha Hauerd9bc3c02012-02-06 10:58:18 +01001032struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
1033 const char *name,
1034 uint64_t min, uint64_t max);
Rob Clarkebc44cf2012-09-12 22:22:31 -05001035struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
1036 int flags, const char *name,
1037 int64_t min, int64_t max);
Rob Clark98f75de2014-05-30 11:37:03 -04001038struct drm_property *drm_property_create_object(struct drm_device *dev,
1039 int flags, const char *name, uint32_t type);
Dave Airlief453ba02008-11-07 14:05:41 -08001040extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1041extern int drm_property_add_enum(struct drm_property *property, int index,
1042 uint64_t value, const char *name);
1043extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1044extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1045 char *formats[]);
1046extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
Vandana Kannanff587e42014-06-11 10:46:48 +05301047extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001048extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -08001049
1050extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1051 struct drm_encoder *encoder);
Sascha Hauer4cae5b82012-02-01 11:38:23 +01001052extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
Dave Airlief453ba02008-11-07 14:05:41 -08001053 int gamma_size);
Daniel Vetter7a9c9062009-09-15 22:57:31 +02001054extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1055 uint32_t id, uint32_t type);
Rob Clark98f75de2014-05-30 11:37:03 -04001056
Dave Airlief453ba02008-11-07 14:05:41 -08001057/* IOCTLs */
1058extern int drm_mode_getresources(struct drm_device *dev,
1059 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001060extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1061 struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001062extern int drm_mode_getcrtc(struct drm_device *dev,
1063 void *data, struct drm_file *file_priv);
1064extern int drm_mode_getconnector(struct drm_device *dev,
1065 void *data, struct drm_file *file_priv);
Daniel Vetter2d13b672012-12-11 13:47:23 +01001066extern int drm_mode_set_config_internal(struct drm_mode_set *set);
Dave Airlief453ba02008-11-07 14:05:41 -08001067extern int drm_mode_setcrtc(struct drm_device *dev,
1068 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001069extern int drm_mode_getplane(struct drm_device *dev,
1070 void *data, struct drm_file *file_priv);
1071extern int drm_mode_setplane(struct drm_device *dev,
1072 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001073extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1074 void *data, struct drm_file *file_priv);
Dave Airlie4c813d42013-06-20 11:48:52 +10001075extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1076 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001077extern int drm_mode_addfb(struct drm_device *dev,
1078 void *data, struct drm_file *file_priv);
Jesse Barnes308e5bc2011-11-14 14:51:28 -08001079extern int drm_mode_addfb2(struct drm_device *dev,
1080 void *data, struct drm_file *file_priv);
1081extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
Dave Airlief453ba02008-11-07 14:05:41 -08001082extern int drm_mode_rmfb(struct drm_device *dev,
1083 void *data, struct drm_file *file_priv);
1084extern int drm_mode_getfb(struct drm_device *dev,
1085 void *data, struct drm_file *file_priv);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001086extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1087 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001088
1089extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1090 void *data, struct drm_file *file_priv);
1091extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1092 void *data, struct drm_file *file_priv);
1093extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1094 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001095extern int drm_mode_getencoder(struct drm_device *dev,
1096 void *data, struct drm_file *file_priv);
1097extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1098 void *data, struct drm_file *file_priv);
1099extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1100 void *data, struct drm_file *file_priv);
Thierry Reding18316c82012-12-20 15:41:44 +01001101extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
Vandana Kannan0967e6a2014-04-01 16:26:59 +05301102extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
Ma Lingf23c20c2009-03-26 19:26:23 +08001103extern bool drm_detect_hdmi_monitor(struct edid *edid);
Zhenyu Wang8fe97902010-09-19 14:27:28 +08001104extern bool drm_detect_monitor_audio(struct edid *edid);
Ville Syrjäläb1edd6a2013-01-17 16:31:30 +02001105extern bool drm_rgb_quant_range_selectable(struct edid *edid);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -05001106extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1107 void *data, struct drm_file *file_priv);
Zhao Yakuif0fda0a2009-09-03 09:33:48 +08001108extern int drm_add_modes_noedid(struct drm_connector *connector,
1109 int hdisplay, int vdisplay);
Gerd Hoffmann3cf70da2013-10-11 10:01:08 +02001110extern void drm_set_preferred_mode(struct drm_connector *connector,
1111 int hpref, int vpref);
Alex Deucher3c537882010-02-05 04:21:19 -05001112
Thomas Reim051963d2011-07-29 14:28:57 +00001113extern int drm_edid_header_is_valid(const u8 *raw_edid);
Jerome Glisse0b2443e2012-08-09 11:25:51 -04001114extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
Alex Deucher3c537882010-02-05 04:21:19 -05001115extern bool drm_edid_is_valid(struct edid *edid);
Dave Airlie1d42bbc2010-05-07 05:02:30 +00001116struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
Adam Jacksonf6e252b2012-04-13 16:33:31 -04001117 int hsize, int vsize, int fresh,
1118 bool rb);
Dave Airlieff72145b2011-02-07 12:16:14 +10001119
1120extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1121 void *data, struct drm_file *file_priv);
1122extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1123 void *data, struct drm_file *file_priv);
1124extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1125 void *data, struct drm_file *file_priv);
Paulo Zanonic5431882012-05-15 18:09:02 -03001126extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1127 struct drm_file *file_priv);
1128extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1129 struct drm_file *file_priv);
Thomas Wood3a5f87c2014-08-20 14:45:00 +01001130extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
1131 struct drm_property *property,
1132 uint64_t value);
Dave Airlie248dbc22011-11-29 20:02:54 +00001133
1134extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1135 int *bpp);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001136extern int drm_format_num_planes(uint32_t format);
Ville Syrjälä5a86bd52012-04-05 21:35:16 +03001137extern int drm_format_plane_cpp(uint32_t format, int plane);
Ville Syrjälä01b68b02012-04-05 21:35:17 +03001138extern int drm_format_horz_chroma_subsampling(uint32_t format);
1139extern int drm_format_vert_chroma_subsampling(uint32_t format);
Ville Syrjäläd20d3172013-06-07 15:43:07 +00001140extern const char *drm_get_format_name(uint32_t format);
Ville Syrjäläc1df5f32014-07-08 10:31:53 +05301141extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
1142 unsigned int supported_rotations);
Ville Syrjälä3c9855f2014-07-08 10:31:56 +05301143extern unsigned int drm_rotation_simplify(unsigned int rotation,
1144 unsigned int supported_rotations);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001145
Russell King96f60e32012-08-15 13:59:49 +01001146/* Helpers */
Rob Clarka2b34e22013-10-05 16:36:52 -04001147
1148static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1149 uint32_t id)
1150{
1151 struct drm_mode_object *mo;
1152 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1153 return mo ? obj_to_plane(mo) : NULL;
1154}
1155
Russell King96f60e32012-08-15 13:59:49 +01001156static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1157 uint32_t id)
1158{
1159 struct drm_mode_object *mo;
1160 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1161 return mo ? obj_to_crtc(mo) : NULL;
1162}
1163
1164static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1165 uint32_t id)
1166{
1167 struct drm_mode_object *mo;
1168 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1169 return mo ? obj_to_encoder(mo) : NULL;
1170}
1171
Rob Clarka2b34e22013-10-05 16:36:52 -04001172static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1173 uint32_t id)
1174{
1175 struct drm_mode_object *mo;
1176 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1177 return mo ? obj_to_connector(mo) : NULL;
1178}
1179
1180static inline struct drm_property *drm_property_find(struct drm_device *dev,
1181 uint32_t id)
1182{
1183 struct drm_mode_object *mo;
1184 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1185 return mo ? obj_to_property(mo) : NULL;
1186}
1187
1188static inline struct drm_property_blob *
1189drm_property_blob_find(struct drm_device *dev, uint32_t id)
1190{
1191 struct drm_mode_object *mo;
1192 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1193 return mo ? obj_to_blob(mo) : NULL;
1194}
1195
Matt Ropere27dde32014-04-01 15:22:30 -07001196/* Plane list iterator for legacy (overlay only) planes. */
1197#define drm_for_each_legacy_plane(plane, planelist) \
1198 list_for_each_entry(plane, planelist, head) \
1199 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1200
Dave Airlief453ba02008-11-07 14:05:41 -08001201#endif /* __DRM_CRTC_H__ */