drm_crtc.h 52.1 KB
Newer Older
D
Dave Airlie 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*
 * Copyright © 2006 Keith Packard
 * Copyright © 2007-2008 Dave Airlie
 * Copyright © 2007-2008 Intel Corporation
 *   Jesse Barnes <jesse.barnes@intel.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef __DRM_CRTC_H__
#define __DRM_CRTC_H__

#include <linux/i2c.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/idr.h>
#include <linux/fb.h>
33
#include <linux/hdmi.h>
34 35
#include <uapi/drm/drm_mode.h>
#include <uapi/drm/drm_fourcc.h>
36
#include <drm/drm_modeset_lock.h>
37

D
Dave Airlie 已提交
38 39 40
struct drm_device;
struct drm_mode_set;
struct drm_framebuffer;
41
struct drm_object_properties;
42 43
struct drm_file;
struct drm_clip_rect;
44
struct device_node;
45
struct fence;
D
Dave Airlie 已提交
46 47 48 49 50 51 52 53

#define DRM_MODE_OBJECT_CRTC 0xcccccccc
#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
#define DRM_MODE_OBJECT_MODE 0xdededede
#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
J
Jesse Barnes 已提交
54
#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
S
Sean Paul 已提交
55
#define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
R
Rob Clark 已提交
56
#define DRM_MODE_OBJECT_ANY 0
D
Dave Airlie 已提交
57 58 59 60

struct drm_mode_object {
	uint32_t id;
	uint32_t type;
61 62 63
	struct drm_object_properties *properties;
};

64
#define DRM_OBJECT_MAX_PROPERTY 24
65
struct drm_object_properties {
66
	int count;
67 68 69 70 71 72
	/* NOTE: if we ever start dynamically destroying properties (ie.
	 * not at drm_mode_config_cleanup() time), then we'd have to do
	 * a better job of detaching property from mode objects to avoid
	 * dangling property pointers:
	 */
	struct drm_property *properties[DRM_OBJECT_MAX_PROPERTY];
73 74 75
	/* do not read/write values directly, but use drm_object_property_get_value()
	 * and drm_object_property_set_value():
	 */
76
	uint64_t values[DRM_OBJECT_MAX_PROPERTY];
D
Dave Airlie 已提交
77 78
};

R
Rob Clark 已提交
79 80 81 82 83 84 85 86 87
static inline int64_t U642I64(uint64_t val)
{
	return (int64_t)*((int64_t *)&val);
}
static inline uint64_t I642U64(int64_t val)
{
	return (uint64_t)*((uint64_t *)&val);
}

88 89 90 91 92 93 94 95
/* rotation property bits */
#define DRM_ROTATE_0	0
#define DRM_ROTATE_90	1
#define DRM_ROTATE_180	2
#define DRM_ROTATE_270	3
#define DRM_REFLECT_X	4
#define DRM_REFLECT_Y	5

96 97 98 99 100
enum drm_connector_force {
	DRM_FORCE_UNSPECIFIED,
	DRM_FORCE_OFF,
	DRM_FORCE_ON,         /* force on analog part normally */
	DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
D
Dave Airlie 已提交
101 102
};

103
#include <drm/drm_modes.h>
104

D
Dave Airlie 已提交
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
enum drm_connector_status {
	connector_status_connected = 1,
	connector_status_disconnected = 2,
	connector_status_unknown = 3,
};

enum subpixel_order {
	SubPixelUnknown = 0,
	SubPixelHorizontalRGB,
	SubPixelHorizontalBGR,
	SubPixelVerticalRGB,
	SubPixelVerticalBGR,
	SubPixelNone,
};

120 121 122
#define DRM_COLOR_FORMAT_RGB444		(1<<0)
#define DRM_COLOR_FORMAT_YCRCB444	(1<<1)
#define DRM_COLOR_FORMAT_YCRCB422	(1<<2)
D
Dave Airlie 已提交
123 124 125 126 127
/*
 * Describes a given display (e.g. CRT or flat panel) and its limitations.
 */
struct drm_display_info {
	char name[DRM_DISPLAY_INFO_LEN];
128

D
Dave Airlie 已提交
129 130 131 132 133 134 135 136
	/* Physical size */
        unsigned int width_mm;
	unsigned int height_mm;

	/* Clock limits FIXME: storage format */
	unsigned int min_vfreq, max_vfreq;
	unsigned int min_hfreq, max_hfreq;
	unsigned int pixel_clock;
J
Jesse Barnes 已提交
137
	unsigned int bpc;
D
Dave Airlie 已提交
138 139

	enum subpixel_order subpixel_order;
140
	u32 color_formats;
D
Dave Airlie 已提交
141

142 143 144
	/* Mask of supported hdmi deep color modes */
	u8 edid_hdmi_dc_modes;

145
	u8 cea_rev;
D
Dave Airlie 已提交
146 147
};

D
Dave Airlie 已提交
148 149 150 151 152 153 154 155
/* data corresponds to displayid vend/prod/serial */
struct drm_tile_group {
	struct kref refcount;
	struct drm_device *dev;
	int id;
	u8 group_data[8];
};

D
Dave Airlie 已提交
156
struct drm_framebuffer_funcs {
R
Rob Clark 已提交
157
	/* note: use drm_framebuffer_remove() */
D
Dave Airlie 已提交
158 159 160 161
	void (*destroy)(struct drm_framebuffer *framebuffer);
	int (*create_handle)(struct drm_framebuffer *fb,
			     struct drm_file *file_priv,
			     unsigned int *handle);
162 163
	/*
	 * Optional callback for the dirty fb ioctl.
164 165 166 167 168 169 170 171 172 173
	 *
	 * Userspace can notify the driver via this callback
	 * that a area of the framebuffer has changed and should
	 * be flushed to the display hardware.
	 *
	 * See documentation in drm_mode.h for the struct
	 * drm_mode_fb_dirty_cmd for more information as all
	 * the semantics and arguments have a one to one mapping
	 * on this function.
	 */
174 175
	int (*dirty)(struct drm_framebuffer *framebuffer,
		     struct drm_file *file_priv, unsigned flags,
176 177
		     unsigned color, struct drm_clip_rect *clips,
		     unsigned num_clips);
D
Dave Airlie 已提交
178 179 180 181
};

struct drm_framebuffer {
	struct drm_device *dev;
R
Rob Clark 已提交
182 183 184 185 186 187 188 189 190 191
	/*
	 * Note that the fb is refcounted for the benefit of driver internals,
	 * for example some hw, disabling a CRTC/plane is asynchronous, and
	 * scanout does not actually complete until the next vblank.  So some
	 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
	 * should be deferred.  In cases like this, the driver would like to
	 * hold a ref to the fb even though it has already been removed from
	 * userspace perspective.
	 */
	struct kref refcount;
192 193 194 195
	/*
	 * Place on the dev->mode_config.fb_list, access protected by
	 * dev->mode_config.fb_lock.
	 */
D
Dave Airlie 已提交
196 197 198
	struct list_head head;
	struct drm_mode_object base;
	const struct drm_framebuffer_funcs *funcs;
199 200
	unsigned int pitches[4];
	unsigned int offsets[4];
D
Dave Airlie 已提交
201 202 203 204 205 206
	unsigned int width;
	unsigned int height;
	/* depth can be 15 or 16 */
	unsigned int depth;
	int bits_per_pixel;
	int flags;
207
	uint32_t pixel_format; /* fourcc format */
D
Dave Airlie 已提交
208
	struct list_head filp_head;
209 210
	/* if you are using the helper */
	void *helper_private;
D
Dave Airlie 已提交
211 212 213 214 215
};

struct drm_property_blob {
	struct drm_mode_object base;
	struct list_head head;
216
	size_t length;
217
	unsigned char data[];
D
Dave Airlie 已提交
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
};

struct drm_property_enum {
	uint64_t value;
	struct list_head head;
	char name[DRM_PROP_NAME_LEN];
};

