drm: Fix docbook warnings in hdr metadata helper structures
[sfrench/cifs-2.6.git] / include / uapi / drm / drm_mode.h
1 /*
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
7  *
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:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
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
24  * IN THE SOFTWARE.
25  */
26
27 #ifndef _DRM_MODE_H
28 #define _DRM_MODE_H
29
30 #include "drm.h"
31
32 #if defined(__cplusplus)
33 extern "C" {
34 #endif
35
36 /**
37  * DOC: overview
38  *
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
43  */
44
45 #define DRM_CONNECTOR_NAME_LEN  32
46 #define DRM_DISPLAY_MODE_LEN    32
47 #define DRM_PROP_NAME_LEN       32
48
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)
56
57 #define DRM_MODE_TYPE_ALL       (DRM_MODE_TYPE_PREFERRED |      \
58                                  DRM_MODE_TYPE_USERDEF |        \
59                                  DRM_MODE_TYPE_DRIVER)
60
61 /* Video mode flags */
62 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
63  *
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!
70  */
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)
85  /*
86   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
87   * (define not exposed to user space).
88   */
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)
99
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
106
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
113
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)
126
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)
140
141 /* DPMS flags */
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
147
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 */
154
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
159
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
164
165 /* Link Status options */
166 #define DRM_MODE_LINK_STATUS_GOOD       0
167 #define DRM_MODE_LINK_STATUS_BAD        1
168
169 /*
170  * DRM_MODE_ROTATE_<degrees>
171  *
172  * Signals that a drm plane is been rotated <degrees> degrees in counter
173  * clockwise direction.
174  *
175  * This define is provided as a convenience, looking up the property id
176  * using the name->prop id lookup is the preferred method.
177  */
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)
182
183 /*
184  * DRM_MODE_ROTATE_MASK
185  *
186  * Bitmask used to look for drm plane rotations.
187  */
188 #define DRM_MODE_ROTATE_MASK (\
189                 DRM_MODE_ROTATE_0  | \
190                 DRM_MODE_ROTATE_90  | \
191                 DRM_MODE_ROTATE_180 | \
192                 DRM_MODE_ROTATE_270)
193
194 /*
195  * DRM_MODE_REFLECT_<axis>
196  *
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.
200  *
201  * This define is provided as a convenience, looking up the property id
202  * using the name->prop id lookup is the preferred method.
203  */
204 #define DRM_MODE_REFLECT_X      (1<<4)
205 #define DRM_MODE_REFLECT_Y      (1<<5)
206
207 /*
208  * DRM_MODE_REFLECT_MASK
209  *
210  * Bitmask used to look for drm plane reflections.
211  */
212 #define DRM_MODE_REFLECT_MASK (\
213                 DRM_MODE_REFLECT_X | \
214                 DRM_MODE_REFLECT_Y)
215
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
220
221 struct drm_mode_modeinfo {
222         __u32 clock;
223         __u16 hdisplay;
224         __u16 hsync_start;
225         __u16 hsync_end;
226         __u16 htotal;
227         __u16 hskew;
228         __u16 vdisplay;
229         __u16 vsync_start;
230         __u16 vsync_end;
231         __u16 vtotal;
232         __u16 vscan;
233
234         __u32 vrefresh;
235
236         __u32 flags;
237         __u32 type;
238         char name[DRM_DISPLAY_MODE_LEN];
239 };
240
241 struct drm_mode_card_res {
242         __u64 fb_id_ptr;
243         __u64 crtc_id_ptr;
244         __u64 connector_id_ptr;
245         __u64 encoder_id_ptr;
246         __u32 count_fbs;
247         __u32 count_crtcs;
248         __u32 count_connectors;
249         __u32 count_encoders;
250         __u32 min_width;
251         __u32 max_width;
252         __u32 min_height;
253         __u32 max_height;
254 };
255
256 struct drm_mode_crtc {
257         __u64 set_connectors_ptr;
258         __u32 count_connectors;
259
260         __u32 crtc_id; /**< Id */
261         __u32 fb_id; /**< Id of framebuffer */
262
263         __u32 x; /**< x Position on the framebuffer */
264         __u32 y; /**< y Position on the framebuffer */
265
266         __u32 gamma_size;
267         __u32 mode_valid;
268         struct drm_mode_modeinfo mode;
269 };
270
271 #define DRM_MODE_PRESENT_TOP_FIELD      (1<<0)
272 #define DRM_MODE_PRESENT_BOTTOM_FIELD   (1<<1)
273
274 /* Planes blend with or override other bits on the CRTC */
275 struct drm_mode_set_plane {
276         __u32 plane_id;
277         __u32 crtc_id;
278         __u32 fb_id; /* fb object contains surface format type */
279         __u32 flags; /* see above flags */
280
281         /* Signed dest location allows it to be partially off screen */
282         __s32 crtc_x;
283         __s32 crtc_y;
284         __u32 crtc_w;
285         __u32 crtc_h;
286
287         /* Source values are 16.16 fixed point */
288         __u32 src_x;
289         __u32 src_y;
290         __u32 src_h;
291         __u32 src_w;
292 };
293
294 struct drm_mode_get_plane {
295         __u32 plane_id;
296
297         __u32 crtc_id;
298         __u32 fb_id;
299
300         __u32 possible_crtcs;
301         __u32 gamma_size;
302
303         __u32 count_format_types;
304         __u64 format_type_ptr;
305 };
306
307 struct drm_mode_get_plane_res {
308         __u64 plane_id_ptr;
309         __u32 count_planes;
310 };
311
312 #define DRM_MODE_ENCODER_NONE   0
313 #define DRM_MODE_ENCODER_DAC    1
314 #define DRM_MODE_ENCODER_TMDS   2
315 #define DRM_MODE_ENCODER_LVDS   3
316 #define DRM_MODE_ENCODER_TVDAC  4
317 #define DRM_MODE_ENCODER_VIRTUAL 5
318 #define DRM_MODE_ENCODER_DSI    6
319 #define DRM_MODE_ENCODER_DPMST  7
320 #define DRM_MODE_ENCODER_DPI    8
321
322 struct drm_mode_get_encoder {
323         __u32 encoder_id;
324         __u32 encoder_type;
325
326         __u32 crtc_id; /**< Id of crtc */
327
328         __u32 possible_crtcs;
329         __u32 possible_clones;
330 };
331
332 /* This is for connectors with multiple signal types. */
333 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
334 enum drm_mode_subconnector {
335         DRM_MODE_SUBCONNECTOR_Automatic = 0,
336         DRM_MODE_SUBCONNECTOR_Unknown = 0,
337         DRM_MODE_SUBCONNECTOR_DVID = 3,
338         DRM_MODE_SUBCONNECTOR_DVIA = 4,
339         DRM_MODE_SUBCONNECTOR_Composite = 5,
340         DRM_MODE_SUBCONNECTOR_SVIDEO = 6,
341         DRM_MODE_SUBCONNECTOR_Component = 8,
342         DRM_MODE_SUBCONNECTOR_SCART = 9,
343 };
344
345 #define DRM_MODE_CONNECTOR_Unknown      0
346 #define DRM_MODE_CONNECTOR_VGA          1
347 #define DRM_MODE_CONNECTOR_DVII         2
348 #define DRM_MODE_CONNECTOR_DVID         3
349 #define DRM_MODE_CONNECTOR_DVIA         4
350 #define DRM_MODE_CONNECTOR_Composite    5
351 #define DRM_MODE_CONNECTOR_SVIDEO       6
352 #define DRM_MODE_CONNECTOR_LVDS         7
353 #define DRM_MODE_CONNECTOR_Component    8
354 #define DRM_MODE_CONNECTOR_9PinDIN      9
355 #define DRM_MODE_CONNECTOR_DisplayPort  10
356 #define DRM_MODE_CONNECTOR_HDMIA        11
357 #define DRM_MODE_CONNECTOR_HDMIB        12
358 #define DRM_MODE_CONNECTOR_TV           13
359 #define DRM_MODE_CONNECTOR_eDP          14
360 #define DRM_MODE_CONNECTOR_VIRTUAL      15
361 #define DRM_MODE_CONNECTOR_DSI          16
362 #define DRM_MODE_CONNECTOR_DPI          17
363 #define DRM_MODE_CONNECTOR_WRITEBACK    18
364
365 struct drm_mode_get_connector {
366
367         __u64 encoders_ptr;
368         __u64 modes_ptr;
369         __u64 props_ptr;
370         __u64 prop_values_ptr;
371
372         __u32 count_modes;
373         __u32 count_props;
374         __u32 count_encoders;
375
376         __u32 encoder_id; /**< Current Encoder */
377         __u32 connector_id; /**< Id */
378         __u32 connector_type;
379         __u32 connector_type_id;
380
381         __u32 connection;
382         __u32 mm_width;  /**< width in millimeters */
383         __u32 mm_height; /**< height in millimeters */
384         __u32 subpixel;
385
386         __u32 pad;
387 };
388
389 #define DRM_MODE_PROP_PENDING   (1<<0) /* deprecated, do not use */
390 #define DRM_MODE_PROP_RANGE     (1<<1)
391 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
392 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
393 #define DRM_MODE_PROP_BLOB      (1<<4)
394 #define DRM_MODE_PROP_BITMASK   (1<<5) /* bitmask of enumerated types */
395
396 /* non-extended types: legacy bitmask, one bit per type: */
397 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
398                 DRM_MODE_PROP_RANGE | \
399                 DRM_MODE_PROP_ENUM | \
400                 DRM_MODE_PROP_BLOB | \
401                 DRM_MODE_PROP_BITMASK)
402
403 /* extended-types: rather than continue to consume a bit per type,
404  * grab a chunk of the bits to use as integer type id.
405  */
406 #define DRM_MODE_PROP_EXTENDED_TYPE     0x0000ffc0
407 #define DRM_MODE_PROP_TYPE(n)           ((n) << 6)
408 #define DRM_MODE_PROP_OBJECT            DRM_MODE_PROP_TYPE(1)
409 #define DRM_MODE_PROP_SIGNED_RANGE      DRM_MODE_PROP_TYPE(2)
410
411 /* the PROP_ATOMIC flag is used to hide properties from userspace that
412  * is not aware of atomic properties.  This is mostly to work around
413  * older userspace (DDX drivers) that read/write each prop they find,
414  * witout being aware that this could be triggering a lengthy modeset.
415  */
416 #define DRM_MODE_PROP_ATOMIC        0x80000000
417
418 struct drm_mode_property_enum {
419         __u64 value;
420         char name[DRM_PROP_NAME_LEN];
421 };
422
423 struct drm_mode_get_property {
424         __u64 values_ptr; /* values and blob lengths */
425         __u64 enum_blob_ptr; /* enum and blob id ptrs */
426
427         __u32 prop_id;
428         __u32 flags;
429         char name[DRM_PROP_NAME_LEN];
430
431         __u32 count_values;
432         /* This is only used to count enum values, not blobs. The _blobs is
433          * simply because of a historical reason, i.e. backwards compat. */
434         __u32 count_enum_blobs;
435 };
436
437 struct drm_mode_connector_set_property {
438         __u64 value;
439         __u32 prop_id;
440         __u32 connector_id;
441 };
442
443 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
444 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
445 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
446 #define DRM_MODE_OBJECT_MODE 0xdededede
447 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
448 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
449 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
450 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
451 #define DRM_MODE_OBJECT_ANY 0
452
453 struct drm_mode_obj_get_properties {
454         __u64 props_ptr;
455         __u64 prop_values_ptr;
456         __u32 count_props;
457         __u32 obj_id;
458         __u32 obj_type;
459 };
460
461 struct drm_mode_obj_set_property {
462         __u64 value;
463         __u32 prop_id;
464         __u32 obj_id;
465         __u32 obj_type;
466 };
467
468 struct drm_mode_get_blob {
469         __u32 blob_id;
470         __u32 length;
471         __u64 data;
472 };
473
474 struct drm_mode_fb_cmd {
475         __u32 fb_id;
476         __u32 width;
477         __u32 height;
478         __u32 pitch;
479         __u32 bpp;
480         __u32 depth;
481         /* driver specific handle */
482         __u32 handle;
483 };
484
485 #define DRM_MODE_FB_INTERLACED  (1<<0) /* for interlaced framebuffers */
486 #define DRM_MODE_FB_MODIFIERS   (1<<1) /* enables ->modifer[] */
487
488 struct drm_mode_fb_cmd2 {
489         __u32 fb_id;
490         __u32 width;
491         __u32 height;
492         __u32 pixel_format; /* fourcc code from drm_fourcc.h */
493         __u32 flags; /* see above flags */
494
495         /*
496          * In case of planar formats, this ioctl allows up to 4
497          * buffer objects with offsets and pitches per plane.
498          * The pitch and offset order is dictated by the fourcc,
499          * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
500          *
501          *   YUV 4:2:0 image with a plane of 8 bit Y samples
502          *   followed by an interleaved U/V plane containing
503          *   8 bit 2x2 subsampled colour difference samples.
504          *
505          * So it would consist of Y as offsets[0] and UV as
506          * offsets[1].  Note that offsets[0] will generally
507          * be 0 (but this is not required).
508          *
509          * To accommodate tiled, compressed, etc formats, a
510          * modifier can be specified.  The default value of zero
511          * indicates "native" format as specified by the fourcc.
512          * Vendor specific modifier token.  Note that even though
513          * it looks like we have a modifier per-plane, we in fact
514          * do not. The modifier for each plane must be identical.
515          * Thus all combinations of different data layouts for
516          * multi plane formats must be enumerated as separate
517          * modifiers.
518          */
519         __u32 handles[4];
520         __u32 pitches[4]; /* pitch for each plane */
521         __u32 offsets[4]; /* offset of each plane */
522         __u64 modifier[4]; /* ie, tiling, compress */
523 };
524
525 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
526 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
527 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
528
529 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
530
531 /*
532  * Mark a region of a framebuffer as dirty.
533  *
534  * Some hardware does not automatically update display contents
535  * as a hardware or software draw to a framebuffer. This ioctl
536  * allows userspace to tell the kernel and the hardware what
537  * regions of the framebuffer have changed.
538  *
539  * The kernel or hardware is free to update more then just the
540  * region specified by the clip rects. The kernel or hardware
541  * may also delay and/or coalesce several calls to dirty into a
542  * single update.
543  *
544  * Userspace may annotate the updates, the annotates are a
545  * promise made by the caller that the change is either a copy
546  * of pixels or a fill of a single color in the region specified.
547  *
548  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
549  * the number of updated regions are half of num_clips given,
550  * where the clip rects are paired in src and dst. The width and
551  * height of each one of the pairs must match.
552  *
553  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
554  * promises that the region specified of the clip rects is filled
555  * completely with a single color as given in the color argument.
556  */
557
558 struct drm_mode_fb_dirty_cmd {
559         __u32 fb_id;
560         __u32 flags;
561         __u32 color;
562         __u32 num_clips;
563         __u64 clips_ptr;
564 };
565
566 struct drm_mode_mode_cmd {
567         __u32 connector_id;
568         struct drm_mode_modeinfo mode;
569 };
570
571 #define DRM_MODE_CURSOR_BO      0x01
572 #define DRM_MODE_CURSOR_MOVE    0x02
573 #define DRM_MODE_CURSOR_FLAGS   0x03
574
575 /*
576  * depending on the value in flags different members are used.
577  *
578  * CURSOR_BO uses
579  *    crtc_id
580  *    width
581  *    height
582  *    handle - if 0 turns the cursor off
583  *
584  * CURSOR_MOVE uses
585  *    crtc_id
586  *    x
587  *    y
588  */
589 struct drm_mode_cursor {
590         __u32 flags;
591         __u32 crtc_id;
592         __s32 x;
593         __s32 y;
594         __u32 width;
595         __u32 height;
596         /* driver specific handle */
597         __u32 handle;
598 };
599
600 struct drm_mode_cursor2 {
601         __u32 flags;
602         __u32 crtc_id;
603         __s32 x;
604         __s32 y;
605         __u32 width;
606         __u32 height;
607         /* driver specific handle */
608         __u32 handle;
609         __s32 hot_x;
610         __s32 hot_y;
611 };
612
613 struct drm_mode_crtc_lut {
614         __u32 crtc_id;
615         __u32 gamma_size;
616
617         /* pointers to arrays */
618         __u64 red;
619         __u64 green;
620         __u64 blue;
621 };
622
623 struct drm_color_ctm {
624         /*
625          * Conversion matrix in S31.32 sign-magnitude
626          * (not two's complement!) format.
627          */
628         __u64 matrix[9];
629 };
630
631 struct drm_color_lut {
632         /*
633          * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and
634          * 0xffff == 1.0.
635          */
636         __u16 red;
637         __u16 green;
638         __u16 blue;
639         __u16 reserved;
640 };
641
642 /**
643  * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data.
644  *
645  * HDR Metadata Infoframe as per CTA 861.G spec. This is expected
646  * to match exactly with the spec.
647  *
648  * Userspace is expected to pass the metadata information as per
649  * the format described in this structure.
650  */
651 struct hdr_metadata_infoframe {
652         /**
653          * @eotf: Electro-Optical Transfer Function (EOTF)
654          * used in the stream.
655          */
656         __u8 eotf;
657         /**
658          * @metadata_type: Static_Metadata_Descriptor_ID.
659          */
660         __u8 metadata_type;
661         /**
662          * @display_primaries: Color Primaries of the Data.
663          * These are coded as unsigned 16-bit values in units of
664          * 0.00002, where 0x0000 represents zero and 0xC350
665          * represents 1.0000.
666          * @display_primaries.x: X cordinate of color primary.
667          * @display_primaries.y: Y cordinate of color primary.
668          */
669         struct {
670                 __u16 x, y;
671                 } display_primaries[3];
672         /**
673          * @white_point: White Point of Colorspace Data.
674          * These are coded as unsigned 16-bit values in units of
675          * 0.00002, where 0x0000 represents zero and 0xC350
676          * represents 1.0000.
677          * @white_point.x: X cordinate of whitepoint of color primary.
678          * @white_point.y: Y cordinate of whitepoint of color primary.
679          */
680         struct {
681                 __u16 x, y;
682                 } white_point;
683         /**
684          * @max_display_mastering_luminance: Max Mastering Display Luminance.
685          * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
686          * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
687          */
688         __u16 max_display_mastering_luminance;
689         /**
690          * @min_display_mastering_luminance: Min Mastering Display Luminance.
691          * This value is coded as an unsigned 16-bit value in units of
692          * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF
693          * represents 6.5535 cd/m2.
694          */
695         __u16 min_display_mastering_luminance;
696         /**
697          * @max_cll: Max Content Light Level.
698          * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
699          * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
700          */
701         __u16 max_cll;
702         /**
703          * @max_fall: Max Frame Average Light Level.
704          * This value is coded as an unsigned 16-bit value in units of 1 cd/m2,
705          * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2.
706          */
707         __u16 max_fall;
708 };
709
710 /**
711  * struct hdr_output_metadata - HDR output metadata
712  *
713  * Metadata Information to be passed from userspace
714  */
715 struct hdr_output_metadata {
716         /**
717          * @metadata_type: Static_Metadata_Descriptor_ID.
718          */
719         __u32 metadata_type;
720         /**
721          * @hdmi_metadata_type1: HDR Metadata Infoframe.
722          */
723         union {
724                 struct hdr_metadata_infoframe hdmi_metadata_type1;
725         };
726 };
727
728 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
729 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
730 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
731 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
732 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
733                                    DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
734 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
735                                   DRM_MODE_PAGE_FLIP_ASYNC | \
736                                   DRM_MODE_PAGE_FLIP_TARGET)
737
738 /*
739  * Request a page flip on the specified crtc.
740  *
741  * This ioctl will ask KMS to schedule a page flip for the specified
742  * crtc.  Once any pending rendering targeting the specified fb (as of
743  * ioctl time) has completed, the crtc will be reprogrammed to display
744  * that fb after the next vertical refresh.  The ioctl returns
745  * immediately, but subsequent rendering to the current fb will block
746  * in the execbuffer ioctl until the page flip happens.  If a page
747  * flip is already pending as the ioctl is called, EBUSY will be
748  * returned.
749  *
750  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
751  * event (see drm.h: struct drm_event_vblank) when the page flip is
752  * done.  The user_data field passed in with this ioctl will be
753  * returned as the user_data field in the vblank event struct.
754  *
755  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
756  * 'as soon as possible', meaning that it not delay waiting for vblank.
757  * This may cause tearing on the screen.
758  *
759  * The reserved field must be zero.
760  */
761
762 struct drm_mode_crtc_page_flip {
763         __u32 crtc_id;
764         __u32 fb_id;
765         __u32 flags;
766         __u32 reserved;
767         __u64 user_data;
768 };
769
770 /*
771  * Request a page flip on the specified crtc.
772  *
773  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
774  * re-purposes the reserved field:
775  *
776  * The sequence field must be zero unless either of the
777  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
778  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
779  * vblank sequence when the flip should take effect. When the RELATIVE
780  * flag is specified, the sequence field denotes the relative (to the
781  * current one when the ioctl is called) vblank sequence when the flip
782  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
783  * make sure the vblank sequence before the target one has passed before
784  * calling this ioctl. The purpose of the
785  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
786  * the target for when code dealing with a page flip runs during a
787  * vertical blank period.
788  */
789
790 struct drm_mode_crtc_page_flip_target {
791         __u32 crtc_id;
792         __u32 fb_id;
793         __u32 flags;
794         __u32 sequence;
795         __u64 user_data;
796 };
797
798 /* create a dumb scanout buffer */
799 struct drm_mode_create_dumb {
800         __u32 height;
801         __u32 width;
802         __u32 bpp;
803         __u32 flags;
804         /* handle, pitch, size will be returned */
805         __u32 handle;
806         __u32 pitch;
807         __u64 size;
808 };
809
810 /* set up for mmap of a dumb scanout buffer */
811 struct drm_mode_map_dumb {
812         /** Handle for the object being mapped. */
813         __u32 handle;
814         __u32 pad;
815         /**
816          * Fake offset to use for subsequent mmap call
817          *
818          * This is a fixed-size type for 32/64 compatibility.
819          */
820         __u64 offset;
821 };
822
823 struct drm_mode_destroy_dumb {
824         __u32 handle;
825 };
826
827 /* page-flip flags are valid, plus: */
828 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
829 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
830 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
831
832 #define DRM_MODE_ATOMIC_FLAGS (\
833                 DRM_MODE_PAGE_FLIP_EVENT |\
834                 DRM_MODE_PAGE_FLIP_ASYNC |\
835                 DRM_MODE_ATOMIC_TEST_ONLY |\
836                 DRM_MODE_ATOMIC_NONBLOCK |\
837                 DRM_MODE_ATOMIC_ALLOW_MODESET)
838
839 struct drm_mode_atomic {
840         __u32 flags;
841         __u32 count_objs;
842         __u64 objs_ptr;
843         __u64 count_props_ptr;
844         __u64 props_ptr;
845         __u64 prop_values_ptr;
846         __u64 reserved;
847         __u64 user_data;
848 };
849
850 struct drm_format_modifier_blob {
851 #define FORMAT_BLOB_CURRENT 1
852         /* Version of this blob format */
853         __u32 version;
854
855         /* Flags */
856         __u32 flags;
857
858         /* Number of fourcc formats supported */
859         __u32 count_formats;
860
861         /* Where in this blob the formats exist (in bytes) */
862         __u32 formats_offset;
863
864         /* Number of drm_format_modifiers */
865         __u32 count_modifiers;
866
867         /* Where in this blob the modifiers exist (in bytes) */
868         __u32 modifiers_offset;
869
870         /* __u32 formats[] */
871         /* struct drm_format_modifier modifiers[] */
872 };
873
874 struct drm_format_modifier {
875         /* Bitmask of formats in get_plane format list this info applies to. The
876          * offset allows a sliding window of which 64 formats (bits).
877          *
878          * Some examples:
879          * In today's world with < 65 formats, and formats 0, and 2 are
880          * supported
881          * 0x0000000000000005
882          *                ^-offset = 0, formats = 5
883          *
884          * If the number formats grew to 128, and formats 98-102 are
885          * supported with the modifier:
886          *
887          * 0x0000007c00000000 0000000000000000
888          *                ^
889          *                |__offset = 64, formats = 0x7c00000000
890          *
891          */
892         __u64 formats;
893         __u32 offset;
894         __u32 pad;
895
896         /* The modifier that applies to the >get_plane format list bitmask. */
897         __u64 modifier;
898 };
899
900 /**
901  * struct drm_mode_create_blob - Create New block property
902  * @data: Pointer to data to copy.
903  * @length: Length of data to copy.
904  * @blob_id: new property ID.
905  * Create a new 'blob' data property, copying length bytes from data pointer,
906  * and returning new blob ID.
907  */
908 struct drm_mode_create_blob {
909         /** Pointer to data to copy. */
910         __u64 data;
911         /** Length of data to copy. */
912         __u32 length;
913         /** Return: new property ID. */
914         __u32 blob_id;
915 };
916
917 /**
918  * struct drm_mode_destroy_blob - Destroy user blob
919  * @blob_id: blob_id to destroy
920  * Destroy a user-created blob property.
921  */
922 struct drm_mode_destroy_blob {
923         __u32 blob_id;
924 };
925
926 /**
927  * struct drm_mode_create_lease - Create lease
928  * @object_ids: Pointer to array of object ids.
929  * @object_count: Number of object ids.
930  * @flags: flags for new FD.
931  * @lessee_id: unique identifier for lessee.
932  * @fd: file descriptor to new drm_master file.
933  * Lease mode resources, creating another drm_master.
934  */
935 struct drm_mode_create_lease {
936         /** Pointer to array of object ids (__u32) */
937         __u64 object_ids;
938         /** Number of object ids */
939         __u32 object_count;
940         /** flags for new FD (O_CLOEXEC, etc) */
941         __u32 flags;
942
943         /** Return: unique identifier for lessee. */
944         __u32 lessee_id;
945         /** Return: file descriptor to new drm_master file */
946         __u32 fd;
947 };
948
949 /**
950  * struct drm_mode_list_lessees - List lessees
951  * @count_lessees: Number of lessees.
952  * @pad: pad.
953  * @lessees_ptr: Pointer to lessess.
954  * List lesses from a drm_master
955  */
956 struct drm_mode_list_lessees {
957         /** Number of lessees.
958          * On input, provides length of the array.
959          * On output, provides total number. No
960          * more than the input number will be written
961          * back, so two calls can be used to get
962          * the size and then the data.
963          */
964         __u32 count_lessees;
965         __u32 pad;
966
967         /** Pointer to lessees.
968          * pointer to __u64 array of lessee ids
969          */
970         __u64 lessees_ptr;
971 };
972
973 /**
974  * struct drm_mode_get_lease - Get Lease
975  * @count_objects: Number of leased objects.
976  * @pad: pad.
977  * @objects_ptr: Pointer to objects.
978  * Get leased objects
979  */
980 struct drm_mode_get_lease {
981         /** Number of leased objects.
982          * On input, provides length of the array.
983          * On output, provides total number. No
984          * more than the input number will be written
985          * back, so two calls can be used to get
986          * the size and then the data.
987          */
988         __u32 count_objects;
989         __u32 pad;
990
991         /** Pointer to objects.
992          * pointer to __u32 array of object ids
993          */
994         __u64 objects_ptr;
995 };
996
997 /**
998  * struct drm_mode_revoke_lease - Revoke lease
999  * @lessee_id: Unique ID of lessee.
1000  * Revoke lease
1001  */
1002 struct drm_mode_revoke_lease {
1003         /** Unique ID of lessee
1004          */
1005         __u32 lessee_id;
1006 };
1007
1008 /**
1009  * struct drm_mode_rect - Two dimensional rectangle.
1010  * @x1: Horizontal starting coordinate (inclusive).
1011  * @y1: Vertical starting coordinate (inclusive).
1012  * @x2: Horizontal ending coordinate (exclusive).
1013  * @y2: Vertical ending coordinate (exclusive).
1014  *
1015  * With drm subsystem using struct drm_rect to manage rectangular area this
1016  * export it to user-space.
1017  *
1018  * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS.
1019  */
1020 struct drm_mode_rect {
1021         __s32 x1;
1022         __s32 y1;
1023         __s32 x2;
1024         __s32 y2;
1025 };
1026
1027 #if defined(__cplusplus)
1028 }
1029 #endif
1030
1031 #endif