drm_crtc.h 68.0 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
#include <linux/media-bus-format.h>
35 36
#include <uapi/drm/drm_mode.h>
#include <uapi/drm/drm_fourcc.h>
37
#include <drm/drm_modeset_lock.h>
38
#include <drm/drm_rect.h>
39
#include <drm/drm_mode_object.h>
40 41
#include <drm/drm_framebuffer.h>
#include <drm/drm_modes.h>
D
Daniel Vetter 已提交
42
#include <drm/drm_connector.h>
D
Daniel Vetter 已提交
43
#include <drm/drm_encoder.h>
D
Daniel Vetter 已提交
44
#include <drm/drm_property.h>
D
Daniel Vetter 已提交
45
#include <drm/drm_bridge.h>
46

D
Dave Airlie 已提交
47 48
struct drm_device;
struct drm_mode_set;
49 50
struct drm_file;
struct drm_clip_rect;
51
struct device_node;
52
struct fence;
D
Daniel Vetter 已提交
53
struct edid;
D
Dave Airlie 已提交
54

R
Rob Clark 已提交
55 56 57 58 59 60 61 62 63
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);
}

64 65 66 67 68
/*
 * Rotation property bits. DRM_ROTATE_<degrees> rotates the image by the
 * specified amount in degrees in counter clockwise direction. DRM_REFLECT_X and
 * DRM_REFLECT_Y reflects the image along the specified axis prior to rotation
 */
69 70 71 72 73 74 75 76 77
#define DRM_ROTATE_0	BIT(0)
#define DRM_ROTATE_90	BIT(1)
#define DRM_ROTATE_180	BIT(2)
#define DRM_ROTATE_270	BIT(3)
#define DRM_ROTATE_MASK (DRM_ROTATE_0   | DRM_ROTATE_90 | \
			 DRM_ROTATE_180 | DRM_ROTATE_270)
#define DRM_REFLECT_X	BIT(4)
#define DRM_REFLECT_Y	BIT(5)
#define DRM_REFLECT_MASK (DRM_REFLECT_X | DRM_REFLECT_Y)
78

D
Dave Airlie 已提交
79 80 81 82 83 84 85 86
/* 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 已提交
87 88
struct drm_crtc;
struct drm_encoder;
89
struct drm_pending_vblank_event;
J
Jesse Barnes 已提交
90
struct drm_plane;
S
Sean Paul 已提交
91
struct drm_bridge;
92 93
struct drm_atomic_state;

94 95 96 97
struct drm_crtc_helper_funcs;
struct drm_encoder_helper_funcs;
struct drm_plane_helper_funcs;

98
/**
D
Daniel Vetter 已提交
99
 * struct drm_crtc_state - mutable CRTC state
100
 * @crtc: backpointer to the CRTC
101
 * @enable: whether the CRTC should be enabled, gates all other state
102
 * @active: whether the CRTC is actively displaying (used for DPMS)
103 104 105 106
 * @planes_changed: planes on this crtc are updated
 * @mode_changed: crtc_state->mode or crtc_state->enable has been changed
 * @active_changed: crtc_state->active has been toggled.
 * @connectors_changed: connectors to this crtc have been updated
107
 * @zpos_changed: zpos values of planes on this crtc have been updated
108 109
 * @color_mgmt_changed: color management properties have changed (degamma or
 *	gamma LUT or CSC matrix)
110
 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
111
 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors
112
 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders
113 114
 * @last_vblank_count: for helpers and drivers to capture the vblank of the
 * 	update to ensure framebuffer cleanup isn't done too early
115
 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
116
 * @mode: current mode timings
117
 * @mode_blob: &drm_property_blob for @mode
118 119 120 121 122
 * @degamma_lut: Lookup table for converting framebuffer pixel data
 *	before apply the conversion matrix
 * @ctm: Transformation matrix
 * @gamma_lut: Lookup table for converting pixel data after the
 *	conversion matrix
123 124 125
 * @event: optional pointer to a DRM event to signal upon completion of the
 * 	state update
 * @state: backpointer to global drm_atomic_state
126 127 128 129 130 131
 *
 * 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.
132 133
 */
struct drm_crtc_state {
134 135
	struct drm_crtc *crtc;

D
Daniel Vetter 已提交
136
	bool enable;
137
	bool active;
138

D
Daniel Vetter 已提交
139 140
	/* computed state bits used by helpers and drivers */
	bool planes_changed : 1;
141
	bool mode_changed : 1;
142
	bool active_changed : 1;
143
	bool connectors_changed : 1;
144
	bool zpos_changed : 1;
145
	bool color_mgmt_changed : 1;
146

147 148 149 150 151 152 153
	/* 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;

154
	u32 connector_mask;
155
	u32 encoder_mask;
156

157 158
	/* last_vblank_count: for vblank waits before cleanup */
	u32 last_vblank_count;
D
Daniel Vetter 已提交
159

160 161 162
	/* adjusted_mode: for use by helpers and drivers */
	struct drm_display_mode adjusted_mode;

163 164
	struct drm_display_mode mode;

165 166 167
	/* blob property to expose current mode to atomic userspace */
	struct drm_property_blob *mode_blob;

168 169 170 171 172
	/* blob property to expose color management to userspace */
	struct drm_property_blob *degamma_lut;
	struct drm_property_blob *ctm;
	struct drm_property_blob *gamma_lut;

173 174 175 176
	struct drm_pending_vblank_event *event;

	struct drm_atomic_state *state;
};
D
Dave Airlie 已提交
177 178

/**
179
 * struct drm_crtc_funcs - control CRTCs for a given device
D
Dave Airlie 已提交
180 181 182 183 184 185 186 187 188 189 190
 *
 * 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 {
191 192 193 194 195 196 197 198 199 200
	/**
	 * @reset:
	 *
	 * Reset CRTC hardware and software state to off. This function isn't
	 * called by the core directly, only through drm_mode_config_reset().
	 * It's not a helper hook only for historical reasons.
	 *
	 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
	 * atomic state using this hook.
	 */
201
	void (*reset)(struct drm_crtc *crtc);
D
Dave Airlie 已提交
202

D
Daniel Vetter 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
	/**
	 * @cursor_set:
	 *
	 * Update the cursor image. The cursor position is relative to the CRTC
	 * and can be partially or fully outside of the visible area.
	 *
	 * Note that contrary to all other KMS functions the legacy cursor entry
	 * points don't take a framebuffer object, but instead take directly a
	 * raw buffer object id from the driver's buffer manager (which is
	 * either GEM or TTM for current drivers).
	 *
	 * This entry point is deprecated, drivers should instead implement
	 * universal plane support and register a proper cursor plane using
	 * drm_crtc_init_with_planes().
	 *
	 * This callback is optional
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
D
Dave Airlie 已提交
224 225
	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
			  uint32_t handle, uint32_t width, uint32_t height);
D
Daniel Vetter 已提交
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245

	/**
	 * @cursor_set2:
	 *
	 * Update the cursor image, including hotspot information. The hotspot
	 * must not affect the cursor position in CRTC coordinates, but is only
	 * meant as a hint for virtualized display hardware to coordinate the
	 * guests and hosts cursor position. The cursor hotspot is relative to
	 * the cursor image. Otherwise this works exactly like @cursor_set.
	 *
	 * This entry point is deprecated, drivers should instead implement
	 * universal plane support and register a proper cursor plane using
	 * drm_crtc_init_with_planes().
	 *
	 * This callback is optional.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
246 247 248
	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
Daniel Vetter 已提交
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

	/**
	 * @cursor_move:
	 *
	 * Update the cursor position. The cursor does not need to be visible
	 * when this hook is called.
	 *
	 * This entry point is deprecated, drivers should instead implement
	 * universal plane support and register a proper cursor plane using
	 * drm_crtc_init_with_planes().
	 *
	 * This callback is optional.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
D
Dave Airlie 已提交
266 267
	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);

D
Daniel Vetter 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
	/**
	 * @gamma_set:
	 *
	 * Set gamma on the CRTC.
	 *
	 * This callback is optional.
	 *
	 * NOTE:
	 *
	 * Drivers that support gamma tables and also fbdev emulation through
	 * the provided helper library need to take care to fill out the gamma
	 * hooks for both. Currently there's a bit an unfortunate duplication
	 * going on, which should eventually be unified to just one set of
	 * hooks.
	 */
283 284
	int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
			 uint32_t size);
285 286 287 288 289 290 291 292

	/**
	 * @destroy:
	 *
	 * Clean up plane resources. This is only called at driver unload time
	 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
	 * in DRM.
	 */
D
Dave Airlie 已提交
293 294
	void (*destroy)(struct drm_crtc *crtc);

