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