drm_crtc.h 49.3 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
#include <drm/drm_edid.h>
D
Daniel Vetter 已提交
47
#include <drm/drm_plane.h>
48
#include <drm/drm_blend.h>
D
Daniel Vetter 已提交
49
#include <drm/drm_color_mgmt.h>
50
#include <drm/drm_debugfs_crc.h>
51

D
Dave Airlie 已提交
52 53
struct drm_device;
struct drm_mode_set;
54 55
struct drm_file;
struct drm_clip_rect;
56
struct device_node;
57
struct dma_fence;
D
Daniel Vetter 已提交
58
struct edid;
D
Dave Airlie 已提交
59

R
Rob Clark 已提交
60 61 62 63 64 65 66 67 68
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);
}

D
Dave Airlie 已提交
69 70 71 72 73 74 75 76
/* 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 已提交
77 78
struct drm_crtc;
struct drm_encoder;
79
struct drm_pending_vblank_event;
J
Jesse Barnes 已提交
80
struct drm_plane;
S
Sean Paul 已提交
81
struct drm_bridge;
82 83
struct drm_atomic_state;

84 85 86 87
struct drm_crtc_helper_funcs;
struct drm_encoder_helper_funcs;
struct drm_plane_helper_funcs;

88
/**
D
Daniel Vetter 已提交
89
 * struct drm_crtc_state - mutable CRTC state
90
 * @crtc: backpointer to the CRTC
91
 * @enable: whether the CRTC should be enabled, gates all other state
92
 * @active: whether the CRTC is actively displaying (used for DPMS)
93 94 95 96
 * @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
97
 * @zpos_changed: zpos values of planes on this crtc have been updated
98 99
 * @color_mgmt_changed: color management properties have changed (degamma or
 *	gamma LUT or CSC matrix)
100
 * @plane_mask: bitmask of (1 << drm_plane_index(plane)) of attached planes
101
 * @connector_mask: bitmask of (1 << drm_connector_index(connector)) of attached connectors
102
 * @encoder_mask: bitmask of (1 << drm_encoder_index(encoder)) of attached encoders
103 104
 * @last_vblank_count: for helpers and drivers to capture the vblank of the
 * 	update to ensure framebuffer cleanup isn't done too early
105
 * @adjusted_mode: for use by helpers and drivers to compute adjusted mode timings
106
 * @mode: current mode timings
107
 * @mode_blob: &drm_property_blob for @mode
108 109 110 111 112
 * @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
113
 * @state: backpointer to global drm_atomic_state
114 115 116 117 118 119
 *
 * 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.
120 121 122 123 124
 *
 * The three booleans active_changed, connectors_changed and mode_changed are
 * intended to indicate whether a full modeset is needed, rather than strictly
 * describing what has changed in a commit.
 * See also: drm_atomic_crtc_needs_modeset()
125 126
 */
struct drm_crtc_state {
127 128
	struct drm_crtc *crtc;

D
Daniel Vetter 已提交
129
	bool enable;
130
	bool active;
131

D
Daniel Vetter 已提交
132 133
	/* computed state bits used by helpers and drivers */
	bool planes_changed : 1;
134
	bool mode_changed : 1;
135
	bool active_changed : 1;
136
	bool connectors_changed : 1;
137
	bool zpos_changed : 1;
138
	bool color_mgmt_changed : 1;
139

140 141 142 143 144 145 146
	/* 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;

147
	u32 connector_mask;
148
	u32 encoder_mask;
149

150 151
	/* last_vblank_count: for vblank waits before cleanup */
	u32 last_vblank_count;
D
Daniel Vetter 已提交
152

153 154 155
	/* adjusted_mode: for use by helpers and drivers */
	struct drm_display_mode adjusted_mode;

156 157
	struct drm_display_mode mode;

158 159 160
	/* blob property to expose current mode to atomic userspace */
	struct drm_property_blob *mode_blob;

161 162 163 164 165
	/* 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;

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
	/**
	 * @event:
	 *
	 * Optional pointer to a DRM event to signal upon completion of the
	 * state update. The driver must send out the event when the atomic
	 * commit operation completes. There are two cases:
	 *
	 *  - The event is for a CRTC which is being disabled through this
	 *    atomic commit. In that case the event can be send out any time
	 *    after the hardware has stopped scanning out the current
	 *    framebuffers. It should contain the timestamp and counter for the
	 *    last vblank before the display pipeline was shut off.
	 *
	 *  - For a CRTC which is enabled at the end of the commit (even when it
	 *    undergoes an full modeset) the vblank timestamp and counter must
	 *    be for the vblank right before the first frame that scans out the
	 *    new set of buffers. Again the event can only be sent out after the
	 *    hardware has stopped scanning out the old buffers.
	 *
	 *  - Events for disabled CRTCs are not allowed, and drivers can ignore
	 *    that 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 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.
	 *
	 * For hardware which supports some means to synchronize vblank
	 * interrupt delivery with committing display state there's also
	 * drm_crtc_arm_vblank_event(). See the documentation of that function
	 * for a detailed discussion of the constraints it needs to be used
	 * safely.
	 */
206 207 208 209
	struct drm_pending_vblank_event *event;