D
Daniel Vetter 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308
	/**
	 * @set_config:
	 *
	 * This is the main legacy entry point to change the modeset state on a
	 * CRTC. All the details of the desired configuration are passed in a
	 * struct &drm_mode_set - see there for details.
	 *
	 * Drivers implementing atomic modeset should use
	 * drm_atomic_helper_set_config() to implement this hook.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
D
Dave Airlie 已提交
309
	int (*set_config)(struct drm_mode_set *set);
310

D
Daniel Vetter 已提交
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
	/**
	 * @page_flip:
	 *
	 * Legacy entry point to schedule a flip to the given framebuffer.
	 *
	 * Page flipping is a synchronization mechanism that replaces the frame
	 * buffer being scanned out by the CRTC with a new frame buffer during
	 * vertical blanking, avoiding tearing (except when requested otherwise
	 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
	 * requests a page flip the DRM core verifies that the new frame buffer
	 * is large enough to be scanned out by the CRTC in the currently
	 * configured mode and then calls the CRTC ->page_flip() operation with a
	 * pointer to the new frame buffer.
	 *
	 * The driver must wait for any pending rendering to the new framebuffer
	 * to complete before executing the flip. It should also wait for any
	 * pending rendering from other drivers if the underlying buffer is a
	 * shared dma-buf.
	 *
	 * An application can request to be notified when the page flip has
	 * completed. The drm core will supply a struct &drm_event in the event
	 * parameter in this case. This can be handled by the
	 * drm_crtc_send_vblank_event() function, which the driver should call on
	 * the provided event upon completion of the flip. Note that if
	 * the driver supports vblank signalling and timestamping the vblank
	 * counters and timestamps must agree with the ones returned from page
	 * flip events. With the current vblank helper infrastructure this can
	 * be achieved by holding a vblank reference while the page flip is
	 * pending, acquired through drm_crtc_vblank_get() and released with
	 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
	 * counter and timestamp tracking though, e.g. if they have accurate
	 * timestamp registers in hardware.
	 *
	 * This callback is optional.
	 *
	 * NOTE:
	 *
	 * Very early versions of the KMS ABI mandated that the driver must
	 * block (but not reject) any rendering to the old framebuffer until the
	 * flip operation has completed and the old framebuffer is no longer
	 * visible. This requirement has been lifted, and userspace is instead
	 * expected to request delivery of an event and wait with recycling old
	 * buffers until such has been received.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure. Note that if a
	 * ->page_flip() operation is already pending the callback should return
	 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
	 * or just runtime disabled through DPMS respectively the new atomic
361 362
	 * "ACTIVE" state) should result in an -EINVAL error code. Note that
	 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
363 364 365
	 */
	int (*page_flip)(struct drm_crtc *crtc,
			 struct drm_framebuffer *fb,
366 367
			 struct drm_pending_vblank_event *event,
			 uint32_t flags);
P
Paulo Zanoni 已提交
368

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
	/**
	 * @page_flip_target:
	 *
	 * Same as @page_flip but with an additional parameter specifying the
	 * absolute target vertical blank period (as reported by
	 * drm_crtc_vblank_count()) when the flip should take effect.
	 *
	 * Note that the core code calls drm_crtc_vblank_get before this entry
	 * point, and will call drm_crtc_vblank_put if this entry point returns
	 * any non-0 error code. It's the driver's responsibility to call
	 * drm_crtc_vblank_put after this entry point returns 0, typically when
	 * the flip completes.
	 */
	int (*page_flip_target)(struct drm_crtc *crtc,
				struct drm_framebuffer *fb,
				struct drm_pending_vblank_event *event,
				uint32_t flags, uint32_t target);

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
	/**
	 * @set_property:
	 *
	 * This is the legacy entry point to update a property attached to the
	 * CRTC.
	 *
	 * Drivers implementing atomic modeset should use
	 * drm_atomic_helper_crtc_set_property() to implement this hook.
	 *
	 * This callback is optional if the driver does not support any legacy
	 * driver-private properties.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
P
Paulo Zanoni 已提交
403 404
	int (*set_property)(struct drm_crtc *crtc,
			    struct drm_property *property, uint64_t val);
405

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	/**
	 * @atomic_duplicate_state:
	 *
	 * Duplicate the current atomic state for this CRTC and return it.
	 * The core and helpers gurantee that any atomic state duplicated with
	 * this hook and still owned by the caller (i.e. not transferred to the
	 * driver by calling ->atomic_commit() from struct
	 * &drm_mode_config_funcs) will be cleaned up by calling the
	 * @atomic_destroy_state hook in this structure.
	 *
	 * Atomic drivers which don't subclass struct &drm_crtc should use
	 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
	 * state structure to extend it with driver-private state should use
	 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
	 * duplicated in a consistent fashion across drivers.
	 *
	 * It is an error to call this hook before crtc->state has been
	 * initialized correctly.
	 *
	 * NOTE:
	 *
	 * If the duplicate state references refcounted resources this hook must
	 * acquire a reference for each of them. The driver must release these
	 * references again in @atomic_destroy_state.
	 *
	 * RETURNS:
	 *
	 * Duplicated atomic state or NULL when the allocation failed.
	 */
435
	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
436 437 438 439 440 441 442

	/**
	 * @atomic_destroy_state:
	 *
	 * Destroy a state duplicated with @atomic_duplicate_state and release
	 * or unreference all resources it references
	 */
443
	void (*atomic_destroy_state)(struct drm_crtc *crtc,
D
Daniel Vetter 已提交
444
				     struct drm_crtc_state *state);
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487

	/**
	 * @atomic_set_property:
	 *
	 * Decode a driver-private property value and store the decoded value
	 * into the passed-in state structure. Since the atomic core decodes all
	 * standardized properties (even for extensions beyond the core set of
	 * properties which might not be implemented by all drivers) this
	 * requires drivers to subclass the state structure.
	 *
	 * Such driver-private properties should really only be implemented for
	 * truly hardware/vendor specific state. Instead it is preferred to
	 * standardize atomic extension and decode the properties used to expose
	 * such an extension in the core.
	 *
	 * Do not call this function directly, use
	 * drm_atomic_crtc_set_property() instead.
	 *
	 * This callback is optional if the driver does not support any
	 * driver-private atomic properties.
	 *
	 * NOTE:
	 *
	 * This function is called in the state assembly phase of atomic
	 * modesets, which can be aborted for any reason (including on
	 * userspace's request to just check whether a configuration would be
	 * possible). Drivers MUST NOT touch any persistent state (hardware or
	 * software) or data structures except the passed in @state parameter.
	 *
	 * Also since userspace controls in which order properties are set this
	 * function must not do any input validation (since the state update is
	 * incomplete and hence likely inconsistent). Instead any such input
	 * validation must be done in the various atomic_check callbacks.
	 *
	 * RETURNS:
	 *
	 * 0 if the property has been found, -EINVAL if the property isn't
	 * implemented by the driver (which should never happen, the core only
	 * asks for properties attached to this CRTC). No other validation is
	 * allowed by the driver. The core already checks that the property
	 * value is within the range (integer, valid enum value, ...) the driver
	 * set when registering the property.
	 */
488 489 490 491
	int (*atomic_set_property)(struct drm_crtc *crtc,
				   struct drm_crtc_state *state,
				   struct drm_property *property,
				   uint64_t val);
492 493 494 495
	/**
	 * @atomic_get_property:
	 *
	 * Reads out the decoded driver-private property. This is used to
496
	 * implement the GETCRTC IOCTL.
497 498 499 500 501 502 503 504 505 506 507 508 509
	 *
	 * Do not call this function directly, use
	 * drm_atomic_crtc_get_property() instead.
	 *
	 * This callback is optional if the driver does not support any
	 * driver-private atomic properties.
	 *
	 * RETURNS:
	 *
	 * 0 on success, -EINVAL if the property isn't implemented by the
	 * driver (which should never happen, the core only asks for
	 * properties attached to this CRTC).
	 */
R
Rob Clark 已提交
510 511 512 513
	int (*atomic_get_property)(struct drm_crtc *crtc,
				   const struct drm_crtc_state *state,
				   struct drm_property *property,
				   uint64_t *val);
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

	/**
	 * @late_register:
	 *
	 * This optional hook can be used to register additional userspace
	 * interfaces attached to the crtc like debugfs interfaces.
	 * It is called late in the driver load sequence from drm_dev_register().
	 * Everything added from this callback should be unregistered in
	 * the early_unregister callback.
	 *
	 * Returns:
	 *
	 * 0 on success, or a negative error code on failure.
	 */
	int (*late_register)(struct drm_crtc *crtc);

	/**
	 * @early_unregister:
	 *
	 * This optional hook should be used to unregister the additional
	 * userspace interfaces attached to the crtc from
	 * late_unregister(). It is called from drm_dev_unregister(),
	 * early in the driver unload sequence to disable userspace access
	 * before data structures are torndown.
	 */
	void (*early_unregister)(struct drm_crtc *crtc);
D
Dave Airlie 已提交
540 541 542
};

