Linux Audio

Check our new training course

Loading...
v5.4
   1/*
   2 * Copyright © 2006 Keith Packard
   3 * Copyright © 2007-2008 Dave Airlie
   4 * Copyright © 2007-2008 Intel Corporation
   5 *   Jesse Barnes <jesse.barnes@intel.com>
   6 *
   7 * Permission is hereby granted, free of charge, to any person obtaining a
   8 * copy of this software and associated documentation files (the "Software"),
   9 * to deal in the Software without restriction, including without limitation
  10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 * and/or sell copies of the Software, and to permit persons to whom the
  12 * Software is furnished to do so, subject to the following conditions:
  13 *
  14 * The above copyright notice and this permission notice shall be included in
  15 * all copies or substantial portions of the Software.
  16 *
  17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23 * OTHER DEALINGS IN THE SOFTWARE.
  24 */
  25#ifndef __DRM_CRTC_H__
  26#define __DRM_CRTC_H__
  27
  28#include <linux/i2c.h>
  29#include <linux/spinlock.h>
  30#include <linux/types.h>
 
  31#include <linux/fb.h>
  32#include <linux/hdmi.h>
  33#include <linux/media-bus-format.h>
  34#include <uapi/drm/drm_mode.h>
  35#include <uapi/drm/drm_fourcc.h>
  36#include <drm/drm_modeset_lock.h>
  37#include <drm/drm_rect.h>
  38#include <drm/drm_mode_object.h>
  39#include <drm/drm_framebuffer.h>
  40#include <drm/drm_modes.h>
  41#include <drm/drm_connector.h>
  42#include <drm/drm_device.h>
  43#include <drm/drm_property.h>
  44#include <drm/drm_bridge.h>
  45#include <drm/drm_edid.h>
  46#include <drm/drm_plane.h>
  47#include <drm/drm_blend.h>
  48#include <drm/drm_color_mgmt.h>
  49#include <drm/drm_debugfs_crc.h>
  50#include <drm/drm_mode_config.h>
  51
  52struct drm_device;
  53struct drm_mode_set;
 
 
  54struct drm_file;
  55struct drm_clip_rect;
  56struct drm_printer;
  57struct drm_self_refresh_data;
  58struct device_node;
  59struct dma_fence;
  60struct edid;
  61
  62static inline int64_t U642I64(uint64_t val)
  63{
  64	return (int64_t)*((int64_t *)&val);
  65}
  66static inline uint64_t I642U64(int64_t val)
  67{
  68	return (uint64_t)*((uint64_t *)&val);
  69}
  70
  71struct drm_crtc;
  72struct drm_pending_vblank_event;
  73struct drm_plane;
  74struct drm_bridge;
  75struct drm_atomic_state;
  76
  77struct drm_crtc_helper_funcs;
  78struct drm_plane_helper_funcs;
  79
  80/**
  81 * struct drm_crtc_state - mutable CRTC state
  82 *
  83 * Note that the distinction between @enable and @active is rather subtle:
  84 * Flipping @active while @enable is set without changing anything else may
  85 * never return in a failure from the &drm_mode_config_funcs.atomic_check
  86 * callback. Userspace assumes that a DPMS On will always succeed. In other
  87 * words: @enable controls resource assignment, @active controls the actual
  88 * hardware state.
  89 *
  90 * The three booleans active_changed, connectors_changed and mode_changed are
  91 * intended to indicate whether a full modeset is needed, rather than strictly
  92 * describing what has changed in a commit. See also:
  93 * drm_atomic_crtc_needs_modeset()
  94 *
  95 * WARNING: Transitional helpers (like drm_helper_crtc_mode_set() or
  96 * drm_helper_crtc_mode_set_base()) do not maintain many of the derived control
  97 * state like @plane_mask so drivers not converted over to atomic helpers should
  98 * not rely on these being accurate!
  99 */
 100struct drm_crtc_state {
 101	/** @crtc: backpointer to the CRTC */
 102	struct drm_crtc *crtc;
 103
 104	/**
 105	 * @enable: Whether the CRTC should be enabled, gates all other state.
 106	 * This controls reservations of shared resources. Actual hardware state
 107	 * is controlled by @active.
 108	 */
 109	bool enable;
 110
 111	/**
 112	 * @active: Whether the CRTC is actively displaying (used for DPMS).
 113	 * Implies that @enable is set. The driver must not release any shared
 114	 * resources if @active is set to false but @enable still true, because
 115	 * userspace expects that a DPMS ON always succeeds.
 116	 *
 117	 * Hence drivers must not consult @active in their various
 118	 * &drm_mode_config_funcs.atomic_check callback to reject an atomic
 119	 * commit. They can consult it to aid in the computation of derived
 120	 * hardware state, since even in the DPMS OFF state the display hardware
 121	 * should be as much powered down as when the CRTC is completely
 122	 * disabled through setting @enable to false.
 123	 */
 124	bool active;
 125
 126	/**
 127	 * @planes_changed: Planes on this crtc are updated. Used by the atomic
 128	 * helpers and drivers to steer the atomic commit control flow.
 129	 */
 130	bool planes_changed : 1;
 131
 132	/**
 133	 * @mode_changed: @mode or @enable has been changed. Used by the atomic
 134	 * helpers and drivers to steer the atomic commit control flow. See also
 135	 * drm_atomic_crtc_needs_modeset().
 136	 *
 137	 * Drivers are supposed to set this for any CRTC state changes that
 138	 * require a full modeset. They can also reset it to false if e.g. a
 139	 * @mode change can be done without a full modeset by only changing
 140	 * scaler settings.
 141	 */
 142	bool mode_changed : 1;
 143
 144	/**
 145	 * @active_changed: @active has been toggled. Used by the atomic
 146	 * helpers and drivers to steer the atomic commit control flow. See also
 147	 * drm_atomic_crtc_needs_modeset().
 148	 */
 149	bool active_changed : 1;
 150
 151	/**
 152	 * @connectors_changed: Connectors to this crtc have been updated,
 153	 * either in their state or routing. Used by the atomic
 154	 * helpers and drivers to steer the atomic commit control flow. See also
 155	 * drm_atomic_crtc_needs_modeset().
 156	 *
 157	 * Drivers are supposed to set this as-needed from their own atomic
 158	 * check code, e.g. from &drm_encoder_helper_funcs.atomic_check
 159	 */
 160	bool connectors_changed : 1;
 161	/**
 162	 * @zpos_changed: zpos values of planes on this crtc have been updated.
 163	 * Used by the atomic helpers and drivers to steer the atomic commit
 164	 * control flow.
 165	 */
 166	bool zpos_changed : 1;
 167	/**
 168	 * @color_mgmt_changed: Color management properties have changed
 169	 * (@gamma_lut, @degamma_lut or @ctm). Used by the atomic helpers and
 170	 * drivers to steer the atomic commit control flow.
 171	 */
 172	bool color_mgmt_changed : 1;
 173
 174	/**
 175	 * @no_vblank:
 176	 *
 177	 * Reflects the ability of a CRTC to send VBLANK events. This state
 178	 * usually depends on the pipeline configuration, and the main usuage
 179	 * is CRTCs feeding a writeback connector operating in oneshot mode.
 180	 * In this case the VBLANK event is only generated when a job is queued
 181	 * to the writeback connector, and we want the core to fake VBLANK
 182	 * events when this part of the pipeline hasn't changed but others had
 183	 * or when the CRTC and connectors are being disabled.
 184	 *
 185	 * __drm_atomic_helper_crtc_duplicate_state() will not reset the value
 186	 * from the current state, the CRTC driver is then responsible for
 187	 * updating this field when needed.
 188	 *
 189	 * Note that the combination of &drm_crtc_state.event == NULL and
 190	 * &drm_crtc_state.no_blank == true is valid and usually used when the
 191	 * writeback connector attached to the CRTC has a new job queued. In
 192	 * this case the driver will send the VBLANK event on its own when the
 193	 * writeback job is complete.
 194	 */
 195	bool no_vblank : 1;
 196
 197	/**
 198	 * @plane_mask: Bitmask of drm_plane_mask(plane) of planes attached to
 199	 * this CRTC.
 200	 */
 201	u32 plane_mask;
 202
 203	/**
 204	 * @connector_mask: Bitmask of drm_connector_mask(connector) of
 205	 * connectors attached to this CRTC.
 206	 */
 207	u32 connector_mask;
 
 208
 209	/**
 210	 * @encoder_mask: Bitmask of drm_encoder_mask(encoder) of encoders
 211	 * attached to this CRTC.
 212	 */
 213	u32 encoder_mask;
 
 214
 215	/**
 216	 * @adjusted_mode:
 217	 *
 218	 * Internal display timings which can be used by the driver to handle
 219	 * differences between the mode requested by userspace in @mode and what
 220	 * is actually programmed into the hardware.
 221	 *
 222	 * For drivers using &drm_bridge, this stores hardware display timings
 223	 * used between the CRTC and the first bridge. For other drivers, the
 224	 * meaning of the adjusted_mode field is purely driver implementation
 225	 * defined information, and will usually be used to store the hardware
 226	 * display timings used between the CRTC and encoder blocks.
 227	 */
 228	struct drm_display_mode adjusted_mode;
 229
 230	/**
 231	 * @mode:
 232	 *
 233	 * Display timings requested by userspace. The driver should try to
 234	 * match the refresh rate as close as possible (but note that it's
 235	 * undefined what exactly is close enough, e.g. some of the HDMI modes
 236	 * only differ in less than 1% of the refresh rate). The active width
 237	 * and height as observed by userspace for positioning planes must match
 238	 * exactly.
 239	 *
 240	 * For external connectors where the sink isn't fixed (like with a
 241	 * built-in panel), this mode here should match the physical mode on the
 242	 * wire to the last details (i.e. including sync polarities and
 243	 * everything).
 244	 */
 245	struct drm_display_mode mode;
 246
 247	/**
 248	 * @mode_blob: &drm_property_blob for @mode, for exposing the mode to
 249	 * atomic userspace.
 250	 */
 251	struct drm_property_blob *mode_blob;
 
 
 
 252
 253	/**
 254	 * @degamma_lut:
 255	 *
 256	 * Lookup table for converting framebuffer pixel data before apply the
 257	 * color conversion matrix @ctm. See drm_crtc_enable_color_mgmt(). The
 258	 * blob (if not NULL) is an array of &struct drm_color_lut.
 259	 */
 260	struct drm_property_blob *degamma_lut;
 261
 262	/**
 263	 * @ctm:
 264	 *
 265	 * Color transformation matrix. See drm_crtc_enable_color_mgmt(). The
 266	 * blob (if not NULL) is a &struct drm_color_ctm.
 267	 */
 268	struct drm_property_blob *ctm;
 
 
 269
 270	/**
 271	 * @gamma_lut:
 272	 *
 273	 * Lookup table for converting pixel data after the color conversion
 274	 * matrix @ctm.  See drm_crtc_enable_color_mgmt(). The blob (if not
 275	 * NULL) is an array of &struct drm_color_lut.
 276	 */
 277	struct drm_property_blob *gamma_lut;
 278
 279	/**
 280	 * @target_vblank:
 281	 *
 282	 * Target vertical blank period when a page flip
 283	 * should take effect.
 284	 */
 285	u32 target_vblank;
 286
 287	/**
 288	 * @async_flip:
 289	 *
 290	 * This is set when DRM_MODE_PAGE_FLIP_ASYNC is set in the legacy
 291	 * PAGE_FLIP IOCTL. It's not wired up for the atomic IOCTL itself yet.
 292	 */
 293	bool async_flip;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 294
 295	/**
 296	 * @vrr_enabled:
 297	 *
 298	 * Indicates if variable refresh rate should be enabled for the CRTC.
 299	 * Support for the requested vrr state will depend on driver and
 300	 * hardware capabiltiy - lacking support is not treated as failure.
 
 
 
 
 
 
 
 
 
 301	 */
 302	bool vrr_enabled;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 303
 304	/**
 305	 * @self_refresh_active:
 306	 *
 307	 * Used by the self refresh helpers to denote when a self refresh
 308	 * transition is occurring. This will be set on enable/disable callbacks
 309	 * when self refresh is being enabled or disabled. In some cases, it may
 310	 * not be desirable to fully shut off the crtc during self refresh.
 311	 * CRTC's can inspect this flag and determine the best course of action.
 312	 */
 313	bool self_refresh_active;
 314
 315	/**
 316	 * @event:
 317	 *
 318	 * Optional pointer to a DRM event to signal upon completion of the
 319	 * state update. The driver must send out the event when the atomic
 320	 * commit operation completes. There are two cases:
 321	 *
 322	 *  - The event is for a CRTC which is being disabled through this
 323	 *    atomic commit. In that case the event can be send out any time
 324	 *    after the hardware has stopped scanning out the current
 325	 *    framebuffers. It should contain the timestamp and counter for the
 326	 *    last vblank before the display pipeline was shut off. The simplest
 327	 *    way to achieve that is calling drm_crtc_send_vblank_event()
 328	 *    somewhen after drm_crtc_vblank_off() has been called.
 329	 *
 330	 *  - For a CRTC which is enabled at the end of the commit (even when it
 331	 *    undergoes an full modeset) the vblank timestamp and counter must
 332	 *    be for the vblank right before the first frame that scans out the
 333	 *    new set of buffers. Again the event can only be sent out after the
 334	 *    hardware has stopped scanning out the old buffers.
 335	 *
 336	 *  - Events for disabled CRTCs are not allowed, and drivers can ignore
 337	 *    that case.
 338	 *
 339	 * This can be handled by the drm_crtc_send_vblank_event() function,
 340	 * which the driver should call on the provided event upon completion of
 341	 * the atomic commit. Note that if the driver supports vblank signalling
 342	 * and timestamping the vblank counters and timestamps must agree with
 343	 * the ones returned from page flip events. With the current vblank
 344	 * helper infrastructure this can be achieved by holding a vblank
 345	 * reference while the page flip is pending, acquired through
 346	 * drm_crtc_vblank_get() and released with drm_crtc_vblank_put().
 347	 * Drivers are free to implement their own vblank counter and timestamp
 348	 * tracking though, e.g. if they have accurate timestamp registers in
 349	 * hardware.
 350	 *
 351	 * For hardware which supports some means to synchronize vblank
 352	 * interrupt delivery with committing display state there's also
 353	 * drm_crtc_arm_vblank_event(). See the documentation of that function
 354	 * for a detailed discussion of the constraints it needs to be used
 355	 * safely.
 356	 *
 357	 * If the device can't notify of flip completion in a race-free way
 358	 * at all, then the event should be armed just after the page flip is
 359	 * committed. In the worst case the driver will send the event to
 360	 * userspace one frame too late. This doesn't allow for a real atomic
 361	 * update, but it should avoid tearing.
 362	 */
 363	struct drm_pending_vblank_event *event;
 364
 365	/**
 366	 * @commit:
 367	 *
 368	 * This tracks how the commit for this update proceeds through the
 369	 * various phases. This is never cleared, except when we destroy the
 370	 * state, so that subsequent commits can synchronize with previous ones.
 371	 */
 372	struct drm_crtc_commit *commit;
 373
 374	/** @state: backpointer to global drm_atomic_state */
 375	struct drm_atomic_state *state;
 376};
 377
 
 
 
 
 
 
 
 378/**
 379 * struct drm_crtc_funcs - control CRTCs for a given device
 
 
 
 
 
 
 
 
 
 
 380 *
 381 * The drm_crtc_funcs structure is the central CRTC management structure
 382 * in the DRM.  Each CRTC controls one or more connectors (note that the name
 383 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
 384 * connectors, not just CRTs).
 385 *
 386 * Each driver is responsible for filling out this structure at startup time,
 387 * in addition to providing other modesetting features, like i2c and DDC
 388 * bus accessors.
 389 */
 390struct drm_crtc_funcs {
 391	/**
 392	 * @reset:
 393	 *
 394	 * Reset CRTC hardware and software state to off. This function isn't
 395	 * called by the core directly, only through drm_mode_config_reset().
 396	 * It's not a helper hook only for historical reasons.
 397	 *
 398	 * Atomic drivers can use drm_atomic_helper_crtc_reset() to reset
 399	 * atomic state using this hook.
 400	 */
 401	void (*reset)(struct drm_crtc *crtc);
 402
 403	/**
 404	 * @cursor_set:
 405	 *
 406	 * Update the cursor image. The cursor position is relative to the CRTC
 407	 * and can be partially or fully outside of the visible area.
 408	 *
 409	 * Note that contrary to all other KMS functions the legacy cursor entry
 410	 * points don't take a framebuffer object, but instead take directly a
 411	 * raw buffer object id from the driver's buffer manager (which is
 412	 * either GEM or TTM for current drivers).
 413	 *
 414	 * This entry point is deprecated, drivers should instead implement
 415	 * universal plane support and register a proper cursor plane using
 416	 * drm_crtc_init_with_planes().
 417	 *
 418	 * This callback is optional
 419	 *
 420	 * RETURNS:
 421	 *
 422	 * 0 on success or a negative error code on failure.
 423	 */
 424	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
 425			  uint32_t handle, uint32_t width, uint32_t height);
 426
 427	/**
 428	 * @cursor_set2:
 429	 *
 430	 * Update the cursor image, including hotspot information. The hotspot
 431	 * must not affect the cursor position in CRTC coordinates, but is only
 432	 * meant as a hint for virtualized display hardware to coordinate the
 433	 * guests and hosts cursor position. The cursor hotspot is relative to
 434	 * the cursor image. Otherwise this works exactly like @cursor_set.
 435	 *
 436	 * This entry point is deprecated, drivers should instead implement
 437	 * universal plane support and register a proper cursor plane using
 438	 * drm_crtc_init_with_planes().
 439	 *
 440	 * This callback is optional.
 441	 *
 442	 * RETURNS:
 443	 *
 444	 * 0 on success or a negative error code on failure.
 445	 */
 446	int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
 447			   uint32_t handle, uint32_t width, uint32_t height,
 448			   int32_t hot_x, int32_t hot_y);
 449
 450	/**
 451	 * @cursor_move:
 452	 *
 453	 * Update the cursor position. The cursor does not need to be visible
 454	 * when this hook is called.
 455	 *
 456	 * This entry point is deprecated, drivers should instead implement
 457	 * universal plane support and register a proper cursor plane using
 458	 * drm_crtc_init_with_planes().
 459	 *
 460	 * This callback is optional.
 461	 *
 462	 * RETURNS:
 463	 *
 464	 * 0 on success or a negative error code on failure.
 465	 */
 466	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
 467
 468	/**
 469	 * @gamma_set:
 470	 *
 471	 * Set gamma on the CRTC.
 472	 *
 473	 * This callback is optional.
 474	 *
 475	 * Atomic drivers who want to support gamma tables should implement the
 476	 * atomic color management support, enabled by calling
 477	 * drm_crtc_enable_color_mgmt(), which then supports the legacy gamma
 478	 * interface through the drm_atomic_helper_legacy_gamma_set()
 479	 * compatibility implementation.
 480	 */
 481	int (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
 482			 uint32_t size,
 483			 struct drm_modeset_acquire_ctx *ctx);
 484
 485	/**
 486	 * @destroy:
 487	 *
 488	 * Clean up CRTC resources. This is only called at driver unload time
 489	 * through drm_mode_config_cleanup() since a CRTC cannot be hotplugged
 490	 * in DRM.
 491	 */
 492	void (*destroy)(struct drm_crtc *crtc);
 493
 494	/**
 495	 * @set_config:
 496	 *
 497	 * This is the main legacy entry point to change the modeset state on a
 498	 * CRTC. All the details of the desired configuration are passed in a
 499	 * &struct drm_mode_set - see there for details.
 500	 *
 501	 * Drivers implementing atomic modeset should use
 502	 * drm_atomic_helper_set_config() to implement this hook.
 503	 *
 504	 * RETURNS:
 505	 *
 506	 * 0 on success or a negative error code on failure.
 507	 */
 508	int (*set_config)(struct drm_mode_set *set,
 509			  struct drm_modeset_acquire_ctx *ctx);
 510
 511	/**
 512	 * @page_flip:
 513	 *
 514	 * Legacy entry point to schedule a flip to the given framebuffer.
 515	 *
 516	 * Page flipping is a synchronization mechanism that replaces the frame
 517	 * buffer being scanned out by the CRTC with a new frame buffer during
 518	 * vertical blanking, avoiding tearing (except when requested otherwise
 519	 * through the DRM_MODE_PAGE_FLIP_ASYNC flag). When an application
 520	 * requests a page flip the DRM core verifies that the new frame buffer
 521	 * is large enough to be scanned out by the CRTC in the currently
 522	 * configured mode and then calls this hook with a pointer to the new
 523	 * frame buffer.
 524	 *
 525	 * The driver must wait for any pending rendering to the new framebuffer
 526	 * to complete before executing the flip. It should also wait for any
 527	 * pending rendering from other drivers if the underlying buffer is a
 528	 * shared dma-buf.
 529	 *
 530	 * An application can request to be notified when the page flip has
 531	 * completed. The drm core will supply a &struct drm_event in the event
 532	 * parameter in this case. This can be handled by the
 533	 * drm_crtc_send_vblank_event() function, which the driver should call on
 534	 * the provided event upon completion of the flip. Note that if
 535	 * the driver supports vblank signalling and timestamping the vblank
 536	 * counters and timestamps must agree with the ones returned from page
 537	 * flip events. With the current vblank helper infrastructure this can
 538	 * be achieved by holding a vblank reference while the page flip is
 539	 * pending, acquired through drm_crtc_vblank_get() and released with
 540	 * drm_crtc_vblank_put(). Drivers are free to implement their own vblank
 541	 * counter and timestamp tracking though, e.g. if they have accurate
 542	 * timestamp registers in hardware.
 543	 *
 544	 * This callback is optional.
 545	 *
 546	 * NOTE:
 547	 *
 548	 * Very early versions of the KMS ABI mandated that the driver must
 549	 * block (but not reject) any rendering to the old framebuffer until the
 550	 * flip operation has completed and the old framebuffer is no longer
 551	 * visible. This requirement has been lifted, and userspace is instead
 552	 * expected to request delivery of an event and wait with recycling old
 553	 * buffers until such has been received.
 554	 *
 555	 * RETURNS:
 556	 *
 557	 * 0 on success or a negative error code on failure. Note that if a
 558	 * page flip operation is already pending the callback should return
 559	 * -EBUSY. Pageflips on a disabled CRTC (either by setting a NULL mode
 560	 * or just runtime disabled through DPMS respectively the new atomic
 561	 * "ACTIVE" state) should result in an -EINVAL error code. Note that
 562	 * drm_atomic_helper_page_flip() checks this already for atomic drivers.
 563	 */
 564	int (*page_flip)(struct drm_crtc *crtc,
 565			 struct drm_framebuffer *fb,
 566			 struct drm_pending_vblank_event *event,
 567			 uint32_t flags,
 568			 struct drm_modeset_acquire_ctx *ctx);
 569
 570	/**
 571	 * @page_flip_target:
 572	 *
 573	 * Same as @page_flip but with an additional parameter specifying the
 574	 * absolute target vertical blank period (as reported by
 575	 * drm_crtc_vblank_count()) when the flip should take effect.
 576	 *
 577	 * Note that the core code calls drm_crtc_vblank_get before this entry
 578	 * point, and will call drm_crtc_vblank_put if this entry point returns
 579	 * any non-0 error code. It's the driver's responsibility to call
 580	 * drm_crtc_vblank_put after this entry point returns 0, typically when
 581	 * the flip completes.
 582	 */
 583	int (*page_flip_target)(struct drm_crtc *crtc,
 584				struct drm_framebuffer *fb,
 585				struct drm_pending_vblank_event *event,
 586				uint32_t flags, uint32_t target,
 587				struct drm_modeset_acquire_ctx *ctx);
 588
 589	/**
 590	 * @set_property:
 591	 *
 592	 * This is the legacy entry point to update a property attached to the
 593	 * CRTC.
 594	 *
 595	 * This callback is optional if the driver does not support any legacy
 596	 * driver-private properties. For atomic drivers it is not used because
 597	 * property handling is done entirely in the DRM core.
 598	 *
 599	 * RETURNS:
 600	 *
 601	 * 0 on success or a negative error code on failure.
 602	 */
 603	int (*set_property)(struct drm_crtc *crtc,
 604			    struct drm_property *property, uint64_t val);
 
 605
 606	/**
 607	 * @atomic_duplicate_state:
 608	 *
 609	 * Duplicate the current atomic state for this CRTC and return it.
 610	 * The core and helpers guarantee that any atomic state duplicated with
 611	 * this hook and still owned by the caller (i.e. not transferred to the
 612	 * driver by calling &drm_mode_config_funcs.atomic_commit) will be
 613	 * cleaned up by calling the @atomic_destroy_state hook in this
 614	 * structure.
 615	 *
 616	 * This callback is mandatory for atomic drivers.
 617	 *
 618	 * Atomic drivers which don't subclass &struct drm_crtc_state should use
 619	 * drm_atomic_helper_crtc_duplicate_state(). Drivers that subclass the
 620	 * state structure to extend it with driver-private state should use
 621	 * __drm_atomic_helper_crtc_duplicate_state() to make sure shared state is
 622	 * duplicated in a consistent fashion across drivers.
 623	 *
 624	 * It is an error to call this hook before &drm_crtc.state has been
 625	 * initialized correctly.
 626	 *
 627	 * NOTE:
 628	 *
 629	 * If the duplicate state references refcounted resources this hook must
 630	 * acquire a reference for each of them. The driver must release these
 631	 * references again in @atomic_destroy_state.
 632	 *
 633	 * RETURNS:
 634	 *
 635	 * Duplicated atomic state or NULL when the allocation failed.
 636	 */
 637	struct drm_crtc_state *(*atomic_duplicate_state)(struct drm_crtc *crtc);
 638
 639	/**
 640	 * @atomic_destroy_state:
 641	 *
 642	 * Destroy a state duplicated with @atomic_duplicate_state and release
 643	 * or unreference all resources it references
 644	 *
 645	 * This callback is mandatory for atomic drivers.
 
 
 646	 */
 647	void (*atomic_destroy_state)(struct drm_crtc *crtc,
 648				     struct drm_crtc_state *state);
 649
 650	/**
 651	 * @atomic_set_property:
 652	 *
 653	 * Decode a driver-private property value and store the decoded value
 654	 * into the passed-in state structure. Since the atomic core decodes all
 655	 * standardized properties (even for extensions beyond the core set of
 656	 * properties which might not be implemented by all drivers) this
 657	 * requires drivers to subclass the state structure.
 658	 *
 659	 * Such driver-private properties should really only be implemented for
 660	 * truly hardware/vendor specific state. Instead it is preferred to
 661	 * standardize atomic extension and decode the properties used to expose
 662	 * such an extension in the core.
 663	 *
 664	 * Do not call this function directly, use
 665	 * drm_atomic_crtc_set_property() instead.
 666	 *
 667	 * This callback is optional if the driver does not support any
 668	 * driver-private atomic properties.
 669	 *
 670	 * NOTE:
 671	 *
 672	 * This function is called in the state assembly phase of atomic
 673	 * modesets, which can be aborted for any reason (including on
 674	 * userspace's request to just check whether a configuration would be
 675	 * possible). Drivers MUST NOT touch any persistent state (hardware or
 676	 * software) or data structures except the passed in @state parameter.
 677	 *
 678	 * Also since userspace controls in which order properties are set this
 679	 * function must not do any input validation (since the state update is
 680	 * incomplete and hence likely inconsistent). Instead any such input
 681	 * validation must be done in the various atomic_check callbacks.
 682	 *
 683	 * RETURNS:
 684	 *
 685	 * 0 if the property has been found, -EINVAL if the property isn't
 686	 * implemented by the driver (which should never happen, the core only
 687	 * asks for properties attached to this CRTC). No other validation is
 688	 * allowed by the driver. The core already checks that the property
 689	 * value is within the range (integer, valid enum value, ...) the driver
 690	 * set when registering the property.
 691	 */
 692	int (*atomic_set_property)(struct drm_crtc *crtc,
 693				   struct drm_crtc_state *state,
 694				   struct drm_property *property,
 695				   uint64_t val);
 696	/**
 697	 * @atomic_get_property:
 698	 *
 699	 * Reads out the decoded driver-private property. This is used to
 700	 * implement the GETCRTC IOCTL.
 701	 *
 702	 * Do not call this function directly, use
 703	 * drm_atomic_crtc_get_property() instead.
 704	 *
 705	 * This callback is optional if the driver does not support any
 706	 * driver-private atomic properties.
 707	 *
 708	 * RETURNS:
 709	 *
 710	 * 0 on success, -EINVAL if the property isn't implemented by the
 711	 * driver (which should never happen, the core only asks for
 712	 * properties attached to this CRTC).
 713	 */
 714	int (*atomic_get_property)(struct drm_crtc *crtc,
 715				   const struct drm_crtc_state *state,
 716				   struct drm_property *property,
 717				   uint64_t *val);
 718
 719	/**
 720	 * @late_register:
 721	 *
 722	 * This optional hook can be used to register additional userspace
 723	 * interfaces attached to the crtc like debugfs interfaces.
 724	 * It is called late in the driver load sequence from drm_dev_register().
 725	 * Everything added from this callback should be unregistered in
 726	 * the early_unregister callback.
 727	 *
 728	 * Returns:
 729	 *
 730	 * 0 on success, or a negative error code on failure.
 731	 */
 732	int (*late_register)(struct drm_crtc *crtc);
 733
 734	/**
 735	 * @early_unregister:
 736	 *
 737	 * This optional hook should be used to unregister the additional
 738	 * userspace interfaces attached to the crtc from
 739	 * @late_register. It is called from drm_dev_unregister(),
 740	 * early in the driver unload sequence to disable userspace access
 741	 * before data structures are torndown.
 742	 */
 743	void (*early_unregister)(struct drm_crtc *crtc);
 744
 745	/**
 746	 * @set_crc_source:
 747	 *
 748	 * Changes the source of CRC checksums of frames at the request of
 749	 * userspace, typically for testing purposes. The sources available are
 750	 * specific of each driver and a %NULL value indicates that CRC
 751	 * generation is to be switched off.
 752	 *
 753	 * When CRC generation is enabled, the driver should call
 754	 * drm_crtc_add_crc_entry() at each frame, providing any information
 755	 * that characterizes the frame contents in the crcN arguments, as
 756	 * provided from the configured source. Drivers must accept an "auto"
 757	 * source name that will select a default source for this CRTC.
 758	 *
 759	 * This may trigger an atomic modeset commit if necessary, to enable CRC
 760	 * generation.
 761	 *
 762	 * Note that "auto" can depend upon the current modeset configuration,
 763	 * e.g. it could pick an encoder or output specific CRC sampling point.
 764	 *
 765	 * This callback is optional if the driver does not support any CRC
 766	 * generation functionality.
 767	 *
 768	 * RETURNS:
 769	 *
 770	 * 0 on success or a negative error code on failure.
 771	 */
 772	int (*set_crc_source)(struct drm_crtc *crtc, const char *source);
 773
 774	/**
 775	 * @verify_crc_source:
 776	 *
 777	 * verifies the source of CRC checksums of frames before setting the
 778	 * source for CRC and during crc open. Source parameter can be NULL
 779	 * while disabling crc source.
 780	 *
 781	 * This callback is optional if the driver does not support any CRC
 782	 * generation functionality.
 783	 *
 784	 * RETURNS:
 785	 *
 786	 * 0 on success or a negative error code on failure.
 787	 */
 788	int (*verify_crc_source)(struct drm_crtc *crtc, const char *source,
 789				 size_t *values_cnt);
 790	/**
 791	 * @get_crc_sources:
 792	 *
 793	 * Driver callback for getting a list of all the available sources for
 794	 * CRC generation. This callback depends upon verify_crc_source, So
 795	 * verify_crc_source callback should be implemented before implementing
 796	 * this. Driver can pass full list of available crc sources, this
 797	 * callback does the verification on each crc-source before passing it
 798	 * to userspace.
 799	 *
 800	 * This callback is optional if the driver does not support exporting of
 801	 * possible CRC sources list.
 802	 *
 803	 * RETURNS:
 804	 *
 805	 * a constant character pointer to the list of all the available CRC
 806	 * sources. On failure driver should return NULL. count should be
 807	 * updated with number of sources in list. if zero we don't process any
 808	 * source from the list.
 809	 */
 810	const char *const *(*get_crc_sources)(struct drm_crtc *crtc,
 811					      size_t *count);
 812
 813	/**
 814	 * @atomic_print_state:
 815	 *
 816	 * If driver subclasses &struct drm_crtc_state, it should implement
 817	 * this optional hook for printing additional driver specific state.
 818	 *
 819	 * Do not call this directly, use drm_atomic_crtc_print_state()
 820	 * instead.
 821	 */
 822	void (*atomic_print_state)(struct drm_printer *p,
 823				   const struct drm_crtc_state *state);
 824
 825	/**
 826	 * @get_vblank_counter:
 827	 *
 828	 * Driver callback for fetching a raw hardware vblank counter for the
 829	 * CRTC. It's meant to be used by new drivers as the replacement of
 830	 * &drm_driver.get_vblank_counter hook.
 831	 *
 832	 * This callback is optional. If a device doesn't have a hardware
 833	 * counter, the driver can simply leave the hook as NULL. The DRM core
 834	 * will account for missed vblank events while interrupts where disabled
 835	 * based on system timestamps.
 836	 *
 837	 * Wraparound handling and loss of events due to modesetting is dealt
 838	 * with in the DRM core code, as long as drivers call
 839	 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
 840	 * enabling a CRTC.
 841	 *
 842	 * See also &drm_device.vblank_disable_immediate and
 843	 * &drm_device.max_vblank_count.
 844	 *
 845	 * Returns:
 846	 *
 847	 * Raw vblank counter value.
 848	 */
 849	u32 (*get_vblank_counter)(struct drm_crtc *crtc);
 850
 851	/**
 852	 * @enable_vblank:
 853	 *
 854	 * Enable vblank interrupts for the CRTC. It's meant to be used by
 855	 * new drivers as the replacement of &drm_driver.enable_vblank hook.
 856	 *
 857	 * Returns:
 858	 *
 859	 * Zero on success, appropriate errno if the vblank interrupt cannot
 860	 * be enabled.
 861	 */
 862	int (*enable_vblank)(struct drm_crtc *crtc);
 863
 864	/**
 865	 * @disable_vblank:
 866	 *
 867	 * Disable vblank interrupts for the CRTC. It's meant to be used by
 868	 * new drivers as the replacement of &drm_driver.disable_vblank hook.
 869	 */
 870	void (*disable_vblank)(struct drm_crtc *crtc);
 
 
 
 
 871};
 872
 
 873/**
 874 * struct drm_crtc - central CRTC control structure
 
 
 
 
 
 
 
 
 
 875 *
 876 * Each CRTC may have one or more connectors associated with it.  This structure
 877 * allows the CRTC to be controlled.
 
 878 */
 879struct drm_crtc {
 880	/** @dev: parent DRM device */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 881	struct drm_device *dev;
 882	/** @port: OF node used by drm_of_find_possible_crtcs(). */
 883	struct device_node *port;
 884	/**
 885	 * @head:
 886	 *
 887	 * List of all CRTCs on @dev, linked from &drm_mode_config.crtc_list.
 888	 * Invariant over the lifetime of @dev and therefore does not need
 889	 * locking.
 890	 */
 891	struct list_head head;
 892
 893	/** @name: human readable name, can be overwritten by the driver */
 894	char *name;
 
 
 895
 896	/**
 897	 * @mutex:
 898	 *
 899	 * This provides a read lock for the overall CRTC state (mode, dpms
 900	 * state, ...) and a write lock for everything which can be update
 901	 * without a full modeset (fb, cursor data, CRTC properties ...). A full
 902	 * modeset also need to grab &drm_mode_config.connection_mutex.
 903	 *
 904	 * For atomic drivers specifically this protects @state.
 905	 */
 906	struct drm_modeset_lock mutex;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 907
 908	/** @base: base KMS object for ID tracking etc. */
 909	struct drm_mode_object base;
 910
 911	/**
 912	 * @primary:
 913	 * Primary plane for this CRTC. Note that this is only
 914	 * relevant for legacy IOCTL, it specifies the plane implicitly used by
 915	 * the SETCRTC and PAGE_FLIP IOCTLs. It does not have any significance
 916	 * beyond that.
 917	 */
 918	struct drm_plane *primary;
 919
 920	/**
 921	 * @cursor:
 922	 * Cursor plane for this CRTC. Note that this is only relevant for
 923	 * legacy IOCTL, it specifies the plane implicitly used by the SETCURSOR
 924	 * and SETCURSOR2 IOCTLs. It does not have any significance
 925	 * beyond that.
 926	 */
 927	struct drm_plane *cursor;
 928
 929	/**
 930	 * @index: Position inside the mode_config.list, can be used as an array
 931	 * index. It is invariant over the lifetime of the CRTC.
 932	 */
 933	unsigned index;
 934
 935	/**
 936	 * @cursor_x: Current x position of the cursor, used for universal
 937	 * cursor planes because the SETCURSOR IOCTL only can update the
 938	 * framebuffer without supplying the coordinates. Drivers should not use
 939	 * this directly, atomic drivers should look at &drm_plane_state.crtc_x
 940	 * of the cursor plane instead.
 941	 */
 942	int cursor_x;
 943	/**
 944	 * @cursor_y: Current y position of the cursor, used for universal
 945	 * cursor planes because the SETCURSOR IOCTL only can update the
 946	 * framebuffer without supplying the coordinates. Drivers should not use
 947	 * this directly, atomic drivers should look at &drm_plane_state.crtc_y
 948	 * of the cursor plane instead.
 949	 */
 950	int cursor_y;
 951
 952	/**
 953	 * @enabled:
 954	 *
 955	 * Is this CRTC enabled? Should only be used by legacy drivers, atomic
 956	 * drivers should instead consult &drm_crtc_state.enable and
 957	 * &drm_crtc_state.active. Atomic drivers can update this by calling
 958	 * drm_atomic_helper_update_legacy_modeset_state().
 959	 */
 960	bool enabled;
 961
 962	/**
 963	 * @mode:
 964	 *
 965	 * Current mode timings. Should only be used by legacy drivers, atomic
 966	 * drivers should instead consult &drm_crtc_state.mode. Atomic drivers
 967	 * can update this by calling
 968	 * drm_atomic_helper_update_legacy_modeset_state().
 969	 */
 970	struct drm_display_mode mode;
 971
 972	/**
 973	 * @hwmode:
 974	 *
 975	 * Programmed mode in hw, after adjustments for encoders, crtc, panel
 976	 * scaling etc. Should only be used by legacy drivers, for high
 977	 * precision vblank timestamps in
 978	 * drm_calc_vbltimestamp_from_scanoutpos().
 979	 *
 980	 * Note that atomic drivers should not use this, but instead use
 981	 * &drm_crtc_state.adjusted_mode. And for high-precision timestamps
 982	 * drm_calc_vbltimestamp_from_scanoutpos() used &drm_vblank_crtc.hwmode,
 983	 * which is filled out by calling drm_calc_timestamping_constants().
 984	 */
 985	struct drm_display_mode hwmode;
 986
 987	/**
 988	 * @x:
 989	 * x position on screen. Should only be used by legacy drivers, atomic
 990	 * drivers should look at &drm_plane_state.crtc_x of the primary plane
 991	 * instead. Updated by calling
 992	 * drm_atomic_helper_update_legacy_modeset_state().
 993	 */
 994	int x;
 995	/**
 996	 * @y:
 997	 * y position on screen. Should only be used by legacy drivers, atomic
 998	 * drivers should look at &drm_plane_state.crtc_y of the primary plane
 999	 * instead. Updated by calling
1000	 * drm_atomic_helper_update_legacy_modeset_state().
1001	 */
1002	int y;
1003
1004	/** @funcs: CRTC control functions */
1005	const struct drm_crtc_funcs *funcs;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1006
1007	/**
1008	 * @gamma_size: Size of legacy gamma ramp reported to userspace. Set up
1009	 * by calling drm_mode_crtc_set_gamma_size().
1010	 */
1011	uint32_t gamma_size;
1012
1013	/**
1014	 * @gamma_store: Gamma ramp values used by the legacy SETGAMMA and
1015	 * GETGAMMA IOCTls. Set up by calling drm_mode_crtc_set_gamma_size().
1016	 */
1017	uint16_t *gamma_store;
1018
1019	/** @helper_private: mid-layer private data */
1020	const struct drm_crtc_helper_funcs *helper_private;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1021
1022	/** @properties: property tracking for this CRTC */
1023	struct drm_object_properties properties;
1024
1025	/**
1026	 * @state:
1027	 *
1028	 * Current atomic state for this CRTC.
1029	 *
1030	 * This is protected by @mutex. Note that nonblocking atomic commits
1031	 * access the current CRTC state without taking locks. Either by going
1032	 * through the &struct drm_atomic_state pointers, see
1033	 * for_each_oldnew_crtc_in_state(), for_each_old_crtc_in_state() and
1034	 * for_each_new_crtc_in_state(). Or through careful ordering of atomic
1035	 * commit operations as implemented in the atomic helpers, see
1036	 * &struct drm_crtc_commit.
1037	 */
1038	struct drm_crtc_state *state;
1039
1040	/**
1041	 * @commit_list:
1042	 *
1043	 * List of &drm_crtc_commit structures tracking pending commits.
1044	 * Protected by @commit_lock. This list holds its own full reference,
1045	 * as does the ongoing commit.
1046	 *
1047	 * "Note that the commit for a state change is also tracked in
1048	 * &drm_crtc_state.commit. For accessing the immediately preceding
1049	 * commit in an atomic update it is recommended to just use that
1050	 * pointer in the old CRTC state, since accessing that doesn't need
1051	 * any locking or list-walking. @commit_list should only be used to
1052	 * stall for framebuffer cleanup that's signalled through
1053	 * &drm_crtc_commit.cleanup_done."
1054	 */
1055	struct list_head commit_list;
1056
1057	/**
1058	 * @commit_lock:
1059	 *
1060	 * Spinlock to protect @commit_list.
1061	 */
1062	spinlock_t commit_lock;
1063
1064#ifdef CONFIG_DEBUG_FS
1065	/**
1066	 * @debugfs_entry:
1067	 *
1068	 * Debugfs directory for this CRTC.
1069	 */
1070	struct dentry *debugfs_entry;
1071#endif
1072
1073	/**
1074	 * @crc:
1075	 *
1076	 * Configuration settings of CRC capture.
1077	 */
1078	struct drm_crtc_crc crc;
1079
1080	/**
1081	 * @fence_context:
1082	 *
1083	 * timeline context used for fence operations.
1084	 */
1085	unsigned int fence_context;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1086
1087	/**
1088	 * @fence_lock:
1089	 *
1090	 * spinlock to protect the fences in the fence_context.
1091	 */
1092	spinlock_t fence_lock;
1093	/**
1094	 * @fence_seqno:
1095	 *
1096	 * Seqno variable used as monotonic counter for the fences
1097	 * created on the CRTC's timeline.
1098	 */
1099	unsigned long fence_seqno;
1100
1101	/**
1102	 * @timeline_name:
1103	 *
1104	 * The name of the CRTC's fence timeline.
1105	 */
1106	char timeline_name[32];
1107
1108	/**
1109	 * @self_refresh_data: Holds the state for the self refresh helpers
1110	 *
1111	 * Initialized via drm_self_refresh_helper_init().
1112	 */
1113	struct drm_self_refresh_data *self_refresh_data;
1114};
1115
1116/**
1117 * struct drm_mode_set - new values for a CRTC config change
 
1118 * @fb: framebuffer to use for new config
1119 * @crtc: CRTC whose configuration we're about to change
1120 * @mode: mode timings to use
1121 * @x: position of this CRTC relative to @fb
1122 * @y: position of this CRTC relative to @fb
1123 * @connectors: array of connectors to drive with this CRTC if possible
1124 * @num_connectors: size of @connectors array
1125 *
1126 * This represents a modeset configuration for the legacy SETCRTC ioctl and is
1127 * also used internally. Atomic drivers instead use &drm_atomic_state.
 
 
1128 */
1129struct drm_mode_set {
1130	struct drm_framebuffer *fb;
1131	struct drm_crtc *crtc;
1132	struct drm_display_mode *mode;
1133
1134	uint32_t x;
1135	uint32_t y;
1136
1137	struct drm_connector **connectors;
1138	size_t num_connectors;
1139};
1140
1141#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1142
1143__printf(6, 7)
1144int drm_crtc_init_with_planes(struct drm_device *dev,
1145			      struct drm_crtc *crtc,
1146			      struct drm_plane *primary,
1147			      struct drm_plane *cursor,
1148			      const struct drm_crtc_funcs *funcs,
1149			      const char *name, ...);
1150void drm_crtc_cleanup(struct drm_crtc *crtc);
1151
1152/**
1153 * drm_crtc_index - find the index of a registered CRTC
1154 * @crtc: CRTC to find index for
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1155 *
1156 * Given a registered CRTC, return the index of that CRTC within a DRM
1157 * device's list of CRTCs.
 
1158 */
1159static inline unsigned int drm_crtc_index(const struct drm_crtc *crtc)
1160{
1161	return crtc->index;
1162}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1163
1164/**
1165 * drm_crtc_mask - find the mask of a registered CRTC
1166 * @crtc: CRTC to find mask for
1167 *
1168 * Given a registered CRTC, return the mask bit of that CRTC for the
1169 * &drm_encoder.possible_crtcs and &drm_plane.possible_crtcs fields.
1170 */
1171static inline uint32_t drm_crtc_mask(const struct drm_crtc *crtc)
1172{
1173	return 1 << drm_crtc_index(crtc);
1174}
1175
1176int drm_mode_set_config_internal(struct drm_mode_set *set);
1177struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1178
1179/**
1180 * drm_crtc_find - look up a CRTC object from its ID
1181 * @dev: DRM device
1182 * @file_priv: drm file to check for lease against.
1183 * @id: &drm_mode_object ID
1184 *
1185 * This can be used to look up a CRTC from its userspace ID. Only used by
1186 * drivers for legacy IOCTLs and interface, nowadays extensions to the KMS
1187 * userspace interface should be done using &drm_property.
1188 */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1189static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1190		struct drm_file *file_priv,
1191		uint32_t id)
1192{
1193	struct drm_mode_object *mo;
1194	mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_CRTC);
1195	return mo ? obj_to_crtc(mo) : NULL;
1196}
1197
1198/**
1199 * drm_for_each_crtc - iterate over all CRTCs
1200 * @crtc: a &struct drm_crtc as the loop cursor
1201 * @dev: the &struct drm_device
1202 *
1203 * Iterate over all CRTCs of @dev.
1204 */
1205#define drm_for_each_crtc(crtc, dev) \
1206	list_for_each_entry(crtc, &(dev)->mode_config.crtc_list, head)
 
 
 