struct drm_property {
	struct list_head head;
	struct drm_mode_object base;
	uint32_t flags;
	char name[DRM_PROP_NAME_LEN];
	uint32_t num_values;
	uint64_t *values;
R
Rob Clark 已提交
233
	struct drm_device *dev;
D
Dave Airlie 已提交
234

235
	struct list_head enum_list;
D
Dave Airlie 已提交
236 237 238 239 240
};

struct drm_crtc;
struct drm_connector;
struct drm_encoder;
241
struct drm_pending_vblank_event;
J
Jesse Barnes 已提交
242
struct drm_plane;
S
Sean Paul 已提交
243
struct drm_bridge;
244 245 246
struct drm_atomic_state;

/**
D
Daniel Vetter 已提交
247
 * struct drm_crtc_state - mutable CRTC state
248
 * @crtc: backpointer to the CRTC
249
 * @enable: whether the CRTC should be enabled, gates all other state
250
 * @active: whether the CRTC is actively displaying (used for DPMS)
251
 * @mode_changed: for use by helpers and drivers when computing state updates
252
 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
253 254
 * @last_vblank_count: for helpers and drivers to capture the vblank of the
 * 	update to ensure framebuffer cleanup isn't done too early
D
Daniel Vetter 已提交
255
 * @planes_changed: for use by helpers and drivers when computing state updates
256
 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
257 258 259 260
 * @mode: current mode timings
 * @event: optional pointer to a DRM event to signal upon completion of the
 * 	state update
 * @state: backpointer to global drm_atomic_state
261 262 263 264 265 266
 *
 * Note that the distinction between @enable and @active is rather subtile:
 * Flipping @active while @enable is set without changing anything else may
 * never return in a failure from the ->atomic_check callback. Userspace assumes
 * that a DPMS On will always succeed. In other words: @enable controls resource
 * assignment, @active controls the actual hardware state.
267 268
 */
struct drm_crtc_state {
269 270
	struct drm_crtc *crtc;

D
Daniel Vetter 已提交
271
	bool enable;
272
	bool active;
273

D
Daniel Vetter 已提交
274 275
	/* computed state bits used by helpers and drivers */
	bool planes_changed : 1;
276 277
	bool mode_changed : 1;

278 279 280 281 282 283 284
	/* attached planes bitmask:
	 * WARNING: transitional helpers do not maintain plane_mask so
	 * drivers not converted over to atomic helpers should not rely
	 * on plane_mask being accurate!
	 */
	u32 plane_mask;

285 286
	/* last_vblank_count: for vblank waits before cleanup */
	u32 last_vblank_count;
D
Daniel Vetter 已提交
287

288 289 290
	/* adjusted_mode: for use by helpers and drivers */
	struct drm_display_mode adjusted_mode;

291 292 293 294 295 296
	struct drm_display_mode mode;

	struct drm_pending_vblank_event *event;

	struct drm_atomic_state *state;
};
D
Dave Airlie 已提交
297 298

/**
299
 * struct drm_crtc_funcs - control CRTCs for a given device
D
Dave Airlie 已提交
300
 * @save: save CRTC state
301
 * @restore: restore CRTC state
C
Christopher Harvey 已提交
302
 * @reset: reset CRTC after state has been invalidated (e.g. resume)
303
 * @cursor_set: setup the cursor
D
Daniel Vetter 已提交
304
 * @cursor_set2: setup the cursor with hotspot, superseeds @cursor_set if set
305
 * @cursor_move: move the cursor
D
Dave Airlie 已提交
306
 * @gamma_set: specify color ramp for CRTC
P
Paulo Zanoni 已提交
307 308
 * @destroy: deinit and free object
 * @set_property: called when a property is changed
309 310
 * @set_config: apply a new CRTC configuration
 * @page_flip: initiate a page flip
311 312 313
 * @atomic_duplicate_state: duplicate the atomic state for this CRTC
 * @atomic_destroy_state: destroy an atomic state for this CRTC
 * @atomic_set_property: set a property on an atomic state for this CRTC
R
Rob Clark 已提交
314
 *    (do not call directly, use drm_atomic_crtc_set_property())
D
Dave Airlie 已提交
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
 *
 * The drm_crtc_funcs structure is the central CRTC management structure
 * in the DRM.  Each CRTC controls one or more connectors (note that the name
 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
 * connectors, not just CRTs).
 *
 * Each driver is responsible for filling out this structure at startup time,
 * in addition to providing other modesetting features, like i2c and DDC
 * bus accessors.
 */
struct drm_crtc_funcs {
	/* Save CRTC state */
	void (*save)(struct drm_crtc *crtc); /* suspend? */
	/* Restore CRTC state */
	void (*restore)(struct drm_crtc *crtc); /* resume? */
330 331
	/* Reset CRTC state */
	void (*reset)(struct drm_crtc *crtc);
D
Dave Airlie 已提交
332 333 334 335

	/* cursor controls */
	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
			  uint32_t handle, uint32_t width, uint32_t height);
336 337 338
	int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
			   uint32_t handle, uint32_t width, uint32_t height,
			   int32_t hot_x, int32_t hot_y);
D
Dave Airlie 已提交
339 340 341 342
	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);

	/* Set gamma on the CRTC */
	void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
J
James Simmons 已提交
343
			  uint32_t start, uint32_t size);
D
Dave Airlie 已提交
344 345 346 347
	/* Object destroy routine */
	void (*destroy)(struct drm_crtc *crtc);

	int (*set_config)(struct drm_mode_set *set);
348 349 350

	/*
	 * Flip to the given framebuffer.  This implements the page
L
Lucas De Marchi 已提交
351
	 * flip ioctl described in drm_mode.h, specifically, the
352 353 354 355 356 357 358 359
	 * implementation must return immediately and block all
	 * rendering to the current fb until the flip has completed.
	 * If userspace set the event flag in the ioctl, the event
	 * argument will point to an event to send back when the flip
	 * completes, otherwise it will be NULL.
	 */
	int (*page_flip)(struct drm_crtc *crtc,
			 struct drm_framebuffer *fb,
360 361
			 struct drm_pending_vblank_event *event,
			 uint32_t flags);
P
Paulo Zanoni 已提交
362 363 364

	int (*set_property)(struct drm_crtc *crtc,
			    struct drm_property *property, uint64_t val);
365 366 367 368

	/* atomic update handling */
	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
	void (*atomic_destroy_state)(struct drm_crtc *crtc,
D
Daniel Vetter 已提交
369
				     struct drm_crtc_state *state);
370 371 372 373
	int (*atomic_set_property)(struct drm_crtc *crtc,
				   struct drm_crtc_state *state,
				   struct drm_property *property,
				   uint64_t val);
D
Dave Airlie 已提交
374 375 376
};

/**
377
 * struct drm_crtc - central CRTC control structure
378
 * @dev: parent DRM device
D
Daniel Vetter 已提交
379
 * @port: OF node used by drm_of_find_possible_crtcs()
380
 * @head: list management
381
 * @mutex: per-CRTC locking
382
 * @base: base KMS object for ID tracking etc.
383 384
 * @primary: primary plane for this CRTC
 * @cursor: cursor plane for this CRTC
D
Daniel Vetter 已提交
385 386
 * @cursor_x: current x position of the cursor, used for universal cursor planes
 * @cursor_y: current y position of the cursor, used for universal cursor planes
D
Dave Airlie 已提交
387
 * @enabled: is this CRTC enabled?
388 389
 * @mode: current mode timings
 * @hwmode: mode timings as programmed to hw regs
R
Rob Clark 已提交
390 391 392
 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
 *    invert the width/height of the crtc.  This is used if the driver
 *    is performing 90 or 270 degree rotated scanout
D
Dave Airlie 已提交
393 394 395
 * @x: x position on screen
 * @y: y position on screen
 * @funcs: CRTC control functions
396 397 398
 * @gamma_size: size of gamma ramp
 * @gamma_store: gamma ramp values
 * @framedur_ns: precise frame timing
D
Daniel Vetter 已提交
399
 * @linedur_ns: precise line timing
400 401
 * @pixeldur_ns: precise pixel timing
 * @helper_private: mid-layer private data
P
Paulo Zanoni 已提交
402
 * @properties: property tracking for this CRTC
403
 * @state: current atomic state for this CRTC
D
Daniel Vetter 已提交
404 405
 * @acquire_ctx: per-CRTC implicit acquire context used by atomic drivers for
 * 	legacy ioctls
D
Dave Airlie 已提交
406 407 408 409 410 411
 *
 * Each CRTC may have one or more connectors associated with it.  This structure
 * allows the CRTC to be controlled.
 */
