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