FROMLIST: drm: Parse HDMI 2.0 YCbCr 4:2:0 VDB and VCB
[firefly-linux-kernel-4.4.55.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 <linux/types.h>
31
32 #define DRM_DISPLAY_INFO_LEN    32
33 #define DRM_CONNECTOR_NAME_LEN  32
34 #define DRM_DISPLAY_MODE_LEN    32
35 #define DRM_PROP_NAME_LEN       32
36
37 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
38 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
39 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
40 #define DRM_MODE_TYPE_PREFERRED (1<<3)
41 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
42 #define DRM_MODE_TYPE_USERDEF   (1<<5)
43 #define DRM_MODE_TYPE_DRIVER    (1<<6)
44
45 /* Video mode flags */
46 /* bit compatible with the xorg definitions. */
47 #define DRM_MODE_FLAG_PHSYNC                    (1<<0)
48 #define DRM_MODE_FLAG_NHSYNC                    (1<<1)
49 #define DRM_MODE_FLAG_PVSYNC                    (1<<2)
50 #define DRM_MODE_FLAG_NVSYNC                    (1<<3)
51 #define DRM_MODE_FLAG_INTERLACE                 (1<<4)
52 #define DRM_MODE_FLAG_DBLSCAN                   (1<<5)
53 #define DRM_MODE_FLAG_CSYNC                     (1<<6)
54 #define DRM_MODE_FLAG_PCSYNC                    (1<<7)
55 #define DRM_MODE_FLAG_NCSYNC                    (1<<8)
56 #define DRM_MODE_FLAG_HSKEW                     (1<<9) /* hskew provided */
57 #define DRM_MODE_FLAG_BCAST                     (1<<10)
58 #define DRM_MODE_FLAG_PIXMUX                    (1<<11)
59 #define DRM_MODE_FLAG_DBLCLK                    (1<<12)
60 #define DRM_MODE_FLAG_CLKDIV2                   (1<<13)
61  /*
62   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
63   * (define not exposed to user space).
64   */
65 #define DRM_MODE_FLAG_3D_MASK                   (0x1f<<14)
66 #define  DRM_MODE_FLAG_3D_NONE                  (0<<14)
67 #define  DRM_MODE_FLAG_3D_FRAME_PACKING         (1<<14)
68 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE     (2<<14)
69 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE      (3<<14)
70 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL     (4<<14)
71 #define  DRM_MODE_FLAG_3D_L_DEPTH               (5<<14)
72 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
73 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM        (7<<14)
74 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF     (8<<14)
75 /*
76  * HDMI 2.0
77  */
78 #define DRM_MODE_FLAG_420_MASK                  (0x03<<19)
79 #define  DRM_MODE_FLAG_420                      (1<<19)
80 #define  DRM_MODE_FLAG_420_ONLY                 (1<<20)
81
82
83 /* DPMS flags */
84 /* bit compatible with the xorg definitions. */
85 #define DRM_MODE_DPMS_ON        0
86 #define DRM_MODE_DPMS_STANDBY   1
87 #define DRM_MODE_DPMS_SUSPEND   2
88 #define DRM_MODE_DPMS_OFF       3
89
90 /* Scaling mode options */
91 #define DRM_MODE_SCALE_NONE             0 /* Unmodified timing (display or
92                                              software can still scale) */
93 #define DRM_MODE_SCALE_FULLSCREEN       1 /* Full screen, ignore aspect */
94 #define DRM_MODE_SCALE_CENTER           2 /* Centered, no scaling */
95 #define DRM_MODE_SCALE_ASPECT           3 /* Full screen, preserve aspect */
96
97 /* Picture aspect ratio options */
98 #define DRM_MODE_PICTURE_ASPECT_NONE    0
99 #define DRM_MODE_PICTURE_ASPECT_4_3     1
100 #define DRM_MODE_PICTURE_ASPECT_16_9    2
101
102 /* Dithering mode options */
103 #define DRM_MODE_DITHERING_OFF  0
104 #define DRM_MODE_DITHERING_ON   1
105 #define DRM_MODE_DITHERING_AUTO 2
106
107 /* Dirty info options */
108 #define DRM_MODE_DIRTY_OFF      0
109 #define DRM_MODE_DIRTY_ON       1
110 #define DRM_MODE_DIRTY_ANNOTATE 2
111
112 struct drm_mode_modeinfo {
113         __u32 clock;
114         __u16 hdisplay;
115         __u16 hsync_start;
116         __u16 hsync_end;
117         __u16 htotal;
118         __u16 hskew;
119         __u16 vdisplay;
120         __u16 vsync_start;
121         __u16 vsync_end;
122         __u16 vtotal;
123         __u16 vscan;
124
125         __u32 vrefresh;
126
127         __u32 flags;
128         __u32 type;
129         char name[DRM_DISPLAY_MODE_LEN];
130 };
131
132 struct drm_mode_card_res {
133         __u64 fb_id_ptr;
134         __u64 crtc_id_ptr;
135         __u64 connector_id_ptr;
136         __u64 encoder_id_ptr;
137         __u32 count_fbs;
138         __u32 count_crtcs;
139         __u32 count_connectors;
140         __u32 count_encoders;
141         __u32 min_width;
142         __u32 max_width;
143         __u32 min_height;
144         __u32 max_height;
145 };
146
147 struct drm_mode_crtc {
148         __u64 set_connectors_ptr;
149         __u32 count_connectors;
150
151         __u32 crtc_id; /**< Id */
152         __u32 fb_id; /**< Id of framebuffer */
153
154         __u32 x; /**< x Position on the framebuffer */
155         __u32 y; /**< y Position on the framebuffer */
156
157         __u32 gamma_size;
158         __u32 mode_valid;
159         struct drm_mode_modeinfo mode;
160 };
161
162 #define DRM_MODE_PRESENT_TOP_FIELD      (1<<0)
163 #define DRM_MODE_PRESENT_BOTTOM_FIELD   (1<<1)
164
165 /* Planes blend with or override other bits on the CRTC */
166 struct drm_mode_set_plane {
167         __u32 plane_id;
168         __u32 crtc_id;
169         __u32 fb_id; /* fb object contains surface format type */
170         __u32 flags; /* see above flags */
171
172         /* Signed dest location allows it to be partially off screen */
173         __s32 crtc_x;
174         __s32 crtc_y;
175         __u32 crtc_w;
176         __u32 crtc_h;
177
178         /* Source values are 16.16 fixed point */
179         __u32 src_x;
180         __u32 src_y;
181         __u32 src_h;
182         __u32 src_w;
183 };
184
185 struct drm_mode_get_plane {
186         __u32 plane_id;
187
188         __u32 crtc_id;
189         __u32 fb_id;
190
191         __u32 possible_crtcs;
192         __u32 gamma_size;
193
194         __u32 count_format_types;
195         __u64 format_type_ptr;
196 };
197
198 struct drm_mode_get_plane_res {
199         __u64 plane_id_ptr;
200         __u32 count_planes;
201 };
202
203 #define DRM_MODE_ENCODER_NONE   0
204 #define DRM_MODE_ENCODER_DAC    1
205 #define DRM_MODE_ENCODER_TMDS   2
206 #define DRM_MODE_ENCODER_LVDS   3
207 #define DRM_MODE_ENCODER_TVDAC  4
208 #define DRM_MODE_ENCODER_VIRTUAL 5
209 #define DRM_MODE_ENCODER_DSI    6
210 #define DRM_MODE_ENCODER_DPMST  7
211
212 struct drm_mode_get_encoder {
213         __u32 encoder_id;
214         __u32 encoder_type;
215
216         __u32 crtc_id; /**< Id of crtc */
217
218         __u32 possible_crtcs;
219         __u32 possible_clones;
220 };
221
222 /* This is for connectors with multiple signal types. */
223 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
224 #define DRM_MODE_SUBCONNECTOR_Automatic 0
225 #define DRM_MODE_SUBCONNECTOR_Unknown   0
226 #define DRM_MODE_SUBCONNECTOR_DVID      3
227 #define DRM_MODE_SUBCONNECTOR_DVIA      4
228 #define DRM_MODE_SUBCONNECTOR_Composite 5
229 #define DRM_MODE_SUBCONNECTOR_SVIDEO    6
230 #define DRM_MODE_SUBCONNECTOR_Component 8
231 #define DRM_MODE_SUBCONNECTOR_SCART     9
232
233 #define DRM_MODE_CONNECTOR_Unknown      0
234 #define DRM_MODE_CONNECTOR_VGA          1
235 #define DRM_MODE_CONNECTOR_DVII         2
236 #define DRM_MODE_CONNECTOR_DVID         3
237 #define DRM_MODE_CONNECTOR_DVIA         4
238 #define DRM_MODE_CONNECTOR_Composite    5
239 #define DRM_MODE_CONNECTOR_SVIDEO       6
240 #define DRM_MODE_CONNECTOR_LVDS         7
241 #define DRM_MODE_CONNECTOR_Component    8
242 #define DRM_MODE_CONNECTOR_9PinDIN      9
243 #define DRM_MODE_CONNECTOR_DisplayPort  10
244 #define DRM_MODE_CONNECTOR_HDMIA        11
245 #define DRM_MODE_CONNECTOR_HDMIB        12
246 #define DRM_MODE_CONNECTOR_TV           13
247 #define DRM_MODE_CONNECTOR_eDP          14
248 #define DRM_MODE_CONNECTOR_VIRTUAL      15
249 #define DRM_MODE_CONNECTOR_DSI          16
250
251 struct drm_mode_get_connector {
252
253         __u64 encoders_ptr;
254         __u64 modes_ptr;
255         __u64 props_ptr;
256         __u64 prop_values_ptr;
257
258         __u32 count_modes;
259         __u32 count_props;
260         __u32 count_encoders;
261
262         __u32 encoder_id; /**< Current Encoder */
263         __u32 connector_id; /**< Id */
264         __u32 connector_type;
265         __u32 connector_type_id;
266
267         __u32 connection;
268         __u32 mm_width;  /**< width in millimeters */
269         __u32 mm_height; /**< height in millimeters */
270         __u32 subpixel;
271
272         __u32 pad;
273 };
274
275 #define DRM_MODE_PROP_PENDING   (1<<0)
276 #define DRM_MODE_PROP_RANGE     (1<<1)
277 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
278 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
279 #define DRM_MODE_PROP_BLOB      (1<<4)
280 #define DRM_MODE_PROP_BITMASK   (1<<5) /* bitmask of enumerated types */
281
282 /* non-extended types: legacy bitmask, one bit per type: */
283 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
284                 DRM_MODE_PROP_RANGE | \
285                 DRM_MODE_PROP_ENUM | \
286                 DRM_MODE_PROP_BLOB | \
287                 DRM_MODE_PROP_BITMASK)
288
289 /* extended-types: rather than continue to consume a bit per type,
290  * grab a chunk of the bits to use as integer type id.
291  */
292 #define DRM_MODE_PROP_EXTENDED_TYPE     0x0000ffc0
293 #define DRM_MODE_PROP_TYPE(n)           ((n) << 6)
294 #define DRM_MODE_PROP_OBJECT            DRM_MODE_PROP_TYPE(1)
295 #define DRM_MODE_PROP_SIGNED_RANGE      DRM_MODE_PROP_TYPE(2)
296
297 /* the PROP_ATOMIC flag is used to hide properties from userspace that
298  * is not aware of atomic properties.  This is mostly to work around
299  * older userspace (DDX drivers) that read/write each prop they find,
300  * witout being aware that this could be triggering a lengthy modeset.
301  */
302 #define DRM_MODE_PROP_ATOMIC        0x80000000
303
304 struct drm_mode_property_enum {
305         __u64 value;
306         char name[DRM_PROP_NAME_LEN];
307 };
308
309 struct drm_mode_get_property {
310         __u64 values_ptr; /* values and blob lengths */
311         __u64 enum_blob_ptr; /* enum and blob id ptrs */
312
313         __u32 prop_id;
314         __u32 flags;
315         char name[DRM_PROP_NAME_LEN];
316
317         __u32 count_values;
318         /* This is only used to count enum values, not blobs. The _blobs is
319          * simply because of a historical reason, i.e. backwards compat. */
320         __u32 count_enum_blobs;
321 };
322
323 struct drm_mode_connector_set_property {
324         __u64 value;
325         __u32 prop_id;
326         __u32 connector_id;
327 };
328
329 struct drm_mode_obj_get_properties {
330         __u64 props_ptr;
331         __u64 prop_values_ptr;
332         __u32 count_props;
333         __u32 obj_id;
334         __u32 obj_type;
335 };
336
337 struct drm_mode_obj_set_property {
338         __u64 value;
339         __u32 prop_id;
340         __u32 obj_id;
341         __u32 obj_type;
342 };
343
344 struct drm_mode_get_blob {
345         __u32 blob_id;
346         __u32 length;
347         __u64 data;
348 };
349
350 struct drm_mode_fb_cmd {
351         __u32 fb_id;
352         __u32 width;
353         __u32 height;
354         __u32 pitch;
355         __u32 bpp;
356         __u32 depth;
357         /* driver specific handle */
358         __u32 handle;
359 };
360
361 #define DRM_MODE_FB_INTERLACED  (1<<0) /* for interlaced framebuffers */
362 #define DRM_MODE_FB_MODIFIERS   (1<<1) /* enables ->modifer[] */
363
364 struct drm_mode_fb_cmd2 {
365         __u32 fb_id;
366         __u32 width;
367         __u32 height;
368         __u32 pixel_format; /* fourcc code from drm_fourcc.h */
369         __u32 flags; /* see above flags */
370
371         /*
372          * In case of planar formats, this ioctl allows up to 4
373          * buffer objects with offsets and pitches per plane.
374          * The pitch and offset order is dictated by the fourcc,
375          * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
376          *
377          *   YUV 4:2:0 image with a plane of 8 bit Y samples
378          *   followed by an interleaved U/V plane containing
379          *   8 bit 2x2 subsampled colour difference samples.
380          *
381          * So it would consist of Y as offsets[0] and UV as
382          * offsets[1].  Note that offsets[0] will generally
383          * be 0 (but this is not required).
384          *
385          * To accommodate tiled, compressed, etc formats, a per-plane
386          * modifier can be specified.  The default value of zero
387          * indicates "native" format as specified by the fourcc.
388          * Vendor specific modifier token.  This allows, for example,
389          * different tiling/swizzling pattern on different planes.
390          * See discussion above of DRM_FORMAT_MOD_xxx.
391          */
392         __u32 handles[4];
393         __u32 pitches[4]; /* pitch for each plane */
394         __u32 offsets[4]; /* offset of each plane */
395         __u64 modifier[4]; /* ie, tiling, compressed (per plane) */
396 };
397
398 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
399 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
400 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
401
402 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
403
404 /*
405  * Mark a region of a framebuffer as dirty.
406  *
407  * Some hardware does not automatically update display contents
408  * as a hardware or software draw to a framebuffer. This ioctl
409  * allows userspace to tell the kernel and the hardware what
410  * regions of the framebuffer have changed.
411  *
412  * The kernel or hardware is free to update more then just the
413  * region specified by the clip rects. The kernel or hardware
414  * may also delay and/or coalesce several calls to dirty into a
415  * single update.
416  *
417  * Userspace may annotate the updates, the annotates are a
418  * promise made by the caller that the change is either a copy
419  * of pixels or a fill of a single color in the region specified.
420  *
421  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
422  * the number of updated regions are half of num_clips given,
423  * where the clip rects are paired in src and dst. The width and
424  * height of each one of the pairs must match.
425  *
426  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
427  * promises that the region specified of the clip rects is filled
428  * completely with a single color as given in the color argument.
429  */
430
431 struct drm_mode_fb_dirty_cmd {
432         __u32 fb_id;
433         __u32 flags;
434         __u32 color;
435         __u32 num_clips;
436         __u64 clips_ptr;
437 };
438
439 struct drm_mode_mode_cmd {
440         __u32 connector_id;
441         struct drm_mode_modeinfo mode;
442 };
443
444 #define DRM_MODE_CURSOR_BO      0x01
445 #define DRM_MODE_CURSOR_MOVE    0x02
446 #define DRM_MODE_CURSOR_FLAGS   0x03
447
448 /*
449  * depending on the value in flags different members are used.
450  *
451  * CURSOR_BO uses
452  *    crtc_id
453  *    width
454  *    height
455  *    handle - if 0 turns the cursor off
456  *
457  * CURSOR_MOVE uses
458  *    crtc_id
459  *    x
460  *    y
461  */
462 struct drm_mode_cursor {
463         __u32 flags;
464         __u32 crtc_id;
465         __s32 x;
466         __s32 y;
467         __u32 width;
468         __u32 height;
469         /* driver specific handle */
470         __u32 handle;
471 };
472
473 struct drm_mode_cursor2 {
474         __u32 flags;
475         __u32 crtc_id;
476         __s32 x;
477         __s32 y;
478         __u32 width;
479         __u32 height;
480         /* driver specific handle */
481         __u32 handle;
482         __s32 hot_x;
483         __s32 hot_y;
484 };
485
486 struct drm_mode_crtc_lut {
487         __u32 crtc_id;
488         __u32 gamma_size;
489
490         /* pointers to arrays */
491         __u64 red;
492         __u64 green;
493         __u64 blue;
494 };
495
496 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
497 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
498 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT|DRM_MODE_PAGE_FLIP_ASYNC)
499
500 /*
501  * Request a page flip on the specified crtc.
502  *
503  * This ioctl will ask KMS to schedule a page flip for the specified
504  * crtc.  Once any pending rendering targeting the specified fb (as of
505  * ioctl time) has completed, the crtc will be reprogrammed to display
506  * that fb after the next vertical refresh.  The ioctl returns
507  * immediately, but subsequent rendering to the current fb will block
508  * in the execbuffer ioctl until the page flip happens.  If a page
509  * flip is already pending as the ioctl is called, EBUSY will be
510  * returned.
511  *
512  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
513  * event (see drm.h: struct drm_event_vblank) when the page flip is
514  * done.  The user_data field passed in with this ioctl will be
515  * returned as the user_data field in the vblank event struct.
516  *
517  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
518  * 'as soon as possible', meaning that it not delay waiting for vblank.
519  * This may cause tearing on the screen.
520  *
521  * The reserved field must be zero until we figure out something
522  * clever to use it for.
523  */
524
525 struct drm_mode_crtc_page_flip {
526         __u32 crtc_id;
527         __u32 fb_id;
528         __u32 flags;
529         __u32 reserved;
530         __u64 user_data;
531 };
532
533 /* create a dumb scanout buffer */
534 struct drm_mode_create_dumb {
535         uint32_t height;
536         uint32_t width;
537         uint32_t bpp;
538         uint32_t flags;
539         /* handle, pitch, size will be returned */
540         uint32_t handle;
541         uint32_t pitch;
542         uint64_t size;
543 };
544
545 /* set up for mmap of a dumb scanout buffer */
546 struct drm_mode_map_dumb {
547         /** Handle for the object being mapped. */
548         __u32 handle;
549         __u32 pad;
550         /**
551          * Fake offset to use for subsequent mmap call
552          *
553          * This is a fixed-size type for 32/64 compatibility.
554          */
555         __u64 offset;
556 };
557
558 struct drm_mode_destroy_dumb {
559         uint32_t handle;
560 };
561
562 /* page-flip flags are valid, plus: */
563 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
564 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
565 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
566
567 #define DRM_MODE_ATOMIC_FLAGS (\
568                 DRM_MODE_PAGE_FLIP_EVENT |\
569                 DRM_MODE_PAGE_FLIP_ASYNC |\
570                 DRM_MODE_ATOMIC_TEST_ONLY |\
571                 DRM_MODE_ATOMIC_NONBLOCK |\
572                 DRM_MODE_ATOMIC_ALLOW_MODESET)
573
574 struct drm_mode_atomic {
575         __u32 flags;
576         __u32 count_objs;
577         __u64 objs_ptr;
578         __u64 count_props_ptr;
579         __u64 props_ptr;
580         __u64 prop_values_ptr;
581         __u64 reserved;
582         __u64 user_data;
583 };
584
585 /**
586  * Create a new 'blob' data property, copying length bytes from data pointer,
587  * and returning new blob ID.
588  */
589 struct drm_mode_create_blob {
590         /** Pointer to data to copy. */
591         __u64 data;
592         /** Length of data to copy. */
593         __u32 length;
594         /** Return: new property ID. */
595         __u32 blob_id;
596 };
597
598 /**
599  * Destroy a user-created blob property.
600  */
601 struct drm_mode_destroy_blob {
602         __u32 blob_id;
603 };
604
605 #endif