	struct drm_atomic_state *state;
};
D
Dave Airlie 已提交
210 211

/**
212
 * struct drm_crtc_funcs - control CRTCs for a given device
D
Dave Airlie 已提交
213 214 215 216 217 218 219 220 221 222 223
 *
 * 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 {
224 225 226 227 228 229 230 231 232 233
	/**
	 * @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.
	 */
234
	void (*reset)(struct drm_crtc *crtc);
D
Dave Airlie 已提交
235

D
Daniel Vetter 已提交
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
	/**
	 * @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 已提交
257 258
	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
			  uint32_t handle, uint32_t width, uint32_t height);
D
Daniel Vetter 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

	/**
	 * @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.
	 */
279 280 281
	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 已提交
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

	/**
	 * @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 已提交
299 300
	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);

D
Daniel Vetter 已提交
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
	/**
	 * @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.
	 */
316 317
	int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
			 uint32_t size);
318 319 320 321 322 323 324 325

	/**
	 * @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 已提交
326 327
	void (*destroy)(struct drm_crtc *crtc);

D
Daniel Vetter 已提交
328 329 330 331 332 333 334 335 336 337 338 339 340 341
	/**
	 * @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 已提交
342
	int (*set_config)(struct drm_mode_set *set);
343

D
Daniel Vetter 已提交
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
	/**
	 * @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
394 395
	 * "ACTIVE" state) should result in an -EINVAL error code. Note that
	 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
396 397 398
	 */
	int (*page_flip)(struct drm_crtc *crtc,
			 struct drm_framebuffer *fb,
399 400
			 struct drm_pending_vblank_event *event,
			 uint32_t flags);
P
Paulo Zanoni 已提交
401

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
	/**
	 * @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);

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
	/**
	 * @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 已提交
436 437
	int (*set_property)(struct drm_crtc *crtc,
			    struct drm_property *property, uint64_t val);
438

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
	/**
	 * @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.
	 */
468
	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
469 470 471 472 473 474 475

	/**
	 * @atomic_destroy_state:
	 *
	 * Destroy a state duplicated with @atomic_duplicate_state and release
	 * or unreference all resources it references
	 */
476
	void (*atomic_destroy_state)(struct drm_crtc *crtc,
D
Daniel Vetter 已提交
477
				     struct drm_crtc_state *state);
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520

	/**
	 * @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.
	 */
521 522 523 524
	int (*atomic_set_property)(struct drm_crtc *crtc,
				   struct drm_crtc_state *state,
				   struct drm_property *property,
				   uint64_t val);
525 526 527 528
	/**
	 * @atomic_get_property:
	 *
	 * Reads out the decoded driver-private property. This is used to
529
	 * implement the GETCRTC IOCTL.
530 531 532 533 534 535 536 537 538 539 540 541 542
	 *
	 * 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 已提交
543 544 545 546
	int (*atomic_get_property)(struct drm_crtc *crtc,
				   const struct drm_crtc_state *state,
				   struct drm_property *property,
				   uint64_t *val);
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572

	/**
	 * @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);
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596

	/**
	 * @set_crc_source:
	 *
	 * Changes the source of CRC checksums of frames at the request of
	 * userspace, typically for testing purposes. The sources available are
	 * specific of each driver and a %NULL value indicates that CRC
	 * generation is to be switched off.
	 *
	 * When CRC generation is enabled, the driver should call
	 * drm_crtc_add_crc_entry() at each frame, providing any information
	 * that characterizes the frame contents in the crcN arguments, as
	 * provided from the configured source. Drivers must accept a "auto"
	 * source name that will select a default source for this CRTC.
	 *
	 * This callback is optional if the driver does not support any CRC
	 * generation functionality.
	 *
	 * RETURNS:
	 *
	 * 0 on success or a negative error code on failure.
	 */
	int (*set_crc_source)(struct drm_crtc *crtc, const char *source,
			      size_t *values_cnt);