struct drm_crtc {
	struct drm_device *dev;
412
	struct device_node *port;
D
Dave Airlie 已提交
413 414
	struct list_head head;

415
	/*
D
Daniel Vetter 已提交
416 417 418 419 420 421
	 * crtc mutex
	 *
	 * This provides a read lock for the overall crtc state (mode, dpms
	 * state, ...) and a write lock for everything which can be update
	 * without a full modeset (fb, cursor data, ...)
	 */
422
	struct drm_modeset_lock mutex;
D
Daniel Vetter 已提交
423

D
Dave Airlie 已提交
424 425
	struct drm_mode_object base;

426 427 428 429
	/* primary and cursor planes for CRTC */
	struct drm_plane *primary;
	struct drm_plane *cursor;

430 431 432 433
	/* position of cursor plane on crtc */
	int cursor_x;
	int cursor_y;

D
Dave Airlie 已提交
434 435
	bool enabled;

436
	/* Requested mode from modesetting. */
D
Dave Airlie 已提交
437 438
	struct drm_display_mode mode;

439 440 441 442 443
	/* Programmed mode in hw, after adjustments for encoders,
	 * crtc, panel scaling etc. Needed for timestamping etc.
	 */
	struct drm_display_mode hwmode;

R
Rob Clark 已提交
444 445
	bool invert_dimensions;

D
Dave Airlie 已提交
446 447 448 449 450 451 452
	int x, y;
	const struct drm_crtc_funcs *funcs;

	/* CRTC gamma size for reporting to userspace */
	uint32_t gamma_size;
	uint16_t *gamma_store;

453
	/* Constants needed for precise vblank and swap timestamping. */
454
	int framedur_ns, linedur_ns, pixeldur_ns;
455

D
Dave Airlie 已提交
456 457
	/* if you are using the helper */
	void *helper_private;
P
Paulo Zanoni 已提交
458 459

	struct drm_object_properties properties;
460

461 462
	struct drm_crtc_state *state;

463 464 465 466 467
	/*
	 * For legacy crtc ioctls so that atomic drivers can get at the locking
	 * acquire context.
	 */
	struct drm_modeset_acquire_ctx *acquire_ctx;
D
Dave Airlie 已提交
468 469
};

470 471
/**
 * struct drm_connector_state - mutable connector state
472
 * @connector: backpointer to the connector
D
Daniel Vetter 已提交
473
 * @crtc: CRTC to connect connector to, NULL if disabled
474
 * @best_encoder: can be used by helpers and drivers to select the encoder
475 476 477
 * @state: backpointer to global drm_atomic_state
 */
struct drm_connector_state {
478 479
	struct drm_connector *connector;

480
	struct drm_crtc *crtc;  /* do not write directly, use drm_atomic_set_crtc_for_connector() */
481

482 483
	struct drm_encoder *best_encoder;

484 485
	struct drm_atomic_state *state;
};
D
Dave Airlie 已提交
486 487

/**
488
 * struct drm_connector_funcs - control connectors on a given device
D
Dave Airlie 已提交
489 490 491
 * @dpms: set power state (see drm_crtc_funcs above)
 * @save: save connector state
 * @restore: restore connector state
492
 * @reset: reset connector after state has been invalidated (e.g. resume)
D
Dave Airlie 已提交
493
 * @detect: is this connector active?
494
 * @fill_modes: fill mode list for this connector
495
 * @set_property: property for this connector may need an update
D
Dave Airlie 已提交
496
 * @destroy: make object go away
497
 * @force: notify the driver that the connector is forced on
498 499 500
 * @atomic_duplicate_state: duplicate the atomic state for this connector
 * @atomic_destroy_state: destroy an atomic state for this connector
 * @atomic_set_property: set a property on an atomic state for this connector
R
Rob Clark 已提交
501
 *    (do not call directly, use drm_atomic_connector_set_property())
502
 *
D
Dave Airlie 已提交
503 504 505 506 507 508 509 510
 * Each CRTC may have one or more connectors attached to it.  The functions
 * below allow the core DRM code to control connectors, enumerate available modes,
 * etc.
 */
struct drm_connector_funcs {
	void (*dpms)(struct drm_connector *connector, int mode);
	void (*save)(struct drm_connector *connector);
	void (*restore)(struct drm_connector *connector);
511
	void (*reset)(struct drm_connector *connector);
512 513 514 515 516 517 518

	/* Check to see if anything is attached to the connector.
	 * @force is set to false whilst polling, true when checking the
	 * connector due to user request. @force can be used by the driver
	 * to avoid expensive, destructive operations during automated
	 * probing.
	 */
519
	enum drm_connector_status (*detect)(struct drm_connector *connector,
520
					    bool force);
J
Jesse Barnes 已提交
521
	int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
D
Dave Airlie 已提交
522 523 524
	int (*set_property)(struct drm_connector *connector, struct drm_property *property,
			     uint64_t val);
	void (*destroy)(struct drm_connector *connector);
525
	void (*force)(struct drm_connector *connector);
526 527 528 529

	/* atomic update handling */
	struct drm_connector_state *(*atomic_duplicate_state)(struct drm_connector *connector);
	void (*atomic_destroy_state)(struct drm_connector *connector,
D
Daniel Vetter 已提交
530
				     struct drm_connector_state *state);
531 532 533 534
	int (*atomic_set_property)(struct drm_connector *connector,
				   struct drm_connector_state *state,
				   struct drm_property *property,
				   uint64_t val);
D
Dave Airlie 已提交
535 536
};

537
/**
538
 * struct drm_encoder_funcs - encoder controls
539 540 541 542 543
 * @reset: reset state (e.g. at init or resume time)
 * @destroy: cleanup and free associated data
 *
 * Encoders sit between CRTCs and connectors.
 */
D
Dave Airlie 已提交
544
struct drm_encoder_funcs {
545
	void (*reset)(struct drm_encoder *encoder);
D
Dave Airlie 已提交
546 547 548
	void (*destroy)(struct drm_encoder *encoder);
};

549
#define DRM_CONNECTOR_MAX_ENCODER 3
D
Dave Airlie 已提交
550 551

/**
552
 * struct drm_encoder - central DRM encoder structure
J
Jesse Barnes 已提交
553 554 555
 * @dev: parent DRM device
 * @head: list management
 * @base: base KMS object
556
 * @name: encoder name
J
Jesse Barnes 已提交
557 558 559 560
 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
 * @possible_crtcs: bitmask of potential CRTC bindings
 * @possible_clones: bitmask of potential sibling encoders for cloning
 * @crtc: currently bound CRTC
S
Sean Paul 已提交
561
 * @bridge: bridge associated to the encoder
J
Jesse Barnes 已提交
562 563 564 565 566
 * @funcs: control functions
 * @helper_private: mid-layer private data
 *
 * CRTCs drive pixels to encoders, which convert them into signals
 * appropriate for a given connector or set of connectors.
D
Dave Airlie 已提交
567 568 569 570 571 572
 */
struct drm_encoder {
	struct drm_device *dev;
	struct list_head head;

	struct drm_mode_object base;
573
	char *name;
D
Dave Airlie 已提交
574 575 576 577 578
	int encoder_type;
	uint32_t possible_crtcs;
	uint32_t possible_clones;

	struct drm_crtc *crtc;
S
Sean Paul 已提交
579
	struct drm_bridge *bridge;
D
Dave Airlie 已提交
580 581 582 583
	const struct drm_encoder_funcs *funcs;
	void *helper_private;
};