/**
543
 * struct drm_crtc - central CRTC control structure
544
 * @dev: parent DRM device
D
Daniel Vetter 已提交
545
 * @port: OF node used by drm_of_find_possible_crtcs()
546
 * @head: list management
547
 * @name: human readable name, can be overwritten by the driver
548
 * @mutex: per-CRTC locking
549
 * @base: base KMS object for ID tracking etc.
550 551
 * @primary: primary plane for this CRTC
 * @cursor: cursor plane for this CRTC
D
Daniel Vetter 已提交
552 553
 * @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 已提交
554
 * @enabled: is this CRTC enabled?
555 556
 * @mode: current mode timings
 * @hwmode: mode timings as programmed to hw regs
D
Dave Airlie 已提交
557 558 559
 * @x: x position on screen
 * @y: y position on screen
 * @funcs: CRTC control functions
560 561 562
 * @gamma_size: size of gamma ramp
 * @gamma_store: gamma ramp values
 * @helper_private: mid-layer private data
P
Paulo Zanoni 已提交
563
 * @properties: property tracking for this CRTC
D
Dave Airlie 已提交
564 565 566 567 568 569
 *
 * 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;
570
	struct device_node *port;
D
Dave Airlie 已提交
571 572
	struct list_head head;

573 574
	char *name;

575 576
	/**
	 * @mutex:
D
Daniel Vetter 已提交
577 578 579
	 *
	 * This provides a read lock for the overall crtc state (mode, dpms
	 * state, ...) and a write lock for everything which can be update
580 581
	 * without a full modeset (fb, cursor data, crtc properties ...). Full
	 * modeset also need to grab dev->mode_config.connection_mutex.
D
Daniel Vetter 已提交
582
	 */
583
	struct drm_modeset_lock mutex;
D
Daniel Vetter 已提交
584

D
Dave Airlie 已提交
585 586
	struct drm_mode_object base;

587 588 589 590
	/* primary and cursor planes for CRTC */
	struct drm_plane *primary;
	struct drm_plane *cursor;

591 592 593 594
	/**
	 * @index: Position inside the mode_config.list, can be used as an array
	 * index. It is invariant over the lifetime of the CRTC.
	 */
C
Chris Wilson 已提交
595 596
	unsigned index;

597 598 599 600
	/* position of cursor plane on crtc */
	int cursor_x;
	int cursor_y;

D
Dave Airlie 已提交
601 602
	bool enabled;

603
	/* Requested mode from modesetting. */
D
Dave Airlie 已提交
604 605
	struct drm_display_mode mode;

606 607 608 609 610
	/* Programmed mode in hw, after adjustments for encoders,
	 * crtc, panel scaling etc. Needed for timestamping etc.
	 */
	struct drm_display_mode hwmode;

D
Dave Airlie 已提交
611 612 613
	int x, y;
	const struct drm_crtc_funcs *funcs;

614
	/* Legacy FB CRTC gamma size for reporting to userspace */
D
Dave Airlie 已提交
615 616 617 618
	uint32_t gamma_size;
	uint16_t *gamma_store;

	/* if you are using the helper */
619
	const struct drm_crtc_helper_funcs *helper_private;
P
Paulo Zanoni 已提交
620 621

	struct drm_object_properties properties;
622

623 624 625 626 627
	/**
	 * @state:
	 *
	 * Current atomic state for this CRTC.
	 */
628 629
	struct drm_crtc_state *state;

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
	/**
	 * @commit_list:
	 *
	 * List of &drm_crtc_commit structures tracking pending commits.
	 * Protected by @commit_lock. This list doesn't hold its own full
	 * reference, but burrows it from the ongoing commit. Commit entries
	 * must be removed from this list once the commit is fully completed,
	 * but before it's correspoding &drm_atomic_state gets destroyed.
	 */
	struct list_head commit_list;

	/**
	 * @commit_lock:
	 *
	 * Spinlock to protect @commit_list.
	 */
	spinlock_t commit_lock;

	/**
	 * @acquire_ctx:
	 *
	 * Per-CRTC implicit acquire context used by atomic drivers for legacy
	 * IOCTLs, so that atomic drivers can get at the locking acquire
	 * context.
654 655
	 */
	struct drm_modeset_acquire_ctx *acquire_ctx;
D
Dave Airlie 已提交
656 657
};

658 659
/**
 * struct drm_plane_state - mutable plane state
660
 * @plane: backpointer to the plane
661
 * @crtc: currently bound CRTC, NULL if disabled
D
Daniel Vetter 已提交
662
 * @fb: currently bound framebuffer
663
 * @fence: optional fence to wait for before scanning out @fb
664 665 666 667 668 669 670 671 672 673
 * @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)
674
 * @rotation: rotation of the plane
675 676 677
 * @zpos: priority of the given plane on crtc (optional)
 * @normalized_zpos: normalized value of zpos: unique, range from 0 to N-1
 *	where N is the number of active planes for given crtc
678 679 680
 * @src: clipped source coordinates of the plane (in 16.16)
 * @dst: clipped destination coordinates of the plane
 * @visible: visibility of the plane
681 682 683
 * @state: backpointer to global drm_atomic_state
 */
struct drm_plane_state {
684 685
	struct drm_plane *plane;

686 687
	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() */
688
	struct fence *fence;
689 690 691 692 693 694 695 696 697

	/* 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;

698 699 700
	/* Plane rotation */
	unsigned int rotation;

701 702 703 704
	/* Plane zpos */
	unsigned int zpos;
	unsigned int normalized_zpos;

705 706 707 708 709 710 711 712 713
	/* Clipped coordinates */
	struct drm_rect src, dst;

	/*
	 * Is the plane actually visible? Can be false even
	 * if fb!=NULL and crtc!=NULL, due to clipping.
	 */
	bool visible;

714
	struct drm_atomic_state *state;
D
Dave Airlie 已提交
715 716
};

717

J
Jesse Barnes 已提交
718
/**
719
 * struct drm_plane_funcs - driver plane control functions
J
Jesse Barnes 已提交
720 721
 */
struct drm_plane_funcs {
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
	/**
	 * @update_plane:
	 *
	 * This is the legacy entry point to enable and configure the plane for
	 * the given CRTC and framebuffer. It is never called to disable the
	 * plane, i.e. the passed-in crtc and fb paramters are never NULL.
	 *
	 * The source rectangle in frame buffer memory coordinates is given by
	 * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point
	 * values). Devices that don't support subpixel plane coordinates can
	 * ignore the fractional part.
	 *
	 * The destination rectangle in CRTC coordinates is given by the
	 * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values).
	 * Devices scale the source rectangle to the destination rectangle. If
	 * scaling is not supported, and the source rectangle size doesn't match
	 * the destination rectangle size, the driver must return a
	 * -<errorname>EINVAL</errorname> error.
	 *
	 * Drivers implementing atomic modeset should use
	 * drm_atomic_helper_update_plane() to implement this hook.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
J
Jesse Barnes 已提交
748 749 750 751 752 753
	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);
754 755 756 757 758

	/**
	 * @disable_plane:
	 *
	 * This is the legacy entry point to disable the plane. The DRM core
759
	 * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call
760 761 762 763 764 765 766 767 768 769
	 * with the frame buffer ID set to 0.  Disabled planes must not be
	 * processed by the CRTC.
	 *
	 * Drivers implementing atomic modeset should use
	 * drm_atomic_helper_disable_plane() to implement this hook.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
J
Jesse Barnes 已提交
770
	int (*disable_plane)(struct drm_plane *plane);
771 772 773 774 775 776 777 778

	/**
	 * @destroy:
	 *
	 * Clean up plane resources. This is only called at driver unload time
	 * through drm_mode_config_cleanup() since a plane cannot be hotplugged
	 * in DRM.
	 */
J
Jesse Barnes 已提交
779
	void (*destroy)(struct drm_plane *plane);
780 781 782 783 784 785 786 787 788 789 790

	/**
	 * @reset:
	 *
	 * Reset plane hardware and software state to off. This function isn't
	 * called by the core directly, only through drm_mode_config_reset().
	 * It's not a helper hook only for historical reasons.
	 *
	 * Atomic drivers can use drm_atomic_helper_plane_reset() to reset
	 * atomic state using this hook.
	 */
D
Daniel Vetter 已提交
791
	void (*reset)(struct drm_plane *plane);
R
Rob Clark 已提交
792

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
	/**
	 * @set_property:
	 *
	 * This is the legacy entry point to update a property attached to the
	 * plane.
	 *
	 * Drivers implementing atomic modeset should use
	 * drm_atomic_helper_plane_set_property() to implement this hook.
	 *
	 * This callback is optional if the driver does not support any legacy
	 * driver-private properties.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
R
Rob Clark 已提交
809 810
	int (*set_property)(struct drm_plane *plane,
			    struct drm_property *property, uint64_t val);
811

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
	/**
	 * @atomic_duplicate_state:
	 *
	 * Duplicate the current atomic state for this plane and return it.
	 * The core and helpers gurantee that any atomic state duplicated with
	 * this hook and still owned by the caller (i.e. not transferred to the
	 * driver by calling ->atomic_commit() from struct
	 * &drm_mode_config_funcs) will be cleaned up by calling the
	 * @atomic_destroy_state hook in this structure.
	 *
	 * Atomic drivers which don't subclass struct &drm_plane_state should use
	 * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the
	 * state structure to extend it with driver-private state should use
	 * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is
	 * duplicated in a consistent fashion across drivers.
	 *
	 * It is an error to call this hook before plane->state has been
	 * initialized correctly.
	 *
	 * NOTE:
	 *
	 * If the duplicate state references refcounted resources this hook must
	 * acquire a reference for each of them. The driver must release these
	 * references again in @atomic_destroy_state.
	 *
	 * RETURNS:
	 *
	 * Duplicated atomic state or NULL when the allocation failed.
	 */
841
	struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane);