D
Dave Airlie 已提交
597 598 599
};

/**
600
 * struct drm_crtc - central CRTC control structure
601
 * @dev: parent DRM device
D
Daniel Vetter 已提交
602
 * @port: OF node used by drm_of_find_possible_crtcs()
603
 * @head: list management
604
 * @name: human readable name, can be overwritten by the driver
605
 * @mutex: per-CRTC locking
606
 * @base: base KMS object for ID tracking etc.
607 608
 * @primary: primary plane for this CRTC
 * @cursor: cursor plane for this CRTC
D
Daniel Vetter 已提交
609 610
 * @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 已提交
611
 * @enabled: is this CRTC enabled?
612 613
 * @mode: current mode timings
 * @hwmode: mode timings as programmed to hw regs
D
Dave Airlie 已提交
614 615 616
 * @x: x position on screen
 * @y: y position on screen
 * @funcs: CRTC control functions
617 618 619
 * @gamma_size: size of gamma ramp
 * @gamma_store: gamma ramp values
 * @helper_private: mid-layer private data
P
Paulo Zanoni 已提交
620
 * @properties: property tracking for this CRTC
D
Dave Airlie 已提交
621 622 623 624 625 626
 *
 * 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;
627
	struct device_node *port;
D
Dave Airlie 已提交
628 629
	struct list_head head;

630 631
	char *name;

632 633
	/**
	 * @mutex:
D
Daniel Vetter 已提交
634 635 636
	 *
	 * This provides a read lock for the overall crtc state (mode, dpms
	 * state, ...) and a write lock for everything which can be update
637 638
	 * without a full modeset (fb, cursor data, crtc properties ...). Full
	 * modeset also need to grab dev->mode_config.connection_mutex.
D
Daniel Vetter 已提交
639
	 */
640
	struct drm_modeset_lock mutex;
D
Daniel Vetter 已提交
641

D
Dave Airlie 已提交
642 643
	struct drm_mode_object base;

644 645 646 647
	/* primary and cursor planes for CRTC */
	struct drm_plane *primary;
	struct drm_plane *cursor;

648 649 650 651
	/**
	 * @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 已提交
652 653
	unsigned index;

654 655 656 657
	/* position of cursor plane on crtc */
	int cursor_x;
	int cursor_y;

D
Dave Airlie 已提交
658 659
	bool enabled;

660
	/* Requested mode from modesetting. */
D
Dave Airlie 已提交
661 662
	struct drm_display_mode mode;

663 664 665 666 667
	/* Programmed mode in hw, after adjustments for encoders,
	 * crtc, panel scaling etc. Needed for timestamping etc.
	 */
	struct drm_display_mode hwmode;

D
Dave Airlie 已提交
668 669 670
	int x, y;
	const struct drm_crtc_funcs *funcs;

671
	/* Legacy FB CRTC gamma size for reporting to userspace */
D
Dave Airlie 已提交
672 673 674 675
	uint32_t gamma_size;
	uint16_t *gamma_store;

	/* if you are using the helper */
676
	const struct drm_crtc_helper_funcs *helper_private;
P
Paulo Zanoni 已提交
677 678

	struct drm_object_properties properties;
679

680 681 682 683 684
	/**
	 * @state:
	 *
	 * Current atomic state for this CRTC.
	 */
685 686
	struct drm_crtc_state *state;

687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
	/**
	 * @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.
711 712
	 */
	struct drm_modeset_acquire_ctx *acquire_ctx;
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728