584 585 586 587 588 589 590 591 592
/* should we poll this connector for connects and disconnects */
/* hot plug detectable */
#define DRM_CONNECTOR_POLL_HPD (1 << 0)
/* poll for connections */
#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
/* can cleanly poll for disconnections without flickering the screen */
/* DACs should rarely do this without a lot of testing */
#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)

593 594
#define MAX_ELD_BYTES	128

D
Dave Airlie 已提交
595
/**
596
 * struct drm_connector - central DRM connector control structure
597 598 599 600 601
 * @dev: parent DRM device
 * @kdev: kernel device for sysfs attributes
 * @attr: sysfs attributes
 * @head: list management
 * @base: base KMS object
602
 * @name: connector name
603 604
 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
 * @connector_type_id: index into connector type enum
D
Dave Airlie 已提交
605 606
 * @interlace_allowed: can this connector handle interlaced modes?
 * @doublescan_allowed: can this connector handle doublescan?
D
Daniel Vetter 已提交
607
 * @stereo_allowed: can this connector handle stereo modes?
608 609 610 611
 * @modes: modes available on this connector (from fill_modes() + user)
 * @status: one of the drm_connector_status enums (connected, not, or unknown)
 * @probed_modes: list of modes derived directly from the display
 * @display_info: information about attached display (e.g. from EDID)
D
Dave Airlie 已提交
612
 * @funcs: connector control functions
613
 * @edid_blob_ptr: DRM property containing EDID if present
614
 * @properties: property tracking for this connector
D
Daniel Vetter 已提交
615
 * @path_blob_ptr: DRM blob property data for the DP MST path property
616 617 618
 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
 * @dpms: current dpms state
 * @helper_private: mid-layer private data
D
Daniel Vetter 已提交
619
 * @cmdline_mode: mode line parsed from the kernel cmdline for this connector
620
 * @force: a %DRM_FORCE_<foo> state for forced mode sets
D
Daniel Vetter 已提交
621
 * @override_edid: has the EDID been overwritten through debugfs for testing?
622 623 624 625 626 627 628 629 630
 * @encoder_ids: valid encoders for this connector
 * @encoder: encoder driving this connector, if any
 * @eld: EDID-like data, if present
 * @dvi_dual: dual link DVI, if found
 * @max_tmds_clock: max clock rate, if found
 * @latency_present: AV delay info from ELD, if found
 * @video_latency: video latency info from ELD, if found
 * @audio_latency: audio latency info from ELD, if found
 * @null_edid_counter: track sinks that give us all zeros for the EDID
D
Daniel Vetter 已提交
631 632
 * @bad_edid_counter: track sinks that give us an EDID with invalid checksum
 * @debugfs_entry: debugfs directory for this connector
633
 * @state: current atomic state for this connector
634 635 636 637 638 639 640 641 642
 * @has_tile: is this connector connected to a tiled monitor
 * @tile_group: tile group for the connected monitor
 * @tile_is_single_monitor: whether the tile is one monitor housing
 * @num_h_tile: number of horizontal tiles in the tile group
 * @num_v_tile: number of vertical tiles in the tile group
 * @tile_h_loc: horizontal location of this tile
 * @tile_v_loc: vertical location of this tile
 * @tile_h_size: horizontal size of this tile.
 * @tile_v_size: vertical size of this tile.
D
Dave Airlie 已提交
643 644 645 646 647 648 649 650
 *
 * Each connector may be connected to one or more CRTCs, or may be clonable by
 * another connector if they can share a CRTC.  Each connector also has a specific
 * position in the broader display (referred to as a 'screen' though it could
 * span multiple monitors).
 */
struct drm_connector {
	struct drm_device *dev;
651
	struct device *kdev;
D
Dave Airlie 已提交
652 653 654 655 656
	struct device_attribute *attr;
	struct list_head head;

	struct drm_mode_object base;

657
	char *name;
D
Dave Airlie 已提交
658 659 660 661
	int connector_type;
	int connector_type_id;
	bool interlace_allowed;
	bool doublescan_allowed;
662
	bool stereo_allowed;
D
Dave Airlie 已提交
663 664 665 666 667 668 669 670 671 672 673
	struct list_head modes; /* list of modes on this connector */

	enum drm_connector_status status;

	/* these are modes added by probing with DDC or the BIOS */
	struct list_head probed_modes;

	struct drm_display_info display_info;
	const struct drm_connector_funcs *funcs;

	struct drm_property_blob *edid_blob_ptr;
674
	struct drm_object_properties properties;
D
Dave Airlie 已提交
675

D
Dave Airlie 已提交
676 677
	struct drm_property_blob *path_blob_ptr;

678 679
	struct drm_property_blob *tile_blob_ptr;

680 681
	uint8_t polled; /* DRM_CONNECTOR_POLL_* */

682 683 684
	/* requested DPMS state */
	int dpms;

D
Dave Airlie 已提交
685 686
	void *helper_private;

687
	/* forced on connector */
688
	struct drm_cmdline_mode cmdline_mode;
689
	enum drm_connector_force force;
690
	bool override_edid;
D
Dave Airlie 已提交
691 692
	uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
	struct drm_encoder *encoder; /* currently active encoder */
693

694 695 696 697 698 699 700
	/* EDID bits */
	uint8_t eld[MAX_ELD_BYTES];
	bool dvi_dual;
	int max_tmds_clock;	/* in MHz */
	bool latency_present[2];
	int video_latency[2];	/* [0]: progressive, [1]: interlaced */
	int audio_latency[2];
701
	int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
702
	unsigned bad_edid_counter;
703 704

	struct dentry *debugfs_entry;
705 706

	struct drm_connector_state *state;
707 708 709 710 711 712 713 714 715

	/* DisplayID bits */
	bool has_tile;
	struct drm_tile_group *tile_group;
	bool tile_is_single_monitor;

	uint8_t num_h_tile, num_v_tile;
	uint8_t tile_h_loc, tile_v_loc;
	uint16_t tile_h_size, tile_v_size;
716 717 718 719
};

/**
 * struct drm_plane_state - mutable plane state
720
 * @plane: backpointer to the plane
721
 * @crtc: currently bound CRTC, NULL if disabled
D
Daniel Vetter 已提交
722
 * @fb: currently bound framebuffer
723
 * @fence: optional fence to wait for before scanning out @fb
724 725 726 727 728 729 730 731 732 733 734 735 736
 * @crtc_x: left position of visible portion of plane on crtc
 * @crtc_y: upper position of visible portion of plane on crtc
 * @crtc_w: width of visible portion of plane on crtc
 * @crtc_h: height of visible portion of plane on crtc
 * @src_x: left position of visible portion of plane within
 *	plane (in 16.16)
 * @src_y: upper position of visible portion of plane within
 *	plane (in 16.16)
 * @src_w: width of visible portion of plane (in 16.16)
 * @src_h: height of visible portion of plane (in 16.16)
 * @state: backpointer to global drm_atomic_state
 */
struct drm_plane_state {
737 738
	struct drm_plane *plane;

739 740
	struct drm_crtc *crtc;   /* do not write directly, use drm_atomic_set_crtc_for_plane() */
	struct drm_framebuffer *fb;  /* do not write directly, use drm_atomic_set_fb_for_plane() */
741
	struct fence *fence;
742 743 744 745 746 747 748 749 750 751

	/* Signed dest location allows it to be partially off screen */
	int32_t crtc_x, crtc_y;
	uint32_t crtc_w, crtc_h;

	/* Source values are 16.16 fixed point */
	uint32_t src_x, src_y;
	uint32_t src_h, src_w;

	struct drm_atomic_state *state;
D
Dave Airlie 已提交
752 753
};

754

J
Jesse Barnes 已提交
755
/**
756
 * struct drm_plane_funcs - driver plane control functions
J
Jesse Barnes 已提交
757 758 759
 * @update_plane: update the plane configuration
 * @disable_plane: shut down the plane
 * @destroy: clean up plane resources
D
Daniel Vetter 已提交
760
 * @reset: reset plane after state has been invalidated (e.g. resume)
R
Rob Clark 已提交
761
 * @set_property: called when a property is changed
762 763 764
 * @atomic_duplicate_state: duplicate the atomic state for this plane
 * @atomic_destroy_state: destroy an atomic state for this plane
 * @atomic_set_property: set a property on an atomic state for this plane
R
Rob Clark 已提交
765
 *    (do not call directly, use drm_atomic_plane_set_property())
J
Jesse Barnes 已提交
766 767 768 769 770 771 772 773 774 775
 */