842 843 844 845 846 847 848

	/**
	 * @atomic_destroy_state:
	 *
	 * Destroy a state duplicated with @atomic_duplicate_state and release
	 * or unreference all resources it references
	 */
849
	void (*atomic_destroy_state)(struct drm_plane *plane,
D
Daniel Vetter 已提交
850
				     struct drm_plane_state *state);
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893

	/**
	 * @atomic_set_property:
	 *
	 * Decode a driver-private property value and store the decoded value
	 * into the passed-in state structure. Since the atomic core decodes all
	 * standardized properties (even for extensions beyond the core set of
	 * properties which might not be implemented by all drivers) this
	 * requires drivers to subclass the state structure.
	 *
	 * Such driver-private properties should really only be implemented for
	 * truly hardware/vendor specific state. Instead it is preferred to
	 * standardize atomic extension and decode the properties used to expose
	 * such an extension in the core.
	 *
	 * Do not call this function directly, use
	 * drm_atomic_plane_set_property() instead.
	 *
	 * This callback is optional if the driver does not support any
	 * driver-private atomic properties.
	 *
	 * NOTE:
	 *
	 * This function is called in the state assembly phase of atomic
	 * modesets, which can be aborted for any reason (including on
	 * userspace's request to just check whether a configuration would be
	 * possible). Drivers MUST NOT touch any persistent state (hardware or
	 * software) or data structures except the passed in @state parameter.
	 *
	 * Also since userspace controls in which order properties are set this
	 * function must not do any input validation (since the state update is
	 * incomplete and hence likely inconsistent). Instead any such input
	 * validation must be done in the various atomic_check callbacks.
	 *
	 * RETURNS:
	 *
	 * 0 if the property has been found, -EINVAL if the property isn't
	 * implemented by the driver (which shouldn't ever happen, the core only
	 * asks for properties attached to this plane). No other validation is
	 * allowed by the driver. The core already checks that the property
	 * value is within the range (integer, valid enum value, ...) the driver
	 * set when registering the property.
	 */
894 895 896 897
	int (*atomic_set_property)(struct drm_plane *plane,
				   struct drm_plane_state *state,
				   struct drm_property *property,
				   uint64_t val);
898 899 900 901 902

	/**
	 * @atomic_get_property:
	 *
	 * Reads out the decoded driver-private property. This is used to
903
	 * implement the GETPLANE IOCTL.
904 905 906 907 908 909 910 911 912 913 914 915 916
	 *
	 * Do not call this function directly, use
	 * drm_atomic_plane_get_property() instead.
	 *
	 * This callback is optional if the driver does not support any
	 * driver-private atomic properties.
	 *
	 * RETURNS:
	 *
	 * 0 on success, -EINVAL if the property isn't implemented by the
	 * driver (which should never happen, the core only asks for
	 * properties attached to this plane).
	 */
R
Rob Clark 已提交
917 918 919 920
	int (*atomic_get_property)(struct drm_plane *plane,
				   const struct drm_plane_state *state,
				   struct drm_property *property,
				   uint64_t *val);
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
	/**
	 * @late_register:
	 *
	 * This optional hook can be used to register additional userspace
	 * interfaces attached to the plane like debugfs interfaces.
	 * It is called late in the driver load sequence from drm_dev_register().
	 * Everything added from this callback should be unregistered in
	 * the early_unregister callback.
	 *
	 * Returns:
	 *
	 * 0 on success, or a negative error code on failure.
	 */
	int (*late_register)(struct drm_plane *plane);

	/**
	 * @early_unregister:
	 *
	 * This optional hook should be used to unregister the additional
	 * userspace interfaces attached to the plane from
	 * late_unregister(). It is called from drm_dev_unregister(),
	 * early in the driver unload sequence to disable userspace access
	 * before data structures are torndown.
	 */
	void (*early_unregister)(struct drm_plane *plane);
J
Jesse Barnes 已提交
946 947
};

948 949 950 951 952 953
enum drm_plane_type {
	DRM_PLANE_TYPE_OVERLAY,
	DRM_PLANE_TYPE_PRIMARY,
	DRM_PLANE_TYPE_CURSOR,
};

954

J
Jesse Barnes 已提交
955
/**
956
 * struct drm_plane - central DRM plane control structure
J
Jesse Barnes 已提交
957 958
 * @dev: DRM device this plane belongs to
 * @head: for list management
959
 * @name: human readable name, can be overwritten by the driver
J
Jesse Barnes 已提交
960 961 962 963
 * @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
964
 * @format_default: driver hasn't supplied supported formats for the plane
J
Jesse Barnes 已提交
965 966
 * @crtc: currently bound CRTC
 * @fb: currently bound fb
D
Daniel Vetter 已提交
967 968
 * @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 已提交
969
 * @funcs: helper functions
R
Rob Clark 已提交
970
 * @properties: property tracking for this plane
971
 * @type: type of plane (overlay, primary, cursor)
972
 * @state: current atomic state for this plane
973
 * @zpos_property: zpos property for this plane
974
 * @helper_private: mid-layer private data
J
Jesse Barnes 已提交
975 976 977 978 979
 */
struct drm_plane {
	struct drm_device *dev;
	struct list_head head;

980 981
	char *name;

982 983 984 985 986 987 988
	/**
	 * @mutex:
	 *
	 * Protects modeset plane state, together with the mutex of &drm_crtc
	 * this plane is linked to (when active, getting actived or getting
	 * disabled).
	 */
D
Daniel Vetter 已提交
989 990
	struct drm_modeset_lock mutex;

J
Jesse Barnes 已提交
991 992 993 994
	struct drm_mode_object base;

	uint32_t possible_crtcs;
	uint32_t *format_types;
995
	unsigned int format_count;
996
	bool format_default;
J
Jesse Barnes 已提交
997 998 999 1000

	struct drm_crtc *crtc;
	struct drm_framebuffer *fb;

1001 1002
	struct drm_framebuffer *old_fb;

J
Jesse Barnes 已提交
1003
	const struct drm_plane_funcs *funcs;
R
Rob Clark 已提交
1004 1005

	struct drm_object_properties properties;
1006 1007

	enum drm_plane_type type;
1008

1009 1010 1011 1012
	/**
	 * @index: Position inside the mode_config.list, can be used as an array
	 * index. It is invariant over the lifetime of the plane.
	 */
C
Chris Wilson 已提交
1013 1014
	unsigned index;

1015
	const struct drm_plane_helper_funcs *helper_private;
D
Daniel Vetter 已提交
1016

1017
	struct drm_plane_state *state;
1018 1019

	struct drm_property *zpos_property;
J
Jesse Barnes 已提交
1020 1021
};

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
/**
 * struct drm_crtc_commit - track modeset commits on a CRTC
 *
 * This structure is used to track pending modeset changes and atomic commit on
 * a per-CRTC basis. Since updating the list should never block this structure
 * is reference counted to allow waiters to safely wait on an event to complete,
 * without holding any locks.
 *
 * It has 3 different events in total to allow a fine-grained synchronization
 * between outstanding updates::
 *
 *	atomic commit thread			hardware
 *
 * 	write new state into hardware	---->	...
 * 	signal hw_done
 * 						switch to new state on next
 * 	...					v/hblank
 *
 *	wait for buffers to show up		...
 *
 *	...					send completion irq
 *						irq handler signals flip_done
 *	cleanup old buffers
 *
 * 	signal cleanup_done
 *
 * 	wait for flip_done		<----
 * 	clean up atomic state
 *
 * The important bit to know is that cleanup_done is the terminal event, but the
 * ordering between flip_done and hw_done is entirely up to the specific driver
 * and modeset state change.
 *
 * For an implementation of how to use this look at
 * drm_atomic_helper_setup_commit() from the atomic helper library.
 */
struct drm_crtc_commit {
	/**
	 * @crtc:
	 *
	 * DRM CRTC for this commit.
	 */
	struct drm_crtc *crtc;

	/**
	 * @ref:
	 *
	 * Reference count for this structure. Needed to allow blocking on
	 * completions without the risk of the completion disappearing
	 * meanwhile.
	 */
	struct kref ref;