#ifdef CONFIG_DEBUG_FS
	/**
	 * @debugfs_entry:
	 *
	 * Debugfs directory for this CRTC.
	 */
	struct dentry *debugfs_entry;

	/**
	 * @crc:
	 *
	 * Configuration settings of CRC capture.
	 */
	struct drm_crtc_crc crc;
#endif
D
Dave Airlie 已提交
729 730 731
};

/**
732
 * struct drm_mode_set - new values for a CRTC config change
733 734 735 736 737 738 739
 * @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 已提交
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
 *
 * 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;
};

/**
759 760 761 762
 * 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 已提交
763 764
 */
struct drm_mode_config_funcs {
765 766 767 768 769 770 771
	/**
	 * @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.
	 *
772 773 774 775 776 777 778 779 780 781 782
	 * 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.
	 *
783 784 785 786 787
	 * RETURNS:
	 *
	 * A new framebuffer with an initial reference count of 1 or a negative
	 * error code encoded with ERR_PTR().
	 */
788 789
	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
					     struct drm_file *file_priv,
790
					     const struct drm_mode_fb_cmd2 *mode_cmd);
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806

	/**
	 * @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.
	 */
807
	void (*output_poll_changed)(struct drm_device *dev);
D
Daniel Vetter 已提交
808

809 810 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 841 842 843 844 845 846 847 848 849 850 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
	/**
	 * @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 已提交
883
	int (*atomic_check)(struct drm_device *dev,
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
			    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.
	 *
901
	 * Nonblocking commits (as indicated with the nonblock parameter) must
902 903 904 905 906 907 908 909 910 911 912 913
	 * 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
914
	 * buffer is a shared dma-buf. Nonblocking commits must not wait for
915 916 917 918 919 920 921
	 * 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
922 923 924
	 * member of each CRTC's &drm_crtc_state structure. See the
	 * documentation for &drm_crtc_state for more details about the precise
	 * semantics of this event.
925 926 927 928 929 930 931 932 933 934 935 936
	 *
	 * 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:
	 *
937
	 *  - -EBUSY, if a nonblocking updated is requested and there is
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
	 *    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 已提交
965
	int (*atomic_commit)(struct drm_device *dev,
966
			     struct drm_atomic_state *state,
967
			     bool nonblock);
968 969 970 971 972 973 974 975 976 977 978 979 980

	/**
	 * @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.
	 */
981
	struct drm_atomic_state *(*atomic_state_alloc)(struct drm_device *dev);
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998

	/**
	 * @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.
	 */
999
	void (*atomic_state_clear)(struct drm_atomic_state *state);
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010

	/**
	 * @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.
	 */
1011
	void (*atomic_state_free)(struct drm_atomic_state *state);
D
Dave Airlie 已提交
1012 1013 1014
};

/**
D
Daniel Vetter 已提交
1015
 * struct drm_mode_config - Mode configuration control structure
1016
 * @mutex: mutex protecting KMS related lists and structures
D
Daniel Vetter 已提交
1017 1018
 * @connection_mutex: ww mutex protecting connector state and routing
 * @acquire_ctx: global implicit acquire context used by atomic drivers for
1019
 * 	legacy IOCTLs
D
Daniel Vetter 已提交
1020
 * @fb_lock: mutex to protect fb state and lists
1021 1022 1023 1024
 * @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 已提交
1025 1026 1027
 * @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
1028 1029
 * @num_crtc: number of CRTCs on this device
 * @crtc_list: list of CRTC objects
D
Daniel Vetter 已提交
1030
 * @property_list: list of property objects
1031 1032 1033 1034 1035 1036
 * @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 已提交
1037 1038
 * @poll_enabled: track polling support for this device
 * @poll_running: track polling status for this device
1039
 * @delayed_event: track delayed poll uevent deliver for this device
1040
 * @output_poll_work: delayed work for polling in process context
D
Daniel Vetter 已提交
1041
 * @property_blob_list: list of all the blob property objects
D
Daniel Stone 已提交
1042
 * @blob_lock: mutex for blob property allocation and management
1043
 * @*_property: core property tracking
D
Daniel Vetter 已提交
1044 1045 1046 1047
 * @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
1048
 * @helper_private: mid-layer private data
D
Dave Airlie 已提交
1049
 *
1050 1051 1052
 * 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 已提交
1053 1054
 */