1207
1208#endif /* __DRM_CRTC_H__ */
v3.15
   1/*
   2 * Copyright © 2006 Keith Packard
   3 * Copyright © 2007-2008 Dave Airlie
   4 * Copyright © 2007-2008 Intel Corporation
   5 *   Jesse Barnes <jesse.barnes@intel.com>
   6 *
   7 * Permission is hereby granted, free of charge, to any person obtaining a
   8 * copy of this software and associated documentation files (the "Software"),
   9 * to deal in the Software without restriction, including without limitation
  10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 * and/or sell copies of the Software, and to permit persons to whom the
  12 * Software is furnished to do so, subject to the following conditions:
  13 *
  14 * The above copyright notice and this permission notice shall be included in
  15 * all copies or substantial portions of the Software.
  16 *
  17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23 * OTHER DEALINGS IN THE SOFTWARE.
  24 */
  25#ifndef __DRM_CRTC_H__
  26#define __DRM_CRTC_H__
  27
  28#include <linux/i2c.h>
  29#include <linux/spinlock.h>
  30#include <linux/types.h>
  31#include <linux/idr.h>
  32#include <linux/fb.h>
  33#include <linux/hdmi.h>
  34#include <drm/drm_mode.h>
  35#include <drm/drm_fourcc.h>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  36
  37struct drm_device;
  38struct drm_mode_set;
  39struct drm_framebuffer;
  40struct drm_object_properties;
  41struct drm_file;
  42struct drm_clip_rect;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  43
  44#define DRM_MODE_OBJECT_CRTC 0xcccccccc
  45#define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
  46#define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
  47#define DRM_MODE_OBJECT_MODE 0xdededede
  48#define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
  49#define DRM_MODE_OBJECT_FB 0xfbfbfbfb
  50#define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
  51#define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
  52#define DRM_MODE_OBJECT_BRIDGE 0xbdbdbdbd
  53
  54struct drm_mode_object {
  55	uint32_t id;
  56	uint32_t type;
  57	struct drm_object_properties *properties;
  58};
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  59
  60#define DRM_OBJECT_MAX_PROPERTY 24
  61struct drm_object_properties {
  62	int count;
  63	uint32_t ids[DRM_OBJECT_MAX_PROPERTY];
  64	uint64_t values[DRM_OBJECT_MAX_PROPERTY];
  65};
  66
  67enum drm_connector_force {
  68	DRM_FORCE_UNSPECIFIED,
  69	DRM_FORCE_OFF,
  70	DRM_FORCE_ON,         /* force on analog part normally */
  71	DRM_FORCE_ON_DIGITAL, /* for DVI-I use digital connector */
  72};
  73
  74#include <drm/drm_modes.h>
 
 
 
 
 
 
 
 
 
 
 
 
 
  75
  76enum drm_connector_status {
  77	connector_status_connected = 1,
  78	connector_status_disconnected = 2,
  79	connector_status_unknown = 3,
  80};
 
 
 
 
 
 
 
 
 
 
 
  81
  82enum subpixel_order {
  83	SubPixelUnknown = 0,
  84	SubPixelHorizontalRGB,
  85	SubPixelHorizontalBGR,
  86	SubPixelVerticalRGB,
  87	SubPixelVerticalBGR,
  88	SubPixelNone,
  89};
  90
  91#define DRM_COLOR_FORMAT_RGB444		(1<<0)
  92#define DRM_COLOR_FORMAT_YCRCB444	(1<<1)
  93#define DRM_COLOR_FORMAT_YCRCB422	(1<<2)
  94/*
  95 * Describes a given display (e.g. CRT or flat panel) and its limitations.
  96 */
  97struct drm_display_info {
  98	char name[DRM_DISPLAY_INFO_LEN];
  99
 100	/* Physical size */
 101        unsigned int width_mm;
 102	unsigned int height_mm;
 103
 104	/* Clock limits FIXME: storage format */
 105	unsigned int min_vfreq, max_vfreq;
 106	unsigned int min_hfreq, max_hfreq;
 107	unsigned int pixel_clock;
 108	unsigned int bpc;
 109
 110	enum subpixel_order subpixel_order;
 111	u32 color_formats;
 
 
 
 
 
 
 112
 113	u8 cea_rev;
 114};
 
 
 
 
 
 115
 116struct drm_framebuffer_funcs {
 117	/* note: use drm_framebuffer_remove() */
 118	void (*destroy)(struct drm_framebuffer *framebuffer);
 119	int (*create_handle)(struct drm_framebuffer *fb,
 120			     struct drm_file *file_priv,
 121			     unsigned int *handle);
 122	/**
 123	 * Optinal callback for the dirty fb ioctl.
 124	 *
 125	 * Userspace can notify the driver via this callback
 126	 * that a area of the framebuffer has changed and should
 127	 * be flushed to the display hardware.
 128	 *
 129	 * See documentation in drm_mode.h for the struct
 130	 * drm_mode_fb_dirty_cmd for more information as all
 131	 * the semantics and arguments have a one to one mapping
 132	 * on this function.
 133	 */
 134	int (*dirty)(struct drm_framebuffer *framebuffer,
 135		     struct drm_file *file_priv, unsigned flags,
 136		     unsigned color, struct drm_clip_rect *clips,
 137		     unsigned num_clips);
 138};
 139
 140struct drm_framebuffer {
 141	struct drm_device *dev;
 142	/*
 143	 * Note that the fb is refcounted for the benefit of driver internals,
 144	 * for example some hw, disabling a CRTC/plane is asynchronous, and
 145	 * scanout does not actually complete until the next vblank.  So some
 146	 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
 147	 * should be deferred.  In cases like this, the driver would like to
 148	 * hold a ref to the fb even though it has already been removed from
 149	 * userspace perspective.
 150	 */
 151	struct kref refcount;
 152	/*
 153	 * Place on the dev->mode_config.fb_list, access protected by
 154	 * dev->mode_config.fb_lock.
 155	 */
 156	struct list_head head;
 157	struct drm_mode_object base;
 158	const struct drm_framebuffer_funcs *funcs;
 159	unsigned int pitches[4];
 160	unsigned int offsets[4];
 161	unsigned int width;
 162	unsigned int height;
 163	/* depth can be 15 or 16 */
 164	unsigned int depth;
 165	int bits_per_pixel;
 166	int flags;
 167	uint32_t pixel_format; /* fourcc format */
 168	struct list_head filp_head;
 169	/* if you are using the helper */
 170	void *helper_private;
 171};
 172
 173struct drm_property_blob {
 174	struct drm_mode_object base;
 175	struct list_head head;
 176	unsigned int length;
 177	unsigned char data[];
 178};
 
 
 
 
 179
 180struct drm_property_enum {
 181	uint64_t value;
 182	struct list_head head;
 183	char name[DRM_PROP_NAME_LEN];
 184};
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 185
 186struct drm_property {
 187	struct list_head head;
 188	struct drm_mode_object base;
 189	uint32_t flags;
 190	char name[DRM_PROP_NAME_LEN];
 191	uint32_t num_values;
 192	uint64_t *values;
 
 193
 194	struct list_head enum_blob_list;
 
 195};
 196
 197struct drm_crtc;
 198struct drm_connector;
 199struct drm_encoder;
 200struct drm_pending_vblank_event;
 201struct drm_plane;
 202struct drm_bridge;
 203
 204/**
 205 * drm_crtc_funcs - control CRTCs for a given device
 206 * @save: save CRTC state
 207 * @restore: restore CRTC state
 208 * @reset: reset CRTC after state has been invalidated (e.g. resume)
 209 * @cursor_set: setup the cursor
 210 * @cursor_move: move the cursor
 211 * @gamma_set: specify color ramp for CRTC
 212 * @destroy: deinit and free object
 213 * @set_property: called when a property is changed
 214 * @set_config: apply a new CRTC configuration
 215 * @page_flip: initiate a page flip
 216 *
 217 * The drm_crtc_funcs structure is the central CRTC management structure
 218 * in the DRM.  Each CRTC controls one or more connectors (note that the name
 219 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
 220 * connectors, not just CRTs).
 221 *
 222 * Each driver is responsible for filling out this structure at startup time,
 223 * in addition to providing other modesetting features, like i2c and DDC
 224 * bus accessors.
 225 */
 226struct drm_crtc_funcs {
 227	/* Save CRTC state */
 228	void (*save)(struct drm_crtc *crtc); /* suspend? */
 229	/* Restore CRTC state */
 230	void (*restore)(struct drm_crtc *crtc); /* resume? */
 231	/* Reset CRTC state */
 
 
 
 
 
 232	void (*reset)(struct drm_crtc *crtc);
 233
 234	/* cursor controls */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 235	int (*cursor_set)(struct drm_crtc *crtc, struct drm_file *file_priv,
 236			  uint32_t handle, uint32_t width, uint32_t height);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 237	int (*cursor_set2)(struct drm_crtc *crtc, struct drm_file *file_priv,
 238			   uint32_t handle, uint32_t width, uint32_t height,
 239			   int32_t hot_x, int32_t hot_y);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 240	int (*cursor_move)(struct drm_crtc *crtc, int x, int y);
 241
 242	/* Set gamma on the CRTC */
 243	void (*gamma_set)(struct drm_crtc *crtc, u16 *r, u16 *g, u16 *b,
 244			  uint32_t start, uint32_t size);
 245	/* Object destroy routine */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 246	void (*destroy)(struct drm_crtc *crtc);
 247
 248	int (*set_config)(struct drm_mode_set *set);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 249
 250	/*
 251	 * Flip to the given framebuffer.  This implements the page
 252	 * flip ioctl described in drm_mode.h, specifically, the
 253	 * implementation must return immediately and block all
 254	 * rendering to the current fb until the flip has completed.
 255	 * If userspace set the event flag in the ioctl, the event
 256	 * argument will point to an event to send back when the flip
 257	 * completes, otherwise it will be NULL.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 258	 */
 259	int (*page_flip)(struct drm_crtc *crtc,
 260			 struct drm_framebuffer *fb,
 261			 struct drm_pending_vblank_event *event,
 262			 uint32_t flags);
 
 263
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 264	int (*set_property)(struct drm_crtc *crtc,
 265			    struct drm_property *property, uint64_t val);
 266};
 267
 268/**
 269 * drm_crtc - central CRTC control structure
 270 * @dev: parent DRM device
 271 * @head: list management
 272 * @base: base KMS object for ID tracking etc.
 273 * @primary: primary plane for this CRTC
 274 * @cursor: cursor plane for this CRTC
 275 * @enabled: is this CRTC enabled?
 276 * @mode: current mode timings
 277 * @hwmode: mode timings as programmed to hw regs
 278 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
 279 *    invert the width/height of the crtc.  This is used if the driver
 280 *    is performing 90 or 270 degree rotated scanout
 281 * @x: x position on screen
 282 * @y: y position on screen
 283 * @funcs: CRTC control functions
 284 * @gamma_size: size of gamma ramp
 285 * @gamma_store: gamma ramp values
 286 * @framedur_ns: precise frame timing
 287 * @framedur_ns: precise line timing
 288 * @pixeldur_ns: precise pixel timing
 289 * @helper_private: mid-layer private data
 290 * @properties: property tracking for this CRTC
 291 *
 292 * Each CRTC may have one or more connectors associated with it.  This structure
 293 * allows the CRTC to be controlled.
 294 */
 295struct drm_crtc {
 296	struct drm_device *dev;
 297	struct list_head head;
 
 
 298
 299	/**
 300	 * crtc mutex
 
 
 
 301	 *
 302	 * This provides a read lock for the overall crtc state (mode, dpms
 303	 * state, ...) and a write lock for everything which can be update
 304	 * without a full modeset (fb, cursor data, ...)
 305	 */
 306	struct mutex mutex;
 
 307
 308	struct drm_mode_object base;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 309
 310	/* primary and cursor planes for CRTC */
 311	struct drm_plane *primary;
 312	struct drm_plane *cursor;
 
 
 
 
 
 
 
 
 
 
 
 313
 314	/* Temporary tracking of the old fb while a modeset is ongoing. Used
 315	 * by drm_mode_set_config_internal to implement correct refcounting. */
 316	struct drm_framebuffer *old_fb;
 
 
 
 
 
 
 
 317
 318	bool enabled;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 319
 320	/* Requested mode from modesetting. */
 321	struct drm_display_mode mode;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 322
 323	/* Programmed mode in hw, after adjustments for encoders,
 324	 * crtc, panel scaling etc. Needed for timestamping etc.
 
 
 
 
 
 
 325	 */
 326	struct drm_display_mode hwmode;
 
 327
 328	bool invert_dimensions;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 329
 330	int x, y;
 331	const struct drm_crtc_funcs *funcs;
 
 
 
 
 
 
 
 
 
 
 332
 333	/* CRTC gamma size for reporting to userspace */
 334	uint32_t gamma_size;
 335	uint16_t *gamma_store;
 336
 337	/* Constants needed for precise vblank and swap timestamping. */
 338	int framedur_ns, linedur_ns, pixeldur_ns;
 339
 340	/* if you are using the helper */
 341	void *helper_private;
 342
 343	struct drm_object_properties properties;
 344};
 345
 346
 347/**
 348 * drm_connector_funcs - control connectors on a given device
 349 * @dpms: set power state (see drm_crtc_funcs above)
 350 * @save: save connector state
 351 * @restore: restore connector state
 352 * @reset: reset connector after state has been invalidated (e.g. resume)
 353 * @detect: is this connector active?
 354 * @fill_modes: fill mode list for this connector
 355 * @set_property: property for this connector may need an update
 356 * @destroy: make object go away
 357 * @force: notify the driver that the connector is forced on
 358 *
 359 * Each CRTC may have one or more connectors attached to it.  The functions
 360 * below allow the core DRM code to control connectors, enumerate available modes,
 361 * etc.
 362 */
 363struct drm_connector_funcs {
 364	void (*dpms)(struct drm_connector *connector, int mode);
 365	void (*save)(struct drm_connector *connector);
 366	void (*restore)(struct drm_connector *connector);
 367	void (*reset)(struct drm_connector *connector);
 368
 369	/* Check to see if anything is attached to the connector.
 370	 * @force is set to false whilst polling, true when checking the
 371	 * connector due to user request. @force can be used by the driver
 372	 * to avoid expensive, destructive operations during automated
 373	 * probing.
 374	 */
 375	enum drm_connector_status (*detect)(struct drm_connector *connector,
 376					    bool force);
 377	int (*fill_modes)(struct drm_connector *connector, uint32_t max_width, uint32_t max_height);
 378	int (*set_property)(struct drm_connector *connector, struct drm_property *property,
 379			     uint64_t val);
 380	void (*destroy)(struct drm_connector *connector);
 381	void (*force)(struct drm_connector *connector);
 382};
 383
 384/**
 385 * drm_encoder_funcs - encoder controls
 386 * @reset: reset state (e.g. at init or resume time)
 387 * @destroy: cleanup and free associated data
 388 *
 389 * Encoders sit between CRTCs and connectors.
 390 */
 391struct drm_encoder_funcs {
 392	void (*reset)(struct drm_encoder *encoder);
 393	void (*destroy)(struct drm_encoder *encoder);
 394};
 395
 396#define DRM_CONNECTOR_MAX_ENCODER 3
 397
 398/**
 399 * drm_encoder - central DRM encoder structure
 400 * @dev: parent DRM device
 401 * @head: list management
 402 * @base: base KMS object
 403 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
 404 * @possible_crtcs: bitmask of potential CRTC bindings
 405 * @possible_clones: bitmask of potential sibling encoders for cloning
 406 * @crtc: currently bound CRTC
 407 * @bridge: bridge associated to the encoder
 408 * @funcs: control functions
 409 * @helper_private: mid-layer private data
 410 *
 411 * CRTCs drive pixels to encoders, which convert them into signals
 412 * appropriate for a given connector or set of connectors.
 413 */
 414struct drm_encoder {
 415	struct drm_device *dev;
 
 
 
 
 
 
 
 
 
 416	struct list_head head;
 417
 418	struct drm_mode_object base;
 419	int encoder_type;
 420	uint32_t possible_crtcs;
 421	uint32_t possible_clones;
 422
 423	struct drm_crtc *crtc;
 424	struct drm_bridge *bridge;
 425	const struct drm_encoder_funcs *funcs;
 426	void *helper_private;
 427};
 428
 429/* should we poll this connector for connects and disconnects */
 430/* hot plug detectable */
 431#define DRM_CONNECTOR_POLL_HPD (1 << 0)
 432/* poll for connections */
 433#define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
 434/* can cleanly poll for disconnections without flickering the screen */
 435/* DACs should rarely do this without a lot of testing */
 436#define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
 437
 438#define MAX_ELD_BYTES	128
 439
 440/**
 441 * drm_connector - central DRM connector control structure
 442 * @dev: parent DRM device
 443 * @kdev: kernel device for sysfs attributes
 444 * @attr: sysfs attributes
 445 * @head: list management
 446 * @base: base KMS object
 447 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
 448 * @connector_type_id: index into connector type enum
 449 * @interlace_allowed: can this connector handle interlaced modes?
 450 * @doublescan_allowed: can this connector handle doublescan?
 451 * @modes: modes available on this connector (from fill_modes() + user)
 452 * @status: one of the drm_connector_status enums (connected, not, or unknown)
 453 * @probed_modes: list of modes derived directly from the display
 454 * @display_info: information about attached display (e.g. from EDID)
 455 * @funcs: connector control functions
 456 * @edid_blob_ptr: DRM property containing EDID if present
 457 * @properties: property tracking for this connector
 458 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
 459 * @dpms: current dpms state
 460 * @helper_private: mid-layer private data
 461 * @force: a %DRM_FORCE_<foo> state for forced mode sets
 462 * @encoder_ids: valid encoders for this connector
 463 * @encoder: encoder driving this connector, if any
 464 * @eld: EDID-like data, if present
 465 * @dvi_dual: dual link DVI, if found
 466 * @max_tmds_clock: max clock rate, if found
 467 * @latency_present: AV delay info from ELD, if found
 468 * @video_latency: video latency info from ELD, if found
 469 * @audio_latency: audio latency info from ELD, if found
 470 * @null_edid_counter: track sinks that give us all zeros for the EDID
 471 *
 472 * Each connector may be connected to one or more CRTCs, or may be clonable by
 473 * another connector if they can share a CRTC.  Each connector also has a specific
 474 * position in the broader display (referred to as a 'screen' though it could
 475 * span multiple monitors).
 476 */
 477struct drm_connector {
 478	struct drm_device *dev;
 479	struct device *kdev;
 480	struct device_attribute *attr;
 481	struct list_head head;
 482
 
 483	struct drm_mode_object base;
 484
 485	int connector_type;
 486	int connector_type_id;
 487	bool interlace_allowed;
 488	bool doublescan_allowed;
 489	bool stereo_allowed;
 490	struct list_head modes; /* list of modes on this connector */
 491
 492	enum drm_connector_status status;
 493
 494	/* these are modes added by probing with DDC or the BIOS */
 495	struct list_head probed_modes;
 
 
 
 
 
 
 496
 497	struct drm_display_info display_info;
 498	const struct drm_connector_funcs *funcs;
 
 
 
 499
 500	struct drm_property_blob *edid_blob_ptr;
 501	struct drm_object_properties properties;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 502
 503	uint8_t polled; /* DRM_CONNECTOR_POLL_* */
 
 
 
 
 
 
 
 
 504
 505	/* requested DPMS state */
 506	int dpms;
 
 
 
 
 
 
 
 507
 508	void *helper_private;
 
 
 
 
 
 
 
 
 
 
 
 
 
 509
 510	/* forced on connector */
 511	enum drm_connector_force force;
 512	uint32_t encoder_ids[DRM_CONNECTOR_MAX_ENCODER];
 513	struct drm_encoder *encoder; /* currently active encoder */
 514
 515	/* EDID bits */
 516	uint8_t eld[MAX_ELD_BYTES];
 517	bool dvi_dual;
 518	int max_tmds_clock;	/* in MHz */
 519	bool latency_present[2];
 520	int video_latency[2];	/* [0]: progressive, [1]: interlaced */
 521	int audio_latency[2];
 522	int null_edid_counter; /* needed to workaround some HW bugs where we get all 0s */
 523	unsigned bad_edid_counter;
 524};
 
 525
 526/**
 527 * drm_plane_funcs - driver plane control functions
 528 * @update_plane: update the plane configuration
 529 * @disable_plane: shut down the plane
 530 * @destroy: clean up plane resources
 531 * @set_property: called when a property is changed
 532 */
 533struct drm_plane_funcs {
 534	int (*update_plane)(struct drm_plane *plane,
 535			    struct drm_crtc *crtc, struct drm_framebuffer *fb,
 536			    int crtc_x, int crtc_y,
 537			    unsigned int crtc_w, unsigned int crtc_h,
 538			    uint32_t src_x, uint32_t src_y,
 539			    uint32_t src_w, uint32_t src_h);
 540	int (*disable_plane)(struct drm_plane *plane);
 541	void (*destroy)(struct drm_plane *plane);
 542
 543	int (*set_property)(struct drm_plane *plane,
 544			    struct drm_property *property, uint64_t val);
 545};
 
 
 546
 547enum drm_plane_type {
 548	DRM_PLANE_TYPE_OVERLAY,
 549	DRM_PLANE_TYPE_PRIMARY,
 550	DRM_PLANE_TYPE_CURSOR,
 551};
 552
 553/**
 554 * drm_plane - central DRM plane control structure
 555 * @dev: DRM device this plane belongs to
 556 * @head: for list management
 557 * @base: base mode object
 558 * @possible_crtcs: pipes this plane can be bound to
 559 * @format_types: array of formats supported by this plane
 560 * @format_count: number of formats supported
 561 * @crtc: currently bound CRTC
 562 * @fb: currently bound fb
 563 * @funcs: helper functions
 564 * @properties: property tracking for this plane
 565 * @type: type of plane (overlay, primary, cursor)
 566 */
 567struct drm_plane {
 568	struct drm_device *dev;
 569	struct list_head head;
 570
 571	struct drm_mode_object base;
 
 572
 573	uint32_t possible_crtcs;
 574	uint32_t *format_types;
 575	uint32_t format_count;
 
 
 
 
 
 
 
 
 
 
 
 576
 577	struct drm_crtc *crtc;
 578	struct drm_framebuffer *fb;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 579
 580	const struct drm_plane_funcs *funcs;
 
 
 
 
 
 581
 582	struct drm_object_properties properties;
 
 
 
 
 
 
 
 583
 584	enum drm_plane_type type;
 585};
 
 
 
 
 586
 587/**
 588 * drm_bridge_funcs - drm_bridge control functions
 589 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
 590 * @disable: Called right before encoder prepare, disables the bridge
 591 * @post_disable: Called right after encoder prepare, for lockstepped disable
 592 * @mode_set: Set this mode to the bridge
 593 * @pre_enable: Called right before encoder commit, for lockstepped commit
 594 * @enable: Called right after encoder commit, enables the bridge
 595 * @destroy: make object go away
 596 */
 597struct drm_bridge_funcs {
 598	bool (*mode_fixup)(struct drm_bridge *bridge,
 599			   const struct drm_display_mode *mode,
 600			   struct drm_display_mode *adjusted_mode);
 601	void (*disable)(struct drm_bridge *bridge);
 602	void (*post_disable)(struct drm_bridge *bridge);
 603	void (*mode_set)(struct drm_bridge *bridge,
 604			 struct drm_display_mode *mode,
 605			 struct drm_display_mode *adjusted_mode);
 606	void (*pre_enable)(struct drm_bridge *bridge);
 607	void (*enable)(struct drm_bridge *bridge);
 608	void (*destroy)(struct drm_bridge *bridge);
 609};
 610
 611/**
 612 * drm_bridge - central DRM bridge control structure
 613 * @dev: DRM device this bridge belongs to
 614 * @head: list management
 615 * @base: base mode object
 616 * @funcs: control functions
 617 * @driver_private: pointer to the bridge driver's internal context
 618 */
 619struct drm_bridge {
 620	struct drm_device *dev;
 621	struct list_head head;
 
 
 622
 623	struct drm_mode_object base;
 
 
 
 
 
 624
 625	const struct drm_bridge_funcs *funcs;
 626	void *driver_private;
 
 
 
 
 627};
 628
 629/**
 630 * drm_mode_set - new values for a CRTC config change
 631 * @head: list management
 632 * @fb: framebuffer to use for new config
 633 * @crtc: CRTC whose configuration we're about to change
 634 * @mode: mode timings to use
 635 * @x: position of this CRTC relative to @fb
 636 * @y: position of this CRTC relative to @fb
 637 * @connectors: array of connectors to drive with this CRTC if possible
 638 * @num_connectors: size of @connectors array
 639 *
 640 * Represents a single crtc the connectors that it drives with what mode
 641 * and from which framebuffer it scans out from.
 642 *
 643 * This is used to set modes.
 644 */
 645struct drm_mode_set {
 646	struct drm_framebuffer *fb;
 647	struct drm_crtc *crtc;
 648	struct drm_display_mode *mode;
 649
 650	uint32_t x;
 651	uint32_t y;
 652
 653	struct drm_connector **connectors;
 654	size_t num_connectors;
 655};
 656
 657/**
 658 * struct drm_mode_config_funcs - basic driver provided mode setting functions
 659 * @fb_create: create a new framebuffer object
 660 * @output_poll_changed: function to handle output configuration changes
 661 *
 662 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
 663 * involve drivers.
 664 */
 665struct drm_mode_config_funcs {
 666	struct drm_framebuffer *(*fb_create)(struct drm_device *dev,
 667					     struct drm_file *file_priv,
 668					     struct drm_mode_fb_cmd2 *mode_cmd);
 669	void (*output_poll_changed)(struct drm_device *dev);
 670};
 671
 672/**
 673 * drm_mode_group - group of mode setting resources for potential sub-grouping
 674 * @num_crtcs: CRTC count
 675 * @num_encoders: encoder count
 676 * @num_connectors: connector count
 677 * @id_list: list of KMS object IDs in this group
 678 *
 679 * Currently this simply tracks the global mode setting state.  But in the
 680 * future it could allow groups of objects to be set aside into independent
 681 * control groups for use by different user level processes (e.g. two X servers
 682 * running simultaneously on different heads, each with their own mode
 683 * configuration and freedom of mode setting).
 684 */
 685struct drm_mode_group {
 686	uint32_t num_crtcs;
 687	uint32_t num_encoders;
 688	uint32_t num_connectors;
 689	uint32_t num_bridges;
 690
 691	/* list of object IDs for this group */
 692	uint32_t *id_list;
 693};
 
 
 
 
 
 694
 695/**
 696 * drm_mode_config - Mode configuration control structure
 697 * @mutex: mutex protecting KMS related lists and structures
 698 * @idr_mutex: mutex for KMS ID allocation and management
 699 * @crtc_idr: main KMS ID tracking object
 700 * @num_fb: number of fbs available
 701 * @fb_list: list of framebuffers available
 702 * @num_connector: number of connectors on this device
 703 * @connector_list: list of connector objects
 704 * @num_bridge: number of bridges on this device
 705 * @bridge_list: list of bridge objects
 706 * @num_encoder: number of encoders on this device
 707 * @encoder_list: list of encoder objects
 708 * @num_crtc: number of CRTCs on this device
 709 * @crtc_list: list of CRTC objects
 710 * @min_width: minimum pixel width on this device
 711 * @min_height: minimum pixel height on this device
 712 * @max_width: maximum pixel width on this device
 713 * @max_height: maximum pixel height on this device
 714 * @funcs: core driver provided mode setting functions
 715 * @fb_base: base address of the framebuffer
 716 * @poll_enabled: track polling status for this device
 717 * @output_poll_work: delayed work for polling in process context
 718 * @*_property: core property tracking
 719 *
 720 * Core mode resource tracking structure.  All CRTC, encoders, and connectors
 721 * enumerated by the driver are added here, as are global properties.  Some
 722 * global restrictions are also here, e.g. dimension restrictions.
 723 */
 724struct drm_mode_config {
 725	struct mutex mutex; /* protects configuration (mode lists etc.) */
 726	struct mutex idr_mutex; /* for IDR management */
 727	struct idr crtc_idr; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
 728	/* this is limited to one for now */
 729
 730
 731	/**
 732	 * fb_lock - mutex to protect fb state
 733	 *
 734	 * Besides the global fb list his also protects the fbs list in the
 735	 * file_priv
 736	 */
 737	struct mutex fb_lock;
 738	int num_fb;
 739	struct list_head fb_list;
 740
 741	int num_connector;
 742	struct list_head connector_list;
 743	int num_bridge;
 744	struct list_head bridge_list;
 745	int num_encoder;
 746	struct list_head encoder_list;
 747
 748	/*
 749	 * Track # of overlay planes separately from # of total planes.  By
 750	 * default we only advertise overlay planes to userspace; if userspace
 751	 * sets the "universal plane" capability bit, we'll go ahead and
 752	 * expose all planes.
 753	 */
 754	int num_overlay_plane;
 755	int num_total_plane;
 756	struct list_head plane_list;
 757
 758	int num_crtc;
 759	struct list_head crtc_list;
 760
 761	struct list_head property_list;
 762
 763	int min_width, min_height;
 764	int max_width, max_height;
 765	const struct drm_mode_config_funcs *funcs;
 766	resource_size_t fb_base;
 767
 768	/* output poll support */
 769	bool poll_enabled;
 770	bool poll_running;
 771	struct delayed_work output_poll_work;
 772
 773	/* pointers to standard properties */
 774	struct list_head property_blob_list;
 775	struct drm_property *edid_property;
 776	struct drm_property *dpms_property;
 777	struct drm_property *plane_type_property;
 778
 779	/* DVI-I properties */
 780	struct drm_property *dvi_i_subconnector_property;
 781	struct drm_property *dvi_i_select_subconnector_property;
 782
 783	/* TV properties */
 784	struct drm_property *tv_subconnector_property;
 785	struct drm_property *tv_select_subconnector_property;
 786	struct drm_property *tv_mode_property;
 787	struct drm_property *tv_left_margin_property;
 788	struct drm_property *tv_right_margin_property;
 789	struct drm_property *tv_top_margin_property;
 790	struct drm_property *tv_bottom_margin_property;
 791	struct drm_property *tv_brightness_property;
 792	struct drm_property *tv_contrast_property;
 793	struct drm_property *tv_flicker_reduction_property;
 794	struct drm_property *tv_overscan_property;
 795	struct drm_property *tv_saturation_property;
 796	struct drm_property *tv_hue_property;
 797
 798	/* Optional properties */
 799	struct drm_property *scaling_mode_property;
 800	struct drm_property *dirty_info_property;
 801
 802	/* dumb ioctl parameters */
 803	uint32_t preferred_depth, prefer_shadow;
 804
 805	/* whether async page flip is supported or not */
 806	bool async_page_flip;
 807
 808	/* cursor size */
 809	uint32_t cursor_width, cursor_height;
 810};
 811
 812#define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
 813#define obj_to_connector(x) container_of(x, struct drm_connector, base)
 814#define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
 815#define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
 816#define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
 817#define obj_to_property(x) container_of(x, struct drm_property, base)
 818#define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
 819#define obj_to_plane(x) container_of(x, struct drm_plane, base)
 820
 821struct drm_prop_enum_list {
 822	int type;
 823	char *name;
 824};
 825
 826extern void drm_modeset_lock_all(struct drm_device *dev);
 827extern void drm_modeset_unlock_all(struct drm_device *dev);
 828extern void drm_warn_on_modeset_not_all_locked(struct drm_device *dev);
 829
 830extern int drm_crtc_init_with_planes(struct drm_device *dev,
 831				     struct drm_crtc *crtc,
 832				     struct drm_plane *primary,
 833				     void *cursor,
 834				     const struct drm_crtc_funcs *funcs);
 835extern int drm_crtc_init(struct drm_device *dev,
 836			 struct drm_crtc *crtc,
 837			 const struct drm_crtc_funcs *funcs);
 838extern void drm_crtc_cleanup(struct drm_crtc *crtc);
 839extern unsigned int drm_crtc_index(struct drm_crtc *crtc);
 840
 841/**
 842 * drm_crtc_mask - find the mask of a registered CRTC
 843 * @crtc: CRTC to find mask for
 844 *
 845 * Given a registered CRTC, return the mask bit of that CRTC for an
 846 * encoder's possible_crtcs field.
 847 */
 848static inline uint32_t drm_crtc_mask(struct drm_crtc *crtc)
 849{
 850	return 1 << drm_crtc_index(crtc);
 851}
 852
 853extern void drm_connector_ida_init(void);
 854extern void drm_connector_ida_destroy(void);
 855extern int drm_connector_init(struct drm_device *dev,
 856			      struct drm_connector *connector,
 857			      const struct drm_connector_funcs *funcs,
 858			      int connector_type);
 859
 860extern void drm_connector_cleanup(struct drm_connector *connector);
 861/* helper to unplug all connectors from sysfs for device */
 862extern void drm_connector_unplug_all(struct drm_device *dev);
 863
 864extern int drm_bridge_init(struct drm_device *dev, struct drm_bridge *bridge,
 865			   const struct drm_bridge_funcs *funcs);
 866extern void drm_bridge_cleanup(struct drm_bridge *bridge);
 867
 868extern int drm_encoder_init(struct drm_device *dev,
 869			    struct drm_encoder *encoder,
 870			    const struct drm_encoder_funcs *funcs,
 871			    int encoder_type);
 872
 873/**
 874 * drm_encoder_crtc_ok - can a given crtc drive a given encoder?
 875 * @encoder: encoder to test
 876 * @crtc: crtc to test
 
 877 *
 878 * Return false if @encoder can't be driven by @crtc, true otherwise.
 
 
 879 */
 880static inline bool drm_encoder_crtc_ok(struct drm_encoder *encoder,
 881				       struct drm_crtc *crtc)
 882{
 883	return !!(encoder->possible_crtcs & drm_crtc_mask(crtc));
 884}
 885
 886extern int drm_universal_plane_init(struct drm_device *dev,
 887				    struct drm_plane *plane,
 888				    unsigned long possible_crtcs,
 889				    const struct drm_plane_funcs *funcs,
 890				    const uint32_t *formats,
 891				    uint32_t format_count,
 892				    enum drm_plane_type type);
 893extern int drm_plane_init(struct drm_device *dev,
 894			  struct drm_plane *plane,
 895			  unsigned long possible_crtcs,
 896			  const struct drm_plane_funcs *funcs,
 897			  const uint32_t *formats, uint32_t format_count,
 898			  bool is_primary);
 899extern void drm_plane_cleanup(struct drm_plane *plane);
 900extern void drm_plane_force_disable(struct drm_plane *plane);
 901extern int drm_crtc_check_viewport(const struct drm_crtc *crtc,
 902				   int x, int y,
 903				   const struct drm_display_mode *mode,
 904				   const struct drm_framebuffer *fb);
 905
 906extern void drm_encoder_cleanup(struct drm_encoder *encoder);
 907
 908extern const char *drm_get_connector_name(const struct drm_connector *connector);
 909extern const char *drm_get_connector_status_name(enum drm_connector_status status);
 910extern const char *drm_get_subpixel_order_name(enum subpixel_order order);
 911extern const char *drm_get_dpms_name(int val);
 912extern const char *drm_get_dvi_i_subconnector_name(int val);
 913extern const char *drm_get_dvi_i_select_name(int val);
 914extern const char *drm_get_tv_subconnector_name(int val);
 915extern const char *drm_get_tv_select_name(int val);
 916extern void drm_fb_release(struct drm_file *file_priv);
 917extern int drm_mode_group_init_legacy_group(struct drm_device *dev, struct drm_mode_group *group);
 918extern bool drm_probe_ddc(struct i2c_adapter *adapter);
 919extern struct edid *drm_get_edid(struct drm_connector *connector,
 920				 struct i2c_adapter *adapter);
 921extern struct edid *drm_edid_duplicate(const struct edid *edid);
 922extern int drm_add_edid_modes(struct drm_connector *connector, struct edid *edid);
 923extern void drm_mode_config_init(struct drm_device *dev);
 924extern void drm_mode_config_reset(struct drm_device *dev);
 925extern void drm_mode_config_cleanup(struct drm_device *dev);
 926
 927extern int drm_mode_connector_update_edid_property(struct drm_connector *connector,
 928						struct edid *edid);
 929extern int drm_object_property_set_value(struct drm_mode_object *obj,
 930					 struct drm_property *property,
 931					 uint64_t val);
 932extern int drm_object_property_get_value(struct drm_mode_object *obj,
 933					 struct drm_property *property,
 934					 uint64_t *value);
 935extern int drm_framebuffer_init(struct drm_device *dev,
 936				struct drm_framebuffer *fb,
 937				const struct drm_framebuffer_funcs *funcs);
 938extern struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev,
 939						      uint32_t id);
 940extern void drm_framebuffer_unreference(struct drm_framebuffer *fb);
 941extern void drm_framebuffer_reference(struct drm_framebuffer *fb);
 942extern void drm_framebuffer_remove(struct drm_framebuffer *fb);
 943extern void drm_framebuffer_cleanup(struct drm_framebuffer *fb);
 944extern void drm_framebuffer_unregister_private(struct drm_framebuffer *fb);
 945
 946extern void drm_object_attach_property(struct drm_mode_object *obj,
 947				       struct drm_property *property,
 948				       uint64_t init_val);
 949extern struct drm_property *drm_property_create(struct drm_device *dev, int flags,
 950						const char *name, int num_values);
 951extern struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
 952					 const char *name,
 953					 const struct drm_prop_enum_list *props,
 954					 int num_values);
 955struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
 956					 int flags, const char *name,
 957					 const struct drm_prop_enum_list *props,
 958					 int num_values);
 959struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
 960					 const char *name,
 961					 uint64_t min, uint64_t max);
 962extern void drm_property_destroy(struct drm_device *dev, struct drm_property *property);
 963extern int drm_property_add_enum(struct drm_property *property, int index,
 964				 uint64_t value, const char *name);
 965extern int drm_mode_create_dvi_i_properties(struct drm_device *dev);
 966extern int drm_mode_create_tv_properties(struct drm_device *dev, int num_formats,
 967				     char *formats[]);
 968extern int drm_mode_create_scaling_mode_property(struct drm_device *dev);
 969extern int drm_mode_create_dirty_info_property(struct drm_device *dev);
 970extern const char *drm_get_encoder_name(const struct drm_encoder *encoder);
 971
 972extern int drm_mode_connector_attach_encoder(struct drm_connector *connector,
 973					     struct drm_encoder *encoder);
 974extern int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
 975					 int gamma_size);
 976extern struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
 977		uint32_t id, uint32_t type);
 978/* IOCTLs */
 979extern int drm_mode_getresources(struct drm_device *dev,
 980				 void *data, struct drm_file *file_priv);
 981extern int drm_mode_getplane_res(struct drm_device *dev, void *data,
 982				   struct drm_file *file_priv);
 983extern int drm_mode_getcrtc(struct drm_device *dev,
 984			    void *data, struct drm_file *file_priv);
 985extern int drm_mode_getconnector(struct drm_device *dev,
 986			      void *data, struct drm_file *file_priv);
 987extern int drm_mode_set_config_internal(struct drm_mode_set *set);
 988extern int drm_mode_setcrtc(struct drm_device *dev,
 989			    void *data, struct drm_file *file_priv);
 990extern int drm_mode_getplane(struct drm_device *dev,
 991			       void *data, struct drm_file *file_priv);
 992extern int drm_mode_setplane(struct drm_device *dev,
 993			       void *data, struct drm_file *file_priv);
 994extern int drm_mode_cursor_ioctl(struct drm_device *dev,
 995				void *data, struct drm_file *file_priv);
 996extern int drm_mode_cursor2_ioctl(struct drm_device *dev,
 997				void *data, struct drm_file *file_priv);
 998extern int drm_mode_addfb(struct drm_device *dev,
 999			  void *data, struct drm_file *file_priv);
