1 /* 2 * Header for the Direct Rendering Manager 3 * 4 * Author: Rickard E. (Rik) Faith <faith (at) valinux.com> 5 * 6 * Acknowledgments: 7 * Dec 1999, Richard Henderson <rth (at) twiddle.net>, move to generic cmpxchg. 8 */ 9 10 /* 11 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. 12 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. 13 * All rights reserved. 14 * 15 * Permission is hereby granted, free of charge, to any person obtaining a 16 * copy of this software and associated documentation files (the "Software"), 17 * to deal in the Software without restriction, including without limitation 18 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 19 * and/or sell copies of the Software, and to permit persons to whom the 20 * Software is furnished to do so, subject to the following conditions: 21 * 22 * The above copyright notice and this permission notice (including the next 23 * paragraph) shall be included in all copies or substantial portions of the 24 * Software. 25 * 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 29 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 30 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 31 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 32 * OTHER DEALINGS IN THE SOFTWARE. 33 */ 34 35 #ifndef _DRM_H_ 36 #define _DRM_H_ 37 38 #if defined(__linux__) 39 40 #include <linux/types.h> 41 #include <asm/ioctl.h> 42 typedef unsigned int drm_handle_t; 43 44 #else /* One of the BSDs */ 45 46 #include <stdint.h> 47 #include <sys/ioccom.h> 48 #include <sys/types.h> 49 #ifndef __linux_sized_types__ 50 #define __linux_sized_types__ 51 typedef int8_t __s8; 52 typedef uint8_t __u8; 53 typedef int16_t __s16; 54 typedef uint16_t __u16; 55 typedef int32_t __s32; 56 typedef uint32_t __u32; 57 typedef int64_t __s64; 58 typedef uint64_t __u64; 59 #endif /* __linux_sized_types__ */ 60 typedef size_t __kernel_size_t; 61 typedef unsigned long drm_handle_t; 62 63 #endif 64 65 #if defined(__cplusplus) 66 extern "C" { 67 #endif 68 69 #define DRM_NAME "drm" /**< Name in kernel, /dev, and /proc */ 70 #define DRM_MIN_ORDER 5 /**< At least 2^5 bytes = 32 bytes */ 71 #define DRM_MAX_ORDER 22 /**< Up to 2^22 bytes = 4MB */ 72 #define DRM_RAM_PERCENT 10 /**< How much system ram can we lock? */ 73 74 #define _DRM_LOCK_HELD 0x80000000U /**< Hardware lock is held */ 75 #define _DRM_LOCK_CONT 0x40000000U /**< Hardware lock is contended */ 76 #define _DRM_LOCK_IS_HELD(lock) ((lock) & _DRM_LOCK_HELD) 77 #define _DRM_LOCK_IS_CONT(lock) ((lock) & _DRM_LOCK_CONT) 78 #define _DRM_LOCKING_CONTEXT(lock) ((lock) & ~(_DRM_LOCK_HELD|_DRM_LOCK_CONT)) 79 80 typedef unsigned int drm_context_t; 81 typedef unsigned int drm_drawable_t; 82 typedef unsigned int drm_magic_t; 83 84 /* 85 * Cliprect. 86 * 87 * \warning: If you change this structure, make sure you change 88 * XF86DRIClipRectRec in the server as well 89 * 90 * \note KW: Actually it's illegal to change either for 91 * backwards-compatibility reasons. 92 */ 93 struct drm_clip_rect { 94 unsigned short x1; 95 unsigned short y1; 96 unsigned short x2; 97 unsigned short y2; 98 }; 99 100 /* 101 * Drawable information. 102 */ 103 struct drm_drawable_info { 104 unsigned int num_rects; 105 struct drm_clip_rect *rects; 106 }; 107 108 /* 109 * Texture region, 110 */ 111 struct drm_tex_region { 112 unsigned char next; 113 unsigned char prev; 114 unsigned char in_use; 115 unsigned char padding; 116 unsigned int age; 117 }; 118 119 /* 120 * Hardware lock. 121 * 122 * The lock structure is a simple cache-line aligned integer. To avoid 123 * processor bus contention on a multiprocessor system, there should not be any 124 * other data stored in the same cache line. 125 */ 126 struct drm_hw_lock { 127 __volatile__ unsigned int lock; /**< lock variable */ 128 char padding[60]; /**< Pad to cache line */ 129 }; 130 131 /* 132 * DRM_IOCTL_VERSION ioctl argument type. 133 * 134 * \sa drmGetVersion(). 135 */ 136 struct drm_version { 137 int version_major; /**< Major version */ 138 int version_minor; /**< Minor version */ 139 int version_patchlevel; /**< Patch level */ 140 __kernel_size_t name_len; /**< Length of name buffer */ 141 char *name; /**< Name of driver */ 142 __kernel_size_t date_len; /**< Length of date buffer */ 143 char *date; /**< User-space buffer to hold date */ 144 __kernel_size_t desc_len; /**< Length of desc buffer */ 145 char *desc; /**< User-space buffer to hold desc */ 146 }; 147 148 /* 149 * DRM_IOCTL_GET_UNIQUE ioctl argument type. 150 * 151 * \sa drmGetBusid() and drmSetBusId(). 152 */ 153 struct drm_unique { 154 __kernel_size_t unique_len; /**< Length of unique */ 155 char *unique; /**< Unique name for driver instantiation */ 156 }; 157 158 struct drm_list { 159 int count; /**< Length of user-space structures */ 160 struct drm_version *version; 161 }; 162 163 struct drm_block { 164 int unused; 165 }; 166 167 /* 168 * DRM_IOCTL_CONTROL ioctl argument type. 169 * 170 * \sa drmCtlInstHandler() and drmCtlUninstHandler(). 171 */ 172 struct drm_control { 173 enum { 174 DRM_ADD_COMMAND, 175 DRM_RM_COMMAND, 176 DRM_INST_HANDLER, 177 DRM_UNINST_HANDLER 178 } func; 179 int irq; 180 }; 181 182 /* 183 * Type of memory to map. 184 */ 185 enum drm_map_type { 186 _DRM_FRAME_BUFFER = 0, /**< WC (no caching), no core dump */ 187 _DRM_REGISTERS = 1, /**< no caching, no core dump */ 188 _DRM_SHM = 2, /**< shared, cached */ 189 _DRM_AGP = 3, /**< AGP/GART */ 190 _DRM_SCATTER_GATHER = 4, /**< Scatter/gather memory for PCI DMA */ 191 _DRM_CONSISTENT = 5 /**< Consistent memory for PCI DMA */ 192 }; 193 194 /* 195 * Memory mapping flags. 196 */ 197 enum drm_map_flags { 198 _DRM_RESTRICTED = 0x01, /**< Cannot be mapped to user-virtual */ 199 _DRM_READ_ONLY = 0x02, 200 _DRM_LOCKED = 0x04, /**< shared, cached, locked */ 201 _DRM_KERNEL = 0x08, /**< kernel requires access */ 202 _DRM_WRITE_COMBINING = 0x10, /**< use write-combining if available */ 203 _DRM_CONTAINS_LOCK = 0x20, /**< SHM page that contains lock */ 204 _DRM_REMOVABLE = 0x40, /**< Removable mapping */ 205 _DRM_DRIVER = 0x80 /**< Managed by driver */ 206 }; 207 208 struct drm_ctx_priv_map { 209 unsigned int ctx_id; /**< Context requesting private mapping */ 210 void *handle; /**< Handle of map */ 211 }; 212 213 /* 214 * DRM_IOCTL_GET_MAP, DRM_IOCTL_ADD_MAP and DRM_IOCTL_RM_MAP ioctls 215 * argument type. 216 * 217 * \sa drmAddMap(). 218 */ 219 struct drm_map { 220 unsigned long offset; /**< Requested physical address (0 for SAREA)*/ 221 unsigned long size; /**< Requested physical size (bytes) */ 222 enum drm_map_type type; /**< Type of memory to map */ 223 enum drm_map_flags flags; /**< Flags */ 224 void *handle; /**< User-space: "Handle" to pass to mmap() */ 225 /**< Kernel-space: kernel-virtual address */ 226 int mtrr; /**< MTRR slot used */ 227 /* Private data */ 228 }; 229 230 /* 231 * DRM_IOCTL_GET_CLIENT ioctl argument type. 232 */ 233 struct drm_client { 234 int idx; /**< Which client desired? */ 235 int auth; /**< Is client authenticated? */ 236 unsigned long pid; /**< Process ID */ 237 unsigned long uid; /**< User ID */ 238 unsigned long magic; /**< Magic */ 239 unsigned long iocs; /**< Ioctl count */ 240 }; 241 242 enum drm_stat_type { 243 _DRM_STAT_LOCK, 244 _DRM_STAT_OPENS, 245 _DRM_STAT_CLOSES, 246 _DRM_STAT_IOCTLS, 247 _DRM_STAT_LOCKS, 248 _DRM_STAT_UNLOCKS, 249 _DRM_STAT_VALUE, /**< Generic value */ 250 _DRM_STAT_BYTE, /**< Generic byte counter (1024bytes/K) */ 251 _DRM_STAT_COUNT, /**< Generic non-byte counter (1000/k) */ 252 253 _DRM_STAT_IRQ, /**< IRQ */ 254 _DRM_STAT_PRIMARY, /**< Primary DMA bytes */ 255 _DRM_STAT_SECONDARY, /**< Secondary DMA bytes */ 256 _DRM_STAT_DMA, /**< DMA */ 257 _DRM_STAT_SPECIAL, /**< Special DMA (e.g., priority or polled) */ 258 _DRM_STAT_MISSED /**< Missed DMA opportunity */ 259 /* Add to the *END* of the list */ 260 }; 261 262 /* 263 * DRM_IOCTL_GET_STATS ioctl argument type. 264 */ 265 struct drm_stats { 266 unsigned long count; 267 struct { 268 unsigned long value; 269 enum drm_stat_type type; 270 } data[15]; 271 }; 272 273 /* 274 * Hardware locking flags. 275 */ 276 enum drm_lock_flags { 277 _DRM_LOCK_READY = 0x01, /**< Wait until hardware is ready for DMA */ 278 _DRM_LOCK_QUIESCENT = 0x02, /**< Wait until hardware quiescent */ 279 _DRM_LOCK_FLUSH = 0x04, /**< Flush this context's DMA queue first */ 280 _DRM_LOCK_FLUSH_ALL = 0x08, /**< Flush all DMA queues first */ 281 /* These *HALT* flags aren't supported yet 282 -- they will be used to support the 283 full-screen DGA-like mode. */ 284 _DRM_HALT_ALL_QUEUES = 0x10, /**< Halt all current and future queues */ 285 _DRM_HALT_CUR_QUEUES = 0x20 /**< Halt all current queues */ 286 }; 287 288 /* 289 * DRM_IOCTL_LOCK, DRM_IOCTL_UNLOCK and DRM_IOCTL_FINISH ioctl argument type. 290 * 291 * \sa drmGetLock() and drmUnlock(). 292 */ 293 struct drm_lock { 294 int context; 295 enum drm_lock_flags flags; 296 }; 297 298 /* 299 * DMA flags 300 * 301 * \warning 302 * These values \e must match xf86drm.h. 303 * 304 * \sa drm_dma. 305 */ 306 enum drm_dma_flags { 307 /* Flags for DMA buffer dispatch */ 308 _DRM_DMA_BLOCK = 0x01, /**< 309 * Block until buffer dispatched. 310 * 311 * \note The buffer may not yet have 312 * been processed by the hardware -- 313 * getting a hardware lock with the 314 * hardware quiescent will ensure 315 * that the buffer has been 316 * processed. 317 */ 318 _DRM_DMA_WHILE_LOCKED = 0x02, /**< Dispatch while lock held */ 319 _DRM_DMA_PRIORITY = 0x04, /**< High priority dispatch */ 320 321 /* Flags for DMA buffer request */ 322 _DRM_DMA_WAIT = 0x10, /**< Wait for free buffers */ 323 _DRM_DMA_SMALLER_OK = 0x20, /**< Smaller-than-requested buffers OK */ 324 _DRM_DMA_LARGER_OK = 0x40 /**< Larger-than-requested buffers OK */ 325 }; 326 327 /* 328 * DRM_IOCTL_ADD_BUFS and DRM_IOCTL_MARK_BUFS ioctl argument type. 329 * 330 * \sa drmAddBufs(). 331 */ 332 struct drm_buf_desc { 333 int count; /**< Number of buffers of this size */ 334 int size; /**< Size in bytes */ 335 int low_mark; /**< Low water mark */ 336 int high_mark; /**< High water mark */ 337 enum { 338 _DRM_PAGE_ALIGN = 0x01, /**< Align on page boundaries for DMA */ 339 _DRM_AGP_BUFFER = 0x02, /**< Buffer is in AGP space */ 340 _DRM_SG_BUFFER = 0x04, /**< Scatter/gather memory buffer */ 341 _DRM_FB_BUFFER = 0x08, /**< Buffer is in frame buffer */ 342 _DRM_PCI_BUFFER_RO = 0x10 /**< Map PCI DMA buffer read-only */ 343 } flags; 344 unsigned long agp_start; /**< 345 * Start address of where the AGP buffers are 346 * in the AGP aperture 347 */ 348 }; 349 350 /* 351 * DRM_IOCTL_INFO_BUFS ioctl argument type. 352 */ 353 struct drm_buf_info { 354 int count; /**< Entries in list */ 355 struct drm_buf_desc *list; 356 }; 357 358 /* 359 * DRM_IOCTL_FREE_BUFS ioctl argument type. 360 */ 361 struct drm_buf_free { 362 int count; 363 int *list; 364 }; 365 366 /* 367 * Buffer information 368 * 369 * \sa drm_buf_map. 370 */ 371 struct drm_buf_pub { 372 int idx; /**< Index into the master buffer list */ 373 int total; /**< Buffer size */ 374 int used; /**< Amount of buffer in use (for DMA) */ 375 void *address; /**< Address of buffer */ 376 }; 377 378 /* 379 * DRM_IOCTL_MAP_BUFS ioctl argument type. 380 */ 381 struct drm_buf_map { 382 int count; /**< Length of the buffer list */ 383 #ifdef __cplusplus 384 void *virt; 385 #else 386 void *virtual; /**< Mmap'd area in user-virtual */ 387 #endif 388 struct drm_buf_pub *list; /**< Buffer information */ 389 }; 390 391 /* 392 * DRM_IOCTL_DMA ioctl argument type. 393 * 394 * Indices here refer to the offset into the buffer list in drm_buf_get. 395 * 396 * \sa drmDMA(). 397 */ 398 struct drm_dma { 399 int context; /**< Context handle */ 400 int send_count; /**< Number of buffers to send */ 401 int *send_indices; /**< List of handles to buffers */ 402 int *send_sizes; /**< Lengths of data to send */ 403 enum drm_dma_flags flags; /**< Flags */ 404 int request_count; /**< Number of buffers requested */ 405 int request_size; /**< Desired size for buffers */ 406 int *request_indices; /**< Buffer information */ 407 int *request_sizes; 408 int granted_count; /**< Number of buffers granted */ 409 }; 410 411 enum drm_ctx_flags { 412 _DRM_CONTEXT_PRESERVED = 0x01, 413 _DRM_CONTEXT_2DONLY = 0x02 414 }; 415 416 /* 417 * DRM_IOCTL_ADD_CTX ioctl argument type. 418 * 419 * \sa drmCreateContext() and drmDestroyContext(). 420 */ 421 struct drm_ctx { 422 drm_context_t handle; 423 enum drm_ctx_flags flags; 424 }; 425 426 /* 427 * DRM_IOCTL_RES_CTX ioctl argument type. 428 */ 429 struct drm_ctx_res { 430 int count; 431 struct drm_ctx *contexts; 432 }; 433 434 /* 435 * DRM_IOCTL_ADD_DRAW and DRM_IOCTL_RM_DRAW ioctl argument type. 436 */ 437 struct drm_draw { 438 drm_drawable_t handle; 439 }; 440 441 /* 442 * DRM_IOCTL_UPDATE_DRAW ioctl argument type. 443 */ 444 typedef enum { 445 DRM_DRAWABLE_CLIPRECTS 446 } drm_drawable_info_type_t; 447 448 struct drm_update_draw { 449 drm_drawable_t handle; 450 unsigned int type; 451 unsigned int num; 452 unsigned long long data; 453 }; 454 455 /* 456 * DRM_IOCTL_GET_MAGIC and DRM_IOCTL_AUTH_MAGIC ioctl argument type. 457 */ 458 struct drm_auth { 459 drm_magic_t magic; 460 }; 461 462 /* 463 * DRM_IOCTL_IRQ_BUSID ioctl argument type. 464 * 465 * \sa drmGetInterruptFromBusID(). 466 */ 467 struct drm_irq_busid { 468 int irq; /**< IRQ number */ 469 int busnum; /**< bus number */ 470 int devnum; /**< device number */ 471 int funcnum; /**< function number */ 472 }; 473 474 enum drm_vblank_seq_type { 475 _DRM_VBLANK_ABSOLUTE = 0x0, /**< Wait for specific vblank sequence number */ 476 _DRM_VBLANK_RELATIVE = 0x1, /**< Wait for given number of vblanks */ 477 /* bits 1-6 are reserved for high crtcs */ 478 _DRM_VBLANK_HIGH_CRTC_MASK = 0x0000003e, 479 _DRM_VBLANK_EVENT = 0x4000000, /**< Send event instead of blocking */ 480 _DRM_VBLANK_FLIP = 0x8000000, /**< Scheduled buffer swap should flip */ 481 _DRM_VBLANK_NEXTONMISS = 0x10000000, /**< If missed, wait for next vblank */ 482 _DRM_VBLANK_SECONDARY = 0x20000000, /**< Secondary display controller */ 483 _DRM_VBLANK_SIGNAL = 0x40000000 /**< Send signal instead of blocking, unsupported */ 484 }; 485 #define _DRM_VBLANK_HIGH_CRTC_SHIFT 1 486 487 #define _DRM_VBLANK_TYPES_MASK (_DRM_VBLANK_ABSOLUTE | _DRM_VBLANK_RELATIVE) 488 #define _DRM_VBLANK_FLAGS_MASK (_DRM_VBLANK_EVENT | _DRM_VBLANK_SIGNAL | \ 489 _DRM_VBLANK_SECONDARY | _DRM_VBLANK_NEXTONMISS) 490 491 struct drm_wait_vblank_request { 492 enum drm_vblank_seq_type type; 493 unsigned int sequence; 494 unsigned long signal; 495 }; 496 497 struct drm_wait_vblank_reply { 498 enum drm_vblank_seq_type type; 499 unsigned int sequence; 500 long tval_sec; 501 long tval_usec; 502 }; 503 504 /* 505 * DRM_IOCTL_WAIT_VBLANK ioctl argument type. 506 * 507 * \sa drmWaitVBlank(). 508 */ 509 union drm_wait_vblank { 510 struct drm_wait_vblank_request request; 511 struct drm_wait_vblank_reply reply; 512 }; 513 514 #define _DRM_PRE_MODESET 1 515 #define _DRM_POST_MODESET 2 516 517 /* 518 * DRM_IOCTL_MODESET_CTL ioctl argument type 519 * 520 * \sa drmModesetCtl(). 521 */ 522 struct drm_modeset_ctl { 523 __u32 crtc; 524 __u32 cmd; 525 }; 526 527 /* 528 * DRM_IOCTL_AGP_ENABLE ioctl argument type. 529 * 530 * \sa drmAgpEnable(). 531 */ 532 struct drm_agp_mode { 533 unsigned long mode; /**< AGP mode */ 534 }; 535 536 /* 537 * DRM_IOCTL_AGP_ALLOC and DRM_IOCTL_AGP_FREE ioctls argument type. 538 * 539 * \sa drmAgpAlloc() and drmAgpFree(). 540 */ 541 struct drm_agp_buffer { 542 unsigned long size; /**< In bytes -- will round to page boundary */ 543 unsigned long handle; /**< Used for binding / unbinding */ 544 unsigned long type; /**< Type of memory to allocate */ 545 unsigned long physical; /**< Physical used by i810 */ 546 }; 547 548 /* 549 * DRM_IOCTL_AGP_BIND and DRM_IOCTL_AGP_UNBIND ioctls argument type. 550 * 551 * \sa drmAgpBind() and drmAgpUnbind(). 552 */ 553 struct drm_agp_binding { 554 unsigned long handle; /**< From drm_agp_buffer */ 555 unsigned long offset; /**< In bytes -- will round to page boundary */ 556 }; 557 558 /* 559 * DRM_IOCTL_AGP_INFO ioctl argument type. 560 * 561 * \sa drmAgpVersionMajor(), drmAgpVersionMinor(), drmAgpGetMode(), 562 * drmAgpBase(), drmAgpSize(), drmAgpMemoryUsed(), drmAgpMemoryAvail(), 563 * drmAgpVendorId() and drmAgpDeviceId(). 564 */ 565 struct drm_agp_info { 566 int agp_version_major; 567 int agp_version_minor; 568 unsigned long mode; 569 unsigned long aperture_base; /* physical address */ 570 unsigned long aperture_size; /* bytes */ 571 unsigned long memory_allowed; /* bytes */ 572 unsigned long memory_used; 573 574 /* PCI information */ 575 unsigned short id_vendor; 576 unsigned short id_device; 577 }; 578 579 /* 580 * DRM_IOCTL_SG_ALLOC ioctl argument type. 581 */ 582 struct drm_scatter_gather { 583 unsigned long size; /**< In bytes -- will round to page boundary */ 584 unsigned long handle; /**< Used for mapping / unmapping */ 585 }; 586 587 /* 588 * DRM_IOCTL_SET_VERSION ioctl argument type. 589 */ 590 struct drm_set_version { 591 int drm_di_major; 592 int drm_di_minor; 593 int drm_dd_major; 594 int drm_dd_minor; 595 }; 596 597 /** 598 * struct drm_gem_close - Argument for &DRM_IOCTL_GEM_CLOSE ioctl. 599 * @handle: Handle of the object to be closed. 600 * @pad: Padding. 601 * 602 * Releases the handle to an mm object. 603 */ 604 struct drm_gem_close { 605 __u32 handle; 606 __u32 pad; 607 }; 608 609 /** 610 * struct drm_gem_flink - Argument for &DRM_IOCTL_GEM_FLINK ioctl. 611 * @handle: Handle for the object being named. 612 * @name: Returned global name. 613 * 614 * Create a global name for an object, returning the name. 615 * 616 * Note that the name does not hold a reference; when the object 617 * is freed, the name goes away. 618 */ 619 struct drm_gem_flink { 620 __u32 handle; 621 __u32 name; 622 }; 623 624 /** 625 * struct drm_gem_open - Argument for &DRM_IOCTL_GEM_OPEN ioctl. 626 * @name: Name of object being opened. 627 * @handle: Returned handle for the object. 628 * @size: Returned size of the object 629 * 630 * Open an object using the global name, returning a handle and the size. 631 * 632 * This handle (of course) holds a reference to the object, so the object 633 * will not go away until the handle is deleted. 634 */ 635 struct drm_gem_open { 636 __u32 name; 637 __u32 handle; 638 __u64 size; 639 }; 640 641 /** 642 * struct drm_gem_change_handle - Argument for &DRM_IOCTL_GEM_CHANGE_HANDLE ioctl. 643 * @handle: The handle of a gem object. 644 * @new_handle: An available gem handle. 645 * 646 * This ioctl changes the handle of a GEM object to the specified one. 647 * The new handle must be unused. On success the old handle is closed 648 * and all further IOCTL should refer to the new handle only. 649 * Calls to DRM_IOCTL_PRIME_FD_TO_HANDLE will return the new handle. 650 */ 651 struct drm_gem_change_handle { 652 __u32 handle; 653 __u32 new_handle; 654 }; 655 656 /** 657 * DRM_CAP_DUMB_BUFFER 658 * 659 * If set to 1, the driver supports creating dumb buffers via the 660 * &DRM_IOCTL_MODE_CREATE_DUMB ioctl. 661 */ 662 #define DRM_CAP_DUMB_BUFFER 0x1 663 /** 664 * DRM_CAP_VBLANK_HIGH_CRTC 665 * 666 * If set to 1, the kernel supports specifying a :ref:`CRTC index<crtc_index>` 667 * in the high bits of &drm_wait_vblank_request.type. 668 * 669 * Starting kernel version 2.6.39, this capability is always set to 1. 670 */ 671 #define DRM_CAP_VBLANK_HIGH_CRTC 0x2 672 /** 673 * DRM_CAP_DUMB_PREFERRED_DEPTH 674 * 675 * The preferred bit depth for dumb buffers. 676 * 677 * The bit depth is the number of bits used to indicate the color of a single 678 * pixel excluding any padding. This is different from the number of bits per 679 * pixel. For instance, XRGB8888 has a bit depth of 24 but has 32 bits per 680 * pixel. 681 * 682 * Note that this preference only applies to dumb buffers, it's irrelevant for 683 * other types of buffers. 684 */ 685 #define DRM_CAP_DUMB_PREFERRED_DEPTH 0x3 686 /** 687 * DRM_CAP_DUMB_PREFER_SHADOW 688 * 689 * If set to 1, the driver prefers userspace to render to a shadow buffer 690 * instead of directly rendering to a dumb buffer. For best speed, userspace 691 * should do streaming ordered memory copies into the dumb buffer and never 692 * read from it. 693 * 694 * Note that this preference only applies to dumb buffers, it's irrelevant for 695 * other types of buffers. 696 */ 697 #define DRM_CAP_DUMB_PREFER_SHADOW 0x4 698 /** 699 * DRM_CAP_PRIME 700 * 701 * Bitfield of supported PRIME sharing capabilities. See &DRM_PRIME_CAP_IMPORT 702 * and &DRM_PRIME_CAP_EXPORT. 703 * 704 * Starting from kernel version 6.6, both &DRM_PRIME_CAP_IMPORT and 705 * &DRM_PRIME_CAP_EXPORT are always advertised. 706 * 707 * PRIME buffers are exposed as dma-buf file descriptors. 708 * See :ref:`prime_buffer_sharing`. 709 */ 710 #define DRM_CAP_PRIME 0x5 711 /** 712 * DRM_PRIME_CAP_IMPORT 713 * 714 * If this bit is set in &DRM_CAP_PRIME, the driver supports importing PRIME 715 * buffers via the &DRM_IOCTL_PRIME_FD_TO_HANDLE ioctl. 716 * 717 * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME. 718 */ 719 #define DRM_PRIME_CAP_IMPORT 0x1 720 /** 721 * DRM_PRIME_CAP_EXPORT 722 * 723 * If this bit is set in &DRM_CAP_PRIME, the driver supports exporting PRIME 724 * buffers via the &DRM_IOCTL_PRIME_HANDLE_TO_FD ioctl. 725 * 726 * Starting from kernel version 6.6, this bit is always set in &DRM_CAP_PRIME. 727 */ 728 #define DRM_PRIME_CAP_EXPORT 0x2 729 /** 730 * DRM_CAP_TIMESTAMP_MONOTONIC 731 * 732 * If set to 0, the kernel will report timestamps with ``CLOCK_REALTIME`` in 733 * struct drm_event_vblank. If set to 1, the kernel will report timestamps with 734 * ``CLOCK_MONOTONIC``. See ``clock_gettime(2)`` for the definition of these 735 * clocks. 736 * 737 * Starting from kernel version 2.6.39, the default value for this capability 738 * is 1. Starting kernel version 4.15, this capability is always set to 1. 739 */ 740 #define DRM_CAP_TIMESTAMP_MONOTONIC 0x6 741 /** 742 * DRM_CAP_ASYNC_PAGE_FLIP 743 * 744 * If set to 1, the driver supports &DRM_MODE_PAGE_FLIP_ASYNC for legacy 745 * page-flips. 746 */ 747 #define DRM_CAP_ASYNC_PAGE_FLIP 0x7 748 /** 749 * DRM_CAP_CURSOR_WIDTH 750 * 751 * The ``CURSOR_WIDTH`` and ``CURSOR_HEIGHT`` capabilities return a valid 752 * width x height combination for the hardware cursor. The intention is that a 753 * hardware agnostic userspace can query a cursor plane size to use. 754 * 755 * Note that the cross-driver contract is to merely return a valid size; 756 * drivers are free to attach another meaning on top, eg. i915 returns the 757 * maximum plane size. 758 */ 759 #define DRM_CAP_CURSOR_WIDTH 0x8 760 /** 761 * DRM_CAP_CURSOR_HEIGHT 762 * 763 * See &DRM_CAP_CURSOR_WIDTH. 764 */ 765 #define DRM_CAP_CURSOR_HEIGHT 0x9 766 /** 767 * DRM_CAP_ADDFB2_MODIFIERS 768 * 769 * If set to 1, the driver supports supplying modifiers in the 770 * &DRM_IOCTL_MODE_ADDFB2 ioctl. 771 */ 772 #define DRM_CAP_ADDFB2_MODIFIERS 0x10 773 /** 774 * DRM_CAP_PAGE_FLIP_TARGET 775 * 776 * If set to 1, the driver supports the &DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE and 777 * &DRM_MODE_PAGE_FLIP_TARGET_RELATIVE flags in 778 * &drm_mode_crtc_page_flip_target.flags for the &DRM_IOCTL_MODE_PAGE_FLIP 779 * ioctl. 780 */ 781 #define DRM_CAP_PAGE_FLIP_TARGET 0x11 782 /** 783 * DRM_CAP_CRTC_IN_VBLANK_EVENT 784 * 785 * If set to 1, the kernel supports reporting the CRTC ID in 786 * &drm_event_vblank.crtc_id for the &DRM_EVENT_VBLANK and 787 * &DRM_EVENT_FLIP_COMPLETE events. 788 * 789 * Starting kernel version 4.12, this capability is always set to 1. 790 */ 791 #define DRM_CAP_CRTC_IN_VBLANK_EVENT 0x12 792 /** 793 * DRM_CAP_SYNCOBJ 794 * 795 * If set to 1, the driver supports sync objects. See :ref:`drm_sync_objects`. 796 */ 797 #define DRM_CAP_SYNCOBJ 0x13 798 /** 799 * DRM_CAP_SYNCOBJ_TIMELINE 800 * 801 * If set to 1, the driver supports timeline operations on sync objects. See 802 * :ref:`drm_sync_objects`. 803 */ 804 #define DRM_CAP_SYNCOBJ_TIMELINE 0x14 805 /** 806 * DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP 807 * 808 * If set to 1, the driver supports &DRM_MODE_PAGE_FLIP_ASYNC for atomic 809 * commits. 810 */ 811 #define DRM_CAP_ATOMIC_ASYNC_PAGE_FLIP 0x15 812 813 /* DRM_IOCTL_GET_CAP ioctl argument type */ 814 struct drm_get_cap { 815 __u64 capability; 816 __u64 value; 817 }; 818 819 /** 820 * DRM_CLIENT_CAP_STEREO_3D 821 * 822 * If set to 1, the DRM core will expose the stereo 3D capabilities of the 823 * monitor by advertising the supported 3D layouts in the flags of struct 824 * drm_mode_modeinfo. See ``DRM_MODE_FLAG_3D_*``. 825 * 826 * This capability is always supported for all drivers starting from kernel 827 * version 3.13. 828 */ 829 #define DRM_CLIENT_CAP_STEREO_3D 1 830 831 /** 832 * DRM_CLIENT_CAP_UNIVERSAL_PLANES 833 * 834 * If set to 1, the DRM core will expose all planes (overlay, primary, and 835 * cursor) to userspace. 836 * 837 * This capability has been introduced in kernel version 3.15. Starting from 838 * kernel version 3.17, this capability is always supported for all drivers. 839 */ 840 #define DRM_CLIENT_CAP_UNIVERSAL_PLANES 2 841 842 /** 843 * DRM_CLIENT_CAP_ATOMIC 844 * 845 * If set to 1, the DRM core will expose atomic properties to userspace. This 846 * implicitly enables &DRM_CLIENT_CAP_UNIVERSAL_PLANES and 847 * &DRM_CLIENT_CAP_ASPECT_RATIO. 848 * 849 * If the driver doesn't support atomic mode-setting, enabling this capability 850 * will fail with -EOPNOTSUPP. 851 * 852 * This capability has been introduced in kernel version 4.0. Starting from 853 * kernel version 4.2, this capability is always supported for atomic-capable 854 * drivers. 855 */ 856 #define DRM_CLIENT_CAP_ATOMIC 3 857 858 /** 859 * DRM_CLIENT_CAP_ASPECT_RATIO 860 * 861 * If set to 1, the DRM core will provide aspect ratio information in modes. 862 * See ``DRM_MODE_FLAG_PIC_AR_*``. 863 * 864 * This capability is always supported for all drivers starting from kernel 865 * version 4.18. 866 */ 867 #define DRM_CLIENT_CAP_ASPECT_RATIO 4 868 869 /** 870 * DRM_CLIENT_CAP_WRITEBACK_CONNECTORS 871 * 872 * If set to 1, the DRM core will expose special connectors to be used for 873 * writing back to memory the scene setup in the commit. The client must enable 874 * &DRM_CLIENT_CAP_ATOMIC first. 875 * 876 * This capability is always supported for atomic-capable drivers starting from 877 * kernel version 4.19. 878 */ 879 #define DRM_CLIENT_CAP_WRITEBACK_CONNECTORS 5 880 881 /** 882 * DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT 883 * 884 * Drivers for para-virtualized hardware (e.g. vmwgfx, qxl, virtio and 885 * virtualbox) have additional restrictions for cursor planes (thus 886 * making cursor planes on those drivers not truly universal,) e.g. 887 * they need cursor planes to act like one would expect from a mouse 888 * cursor and have correctly set hotspot properties. 889 * If this client cap is not set the DRM core will hide cursor plane on 890 * those virtualized drivers because not setting it implies that the 891 * client is not capable of dealing with those extra restictions. 892 * Clients which do set cursor hotspot and treat the cursor plane 893 * like a mouse cursor should set this property. 894 * The client must enable &DRM_CLIENT_CAP_ATOMIC first. 895 * 896 * Setting this property on drivers which do not special case 897 * cursor planes (i.e. non-virtualized drivers) will return 898 * EOPNOTSUPP, which can be used by userspace to gauge 899 * requirements of the hardware/drivers they're running on. 900 * 901 * This capability is always supported for atomic-capable virtualized 902 * drivers starting from kernel version 6.6. 903 */ 904 #define DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT 6 905 906 /** 907 * DRM_CLIENT_CAP_PLANE_COLOR_PIPELINE 908 * 909 * If set to 1 the DRM core will allow setting the COLOR_PIPELINE 910 * property on a &drm_plane, as well as drm_colorop properties. 911 * 912 * Setting of these plane properties will be rejected when this client 913 * cap is set: 914 * - COLOR_ENCODING 915 * - COLOR_RANGE 916 * 917 * The client must enable &DRM_CLIENT_CAP_ATOMIC first. 918 */ 919 #define DRM_CLIENT_CAP_PLANE_COLOR_PIPELINE 7 920 921 /* DRM_IOCTL_SET_CLIENT_CAP ioctl argument type */ 922 struct drm_set_client_cap { 923 __u64 capability; 924 __u64 value; 925 }; 926 927 #define DRM_RDWR O_RDWR 928 #define DRM_CLOEXEC O_CLOEXEC 929 struct drm_prime_handle { 930 __u32 handle; 931 932 /** Flags.. only applicable for handle->fd */ 933 __u32 flags; 934 935 /** Returned dmabuf file descriptor */ 936 __s32 fd; 937 }; 938 939 struct drm_syncobj_create { 940 __u32 handle; 941 #define DRM_SYNCOBJ_CREATE_SIGNALED (1 << 0) 942 __u32 flags; 943 }; 944 945 struct drm_syncobj_destroy { 946 __u32 handle; 947 __u32 pad; 948 }; 949 950 #define DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_IMPORT_SYNC_FILE (1 << 0) 951 #define DRM_SYNCOBJ_FD_TO_HANDLE_FLAGS_TIMELINE (1 << 1) 952 #define DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_EXPORT_SYNC_FILE (1 << 0) 953 #define DRM_SYNCOBJ_HANDLE_TO_FD_FLAGS_TIMELINE (1 << 1) 954 struct drm_syncobj_handle { 955 __u32 handle; 956 __u32 flags; 957 958 __s32 fd; 959 __u32 pad; 960 961 __u64 point; 962 }; 963 964 struct drm_syncobj_transfer { 965 __u32 src_handle; 966 __u32 dst_handle; 967 __u64 src_point; 968 __u64 dst_point; 969 __u32 flags; 970 __u32 pad; 971 }; 972 973 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_ALL (1 << 0) 974 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT (1 << 1) 975 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE (1 << 2) /* wait for time point to become available */ 976 #define DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE (1 << 3) /* set fence deadline to deadline_nsec */ 977 struct drm_syncobj_wait { 978 __u64 handles; 979 /* absolute timeout */ 980 __s64 timeout_nsec; 981 __u32 count_handles; 982 __u32 flags; 983 __u32 first_signaled; /* only valid when not waiting all */ 984 __u32 pad; 985 /** 986 * @deadline_nsec - fence deadline hint 987 * 988 * Deadline hint, in absolute CLOCK_MONOTONIC, to set on backing 989 * fence(s) if the DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE flag is 990 * set. 991 */ 992 __u64 deadline_nsec; 993 }; 994 995 struct drm_syncobj_timeline_wait { 996 __u64 handles; 997 /* wait on specific timeline point for every handles*/ 998 __u64 points; 999 /* absolute timeout */ 1000 __s64 timeout_nsec; 1001 __u32 count_handles; 1002 __u32 flags; 1003 __u32 first_signaled; /* only valid when not waiting all */ 1004 __u32 pad; 1005 /** 1006 * @deadline_nsec - fence deadline hint 1007 * 1008 * Deadline hint, in absolute CLOCK_MONOTONIC, to set on backing 1009 * fence(s) if the DRM_SYNCOBJ_WAIT_FLAGS_WAIT_DEADLINE flag is 1010 * set. 1011 */ 1012 __u64 deadline_nsec; 1013 }; 1014 1015 /** 1016 * struct drm_syncobj_eventfd 1017 * @handle: syncobj handle. 1018 * @flags: Zero to wait for the point to be signalled, or 1019 * &DRM_SYNCOBJ_WAIT_FLAGS_WAIT_AVAILABLE to wait for a fence to be 1020 * available for the point. 1021 * @point: syncobj timeline point (set to zero for binary syncobjs). 1022 * @fd: Existing eventfd to sent events to. 1023 * @pad: Must be zero. 1024 * 1025 * Register an eventfd to be signalled by a syncobj. The eventfd counter will 1026 * be incremented by one. 1027 */ 1028 struct drm_syncobj_eventfd { 1029 __u32 handle; 1030 __u32 flags; 1031 __u64 point; 1032 __s32 fd; 1033 __u32 pad; 1034 }; 1035 1036 1037 struct drm_syncobj_array { 1038 __u64 handles; 1039 __u32 count_handles; 1040 __u32 pad; 1041 }; 1042 1043 #define DRM_SYNCOBJ_QUERY_FLAGS_LAST_SUBMITTED (1 << 0) /* last available point on timeline syncobj */ 1044 struct drm_syncobj_timeline_array { 1045 __u64 handles; 1046 __u64 points; 1047 __u32 count_handles; 1048 __u32 flags; 1049 }; 1050 1051 1052 /* Query current scanout sequence number */ 1053 struct drm_crtc_get_sequence { 1054 __u32 crtc_id; /* requested crtc_id */ 1055 __u32 active; /* return: crtc output is active */ 1056 __u64 sequence; /* return: most recent vblank sequence */ 1057 __s64 sequence_ns; /* return: most recent time of first pixel out */ 1058 }; 1059 1060 /* Queue event to be delivered at specified sequence. Time stamp marks 1061 * when the first pixel of the refresh cycle leaves the display engine 1062 * for the display 1063 */ 1064 #define DRM_CRTC_SEQUENCE_RELATIVE 0x00000001 /* sequence is relative to current */ 1065 #define DRM_CRTC_SEQUENCE_NEXT_ON_MISS 0x00000002 /* Use next sequence if we've missed */ 1066 1067 struct drm_crtc_queue_sequence { 1068 __u32 crtc_id; 1069 __u32 flags; 1070 __u64 sequence; /* on input, target sequence. on output, actual sequence */ 1071 __u64 user_data; /* user data passed to event */ 1072 }; 1073 1074 #define DRM_CLIENT_NAME_MAX_LEN 64 1075 struct drm_set_client_name { 1076 __u64 name_len; 1077 __u64 name; 1078 }; 1079 1080 1081 #if defined(__cplusplus) 1082 } 1083 #endif 1084 1085 #include "drm_mode.h" 1086 1087 #if defined(__cplusplus) 1088 extern "C" { 1089 #endif 1090 1091 #define DRM_IOCTL_BASE 'd' 1092 #define DRM_IO(nr) _IO(DRM_IOCTL_BASE,nr) 1093 #define DRM_IOR(nr,type) _IOR(DRM_IOCTL_BASE,nr,type) 1094 #define DRM_IOW(nr,type) _IOW(DRM_IOCTL_BASE,nr,type) 1095 #define DRM_IOWR(nr,type) _IOWR(DRM_IOCTL_BASE,nr,type) 1096 1097 #define DRM_IOCTL_VERSION DRM_IOWR(0x00, struct drm_version) 1098 #define DRM_IOCTL_GET_UNIQUE DRM_IOWR(0x01, struct drm_unique) 1099 #define DRM_IOCTL_GET_MAGIC DRM_IOR( 0x02, struct drm_auth) 1100 #define DRM_IOCTL_IRQ_BUSID DRM_IOWR(0x03, struct drm_irq_busid) 1101 #define DRM_IOCTL_GET_MAP DRM_IOWR(0x04, struct drm_map) 1102 #define DRM_IOCTL_GET_CLIENT DRM_IOWR(0x05, struct drm_client) 1103 #define DRM_IOCTL_GET_STATS DRM_IOR( 0x06, struct drm_stats) 1104 #define DRM_IOCTL_SET_VERSION DRM_IOWR(0x07, struct drm_set_version) 1105 #define DRM_IOCTL_MODESET_CTL DRM_IOW(0x08, struct drm_modeset_ctl) 1106 /** 1107 * DRM_IOCTL_GEM_CLOSE - Close a GEM handle. 1108 * 1109 * GEM handles are not reference-counted by the kernel. User-space is 1110 * responsible for managing their lifetime. For example, if user-space imports 1111 * the same memory object twice on the same DRM file description, the same GEM 1112 * handle is returned by both imports, and user-space needs to ensure 1113 * &DRM_IOCTL_GEM_CLOSE is performed once only. The same situation can happen 1114 * when a memory object is allocated, then exported and imported again on the 1115 * same DRM file description. The &DRM_IOCTL_MODE_GETFB2 IOCTL is an exception 1116 * and always returns fresh new GEM handles even if an existing GEM handle 1117 * already refers to the same memory object before the IOCTL is performed. 1118 */ 1119 #define DRM_IOCTL_GEM_CLOSE DRM_IOW (0x09, struct drm_gem_close) 1120 #define DRM_IOCTL_GEM_FLINK DRM_IOWR(0x0a, struct drm_gem_flink) 1121 #define DRM_IOCTL_GEM_OPEN DRM_IOWR(0x0b, struct drm_gem_open) 1122 #define DRM_IOCTL_GET_CAP DRM_IOWR(0x0c, struct drm_get_cap) 1123 #define DRM_IOCTL_SET_CLIENT_CAP DRM_IOW( 0x0d, struct drm_set_client_cap) 1124 1125 #define DRM_IOCTL_SET_UNIQUE DRM_IOW( 0x10, struct drm_unique) 1126 #define DRM_IOCTL_AUTH_MAGIC DRM_IOW( 0x11, struct drm_auth) 1127 #define DRM_IOCTL_BLOCK DRM_IOWR(0x12, struct drm_block) 1128 #define DRM_IOCTL_UNBLOCK DRM_IOWR(0x13, struct drm_block) 1129 #define DRM_IOCTL_CONTROL DRM_IOW( 0x14, struct drm_control) 1130 #define DRM_IOCTL_ADD_MAP DRM_IOWR(0x15, struct drm_map) 1131 #define DRM_IOCTL_ADD_BUFS DRM_IOWR(0x16, struct drm_buf_desc) 1132 #define DRM_IOCTL_MARK_BUFS DRM_IOW( 0x17, struct drm_buf_desc) 1133 #define DRM_IOCTL_INFO_BUFS DRM_IOWR(0x18, struct drm_buf_info) 1134 #define DRM_IOCTL_MAP_BUFS DRM_IOWR(0x19, struct drm_buf_map) 1135 #define DRM_IOCTL_FREE_BUFS DRM_IOW( 0x1a, struct drm_buf_free) 1136 1137 #define DRM_IOCTL_RM_MAP DRM_IOW( 0x1b, struct drm_map) 1138 1139 #define DRM_IOCTL_SET_SAREA_CTX DRM_IOW( 0x1c, struct drm_ctx_priv_map) 1140 #define DRM_IOCTL_GET_SAREA_CTX DRM_IOWR(0x1d, struct drm_ctx_priv_map) 1141 1142 #define DRM_IOCTL_SET_MASTER DRM_IO(0x1e) 1143 #define DRM_IOCTL_DROP_MASTER DRM_IO(0x1f) 1144 1145 #define DRM_IOCTL_ADD_CTX DRM_IOWR(0x20, struct drm_ctx) 1146 #define DRM_IOCTL_RM_CTX DRM_IOWR(0x21, struct drm_ctx) 1147 #define DRM_IOCTL_MOD_CTX DRM_IOW( 0x22, struct drm_ctx) 1148 #define DRM_IOCTL_GET_CTX DRM_IOWR(0x23, struct drm_ctx) 1149 #define DRM_IOCTL_SWITCH_CTX DRM_IOW( 0x24, struct drm_ctx) 1150 #define DRM_IOCTL_NEW_CTX DRM_IOW( 0x25, struct drm_ctx) 1151 #define DRM_IOCTL_RES_CTX DRM_IOWR(0x26, struct drm_ctx_res) 1152 #define DRM_IOCTL_ADD_DRAW DRM_IOWR(0x27, struct drm_draw) 1153 #define DRM_IOCTL_RM_DRAW DRM_IOWR(0x28, struct drm_draw) 1154 #define DRM_IOCTL_DMA DRM_IOWR(0x29, struct drm_dma) 1155 #define DRM_IOCTL_LOCK DRM_IOW( 0x2a, struct drm_lock) 1156 #define DRM_IOCTL_UNLOCK DRM_IOW( 0x2b, struct drm_lock) 1157 #define DRM_IOCTL_FINISH DRM_IOW( 0x2c, struct drm_lock) 1158 1159 /** 1160 * DRM_IOCTL_PRIME_HANDLE_TO_FD - Convert a GEM handle to a DMA-BUF FD. 1161 * 1162 * User-space sets &drm_prime_handle.handle with the GEM handle to export and 1163 * &drm_prime_handle.flags, and gets back a DMA-BUF file descriptor in 1164 * &drm_prime_handle.fd. 1165 * 1166 * The export can fail for any driver-specific reason, e.g. because export is 1167 * not supported for this specific GEM handle (but might be for others). 1168 * 1169 * Support for exporting DMA-BUFs is advertised via &DRM_PRIME_CAP_EXPORT. 1170 */ 1171 #define DRM_IOCTL_PRIME_HANDLE_TO_FD DRM_IOWR(0x2d, struct drm_prime_handle) 1172 /** 1173 * DRM_IOCTL_PRIME_FD_TO_HANDLE - Convert a DMA-BUF FD to a GEM handle. 1174 * 1175 * User-space sets &drm_prime_handle.fd with a DMA-BUF file descriptor to 1176 * import, and gets back a GEM handle in &drm_prime_handle.handle. 1177 * &drm_prime_handle.flags is unused. 1178 * 1179 * If an existing GEM handle refers to the memory object backing the DMA-BUF, 1180 * that GEM handle is returned. Therefore user-space which needs to handle 1181 * arbitrary DMA-BUFs must have a user-space lookup data structure to manually 1182 * reference-count duplicated GEM handles. For more information see 1183 * &DRM_IOCTL_GEM_CLOSE. 1184 * 1185 * The import can fail for any driver-specific reason, e.g. because import is 1186 * only supported for DMA-BUFs allocated on this DRM device. 1187 * 1188 * Support for importing DMA-BUFs is advertised via &DRM_PRIME_CAP_IMPORT. 1189 */ 1190 #define DRM_IOCTL_PRIME_FD_TO_HANDLE DRM_IOWR(0x2e, struct drm_prime_handle) 1191 1192 #define DRM_IOCTL_AGP_ACQUIRE DRM_IO( 0x30) 1193 #define DRM_IOCTL_AGP_RELEASE DRM_IO( 0x31) 1194 #define DRM_IOCTL_AGP_ENABLE DRM_IOW( 0x32, struct drm_agp_mode) 1195 #define DRM_IOCTL_AGP_INFO DRM_IOR( 0x33, struct drm_agp_info) 1196 #define DRM_IOCTL_AGP_ALLOC DRM_IOWR(0x34, struct drm_agp_buffer) 1197 #define DRM_IOCTL_AGP_FREE DRM_IOW( 0x35, struct drm_agp_buffer) 1198 #define DRM_IOCTL_AGP_BIND DRM_IOW( 0x36, struct drm_agp_binding) 1199 #define DRM_IOCTL_AGP_UNBIND DRM_IOW( 0x37, struct drm_agp_binding) 1200 1201 #define DRM_IOCTL_SG_ALLOC DRM_IOWR(0x38, struct drm_scatter_gather) 1202 #define DRM_IOCTL_SG_FREE DRM_IOW( 0x39, struct drm_scatter_gather) 1203 1204 #define DRM_IOCTL_WAIT_VBLANK DRM_IOWR(0x3a, union drm_wait_vblank) 1205 1206 #define DRM_IOCTL_CRTC_GET_SEQUENCE DRM_IOWR(0x3b, struct drm_crtc_get_sequence) 1207 #define DRM_IOCTL_CRTC_QUEUE_SEQUENCE DRM_IOWR(0x3c, struct drm_crtc_queue_sequence) 1208 1209 #define DRM_IOCTL_UPDATE_DRAW DRM_IOW(0x3f, struct drm_update_draw) 1210 1211 #define DRM_IOCTL_MODE_GETRESOURCES DRM_IOWR(0xA0, struct drm_mode_card_res) 1212 #define DRM_IOCTL_MODE_GETCRTC DRM_IOWR(0xA1, struct drm_mode_crtc) 1213 #define DRM_IOCTL_MODE_SETCRTC DRM_IOWR(0xA2, struct drm_mode_crtc) 1214 #define DRM_IOCTL_MODE_CURSOR DRM_IOWR(0xA3, struct drm_mode_cursor) 1215 #define DRM_IOCTL_MODE_GETGAMMA DRM_IOWR(0xA4, struct drm_mode_crtc_lut) 1216 #define DRM_IOCTL_MODE_SETGAMMA DRM_IOWR(0xA5, struct drm_mode_crtc_lut) 1217 #define DRM_IOCTL_MODE_GETENCODER DRM_IOWR(0xA6, struct drm_mode_get_encoder) 1218 #define DRM_IOCTL_MODE_GETCONNECTOR DRM_IOWR(0xA7, struct drm_mode_get_connector) 1219 #define DRM_IOCTL_MODE_ATTACHMODE DRM_IOWR(0xA8, struct drm_mode_mode_cmd) /* deprecated (never worked) */ 1220 #define DRM_IOCTL_MODE_DETACHMODE DRM_IOWR(0xA9, struct drm_mode_mode_cmd) /* deprecated (never worked) */ 1221 1222 #define DRM_IOCTL_MODE_GETPROPERTY DRM_IOWR(0xAA, struct drm_mode_get_property) 1223 #define DRM_IOCTL_MODE_SETPROPERTY DRM_IOWR(0xAB, struct drm_mode_connector_set_property) 1224 #define DRM_IOCTL_MODE_GETPROPBLOB DRM_IOWR(0xAC, struct drm_mode_get_blob) 1225 #define DRM_IOCTL_MODE_GETFB DRM_IOWR(0xAD, struct drm_mode_fb_cmd) 1226 #define DRM_IOCTL_MODE_ADDFB DRM_IOWR(0xAE, struct drm_mode_fb_cmd) 1227 /** 1228 * DRM_IOCTL_MODE_RMFB - Remove a framebuffer. 1229 * 1230 * This removes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL 1231 * argument is a framebuffer object ID. 1232 * 1233 * Warning: removing a framebuffer currently in-use on an enabled plane will 1234 * disable that plane. The CRTC the plane is linked to may also be disabled 1235 * (depending on driver capabilities). 1236 */ 1237 #define DRM_IOCTL_MODE_RMFB DRM_IOWR(0xAF, unsigned int) 1238 #define DRM_IOCTL_MODE_PAGE_FLIP DRM_IOWR(0xB0, struct drm_mode_crtc_page_flip) 1239 #define DRM_IOCTL_MODE_DIRTYFB DRM_IOWR(0xB1, struct drm_mode_fb_dirty_cmd) 1240 1241 /** 1242 * DRM_IOCTL_MODE_CREATE_DUMB - Create a new dumb buffer object. 1243 * 1244 * KMS dumb buffers provide a very primitive way to allocate a buffer object 1245 * suitable for scanout and map it for software rendering. KMS dumb buffers are 1246 * not suitable for hardware-accelerated rendering nor video decoding. KMS dumb 1247 * buffers are not suitable to be displayed on any other device than the KMS 1248 * device where they were allocated from. Also see 1249 * :ref:`kms_dumb_buffer_objects`. 1250 * 1251 * The IOCTL argument is a struct drm_mode_create_dumb. 1252 * 1253 * User-space is expected to create a KMS dumb buffer via this IOCTL, then add 1254 * it as a KMS framebuffer via &DRM_IOCTL_MODE_ADDFB and map it via 1255 * &DRM_IOCTL_MODE_MAP_DUMB. 1256 * 1257 * &DRM_CAP_DUMB_BUFFER indicates whether this IOCTL is supported. 1258 * &DRM_CAP_DUMB_PREFERRED_DEPTH and &DRM_CAP_DUMB_PREFER_SHADOW indicate 1259 * driver preferences for dumb buffers. 1260 */ 1261 #define DRM_IOCTL_MODE_CREATE_DUMB DRM_IOWR(0xB2, struct drm_mode_create_dumb) 1262 #define DRM_IOCTL_MODE_MAP_DUMB DRM_IOWR(0xB3, struct drm_mode_map_dumb) 1263 #define DRM_IOCTL_MODE_DESTROY_DUMB DRM_IOWR(0xB4, struct drm_mode_destroy_dumb) 1264 #define DRM_IOCTL_MODE_GETPLANERESOURCES DRM_IOWR(0xB5, struct drm_mode_get_plane_res) 1265 #define DRM_IOCTL_MODE_GETPLANE DRM_IOWR(0xB6, struct drm_mode_get_plane) 1266 #define DRM_IOCTL_MODE_SETPLANE DRM_IOWR(0xB7, struct drm_mode_set_plane) 1267 #define DRM_IOCTL_MODE_ADDFB2 DRM_IOWR(0xB8, struct drm_mode_fb_cmd2) 1268 #define DRM_IOCTL_MODE_OBJ_GETPROPERTIES DRM_IOWR(0xB9, struct drm_mode_obj_get_properties) 1269 #define DRM_IOCTL_MODE_OBJ_SETPROPERTY DRM_IOWR(0xBA, struct drm_mode_obj_set_property) 1270 #define DRM_IOCTL_MODE_CURSOR2 DRM_IOWR(0xBB, struct drm_mode_cursor2) 1271 #define DRM_IOCTL_MODE_ATOMIC DRM_IOWR(0xBC, struct drm_mode_atomic) 1272 #define DRM_IOCTL_MODE_CREATEPROPBLOB DRM_IOWR(0xBD, struct drm_mode_create_blob) 1273 #define DRM_IOCTL_MODE_DESTROYPROPBLOB DRM_IOWR(0xBE, struct drm_mode_destroy_blob) 1274 1275 #define DRM_IOCTL_SYNCOBJ_CREATE DRM_IOWR(0xBF, struct drm_syncobj_create) 1276 #define DRM_IOCTL_SYNCOBJ_DESTROY DRM_IOWR(0xC0, struct drm_syncobj_destroy) 1277 #define DRM_IOCTL_SYNCOBJ_HANDLE_TO_FD DRM_IOWR(0xC1, struct drm_syncobj_handle) 1278 #define DRM_IOCTL_SYNCOBJ_FD_TO_HANDLE DRM_IOWR(0xC2, struct drm_syncobj_handle) 1279 #define DRM_IOCTL_SYNCOBJ_WAIT DRM_IOWR(0xC3, struct drm_syncobj_wait) 1280 #define DRM_IOCTL_SYNCOBJ_RESET DRM_IOWR(0xC4, struct drm_syncobj_array) 1281 #define DRM_IOCTL_SYNCOBJ_SIGNAL DRM_IOWR(0xC5, struct drm_syncobj_array) 1282 1283 #define DRM_IOCTL_MODE_CREATE_LEASE DRM_IOWR(0xC6, struct drm_mode_create_lease) 1284 #define DRM_IOCTL_MODE_LIST_LESSEES DRM_IOWR(0xC7, struct drm_mode_list_lessees) 1285 #define DRM_IOCTL_MODE_GET_LEASE DRM_IOWR(0xC8, struct drm_mode_get_lease) 1286 #define DRM_IOCTL_MODE_REVOKE_LEASE DRM_IOWR(0xC9, struct drm_mode_revoke_lease) 1287 1288 #define DRM_IOCTL_SYNCOBJ_TIMELINE_WAIT DRM_IOWR(0xCA, struct drm_syncobj_timeline_wait) 1289 #define DRM_IOCTL_SYNCOBJ_QUERY DRM_IOWR(0xCB, struct drm_syncobj_timeline_array) 1290 #define DRM_IOCTL_SYNCOBJ_TRANSFER DRM_IOWR(0xCC, struct drm_syncobj_transfer) 1291 #define DRM_IOCTL_SYNCOBJ_TIMELINE_SIGNAL DRM_IOWR(0xCD, struct drm_syncobj_timeline_array) 1292 1293 /** 1294 * DRM_IOCTL_MODE_GETFB2 - Get framebuffer metadata. 1295 * 1296 * This queries metadata about a framebuffer. User-space fills 1297 * &drm_mode_fb_cmd2.fb_id as the input, and the kernels fills the rest of the 1298 * struct as the output. 1299 * 1300 * If the client is DRM master or has &CAP_SYS_ADMIN, &drm_mode_fb_cmd2.handles 1301 * will be filled with GEM buffer handles. Fresh new GEM handles are always 1302 * returned, even if another GEM handle referring to the same memory object 1303 * already exists on the DRM file description. The caller is responsible for 1304 * removing the new handles, e.g. via the &DRM_IOCTL_GEM_CLOSE IOCTL. The same 1305 * new handle will be returned for multiple planes in case they use the same 1306 * memory object. Planes are valid until one has a zero handle -- this can be 1307 * used to compute the number of planes. 1308 * 1309 * Otherwise, &drm_mode_fb_cmd2.handles will be zeroed and planes are valid 1310 * until one has a zero &drm_mode_fb_cmd2.pitches. 1311 * 1312 * If the framebuffer has a format modifier, &DRM_MODE_FB_MODIFIERS will be set 1313 * in &drm_mode_fb_cmd2.flags and &drm_mode_fb_cmd2.modifier will contain the 1314 * modifier. Otherwise, user-space must ignore &drm_mode_fb_cmd2.modifier. 1315 * 1316 * To obtain DMA-BUF FDs for each plane without leaking GEM handles, user-space 1317 * can export each handle via &DRM_IOCTL_PRIME_HANDLE_TO_FD, then immediately 1318 * close each unique handle via &DRM_IOCTL_GEM_CLOSE, making sure to not 1319 * double-close handles which are specified multiple times in the array. 1320 */ 1321 #define DRM_IOCTL_MODE_GETFB2 DRM_IOWR(0xCE, struct drm_mode_fb_cmd2) 1322 1323 #define DRM_IOCTL_SYNCOBJ_EVENTFD DRM_IOWR(0xCF, struct drm_syncobj_eventfd) 1324 1325 /** 1326 * DRM_IOCTL_MODE_CLOSEFB - Close a framebuffer. 1327 * 1328 * This closes a framebuffer previously added via ADDFB/ADDFB2. The IOCTL 1329 * argument is a framebuffer object ID. 1330 * 1331 * This IOCTL is similar to &DRM_IOCTL_MODE_RMFB, except it doesn't disable 1332 * planes and CRTCs. As long as the framebuffer is used by a plane, it's kept 1333 * alive. When the plane no longer uses the framebuffer (because the 1334 * framebuffer is replaced with another one, or the plane is disabled), the 1335 * framebuffer is cleaned up. 1336 * 1337 * This is useful to implement flicker-free transitions between two processes. 1338 * 1339 * Depending on the threat model, user-space may want to ensure that the 1340 * framebuffer doesn't expose any sensitive user information: closed 1341 * framebuffers attached to a plane can be read back by the next DRM master. 1342 */ 1343 #define DRM_IOCTL_MODE_CLOSEFB DRM_IOWR(0xD0, struct drm_mode_closefb) 1344 1345 /** 1346 * DRM_IOCTL_SET_CLIENT_NAME - Attach a name to a drm_file 1347 * 1348 * Having a name allows for easier tracking and debugging. 1349 * The length of the name (without null ending char) must be 1350 * <= DRM_CLIENT_NAME_MAX_LEN. 1351 * The call will fail if the name contains whitespaces or non-printable chars. 1352 */ 1353 #define DRM_IOCTL_SET_CLIENT_NAME DRM_IOWR(0xD1, struct drm_set_client_name) 1354 1355 /** 1356 * DRM_IOCTL_GEM_CHANGE_HANDLE - Move an object to a different handle 1357 * 1358 * Some applications (notably CRIU) need objects to have specific gem handles. 1359 * This ioctl changes the object at one gem handle to use a new gem handle. 1360 */ 1361 #define DRM_IOCTL_GEM_CHANGE_HANDLE DRM_IOWR(0xD2, struct drm_gem_change_handle) 1362 1363 /* 1364 * Device specific ioctls should only be in their respective headers 1365 * The device specific ioctl range is from 0x40 to 0x9f. 1366 * Generic IOCTLS restart at 0xA0. 1367 * 1368 * \sa drmCommandNone(), drmCommandRead(), drmCommandWrite(), and 1369 * drmCommandReadWrite(). 1370 */ 1371 #define DRM_COMMAND_BASE 0x40 1372 #define DRM_COMMAND_END 0xA0 1373 1374 /** 1375 * struct drm_event - Header for DRM events 1376 * @type: event type. 1377 * @length: total number of payload bytes (including header). 1378 * 1379 * This struct is a header for events written back to user-space on the DRM FD. 1380 * A read on the DRM FD will always only return complete events: e.g. if the 1381 * read buffer is 100 bytes large and there are two 64 byte events pending, 1382 * only one will be returned. 1383 * 1384 * Event types 0 - 0x7fffffff are generic DRM events, 0x80000000 and 1385 * up are chipset specific. Generic DRM events include &DRM_EVENT_VBLANK, 1386 * &DRM_EVENT_FLIP_COMPLETE and &DRM_EVENT_CRTC_SEQUENCE. 1387 */ 1388 struct drm_event { 1389 __u32 type; 1390 __u32 length; 1391 }; 1392 1393 /** 1394 * DRM_EVENT_VBLANK - vertical blanking event 1395 * 1396 * This event is sent in response to &DRM_IOCTL_WAIT_VBLANK with the 1397 * &_DRM_VBLANK_EVENT flag set. 1398 * 1399 * The event payload is a struct drm_event_vblank. 1400 */ 1401 #define DRM_EVENT_VBLANK 0x01 1402 /** 1403 * DRM_EVENT_FLIP_COMPLETE - page-flip completion event 1404 * 1405 * This event is sent in response to an atomic commit or legacy page-flip with 1406 * the &DRM_MODE_PAGE_FLIP_EVENT flag set. 1407 * 1408 * The event payload is a struct drm_event_vblank. 1409 */ 1410 #define DRM_EVENT_FLIP_COMPLETE 0x02 1411 /** 1412 * DRM_EVENT_CRTC_SEQUENCE - CRTC sequence event 1413 * 1414 * This event is sent in response to &DRM_IOCTL_CRTC_QUEUE_SEQUENCE. 1415 * 1416 * The event payload is a struct drm_event_crtc_sequence. 1417 */ 1418 #define DRM_EVENT_CRTC_SEQUENCE 0x03 1419 1420 struct drm_event_vblank { 1421 struct drm_event base; 1422 __u64 user_data; 1423 __u32 tv_sec; 1424 __u32 tv_usec; 1425 __u32 sequence; 1426 __u32 crtc_id; /* 0 on older kernels that do not support this */ 1427 }; 1428 1429 /* Event delivered at sequence. Time stamp marks when the first pixel 1430 * of the refresh cycle leaves the display engine for the display 1431 */ 1432 struct drm_event_crtc_sequence { 1433 struct drm_event base; 1434 __u64 user_data; 1435 __s64 time_ns; 1436 __u64 sequence; 1437 }; 1438 1439 /* typedef area */ 1440 typedef struct drm_clip_rect drm_clip_rect_t; 1441 typedef struct drm_drawable_info drm_drawable_info_t; 1442 typedef struct drm_tex_region drm_tex_region_t; 1443 typedef struct drm_hw_lock drm_hw_lock_t; 1444 typedef struct drm_version drm_version_t; 1445 typedef struct drm_unique drm_unique_t; 1446 typedef struct drm_list drm_list_t; 1447 typedef struct drm_block drm_block_t; 1448 typedef struct drm_control drm_control_t; 1449 typedef enum drm_map_type drm_map_type_t; 1450 typedef enum drm_map_flags drm_map_flags_t; 1451 typedef struct drm_ctx_priv_map drm_ctx_priv_map_t; 1452 typedef struct drm_map drm_map_t; 1453 typedef struct drm_client drm_client_t; 1454 typedef enum drm_stat_type drm_stat_type_t; 1455 typedef struct drm_stats drm_stats_t; 1456 typedef enum drm_lock_flags drm_lock_flags_t; 1457 typedef struct drm_lock drm_lock_t; 1458 typedef enum drm_dma_flags drm_dma_flags_t; 1459 typedef struct drm_buf_desc drm_buf_desc_t; 1460 typedef struct drm_buf_info drm_buf_info_t; 1461 typedef struct drm_buf_free drm_buf_free_t; 1462 typedef struct drm_buf_pub drm_buf_pub_t; 1463 typedef struct drm_buf_map drm_buf_map_t; 1464 typedef struct drm_dma drm_dma_t; 1465 typedef union drm_wait_vblank drm_wait_vblank_t; 1466 typedef struct drm_agp_mode drm_agp_mode_t; 1467 typedef enum drm_ctx_flags drm_ctx_flags_t; 1468 typedef struct drm_ctx drm_ctx_t; 1469 typedef struct drm_ctx_res drm_ctx_res_t; 1470 typedef struct drm_draw drm_draw_t; 1471 typedef struct drm_update_draw drm_update_draw_t; 1472 typedef struct drm_auth drm_auth_t; 1473 typedef struct drm_irq_busid drm_irq_busid_t; 1474 typedef enum drm_vblank_seq_type drm_vblank_seq_type_t; 1475 1476 typedef struct drm_agp_buffer drm_agp_buffer_t; 1477 typedef struct drm_agp_binding drm_agp_binding_t; 1478 typedef struct drm_agp_info drm_agp_info_t; 1479 typedef struct drm_scatter_gather drm_scatter_gather_t; 1480 typedef struct drm_set_version drm_set_version_t; 1481 1482 #if defined(__cplusplus) 1483 } 1484 #endif 1485 1486 #endif 1487