struct drm_plane_funcs {
	int (*update_plane)(struct drm_plane *plane,
			    struct drm_crtc *crtc, struct drm_framebuffer *fb,
			    int crtc_x, int crtc_y,
			    unsigned int crtc_w, unsigned int crtc_h,
			    uint32_t src_x, uint32_t src_y,
			    uint32_t src_w, uint32_t src_h);
	int (*disable_plane)(struct drm_plane *plane);
	void (*destroy)(struct drm_plane *plane);
D
Daniel Vetter 已提交
776
	void (*reset)(struct drm_plane *plane);
R
Rob Clark 已提交
777 778 779

	int (*set_property)(struct drm_plane *plane,
			    struct drm_property *property, uint64_t val);
780 781 782 783

	/* atomic update handling */
	struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
	void (*atomic_destroy_state)(struct drm_plane *plane,
D
Daniel Vetter 已提交
784
				     struct drm_plane_state *state);
785 786 787 788
	int (*atomic_set_property)(struct drm_plane *plane,
				   struct drm_plane_state *state,
				   struct drm_property *property,
				   uint64_t val);
J
Jesse Barnes 已提交
789 790
};

791 792 793 794 795 796
enum drm_plane_type {
	DRM_PLANE_TYPE_OVERLAY,
	DRM_PLANE_TYPE_PRIMARY,
	DRM_PLANE_TYPE_CURSOR,
};

J
Jesse Barnes 已提交
797
/**
798
 * struct drm_plane - central DRM plane control structure
J
Jesse Barnes 已提交
799 800 801 802 803 804 805 806
 * @dev: DRM device this plane belongs to
 * @head: for list management
 * @base: base mode object
 * @possible_crtcs: pipes this plane can be bound to
 * @format_types: array of formats supported by this plane
 * @format_count: number of formats supported
 * @crtc: currently bound CRTC
 * @fb: currently bound fb
D
Daniel Vetter 已提交
807 808
 * @old_fb: Temporary tracking of the old fb while a modeset is ongoing. Used by
 * 	drm_mode_set_config_internal() to implement correct refcounting.
J
Jesse Barnes 已提交
809
 * @funcs: helper functions
R
Rob Clark 已提交
810
 * @properties: property tracking for this plane
811
 * @type: type of plane (overlay, primary, cursor)
812
 * @state: current atomic state for this plane
J
Jesse Barnes 已提交
813 814 815 816 817
 */
struct drm_plane {
	struct drm_device *dev;
	struct list_head head;

D
Daniel Vetter 已提交
818 819
	struct drm_modeset_lock mutex;

J
Jesse Barnes 已提交
820 821 822 823 824 825 826 827 828
	struct drm_mode_object base;

	uint32_t possible_crtcs;
	uint32_t *format_types;
	uint32_t format_count;

	struct drm_crtc *crtc;
	struct drm_framebuffer *fb;

829 830
	struct drm_framebuffer *old_fb;

J
Jesse Barnes 已提交
831
	const struct drm_plane_funcs *funcs;
R
Rob Clark 已提交
832 833

	struct drm_object_properties properties;
834 835

	enum drm_plane_type type;
836

D
Daniel Vetter 已提交
837 838
	void *helper_private;

839
	struct drm_plane_state *state;
J
Jesse Barnes 已提交
840 841
};

S
Sean Paul 已提交
842
/**
843
 * struct drm_bridge_funcs - drm_bridge control functions
S
Sean Paul 已提交
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
 * @disable: Called right before encoder prepare, disables the bridge
 * @post_disable: Called right after encoder prepare, for lockstepped disable
 * @mode_set: Set this mode to the bridge
 * @pre_enable: Called right before encoder commit, for lockstepped commit
 * @enable: Called right after encoder commit, enables the bridge
 * @destroy: make object go away
 */
struct drm_bridge_funcs {
	bool (*mode_fixup)(struct drm_bridge *bridge,
			   const struct drm_display_mode *mode,
			   struct drm_display_mode *adjusted_mode);
	void (*disable)(struct drm_bridge *bridge);
	void (*post_disable)(struct drm_bridge *bridge);
	void (*mode_set)(struct drm_bridge *bridge,
			 struct drm_display_mode *mode,
			 struct drm_display_mode *adjusted_mode);
	void (*pre_enable)(struct drm_bridge *bridge);
	void (*enable)(struct drm_bridge *bridge);
	void (*destroy)(struct drm_bridge *bridge);
};

/**
867
 * struct drm_bridge - central DRM bridge control structure
S
Sean Paul 已提交
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
 * @dev: DRM device this bridge belongs to
 * @head: list management
 * @base: base mode object
 * @funcs: control functions
 * @driver_private: pointer to the bridge driver's internal context
 */
struct drm_bridge {
	struct drm_device *dev;
	struct list_head head;

	struct drm_mode_object base;

	const struct drm_bridge_funcs *funcs;
	void *driver_private;
};

D
Daniel Vetter 已提交
884 885 886 887 888 889 890 891
/**
 * struct struct drm_atomic_state - the global state object for atomic updates
 * @dev: parent DRM device
 * @flags: state flags like async update
 * @planes: pointer to array of plane pointers
 * @plane_states: pointer to array of plane states pointers
 * @crtcs: pointer to array of CRTC pointers
 * @crtc_states: pointer to array of CRTC states pointers
892
 * @num_connector: size of the @connectors and @connector_states arrays
D
Daniel Vetter 已提交
893 894 895 896 897 898 899 900 901 902 903
 * @connectors: pointer to array of connector pointers
 * @connector_states: pointer to array of connector states pointers
 * @acquire_ctx: acquire context for this atomic modeset state update
 */
struct drm_atomic_state {
	struct drm_device *dev;
	uint32_t flags;
	struct drm_plane **planes;
	struct drm_plane_state **plane_states;
	struct drm_crtc **crtcs;
	struct drm_crtc_state **crtc_states;
904
	int num_connector;
D
Daniel Vetter 已提交
905 906 907 908 909 910 911
	struct drm_connector **connectors;
	struct drm_connector_state **connector_states;

	struct drm_modeset_acquire_ctx *acquire_ctx;
};


D
Dave Airlie 已提交
912
/**
913
 * struct drm_mode_set - new values for a CRTC config change
914 915 916 917 918 919 920
 * @fb: framebuffer to use for new config
 * @crtc: CRTC whose configuration we're about to change
 * @mode: mode timings to use
 * @x: position of this CRTC relative to @fb
 * @y: position of this CRTC relative to @fb
 * @connectors: array of connectors to drive with this CRTC if possible
 * @num_connectors: size of @connectors array
D
Dave Airlie 已提交
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
 *
 * Represents a single crtc the connectors that it drives with what mode
 * and from which framebuffer it scans out from.
 *
 * This is used to set modes.
 */
struct drm_mode_set {
	struct drm_framebuffer *fb;
	struct drm_crtc *crtc;
	struct drm_display_mode *mode;

	uint32_t x;
	uint32_t y;

	struct drm_connector **connectors;
	size_t num_connectors;
};

/**
940 941 942
 * struct drm_mode_config_funcs - basic driver provided mode setting functions
 * @fb_create: create a new framebuffer object
 * @output_poll_changed: function to handle output configuration changes
D
Daniel Vetter 已提交
943 944 945
 * @atomic_check: check whether a give atomic state update is possible
 * @atomic_commit: commit an atomic state update previously verified with
 * 	atomic_check()
946 947 948
 *
 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
 * involve drivers.
D
Dave Airlie 已提交
949 950
 */
struct drm_mode_config_funcs {
951 952 953
	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
					     struct drm_file *file_priv,
					     struct drm_mode_fb_cmd2 *mode_cmd);
