2 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
3 * Copyright (c) 2007 Jakob Bornecrantz <wallbraker@gmail.com>
4 * Copyright (c) 2008 Red Hat Inc.
5 * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA
6 * Copyright (c) 2007-2008 Intel Corporation
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
32 #if defined(__cplusplus)
39 * DRM exposes many UAPI and structure definition to have a consistent
40 * and standardized interface with user.
41 * Userspace can refer to these structure definitions and UAPI formats
42 * to communicate to driver
45 #define DRM_CONNECTOR_NAME_LEN 32
46 #define DRM_DISPLAY_MODE_LEN 32
47 #define DRM_PROP_NAME_LEN 32
49 #define DRM_MODE_TYPE_BUILTIN (1<<0) /* deprecated */
50 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
51 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */
52 #define DRM_MODE_TYPE_PREFERRED (1<<3)
53 #define DRM_MODE_TYPE_DEFAULT (1<<4) /* deprecated */
54 #define DRM_MODE_TYPE_USERDEF (1<<5)
55 #define DRM_MODE_TYPE_DRIVER (1<<6)
57 #define DRM_MODE_TYPE_ALL (DRM_MODE_TYPE_PREFERRED | \
58 DRM_MODE_TYPE_USERDEF | \
61 /* Video mode flags */
62 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
64 * ABI warning: Existing userspace really expects
65 * the mode flags to match the xrandr definitions. Any
66 * changes that don't match the xrandr definitions will
67 * likely need a new client cap or some other mechanism
68 * to avoid breaking existing userspace. This includes
69 * allocating new flags in the previously unused bits!
71 #define DRM_MODE_FLAG_PHSYNC (1<<0)
72 #define DRM_MODE_FLAG_NHSYNC (1<<1)
73 #define DRM_MODE_FLAG_PVSYNC (1<<2)
74 #define DRM_MODE_FLAG_NVSYNC (1<<3)
75 #define DRM_MODE_FLAG_INTERLACE (1<<4)
76 #define DRM_MODE_FLAG_DBLSCAN (1<<5)
77 #define DRM_MODE_FLAG_CSYNC (1<<6)
78 #define DRM_MODE_FLAG_PCSYNC (1<<7)
79 #define DRM_MODE_FLAG_NCSYNC (1<<8)
80 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */
81 #define DRM_MODE_FLAG_BCAST (1<<10) /* deprecated */
82 #define DRM_MODE_FLAG_PIXMUX (1<<11) /* deprecated */
83 #define DRM_MODE_FLAG_DBLCLK (1<<12)
84 #define DRM_MODE_FLAG_CLKDIV2 (1<<13)
86 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
87 * (define not exposed to user space).
89 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14)
90 #define DRM_MODE_FLAG_3D_NONE (0<<14)
91 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14)
92 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14)
93 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14)
94 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14)
95 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14)
96 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
97 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14)
98 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14)
100 /* Picture aspect ratio options */
101 #define DRM_MODE_PICTURE_ASPECT_NONE 0
102 #define DRM_MODE_PICTURE_ASPECT_4_3 1
103 #define DRM_MODE_PICTURE_ASPECT_16_9 2
104 #define DRM_MODE_PICTURE_ASPECT_64_27 3
105 #define DRM_MODE_PICTURE_ASPECT_256_135 4
107 /* Content type options */
108 #define DRM_MODE_CONTENT_TYPE_NO_DATA 0
109 #define DRM_MODE_CONTENT_TYPE_GRAPHICS 1
110 #define DRM_MODE_CONTENT_TYPE_PHOTO 2
111 #define DRM_MODE_CONTENT_TYPE_CINEMA 3
112 #define DRM_MODE_CONTENT_TYPE_GAME 4
114 /* Aspect ratio flag bitmask (4 bits 22:19) */
115 #define DRM_MODE_FLAG_PIC_AR_MASK (0x0F<<19)
116 #define DRM_MODE_FLAG_PIC_AR_NONE \
117 (DRM_MODE_PICTURE_ASPECT_NONE<<19)
118 #define DRM_MODE_FLAG_PIC_AR_4_3 \
119 (DRM_MODE_PICTURE_ASPECT_4_3<<19)
120 #define DRM_MODE_FLAG_PIC_AR_16_9 \
121 (DRM_MODE_PICTURE_ASPECT_16_9<<19)
122 #define DRM_MODE_FLAG_PIC_AR_64_27 \
123 (DRM_MODE_PICTURE_ASPECT_64_27<<19)
124 #define DRM_MODE_FLAG_PIC_AR_256_135 \
125 (DRM_MODE_PICTURE_ASPECT_256_135<<19)
127 #define DRM_MODE_FLAG_ALL (DRM_MODE_FLAG_PHSYNC | \
128 DRM_MODE_FLAG_NHSYNC | \
129 DRM_MODE_FLAG_PVSYNC | \
130 DRM_MODE_FLAG_NVSYNC | \
131 DRM_MODE_FLAG_INTERLACE | \
132 DRM_MODE_FLAG_DBLSCAN | \
133 DRM_MODE_FLAG_CSYNC | \
134 DRM_MODE_FLAG_PCSYNC | \
135 DRM_MODE_FLAG_NCSYNC | \
136 DRM_MODE_FLAG_HSKEW | \
137 DRM_MODE_FLAG_DBLCLK | \
138 DRM_MODE_FLAG_CLKDIV2 | \
139 DRM_MODE_FLAG_3D_MASK)
142 /* bit compatible with the xorg definitions. */
143 #define DRM_MODE_DPMS_ON 0
144 #define DRM_MODE_DPMS_STANDBY 1
145 #define DRM_MODE_DPMS_SUSPEND 2
146 #define DRM_MODE_DPMS_OFF 3
148 /* Scaling mode options */
149 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or
150 software can still scale) */
151 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */
152 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */
153 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */
155 /* Dithering mode options */
156 #define DRM_MODE_DITHERING_OFF 0
157 #define DRM_MODE_DITHERING_ON 1
158 #define DRM_MODE_DITHERING_AUTO 2
160 /* Dirty info options */
161 #define DRM_MODE_DIRTY_OFF 0
162 #define DRM_MODE_DIRTY_ON 1
163 #define DRM_MODE_DIRTY_ANNOTATE 2
165 /* Link Status options */
166 #define DRM_MODE_LINK_STATUS_GOOD 0
167 #define DRM_MODE_LINK_STATUS_BAD 1
170 * DRM_MODE_ROTATE_<degrees>
172 * Signals that a drm plane is been rotated <degrees> degrees in counter
173 * clockwise direction.
175 * This define is provided as a convenience, looking up the property id
176 * using the name->prop id lookup is the preferred method.
178 #define DRM_MODE_ROTATE_0 (1<<0)
179 #define DRM_MODE_ROTATE_90 (1<<1)
180 #define DRM_MODE_ROTATE_180 (1<<2)
181 #define DRM_MODE_ROTATE_270 (1<<3)
184 * DRM_MODE_ROTATE_MASK
186 * Bitmask used to look for drm plane rotations.
188 #define DRM_MODE_ROTATE_MASK (\
189 DRM_MODE_ROTATE_0 | \
190 DRM_MODE_ROTATE_90 | \
191 DRM_MODE_ROTATE_180 | \
195 * DRM_MODE_REFLECT_<axis>
197 * Signals that the contents of a drm plane is reflected along the <axis> axis,
198 * in the same way as mirroring.
199 * See kerneldoc chapter "Plane Composition Properties" for more details.
201 * This define is provided as a convenience, looking up the property id
202 * using the name->prop id lookup is the preferred method.
204 #define DRM_MODE_REFLECT_X (1<<4)
205 #define DRM_MODE_REFLECT_Y (1<<5)
208 * DRM_MODE_REFLECT_MASK
210 * Bitmask used to look for drm plane reflections.
212 #define DRM_MODE_REFLECT_MASK (\
213 DRM_MODE_REFLECT_X | \
216 /* Content Protection Flags */
217 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED 0
218 #define DRM_MODE_CONTENT_PROTECTION_DESIRED 1
219 #define DRM_MODE_CONTENT_PROTECTION_ENABLED 2
222 * struct drm_mode_modeinfo - Display mode information.
223 * @clock: pixel clock in kHz
224 * @hdisplay: horizontal display size
225 * @hsync_start: horizontal sync start
226 * @hsync_end: horizontal sync end
227 * @htotal: horizontal total size
228 * @hskew: horizontal skew
229 * @vdisplay: vertical display size
230 * @vsync_start: vertical sync start
231 * @vsync_end: vertical sync end
232 * @vtotal: vertical total size
233 * @vscan: vertical scan
234 * @vrefresh: approximate vertical refresh rate in Hz
235 * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines
236 * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines
237 * @name: string describing the mode resolution
239 * This is the user-space API display mode information structure. For the
240 * kernel version see struct drm_display_mode.
242 struct drm_mode_modeinfo {
259 char name[DRM_DISPLAY_MODE_LEN];
262 struct drm_mode_card_res {
265 __u64 connector_id_ptr;
266 __u64 encoder_id_ptr;
269 __u32 count_connectors;
270 __u32 count_encoders;
277 struct drm_mode_crtc {
278 __u64 set_connectors_ptr;
279 __u32 count_connectors;
281 __u32 crtc_id; /**< Id */
282 __u32 fb_id; /**< Id of framebuffer */
284 __u32 x; /**< x Position on the framebuffer */
285 __u32 y; /**< y Position on the framebuffer */
289 struct drm_mode_modeinfo mode;
292 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0)
293 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1)
295 /* Planes blend with or override other bits on the CRTC */
296 struct drm_mode_set_plane {
299 __u32 fb_id; /* fb object contains surface format type */
300 __u32 flags; /* see above flags */
302 /* Signed dest location allows it to be partially off screen */
308 /* Source values are 16.16 fixed point */
315 struct drm_mode_get_plane {
321 __u32 possible_crtcs;
324 __u32 count_format_types;
325 __u64 format_type_ptr;
328 struct drm_mode_get_plane_res {
333 #define DRM_MODE_ENCODER_NONE 0
334 #define DRM_MODE_ENCODER_DAC 1
335 #define DRM_MODE_ENCODER_TMDS 2
336 #define DRM_MODE_ENCODER_LVDS 3
337 #define DRM_MODE_ENCODER_TVDAC 4
338 #define DRM_MODE_ENCODER_VIRTUAL 5
339 #define DRM_MODE_ENCODER_DSI 6
340 #define DRM_MODE_ENCODER_DPMST 7
341 #define DRM_MODE_ENCODER_DPI 8
343 struct drm_mode_get_encoder {
347 __u32 crtc_id; /**< Id of crtc */
349 __u32 possible_crtcs;
350 __u32 possible_clones;
353 /* This is for connectors with multiple signal types. */
354 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
355 enum drm_mode_subconnector {
356 DRM_MODE_SUBCONNECTOR_Automatic = 0, /* DVI-I, TV */
357 DRM_MODE_SUBCONNECTOR_Unknown = 0, /* DVI-I, TV, DP */
358 DRM_MODE_SUBCONNECTOR_VGA = 1, /* DP */
359 DRM_MODE_SUBCONNECTOR_DVID = 3, /* DVI-I DP */
360 DRM_MODE_SUBCONNECTOR_DVIA = 4, /* DVI-I */
361 DRM_MODE_SUBCONNECTOR_Composite = 5, /* TV */
362 DRM_MODE_SUBCONNECTOR_SVIDEO = 6, /* TV */
363 DRM_MODE_SUBCONNECTOR_Component = 8, /* TV */
364 DRM_MODE_SUBCONNECTOR_SCART = 9, /* TV */
365 DRM_MODE_SUBCONNECTOR_DisplayPort = 10, /* DP */
366 DRM_MODE_SUBCONNECTOR_HDMIA = 11, /* DP */
367 DRM_MODE_SUBCONNECTOR_Native = 15, /* DP */
368 DRM_MODE_SUBCONNECTOR_Wireless = 18, /* DP */
371 #define DRM_MODE_CONNECTOR_Unknown 0
372 #define DRM_MODE_CONNECTOR_VGA 1
373 #define DRM_MODE_CONNECTOR_DVII 2
374 #define DRM_MODE_CONNECTOR_DVID 3
375 #define DRM_MODE_CONNECTOR_DVIA 4
376 #define DRM_MODE_CONNECTOR_Composite 5
377 #define DRM_MODE_CONNECTOR_SVIDEO 6
378 #define DRM_MODE_CONNECTOR_LVDS 7
379 #define DRM_MODE_CONNECTOR_Component 8
380 #define DRM_MODE_CONNECTOR_9PinDIN 9
381 #define DRM_MODE_CONNECTOR_DisplayPort 10
382 #define DRM_MODE_CONNECTOR_HDMIA 11
383 #define DRM_MODE_CONNECTOR_HDMIB 12
384 #define DRM_MODE_CONNECTOR_TV 13
385 #define DRM_MODE_CONNECTOR_eDP 14
386 #define DRM_MODE_CONNECTOR_VIRTUAL 15
387 #define DRM_MODE_CONNECTOR_DSI 16
388 #define DRM_MODE_CONNECTOR_DPI 17
389 #define DRM_MODE_CONNECTOR_WRITEBACK 18
390 #define DRM_MODE_CONNECTOR_SPI 19
391 #define DRM_MODE_CONNECTOR_USB 20
394 * struct drm_mode_get_connector - Get connector metadata.
396 * User-space can perform a GETCONNECTOR ioctl to retrieve information about a
397 * connector. User-space is expected to retrieve encoders, modes and properties
398 * by performing this ioctl at least twice: the first time to retrieve the
399 * number of elements, the second time to retrieve the elements themselves.
401 * To retrieve the number of elements, set @count_props and @count_encoders to
402 * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct
403 * drm_mode_modeinfo element.
405 * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr,
406 * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and
407 * @count_encoders to their capacity.
409 * Performing the ioctl only twice may be racy: the number of elements may have
410 * changed with a hotplug event in-between the two ioctls. User-space is
411 * expected to retry the last ioctl until the number of elements stabilizes.
412 * The kernel won't fill any array which doesn't have the expected length.
414 * **Force-probing a connector**
416 * If the @count_modes field is set to zero, the kernel will perform a forced
417 * probe on the connector to refresh the connector status, modes and EDID.
418 * A forced-probe can be slow, might cause flickering and the ioctl will block.
420 * User-space needs to force-probe connectors to ensure their metadata is
421 * up-to-date at startup and after receiving a hot-plug event. User-space
422 * may perform a forced-probe when the user explicitly requests it. User-space
423 * shouldn't perform a forced-probe in other situations.
425 struct drm_mode_get_connector {
426 /** @encoders_ptr: Pointer to ``__u32`` array of object IDs. */
428 /** @modes_ptr: Pointer to struct drm_mode_modeinfo array. */
430 /** @props_ptr: Pointer to ``__u32`` array of property IDs. */
432 /** @prop_values_ptr: Pointer to ``__u64`` array of property values. */
433 __u64 prop_values_ptr;
435 /** @count_modes: Number of modes. */
437 /** @count_props: Number of properties. */
439 /** @count_encoders: Number of encoders. */
440 __u32 count_encoders;
442 /** @encoder_id: Object ID of the current encoder. */
444 /** @connector_id: Object ID of the connector. */
447 * @connector_type: Type of the connector.
449 * See DRM_MODE_CONNECTOR_* defines.
451 __u32 connector_type;
453 * @connector_type_id: Type-specific connector number.
455 * This is not an object ID. This is a per-type connector number. Each
456 * (type, type_id) combination is unique across all connectors of a DRM
459 __u32 connector_type_id;
462 * @connection: Status of the connector.
464 * See enum drm_connector_status.
467 /** @mm_width: Width of the connected sink in millimeters. */
469 /** @mm_height: Height of the connected sink in millimeters. */
472 * @subpixel: Subpixel order of the connected sink.
474 * See enum subpixel_order.
478 /** @pad: Padding, must be zero. */
482 #define DRM_MODE_PROP_PENDING (1<<0) /* deprecated, do not use */
483 #define DRM_MODE_PROP_RANGE (1<<1)
484 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
485 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */
486 #define DRM_MODE_PROP_BLOB (1<<4)
487 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */
489 /* non-extended types: legacy bitmask, one bit per type: */
490 #define DRM_MODE_PROP_LEGACY_TYPE ( \
491 DRM_MODE_PROP_RANGE | \
492 DRM_MODE_PROP_ENUM | \
493 DRM_MODE_PROP_BLOB | \
494 DRM_MODE_PROP_BITMASK)
496 /* extended-types: rather than continue to consume a bit per type,
497 * grab a chunk of the bits to use as integer type id.
499 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0
500 #define DRM_MODE_PROP_TYPE(n) ((n) << 6)
501 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1)
502 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2)
504 /* the PROP_ATOMIC flag is used to hide properties from userspace that
505 * is not aware of atomic properties. This is mostly to work around
506 * older userspace (DDX drivers) that read/write each prop they find,
507 * witout being aware that this could be triggering a lengthy modeset.
509 #define DRM_MODE_PROP_ATOMIC 0x80000000
511 struct drm_mode_property_enum {
513 char name[DRM_PROP_NAME_LEN];
516 struct drm_mode_get_property {
517 __u64 values_ptr; /* values and blob lengths */
518 __u64 enum_blob_ptr; /* enum and blob id ptrs */
522 char name[DRM_PROP_NAME_LEN];
525 /* This is only used to count enum values, not blobs. The _blobs is
526 * simply because of a historical reason, i.e. backwards compat. */
527 __u32 count_enum_blobs;
530 struct drm_mode_connector_set_property {
536 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
537 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
538 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
539 #define DRM_MODE_OBJECT_MODE 0xdededede
540 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
541 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
542 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
543 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
544 #define DRM_MODE_OBJECT_ANY 0
546 struct drm_mode_obj_get_properties {
548 __u64 prop_values_ptr;
554 struct drm_mode_obj_set_property {
561 struct drm_mode_get_blob {
567 struct drm_mode_fb_cmd {
574 /* driver specific handle */
578 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */
579 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */
581 struct drm_mode_fb_cmd2 {
585 __u32 pixel_format; /* fourcc code from drm_fourcc.h */
586 __u32 flags; /* see above flags */
589 * In case of planar formats, this ioctl allows up to 4
590 * buffer objects with offsets and pitches per plane.
591 * The pitch and offset order is dictated by the fourcc,
592 * e.g. NV12 (https://fourcc.org/yuv.php#NV12) is described as:
594 * YUV 4:2:0 image with a plane of 8 bit Y samples
595 * followed by an interleaved U/V plane containing
596 * 8 bit 2x2 subsampled colour difference samples.
598 * So it would consist of Y as offsets[0] and UV as
599 * offsets[1]. Note that offsets[0] will generally
600 * be 0 (but this is not required).
602 * To accommodate tiled, compressed, etc formats, a
603 * modifier can be specified. The default value of zero
604 * indicates "native" format as specified by the fourcc.
605 * Vendor specific modifier token. Note that even though
606 * it looks like we have a modifier per-plane, we in fact
607 * do not. The modifier for each plane must be identical.
608 * Thus all combinations of different data layouts for
609 * multi plane formats must be enumerated as separate
613 __u32 pitches[4]; /* pitch for each plane */
614 __u32 offsets[4]; /* offset of each plane */
615 __u64 modifier[4]; /* ie, tiling, compress */
618 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
619 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
620 #define DRM_MODE_FB_DIRTY_FLAGS 0x03
622 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256
625 * Mark a region of a framebuffer as dirty.
627 * Some hardware does not automatically update display contents
628 * as a hardware or software draw to a framebuffer. This ioctl
629 * allows userspace to tell the kernel and the hardware what
630 * regions of the framebuffer have changed.
632 * The kernel or hardware is free to update more then just the
633 * region specified by the clip rects. The kernel or hardware
634 * may also delay and/or coalesce several calls to dirty into a
637 * Userspace may annotate the updates, the annotates are a
638 * promise made by the caller that the change is either a copy
639 * of pixels or a fill of a single color in the region specified.
641 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
642 * the number of updated regions are half of num_clips given,
643 * where the clip rects are paired in src and dst. The width and
644 * height of each one of the pairs must match.
646 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
647 * promises that the region specified of the clip rects is filled
648 * completely with a single color as given in the color argument.
651 struct drm_mode_fb_dirty_cmd {
659 struct drm_mode_mode_cmd {
661 struct drm_mode_modeinfo mode;
664 #define DRM_MODE_CURSOR_BO 0x01
665 #define DRM_MODE_CURSOR_MOVE 0x02
666 #define DRM_MODE_CURSOR_FLAGS 0x03
669 * depending on the value in flags different members are used.
675 * handle - if 0 turns the cursor off
682 struct drm_mode_cursor {
689 /* driver specific handle */
693 struct drm_mode_cursor2 {
700 /* driver specific handle */
706 struct drm_mode_crtc_lut {
710 /* pointers to arrays */
716 struct drm_color_ctm {
718 * Conversion matrix in S31.32 sign-magnitude
719 * (not two's complement!) format.
724 struct drm_color_lut {
726 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
736 * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
738 * HDR Metadata Infoframe as per CTA 861.G spec. This is expected
739 * to match exactly with the spec.
741 * Userspace is expected to pass the metadata information as per
742 * the format described in this structure.
744 struct hdr_metadata_infoframe {
746 * @eotf: Electro-Optical Transfer Function (EOTF)
747 * used in the stream.
751 * @metadata_type: Static_Metadata_Descriptor_ID.
755 * @display_primaries: Color Primaries of the Data.
756 * These are coded as unsigned 16-bit values in units of
757 * 0.00002, where 0x0000 represents zero and 0xC350
759 * @display_primaries.x: X cordinate of color primary.
760 * @display_primaries.y: Y cordinate of color primary.
764 } display_primaries[3];
766 * @white_point: White Point of Colorspace Data.
767 * These are coded as unsigned 16-bit values in units of
768 * 0.00002, where 0x0000 represents zero and 0xC350
770 * @white_point.x: X cordinate of whitepoint of color primary.
771 * @white_point.y: Y cordinate of whitepoint of color primary.
777 * @max_display_mastering_luminance: Max Mastering Display Luminance.
778 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
779 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
781 __u16 max_display_mastering_luminance;
783 * @min_display_mastering_luminance: Min Mastering Display Luminance.
784 * This value is coded as an unsigned 16-bit value in units of
785 * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF
786 * represents 6.5535 cd/m2.
788 __u16 min_display_mastering_luminance;
790 * @max_cll: Max Content Light Level.
791 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
792 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
796 * @max_fall: Max Frame Average Light Level.
797 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
798 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
804 * struct hdr_output_metadata - HDR output metadata
806 * Metadata Information to be passed from userspace
808 struct hdr_output_metadata {
810 * @metadata_type: Static_Metadata_Descriptor_ID.
814 * @hdmi_metadata_type1: HDR Metadata Infoframe.
817 struct hdr_metadata_infoframe hdmi_metadata_type1;
821 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
822 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
823 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
824 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
825 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
826 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
827 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
828 DRM_MODE_PAGE_FLIP_ASYNC | \
829 DRM_MODE_PAGE_FLIP_TARGET)
832 * Request a page flip on the specified crtc.
834 * This ioctl will ask KMS to schedule a page flip for the specified
835 * crtc. Once any pending rendering targeting the specified fb (as of
836 * ioctl time) has completed, the crtc will be reprogrammed to display
837 * that fb after the next vertical refresh. The ioctl returns
838 * immediately, but subsequent rendering to the current fb will block
839 * in the execbuffer ioctl until the page flip happens. If a page
840 * flip is already pending as the ioctl is called, EBUSY will be
843 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
844 * event (see drm.h: struct drm_event_vblank) when the page flip is
845 * done. The user_data field passed in with this ioctl will be
846 * returned as the user_data field in the vblank event struct.
848 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
849 * 'as soon as possible', meaning that it not delay waiting for vblank.
850 * This may cause tearing on the screen.
852 * The reserved field must be zero.
855 struct drm_mode_crtc_page_flip {
864 * Request a page flip on the specified crtc.
866 * Same as struct drm_mode_crtc_page_flip, but supports new flags and
867 * re-purposes the reserved field:
869 * The sequence field must be zero unless either of the
870 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
871 * the ABSOLUTE flag is specified, the sequence field denotes the absolute
872 * vblank sequence when the flip should take effect. When the RELATIVE
873 * flag is specified, the sequence field denotes the relative (to the
874 * current one when the ioctl is called) vblank sequence when the flip
875 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
876 * make sure the vblank sequence before the target one has passed before
877 * calling this ioctl. The purpose of the
878 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
879 * the target for when code dealing with a page flip runs during a
880 * vertical blank period.
883 struct drm_mode_crtc_page_flip_target {
891 /* create a dumb scanout buffer */
892 struct drm_mode_create_dumb {
897 /* handle, pitch, size will be returned */
903 /* set up for mmap of a dumb scanout buffer */
904 struct drm_mode_map_dumb {
905 /** Handle for the object being mapped. */
909 * Fake offset to use for subsequent mmap call
911 * This is a fixed-size type for 32/64 compatibility.
916 struct drm_mode_destroy_dumb {
920 /* page-flip flags are valid, plus: */
921 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
922 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200
923 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
925 #define DRM_MODE_ATOMIC_FLAGS (\
926 DRM_MODE_PAGE_FLIP_EVENT |\
927 DRM_MODE_PAGE_FLIP_ASYNC |\
928 DRM_MODE_ATOMIC_TEST_ONLY |\
929 DRM_MODE_ATOMIC_NONBLOCK |\
930 DRM_MODE_ATOMIC_ALLOW_MODESET)
932 struct drm_mode_atomic {
936 __u64 count_props_ptr;
938 __u64 prop_values_ptr;
943 struct drm_format_modifier_blob {
944 #define FORMAT_BLOB_CURRENT 1
945 /* Version of this blob format */
951 /* Number of fourcc formats supported */
954 /* Where in this blob the formats exist (in bytes) */
955 __u32 formats_offset;
957 /* Number of drm_format_modifiers */
958 __u32 count_modifiers;
960 /* Where in this blob the modifiers exist (in bytes) */
961 __u32 modifiers_offset;
963 /* __u32 formats[] */
964 /* struct drm_format_modifier modifiers[] */
967 struct drm_format_modifier {
968 /* Bitmask of formats in get_plane format list this info applies to. The
969 * offset allows a sliding window of which 64 formats (bits).
972 * In today's world with < 65 formats, and formats 0, and 2 are
975 * ^-offset = 0, formats = 5
977 * If the number formats grew to 128, and formats 98-102 are
978 * supported with the modifier:
980 * 0x0000007c00000000 0000000000000000
982 * |__offset = 64, formats = 0x7c00000000
989 /* The modifier that applies to the >get_plane format list bitmask. */
994 * struct drm_mode_create_blob - Create New blob property
996 * Create a new 'blob' data property, copying length bytes from data pointer,
997 * and returning new blob ID.
999 struct drm_mode_create_blob {
1000 /** @data: Pointer to data to copy. */
1002 /** @length: Length of data to copy. */
1004 /** @blob_id: Return: new property ID. */
1009 * struct drm_mode_destroy_blob - Destroy user blob
1010 * @blob_id: blob_id to destroy
1012 * Destroy a user-created blob property.
1014 * User-space can release blobs as soon as they do not need to refer to them by
1015 * their blob object ID. For instance, if you are using a MODE_ID blob in an
1016 * atomic commit and you will not make another commit re-using the same ID, you
1017 * can destroy the blob as soon as the commit has been issued, without waiting
1018 * for it to complete.
1020 struct drm_mode_destroy_blob {
1025 * struct drm_mode_create_lease - Create lease
1027 * Lease mode resources, creating another drm_master.
1029 struct drm_mode_create_lease {
1030 /** @object_ids: Pointer to array of object ids (__u32) */
1032 /** @object_count: Number of object ids */
1034 /** @flags: flags for new FD (O_CLOEXEC, etc) */
1037 /** @lessee_id: Return: unique identifier for lessee. */
1039 /** @fd: Return: file descriptor to new drm_master file */
1044 * struct drm_mode_list_lessees - List lessees
1046 * List lesses from a drm_master.
1048 struct drm_mode_list_lessees {
1050 * @count_lessees: Number of lessees.
1052 * On input, provides length of the array.
1053 * On output, provides total number. No
1054 * more than the input number will be written
1055 * back, so two calls can be used to get
1056 * the size and then the data.
1058 __u32 count_lessees;
1059 /** @pad: Padding. */
1063 * @lessees_ptr: Pointer to lessees.
1065 * Pointer to __u64 array of lessee ids
1071 * struct drm_mode_get_lease - Get Lease
1073 * Get leased objects.
1075 struct drm_mode_get_lease {
1077 * @count_objects: Number of leased objects.
1079 * On input, provides length of the array.
1080 * On output, provides total number. No
1081 * more than the input number will be written
1082 * back, so two calls can be used to get
1083 * the size and then the data.
1085 __u32 count_objects;
1086 /** @pad: Padding. */
1090 * @objects_ptr: Pointer to objects.
1092 * Pointer to __u32 array of object ids.
1098 * struct drm_mode_revoke_lease - Revoke lease
1100 struct drm_mode_revoke_lease {
1101 /** @lessee_id: Unique ID of lessee */
1106 * struct drm_mode_rect - Two dimensional rectangle.
1107 * @x1: Horizontal starting coordinate (inclusive).
1108 * @y1: Vertical starting coordinate (inclusive).
1109 * @x2: Horizontal ending coordinate (exclusive).
1110 * @y2: Vertical ending coordinate (exclusive).
1112 * With drm subsystem using struct drm_rect to manage rectangular area this
1113 * export it to user-space.
1115 * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.
1117 struct drm_mode_rect {
1124 #if defined(__cplusplus)