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