954
	void (*output_poll_changed)(struct drm_device *dev);
D
Daniel Vetter 已提交
955 956 957 958 959 960

	int (*atomic_check)(struct drm_device *dev,
			    struct drm_atomic_state *a);
	int (*atomic_commit)(struct drm_device *dev,
			     struct drm_atomic_state *a,
			     bool async);
D
Dave Airlie 已提交
961 962
};

963
/**
D
Daniel Vetter 已提交
964
 * struct drm_mode_group - group of mode setting resources for potential sub-grouping
965 966 967
 * @num_crtcs: CRTC count
 * @num_encoders: encoder count
 * @num_connectors: connector count
D
Daniel Vetter 已提交
968
 * @num_bridges: bridge count
969 970 971 972 973 974 975 976
 * @id_list: list of KMS object IDs in this group
 *
 * Currently this simply tracks the global mode setting state.  But in the
 * future it could allow groups of objects to be set aside into independent
 * control groups for use by different user level processes (e.g. two X servers
 * running simultaneously on different heads, each with their own mode
 * configuration and freedom of mode setting).
 */
D
Dave Airlie 已提交
977 978 979 980
struct drm_mode_group {
	uint32_t num_crtcs;
	uint32_t num_encoders;
	uint32_t num_connectors;
S
Sean Paul 已提交
981
	uint32_t num_bridges;
D
Dave Airlie 已提交
982 983 984 985 986 987

	/* list of object IDs for this group */
	uint32_t *id_list;
};

/**
D
Daniel Vetter 已提交
988
 * struct drm_mode_config - Mode configuration control structure
989
 * @mutex: mutex protecting KMS related lists and structures
D
Daniel Vetter 已提交
990 991 992
 * @connection_mutex: ww mutex protecting connector state and routing
 * @acquire_ctx: global implicit acquire context used by atomic drivers for
 * 	legacy ioctls
993 994
 * @idr_mutex: mutex for KMS ID allocation and management
 * @crtc_idr: main KMS ID tracking object
D
Daniel Vetter 已提交
995
 * @fb_lock: mutex to protect fb state and lists
996 997 998 999
 * @num_fb: number of fbs available
 * @fb_list: list of framebuffers available
 * @num_connector: number of connectors on this device
 * @connector_list: list of connector objects
S
Sean Paul 已提交
1000 1001
 * @num_bridge: number of bridges on this device
 * @bridge_list: list of bridge objects
1002 1003
 * @num_encoder: number of encoders on this device
 * @encoder_list: list of encoder objects
D
Daniel Vetter 已提交
1004 1005 1006
 * @num_overlay_plane: number of overlay planes on this device
 * @num_total_plane: number of universal (i.e. with primary/curso) planes on this device
 * @plane_list: list of plane objects
1007 1008
 * @num_crtc: number of CRTCs on this device
 * @crtc_list: list of CRTC objects
D
Daniel Vetter 已提交
1009
 * @property_list: list of property objects
1010 1011 1012 1013 1014 1015
 * @min_width: minimum pixel width on this device
 * @min_height: minimum pixel height on this device
 * @max_width: maximum pixel width on this device
 * @max_height: maximum pixel height on this device
 * @funcs: core driver provided mode setting functions
 * @fb_base: base address of the framebuffer
D
Daniel Vetter 已提交
1016 1017
 * @poll_enabled: track polling support for this device
 * @poll_running: track polling status for this device
1018
 * @output_poll_work: delayed work for polling in process context
D
Daniel Vetter 已提交
1019
 * @property_blob_list: list of all the blob property objects
1020
 * @*_property: core property tracking
D
Daniel Vetter 已提交
1021 1022 1023 1024 1025
 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
 * @async_page_flip: does this device support async flips on the primary plane?
 * @cursor_width: hint to userspace for max cursor width
 * @cursor_height: hint to userspace for max cursor height
D
Dave Airlie 已提交
1026
 *
1027 1028 1029
 * Core mode resource tracking structure.  All CRTC, encoders, and connectors
 * enumerated by the driver are added here, as are global properties.  Some
 * global restrictions are also here, e.g. dimension restrictions.
D
Dave Airlie 已提交
1030 1031
 */
struct drm_mode_config {
J
Jesse Barnes 已提交
1032
	struct mutex mutex; /* protects configuration (mode lists etc.) */
1033 1034
	struct drm_modeset_lock connection_mutex; /* protects connector->encoder and encoder->crtc links */
	struct drm_modeset_acquire_ctx *acquire_ctx; /* for legacy _lock_all() / _unlock_all() */
J
Jesse Barnes 已提交
1035
	struct mutex idr_mutex; /* for IDR management */
D
Dave Airlie 已提交
1036
	struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
D
Dave Airlie 已提交
1037
	struct idr tile_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
D
Dave Airlie 已提交
1038
	/* this is limited to one for now */
1039

D
Daniel Vetter 已提交
1040
	struct mutex fb_lock; /* proctects global and per-file fb lists */
D
Dave Airlie 已提交
1041 1042
	int num_fb;
	struct list_head fb_list;
1043

D
Dave Airlie 已提交
1044 1045
	int num_connector;
	struct list_head connector_list;
S
Sean Paul 已提交
1046 1047
	int num_bridge;
	struct list_head bridge_list;
D
Dave Airlie 已提交
1048 1049
	int num_encoder;
	struct list_head encoder_list;
1050 1051 1052 1053 1054 1055 1056 1057 1058

	/*
	 * Track # of overlay planes separately from # of total planes.  By
	 * default we only advertise overlay planes to userspace; if userspace
	 * sets the "universal plane" capability bit, we'll go ahead and
	 * expose all planes.
	 */
	int num_overlay_plane;
	int num_total_plane;
J
Jesse Barnes 已提交
1059
	struct list_head plane_list;
D
Dave Airlie 已提交
1060 1061 1062 1063 1064 1065 1066 1067

	int num_crtc;
	struct list_head crtc_list;

	struct list_head property_list;

	int min_width, min_height;
	int max_width, max_height;
1068
	const struct drm_mode_config_funcs *funcs;
1069
	resource_size_t fb_base;
D
Dave Airlie 已提交
1070

1071 1072
	/* output poll support */
	bool poll_enabled;
1073
	bool poll_running;
1074
	struct delayed_work output_poll_work;
1075

D
Dave Airlie 已提交
1076 1077 1078 1079
	/* pointers to standard properties */
	struct list_head property_blob_list;
	struct drm_property *edid_property;
	struct drm_property *dpms_property;
D
Dave Airlie 已提交
1080
	struct drm_property *path_property;
1081
	struct drm_property *tile_property;
R
Rob Clark 已提交
1082
	struct drm_property *plane_type_property;
1083
	struct drm_property *rotation_property;
D
Dave Airlie 已提交
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096

	/* DVI-I properties */
	struct drm_property *dvi_i_subconnector_property;
	struct drm_property *dvi_i_select_subconnector_property;

	/* TV properties */
	struct drm_property *tv_subconnector_property;
	struct drm_property *tv_select_subconnector_property;
	struct drm_property *tv_mode_property;
	struct drm_property *tv_left_margin_property;
	struct drm_property *tv_right_margin_property;
	struct drm_property *tv_top_margin_property;
	struct drm_property *tv_bottom_margin_property;
1097 1098 1099
	struct drm_property *tv_brightness_property;
	struct drm_property *tv_contrast_property;
	struct drm_property *tv_flicker_reduction_property;
1100 1101 1102
	struct drm_property *tv_overscan_property;
	struct drm_property *tv_saturation_property;
	struct drm_property *tv_hue_property;
D
Dave Airlie 已提交
1103 1104 1105

	/* Optional properties */
	struct drm_property *scaling_mode_property;
1106
	struct drm_property *aspect_ratio_property;
1107
	struct drm_property *dirty_info_property;
1108

1109 1110 1111 1112
	/* properties for virtual machine layout */
	struct drm_property *suggested_x_property;
	struct drm_property *suggested_y_property;

1113 1114
	/* dumb ioctl parameters */
	uint32_t preferred_depth, prefer_shadow;
1115 1116 1117

