include/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 #define DRM_DISPLAY_INFO_LEN    32
  37 #define DRM_CONNECTOR_NAME_LEN  32
  38 #define DRM_DISPLAY_MODE_LEN    32
  39 #define DRM_PROP_NAME_LEN       32
  40
  41 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
  42 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
  43 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
  44 #define DRM_MODE_TYPE_PREFERRED (1<<3)
  45 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
  46 #define DRM_MODE_TYPE_USERDEF   (1<<5)
  47 #define DRM_MODE_TYPE_DRIVER    (1<<6)
  48
  49 /* Video mode flags */
  50 /* bit compatible with the xrandr RR_ definitions (bits 0-13)
  51  *
  52  * ABI warning: Existing userspace really expects
  53  * the mode flags to match the xrandr definitions. Any
  54  * changes that don't match the xrandr definitions will
  55  * likely need a new client cap or some other mechanism
  56  * to avoid breaking existing userspace. This includes
  57  * allocating new flags in the previously unused bits!
  58  */
  59 #define DRM_MODE_FLAG_PHSYNC                    (1<<0)
  60 #define DRM_MODE_FLAG_NHSYNC                    (1<<1)
  61 #define DRM_MODE_FLAG_PVSYNC                    (1<<2)
  62 #define DRM_MODE_FLAG_NVSYNC                    (1<<3)
  63 #define DRM_MODE_FLAG_INTERLACE                 (1<<4)
  64 #define DRM_MODE_FLAG_DBLSCAN                   (1<<5)
  65 #define DRM_MODE_FLAG_CSYNC                     (1<<6)
  66 #define DRM_MODE_FLAG_PCSYNC                    (1<<7)
  67 #define DRM_MODE_FLAG_NCSYNC                    (1<<8)
  68 #define DRM_MODE_FLAG_HSKEW                     (1<<9) /* hskew provided */
  69 #define DRM_MODE_FLAG_BCAST                     (1<<10)
  70 #define DRM_MODE_FLAG_PIXMUX                    (1<<11)
  71 #define DRM_MODE_FLAG_DBLCLK                    (1<<12)
  72 #define DRM_MODE_FLAG_CLKDIV2                   (1<<13)
  73  /*
  74   * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX
  75   * (define not exposed to user space).
  76   */
  77 #define DRM_MODE_FLAG_3D_MASK                   (0x1f<<14)
  78 #define  DRM_MODE_FLAG_3D_NONE                  (0<<14)
  79 #define  DRM_MODE_FLAG_3D_FRAME_PACKING         (1<<14)
  80 #define  DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE     (2<<14)
  81 #define  DRM_MODE_FLAG_3D_LINE_ALTERNATIVE      (3<<14)
  82 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL     (4<<14)
  83 #define  DRM_MODE_FLAG_3D_L_DEPTH               (5<<14)
  84 #define  DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14)
  85 #define  DRM_MODE_FLAG_3D_TOP_AND_BOTTOM        (7<<14)
  86 #define  DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF     (8<<14)
  87
  88
  89 /* DPMS flags */
  90 /* bit compatible with the xorg definitions. */
  91 #define DRM_MODE_DPMS_ON        0
  92 #define DRM_MODE_DPMS_STANDBY   1
  93 #define DRM_MODE_DPMS_SUSPEND   2
  94 #define DRM_MODE_DPMS_OFF       3
  95
  96 /* Scaling mode options */
  97 #define DRM_MODE_SCALE_NONE             0 /* Unmodified timing (display or
  98                                              software can still scale) */
  99 #define DRM_MODE_SCALE_FULLSCREEN       1 /* Full screen, ignore aspect */
 100 #define DRM_MODE_SCALE_CENTER           2 /* Centered, no scaling */
 101 #define DRM_MODE_SCALE_ASPECT           3 /* Full screen, preserve aspect */
 102
 103 /* Picture aspect ratio options */
 104 #define DRM_MODE_PICTURE_ASPECT_NONE    0
 105 #define DRM_MODE_PICTURE_ASPECT_4_3     1
 106 #define DRM_MODE_PICTURE_ASPECT_16_9    2
 107
 108 /* Dithering mode options */
 109 #define DRM_MODE_DITHERING_OFF  0
 110 #define DRM_MODE_DITHERING_ON   1
 111 #define DRM_MODE_DITHERING_AUTO 2
 112
 113 /* Dirty info options */
 114 #define DRM_MODE_DIRTY_OFF      0
 115 #define DRM_MODE_DIRTY_ON       1
 116 #define DRM_MODE_DIRTY_ANNOTATE 2
 117
 118 /* Link Status options */
 119 #define DRM_MODE_LINK_STATUS_GOOD       0
 120 #define DRM_MODE_LINK_STATUS_BAD        1
 121
 122 /*
 123  * DRM_MODE_ROTATE_<degrees>
 124  *
 125  * Signals that a drm plane is been rotated <degrees> degrees in counter
 126  * clockwise direction.
 127  *
 128  * This define is provided as a convenience, looking up the property id
 129  * using the name->prop id lookup is the preferred method.
 130  */
 131 #define DRM_MODE_ROTATE_0       (1<<0)
 132 #define DRM_MODE_ROTATE_90      (1<<1)
 133 #define DRM_MODE_ROTATE_180     (1<<2)
 134 #define DRM_MODE_ROTATE_270     (1<<3)
 135
 136 /*
 137  * DRM_MODE_ROTATE_MASK
 138  *
 139  * Bitmask used to look for drm plane rotations.
 140  */
 141 #define DRM_MODE_ROTATE_MASK (\
 142                 DRM_MODE_ROTATE_0  | \
 143                 DRM_MODE_ROTATE_90  | \
 144                 DRM_MODE_ROTATE_180 | \
 145                 DRM_MODE_ROTATE_270)
 146
 147 /*
 148  * DRM_MODE_REFLECT_<axis>
 149  *
 150  * Signals that the contents of a drm plane is reflected in the <axis> axis,
 151  * in the same way as mirroring.
 152  *
 153  * This define is provided as a convenience, looking up the property id
 154  * using the name->prop id lookup is the preferred method.
 155  */
 156 #define DRM_MODE_REFLECT_X      (1<<4)
 157 #define DRM_MODE_REFLECT_Y      (1<<5)
 158
 159 /*
 160  * DRM_MODE_REFLECT_MASK
 161  *
 162  * Bitmask used to look for drm plane reflections.
 163  */
 164 #define DRM_MODE_REFLECT_MASK (\
 165                 DRM_MODE_REFLECT_X | \
 166                 DRM_MODE_REFLECT_Y)
 167
 168
 169 struct drm_mode_modeinfo {
 170         __u32 clock;
 171         __u16 hdisplay;
 172         __u16 hsync_start;
 173         __u16 hsync_end;
 174         __u16 htotal;
 175         __u16 hskew;
 176         __u16 vdisplay;
 177         __u16 vsync_start;
 178         __u16 vsync_end;
 179         __u16 vtotal;
 180         __u16 vscan;
 181
 182         __u32 vrefresh;
 183
 184         __u32 flags;
 185         __u32 type;
 186         char name[DRM_DISPLAY_MODE_LEN];
 187 };
 188
 189 struct drm_mode_card_res {
 190         __u64 fb_id_ptr;
 191         __u64 crtc_id_ptr;
 192         __u64 connector_id_ptr;
 193         __u64 encoder_id_ptr;
 194         __u32 count_fbs;
 195         __u32 count_crtcs;
 196         __u32 count_connectors;
 197         __u32 count_encoders;
 198         __u32 min_width;
 199         __u32 max_width;
 200         __u32 min_height;
 201         __u32 max_height;
 202 };
 203
 204 struct drm_mode_crtc {
 205         __u64 set_connectors_ptr;
 206         __u32 count_connectors;
 207
 208         __u32 crtc_id; /**< Id */
 209         __u32 fb_id; /**< Id of framebuffer */
 210
 211         __u32 x; /**< x Position on the framebuffer */
 212         __u32 y; /**< y Position on the framebuffer */
 213
 214         __u32 gamma_size;
 215         __u32 mode_valid;
 216         struct drm_mode_modeinfo mode;
 217 };
 218
 219 #define DRM_MODE_PRESENT_TOP_FIELD      (1<<0)
 220 #define DRM_MODE_PRESENT_BOTTOM_FIELD   (1<<1)
 221
 222 /* Planes blend with or override other bits on the CRTC */
 223 struct drm_mode_set_plane {
 224         __u32 plane_id;
 225         __u32 crtc_id;
 226         __u32 fb_id; /* fb object contains surface format type */
 227         __u32 flags; /* see above flags */
 228
 229         /* Signed dest location allows it to be partially off screen */
 230         __s32 crtc_x;
 231         __s32 crtc_y;
 232         __u32 crtc_w;
 233         __u32 crtc_h;
 234
 235         /* Source values are 16.16 fixed point */
 236         __u32 src_x;
 237         __u32 src_y;
 238         __u32 src_h;
 239         __u32 src_w;
 240 };
 241
 242 struct drm_mode_get_plane {
 243         __u32 plane_id;
 244
 245         __u32 crtc_id;
 246         __u32 fb_id;
 247
 248         __u32 possible_crtcs;
 249         __u32 gamma_size;
 250
 251         __u32 count_format_types;
 252         __u64 format_type_ptr;
 253 };
 254
 255 struct drm_mode_get_plane_res {
 256         __u64 plane_id_ptr;
 257         __u32 count_planes;
 258 };
 259
 260 #define DRM_MODE_ENCODER_NONE   0
 261 #define DRM_MODE_ENCODER_DAC    1
 262 #define DRM_MODE_ENCODER_TMDS   2
 263 #define DRM_MODE_ENCODER_LVDS   3
 264 #define DRM_MODE_ENCODER_TVDAC  4
 265 #define DRM_MODE_ENCODER_VIRTUAL 5
 266 #define DRM_MODE_ENCODER_DSI    6
 267 #define DRM_MODE_ENCODER_DPMST  7
 268 #define DRM_MODE_ENCODER_DPI    8
 269
 270 struct drm_mode_get_encoder {
 271         __u32 encoder_id;
 272         __u32 encoder_type;
 273
 274         __u32 crtc_id; /**< Id of crtc */
 275
 276         __u32 possible_crtcs;
 277         __u32 possible_clones;
 278 };
 279
 280 /* This is for connectors with multiple signal types. */
 281 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
 282 enum drm_mode_subconnector {
 283         DRM_MODE_SUBCONNECTOR_Automatic = 0,
 284         DRM_MODE_SUBCONNECTOR_Unknown = 0,
 285         DRM_MODE_SUBCONNECTOR_DVID = 3,
 286         DRM_MODE_SUBCONNECTOR_DVIA = 4,
 287         DRM_MODE_SUBCONNECTOR_Composite = 5,
 288         DRM_MODE_SUBCONNECTOR_SVIDEO = 6,
 289         DRM_MODE_SUBCONNECTOR_Component = 8,
 290         DRM_MODE_SUBCONNECTOR_SCART = 9,
 291 };
 292
 293 #define DRM_MODE_CONNECTOR_Unknown      0
 294 #define DRM_MODE_CONNECTOR_VGA          1
 295 #define DRM_MODE_CONNECTOR_DVII         2
 296 #define DRM_MODE_CONNECTOR_DVID         3
 297 #define DRM_MODE_CONNECTOR_DVIA         4
 298 #define DRM_MODE_CONNECTOR_Composite    5
 299 #define DRM_MODE_CONNECTOR_SVIDEO       6
 300 #define DRM_MODE_CONNECTOR_LVDS         7
 301 #define DRM_MODE_CONNECTOR_Component    8
 302 #define DRM_MODE_CONNECTOR_9PinDIN      9
 303 #define DRM_MODE_CONNECTOR_DisplayPort  10
 304 #define DRM_MODE_CONNECTOR_HDMIA        11
 305 #define DRM_MODE_CONNECTOR_HDMIB        12
 306 #define DRM_MODE_CONNECTOR_TV           13
 307 #define DRM_MODE_CONNECTOR_eDP          14
 308 #define DRM_MODE_CONNECTOR_VIRTUAL      15
 309 #define DRM_MODE_CONNECTOR_DSI          16
 310 #define DRM_MODE_CONNECTOR_DPI          17
 311
 312 struct drm_mode_get_connector {
 313
 314         __u64 encoders_ptr;
 315         __u64 modes_ptr;
 316         __u64 props_ptr;
 317         __u64 prop_values_ptr;
 318
 319         __u32 count_modes;
 320         __u32 count_props;
 321         __u32 count_encoders;
 322
 323         __u32 encoder_id; /**< Current Encoder */
 324         __u32 connector_id; /**< Id */
 325         __u32 connector_type;
 326         __u32 connector_type_id;
 327
 328         __u32 connection;
 329         __u32 mm_width;  /**< width in millimeters */
 330         __u32 mm_height; /**< height in millimeters */
 331         __u32 subpixel;
 332
 333         __u32 pad;
 334 };
 335
 336 #define DRM_MODE_PROP_PENDING   (1<<0)
 337 #define DRM_MODE_PROP_RANGE     (1<<1)
 338 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
 339 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
 340 #define DRM_MODE_PROP_BLOB      (1<<4)
 341 #define DRM_MODE_PROP_BITMASK   (1<<5) /* bitmask of enumerated types */
 342
 343 /* non-extended types: legacy bitmask, one bit per type: */
 344 #define DRM_MODE_PROP_LEGACY_TYPE  ( \
 345                 DRM_MODE_PROP_RANGE | \
 346                 DRM_MODE_PROP_ENUM | \
 347                 DRM_MODE_PROP_BLOB | \
 348                 DRM_MODE_PROP_BITMASK)
 349
 350 /* extended-types: rather than continue to consume a bit per type,
 351  * grab a chunk of the bits to use as integer type id.
 352  */
 353 #define DRM_MODE_PROP_EXTENDED_TYPE     0x0000ffc0
 354 #define DRM_MODE_PROP_TYPE(n)           ((n) << 6)
 355 #define DRM_MODE_PROP_OBJECT            DRM_MODE_PROP_TYPE(1)
 356 #define DRM_MODE_PROP_SIGNED_RANGE      DRM_MODE_PROP_TYPE(2)
 357
 358 /* the PROP_ATOMIC flag is used to hide properties from userspace that
 359  * is not aware of atomic properties.  This is mostly to work around
 360  * older userspace (DDX drivers) that read/write each prop they find,
 361  * witout being aware that this could be triggering a lengthy modeset.
 362  */
 363 #define DRM_MODE_PROP_ATOMIC        0x80000000
 364
 365 struct drm_mode_property_enum {
 366         __u64 value;
 367         char name[DRM_PROP_NAME_LEN];
 368 };
 369
 370 struct drm_mode_get_property {
 371         __u64 values_ptr; /* values and blob lengths */
 372         __u64 enum_blob_ptr; /* enum and blob id ptrs */
 373
 374         __u32 prop_id;
 375         __u32 flags;
 376         char name[DRM_PROP_NAME_LEN];
 377
 378         __u32 count_values;
 379         /* This is only used to count enum values, not blobs. The _blobs is
 380          * simply because of a historical reason, i.e. backwards compat. */
 381         __u32 count_enum_blobs;
 382 };
 383
 384 struct drm_mode_connector_set_property {
 385         __u64 value;
 386         __u32 prop_id;
 387         __u32 connector_id;
 388 };
 389
 390 #define DRM_MODE_OBJECT_CRTC 0xcccccccc
 391 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0
 392 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0
 393 #define DRM_MODE_OBJECT_MODE 0xdededede
 394 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0
 395 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb
 396 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb
 397 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee
 398 #define DRM_MODE_OBJECT_ANY 0
 399
 400 struct drm_mode_obj_get_properties {
 401         __u64 props_ptr;
 402         __u64 prop_values_ptr;
 403         __u32 count_props;
 404         __u32 obj_id;
 405         __u32 obj_type;
 406 };
 407
 408 struct drm_mode_obj_set_property {
 409         __u64 value;
 410         __u32 prop_id;
 411         __u32 obj_id;
 412         __u32 obj_type;
 413 };
 414
 415 struct drm_mode_get_blob {
 416         __u32 blob_id;
 417         __u32 length;
 418         __u64 data;
 419 };
 420
 421 struct drm_mode_fb_cmd {
 422         __u32 fb_id;
 423         __u32 width;
 424         __u32 height;
 425         __u32 pitch;
 426         __u32 bpp;
 427         __u32 depth;
 428         /* driver specific handle */
 429         __u32 handle;
 430 };
 431
 432 #define DRM_MODE_FB_INTERLACED  (1<<0) /* for interlaced framebuffers */
 433 #define DRM_MODE_FB_MODIFIERS   (1<<1) /* enables ->modifer[] */
 434
 435 struct drm_mode_fb_cmd2 {
 436         __u32 fb_id;
 437         __u32 width;
 438         __u32 height;
 439         __u32 pixel_format; /* fourcc code from drm_fourcc.h */
 440         __u32 flags; /* see above flags */
 441
 442         /*
 443          * In case of planar formats, this ioctl allows up to 4
 444          * buffer objects with offsets and pitches per plane.
 445          * The pitch and offset order is dictated by the fourcc,
 446          * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as:
 447          *
 448          *   YUV 4:2:0 image with a plane of 8 bit Y samples
 449          *   followed by an interleaved U/V plane containing
 450          *   8 bit 2x2 subsampled colour difference samples.
 451          *
 452          * So it would consist of Y as offsets[0] and UV as
 453          * offsets[1].  Note that offsets[0] will generally
 454          * be 0 (but this is not required).
 455          *
 456          * To accommodate tiled, compressed, etc formats, a
 457          * modifier can be specified.  The default value of zero
 458          * indicates "native" format as specified by the fourcc.
 459          * Vendor specific modifier token.  Note that even though
 460          * it looks like we have a modifier per-plane, we in fact
 461          * do not. The modifier for each plane must be identical.
 462          * Thus all combinations of different data layouts for
 463          * multi plane formats must be enumerated as separate
 464          * modifiers.
 465          */
 466         __u32 handles[4];
 467         __u32 pitches[4]; /* pitch for each plane */
 468         __u32 offsets[4]; /* offset of each plane */
 469         __u64 modifier[4]; /* ie, tiling, compress */
 470 };
 471
 472 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
 473 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
 474 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
 475
 476 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
 477
 478 /*
 479  * Mark a region of a framebuffer as dirty.
 480  *
 481  * Some hardware does not automatically update display contents
 482  * as a hardware or software draw to a framebuffer. This ioctl
 483  * allows userspace to tell the kernel and the hardware what
 484  * regions of the framebuffer have changed.
 485  *
 486  * The kernel or hardware is free to update more then just the
 487  * region specified by the clip rects. The kernel or hardware
 488  * may also delay and/or coalesce several calls to dirty into a
 489  * single update.
 490  *
 491  * Userspace may annotate the updates, the annotates are a
 492  * promise made by the caller that the change is either a copy
 493  * of pixels or a fill of a single color in the region specified.
 494  *
 495  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
 496  * the number of updated regions are half of num_clips given,
 497  * where the clip rects are paired in src and dst. The width and
 498  * height of each one of the pairs must match.
 499  *
 500  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
 501  * promises that the region specified of the clip rects is filled
 502  * completely with a single color as given in the color argument.
 503  */
 504
 505 struct drm_mode_fb_dirty_cmd {
 506         __u32 fb_id;
 507         __u32 flags;
 508         __u32 color;
 509         __u32 num_clips;
 510         __u64 clips_ptr;
 511 };
 512
 513 struct drm_mode_mode_cmd {
 514         __u32 connector_id;
 515         struct drm_mode_modeinfo mode;
 516 };
 517
 518 #define DRM_MODE_CURSOR_BO      0x01
 519 #define DRM_MODE_CURSOR_MOVE    0x02
 520 #define DRM_MODE_CURSOR_FLAGS   0x03
 521
 522 /*
 523  * depending on the value in flags different members are used.
 524  *
 525  * CURSOR_BO uses
 526  *    crtc_id
 527  *    width
 528  *    height
 529  *    handle - if 0 turns the cursor off
 530  *
 531  * CURSOR_MOVE uses
 532  *    crtc_id
 533  *    x
 534  *    y
 535  */
 536 struct drm_mode_cursor {
 537         __u32 flags;
 538         __u32 crtc_id;
 539         __s32 x;
 540         __s32 y;
 541         __u32 width;
 542         __u32 height;
 543         /* driver specific handle */
 544         __u32 handle;
 545 };
 546
 547 struct drm_mode_cursor2 {
 548         __u32 flags;
 549         __u32 crtc_id;
 550         __s32 x;
 551         __s32 y;
 552         __u32 width;
 553         __u32 height;
 554         /* driver specific handle */
 555         __u32 handle;
 556         __s32 hot_x;
 557         __s32 hot_y;
 558 };
 559
 560 struct drm_mode_crtc_lut {
 561         __u32 crtc_id;
 562         __u32 gamma_size;
 563
 564         /* pointers to arrays */
 565         __u64 red;
 566         __u64 green;
 567         __u64 blue;
 568 };
 569
 570 struct drm_color_ctm {
 571         /* Conversion matrix in S31.32 format. */
 572         __s64 matrix[9];
 573 };
 574
 575 struct drm_color_lut {
 576         /*
 577          * Data is U0.16 fixed point format.
 578          */
 579         __u16 red;
 580         __u16 green;
 581         __u16 blue;
 582         __u16 reserved;
 583 };
 584
 585 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
 586 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02
 587 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4
 588 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8
 589 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \
 590                                    DRM_MODE_PAGE_FLIP_TARGET_RELATIVE)
 591 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \
 592                                   DRM_MODE_PAGE_FLIP_ASYNC | \
 593                                   DRM_MODE_PAGE_FLIP_TARGET)
 594
 595 /*
 596  * Request a page flip on the specified crtc.
 597  *
 598  * This ioctl will ask KMS to schedule a page flip for the specified
 599  * crtc.  Once any pending rendering targeting the specified fb (as of
 600  * ioctl time) has completed, the crtc will be reprogrammed to display
 601  * that fb after the next vertical refresh.  The ioctl returns
 602  * immediately, but subsequent rendering to the current fb will block
 603  * in the execbuffer ioctl until the page flip happens.  If a page
 604  * flip is already pending as the ioctl is called, EBUSY will be
 605  * returned.
 606  *
 607  * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank
 608  * event (see drm.h: struct drm_event_vblank) when the page flip is
 609  * done.  The user_data field passed in with this ioctl will be
 610  * returned as the user_data field in the vblank event struct.
 611  *
 612  * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen
 613  * 'as soon as possible', meaning that it not delay waiting for vblank.
 614  * This may cause tearing on the screen.
 615  *
 616  * The reserved field must be zero.
 617  */
 618
 619 struct drm_mode_crtc_page_flip {
 620         __u32 crtc_id;
 621         __u32 fb_id;
 622         __u32 flags;
 623         __u32 reserved;
 624         __u64 user_data;
 625 };
 626
 627 /*
 628  * Request a page flip on the specified crtc.
 629  *
 630  * Same as struct drm_mode_crtc_page_flip, but supports new flags and
 631  * re-purposes the reserved field:
 632  *
 633  * The sequence field must be zero unless either of the
 634  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When
 635  * the ABSOLUTE flag is specified, the sequence field denotes the absolute
 636  * vblank sequence when the flip should take effect. When the RELATIVE
 637  * flag is specified, the sequence field denotes the relative (to the
 638  * current one when the ioctl is called) vblank sequence when the flip
 639  * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to
 640  * make sure the vblank sequence before the target one has passed before
 641  * calling this ioctl. The purpose of the
 642  * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify
 643  * the target for when code dealing with a page flip runs during a
 644  * vertical blank period.
 645  */
 646
 647 struct drm_mode_crtc_page_flip_target {
 648         __u32 crtc_id;
 649         __u32 fb_id;
 650         __u32 flags;
 651         __u32 sequence;
 652         __u64 user_data;
 653 };
 654
 655 /* create a dumb scanout buffer */
 656 struct drm_mode_create_dumb {
 657         __u32 height;
 658         __u32 width;
 659         __u32 bpp;
 660         __u32 flags;
 661         /* handle, pitch, size will be returned */
 662         __u32 handle;
 663         __u32 pitch;
 664         __u64 size;
 665 };
 666
 667 /* set up for mmap of a dumb scanout buffer */
 668 struct drm_mode_map_dumb {
 669         /** Handle for the object being mapped. */
 670         __u32 handle;
 671         __u32 pad;
 672         /**
 673          * Fake offset to use for subsequent mmap call
 674          *
 675          * This is a fixed-size type for 32/64 compatibility.
 676          */
 677         __u64 offset;
 678 };
 679
 680 struct drm_mode_destroy_dumb {
 681         __u32 handle;
 682 };
 683
 684 /* page-flip flags are valid, plus: */
 685 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100
 686 #define DRM_MODE_ATOMIC_NONBLOCK  0x0200
 687 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400
 688
 689 #define DRM_MODE_ATOMIC_FLAGS (\
 690                 DRM_MODE_PAGE_FLIP_EVENT |\
 691                 DRM_MODE_PAGE_FLIP_ASYNC |\
 692                 DRM_MODE_ATOMIC_TEST_ONLY |\
 693                 DRM_MODE_ATOMIC_NONBLOCK |\
 694                 DRM_MODE_ATOMIC_ALLOW_MODESET)
 695
 696 struct drm_mode_atomic {
 697         __u32 flags;
 698         __u32 count_objs;
 699         __u64 objs_ptr;
 700         __u64 count_props_ptr;
 701         __u64 props_ptr;
 702         __u64 prop_values_ptr;
 703         __u64 reserved;
 704         __u64 user_data;
 705 };
 706
 707 struct drm_format_modifier_blob {
 708 #define FORMAT_BLOB_CURRENT 1
 709         /* Version of this blob format */
 710         __u32 version;
 711
 712         /* Flags */
 713         __u32 flags;
 714
 715         /* Number of fourcc formats supported */
 716         __u32 count_formats;
 717
 718         /* Where in this blob the formats exist (in bytes) */
 719         __u32 formats_offset;
 720
 721         /* Number of drm_format_modifiers */
 722         __u32 count_modifiers;
 723
 724         /* Where in this blob the modifiers exist (in bytes) */
 725         __u32 modifiers_offset;
 726
 727         /* u32 formats[] */
 728         /* struct drm_format_modifier modifiers[] */
 729 };
 730
 731 struct drm_format_modifier {
 732         /* Bitmask of formats in get_plane format list this info applies to. The
 733          * offset allows a sliding window of which 64 formats (bits).
 734          *
 735          * Some examples:
 736          * In today's world with < 65 formats, and formats 0, and 2 are
 737          * supported
 738          * 0x0000000000000005
 739          *                ^-offset = 0, formats = 5
 740          *
 741          * If the number formats grew to 128, and formats 98-102 are
 742          * supported with the modifier:
 743          *
 744          * 0x0000003c00000000 0000000000000000
 745          *                ^
 746          *                |__offset = 64, formats = 0x3c00000000
 747          *
 748          */
 749         __u64 formats;
 750         __u32 offset;
 751         __u32 pad;
 752
 753         /* The modifier that applies to the >get_plane format list bitmask. */
 754         __u64 modifier;
 755 };
 756
 757 /**
 758  * Create a new 'blob' data property, copying length bytes from data pointer,
 759  * and returning new blob ID.
 760  */
 761 struct drm_mode_create_blob {
 762         /** Pointer to data to copy. */
 763         __u64 data;
 764         /** Length of data to copy. */
 765         __u32 length;
 766         /** Return: new property ID. */
 767         __u32 blob_id;
 768 };
 769
 770 /**
 771  * Destroy a user-created blob property.
 772  */
 773 struct drm_mode_destroy_blob {
 774         __u32 blob_id;
 775 };
 776
 777 #if defined(__cplusplus)
 778 }
 779 #endif
 780
 781 #endif