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