blob: a7fac5686915f21c728315a9c6533cb25cf9879a [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>
Jesse Barnes308e5bc2011-11-14 14:51:28 -080035#include <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;
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
Rob Clark98f75de2014-05-30 11:37:03 -040054#define DRM_MODE_OBJECT_ANY 0
Dave Airlief453ba02008-11-07 14:05:41 -080055
56struct drm_mode_object {
57 uint32_t id;
58 uint32_t type;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030059 struct drm_object_properties *properties;
60};
61
Paulo Zanonife456162012-06-12 11:27:01 -030062#define DRM_OBJECT_MAX_PROPERTY 24
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030063struct drm_object_properties {
Paulo Zanoni7f88a9b2012-05-15 18:09:04 -030064 int count;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -030065 uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
66 uint64_t values[DRM_OBJECT_MAX_PROPERTY];
Dave Airlief453ba02008-11-07 14:05:41 -080067};
68
Rob Clarkebc44cf2012-09-12 22:22:31 -050069static inline int64_t U642I64(uint64_t val)
70{
71 return (int64_t)*((int64_t *)&val);
72}
73static inline uint64_t I642U64(int64_t val)
74{
75 return (uint64_t)*((uint64_t *)&val);
76}
77
Daniel Vetter55310002014-01-23 15:52:20 +010078enum drm_connector_force {
79 DRM_FORCE_UNSPECIFIED,
80 DRM_FORCE_OFF,
81 DRM_FORCE_ON, /* force on analog part normally */
82 DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
Dave Airlief453ba02008-11-07 14:05:41 -080083};
84
Daniel Vetter55310002014-01-23 15:52:20 +010085#include <drm/drm_modes.h>
Damien Lespiau4aa17cf2013-09-25 16:45:21 +010086
Dave Airlief453ba02008-11-07 14:05:41 -080087enum drm_connector_status {
88 connector_status_connected = 1,
89 connector_status_disconnected = 2,
90 connector_status_unknown = 3,
91};
92
93enum subpixel_order {
94 SubPixelUnknown = 0,
95 SubPixelHorizontalRGB,
96 SubPixelHorizontalBGR,
97 SubPixelVerticalRGB,
98 SubPixelVerticalBGR,
99 SubPixelNone,
100};
101
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700102#define DRM_COLOR_FORMAT_RGB444 (1<<0)
103#define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
104#define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
Dave Airlief453ba02008-11-07 14:05:41 -0800105/*
106 * Describes a given display (e.g. CRT or flat panel) and its limitations.
107 */
108struct drm_display_info {
109 char name[DRM_DISPLAY_INFO_LEN];
Adam Jacksonfb439642010-08-03 14:38:16 -0400110
Dave Airlief453ba02008-11-07 14:05:41 -0800111 /* Physical size */
112 unsigned int width_mm;
113 unsigned int height_mm;
114
Dave Airlief453ba02008-11-07 14:05:41 -0800115 /* Clock limits FIXME: storage format */
116 unsigned int min_vfreq, max_vfreq;
117 unsigned int min_hfreq, max_hfreq;
118 unsigned int pixel_clock;
Jesse Barnes3b112282011-04-15 12:49:23 -0700119 unsigned int bpc;
Dave Airlief453ba02008-11-07 14:05:41 -0800120
Dave Airlief453ba02008-11-07 14:05:41 -0800121 enum subpixel_order subpixel_order;
Jesse Barnesda05a5a72011-04-15 13:48:57 -0700122 u32 color_formats;
Dave Airlief453ba02008-11-07 14:05:41 -0800123
Jesse Barnesebec9a72011-08-03 09:22:54 -0700124 u8 cea_rev;
Dave Airlief453ba02008-11-07 14:05:41 -0800125};
126
127struct drm_framebuffer_funcs {
Rob Clarkf7eff602012-09-05 21:48:38 +0000128 /* note: use drm_framebuffer_remove() */
Dave Airlief453ba02008-11-07 14:05:41 -0800129 void (*destroy)(struct drm_framebuffer *framebuffer);
130 int (*create_handle)(struct drm_framebuffer *fb,
131 struct drm_file *file_priv,
132 unsigned int *handle);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000133 /**
134 * Optinal callback for the dirty fb ioctl.
135 *
136 * Userspace can notify the driver via this callback
137 * that a area of the framebuffer has changed and should
138 * be flushed to the display hardware.
139 *
140 * See documentation in drm_mode.h for the struct
141 * drm_mode_fb_dirty_cmd for more information as all
142 * the semantics and arguments have a one to one mapping
143 * on this function.
144 */
Thomas Hellstrom02b00162010-10-05 12:43:02 +0200145 int (*dirty)(struct drm_framebuffer *framebuffer,
146 struct drm_file *file_priv, unsigned flags,
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000147 unsigned color, struct drm_clip_rect *clips,
148 unsigned num_clips);
Dave Airlief453ba02008-11-07 14:05:41 -0800149};
150
151struct drm_framebuffer {
152 struct drm_device *dev;
Rob Clarkf7eff602012-09-05 21:48:38 +0000153 /*
154 * Note that the fb is refcounted for the benefit of driver internals,
155 * for example some hw, disabling a CRTC/plane is asynchronous, and
156 * scanout does not actually complete until the next vblank. So some
157 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
158 * should be deferred. In cases like this, the driver would like to
159 * hold a ref to the fb even though it has already been removed from
160 * userspace perspective.
161 */
162 struct kref refcount;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100163 /*
164 * Place on the dev->mode_config.fb_list, access protected by
165 * dev->mode_config.fb_lock.
166 */
Dave Airlief453ba02008-11-07 14:05:41 -0800167 struct list_head head;
168 struct drm_mode_object base;
169 const struct drm_framebuffer_funcs *funcs;
Ville Syrjälä01f2c772011-12-20 00:06:49 +0200170 unsigned int pitches[4];
171 unsigned int offsets[4];
Dave Airlief453ba02008-11-07 14:05:41 -0800172 unsigned int width;
173 unsigned int height;
174 /* depth can be 15 or 16 */
175 unsigned int depth;
176 int bits_per_pixel;
177 int flags;
Jesse Barnes308e5bc2011-11-14 14:51:28 -0800178 uint32_t pixel_format; /* fourcc format */
Dave Airlief453ba02008-11-07 14:05:41 -0800179 struct list_head filp_head;
Dave Airlie785b93e2009-08-28 15:46:53 +1000180 /* if you are using the helper */
181 void *helper_private;
Dave Airlief453ba02008-11-07 14:05:41 -0800182};
183
184struct drm_property_blob {
185 struct drm_mode_object base;
186 struct list_head head;
187 unsigned int length;
Ville Syrjäläd63f5e62012-03-13 12:35:49 +0200188 unsigned char data[];
Dave Airlief453ba02008-11-07 14:05:41 -0800189};
190
191struct drm_property_enum {
192 uint64_t value;
193 struct list_head head;
194 char name[DRM_PROP_NAME_LEN];
195};
196
197struct drm_property {
198 struct list_head head;
199 struct drm_mode_object base;
200 uint32_t flags;
201 char name[DRM_PROP_NAME_LEN];
202 uint32_t num_values;
203 uint64_t *values;
Rob Clark98f75de2014-05-30 11:37:03 -0400204 struct drm_device *dev;
Dave Airlief453ba02008-11-07 14:05:41 -0800205
206 struct list_head enum_blob_list;
207};
208
Rob Clark51fd3712013-11-19 12:10:12 -0500209void drm_modeset_lock_all(struct drm_device *dev);
210void drm_modeset_unlock_all(struct drm_device *dev);
211void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
212
Dave Airlief453ba02008-11-07 14:05:41 -0800213struct drm_crtc;
214struct drm_connector;
215struct drm_encoder;
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500216struct drm_pending_vblank_event;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800217struct drm_plane;
Sean Paul3b336ec2013-08-14 16:47:37 -0400218struct drm_bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800219
220/**
221 * drm_crtc_funcs - control CRTCs for a given device
Dave Airlief453ba02008-11-07 14:05:41 -0800222 * @save: save CRTC state
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200223 * @restore: restore CRTC state
Christopher Harvey715f59c2013-04-05 15:28:32 +0000224 * @reset: reset CRTC after state has been invalidated (e.g. resume)
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200225 * @cursor_set: setup the cursor
226 * @cursor_move: move the cursor
Dave Airlief453ba02008-11-07 14:05:41 -0800227 * @gamma_set: specify color ramp for CRTC
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300228 * @destroy: deinit and free object
229 * @set_property: called when a property is changed
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200230 * @set_config: apply a new CRTC configuration
231 * @page_flip: initiate a page flip
Dave Airlief453ba02008-11-07 14:05:41 -0800232 *
233 * The drm_crtc_funcs structure is the central CRTC management structure
234 * in the DRM. Each CRTC controls one or more connectors (note that the name
235 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
236 * connectors, not just CRTs).
237 *
238 * Each driver is responsible for filling out this structure at startup time,
239 * in addition to providing other modesetting features, like i2c and DDC
240 * bus accessors.
241 */
242struct drm_crtc_funcs {
243 /* Save CRTC state */
244 void (*save)(struct drm_crtc *crtc); /* suspend? */
245 /* Restore CRTC state */
246 void (*restore)(struct drm_crtc *crtc); /* resume? */
Chris Wilsoneb033552011-01-24 15:11:08 +0000247 /* Reset CRTC state */
248 void (*reset)(struct drm_crtc *crtc);
Dave Airlief453ba02008-11-07 14:05:41 -0800249
250 /* cursor controls */
251 int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
252 uint32_t handle, uint32_t width, uint32_t height);
Dave Airlie4c813d42013-06-20 11:48:52 +1000253 int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
254 uint32_t handle, uint32_t width, uint32_t height,
255 int32_t hot_x, int32_t hot_y);
Dave Airlief453ba02008-11-07 14:05:41 -0800256 int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
257
258 /* Set gamma on the CRTC */
259 void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
James Simmons72034252010-08-03 01:33:19 +0100260 uint32_t start, uint32_t size);
Dave Airlief453ba02008-11-07 14:05:41 -0800261 /* Object destroy routine */
262 void (*destroy)(struct drm_crtc *crtc);
263
264 int (*set_config)(struct drm_mode_set *set);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500265
266 /*
267 * Flip to the given framebuffer. This implements the page
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300268 * flip ioctl described in drm_mode.h, specifically, the
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -0500269 * implementation must return immediately and block all
270 * rendering to the current fb until the flip has completed.
271 * If userspace set the event flag in the ioctl, the event
272 * argument will point to an event to send back when the flip
273 * completes, otherwise it will be NULL.
274 */
275 int (*page_flip)(struct drm_crtc *crtc,
276 struct drm_framebuffer *fb,
Keith Packarded8d1972013-07-22 18:49:58 -0700277 struct drm_pending_vblank_event *event,
278 uint32_t flags);
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300279
280 int (*set_property)(struct drm_crtc *crtc,
281 struct drm_property *property, uint64_t val);
Dave Airlief453ba02008-11-07 14:05:41 -0800282};
283
284/**
285 * drm_crtc - central CRTC control structure
Jesse Barnes77491632011-11-07 12:03:14 -0800286 * @dev: parent DRM device
287 * @head: list management
Rob Clark51fd3712013-11-19 12:10:12 -0500288 * @mutex: per-CRTC locking
Jesse Barnes77491632011-11-07 12:03:14 -0800289 * @base: base KMS object for ID tracking etc.
Matt Ropere13161a2014-04-01 15:22:38 -0700290 * @primary: primary plane for this CRTC
291 * @cursor: cursor plane for this CRTC
Dave Airlief453ba02008-11-07 14:05:41 -0800292 * @enabled: is this CRTC enabled?
Jesse Barnes77491632011-11-07 12:03:14 -0800293 * @mode: current mode timings
294 * @hwmode: mode timings as programmed to hw regs
Rob Clark7c80e122012-09-04 16:35:56 +0000295 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
296 * invert the width/height of the crtc. This is used if the driver
297 * is performing 90 or 270 degree rotated scanout
Dave Airlief453ba02008-11-07 14:05:41 -0800298 * @x: x position on screen
299 * @y: y position on screen
Dave Airlief453ba02008-11-07 14:05:41 -0800300 * @funcs: CRTC control functions
Jesse Barnes77491632011-11-07 12:03:14 -0800301 * @gamma_size: size of gamma ramp
302 * @gamma_store: gamma ramp values
303 * @framedur_ns: precise frame timing
304 * @framedur_ns: precise line timing
305 * @pixeldur_ns: precise pixel timing
306 * @helper_private: mid-layer private data
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300307 * @properties: property tracking for this CRTC
Dave Airlief453ba02008-11-07 14:05:41 -0800308 *
309 * Each CRTC may have one or more connectors associated with it. This structure
310 * allows the CRTC to be controlled.
311 */
312struct drm_crtc {
313 struct drm_device *dev;
314 struct list_head head;
315
Daniel Vetter29494c12012-12-02 02:18:25 +0100316 /**
317 * crtc mutex
318 *
319 * This provides a read lock for the overall crtc state (mode, dpms
320 * state, ...) and a write lock for everything which can be update
321 * without a full modeset (fb, cursor data, ...)
322 */
Rob Clark51fd3712013-11-19 12:10:12 -0500323 struct drm_modeset_lock mutex;
Daniel Vetter29494c12012-12-02 02:18:25 +0100324
Dave Airlief453ba02008-11-07 14:05:41 -0800325 struct drm_mode_object base;
326
Matt Ropere13161a2014-04-01 15:22:38 -0700327 /* primary and cursor planes for CRTC */
328 struct drm_plane *primary;
329 struct drm_plane *cursor;
330
Daniel Vetter5cef29a2013-06-15 00:13:16 +0200331 /* Temporary tracking of the old fb while a modeset is ongoing. Used
332 * by drm_mode_set_config_internal to implement correct refcounting. */
333 struct drm_framebuffer *old_fb;
334
Dave Airlief453ba02008-11-07 14:05:41 -0800335 bool enabled;
336
Mario Kleiner27641c32010-10-23 04:20:23 +0200337 /* Requested mode from modesetting. */
Dave Airlief453ba02008-11-07 14:05:41 -0800338 struct drm_display_mode mode;
339
Mario Kleiner27641c32010-10-23 04:20:23 +0200340 /* Programmed mode in hw, after adjustments for encoders,
341 * crtc, panel scaling etc. Needed for timestamping etc.
342 */
343 struct drm_display_mode hwmode;
344
Rob Clark7c80e122012-09-04 16:35:56 +0000345 bool invert_dimensions;
346
Dave Airlief453ba02008-11-07 14:05:41 -0800347 int x, y;
Dave Airlief453ba02008-11-07 14:05:41 -0800348 const struct drm_crtc_funcs *funcs;
349
350 /* CRTC gamma size for reporting to userspace */
351 uint32_t gamma_size;
352 uint16_t *gamma_store;
353
Mario Kleiner27641c32010-10-23 04:20:23 +0200354 /* Constants needed for precise vblank and swap timestamping. */
Ville Syrjälä3c184f62013-10-26 17:38:52 +0300355 int framedur_ns, linedur_ns, pixeldur_ns;
Mario Kleiner27641c32010-10-23 04:20:23 +0200356
Dave Airlief453ba02008-11-07 14:05:41 -0800357 /* if you are using the helper */
358 void *helper_private;
Paulo Zanonibffd9de02012-05-15 18:09:05 -0300359
360 struct drm_object_properties properties;
Dave Airlief453ba02008-11-07 14:05:41 -0800361};
362
363
364/**
365 * drm_connector_funcs - control connectors on a given device
366 * @dpms: set power state (see drm_crtc_funcs above)
367 * @save: save connector state
368 * @restore: restore connector state
Christopher Harvey13bcf012013-03-07 10:42:25 -0500369 * @reset: reset connector after state has been invalidated (e.g. resume)
Dave Airlief453ba02008-11-07 14:05:41 -0800370 * @detect: is this connector active?
Laurent Pinchart3b02ab82012-05-17 13:27:20 +0200371 * @fill_modes: fill mode list for this connector
Christopher Harvey13bcf012013-03-07 10:42:25 -0500372 * @set_property: property for this connector may need an update
Dave Airlief453ba02008-11-07 14:05:41 -0800373 * @destroy: make object go away
Christopher Harvey13bcf012013-03-07 10:42:25 -0500374 * @force: notify the driver that the connector is forced on
Dave Airlief453ba02008-11-07 14:05:41 -0800375 *
376 * Each CRTC may have one or more connectors attached to it. The functions
377 * below allow the core DRM code to control connectors, enumerate available modes,
378 * etc.
379 */
380struct drm_connector_funcs {
381 void (*dpms)(struct drm_connector *connector, int mode);
382 void (*save)(struct drm_connector *connector);
383 void (*restore)(struct drm_connector *connector);
Chris Wilsoneb033552011-01-24 15:11:08 +0000384 void (*reset)(struct drm_connector *connector);
Chris Wilson930a9e22010-09-14 11:07:23 +0100385
386 /* Check to see if anything is attached to the connector.
387 * @force is set to false whilst polling, true when checking the
388 * connector due to user request. @force can be used by the driver
389 * to avoid expensive, destructive operations during automated
390 * probing.
391 */
Chris Wilson7b334fc2010-09-09 23:51:02 +0100392 enum drm_connector_status (*detect)(struct drm_connector *connector,
Chris Wilson930a9e22010-09-14 11:07:23 +0100393 bool force);
Jesse Barnes40a518d2009-01-12 12:05:32 -0800394 int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
Dave Airlief453ba02008-11-07 14:05:41 -0800395 int (*set_property)(struct drm_connector *connector, struct drm_property *property,
396 uint64_t val);
397 void (*destroy)(struct drm_connector *connector);
Dave Airlied50ba252009-09-23 14:44:08 +1000398 void (*force)(struct drm_connector *connector);
Dave Airlief453ba02008-11-07 14:05:41 -0800399};
400
Jesse Barnes6c3db922011-11-07 12:03:16 -0800401/**
402 * drm_encoder_funcs - encoder controls
403 * @reset: reset state (e.g. at init or resume time)
404 * @destroy: cleanup and free associated data
405 *
406 * Encoders sit between CRTCs and connectors.
407 */
Dave Airlief453ba02008-11-07 14:05:41 -0800408struct drm_encoder_funcs {
Chris Wilsoneb033552011-01-24 15:11:08 +0000409 void (*reset)(struct drm_encoder *encoder);
Dave Airlief453ba02008-11-07 14:05:41 -0800410 void (*destroy)(struct drm_encoder *encoder);
411};
412
Ben Skeggsafe887d2012-01-12 16:00:57 +1000413#define DRM_CONNECTOR_MAX_ENCODER 3
Dave Airlief453ba02008-11-07 14:05:41 -0800414
415/**
416 * drm_encoder - central DRM encoder structure
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800417 * @dev: parent DRM device
418 * @head: list management
419 * @base: base KMS object
Jani Nikulae5748942014-05-14 16:58:20 +0300420 * @name: encoder name
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800421 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
422 * @possible_crtcs: bitmask of potential CRTC bindings
423 * @possible_clones: bitmask of potential sibling encoders for cloning
424 * @crtc: currently bound CRTC
Sean Paul3b336ec2013-08-14 16:47:37 -0400425 * @bridge: bridge associated to the encoder
Jesse Barnesdb3e4492011-11-07 12:03:17 -0800426 * @funcs: control functions
427 * @helper_private: mid-layer private data
428 *
429 * CRTCs drive pixels to encoders, which convert them into signals
430 * appropriate for a given connector or set of connectors.
Dave Airlief453ba02008-11-07 14:05:41 -0800431 */
432struct drm_encoder {
433 struct drm_device *dev;
434 struct list_head head;
435
436 struct drm_mode_object base;
Jani Nikulae5748942014-05-14 16:58:20 +0300437 char *name;
Dave Airlief453ba02008-11-07 14:05:41 -0800438 int encoder_type;
439 uint32_t possible_crtcs;
440 uint32_t possible_clones;
441
442 struct drm_crtc *crtc;
Sean Paul3b336ec2013-08-14 16:47:37 -0400443 struct drm_bridge *bridge;
Dave Airlief453ba02008-11-07 14:05:41 -0800444 const struct drm_encoder_funcs *funcs;
445 void *helper_private;
446};
447
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000448/* should we poll this connector for connects and disconnects */
449/* hot plug detectable */
450#define DRM_CONNECTOR_POLL_HPD (1 << 0)
451/* poll for connections */
452#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
453/* can cleanly poll for disconnections without flickering the screen */
454/* DACs should rarely do this without a lot of testing */
455#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
456
Wu Fengguang76adaa342011-09-05 14:23:20 +0800457#define MAX_ELD_BYTES 128
458
Dave Airlief453ba02008-11-07 14:05:41 -0800459/**
460 * drm_connector - central DRM connector control structure
Jesse Barnes72252542011-11-07 12:03:18 -0800461 * @dev: parent DRM device
462 * @kdev: kernel device for sysfs attributes
463 * @attr: sysfs attributes
464 * @head: list management
465 * @base: base KMS object
Jani Nikula2abdd312014-05-14 16:58:19 +0300466 * @name: connector name
Jesse Barnes72252542011-11-07 12:03:18 -0800467 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
468 * @connector_type_id: index into connector type enum
Dave Airlief453ba02008-11-07 14:05:41 -0800469 * @interlace_allowed: can this connector handle interlaced modes?
470 * @doublescan_allowed: can this connector handle doublescan?
Jesse Barnes72252542011-11-07 12:03:18 -0800471 * @modes: modes available on this connector (from fill_modes() + user)
472 * @status: one of the drm_connector_status enums (connected, not, or unknown)
473 * @probed_modes: list of modes derived directly from the display
474 * @display_info: information about attached display (e.g. from EDID)
Dave Airlief453ba02008-11-07 14:05:41 -0800475 * @funcs: connector control functions
Jesse Barnes72252542011-11-07 12:03:18 -0800476 * @edid_blob_ptr: DRM property containing EDID if present
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300477 * @properties: property tracking for this connector
Jesse Barnes72252542011-11-07 12:03:18 -0800478 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
479 * @dpms: current dpms state
480 * @helper_private: mid-layer private data
481 * @force: a %DRM_FORCE_<foo> state for forced mode sets
482 * @encoder_ids: valid encoders for this connector
483 * @encoder: encoder driving this connector, if any
484 * @eld: EDID-like data, if present
485 * @dvi_dual: dual link DVI, if found
486 * @max_tmds_clock: max clock rate, if found
487 * @latency_present: AV delay info from ELD, if found
488 * @video_latency: video latency info from ELD, if found
489 * @audio_latency: audio latency info from ELD, if found
490 * @null_edid_counter: track sinks that give us all zeros for the EDID
Dave Airlief453ba02008-11-07 14:05:41 -0800491 *
492 * Each connector may be connected to one or more CRTCs, or may be clonable by
493 * another connector if they can share a CRTC. Each connector also has a specific
494 * position in the broader display (referred to as a 'screen' though it could
495 * span multiple monitors).
496 */
497struct drm_connector {
498 struct drm_device *dev;
Dave Airlie5bdebb12013-10-11 14:07:25 +1000499 struct device *kdev;
Dave Airlief453ba02008-11-07 14:05:41 -0800500 struct device_attribute *attr;
501 struct list_head head;
502
503 struct drm_mode_object base;
504
Jani Nikula2abdd312014-05-14 16:58:19 +0300505 char *name;
Dave Airlief453ba02008-11-07 14:05:41 -0800506 int connector_type;
507 int connector_type_id;
508 bool interlace_allowed;
509 bool doublescan_allowed;
Damien Lespiau560a0672013-09-25 16:45:29 +0100510 bool stereo_allowed;
Dave Airlief453ba02008-11-07 14:05:41 -0800511 struct list_head modes; /* list of modes on this connector */
512
Dave Airlief453ba02008-11-07 14:05:41 -0800513 enum drm_connector_status status;
514
515 /* these are modes added by probing with DDC or the BIOS */
516 struct list_head probed_modes;
517
518 struct drm_display_info display_info;
519 const struct drm_connector_funcs *funcs;
520
Dave Airlief453ba02008-11-07 14:05:41 -0800521 struct drm_property_blob *edid_blob_ptr;
Paulo Zanoni7e3bdf42012-05-15 18:09:01 -0300522 struct drm_object_properties properties;
Dave Airlief453ba02008-11-07 14:05:41 -0800523
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000524 uint8_t polled; /* DRM_CONNECTOR_POLL_* */
525
Keith Packardc9fb15f2009-05-30 20:42:28 -0700526 /* requested DPMS state */
527 int dpms;
528
Dave Airlief453ba02008-11-07 14:05:41 -0800529 void *helper_private;
530
Dave Airlied50ba252009-09-23 14:44:08 +1000531 /* forced on connector */
532 enum drm_connector_force force;
Dave Airlief453ba02008-11-07 14:05:41 -0800533 uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
Dave Airlief453ba02008-11-07 14:05:41 -0800534 struct drm_encoder *encoder; /* currently active encoder */
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000535
Wu Fengguang76adaa342011-09-05 14:23:20 +0800536 /* EDID bits */
537 uint8_t eld[MAX_ELD_BYTES];
538 bool dvi_dual;
539 int max_tmds_clock; /* in MHz */
540 bool latency_present[2];
541 int video_latency[2]; /* [0]: progressive, [1]: interlaced */
542 int audio_latency[2];
Dave Airlie4a9a8b72011-06-14 06:13:55 +0000543 int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
Jerome Glisse0b2443e2012-08-09 11:25:51 -0400544 unsigned bad_edid_counter;
Dave Airlief453ba02008-11-07 14:05:41 -0800545};
546
547/**
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800548 * drm_plane_funcs - driver plane control functions
549 * @update_plane: update the plane configuration
550 * @disable_plane: shut down the plane
551 * @destroy: clean up plane resources
Rob Clark4d939142012-05-17 02:23:27 -0600552 * @set_property: called when a property is changed
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800553 */
554struct drm_plane_funcs {
555 int (*update_plane)(struct drm_plane *plane,
556 struct drm_crtc *crtc, struct drm_framebuffer *fb,
557 int crtc_x, int crtc_y,
558 unsigned int crtc_w, unsigned int crtc_h,
559 uint32_t src_x, uint32_t src_y,
560 uint32_t src_w, uint32_t src_h);
561 int (*disable_plane)(struct drm_plane *plane);
562 void (*destroy)(struct drm_plane *plane);
Rob Clark4d939142012-05-17 02:23:27 -0600563
564 int (*set_property)(struct drm_plane *plane,
565 struct drm_property *property, uint64_t val);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800566};
567
Matt Ropere27dde32014-04-01 15:22:30 -0700568enum drm_plane_type {
569 DRM_PLANE_TYPE_OVERLAY,
570 DRM_PLANE_TYPE_PRIMARY,
571 DRM_PLANE_TYPE_CURSOR,
572};
573
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800574/**
575 * drm_plane - central DRM plane control structure
576 * @dev: DRM device this plane belongs to
577 * @head: for list management
578 * @base: base mode object
579 * @possible_crtcs: pipes this plane can be bound to
580 * @format_types: array of formats supported by this plane
581 * @format_count: number of formats supported
582 * @crtc: currently bound CRTC
583 * @fb: currently bound fb
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800584 * @funcs: helper functions
Rob Clark4d939142012-05-17 02:23:27 -0600585 * @properties: property tracking for this plane
Matt Ropere27dde32014-04-01 15:22:30 -0700586 * @type: type of plane (overlay, primary, cursor)
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800587 */
588struct drm_plane {
589 struct drm_device *dev;
590 struct list_head head;
591
592 struct drm_mode_object base;
593
594 uint32_t possible_crtcs;
595 uint32_t *format_types;
596 uint32_t format_count;
597
598 struct drm_crtc *crtc;
599 struct drm_framebuffer *fb;
600
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800601 const struct drm_plane_funcs *funcs;
Rob Clark4d939142012-05-17 02:23:27 -0600602
603 struct drm_object_properties properties;
Matt Ropere27dde32014-04-01 15:22:30 -0700604
605 enum drm_plane_type type;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800606};
607
608/**
Sean Paul3b336ec2013-08-14 16:47:37 -0400609 * drm_bridge_funcs - drm_bridge control functions
610 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
611 * @disable: Called right before encoder prepare, disables the bridge
612 * @post_disable: Called right after encoder prepare, for lockstepped disable
613 * @mode_set: Set this mode to the bridge
614 * @pre_enable: Called right before encoder commit, for lockstepped commit
615 * @enable: Called right after encoder commit, enables the bridge
616 * @destroy: make object go away
617 */
618struct drm_bridge_funcs {
619 bool (*mode_fixup)(struct drm_bridge *bridge,
620 const struct drm_display_mode *mode,
621 struct drm_display_mode *adjusted_mode);
622 void (*disable)(struct drm_bridge *bridge);
623 void (*post_disable)(struct drm_bridge *bridge);
624 void (*mode_set)(struct drm_bridge *bridge,
625 struct drm_display_mode *mode,
626 struct drm_display_mode *adjusted_mode);
627 void (*pre_enable)(struct drm_bridge *bridge);
628 void (*enable)(struct drm_bridge *bridge);
629 void (*destroy)(struct drm_bridge *bridge);
630};
631
632/**
633 * drm_bridge - central DRM bridge control structure
634 * @dev: DRM device this bridge belongs to
635 * @head: list management
636 * @base: base mode object
637 * @funcs: control functions
638 * @driver_private: pointer to the bridge driver's internal context
639 */
640struct drm_bridge {
641 struct drm_device *dev;
642 struct list_head head;
643
644 struct drm_mode_object base;
645
646 const struct drm_bridge_funcs *funcs;
647 void *driver_private;
648};
649
650/**
Jesse Barnesef273512011-11-07 12:03:19 -0800651 * drm_mode_set - new values for a CRTC config change
652 * @head: list management
653 * @fb: framebuffer to use for new config
654 * @crtc: CRTC whose configuration we're about to change
655 * @mode: mode timings to use
656 * @x: position of this CRTC relative to @fb
657 * @y: position of this CRTC relative to @fb
658 * @connectors: array of connectors to drive with this CRTC if possible
659 * @num_connectors: size of @connectors array
Dave Airlief453ba02008-11-07 14:05:41 -0800660 *
661 * Represents a single crtc the connectors that it drives with what mode
662 * and from which framebuffer it scans out from.
663 *
664 * This is used to set modes.
665 */
666struct drm_mode_set {
Dave Airlief453ba02008-11-07 14:05:41 -0800667 struct drm_framebuffer *fb;
668 struct drm_crtc *crtc;
669 struct drm_display_mode *mode;
670
671 uint32_t x;
672 uint32_t y;
673
674 struct drm_connector **connectors;
675 size_t num_connectors;
676};
677
678/**
Jesse Barnes550cebc2011-11-07 12:03:20 -0800679 * struct drm_mode_config_funcs - basic driver provided mode setting functions
680 * @fb_create: create a new framebuffer object
681 * @output_poll_changed: function to handle output configuration changes
682 *
683 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
684 * involve drivers.
Dave Airlief453ba02008-11-07 14:05:41 -0800685 */
686struct drm_mode_config_funcs {
Jesse Barnes550cebc2011-11-07 12:03:20 -0800687 struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
688 struct drm_file *file_priv,
689 struct drm_mode_fb_cmd2 *mode_cmd);
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000690 void (*output_poll_changed)(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800691};
692
Jesse Barnesc1aaca22011-11-07 12:03:21 -0800693/**
694 * drm_mode_group - group of mode setting resources for potential sub-grouping
695 * @num_crtcs: CRTC count
696 * @num_encoders: encoder count
697 * @num_connectors: connector count
698 * @id_list: list of KMS object IDs in this group
699 *
700 * Currently this simply tracks the global mode setting state. But in the
701 * future it could allow groups of objects to be set aside into independent
702 * control groups for use by different user level processes (e.g. two X servers
703 * running simultaneously on different heads, each with their own mode
704 * configuration and freedom of mode setting).
705 */
Dave Airlief453ba02008-11-07 14:05:41 -0800706struct drm_mode_group {
707 uint32_t num_crtcs;
708 uint32_t num_encoders;
709 uint32_t num_connectors;
Sean Paul3b336ec2013-08-14 16:47:37 -0400710 uint32_t num_bridges;
Dave Airlief453ba02008-11-07 14:05:41 -0800711
712 /* list of object IDs for this group */
713 uint32_t *id_list;
714};
715
716/**
717 * drm_mode_config - Mode configuration control structure
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800718 * @mutex: mutex protecting KMS related lists and structures
719 * @idr_mutex: mutex for KMS ID allocation and management
720 * @crtc_idr: main KMS ID tracking object
721 * @num_fb: number of fbs available
722 * @fb_list: list of framebuffers available
723 * @num_connector: number of connectors on this device
724 * @connector_list: list of connector objects
Sean Paul3b336ec2013-08-14 16:47:37 -0400725 * @num_bridge: number of bridges on this device
726 * @bridge_list: list of bridge objects
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800727 * @num_encoder: number of encoders on this device
728 * @encoder_list: list of encoder objects
729 * @num_crtc: number of CRTCs on this device
730 * @crtc_list: list of CRTC objects
731 * @min_width: minimum pixel width on this device
732 * @min_height: minimum pixel height on this device
733 * @max_width: maximum pixel width on this device
734 * @max_height: maximum pixel height on this device
735 * @funcs: core driver provided mode setting functions
736 * @fb_base: base address of the framebuffer
737 * @poll_enabled: track polling status for this device
738 * @output_poll_work: delayed work for polling in process context
739 * @*_property: core property tracking
Dave Airlief453ba02008-11-07 14:05:41 -0800740 *
Jesse Barnesa62c93d2011-11-07 12:03:22 -0800741 * Core mode resource tracking structure. All CRTC, encoders, and connectors
742 * enumerated by the driver are added here, as are global properties. Some
743 * global restrictions are also here, e.g. dimension restrictions.
Dave Airlief453ba02008-11-07 14:05:41 -0800744 */
745struct drm_mode_config {
Jesse Barnesad2563c2009-01-19 17:21:45 +1000746 struct mutex mutex; /* protects configuration (mode lists etc.) */
Rob Clark51fd3712013-11-19 12:10:12 -0500747 struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
748 struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
Jesse Barnesad2563c2009-01-19 17:21:45 +1000749 struct mutex idr_mutex; /* for IDR management */
Dave Airlief453ba02008-11-07 14:05:41 -0800750 struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
751 /* this is limited to one for now */
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100752
753
754 /**
755 * fb_lock - mutex to protect fb state
756 *
757 * Besides the global fb list his also protects the fbs list in the
758 * file_priv
759 */
760 struct mutex fb_lock;
Dave Airlief453ba02008-11-07 14:05:41 -0800761 int num_fb;
762 struct list_head fb_list;
Daniel Vetter4b096ac2012-12-10 21:19:18 +0100763
Dave Airlief453ba02008-11-07 14:05:41 -0800764 int num_connector;
765 struct list_head connector_list;
Sean Paul3b336ec2013-08-14 16:47:37 -0400766 int num_bridge;
767 struct list_head bridge_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800768 int num_encoder;
769 struct list_head encoder_list;
Matt Ropere27dde32014-04-01 15:22:30 -0700770
771 /*
772 * Track # of overlay planes separately from # of total planes. By
773 * default we only advertise overlay planes to userspace; if userspace
774 * sets the "universal plane" capability bit, we'll go ahead and
775 * expose all planes.
776 */
777 int num_overlay_plane;
778 int num_total_plane;
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800779 struct list_head plane_list;
Dave Airlief453ba02008-11-07 14:05:41 -0800780
781 int num_crtc;
782 struct list_head crtc_list;
783
784 struct list_head property_list;
785
Dave Airlief453ba02008-11-07 14:05:41 -0800786 int min_width, min_height;
787 int max_width, max_height;
Laurent Pincharte6ecefa2012-05-17 13:27:23 +0200788 const struct drm_mode_config_funcs *funcs;
Benjamin Herrenschmidtd883f7f2009-02-02 16:55:45 +1100789 resource_size_t fb_base;
Dave Airlief453ba02008-11-07 14:05:41 -0800790
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000791 /* output poll support */
792 bool poll_enabled;
Daniel Vetter905bc9f2012-10-23 18:23:36 +0000793 bool poll_running;
Tejun Heo991ea752010-07-20 22:09:02 +0200794 struct delayed_work output_poll_work;
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000795
Dave Airlief453ba02008-11-07 14:05:41 -0800796 /* pointers to standard properties */
797 struct list_head property_blob_list;
798 struct drm_property *edid_property;
799 struct drm_property *dpms_property;
Rob Clark9922ab52014-04-01 20:16:57 -0400800 struct drm_property *plane_type_property;
Dave Airlief453ba02008-11-07 14:05:41 -0800801
802 /* DVI-I properties */
803 struct drm_property *dvi_i_subconnector_property;
804 struct drm_property *dvi_i_select_subconnector_property;
805
806 /* TV properties */
807 struct drm_property *tv_subconnector_property;
808 struct drm_property *tv_select_subconnector_property;
809 struct drm_property *tv_mode_property;
810 struct drm_property *tv_left_margin_property;
811 struct drm_property *tv_right_margin_property;
812 struct drm_property *tv_top_margin_property;
813 struct drm_property *tv_bottom_margin_property;
Francisco Jerezb6b79022009-08-02 04:19:20 +0200814 struct drm_property *tv_brightness_property;
815 struct drm_property *tv_contrast_property;
816 struct drm_property *tv_flicker_reduction_property;
Francisco Jereza75f0232009-08-12 02:30:10 +0200817 struct drm_property *tv_overscan_property;
818 struct drm_property *tv_saturation_property;
819 struct drm_property *tv_hue_property;
Dave Airlief453ba02008-11-07 14:05:41 -0800820
821 /* Optional properties */
822 struct drm_property *scaling_mode_property;
Jakob Bornecrantz884840a2009-12-03 23:25:47 +0000823 struct drm_property *dirty_info_property;
Dave Airlie019d96c2011-09-29 16:20:42 +0100824
825 /* dumb ioctl parameters */
826 uint32_t preferred_depth, prefer_shadow;
Keith Packard62f21042013-07-22 18:50:00 -0700827
828 /* whether async page flip is supported or not */
829 bool async_page_flip;
Alex Deucher8716ed42014-02-12 12:48:23 -0500830
831 /* cursor size */
832 uint32_t cursor_width, cursor_height;
Dave Airlief453ba02008-11-07 14:05:41 -0800833};
834
835#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
836#define obj_to_connector(x) container_of(x, struct drm_connector, base)
837#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
838#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
839#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
840#define obj_to_property(x) container_of(x, struct drm_property, base)
841#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800842#define obj_to_plane(x) container_of(x, struct drm_plane, base)
Dave Airlief453ba02008-11-07 14:05:41 -0800843
Sascha Hauer4a67d392012-02-06 10:58:17 +0100844struct drm_prop_enum_list {
845 int type;
846 char *name;
847};
Dave Airlief453ba02008-11-07 14:05:41 -0800848
Matt Ropere13161a2014-04-01 15:22:38 -0700849extern int drm_crtc_init_with_planes(struct drm_device *dev,
850 struct drm_crtc *crtc,
851 struct drm_plane *primary,
852 void *cursor,
853 const struct drm_crtc_funcs *funcs);
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200854extern int drm_crtc_init(struct drm_device *dev,
855 struct drm_crtc *crtc,
856 const struct drm_crtc_funcs *funcs);
Dave Airlief453ba02008-11-07 14:05:41 -0800857extern void drm_crtc_cleanup(struct drm_crtc *crtc);
Russell Kingdb5f7a62014-01-02 21:27:33 +0000858extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
859
860/**
861 * drm_crtc_mask - find the mask of a registered CRTC
862 * @crtc: CRTC to find mask for
863 *
864 * Given a registered CRTC, return the mask bit of that CRTC for an
865 * encoder's possible_crtcs field.
866 */
867static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
868{
869 return 1 << drm_crtc_index(crtc);
870}
Dave Airlief453ba02008-11-07 14:05:41 -0800871
Ilia Mirkinb21e3af2013-08-07 22:34:48 -0400872extern void drm_connector_ida_init(void);
873extern void drm_connector_ida_destroy(void);
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200874extern int drm_connector_init(struct drm_device *dev,
875 struct drm_connector *connector,
876 const struct drm_connector_funcs *funcs,
877 int connector_type);
Dave Airlief453ba02008-11-07 14:05:41 -0800878
879extern void drm_connector_cleanup(struct drm_connector *connector);
Dave Airliecbc7e222012-02-20 14:16:40 +0000880/* helper to unplug all connectors from sysfs for device */
881extern void drm_connector_unplug_all(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800882
Sean Paul3b336ec2013-08-14 16:47:37 -0400883extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
884 const struct drm_bridge_funcs *funcs);
885extern void drm_bridge_cleanup(struct drm_bridge *bridge);
886
Ville Syrjälä6bfc56a2012-03-13 12:35:48 +0200887extern int drm_encoder_init(struct drm_device *dev,
888 struct drm_encoder *encoder,
889 const struct drm_encoder_funcs *funcs,
890 int encoder_type);
Dave Airlief453ba02008-11-07 14:05:41 -0800891
Thierry Reding3d887362014-01-13 14:33:20 +0100892/**
893 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
894 * @encoder: encoder to test
895 * @crtc: crtc to test
896 *
897 * Return false if @encoder can't be driven by @crtc, true otherwise.
898 */
899static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
900 struct drm_crtc *crtc)
901{
902 return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
903}
904
Matt Roperdc415ff2014-04-01 15:22:36 -0700905extern int drm_universal_plane_init(struct drm_device *dev,
906 struct drm_plane *plane,
907 unsigned long possible_crtcs,
908 const struct drm_plane_funcs *funcs,
909 const uint32_t *formats,
910 uint32_t format_count,
911 enum drm_plane_type type);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800912extern int drm_plane_init(struct drm_device *dev,
913 struct drm_plane *plane,
914 unsigned long possible_crtcs,
915 const struct drm_plane_funcs *funcs,
Rob Clark0a7eb242011-12-13 20:19:36 -0600916 const uint32_t *formats, uint32_t format_count,
Matt Roperdc415ff2014-04-01 15:22:36 -0700917 bool is_primary);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800918extern void drm_plane_cleanup(struct drm_plane *plane);
Ville Syrjälä9125e612013-06-03 16:10:40 +0300919extern void drm_plane_force_disable(struct drm_plane *plane);
Matt Roperaf936292014-04-01 15:22:34 -0700920extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
921 int x, int y,
922 const struct drm_display_mode *mode,
923 const struct drm_framebuffer *fb);
Jesse Barnes8cf5c912011-11-14 14:51:27 -0800924
Dave Airlief453ba02008-11-07 14:05:41 -0800925extern void drm_encoder_cleanup(struct drm_encoder *encoder);
926
Ville Syrjäläd20d3172013-06-07 15:43:07 +0000927extern const char *drm_get_connector_status_name(enum drm_connector_status status);
Jesse Barnesac1bb362014-02-10 15:32:44 -0800928extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
Ville Syrjäläd20d3172013-06-07 15:43:07 +0000929extern const char *drm_get_dpms_name(int val);
930extern const char *drm_get_dvi_i_subconnector_name(int val);
931extern const char *drm_get_dvi_i_select_name(int val);
932extern const char *drm_get_tv_subconnector_name(int val);
933extern const char *drm_get_tv_select_name(int val);
Kristian Høgsbergea39f832009-02-12 14:37:56 -0500934extern void drm_fb_release(struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -0800935extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
Dave Airliead222792014-05-02 13:22:19 +1000936extern void drm_mode_group_destroy(struct drm_mode_group *group);
Adam Jacksonfbff4692012-09-18 10:58:47 -0400937extern bool drm_probe_ddc(struct i2c_adapter *adapter);
Dave Airlief453ba02008-11-07 14:05:41 -0800938extern struct edid *drm_get_edid(struct drm_connector *connector,
939 struct i2c_adapter *adapter);
Jani Nikula51f8da52013-09-27 15:08:27 +0300940extern struct edid *drm_edid_duplicate(const struct edid *edid);
Dave Airlief453ba02008-11-07 14:05:41 -0800941extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
Dave Airlief453ba02008-11-07 14:05:41 -0800942extern void drm_mode_config_init(struct drm_device *dev);
Chris Wilsoneb033552011-01-24 15:11:08 +0000943extern void drm_mode_config_reset(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800944extern void drm_mode_config_cleanup(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -0800945
Dave Airlief453ba02008-11-07 14:05:41 -0800946extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
947 struct edid *edid);
Rob Clark5ea22f22014-05-30 11:34:01 -0400948
949static inline bool drm_property_type_is(struct drm_property *property,
950 uint32_t type)
951{
952 /* instanceof for props.. handles extended type vs original types: */
953 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
954 return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
955 return property->flags & type;
956}
957
958static inline bool drm_property_type_valid(struct drm_property *property)
959{
960 if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
961 return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
962 return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
963}
964
Paulo Zanonic5431882012-05-15 18:09:02 -0300965extern int drm_object_property_set_value(struct drm_mode_object *obj,
966 struct drm_property *property,
967 uint64_t val);
968extern int drm_object_property_get_value(struct drm_mode_object *obj,
969 struct drm_property *property,
970 uint64_t *value);
Dave Airlief453ba02008-11-07 14:05:41 -0800971extern int drm_framebuffer_init(struct drm_device *dev,
972 struct drm_framebuffer *fb,
973 const struct drm_framebuffer_funcs *funcs);
Daniel Vetter786b99e2012-12-02 21:53:40 +0100974extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
975 uint32_t id);
Rob Clarkf7eff602012-09-05 21:48:38 +0000976extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
977extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
978extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -0800979extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
Daniel Vetter36206362012-12-10 20:42:17 +0100980extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
Dave Airlief453ba02008-11-07 14:05:41 -0800981
Paulo Zanonic5431882012-05-15 18:09:02 -0300982extern void drm_object_attach_property(struct drm_mode_object *obj,
983 struct drm_property *property,
984 uint64_t init_val);
Dave Airlief453ba02008-11-07 14:05:41 -0800985extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
986 const char *name, int num_values);
Sascha Hauer4a67d392012-02-06 10:58:17 +0100987extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
988 const char *name,
989 const struct drm_prop_enum_list *props,
990 int num_values);
Rob Clark49e27542012-05-17 02:23:26 -0600991struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
992 int flags, const char *name,
993 const struct drm_prop_enum_list *props,
994 int num_values);
Sascha Hauerd9bc3c02012-02-06 10:58:18 +0100995struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
996 const char *name,
997 uint64_t min, uint64_t max);
Rob Clarkebc44cf2012-09-12 22:22:31 -0500998struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
999 int flags, const char *name,
1000 int64_t min, int64_t max);
Rob Clark98f75de2014-05-30 11:37:03 -04001001struct drm_property *drm_property_create_object(struct drm_device *dev,
1002 int flags, const char *name, uint32_t type);
Dave Airlief453ba02008-11-07 14:05:41 -08001003extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
1004extern int drm_property_add_enum(struct drm_property *property, int index,
1005 uint64_t value, const char *name);
1006extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1007extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
1008 char *formats[]);
1009extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001010extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
Dave Airlief453ba02008-11-07 14:05:41 -08001011
1012extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
1013 struct drm_encoder *encoder);
Sascha Hauer4cae5b82012-02-01 11:38:23 +01001014extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
Dave Airlief453ba02008-11-07 14:05:41 -08001015 int gamma_size);
Daniel Vetter7a9c9062009-09-15 22:57:31 +02001016extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
1017 uint32_t id, uint32_t type);
Rob Clark98f75de2014-05-30 11:37:03 -04001018
Dave Airlief453ba02008-11-07 14:05:41 -08001019/* IOCTLs */
1020extern int drm_mode_getresources(struct drm_device *dev,
1021 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001022extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
1023 struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001024extern int drm_mode_getcrtc(struct drm_device *dev,
1025 void *data, struct drm_file *file_priv);
1026extern int drm_mode_getconnector(struct drm_device *dev,
1027 void *data, struct drm_file *file_priv);
Daniel Vetter2d13b672012-12-11 13:47:23 +01001028extern int drm_mode_set_config_internal(struct drm_mode_set *set);
Dave Airlief453ba02008-11-07 14:05:41 -08001029extern int drm_mode_setcrtc(struct drm_device *dev,
1030 void *data, struct drm_file *file_priv);
Jesse Barnes8cf5c912011-11-14 14:51:27 -08001031extern int drm_mode_getplane(struct drm_device *dev,
1032 void *data, struct drm_file *file_priv);
1033extern int drm_mode_setplane(struct drm_device *dev,
1034 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001035extern int drm_mode_cursor_ioctl(struct drm_device *dev,
1036 void *data, struct drm_file *file_priv);
Dave Airlie4c813d42013-06-20 11:48:52 +10001037extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
1038 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001039extern int drm_mode_addfb(struct drm_device *dev,
1040 void *data, struct drm_file *file_priv);
Jesse Barnes308e5bc2011-11-14 14:51:28 -08001041extern int drm_mode_addfb2(struct drm_device *dev,
1042 void *data, struct drm_file *file_priv);
1043extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
Dave Airlief453ba02008-11-07 14:05:41 -08001044extern int drm_mode_rmfb(struct drm_device *dev,
1045 void *data, struct drm_file *file_priv);
1046extern int drm_mode_getfb(struct drm_device *dev,
1047 void *data, struct drm_file *file_priv);
Jakob Bornecrantz884840a2009-12-03 23:25:47 +00001048extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1049 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001050
1051extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1052 void *data, struct drm_file *file_priv);
1053extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1054 void *data, struct drm_file *file_priv);
1055extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1056 void *data, struct drm_file *file_priv);
Dave Airlief453ba02008-11-07 14:05:41 -08001057extern int drm_mode_getencoder(struct drm_device *dev,
1058 void *data, struct drm_file *file_priv);
1059extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1060 void *data, struct drm_file *file_priv);
1061extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1062 void *data, struct drm_file *file_priv);
Thierry Reding18316c82012-12-20 15:41:44 +01001063extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
Vandana Kannan0967e6a2014-04-01 16:26:59 +05301064extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
Ma Lingf23c20c2009-03-26 19:26:23 +08001065extern bool drm_detect_hdmi_monitor(struct edid *edid);
Zhenyu Wang8fe97902010-09-19 14:27:28 +08001066extern bool drm_detect_monitor_audio(struct edid *edid);
Ville Syrjäläb1edd6a2013-01-17 16:31:30 +02001067extern bool drm_rgb_quant_range_selectable(struct edid *edid);
Kristian Høgsbergd91d8a32009-11-17 12:43:55 -05001068extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1069 void *data, struct drm_file *file_priv);
Zhao Yakuif0fda0a2009-09-03 09:33:48 +08001070extern int drm_add_modes_noedid(struct drm_connector *connector,
1071 int hdisplay, int vdisplay);
Gerd Hoffmann3cf70da2013-10-11 10:01:08 +02001072extern void drm_set_preferred_mode(struct drm_connector *connector,
1073 int hpref, int vpref);
Alex Deucher3c537882010-02-05 04:21:19 -05001074
Thomas Reim051963d2011-07-29 14:28:57 +00001075extern int drm_edid_header_is_valid(const u8 *raw_edid);
Jerome Glisse0b2443e2012-08-09 11:25:51 -04001076extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
Alex Deucher3c537882010-02-05 04:21:19 -05001077extern bool drm_edid_is_valid(struct edid *edid);
Dave Airlie1d42bbc2010-05-07 05:02:30 +00001078struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
Adam Jacksonf6e252b2012-04-13 16:33:31 -04001079 int hsize, int vsize, int fresh,
1080 bool rb);
Dave Airlieff72145b2011-02-07 12:16:14 +10001081
1082extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1083 void *data, struct drm_file *file_priv);
1084extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1085 void *data, struct drm_file *file_priv);
1086extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1087 void *data, struct drm_file *file_priv);
Paulo Zanonic5431882012-05-15 18:09:02 -03001088extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1089 struct drm_file *file_priv);
1090extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1091 struct drm_file *file_priv);
Dave Airlie248dbc22011-11-29 20:02:54 +00001092
1093extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1094 int *bpp);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001095extern int drm_format_num_planes(uint32_t format);
Ville Syrjälä5a86bd52012-04-05 21:35:16 +03001096extern int drm_format_plane_cpp(uint32_t format, int plane);
Ville Syrjälä01b68b02012-04-05 21:35:17 +03001097extern int drm_format_horz_chroma_subsampling(uint32_t format);
1098extern int drm_format_vert_chroma_subsampling(uint32_t format);
Ville Syrjäläd20d3172013-06-07 15:43:07 +00001099extern const char *drm_get_format_name(uint32_t format);
Ville Syrjälä141670e2012-04-05 21:35:15 +03001100
Russell King96f60e32012-08-15 13:59:49 +01001101/* Helpers */
Rob Clarka2b34e22013-10-05 16:36:52 -04001102
1103static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
1104 uint32_t id)
1105{
1106 struct drm_mode_object *mo;
1107 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
1108 return mo ? obj_to_plane(mo) : NULL;
1109}
1110
Russell King96f60e32012-08-15 13:59:49 +01001111static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1112 uint32_t id)
1113{
1114 struct drm_mode_object *mo;
1115 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1116 return mo ? obj_to_crtc(mo) : NULL;
1117}
1118
1119static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1120 uint32_t id)
1121{
1122 struct drm_mode_object *mo;
1123 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1124 return mo ? obj_to_encoder(mo) : NULL;
1125}
1126
Rob Clarka2b34e22013-10-05 16:36:52 -04001127static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
1128 uint32_t id)
1129{
1130 struct drm_mode_object *mo;
1131 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
1132 return mo ? obj_to_connector(mo) : NULL;
1133}
1134
1135static inline struct drm_property *drm_property_find(struct drm_device *dev,
1136 uint32_t id)
1137{
1138 struct drm_mode_object *mo;
1139 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
1140 return mo ? obj_to_property(mo) : NULL;
1141}
1142
1143static inline struct drm_property_blob *
1144drm_property_blob_find(struct drm_device *dev, uint32_t id)
1145{
1146 struct drm_mode_object *mo;
1147 mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
1148 return mo ? obj_to_blob(mo) : NULL;
1149}
1150
Matt Ropere27dde32014-04-01 15:22:30 -07001151/* Plane list iterator for legacy (overlay only) planes. */
1152#define drm_for_each_legacy_plane(plane, planelist) \
1153 list_for_each_entry(plane, planelist, head) \
1154 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1155
Dave Airlief453ba02008-11-07 14:05:41 -08001156#endif /* __DRM_CRTC_H__ */