	/* whether async page flip is supported or not */
	bool async_page_flip;
A
Alex Deucher 已提交
1118 1119 1120

	/* cursor size */
	uint32_t cursor_width, cursor_height;
D
Dave Airlie 已提交
1121 1122
};

R
Rob Clark 已提交
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
/**
 * drm_for_each_plane_mask - iterate over planes specified by bitmask
 * @plane: the loop cursor
 * @dev: the DRM device
 * @plane_mask: bitmask of plane indices
 *
 * Iterate over all planes specified by bitmask.
 */
#define drm_for_each_plane_mask(plane, dev, plane_mask) \
	list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \
		if ((plane_mask) & (1 << drm_plane_index(plane)))


D
Dave Airlie 已提交
1136 1137 1138 1139 1140 1141 1142
#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
#define obj_to_connector(x) container_of(x, struct drm_connector, base)
#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
#define obj_to_property(x) container_of(x, struct drm_property, base)
#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
J
Jesse Barnes 已提交
1143
#define obj_to_plane(x) container_of(x, struct drm_plane, base)
D
Dave Airlie 已提交
1144

1145 1146 1147 1148
struct drm_prop_enum_list {
	int type;
	char *name;
};
D
Dave Airlie 已提交
1149

1150 1151 1152
extern int drm_crtc_init_with_planes(struct drm_device *dev,
				     struct drm_crtc *crtc,
				     struct drm_plane *primary,
1153
				     struct drm_plane *cursor,
1154
				     const struct drm_crtc_funcs *funcs);
D
Dave Airlie 已提交
1155
extern void drm_crtc_cleanup(struct drm_crtc *crtc);
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
extern unsigned int drm_crtc_index(struct drm_crtc *crtc);

/**
 * drm_crtc_mask - find the mask of a registered CRTC
 * @crtc: CRTC to find mask for
 *
 * Given a registered CRTC, return the mask bit of that CRTC for an
 * encoder's possible_crtcs field.
 */
static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
{
	return 1 << drm_crtc_index(crtc);
}
D
Dave Airlie 已提交
1169

1170 1171
extern void drm_connector_ida_init(void);
extern void drm_connector_ida_destroy(void);
1172 1173 1174 1175
extern int drm_connector_init(struct drm_device *dev,
			      struct drm_connector *connector,
			      const struct drm_connector_funcs *funcs,
			      int connector_type);
1176 1177
int drm_connector_register(struct drm_connector *connector);
void drm_connector_unregister(struct drm_connector *connector);
D
Dave Airlie 已提交
1178 1179

extern void drm_connector_cleanup(struct drm_connector *connector);
1180
extern unsigned int drm_connector_index(struct drm_connector *connector);
1181 1182
/* helper to unplug all connectors from sysfs for device */
extern void drm_connector_unplug_all(struct drm_device *dev);
D
Dave Airlie 已提交
1183

S
Sean Paul 已提交
1184 1185 1186 1187
extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
			   const struct drm_bridge_funcs *funcs);
extern void drm_bridge_cleanup(struct drm_bridge *bridge);

1188 1189 1190 1191
extern int drm_encoder_init(struct drm_device *dev,
			    struct drm_encoder *encoder,
			    const struct drm_encoder_funcs *funcs,
			    int encoder_type);
D
Dave Airlie 已提交
1192

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
/**
 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
 * @encoder: encoder to test
 * @crtc: crtc to test
 *
 * Return false if @encoder can't be driven by @crtc, true otherwise.
 */
static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
				       struct drm_crtc *crtc)
{
	return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
}

M
Matt Roper 已提交
1206 1207 1208 1209 1210 1211 1212
extern int drm_universal_plane_init(struct drm_device *dev,
				    struct drm_plane *plane,
				    unsigned long possible_crtcs,
				    const struct drm_plane_funcs *funcs,
				    const uint32_t *formats,
				    uint32_t format_count,
				    enum drm_plane_type type);
J
Jesse Barnes 已提交
1213 1214 1215 1216
extern int drm_plane_init(struct drm_device *dev,
			  struct drm_plane *plane,
			  unsigned long possible_crtcs,
			  const struct drm_plane_funcs *funcs,
R
Rob Clark 已提交
1217
			  const uint32_t *formats, uint32_t format_count,
M
Matt Roper 已提交
1218
			  bool is_primary);
J
Jesse Barnes 已提交
1219
extern void drm_plane_cleanup(struct drm_plane *plane);
1220
extern unsigned int drm_plane_index(struct drm_plane *plane);
1221
extern void drm_plane_force_disable(struct drm_plane *plane);
1222 1223 1224 1225
extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
				   int x, int y,
				   const struct drm_display_mode *mode,
				   const struct drm_framebuffer *fb);
J
Jesse Barnes 已提交
1226

D
Dave Airlie 已提交
1227 1228
extern void drm_encoder_cleanup(struct drm_encoder *encoder);

1229
extern const char *drm_get_connector_status_name(enum drm_connector_status status);
1230
extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
1231 1232 1233 1234 1235
extern const char *drm_get_dpms_name(int val);
extern const char *drm_get_dvi_i_subconnector_name(int val);
extern const char *drm_get_dvi_i_select_name(int val);
extern const char *drm_get_tv_subconnector_name(int val);
extern const char *drm_get_tv_select_name(int val);
1236
extern void drm_fb_release(struct drm_file *file_priv);
D
Dave Airlie 已提交
1237
extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
1238
extern void drm_mode_group_destroy(struct drm_mode_group *group);
1239
extern void drm_reinit_primary_mode_group(struct drm_device *dev);
A
Adam Jackson 已提交
1240
extern bool drm_probe_ddc(struct i2c_adapter *adapter);
D
Dave Airlie 已提交
1241 1242
extern struct edid *drm_get_edid(struct drm_connector *connector,
				 struct i2c_adapter *adapter);
J
Jani Nikula 已提交
1243
extern struct edid *drm_edid_duplicate(const struct edid *edid);
D
Dave Airlie 已提交
1244 1245
extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
extern void drm_mode_config_init(struct drm_device *dev);
1246
extern void drm_mode_config_reset(struct drm_device *dev);
D
Dave Airlie 已提交
1247
extern void drm_mode_config_cleanup(struct drm_device *dev);
1248

D
Dave Airlie 已提交
1249
extern int drm_mode_connector_set_path_property(struct drm_connector *connector,
1250
						const char *path);
1251
int drm_mode_connector_set_tile_property(struct drm_connector *connector);
D
Dave Airlie 已提交
1252
extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
1253
						   const struct edid *edid);
R
Rob Clark 已提交
1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270

static inline bool drm_property_type_is(struct drm_property *property,
		uint32_t type)
{
	/* instanceof for props.. handles extended type vs original types: */
	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
		return (property->flags & DRM_MODE_PROP_EXTENDED_TYPE) == type;
	return property->flags & type;
}

static inline bool drm_property_type_valid(struct drm_property *property)
{
	if (property->flags & DRM_MODE_PROP_EXTENDED_TYPE)
		return !(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
	return !!(property->flags & DRM_MODE_PROP_LEGACY_TYPE);
}

1271 1272 1273 1274 1275 1276
extern int drm_object_property_set_value(struct drm_mode_object *obj,
					 struct drm_property *property,
					 uint64_t val);
extern int drm_object_property_get_value(struct drm_mode_object *obj,
					 struct drm_property *property,
					 uint64_t *value);
D
Dave Airlie 已提交
1277 1278 1279
extern int drm_framebuffer_init(struct drm_device *dev,
				struct drm_framebuffer *fb,
				const struct drm_framebuffer_funcs *funcs);
1280 1281
extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
						      uint32_t id);
R
Rob Clark 已提交
1282 1283 1284
extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
D
Dave Airlie 已提交
1285
extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
1286
extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
D
Dave Airlie 已提交
1287

1288 1289 1290
extern void drm_object_attach_property(struct drm_mode_object *obj,
				       struct drm_property *property,
				       uint64_t init_val);