struct drm_mode_config {
J
Jesse Barnes 已提交
1055
	struct mutex mutex; /* protects configuration (mode lists etc.) */
1056 1057
	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() */
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

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

D
Daniel Vetter 已提交
1083
	struct mutex fb_lock; /* proctects global and per-file fb lists */
D
Dave Airlie 已提交
1084 1085
	int num_fb;
	struct list_head fb_list;
1086

1087 1088 1089
	/**
	 * @num_connector: Number of connectors on this device.
	 */
D
Dave Airlie 已提交
1090
	int num_connector;
1091 1092 1093
	/**
	 * @connector_ida: ID allocator for connector indices.
	 */
1094
	struct ida connector_ida;
1095 1096 1097
	/**
	 * @connector_list: List of connector objects.
	 */
D
Dave Airlie 已提交
1098 1099 1100
	struct list_head connector_list;
	int num_encoder;
	struct list_head encoder_list;
1101 1102 1103 1104 1105 1106 1107 1108 1109

	/*
	 * 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 已提交
1110
	struct list_head plane_list;
D
Dave Airlie 已提交
1111 1112 1113 1114 1115 1116 1117 1118

	int num_crtc;
	struct list_head crtc_list;

	struct list_head property_list;

	int min_width, min_height;
	int max_width, max_height;
1119
	const struct drm_mode_config_funcs *funcs;
1120
	resource_size_t fb_base;
D
Dave Airlie 已提交
1121

1122 1123
	/* output poll support */
	bool poll_enabled;
1124
	bool poll_running;
1125
	bool delayed_event;
1126
	struct delayed_work output_poll_work;
1127

D
Daniel Stone 已提交
1128 1129
	struct mutex blob_lock;

D
Dave Airlie 已提交
1130 1131
	/* pointers to standard properties */
	struct list_head property_blob_list;
1132 1133 1134 1135
	/**
	 * @edid_property: Default connector property to hold the EDID of the
	 * currently connected sink, if any.
	 */
D
Dave Airlie 已提交
1136
	struct drm_property *edid_property;
1137 1138 1139 1140
	/**
	 * @dpms_property: Default connector property to control the
	 * connector's DPMS state.
	 */
D
Dave Airlie 已提交
1141
	struct drm_property *dpms_property;
1142 1143 1144 1145
	/**
	 * @path_property: Default connector property to hold the DP MST path
	 * for the port.
	 */
D
Dave Airlie 已提交
1146
	struct drm_property *path_property;
1147 1148 1149 1150 1151
	/**
	 * @tile_property: Default connector property to store the tile
	 * position of a tiled screen, for sinks which need to be driven with
	 * multiple CRTCs.
	 */
1152
	struct drm_property *tile_property;
1153 1154 1155 1156
	/**
	 * @plane_type_property: Default plane property to differentiate
	 * CURSOR, PRIMARY and OVERLAY legacy uses of planes.
	 */
R
Rob Clark 已提交
1157
	struct drm_property *plane_type_property;
1158 1159 1160 1161
	/**
	 * @prop_src_x: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1162
	struct drm_property *prop_src_x;
1163 1164 1165 1166
	/**
	 * @prop_src_y: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1167
	struct drm_property *prop_src_y;
1168 1169 1170 1171
	/**
	 * @prop_src_w: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1172
	struct drm_property *prop_src_w;
1173 1174 1175 1176
	/**
	 * @prop_src_h: Default atomic plane property for the plane source
	 * position in the connected &drm_framebuffer.
	 */
R
Rob Clark 已提交
1177
	struct drm_property *prop_src_h;
1178 1179 1180 1181
	/**
	 * @prop_crtc_x: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1182
	struct drm_property *prop_crtc_x;
1183 1184 1185 1186
	/**
	 * @prop_crtc_y: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1187
	struct drm_property *prop_crtc_y;
1188 1189 1190 1191
	/**
	 * @prop_crtc_w: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1192
	struct drm_property *prop_crtc_w;
1193 1194 1195 1196
	/**
	 * @prop_crtc_h: Default atomic plane property for the plane destination
	 * position in the &drm_crtc is is being shown on.
	 */
R
Rob Clark 已提交
1197
	struct drm_property *prop_crtc_h;
1198 1199 1200 1201
	/**
	 * @prop_fb_id: Default atomic plane property to specify the
	 * &drm_framebuffer.
	 */
R
Rob Clark 已提交
1202
	struct drm_property *prop_fb_id;
1203 1204 1205 1206
	/**
	 * @prop_crtc_id: Default atomic plane property to specify the
	 * &drm_crtc.
	 */
R
Rob Clark 已提交
1207
	struct drm_property *prop_crtc_id;
1208 1209 1210 1211 1212
	/**
	 * @prop_active: Default atomic CRTC property to control the active
	 * state, which is the simplified implementation for DPMS in atomic
	 * drivers.
	 */
1213
	struct drm_property *prop_active;
1214 1215 1216 1217 1218
	/**
	 * @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 已提交
1219
	struct drm_property *prop_mode_id;
D
Dave Airlie 已提交
1220

1221 1222 1223 1224
	/**
	 * @dvi_i_subconnector_property: Optional DVI-I property to
	 * differentiate between analog or digital mode.
	 */
D
Dave Airlie 已提交
1225
	struct drm_property *dvi_i_subconnector_property;
1226 1227 1228 1229
	/**
	 * @dvi_i_select_subconnector_property: Optional DVI-I property to
	 * select between analog or digital mode.
	 */
D
Dave Airlie 已提交
1230 1231
	struct drm_property *dvi_i_select_subconnector_property;

1232 1233 1234 1235
	/**
	 * @tv_subconnector_property: Optional TV property to differentiate
	 * between different TV connector types.
	 */
D
Dave Airlie 已提交
1236
	struct drm_property *tv_subconnector_property;
1237 1238 1239 1240
	/**
	 * @tv_select_subconnector_property: Optional TV property to select
	 * between different TV connector types.
	 */
D
Dave Airlie 已提交
1241
	struct drm_property *tv_select_subconnector_property;
1242 1243 1244 1245
	/**
	 * @tv_mode_property: Optional TV property to select
	 * the output TV mode.
	 */
D
Dave Airlie 已提交
1246
	struct drm_property *tv_mode_property;
1247 1248 1249 1250
	/**
	 * @tv_left_margin_property: Optional TV property to set the left
	 * margin.
	 */
D
Dave Airlie 已提交
1251
	struct drm_property *tv_left_margin_property;
1252 1253 1254 1255
	/**
	 * @tv_right_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1256
	struct drm_property *tv_right_margin_property;
1257 1258 1259 1260
	/**
	 * @tv_top_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1261
	struct drm_property *tv_top_margin_property;
1262 1263 1264 1265
	/**
	 * @tv_bottom_margin_property: Optional TV property to set the right
	 * margin.
	 */
D
Dave Airlie 已提交
1266
	struct drm_property *tv_bottom_margin_property;
1267 1268 1269 1270
	/**
	 * @tv_brightness_property: Optional TV property to set the
	 * brightness.
	 */
1271
	struct drm_property *tv_brightness_property;
1272 1273 1274 1275
	/**
	 * @tv_contrast_property: Optional TV property to set the
	 * contrast.
	 */
1276
	struct drm_property *tv_contrast_property;
1277 1278 1279 1280
	/**
	 * @tv_flicker_reduction_property: Optional TV property to control the
	 * flicker reduction mode.
	 */
1281
	struct drm_property *tv_flicker_reduction_property;
1282 1283 1284 1285
	/**
	 * @tv_overscan_property: Optional TV property to control the overscan
	 * setting.
	 */
1286
	struct drm_property *tv_overscan_property;
1287 1288 1289 1290
	/**
	 * @tv_saturation_property: Optional TV property to set the
	 * saturation.
	 */
1291
	struct drm_property *tv_saturation_property;
1292 1293 1294
	/**
	 * @tv_hue_property: Optional TV property to set the hue.
	 */
1295
	struct drm_property *tv_hue_property;
D
Dave Airlie 已提交
1296

1297 1298 1299 1300
	/**
	 * @scaling_mode_property: Optional connector property to control the
	 * upscaling, mostly used for built-in panels.
	 */
D
Dave Airlie 已提交
1301
	struct drm_property *scaling_mode_property;
1302 1303 1304 1305
	/**
	 * @aspect_ratio_property: Optional connector property to control the
	 * HDMI infoframe aspect ratio setting.
	 */
1306
	struct drm_property *aspect_ratio_property;
1307 1308 1309 1310
	/**
	 * @degamma_lut_property: Optional CRTC property to set the LUT used to
	 * convert the framebuffer's colors to linear gamma.
	 */
1311
	struct drm_property *degamma_lut_property;
1312 1313 1314 1315
	/**
	 * @degamma_lut_size_property: Optional CRTC property for the size of
	 * the degamma LUT as supported by the driver (read-only).
	 */
1316
	struct drm_property *degamma_lut_size_property;
1317 1318 1319 1320 1321
	/**
	 * @ctm_property: Optional CRTC property to set the
	 * matrix used to convert colors after the lookup in the
	 * degamma LUT.
	 */
1322
	struct drm_property *ctm_property;
1323 1324 1325 1326 1327
	/**
	 * @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.
	 */
1328
	struct drm_property *gamma_lut_property;
1329 1330 1331 1332
	/**
	 * @gamma_lut_size_property: Optional CRTC property for the size of the
	 * gamma LUT as supported by the driver (read-only).
	 */
1333 1334
	struct drm_property *gamma_lut_size_property;

1335 1336 1337 1338
	/**
	 * @suggested_x_property: Optional connector property with a hint for
	 * the position of the output on the host's screen.
	 */
1339
	struct drm_property *suggested_x_property;
1340 1341 1342 1343
	/**
	 * @suggested_y_property: Optional connector property with a hint for
	 * the position of the output on the host's screen.
	 */
1344 1345
	struct drm_property *suggested_y_property;

1346 1347
	/* dumb ioctl parameters */
	uint32_t preferred_depth, prefer_shadow;
1348

1349 1350 1351 1352
	/**
	 * @async_page_flip: Does this device support async flips on the primary
	 * plane?
	 */
1353
	bool async_page_flip;
A
Alex Deucher 已提交
1354

1355 1356 1357 1358 1359
	/**
	 * @allow_fb_modifiers:
	 *
	 * Whether the driver supports fb modifiers in the ADDFB2.1 ioctl call.
	 */
1360 1361
	bool allow_fb_modifiers;

A
Alex Deucher 已提交
1362 1363
	/* cursor size */
	uint32_t cursor_width, cursor_height;
1364 1365