	/**
	 * @flip_done:
	 *
	 * Will be signaled when the hardware has flipped to the new set of
	 * buffers. Signals at the same time as when the drm event for this
	 * commit is sent to userspace, or when an out-fence is singalled. Note
	 * that for most hardware, in most cases this happens after @hw_done is
	 * signalled.
	 */
	struct completion flip_done;

	/**
	 * @hw_done:
	 *
	 * Will be signalled when all hw register changes for this commit have
	 * been written out. Especially when disabling a pipe this can be much
	 * later than than @flip_done, since that can signal already when the
	 * screen goes black, whereas to fully shut down a pipe more register
	 * I/O is required.
	 *
	 * Note that this does not need to include separately reference-counted
	 * resources like backing storage buffer pinning, or runtime pm
	 * management.
	 */
	struct completion hw_done;

	/**
	 * @cleanup_done:
	 *
	 * Will be signalled after old buffers have been cleaned up by calling
	 * drm_atomic_helper_cleanup_planes(). Since this can only happen after
	 * a vblank wait completed it might be a bit later. This completion is
	 * useful to throttle updates and avoid hardware updates getting ahead
	 * of the buffer cleanup too much.
	 */
	struct completion cleanup_done;

	/**
	 * @commit_entry:
	 *
	 * Entry on the per-CRTC commit_list. Protected by crtc->commit_lock.
	 */
	struct list_head commit_entry;

	/**
	 * @event:
	 *
	 * &drm_pending_vblank_event pointer to clean up private events.
	 */
	struct drm_pending_vblank_event *event;
};

1127 1128 1129 1130 1131
struct __drm_planes_state {
	struct drm_plane *ptr;
	struct drm_plane_state *state;
};

1132 1133 1134
struct __drm_crtcs_state {
	struct drm_crtc *ptr;
	struct drm_crtc_state *state;
1135
	struct drm_crtc_commit *commit;
1136 1137
};

1138 1139 1140 1141 1142
struct __drm_connnectors_state {
	struct drm_connector *ptr;
	struct drm_connector_state *state;
};

D
Daniel Vetter 已提交
1143
/**
R
Rob Clark 已提交
1144
 * struct drm_atomic_state - the global state object for atomic updates
D
Daniel Vetter 已提交
1145
 * @dev: parent DRM device
R
Rob Clark 已提交
1146
 * @allow_modeset: allow full modeset
1147
 * @legacy_cursor_update: hint to enforce legacy cursor IOCTL semantics
1148
 * @legacy_set_config: Disable conflicting encoders instead of failing with -EINVAL.
1149
 * @planes: pointer to array of structures with per-plane data
D
Daniel Vetter 已提交
1150
 * @crtcs: pointer to array of CRTC pointers
1151
 * @num_connector: size of the @connectors and @connector_states arrays
1152
 * @connectors: pointer to array of structures with per-connector data
D
Daniel Vetter 已提交
1153 1154 1155 1156
 * @acquire_ctx: acquire context for this atomic modeset state update
 */
struct drm_atomic_state {
	struct drm_device *dev;
R
Rob Clark 已提交
1157
	bool allow_modeset : 1;
1158
	bool legacy_cursor_update : 1;
1159
	bool legacy_set_config : 1;
1160
	struct __drm_planes_state *planes;
1161
	struct __drm_crtcs_state *crtcs;
1162
	int num_connector;
1163
	struct __drm_connnectors_state *connectors;
D
Daniel Vetter 已提交
1164 1165

	struct drm_modeset_acquire_ctx *acquire_ctx;
1166 1167 1168 1169 1170 1171 1172 1173

	/**
	 * @commit_work:
	 *
	 * Work item which can be used by the driver or helpers to execute the
	 * commit without blocking.
	 */
	struct work_struct commit_work;
D
Daniel Vetter 已提交
1174 1175 1176
};


D
Dave Airlie 已提交
1177
/**
1178
 * struct drm_mode_set - new values for a CRTC config change
1179 1180 1181 1182 1183 1184 1185
 * @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 已提交
1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
 *
 * 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;
};

/**
1205 1206 1207 1208
 * struct drm_mode_config_funcs - basic driver provided mode setting functions
 *
 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
 * involve drivers.
D
Dave Airlie 已提交
1209 1210
 */
struct drm_mode_config_funcs {
1211 1212 1213 1214 1215 1216 1217
	/**
	 * @fb_create:
	 *
	 * Create a new framebuffer object. The core does basic checks on the
	 * requested metadata, but most of that is left to the driver. See
	 * struct &drm_mode_fb_cmd2 for details.
	 *
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
	 * If the parameters are deemed valid and the backing storage objects in
	 * the underlying memory manager all exist, then the driver allocates
	 * a new &drm_framebuffer structure, subclassed to contain
	 * driver-specific information (like the internal native buffer object
	 * references). It also needs to fill out all relevant metadata, which
	 * should be done by calling drm_helper_mode_fill_fb_struct().
	 *
	 * The initialization is finalized by calling drm_framebuffer_init(),
	 * which registers the framebuffer and makes it accessible to other
	 * threads.
	 *
1229 1230 1231 1232 1233
	 * RETURNS:
	 *
	 * A new framebuffer with an initial reference count of 1 or a negative
	 * error code encoded with ERR_PTR().
	 */
1234 1235
	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
					     struct drm_file *file_priv,
1236
					     const struct drm_mode_fb_cmd2 *mode_cmd);
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

	/**
	 * @output_poll_changed:
	 *
	 * Callback used by helpers to inform the driver of output configuration
	 * changes.
	 *
	 * Drivers implementing fbdev emulation with the helpers can call
	 * drm_fb_helper_hotplug_changed from this hook to inform the fbdev
	 * helper of output changes.
	 *
	 * FIXME:
	 *
	 * Except that there's no vtable for device-level helper callbacks
	 * there's no reason this is a core function.
	 */
1253
	void (*output_poll_changed)(struct drm_device *dev);
D
Daniel Vetter 已提交
1254

1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
	/**
	 * @atomic_check:
	 *
	 * This is the only hook to validate an atomic modeset update. This
	 * function must reject any modeset and state changes which the hardware
	 * or driver doesn't support. This includes but is of course not limited
	 * to:
	 *
	 *  - Checking that the modes, framebuffers, scaling and placement
	 *    requirements and so on are within the limits of the hardware.
	 *
	 *  - Checking that any hidden shared resources are not oversubscribed.
	 *    This can be shared PLLs, shared lanes, overall memory bandwidth,
	 *    display fifo space (where shared between planes or maybe even
	 *    CRTCs).
	 *
	 *  - Checking that virtualized resources exported to userspace are not
	 *    oversubscribed. For various reasons it can make sense to expose
	 *    more planes, crtcs or encoders than which are physically there. One
	 *    example is dual-pipe operations (which generally should be hidden
	 *    from userspace if when lockstepped in hardware, exposed otherwise),
	 *    where a plane might need 1 hardware plane (if it's just on one
	 *    pipe), 2 hardware planes (when it spans both pipes) or maybe even
	 *    shared a hardware plane with a 2nd plane (if there's a compatible
	 *    plane requested on the area handled by the other pipe).
	 *
	 *  - Check that any transitional state is possible and that if
	 *    requested, the update can indeed be done in the vblank period
	 *    without temporarily disabling some functions.
	 *
	 *  - Check any other constraints the driver or hardware might have.
	 *
	 *  - This callback also needs to correctly fill out the &drm_crtc_state
	 *    in this update to make sure that drm_atomic_crtc_needs_modeset()
	 *    reflects the nature of the possible update and returns true if and
	 *    only if the update cannot be applied without tearing within one
	 *    vblank on that CRTC. The core uses that information to reject
	 *    updates which require a full modeset (i.e. blanking the screen, or
	 *    at least pausing updates for a substantial amount of time) if
	 *    userspace has disallowed that in its request.
	 *
	 *  - The driver also does not need to repeat basic input validation
	 *    like done for the corresponding legacy entry points. The core does
	 *    that before calling this hook.
	 *
	 * See the documentation of @atomic_commit for an exhaustive list of
	 * error conditions which don't have to be checked at the
	 * ->atomic_check() stage?
	 *
	 * See the documentation for struct &drm_atomic_state for how exactly
	 * an atomic modeset update is described.
	 *
	 * Drivers using the atomic helpers can implement this hook using
	 * drm_atomic_helper_check(), or one of the exported sub-functions of
	 * it.
	 *
	 * RETURNS:
	 *
	 * 0 on success or one of the below negative error codes:
	 *
	 *  - -EINVAL, if any of the above constraints are violated.
	 *
	 *  - -EDEADLK, when returned from an attempt to acquire an additional
	 *    &drm_modeset_lock through drm_modeset_lock().
	 *
	 *  - -ENOMEM, if allocating additional state sub-structures failed due
	 *    to lack of memory.
	 *
	 *  - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
	 *    This can either be due to a pending signal, or because the driver
	 *    needs to completely bail out to recover from an exceptional
	 *    situation like a GPU hang. From a userspace point all errors are
	 *    treated equally.
	 */