D
Dave Airlie 已提交
1291 1292
extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
						const char *name, int num_values);
1293 1294
extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
					 const char *name,
R
Rob Clark 已提交
1295 1296 1297 1298
					 const struct drm_prop_enum_list *props,
					 int num_values);
struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
					 int flags, const char *name,
1299
					 const struct drm_prop_enum_list *props,
1300 1301
					 int num_props,
					 uint64_t supported_bits);
1302 1303 1304
struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
					 const char *name,
					 uint64_t min, uint64_t max);
R
Rob Clark 已提交
1305 1306 1307
struct drm_property *drm_property_create_signed_range(struct drm_device *dev,
					 int flags, const char *name,
					 int64_t min, int64_t max);
R
Rob Clark 已提交
1308 1309
struct drm_property *drm_property_create_object(struct drm_device *dev,
					 int flags, const char *name, uint32_t type);
D
Dave Airlie 已提交
1310 1311 1312 1313
extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
extern int drm_property_add_enum(struct drm_property *property, int index,
				 uint64_t value, const char *name);
extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
1314 1315 1316
extern int drm_mode_create_tv_properties(struct drm_device *dev,
					 unsigned int num_modes,
					 char *modes[]);
D
Dave Airlie 已提交
1317
extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
1318
extern int drm_mode_create_aspect_ratio_property(struct drm_device *dev);
1319
extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
1320
extern int drm_mode_create_suggested_offset_properties(struct drm_device *dev);
D
Dave Airlie 已提交
1321 1322 1323

extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
					     struct drm_encoder *encoder);
1324
extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
D
Dave Airlie 已提交
1325
					 int gamma_size);
1326 1327
extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
		uint32_t id, uint32_t type);
R
Rob Clark 已提交
1328

D
Dave Airlie 已提交
1329 1330 1331
/* IOCTLs */
extern int drm_mode_getresources(struct drm_device *dev,
				 void *data, struct drm_file *file_priv);
J
Jesse Barnes 已提交
1332 1333
extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
				   struct drm_file *file_priv);
D
Dave Airlie 已提交
1334 1335 1336 1337
extern int drm_mode_getcrtc(struct drm_device *dev,
			    void *data, struct drm_file *file_priv);
extern int drm_mode_getconnector(struct drm_device *dev,
			      void *data, struct drm_file *file_priv);
1338
extern int drm_mode_set_config_internal(struct drm_mode_set *set);
D
Dave Airlie 已提交
1339 1340
extern int drm_mode_setcrtc(struct drm_device *dev,
			    void *data, struct drm_file *file_priv);
J
Jesse Barnes 已提交
1341 1342 1343 1344
extern int drm_mode_getplane(struct drm_device *dev,
			       void *data, struct drm_file *file_priv);
extern int drm_mode_setplane(struct drm_device *dev,
			       void *data, struct drm_file *file_priv);
D
Dave Airlie 已提交
1345 1346
extern int drm_mode_cursor_ioctl(struct drm_device *dev,
				void *data, struct drm_file *file_priv);
1347 1348
extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
				void *data, struct drm_file *file_priv);
D
Dave Airlie 已提交
1349 1350
extern int drm_mode_addfb(struct drm_device *dev,
			  void *data, struct drm_file *file_priv);
1351 1352 1353
extern int drm_mode_addfb2(struct drm_device *dev,
			   void *data, struct drm_file *file_priv);
extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
D
Dave Airlie 已提交
1354 1355 1356 1357
extern int drm_mode_rmfb(struct drm_device *dev,
			 void *data, struct drm_file *file_priv);
extern int drm_mode_getfb(struct drm_device *dev,
			  void *data, struct drm_file *file_priv);
1358 1359
extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
				  void *data, struct drm_file *file_priv);
D
Dave Airlie 已提交
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372

extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
				      void *data, struct drm_file *file_priv);
extern int drm_mode_getblob_ioctl(struct drm_device *dev,
				  void *data, struct drm_file *file_priv);
extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
					      void *data, struct drm_file *file_priv);
extern int drm_mode_getencoder(struct drm_device *dev,
			       void *data, struct drm_file *file_priv);
extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
				    void *data, struct drm_file *file_priv);
extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
				    void *data, struct drm_file *file_priv);
1373
extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1374
extern enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
1375
extern bool drm_detect_hdmi_monitor(struct edid *edid);
1376
extern bool drm_detect_monitor_audio(struct edid *edid);
1377
extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1378 1379
extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
				    void *data, struct drm_file *file_priv);
1380 1381
extern int drm_add_modes_noedid(struct drm_connector *connector,
				int hdisplay, int vdisplay);
G
Gerd Hoffmann 已提交
1382 1383
extern void drm_set_preferred_mode(struct drm_connector *connector,
				   int hpref, int vpref);
1384

1385
extern int drm_edid_header_is_valid(const u8 *raw_edid);
1386
extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1387
extern bool drm_edid_is_valid(struct edid *edid);
D
Dave Airlie 已提交
1388 1389 1390 1391 1392 1393 1394

extern struct drm_tile_group *drm_mode_create_tile_group(struct drm_device *dev,
							 char topology[8]);
extern struct drm_tile_group *drm_mode_get_tile_group(struct drm_device *dev,
					       char topology[8]);
extern void drm_mode_put_tile_group(struct drm_device *dev,
				   struct drm_tile_group *tg);
D
Dave Airlie 已提交
1395
struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1396 1397
					   int hsize, int vsize, int fresh,
					   bool rb);
1398 1399 1400 1401 1402 1403 1404

extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
				      void *data, struct drm_file *file_priv);
extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
				    void *data, struct drm_file *file_priv);
extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
				      void *data, struct drm_file *file_priv);
1405 1406 1407 1408
extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
					     struct drm_file *file_priv);
extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
					   struct drm_file *file_priv);
1409 1410 1411
extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
				       struct drm_property *property,
				       uint64_t value);
1412 1413 1414

extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
				 int *bpp);
1415
extern int drm_format_num_planes(uint32_t format);
1416
extern int drm_format_plane_cpp(uint32_t format, int plane);
1417 1418
extern int drm_format_horz_chroma_subsampling(uint32_t format);
extern int drm_format_vert_chroma_subsampling(uint32_t format);
1419
extern const char *drm_get_format_name(uint32_t format);
1420 1421
extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
							      unsigned int supported_rotations);
1422 1423
extern unsigned int drm_rotation_simplify(unsigned int rotation,
					  unsigned int supported_rotations);
1424

R
Russell King 已提交
1425
/* Helpers */
R
Rob Clark 已提交
1426 1427 1428 1429 1430 1431 1432 1433 1434

static inline struct drm_plane *drm_plane_find(struct drm_device *dev,
		uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PLANE);
	return mo ? obj_to_plane(mo) : NULL;
}

R
Russell King 已提交
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
	uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
	return mo ? obj_to_crtc(mo) : NULL;
}

static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
	uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
	return mo ? obj_to_encoder(mo) : NULL;
}

R
Rob Clark 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
static inline struct drm_connector *drm_connector_find(struct drm_device *dev,
		uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CONNECTOR);
	return mo ? obj_to_connector(mo) : NULL;
}

static inline struct drm_property *drm_property_find(struct drm_device *dev,
		uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_PROPERTY);
	return mo ? obj_to_property(mo) : NULL;
}

static inline struct drm_property_blob *
drm_property_blob_find(struct drm_device *dev, uint32_t id)
{
	struct drm_mode_object *mo;
	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_BLOB);
	return mo ? obj_to_blob(mo) : NULL;
}

1475 1476 1477 1478 1479
/* Plane list iterator for legacy (overlay only) planes. */
#define drm_for_each_legacy_plane(plane, planelist) \
	list_for_each_entry(plane, planelist, head) \
		if (plane->type == DRM_PLANE_TYPE_OVERLAY)

D
Dave Airlie 已提交
1480
#endif /* __DRM_CRTC_H__ */