	struct drm_mode_config_helper_funcs *helper_private;
D
Dave Airlie 已提交
1366 1367 1368 1369
};

#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)

1370 1371 1372 1373 1374 1375 1376
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 已提交
1377
extern void drm_crtc_cleanup(struct drm_crtc *crtc);
C
Chris Wilson 已提交
1378 1379 1380 1381 1382 1383 1384 1385

/**
 * 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.
 */
1386
static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc)
C
Chris Wilson 已提交
1387 1388 1389
{
	return crtc->index;
}
1390 1391 1392 1393 1394 1395 1396 1397

/**
 * 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.
 */
1398
static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc)
1399 1400 1401
{
	return 1 << drm_crtc_index(crtc);
}
D
Dave Airlie 已提交
1402

1403 1404
extern void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
				   int *hdisplay, int *vdisplay);
1405 1406
extern int drm_crtc_force_disable(struct drm_crtc *crtc);
extern int drm_crtc_force_disable_all(struct drm_device *dev);
J
Jesse Barnes 已提交
1407

D
Dave Airlie 已提交
1408
extern void drm_mode_config_init(struct drm_device *dev);
1409
extern void drm_mode_config_reset(struct drm_device *dev);
D
Dave Airlie 已提交
1410
extern void drm_mode_config_cleanup(struct drm_device *dev);
1411

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

D
Dave Airlie 已提交
1414 1415 1416 1417 1418 1419
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);
1420

R
Russell King 已提交
1421 1422 1423 1424 1425 1426 1427 1428 1429
/* Helpers */
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;
}

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

1433 1434 1435
static inline void
assert_drm_connector_list_read_locked(struct drm_mode_config *mode_config)
{
1436 1437 1438 1439 1440 1441 1442 1443 1444
	/*
	 * 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));
1445 1446
}

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