2 * Copyright © 2006 Keith Packard
3 * Copyright © 2007-2008 Dave Airlie
4 * Copyright © 2007-2008 Intel Corporation
5 * Jesse Barnes <jesse.barnes@intel.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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.
25 #ifndef __DRM_CRTC_H__
26 #define __DRM_CRTC_H__
28 #include <linux/i2c.h>
29 #include <linux/spinlock.h>
30 #include <linux/types.h>
31 #include <linux/idr.h>
33 #include <drm/drm_mode.h>
35 #include <drm/drm_fourcc.h>
39 struct drm_framebuffer
;
40 struct drm_object_properties
;
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
54 struct drm_mode_object
{
57 struct drm_object_properties
*properties
;
60 #define DRM_OBJECT_MAX_PROPERTY 24
61 struct drm_object_properties
{
63 uint32_t ids
[DRM_OBJECT_MAX_PROPERTY
];
64 uint64_t values
[DRM_OBJECT_MAX_PROPERTY
];
68 * Note on terminology: here, for brevity and convenience, we refer to connector
69 * control chips as 'CRTCs'. They can control any type of connector, VGA, LVDS,
70 * DVI, etc. And 'screen' refers to the whole of the visible display, which
71 * may span multiple monitors (and therefore multiple CRTC and connector
75 enum drm_mode_status
{
76 MODE_OK
= 0, /* Mode OK */
77 MODE_HSYNC
, /* hsync out of range */
78 MODE_VSYNC
, /* vsync out of range */
79 MODE_H_ILLEGAL
, /* mode has illegal horizontal timings */
80 MODE_V_ILLEGAL
, /* mode has illegal horizontal timings */
81 MODE_BAD_WIDTH
, /* requires an unsupported linepitch */
82 MODE_NOMODE
, /* no mode with a matching name */
83 MODE_NO_INTERLACE
, /* interlaced mode not supported */
84 MODE_NO_DBLESCAN
, /* doublescan mode not supported */
85 MODE_NO_VSCAN
, /* multiscan mode not supported */
86 MODE_MEM
, /* insufficient video memory */
87 MODE_VIRTUAL_X
, /* mode width too large for specified virtual size */
88 MODE_VIRTUAL_Y
, /* mode height too large for specified virtual size */
89 MODE_MEM_VIRT
, /* insufficient video memory given virtual size */
90 MODE_NOCLOCK
, /* no fixed clock available */
91 MODE_CLOCK_HIGH
, /* clock required is too high */
92 MODE_CLOCK_LOW
, /* clock required is too low */
93 MODE_CLOCK_RANGE
, /* clock/mode isn't in a ClockRange */
94 MODE_BAD_HVALUE
, /* horizontal timing was out of range */
95 MODE_BAD_VVALUE
, /* vertical timing was out of range */
96 MODE_BAD_VSCAN
, /* VScan value out of range */
97 MODE_HSYNC_NARROW
, /* horizontal sync too narrow */
98 MODE_HSYNC_WIDE
, /* horizontal sync too wide */
99 MODE_HBLANK_NARROW
, /* horizontal blanking too narrow */
100 MODE_HBLANK_WIDE
, /* horizontal blanking too wide */
101 MODE_VSYNC_NARROW
, /* vertical sync too narrow */
102 MODE_VSYNC_WIDE
, /* vertical sync too wide */
103 MODE_VBLANK_NARROW
, /* vertical blanking too narrow */
104 MODE_VBLANK_WIDE
, /* vertical blanking too wide */
105 MODE_PANEL
, /* exceeds panel dimensions */
106 MODE_INTERLACE_WIDTH
, /* width too large for interlaced mode */
107 MODE_ONE_WIDTH
, /* only one width is supported */
108 MODE_ONE_HEIGHT
, /* only one height is supported */
109 MODE_ONE_SIZE
, /* only one resolution is supported */
110 MODE_NO_REDUCED
, /* monitor doesn't accept reduced blanking */
111 MODE_NO_STEREO
, /* stereo modes not supported */
112 MODE_UNVERIFIED
= -3, /* mode needs to reverified */
113 MODE_BAD
= -2, /* unspecified reason */
114 MODE_ERROR
= -1 /* error condition */
117 #define DRM_MODE_TYPE_CLOCK_CRTC_C (DRM_MODE_TYPE_CLOCK_C | \
118 DRM_MODE_TYPE_CRTC_C)
120 #define DRM_MODE(nm, t, c, hd, hss, hse, ht, hsk, vd, vss, vse, vt, vs, f) \
121 .name = nm, .status = 0, .type = (t), .clock = (c), \
122 .hdisplay = (hd), .hsync_start = (hss), .hsync_end = (hse), \
123 .htotal = (ht), .hskew = (hsk), .vdisplay = (vd), \
124 .vsync_start = (vss), .vsync_end = (vse), .vtotal = (vt), \
125 .vscan = (vs), .flags = (f), \
126 .base.type = DRM_MODE_OBJECT_MODE
128 #define CRTC_INTERLACE_HALVE_V 0x1 /* halve V values for interlacing */
130 struct drm_display_mode
{
132 struct list_head head
;
133 struct drm_mode_object base
;
135 char name
[DRM_DISPLAY_MODE_LEN
];
137 enum drm_mode_status status
;
140 /* Proposed mode values */
141 int clock
; /* in kHz */
154 /* Addressable image size (may be 0 for projectors, etc.) */
158 /* Actual mode we give to hw */
159 int crtc_clock
; /* in KHz */
161 int crtc_hblank_start
;
163 int crtc_hsync_start
;
168 int crtc_vblank_start
;
170 int crtc_vsync_start
;
174 /* Driver private mode info */
179 int vrefresh
; /* in Hz */
180 int hsync
; /* in kHz */
183 #define DRM_MODE_FLAG_3D_MASK (DRM_MODE_FLAG_3D_FRAME_PACKING | \
184 DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE | \
185 DRM_MODE_FLAG_3D_LINE_ALTERNATIVE | \
186 DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL | \
187 DRM_MODE_FLAG_3D_L_DEPTH | \
188 DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH | \
189 DRM_MODE_FLAG_3D_TOP_AND_BOTTOM | \
190 DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF)
192 static inline bool drm_mode_is_stereo(const struct drm_display_mode
*mode
)
194 return mode
->flags
& DRM_MODE_FLAG_3D_MASK
;
197 enum drm_connector_status
{
198 connector_status_connected
= 1,
199 connector_status_disconnected
= 2,
200 connector_status_unknown
= 3,
203 enum subpixel_order
{
205 SubPixelHorizontalRGB
,
206 SubPixelHorizontalBGR
,
212 #define DRM_COLOR_FORMAT_RGB444 (1<<0)
213 #define DRM_COLOR_FORMAT_YCRCB444 (1<<1)
214 #define DRM_COLOR_FORMAT_YCRCB422 (1<<2)
216 * Describes a given display (e.g. CRT or flat panel) and its limitations.
218 struct drm_display_info
{
219 char name
[DRM_DISPLAY_INFO_LEN
];
222 unsigned int width_mm
;
223 unsigned int height_mm
;
225 /* Clock limits FIXME: storage format */
226 unsigned int min_vfreq
, max_vfreq
;
227 unsigned int min_hfreq
, max_hfreq
;
228 unsigned int pixel_clock
;
231 enum subpixel_order subpixel_order
;
237 struct drm_framebuffer_funcs
{
238 /* note: use drm_framebuffer_remove() */
239 void (*destroy
)(struct drm_framebuffer
*framebuffer
);
240 int (*create_handle
)(struct drm_framebuffer
*fb
,
241 struct drm_file
*file_priv
,
242 unsigned int *handle
);
244 * Optinal callback for the dirty fb ioctl.
246 * Userspace can notify the driver via this callback
247 * that a area of the framebuffer has changed and should
248 * be flushed to the display hardware.
250 * See documentation in drm_mode.h for the struct
251 * drm_mode_fb_dirty_cmd for more information as all
252 * the semantics and arguments have a one to one mapping
255 int (*dirty
)(struct drm_framebuffer
*framebuffer
,
256 struct drm_file
*file_priv
, unsigned flags
,
257 unsigned color
, struct drm_clip_rect
*clips
,
261 struct drm_framebuffer
{
262 struct drm_device
*dev
;
264 * Note that the fb is refcounted for the benefit of driver internals,
265 * for example some hw, disabling a CRTC/plane is asynchronous, and
266 * scanout does not actually complete until the next vblank. So some
267 * cleanup (like releasing the reference(s) on the backing GEM bo(s))
268 * should be deferred. In cases like this, the driver would like to
269 * hold a ref to the fb even though it has already been removed from
270 * userspace perspective.
272 struct kref refcount
;
274 * Place on the dev->mode_config.fb_list, access protected by
275 * dev->mode_config.fb_lock.
277 struct list_head head
;
278 struct drm_mode_object base
;
279 const struct drm_framebuffer_funcs
*funcs
;
280 unsigned int pitches
[4];
281 unsigned int offsets
[4];
284 /* depth can be 15 or 16 */
288 uint32_t pixel_format
; /* fourcc format */
289 struct list_head filp_head
;
290 /* if you are using the helper */
291 void *helper_private
;
294 struct drm_property_blob
{
295 struct drm_mode_object base
;
296 struct list_head head
;
298 unsigned char data
[];
301 struct drm_property_enum
{
303 struct list_head head
;
304 char name
[DRM_PROP_NAME_LEN
];
307 struct drm_property
{
308 struct list_head head
;
309 struct drm_mode_object base
;
311 char name
[DRM_PROP_NAME_LEN
];
315 struct list_head enum_blob_list
;
319 struct drm_connector
;
321 struct drm_pending_vblank_event
;
326 * drm_crtc_funcs - control CRTCs for a given device
327 * @save: save CRTC state
328 * @restore: restore CRTC state
329 * @reset: reset CRTC after state has been invalidated (e.g. resume)
330 * @cursor_set: setup the cursor
331 * @cursor_move: move the cursor
332 * @gamma_set: specify color ramp for CRTC
333 * @destroy: deinit and free object
334 * @set_property: called when a property is changed
335 * @set_config: apply a new CRTC configuration
336 * @page_flip: initiate a page flip
338 * The drm_crtc_funcs structure is the central CRTC management structure
339 * in the DRM. Each CRTC controls one or more connectors (note that the name
340 * CRTC is simply historical, a CRTC may control LVDS, VGA, DVI, TV out, etc.
341 * connectors, not just CRTs).
343 * Each driver is responsible for filling out this structure at startup time,
344 * in addition to providing other modesetting features, like i2c and DDC
347 struct drm_crtc_funcs
{
348 /* Save CRTC state */
349 void (*save
)(struct drm_crtc
*crtc
); /* suspend? */
350 /* Restore CRTC state */
351 void (*restore
)(struct drm_crtc
*crtc
); /* resume? */
352 /* Reset CRTC state */
353 void (*reset
)(struct drm_crtc
*crtc
);
355 /* cursor controls */
356 int (*cursor_set
)(struct drm_crtc
*crtc
, struct drm_file
*file_priv
,
357 uint32_t handle
, uint32_t width
, uint32_t height
);
358 int (*cursor_set2
)(struct drm_crtc
*crtc
, struct drm_file
*file_priv
,
359 uint32_t handle
, uint32_t width
, uint32_t height
,
360 int32_t hot_x
, int32_t hot_y
);
361 int (*cursor_move
)(struct drm_crtc
*crtc
, int x
, int y
);
363 /* Set gamma on the CRTC */
364 void (*gamma_set
)(struct drm_crtc
*crtc
, u16
*r
, u16
*g
, u16
*b
,
365 uint32_t start
, uint32_t size
);
366 /* Object destroy routine */
367 void (*destroy
)(struct drm_crtc
*crtc
);
369 int (*set_config
)(struct drm_mode_set
*set
);
372 * Flip to the given framebuffer. This implements the page
373 * flip ioctl described in drm_mode.h, specifically, the
374 * implementation must return immediately and block all
375 * rendering to the current fb until the flip has completed.
376 * If userspace set the event flag in the ioctl, the event
377 * argument will point to an event to send back when the flip
378 * completes, otherwise it will be NULL.
380 int (*page_flip
)(struct drm_crtc
*crtc
,
381 struct drm_framebuffer
*fb
,
382 struct drm_pending_vblank_event
*event
,
385 int (*set_property
)(struct drm_crtc
*crtc
,
386 struct drm_property
*property
, uint64_t val
);
390 * drm_crtc - central CRTC control structure
391 * @dev: parent DRM device
392 * @head: list management
393 * @base: base KMS object for ID tracking etc.
394 * @enabled: is this CRTC enabled?
395 * @mode: current mode timings
396 * @hwmode: mode timings as programmed to hw regs
397 * @invert_dimensions: for purposes of error checking crtc vs fb sizes,
398 * invert the width/height of the crtc. This is used if the driver
399 * is performing 90 or 270 degree rotated scanout
400 * @x: x position on screen
401 * @y: y position on screen
402 * @funcs: CRTC control functions
403 * @gamma_size: size of gamma ramp
404 * @gamma_store: gamma ramp values
405 * @framedur_ns: precise frame timing
406 * @framedur_ns: precise line timing
407 * @pixeldur_ns: precise pixel timing
408 * @helper_private: mid-layer private data
409 * @properties: property tracking for this CRTC
411 * Each CRTC may have one or more connectors associated with it. This structure
412 * allows the CRTC to be controlled.
415 struct drm_device
*dev
;
416 struct list_head head
;
421 * This provides a read lock for the overall crtc state (mode, dpms
422 * state, ...) and a write lock for everything which can be update
423 * without a full modeset (fb, cursor data, ...)
427 struct drm_mode_object base
;
429 /* framebuffer the connector is currently bound to */
430 struct drm_framebuffer
*fb
;
432 /* Temporary tracking of the old fb while a modeset is ongoing. Used
433 * by drm_mode_set_config_internal to implement correct refcounting. */
434 struct drm_framebuffer
*old_fb
;
438 /* Requested mode from modesetting. */
439 struct drm_display_mode mode
;
441 /* Programmed mode in hw, after adjustments for encoders,
442 * crtc, panel scaling etc. Needed for timestamping etc.
444 struct drm_display_mode hwmode
;
446 bool invert_dimensions
;
449 const struct drm_crtc_funcs
*funcs
;
451 /* CRTC gamma size for reporting to userspace */
453 uint16_t *gamma_store
;
455 /* Constants needed for precise vblank and swap timestamping. */
456 s64 framedur_ns
, linedur_ns
, pixeldur_ns
;
458 /* if you are using the helper */
459 void *helper_private
;
461 struct drm_object_properties properties
;
466 * drm_connector_funcs - control connectors on a given device
467 * @dpms: set power state (see drm_crtc_funcs above)
468 * @save: save connector state
469 * @restore: restore connector state
470 * @reset: reset connector after state has been invalidated (e.g. resume)
471 * @detect: is this connector active?
472 * @fill_modes: fill mode list for this connector
473 * @set_property: property for this connector may need an update
474 * @destroy: make object go away
475 * @force: notify the driver that the connector is forced on
477 * Each CRTC may have one or more connectors attached to it. The functions
478 * below allow the core DRM code to control connectors, enumerate available modes,
481 struct drm_connector_funcs
{
482 void (*dpms
)(struct drm_connector
*connector
, int mode
);
483 void (*save
)(struct drm_connector
*connector
);
484 void (*restore
)(struct drm_connector
*connector
);
485 void (*reset
)(struct drm_connector
*connector
);
487 /* Check to see if anything is attached to the connector.
488 * @force is set to false whilst polling, true when checking the
489 * connector due to user request. @force can be used by the driver
490 * to avoid expensive, destructive operations during automated
493 enum drm_connector_status (*detect
)(struct drm_connector
*connector
,
495 int (*fill_modes
)(struct drm_connector
*connector
, uint32_t max_width
, uint32_t max_height
);
496 int (*set_property
)(struct drm_connector
*connector
, struct drm_property
*property
,
498 void (*destroy
)(struct drm_connector
*connector
);
499 void (*force
)(struct drm_connector
*connector
);
503 * drm_encoder_funcs - encoder controls
504 * @reset: reset state (e.g. at init or resume time)
505 * @destroy: cleanup and free associated data
507 * Encoders sit between CRTCs and connectors.
509 struct drm_encoder_funcs
{
510 void (*reset
)(struct drm_encoder
*encoder
);
511 void (*destroy
)(struct drm_encoder
*encoder
);
514 #define DRM_CONNECTOR_MAX_ENCODER 3
517 * drm_encoder - central DRM encoder structure
518 * @dev: parent DRM device
519 * @head: list management
520 * @base: base KMS object
521 * @encoder_type: one of the %DRM_MODE_ENCODER_<foo> types in drm_mode.h
522 * @possible_crtcs: bitmask of potential CRTC bindings
523 * @possible_clones: bitmask of potential sibling encoders for cloning
524 * @crtc: currently bound CRTC
525 * @bridge: bridge associated to the encoder
526 * @funcs: control functions
527 * @helper_private: mid-layer private data
529 * CRTCs drive pixels to encoders, which convert them into signals
530 * appropriate for a given connector or set of connectors.
533 struct drm_device
*dev
;
534 struct list_head head
;
536 struct drm_mode_object base
;
538 uint32_t possible_crtcs
;
539 uint32_t possible_clones
;
541 struct drm_crtc
*crtc
;
542 struct drm_bridge
*bridge
;
543 const struct drm_encoder_funcs
*funcs
;
544 void *helper_private
;
547 enum drm_connector_force
{
548 DRM_FORCE_UNSPECIFIED
,
550 DRM_FORCE_ON
, /* force on analog part normally */
551 DRM_FORCE_ON_DIGITAL
, /* for DVI-I use digital connector */
554 /* should we poll this connector for connects and disconnects */
555 /* hot plug detectable */
556 #define DRM_CONNECTOR_POLL_HPD (1 << 0)
557 /* poll for connections */
558 #define DRM_CONNECTOR_POLL_CONNECT (1 << 1)
559 /* can cleanly poll for disconnections without flickering the screen */
560 /* DACs should rarely do this without a lot of testing */
561 #define DRM_CONNECTOR_POLL_DISCONNECT (1 << 2)
563 #define MAX_ELD_BYTES 128
566 * drm_connector - central DRM connector control structure
567 * @dev: parent DRM device
568 * @kdev: kernel device for sysfs attributes
569 * @attr: sysfs attributes
570 * @head: list management
571 * @base: base KMS object
572 * @connector_type: one of the %DRM_MODE_CONNECTOR_<foo> types from drm_mode.h
573 * @connector_type_id: index into connector type enum
574 * @interlace_allowed: can this connector handle interlaced modes?
575 * @doublescan_allowed: can this connector handle doublescan?
576 * @modes: modes available on this connector (from fill_modes() + user)
577 * @status: one of the drm_connector_status enums (connected, not, or unknown)
578 * @probed_modes: list of modes derived directly from the display
579 * @display_info: information about attached display (e.g. from EDID)
580 * @funcs: connector control functions
581 * @edid_blob_ptr: DRM property containing EDID if present
582 * @properties: property tracking for this connector
583 * @polled: a %DRM_CONNECTOR_POLL_<foo> value for core driven polling
584 * @dpms: current dpms state
585 * @helper_private: mid-layer private data
586 * @force: a %DRM_FORCE_<foo> state for forced mode sets
587 * @encoder_ids: valid encoders for this connector
588 * @encoder: encoder driving this connector, if any
589 * @eld: EDID-like data, if present
590 * @dvi_dual: dual link DVI, if found
591 * @max_tmds_clock: max clock rate, if found
592 * @latency_present: AV delay info from ELD, if found
593 * @video_latency: video latency info from ELD, if found
594 * @audio_latency: audio latency info from ELD, if found
595 * @null_edid_counter: track sinks that give us all zeros for the EDID
597 * Each connector may be connected to one or more CRTCs, or may be clonable by
598 * another connector if they can share a CRTC. Each connector also has a specific
599 * position in the broader display (referred to as a 'screen' though it could
600 * span multiple monitors).
602 struct drm_connector
{
603 struct drm_device
*dev
;
605 struct device_attribute
*attr
;
606 struct list_head head
;
608 struct drm_mode_object base
;
611 int connector_type_id
;
612 bool interlace_allowed
;
613 bool doublescan_allowed
;
615 struct list_head modes
; /* list of modes on this connector */
617 enum drm_connector_status status
;
619 /* these are modes added by probing with DDC or the BIOS */
620 struct list_head probed_modes
;
622 struct drm_display_info display_info
;
623 const struct drm_connector_funcs
*funcs
;
625 struct drm_property_blob
*edid_blob_ptr
;
626 struct drm_object_properties properties
;
628 uint8_t polled
; /* DRM_CONNECTOR_POLL_* */
630 /* requested DPMS state */
633 void *helper_private
;
635 /* forced on connector */
636 enum drm_connector_force force
;
637 uint32_t encoder_ids
[DRM_CONNECTOR_MAX_ENCODER
];
638 struct drm_encoder
*encoder
; /* currently active encoder */
641 uint8_t eld
[MAX_ELD_BYTES
];
643 int max_tmds_clock
; /* in MHz */
644 bool latency_present
[2];
645 int video_latency
[2]; /* [0]: progressive, [1]: interlaced */
646 int audio_latency
[2];
647 int null_edid_counter
; /* needed to workaround some HW bugs where we get all 0s */
648 unsigned bad_edid_counter
;
652 * drm_plane_funcs - driver plane control functions
653 * @update_plane: update the plane configuration
654 * @disable_plane: shut down the plane
655 * @destroy: clean up plane resources
656 * @set_property: called when a property is changed
658 struct drm_plane_funcs
{
659 int (*update_plane
)(struct drm_plane
*plane
,
660 struct drm_crtc
*crtc
, struct drm_framebuffer
*fb
,
661 int crtc_x
, int crtc_y
,
662 unsigned int crtc_w
, unsigned int crtc_h
,
663 uint32_t src_x
, uint32_t src_y
,
664 uint32_t src_w
, uint32_t src_h
);
665 int (*disable_plane
)(struct drm_plane
*plane
);
666 void (*destroy
)(struct drm_plane
*plane
);
668 int (*set_property
)(struct drm_plane
*plane
,
669 struct drm_property
*property
, uint64_t val
);
673 * drm_plane - central DRM plane control structure
674 * @dev: DRM device this plane belongs to
675 * @head: for list management
676 * @base: base mode object
677 * @possible_crtcs: pipes this plane can be bound to
678 * @format_types: array of formats supported by this plane
679 * @format_count: number of formats supported
680 * @crtc: currently bound CRTC
681 * @fb: currently bound fb
682 * @funcs: helper functions
683 * @properties: property tracking for this plane
686 struct drm_device
*dev
;
687 struct list_head head
;
689 struct drm_mode_object base
;
691 uint32_t possible_crtcs
;
692 uint32_t *format_types
;
693 uint32_t format_count
;
695 struct drm_crtc
*crtc
;
696 struct drm_framebuffer
*fb
;
698 const struct drm_plane_funcs
*funcs
;
700 struct drm_object_properties properties
;
704 * drm_bridge_funcs - drm_bridge control functions
705 * @mode_fixup: Try to fixup (or reject entirely) proposed mode for this bridge
706 * @disable: Called right before encoder prepare, disables the bridge
707 * @post_disable: Called right after encoder prepare, for lockstepped disable
708 * @mode_set: Set this mode to the bridge
709 * @pre_enable: Called right before encoder commit, for lockstepped commit
710 * @enable: Called right after encoder commit, enables the bridge
711 * @destroy: make object go away
713 struct drm_bridge_funcs
{
714 bool (*mode_fixup
)(struct drm_bridge
*bridge
,
715 const struct drm_display_mode
*mode
,
716 struct drm_display_mode
*adjusted_mode
);
717 void (*disable
)(struct drm_bridge
*bridge
);
718 void (*post_disable
)(struct drm_bridge
*bridge
);
719 void (*mode_set
)(struct drm_bridge
*bridge
,
720 struct drm_display_mode
*mode
,
721 struct drm_display_mode
*adjusted_mode
);
722 void (*pre_enable
)(struct drm_bridge
*bridge
);
723 void (*enable
)(struct drm_bridge
*bridge
);
724 void (*destroy
)(struct drm_bridge
*bridge
);
728 * drm_bridge - central DRM bridge control structure
729 * @dev: DRM device this bridge belongs to
730 * @head: list management
731 * @base: base mode object
732 * @funcs: control functions
733 * @driver_private: pointer to the bridge driver's internal context
736 struct drm_device
*dev
;
737 struct list_head head
;
739 struct drm_mode_object base
;
741 const struct drm_bridge_funcs
*funcs
;
742 void *driver_private
;
746 * drm_mode_set - new values for a CRTC config change
747 * @head: list management
748 * @fb: framebuffer to use for new config
749 * @crtc: CRTC whose configuration we're about to change
750 * @mode: mode timings to use
751 * @x: position of this CRTC relative to @fb
752 * @y: position of this CRTC relative to @fb
753 * @connectors: array of connectors to drive with this CRTC if possible
754 * @num_connectors: size of @connectors array
756 * Represents a single crtc the connectors that it drives with what mode
757 * and from which framebuffer it scans out from.
759 * This is used to set modes.
761 struct drm_mode_set
{
762 struct drm_framebuffer
*fb
;
763 struct drm_crtc
*crtc
;
764 struct drm_display_mode
*mode
;
769 struct drm_connector
**connectors
;
770 size_t num_connectors
;
774 * struct drm_mode_config_funcs - basic driver provided mode setting functions
775 * @fb_create: create a new framebuffer object
776 * @output_poll_changed: function to handle output configuration changes
778 * Some global (i.e. not per-CRTC, connector, etc) mode setting functions that
781 struct drm_mode_config_funcs
{
782 struct drm_framebuffer
*(*fb_create
)(struct drm_device
*dev
,
783 struct drm_file
*file_priv
,
784 struct drm_mode_fb_cmd2
*mode_cmd
);
785 void (*output_poll_changed
)(struct drm_device
*dev
);
789 * drm_mode_group - group of mode setting resources for potential sub-grouping
790 * @num_crtcs: CRTC count
791 * @num_encoders: encoder count
792 * @num_connectors: connector count
793 * @id_list: list of KMS object IDs in this group
795 * Currently this simply tracks the global mode setting state. But in the
796 * future it could allow groups of objects to be set aside into independent
797 * control groups for use by different user level processes (e.g. two X servers
798 * running simultaneously on different heads, each with their own mode
799 * configuration and freedom of mode setting).
801 struct drm_mode_group
{
803 uint32_t num_encoders
;
804 uint32_t num_connectors
;
805 uint32_t num_bridges
;
807 /* list of object IDs for this group */
812 * drm_mode_config - Mode configuration control structure
813 * @mutex: mutex protecting KMS related lists and structures
814 * @idr_mutex: mutex for KMS ID allocation and management
815 * @crtc_idr: main KMS ID tracking object
816 * @num_fb: number of fbs available
817 * @fb_list: list of framebuffers available
818 * @num_connector: number of connectors on this device
819 * @connector_list: list of connector objects
820 * @num_bridge: number of bridges on this device
821 * @bridge_list: list of bridge objects
822 * @num_encoder: number of encoders on this device
823 * @encoder_list: list of encoder objects
824 * @num_crtc: number of CRTCs on this device
825 * @crtc_list: list of CRTC objects
826 * @min_width: minimum pixel width on this device
827 * @min_height: minimum pixel height on this device
828 * @max_width: maximum pixel width on this device
829 * @max_height: maximum pixel height on this device
830 * @funcs: core driver provided mode setting functions
831 * @fb_base: base address of the framebuffer
832 * @poll_enabled: track polling status for this device
833 * @output_poll_work: delayed work for polling in process context
834 * @*_property: core property tracking
836 * Core mode resource tracking structure. All CRTC, encoders, and connectors
837 * enumerated by the driver are added here, as are global properties. Some
838 * global restrictions are also here, e.g. dimension restrictions.
840 struct drm_mode_config
{
841 struct mutex mutex
; /* protects configuration (mode lists etc.) */
842 struct mutex idr_mutex
; /* for IDR management */
843 struct idr crtc_idr
; /* use this idr for all IDs, fb, crtc, connector, modes - just makes life easier */
844 /* this is limited to one for now */
848 * fb_lock - mutex to protect fb state
850 * Besides the global fb list his also protects the fbs list in the
853 struct mutex fb_lock
;
855 struct list_head fb_list
;
858 struct list_head connector_list
;
860 struct list_head bridge_list
;
862 struct list_head encoder_list
;
864 struct list_head plane_list
;
867 struct list_head crtc_list
;
869 struct list_head property_list
;
871 int min_width
, min_height
;
872 int max_width
, max_height
;
873 const struct drm_mode_config_funcs
*funcs
;
874 resource_size_t fb_base
;
876 /* output poll support */
879 struct delayed_work output_poll_work
;
881 /* pointers to standard properties */
882 struct list_head property_blob_list
;
883 struct drm_property
*edid_property
;
884 struct drm_property
*dpms_property
;
886 /* DVI-I properties */
887 struct drm_property
*dvi_i_subconnector_property
;
888 struct drm_property
*dvi_i_select_subconnector_property
;
891 struct drm_property
*tv_subconnector_property
;
892 struct drm_property
*tv_select_subconnector_property
;
893 struct drm_property
*tv_mode_property
;
894 struct drm_property
*tv_left_margin_property
;
895 struct drm_property
*tv_right_margin_property
;
896 struct drm_property
*tv_top_margin_property
;
897 struct drm_property
*tv_bottom_margin_property
;
898 struct drm_property
*tv_brightness_property
;
899 struct drm_property
*tv_contrast_property
;
900 struct drm_property
*tv_flicker_reduction_property
;
901 struct drm_property
*tv_overscan_property
;
902 struct drm_property
*tv_saturation_property
;
903 struct drm_property
*tv_hue_property
;
905 /* Optional properties */
906 struct drm_property
*scaling_mode_property
;
907 struct drm_property
*dirty_info_property
;
909 /* dumb ioctl parameters */
910 uint32_t preferred_depth
, prefer_shadow
;
912 /* whether async page flip is supported or not */
913 bool async_page_flip
;
916 #define obj_to_crtc(x) container_of(x, struct drm_crtc, base)
917 #define obj_to_connector(x) container_of(x, struct drm_connector, base)
918 #define obj_to_encoder(x) container_of(x, struct drm_encoder, base)
919 #define obj_to_mode(x) container_of(x, struct drm_display_mode, base)
920 #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base)
921 #define obj_to_property(x) container_of(x, struct drm_property, base)
922 #define obj_to_blob(x) container_of(x, struct drm_property_blob, base)
923 #define obj_to_plane(x) container_of(x, struct drm_plane, base)
925 struct drm_prop_enum_list
{
930 extern void drm_modeset_lock_all(struct drm_device
*dev
);
931 extern void drm_modeset_unlock_all(struct drm_device
*dev
);
932 extern void drm_warn_on_modeset_not_all_locked(struct drm_device
*dev
);
934 extern int drm_crtc_init(struct drm_device
*dev
,
935 struct drm_crtc
*crtc
,
936 const struct drm_crtc_funcs
*funcs
);
937 extern void drm_crtc_cleanup(struct drm_crtc
*crtc
);
939 extern void drm_connector_ida_init(void);
940 extern void drm_connector_ida_destroy(void);
941 extern int drm_connector_init(struct drm_device
*dev
,
942 struct drm_connector
*connector
,
943 const struct drm_connector_funcs
*funcs
,
946 extern void drm_connector_cleanup(struct drm_connector
*connector
);
947 /* helper to unplug all connectors from sysfs for device */
948 extern void drm_connector_unplug_all(struct drm_device
*dev
);
950 extern int drm_bridge_init(struct drm_device
*dev
, struct drm_bridge
*bridge
,
951 const struct drm_bridge_funcs
*funcs
);
952 extern void drm_bridge_cleanup(struct drm_bridge
*bridge
);
954 extern int drm_encoder_init(struct drm_device
*dev
,
955 struct drm_encoder
*encoder
,
956 const struct drm_encoder_funcs
*funcs
,
959 extern int drm_plane_init(struct drm_device
*dev
,
960 struct drm_plane
*plane
,
961 unsigned long possible_crtcs
,
962 const struct drm_plane_funcs
*funcs
,
963 const uint32_t *formats
, uint32_t format_count
,
965 extern void drm_plane_cleanup(struct drm_plane
*plane
);
966 extern void drm_plane_force_disable(struct drm_plane
*plane
);
968 extern void drm_encoder_cleanup(struct drm_encoder
*encoder
);
970 extern const char *drm_get_connector_name(const struct drm_connector
*connector
);
971 extern const char *drm_get_connector_status_name(enum drm_connector_status status
);
972 extern const char *drm_get_dpms_name(int val
);
973 extern const char *drm_get_dvi_i_subconnector_name(int val
);
974 extern const char *drm_get_dvi_i_select_name(int val
);
975 extern const char *drm_get_tv_subconnector_name(int val
);
976 extern const char *drm_get_tv_select_name(int val
);
977 extern void drm_fb_release(struct drm_file
*file_priv
);
978 extern int drm_mode_group_init_legacy_group(struct drm_device
*dev
, struct drm_mode_group
*group
);
979 extern bool drm_probe_ddc(struct i2c_adapter
*adapter
);
980 extern struct edid
*drm_get_edid(struct drm_connector
*connector
,
981 struct i2c_adapter
*adapter
);
982 extern int drm_add_edid_modes(struct drm_connector
*connector
, struct edid
*edid
);
983 extern void drm_mode_probed_add(struct drm_connector
*connector
, struct drm_display_mode
*mode
);
984 extern void drm_mode_copy(struct drm_display_mode
*dst
, const struct drm_display_mode
*src
);
985 extern struct drm_display_mode
*drm_mode_duplicate(struct drm_device
*dev
,
986 const struct drm_display_mode
*mode
);
987 extern void drm_mode_debug_printmodeline(const struct drm_display_mode
*mode
);
988 extern void drm_mode_config_init(struct drm_device
*dev
);
989 extern void drm_mode_config_reset(struct drm_device
*dev
);
990 extern void drm_mode_config_cleanup(struct drm_device
*dev
);
991 extern void drm_mode_set_name(struct drm_display_mode
*mode
);
992 extern bool drm_mode_equal(const struct drm_display_mode
*mode1
, const struct drm_display_mode
*mode2
);
993 extern bool drm_mode_equal_no_clocks_no_stereo(const struct drm_display_mode
*mode1
, const struct drm_display_mode
*mode2
);
994 extern int drm_mode_width(const struct drm_display_mode
*mode
);
995 extern int drm_mode_height(const struct drm_display_mode
*mode
);
997 /* for us by fb module */
998 extern struct drm_display_mode
*drm_mode_create(struct drm_device
*dev
);
999 extern void drm_mode_destroy(struct drm_device
*dev
, struct drm_display_mode
*mode
);
1000 extern void drm_mode_validate_size(struct drm_device
*dev
,
1001 struct list_head
*mode_list
,
1002 int maxX
, int maxY
, int maxPitch
);
1003 extern void drm_mode_prune_invalid(struct drm_device
*dev
,
1004 struct list_head
*mode_list
, bool verbose
);
1005 extern void drm_mode_sort(struct list_head
*mode_list
);
1006 extern int drm_mode_hsync(const struct drm_display_mode
*mode
);
1007 extern int drm_mode_vrefresh(const struct drm_display_mode
*mode
);
1008 extern void drm_mode_set_crtcinfo(struct drm_display_mode
*p
,
1010 extern void drm_mode_connector_list_update(struct drm_connector
*connector
);
1011 extern int drm_mode_connector_update_edid_property(struct drm_connector
*connector
,
1013 extern int drm_object_property_set_value(struct drm_mode_object
*obj
,
1014 struct drm_property
*property
,
1016 extern int drm_object_property_get_value(struct drm_mode_object
*obj
,
1017 struct drm_property
*property
,
1019 extern int drm_framebuffer_init(struct drm_device
*dev
,
1020 struct drm_framebuffer
*fb
,
1021 const struct drm_framebuffer_funcs
*funcs
);
1022 extern struct drm_framebuffer
*drm_framebuffer_lookup(struct drm_device
*dev
,
1024 extern void drm_framebuffer_unreference(struct drm_framebuffer
*fb
);
1025 extern void drm_framebuffer_reference(struct drm_framebuffer
*fb
);
1026 extern void drm_framebuffer_remove(struct drm_framebuffer
*fb
);
1027 extern void drm_framebuffer_cleanup(struct drm_framebuffer
*fb
);
1028 extern void drm_framebuffer_unregister_private(struct drm_framebuffer
*fb
);
1030 extern void drm_object_attach_property(struct drm_mode_object
*obj
,
1031 struct drm_property
*property
,
1033 extern struct drm_property
*drm_property_create(struct drm_device
*dev
, int flags
,
1034 const char *name
, int num_values
);
1035 extern struct drm_property
*drm_property_create_enum(struct drm_device
*dev
, int flags
,
1037 const struct drm_prop_enum_list
*props
,
1039 struct drm_property
*drm_property_create_bitmask(struct drm_device
*dev
,
1040 int flags
, const char *name
,
1041 const struct drm_prop_enum_list
*props
,
1043 struct drm_property
*drm_property_create_range(struct drm_device
*dev
, int flags
,
1045 uint64_t min
, uint64_t max
);
1046 extern void drm_property_destroy(struct drm_device
*dev
, struct drm_property
*property
);
1047 extern int drm_property_add_enum(struct drm_property
*property
, int index
,
1048 uint64_t value
, const char *name
);
1049 extern int drm_mode_create_dvi_i_properties(struct drm_device
*dev
);
1050 extern int drm_mode_create_tv_properties(struct drm_device
*dev
, int num_formats
,
1052 extern int drm_mode_create_scaling_mode_property(struct drm_device
*dev
);
1053 extern int drm_mode_create_dirty_info_property(struct drm_device
*dev
);
1054 extern const char *drm_get_encoder_name(const struct drm_encoder
*encoder
);
1056 extern int drm_mode_connector_attach_encoder(struct drm_connector
*connector
,
1057 struct drm_encoder
*encoder
);
1058 extern void drm_mode_connector_detach_encoder(struct drm_connector
*connector
,
1059 struct drm_encoder
*encoder
);
1060 extern int drm_mode_crtc_set_gamma_size(struct drm_crtc
*crtc
,
1062 extern struct drm_mode_object
*drm_mode_object_find(struct drm_device
*dev
,
1063 uint32_t id
, uint32_t type
);
1065 extern int drm_mode_getresources(struct drm_device
*dev
,
1066 void *data
, struct drm_file
*file_priv
);
1067 extern int drm_mode_getplane_res(struct drm_device
*dev
, void *data
,
1068 struct drm_file
*file_priv
);
1069 extern int drm_mode_getcrtc(struct drm_device
*dev
,
1070 void *data
, struct drm_file
*file_priv
);
1071 extern int drm_mode_getconnector(struct drm_device
*dev
,
1072 void *data
, struct drm_file
*file_priv
);
1073 extern int drm_mode_set_config_internal(struct drm_mode_set
*set
);
1074 extern int drm_mode_setcrtc(struct drm_device
*dev
,
1075 void *data
, struct drm_file
*file_priv
);
1076 extern int drm_mode_getplane(struct drm_device
*dev
,
1077 void *data
, struct drm_file
*file_priv
);
1078 extern int drm_mode_setplane(struct drm_device
*dev
,
1079 void *data
, struct drm_file
*file_priv
);
1080 extern int drm_mode_cursor_ioctl(struct drm_device
*dev
,
1081 void *data
, struct drm_file
*file_priv
);
1082 extern int drm_mode_cursor2_ioctl(struct drm_device
*dev
,
1083 void *data
, struct drm_file
*file_priv
);
1084 extern int drm_mode_addfb(struct drm_device
*dev
,
1085 void *data
, struct drm_file
*file_priv
);
1086 extern int drm_mode_addfb2(struct drm_device
*dev
,
1087 void *data
, struct drm_file
*file_priv
);
1088 extern uint32_t drm_mode_legacy_fb_format(uint32_t bpp
, uint32_t depth
);
1089 extern int drm_mode_rmfb(struct drm_device
*dev
,
1090 void *data
, struct drm_file
*file_priv
);
1091 extern int drm_mode_getfb(struct drm_device
*dev
,
1092 void *data
, struct drm_file
*file_priv
);
1093 extern int drm_mode_dirtyfb_ioctl(struct drm_device
*dev
,
1094 void *data
, struct drm_file
*file_priv
);
1096 extern int drm_mode_getproperty_ioctl(struct drm_device
*dev
,
1097 void *data
, struct drm_file
*file_priv
);
1098 extern int drm_mode_getblob_ioctl(struct drm_device
*dev
,
1099 void *data
, struct drm_file
*file_priv
);
1100 extern int drm_mode_connector_property_set_ioctl(struct drm_device
*dev
,
1101 void *data
, struct drm_file
*file_priv
);
1102 extern int drm_mode_getencoder(struct drm_device
*dev
,
1103 void *data
, struct drm_file
*file_priv
);
1104 extern int drm_mode_gamma_get_ioctl(struct drm_device
*dev
,
1105 void *data
, struct drm_file
*file_priv
);
1106 extern int drm_mode_gamma_set_ioctl(struct drm_device
*dev
,
1107 void *data
, struct drm_file
*file_priv
);
1108 extern u8
drm_match_cea_mode(const struct drm_display_mode
*to_match
);
1109 extern bool drm_detect_hdmi_monitor(struct edid
*edid
);
1110 extern bool drm_detect_monitor_audio(struct edid
*edid
);
1111 extern bool drm_rgb_quant_range_selectable(struct edid
*edid
);
1112 extern int drm_mode_page_flip_ioctl(struct drm_device
*dev
,
1113 void *data
, struct drm_file
*file_priv
);
1114 extern struct drm_display_mode
*drm_cvt_mode(struct drm_device
*dev
,
1115 int hdisplay
, int vdisplay
, int vrefresh
,
1116 bool reduced
, bool interlaced
, bool margins
);
1117 extern struct drm_display_mode
*drm_gtf_mode(struct drm_device
*dev
,
1118 int hdisplay
, int vdisplay
, int vrefresh
,
1119 bool interlaced
, int margins
);
1120 extern struct drm_display_mode
*drm_gtf_mode_complex(struct drm_device
*dev
,
1121 int hdisplay
, int vdisplay
, int vrefresh
,
1122 bool interlaced
, int margins
, int GTF_M
,
1123 int GTF_2C
, int GTF_K
, int GTF_2J
);
1124 extern int drm_add_modes_noedid(struct drm_connector
*connector
,
1125 int hdisplay
, int vdisplay
);
1127 extern int drm_edid_header_is_valid(const u8
*raw_edid
);
1128 extern bool drm_edid_block_valid(u8
*raw_edid
, int block
, bool print_bad_edid
);
1129 extern bool drm_edid_is_valid(struct edid
*edid
);
1130 struct drm_display_mode
*drm_mode_find_dmt(struct drm_device
*dev
,
1131 int hsize
, int vsize
, int fresh
,
1134 extern int drm_mode_create_dumb_ioctl(struct drm_device
*dev
,
1135 void *data
, struct drm_file
*file_priv
);
1136 extern int drm_mode_mmap_dumb_ioctl(struct drm_device
*dev
,
1137 void *data
, struct drm_file
*file_priv
);
1138 extern int drm_mode_destroy_dumb_ioctl(struct drm_device
*dev
,
1139 void *data
, struct drm_file
*file_priv
);
1140 extern int drm_mode_obj_get_properties_ioctl(struct drm_device
*dev
, void *data
,
1141 struct drm_file
*file_priv
);
1142 extern int drm_mode_obj_set_property_ioctl(struct drm_device
*dev
, void *data
,
1143 struct drm_file
*file_priv
);
1145 extern void drm_fb_get_bpp_depth(uint32_t format
, unsigned int *depth
,
1147 extern int drm_format_num_planes(uint32_t format
);
1148 extern int drm_format_plane_cpp(uint32_t format
, int plane
);
1149 extern int drm_format_horz_chroma_subsampling(uint32_t format
);
1150 extern int drm_format_vert_chroma_subsampling(uint32_t format
);
1151 extern const char *drm_get_format_name(uint32_t format
);
1153 #endif /* __DRM_CRTC_H__ */