D
Daniel Vetter 已提交
1329
	int (*atomic_check)(struct drm_device *dev,
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
			    struct drm_atomic_state *state);

	/**
	 * @atomic_commit:
	 *
	 * This is the only hook to commit an atomic modeset update. The core
	 * guarantees that @atomic_check has been called successfully before
	 * calling this function, and that nothing has been changed in the
	 * interim.
	 *
	 * See the documentation for struct &drm_atomic_state for how exactly
	 * an atomic modeset update is described.
	 *
	 * Drivers using the atomic helpers can implement this hook using
	 * drm_atomic_helper_commit(), or one of the exported sub-functions of
	 * it.
	 *
1347
	 * Nonblocking commits (as indicated with the nonblock parameter) must
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
	 * do any preparatory work which might result in an unsuccessful commit
	 * in the context of this callback. The only exceptions are hardware
	 * errors resulting in -EIO. But even in that case the driver must
	 * ensure that the display pipe is at least running, to avoid
	 * compositors crashing when pageflips don't work. Anything else,
	 * specifically committing the update to the hardware, should be done
	 * without blocking the caller. For updates which do not require a
	 * modeset this must be guaranteed.
	 *
	 * The driver must wait for any pending rendering to the new
	 * framebuffers to complete before executing the flip. It should also
	 * wait for any pending rendering from other drivers if the underlying
1360
	 * buffer is a shared dma-buf. Nonblocking commits must not wait for
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
	 * rendering in the context of this callback.
	 *
	 * An application can request to be notified when the atomic commit has
	 * completed. These events are per-CRTC and can be distinguished by the
	 * CRTC index supplied in &drm_event to userspace.
	 *
	 * The drm core will supply a struct &drm_event in the event
	 * member of each CRTC's &drm_crtc_state structure. This can be handled by the
	 * drm_crtc_send_vblank_event() function, which the driver should call on
	 * the provided event upon completion of the atomic commit. Note that if
	 * the driver supports vblank signalling and timestamping the vblank
	 * counters and timestamps must agree with the ones returned from page
	 * flip events. With the current vblank helper infrastructure this can
	 * be achieved by holding a vblank reference while the page flip is
	 * pending, acquired through drm_crtc_vblank_get() and released with
	 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
	 * counter and timestamp tracking though, e.g. if they have accurate
	 * timestamp registers in hardware.
	 *
	 * NOTE:
	 *
	 * Drivers are not allowed to shut down any display pipe successfully
	 * enabled through an atomic commit on their own. Doing so can result in
	 * compositors crashing if a page flip is suddenly rejected because the
	 * pipe is off.
	 *
	 * RETURNS:
	 *
	 * 0 on success or one of the below negative error codes:
	 *
1391
	 *  - -EBUSY, if a nonblocking updated is requested and there is
1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
	 *    an earlier updated pending. Drivers are allowed to support a queue
	 *    of outstanding updates, but currently no driver supports that.
	 *    Note that drivers must wait for preceding updates to complete if a
	 *    synchronous update is requested, they are not allowed to fail the
	 *    commit in that case.
	 *
	 *  - -ENOMEM, if the driver failed to allocate memory. Specifically
	 *    this can happen when trying to pin framebuffers, which must only
	 *    be done when committing the state.
	 *
	 *  - -ENOSPC, as a refinement of the more generic -ENOMEM to indicate
	 *    that the driver has run out of vram, iommu space or similar GPU
	 *    address space needed for framebuffer.
	 *
	 *  - -EIO, if the hardware completely died.
	 *
	 *  - -EINTR, -EAGAIN or -ERESTARTSYS, if the IOCTL should be restarted.
	 *    This can either be due to a pending signal, or because the driver
	 *    needs to completely bail out to recover from an exceptional
	 *    situation like a GPU hang. From a userspace point of view all errors are
	 *    treated equally.
	 *
	 * This list is exhaustive. Specifically this hook is not allowed to
	 * return -EINVAL (any invalid requests should be caught in
	 * @atomic_check) or -EDEADLK (this function must not acquire
	 * additional modeset locks).
	 */
D
Daniel Vetter 已提交
1419
	int (*atomic_commit)(struct drm_device *dev,
1420
			     struct drm_atomic_state *state,
1421
			     bool nonblock);
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434

	/**
	 * @atomic_state_alloc:
	 *
	 * This optional hook can be used by drivers that want to subclass struct
	 * &drm_atomic_state to be able to track their own driver-private global
	 * state easily. If this hook is implemented, drivers must also
	 * implement @atomic_state_clear and @atomic_state_free.
	 *
	 * RETURNS:
	 *
	 * A new &drm_atomic_state on success or NULL on failure.
	 */
1435
	struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452

	/**
	 * @atomic_state_clear:
	 *
	 * This hook must clear any driver private state duplicated into the
	 * passed-in &drm_atomic_state. This hook is called when the caller
	 * encountered a &drm_modeset_lock deadlock and needs to drop all
	 * already acquired locks as part of the deadlock avoidance dance
	 * implemented in drm_modeset_lock_backoff().
	 *
	 * Any duplicated state must be invalidated since a concurrent atomic
	 * update might change it, and the drm atomic interfaces always apply
	 * updates as relative changes to the current state.
	 *
	 * Drivers that implement this must call drm_atomic_state_default_clear()
	 * to clear common state.
	 */
1453
	void (*atomic_state_clear)(struct drm_atomic_state *state);
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464

	/**
	 * @atomic_state_free:
	 *
	 * This hook needs driver private resources and the &drm_atomic_state
	 * itself. Note that the core first calls drm_atomic_state_clear() to
	 * avoid code duplicate between the clear and free hooks.
	 *
	 * Drivers that implement this must call drm_atomic_state_default_free()
	 * to release common resources.
	 */
1465
	void (*atomic_state_free)(struct drm_atomic_state *state);
D
Dave Airlie 已提交
1466 1467 1468
};

/**
D
Daniel Vetter 已提交
1469
 * struct drm_mode_config - Mode configuration control structure
1470
 * @mutex: mutex protecting KMS related lists and structures
D
Daniel Vetter 已提交
1471 1472
 * @connection_mutex: ww mutex protecting connector state and routing
 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1473
 * 	legacy IOCTLs
D
Daniel Vetter 已提交
1474
 * @fb_lock: mutex to protect fb state and lists
1475 1476 1477 1478
 * @num_fb: number of fbs available
 * @fb_list: list of framebuffers available
 * @num_encoder: number of encoders on this device
 * @encoder_list: list of encoder objects
D
Daniel Vetter 已提交
1479 1480 1481
 * @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
1482 1483
 * @num_crtc: number of CRTCs on this device
 * @crtc_list: list of CRTC objects
D
Daniel Vetter 已提交
1484
 * @property_list: list of property objects
1485 1486 1487 1488 1489 1490
 * @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 已提交
1491 1492
 * @poll_enabled: track polling support for this device
 * @poll_running: track polling status for this device
1493
 * @delayed_event: track delayed poll uevent deliver for this device
1494
 * @output_poll_work: delayed work for polling in process context
D
Daniel Vetter 已提交
1495
 * @property_blob_list: list of all the blob property objects
D
Daniel Stone 已提交
1496
 * @blob_lock: mutex for blob property allocation and management
1497
 * @*_property: core property tracking
D
Daniel Vetter 已提交
1498 1499 1500 1501
 * @preferred_depth: preferred RBG pixel depth, used by fb helpers
 * @prefer_shadow: hint to userspace to prefer shadow-fb rendering
 * @cursor_width: hint to userspace for max cursor width
 * @cursor_height: hint to userspace for max cursor height
1502
 * @helper_private: mid-layer private data
D
Dave Airlie 已提交
1503
 *
1504 1505 1506
 * 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 已提交
1507 1508
 */
struct drm_mode_config {
J
Jesse Barnes 已提交
1509
	struct mutex mutex; /* protects configuration (mode lists etc.) */
1510 1511
	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() */
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535

	/**
	 * @idr_mutex:
	 *
	 * Mutex for KMS ID allocation and management. Protects both @crtc_idr
	 * and @tile_idr.
	 */
	struct mutex idr_mutex;

	/**
	 * @crtc_idr:
	 *
	 * Main KMS ID tracking object. Use this idr for all IDs, fb, crtc,
	 * connector, modes - just makes life easier to have only one.
	 */
	struct idr crtc_idr;