1000extern int drm_mode_addfb2(struct drm_device *dev,
1001			   void *data, struct drm_file *file_priv);
1002extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
1003extern int drm_mode_rmfb(struct drm_device *dev,
1004			 void *data, struct drm_file *file_priv);
1005extern int drm_mode_getfb(struct drm_device *dev,
1006			  void *data, struct drm_file *file_priv);
1007extern int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
1008				  void *data, struct drm_file *file_priv);
1009
1010extern int drm_mode_getproperty_ioctl(struct drm_device *dev,
1011				      void *data, struct drm_file *file_priv);
1012extern int drm_mode_getblob_ioctl(struct drm_device *dev,
1013				  void *data, struct drm_file *file_priv);
1014extern int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
1015					      void *data, struct drm_file *file_priv);
1016extern int drm_mode_getencoder(struct drm_device *dev,
1017			       void *data, struct drm_file *file_priv);
1018extern int drm_mode_gamma_get_ioctl(struct drm_device *dev,
1019				    void *data, struct drm_file *file_priv);
1020extern int drm_mode_gamma_set_ioctl(struct drm_device *dev,
1021				    void *data, struct drm_file *file_priv);
1022extern u8 drm_match_cea_mode(const struct drm_display_mode *to_match);
1023extern bool drm_detect_hdmi_monitor(struct edid *edid);
1024extern bool drm_detect_monitor_audio(struct edid *edid);
1025extern bool drm_rgb_quant_range_selectable(struct edid *edid);
1026extern int drm_mode_page_flip_ioctl(struct drm_device *dev,
1027				    void *data, struct drm_file *file_priv);
1028extern int drm_add_modes_noedid(struct drm_connector *connector,
1029				int hdisplay, int vdisplay);
1030extern void drm_set_preferred_mode(struct drm_connector *connector,
1031				   int hpref, int vpref);
1032
1033extern int drm_edid_header_is_valid(const u8 *raw_edid);
1034extern bool drm_edid_block_valid(u8 *raw_edid, int block, bool print_bad_edid);
1035extern bool drm_edid_is_valid(struct edid *edid);
1036struct drm_display_mode *drm_mode_find_dmt(struct drm_device *dev,
1037					   int hsize, int vsize, int fresh,
1038					   bool rb);
1039
1040extern int drm_mode_create_dumb_ioctl(struct drm_device *dev,
1041				      void *data, struct drm_file *file_priv);
1042extern int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
1043				    void *data, struct drm_file *file_priv);
1044extern int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
1045				      void *data, struct drm_file *file_priv);
1046extern int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
1047					     struct drm_file *file_priv);
1048extern int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
1049					   struct drm_file *file_priv);
1050
1051extern void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
1052				 int *bpp);
1053extern int drm_format_num_planes(uint32_t format);
1054extern int drm_format_plane_cpp(uint32_t format, int plane);
1055extern int drm_format_horz_chroma_subsampling(uint32_t format);
1056extern int drm_format_vert_chroma_subsampling(uint32_t format);
1057extern const char *drm_get_format_name(uint32_t format);
1058
1059/* Helpers */
1060static inline struct drm_crtc *drm_crtc_find(struct drm_device *dev,
1061	uint32_t id)
 
1062{
1063	struct drm_mode_object *mo;
1064	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_CRTC);
1065	return mo ? obj_to_crtc(mo) : NULL;
1066}
1067
1068static inline struct drm_encoder *drm_encoder_find(struct drm_device *dev,
1069	uint32_t id)
1070{
1071	struct drm_mode_object *mo;
1072	mo = drm_mode_object_find(dev, id, DRM_MODE_OBJECT_ENCODER);
1073	return mo ? obj_to_encoder(mo) : NULL;
1074}
1075
1076/* Plane list iterator for legacy (overlay only) planes. */
1077#define drm_for_each_legacy_plane(plane, planelist) \
1078	list_for_each_entry(plane, planelist, head) \
1079		if (plane->type == DRM_PLANE_TYPE_OVERLAY)
1080
1081#endif /* __DRM_CRTC_H__ */