	/**
	 * @tile_idr:
	 *
	 * Use this idr for allocating new IDs for tiled sinks like use in some
	 * high-res DP MST screens.
	 */
	struct idr tile_idr;
1536

D
Daniel Vetter 已提交
1537
	struct mutex fb_lock; /* proctects global and per-file fb lists */
D
Dave Airlie 已提交
1538 1539
	int num_fb;
	struct list_head fb_list;
1540

1541 1542 1543
	/**
	 * @num_connector: Number of connectors on this device.
	 */
D
Dave Airlie 已提交
1544
	int num_connector;
1545 1546 1547
	/**
	 * @connector_ida: ID allocator for connector indices.
	 */
1548
	struct ida connector_ida;
1549 1550 1551
	/**
	 * @connector_list: List of connector objects.
	 */
D
Dave Airlie 已提交
1552 1553 1554
	struct list_head connector_list;
	int num_encoder;
	struct list_head encoder_list;
1555 1556 1557 1558 1559 1560 1561 1562 1563

	/*
	 * 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 已提交
1564
	struct list_head plane_list;
D
Dave Airlie 已提交
1565 1566 1567 1568 1569 1570 1571 1572

	int num_crtc;
	struct list_head crtc_list;

	struct list_head property_list;

	int min_width, min_height;
	int max_width, max_height;
1573
	const struct drm_mode_config_funcs *funcs;
1574
	resource_size_t fb_base;
D
Dave Airlie 已提交
1575

1576 1577
	/* output poll support */
	bool poll_enabled;
1578
	bool poll_running;
1579
	bool delayed_event;
1580
	struct delayed_work output_poll_work;
1581

D
Daniel Stone 已提交
1582 1583
	struct mutex blob_lock;

D
Dave Airlie 已提交
1584 1585
	/* pointers to standard properties */
	struct list_head property_blob_list;
1586 1587 1588 1589
	/**
	 * @edid_property: Default connector property to hold the EDID of the
	 * currently connected sink, if any.
	 */
D
Dave Airlie 已提交
1590
	struct drm_property *edid_property;
1591 1592 1593 1594
	/**
	 * @dpms_property: Default connector property to control the
	 * connector's DPMS state.
	 */
D
Dave Airlie 已提交
1595
	struct drm_property *dpms_property;
1596 1597 1598 1599
	/**
	 * @path_property: Default connector property to hold the DP MST path
	 * for the port.
	 */
D
Dave Airlie 已提交
1600
	struct drm_property *path_property;
1601 1602 1603 1604 1605
	/**
	 * @tile_property: Default connector property to store the tile
	 * position of a tiled screen, for sinks which need to be driven with
	 * multiple CRTCs.
	 */
1606
	struct drm_property *tile_property;
1607 1608 1609 1610
	/**
	 * @plane_type_property: Default plane property to differentiate
	 * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
	 */
R
Rob Clark 已提交
1611
	struct drm_property *plane_type_property;
1612 1613 1614 1615
	/**
	 * @rotation_property: Optional property for planes or CRTCs to specifiy
	 * rotation.
	 */
1616
	struct drm_property *rotation_property;
1617 1618 1619 1620
	/**
	 * @prop_src_x: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1621
	struct drm_property *prop_src_x;
1622 1623 1624 1625
	/**
	 * @prop_src_y: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1626
	struct drm_property *prop_src_y;
1627 1628 1629 1630
	/**
	 * @prop_src_w: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1631
	struct drm_property *prop_src_w;
1632 1633 1634 1635
	/**
	 * @prop_src_h: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1636
	struct drm_property *prop_src_h;
1637 1638 1639 1640
	/**
	 * @prop_crtc_x: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1641
	struct drm_property *prop_crtc_x;
1642 1643 1644 1645
	/**
	 * @prop_crtc_y: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1646
	struct drm_property *prop_crtc_y;
1647 1648 1649 1650
	/**
	 * @prop_crtc_w: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1651
	struct drm_property *prop_crtc_w;
1652 1653 1654 1655
	/**
	 * @prop_crtc_h: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1656
	struct drm_property *prop_crtc_h;
1657 1658 1659 1660
	/**
	 * @prop_fb_id: Default atomic plane property to specify the
	 * &drm_framebuffer.
	 */
R
Rob Clark 已提交
1661
	struct drm_property *prop_fb_id;
1662 1663 1664 1665
	/**
	 * @prop_crtc_id: Default atomic plane property to specify the
	 * &drm_crtc.
	 */
R
Rob Clark 已提交
1666
	struct drm_property *prop_crtc_id;
1667 1668 1669 1670 1671
	/**
	 * @prop_active: Default atomic CRTC property to control the active
	 * state, which is the simplified implementation for DPMS in atomic
	 * drivers.
	 */
1672
	struct drm_property *prop_active;
1673 1674 1675 1676 1677
	/**
	 * @prop_mode_id: Default atomic CRTC property to set the mode for a
	 * CRTC. A 0 mode implies that the CRTC is entirely disabled - all
	 * connectors must be of and active must be set to disabled, too.
	 */
D
Daniel Stone 已提交
1678
	struct drm_property *prop_mode_id;
D
Dave Airlie 已提交
1679

1680 1681 1682 1683
	/**
	 * @dvi_i_subconnector_property: Optional DVI-I property to
	 * differentiate between analog or digital mode.
	 */
D
Dave Airlie 已提交
1684
	struct drm_property *dvi_i_subconnector_property;
1685 1686 1687 1688
	/**
	 * @dvi_i_select_subconnector_property: Optional DVI-I property to
	 * select between analog or digital mode.
	 */
D
Dave Airlie 已提交
1689 1690
	struct drm_property *dvi_i_select_subconnector_property;

1691 1692 1693 1694
	/**
	 * @tv_subconnector_property: Optional TV property to differentiate
	 * between different TV connector types.
	 */
D
Dave Airlie 已提交
1695
	struct drm_property *tv_subconnector_property;
1696 1697 1698 1699
	/**
	 * @tv_select_subconnector_property: Optional TV property to select
	 * between different TV connector types.
	 */
D
Dave Airlie 已提交
1700
	struct drm_property *tv_select_subconnector_property;
1701 1702 1703 1704
	/**
	 * @tv_mode_property: Optional TV property to select
	 * the output TV mode.
	 */
D
Dave Airlie 已提交
1705
	struct drm_property *tv_mode_property;
1706 1707 1708 1709
	/**
	 * @tv_left_margin_property: Optional TV property to set the left
	 * margin.
	 */
D
Dave Airlie 已提交
1710
	struct drm_property *tv_left_margin_property;
1711 1712 1713 1714
	/**
	 * @tv_right_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1715
	struct drm_property *tv_right_margin_property;
1716 1717 1718 1719
	/**
	 * @tv_top_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1720
	struct drm_property *tv_top_margin_property;
1721 1722 1723 1724
	/**
	 * @tv_bottom_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1725
	struct drm_property *tv_bottom_margin_property;
1726 1727 1728 1729
	/**
	 * @tv_brightness_property: Optional TV property to set the
	 * brightness.
	 */
1730
	struct drm_property *tv_brightness_property;
1731 1732 1733 1734
	/**
	 * @tv_contrast_property: Optional TV property to set the
	 * contrast.
	 */
1735
	struct drm_property *tv_contrast_property;
1736 1737 1738 1739
	/**
	 * @tv_flicker_reduction_property: Optional TV property to control the
	 * flicker reduction mode.
	 */
1740
	struct drm_property *tv_flicker_reduction_property;
1741 1742 1743 1744
	/**
	 * @tv_overscan_property: Optional TV property to control the overscan
	 * setting.
	 */
1745
	struct drm_property *tv_overscan_property;
1746 1747 1748 1749
	/**
	 * @tv_saturation_property: Optional TV property to set the
	 * saturation.
	 */
1750
	struct drm_property *tv_saturation_property;
1751 1752 1753
	/**
	 * @tv_hue_property: Optional TV property to set the hue.
	 */
1754
	struct drm_property *tv_hue_property;
D
Dave Airlie 已提交
1755

1756 1757 1758 1759
	/**
	 * @scaling_mode_property: Optional connector property to control the
	 * upscaling, mostly used for built-in panels.
	 */
D
Dave Airlie 已提交
1760
	struct drm_property *scaling_mode_property;
1761 1762 1763 1764
	/**
	 * @aspect_ratio_property: Optional connector property to control the
	 * HDMI infoframe aspect ratio setting.
	 */
1765
	struct drm_property *aspect_ratio_property;
1766 1767 1768 1769
	/**
	 * @degamma_lut_property: Optional CRTC property to set the LUT used to
	 * convert the framebuffer's colors to linear gamma.
	 */
1770
	struct drm_property *degamma_lut_property;
1771 1772 1773 1774
	/**
	 * @degamma_lut_size_property: Optional CRTC property for the size of
	 * the degamma LUT as supported by the driver (read-only).
	 */
1775
	struct drm_property *degamma_lut_size_property;
1776 1777 1778 1779 1780
	/**
	 * @ctm_property: Optional CRTC property to set the
	 * matrix used to convert colors after the lookup in the
	 * degamma LUT.
	 */
1781
	struct drm_property *ctm_property;
1782 1783 1784 1785 1786
	/**
	 * @gamma_lut_property: Optional CRTC property to set the LUT used to
	 * convert the colors, after the CTM matrix, to the gamma space of the
	 * connected screen.
	 */
1787
	struct drm_property *gamma_lut_property;
1788 1789 1790 1791
	/**
	 * @gamma_lut_size_property: Optional CRTC property for the size of the
	 * gamma LUT as supported by the driver (read-only).
	 */
1792 1793
	struct drm_property *gamma_lut_size_property;

1794 1795 1796 1797
	/**
	 * @suggested_x_property: Optional connector property with a hint for
	 * the position of the output on the host's screen.
	 */
1798
	struct drm_property *suggested_x_property;
1799 1800 1801 1802
	/**
	 * @suggested_y_property: Optional connector property with a hint for
	 * the position of the output on the host's screen.
	 */
1803 1804
	struct drm_property *suggested_y_property;

1805 1806
	/* dumb ioctl parameters */
	uint32_t preferred_depth, prefer_shadow;
1807

1808 1809 1810 1811
	/**
	 * @async_page_flip: Does this device support async flips on the primary
	 * plane?
	 */
1812
	bool async_page_flip;
A
Alex Deucher 已提交
1813

1814 1815 1816 1817 1818
	/**
	 * @allow_fb_modifiers:
	 *
	 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
	 */
1819 1820
	bool allow_fb_modifiers;

A
Alex Deucher 已提交
1821 1822
	/* cursor size */
	uint32_t cursor_width, cursor_height;
1823 1824

	struct drm_mode_config_helper_funcs *helper_private;
D
Dave Airlie 已提交
1825 1826
};

R
Rob Clark 已提交
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
/**
 * 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) \
1837
		for_each_if ((plane_mask) & (1 << drm_plane_index(plane)))
R
Rob Clark 已提交
1838

D
Dave Airlie 已提交
1839
#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
J
Jesse Barnes 已提交
1840
#define obj_to_plane(x) container_of(x, struct drm_plane, base)
D
Dave Airlie 已提交
1841

1842 1843 1844 1845 1846 1847 1848
extern __printf(6, 7)
int drm_crtc_init_with_planes(struct drm_device *dev,
			      struct drm_crtc *crtc,
			      struct drm_plane *primary,
			      struct drm_plane *cursor,
			      const struct drm_crtc_funcs *funcs,
			      const char *name, ...);
D
Dave Airlie 已提交
1849
extern void drm_crtc_cleanup(struct drm_crtc *crtc);
C
Chris Wilson 已提交
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861

/**
 * drm_crtc_index - find the index of a registered CRTC
 * @crtc: CRTC to find index for
 *
 * Given a registered CRTC, return the index of that CRTC within a DRM
 * device's list of CRTCs.
 */
static inline unsigned int drm_crtc_index(struct drm_crtc *crtc)
{
	return crtc->index;
}
1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873

/**
 * 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 已提交
1874

1875 1876 1877 1878 1879 1880 1881 1882 1883
extern __printf(8, 9)
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,
			     unsigned int format_count,
			     enum drm_plane_type type,
			     const char *name, ...);
J
Jesse Barnes 已提交
1884 1885 1886 1887
extern int drm_plane_init(struct drm_device *dev,
			  struct drm_plane *plane,
			  unsigned long possible_crtcs,
			  const struct drm_plane_funcs *funcs,
1888
			  const uint32_t *formats, unsigned int format_count,
M
Matt Roper 已提交
1889
			  bool is_primary);
J
Jesse Barnes 已提交
1890
extern void drm_plane_cleanup(struct drm_plane *plane);
C
Chris Wilson 已提交
1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902

/**
 * drm_plane_index - find the index of a registered plane
 * @plane: plane to find index for
 *
 * Given a registered plane, return the index of that plane within a DRM
 * device's list of planes.
 */
static inline unsigned int drm_plane_index(struct drm_plane *plane)
{
	return plane->index;
}
1903
extern struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx);
1904
extern void drm_plane_force_disable(struct drm_plane *plane);
1905 1906
extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
				   int *hdisplay, int *vdisplay);
1907 1908
extern int drm_crtc_force_disable(struct drm_crtc *crtc);
extern int drm_crtc_force_disable_all(struct drm_device *dev);
J
Jesse Barnes 已提交
1909

D
Dave Airlie 已提交
1910
extern void drm_mode_config_init(struct drm_device *dev);
1911
extern void drm_mode_config_reset(struct drm_device *dev);
D
Dave Airlie 已提交
1912
extern void drm_mode_config_cleanup(struct drm_device *dev);
1913

1914
extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
D
Dave Airlie 已提交
1915
					 int gamma_size);
R
Rob Clark 已提交
1916

1917
extern int drm_mode_set_config_internal(struct drm_mode_set *set);
D
Daniel Vetter 已提交
1918

D
Dave Airlie 已提交
1919 1920 1921 1922 1923 1924
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);
1925

1926 1927 1928
extern int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
				       struct drm_property *property,
				       uint64_t value);
1929

1930 1931
extern struct drm_property *drm_mode_create_rotation_property(struct drm_device *dev,
							      unsigned int supported_rotations);
1932 1933
extern unsigned int drm_rotation_simplify(unsigned int rotation,
					  unsigned int supported_rotations);
1934 1935 1936 1937
extern void drm_crtc_enable_color_mgmt(struct drm_crtc *crtc,
				       uint degamma_lut_size,
				       bool has_ctm,
				       uint gamma_lut_size);
1938 1939 1940 1941 1942 1943 1944 1945

int drm_plane_create_zpos_property(struct drm_plane *plane,
				   unsigned int zpos,
				   unsigned int min, unsigned int max);

int drm_plane_create_zpos_immutable_property(struct drm_plane *plane,
					     unsigned int zpos);

R
Russell King 已提交
1946
/* Helpers */
R
Rob Clark 已提交
1947 1948 1949 1950 1951 1952 1953 1954
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 已提交
1955 1956 1957 1958 1959 1960 1961 1962
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;
}

1963 1964 1965 1966 1967 1968 1969
/*
 * Extract a degamma/gamma LUT value provided by user and round it to the
 * precision supported by the hardware.
 */
static inline uint32_t drm_color_lut_extract(uint32_t user_input,
					     uint32_t bit_precision)
{
1970
	uint32_t val = user_input;
1971 1972
	uint32_t max = 0xffff >> (16 - bit_precision);

1973 1974 1975 1976 1977
	/* Round only if we're not using full precision. */
	if (bit_precision < 16) {
		val += 1UL << (16 - bit_precision - 1);
		val >>= 16 - bit_precision;
	}
1978 1979 1980 1981

	return clamp_val(val, 0, max);
}

1982
/* Plane list iterator for legacy (overlay only) planes. */
1983 1984
#define drm_for_each_legacy_plane(plane, dev) \
	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \
1985
		for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1986

1987 1988 1989 1990 1991 1992
#define drm_for_each_plane(plane, dev) \
	list_for_each_entry(plane, &(dev)->mode_config.plane_list, head)

#define drm_for_each_crtc(crtc, dev) \
	list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)

1993 1994 1995
static inline void
assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
{
1996 1997 1998 1999 2000 2001 2002 2003 2004
	/*
	 * The connector hotadd/remove code currently grabs both locks when
	 * updating lists. Hence readers need only hold either of them to be
	 * safe and the check amounts to
	 *
	 * WARN_ON(not_holding(A) && not_holding(B)).
	 */
	WARN_ON(!mutex_is_locked(&mode_config->mutex) &&
		!drm_modeset_is_locked(&mode_config->connection_mutex));
2005 2006
}

D
Daniel Vetter 已提交
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
/* drm_edid.c */
bool drm_probe_ddc(struct i2c_adapter *adapter);
struct edid *drm_get_edid(struct drm_connector *connector,
			  struct i2c_adapter *adapter);
struct edid *drm_get_edid_switcheroo(struct drm_connector *connector,
				     struct i2c_adapter *adapter);
struct edid *drm_edid_duplicate(const struct edid *edid);
int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);

u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
enum hdmi_picture_aspect drm_get_cea_aspect_ratio(const u8 video_code);
bool drm_detect_hdmi_monitor(struct edid *edid);
bool drm_detect_monitor_audio(struct edid *edid);
bool drm_rgb_quant_range_selectable(struct edid *edid);
int drm_add_modes_noedid(struct drm_connector *connector,
			 int hdisplay, int vdisplay);
void drm_set_preferred_mode(struct drm_connector *connector,
			    int hpref, int vpref);

int drm_edid_header_is_valid(const u8 *raw_edid);
bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid,
			  bool *edid_corrupt);
bool drm_edid_is_valid(struct edid *edid);
void drm_edid_get_monitor_name(struct edid *edid, char *name,
			       int buflen);
struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
					   int hsize, int vsize, int fresh,
					   bool rb);

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