1 /* $NetBSD: drm_mode.h,v 1.2 2021/12/18 23:45:46 riastradh Exp $ */ 2 3 /* 4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie> 5 * Copyright (c) 2007 Jakob Bornecrantz <wallbraker@gmail.com> 6 * Copyright (c) 2008 Red Hat Inc. 7 * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, TX., USA 8 * Copyright (c) 2007-2008 Intel Corporation 9 * 10 * Permission is hereby granted, free of charge, to any person obtaining a 11 * copy of this software and associated documentation files (the "Software"), 12 * to deal in the Software without restriction, including without limitation 13 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 14 * and/or sell copies of the Software, and to permit persons to whom the 15 * Software is furnished to do so, subject to the following conditions: 16 * 17 * The above copyright notice and this permission notice shall be included in 18 * all copies or substantial portions of the Software. 19 * 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 26 * IN THE SOFTWARE. 27 */ 28 29 #ifndef _DRM_MODE_H 30 #define _DRM_MODE_H 31 32 #include "drm.h" 33 34 #if defined(__cplusplus) 35 extern "C" { 36 #endif 37 38 /** 39 * DOC: overview 40 * 41 * DRM exposes many UAPI and structure definition to have a consistent 42 * and standardized interface with user. 43 * Userspace can refer to these structure definitions and UAPI formats 44 * to communicate to driver 45 */ 46 47 #define DRM_CONNECTOR_NAME_LEN 32 48 #define DRM_DISPLAY_MODE_LEN 32 49 #define DRM_PROP_NAME_LEN 32 50 51 #define DRM_MODE_TYPE_BUILTIN (1<<0) /* deprecated */ 52 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */ 53 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */ 54 #define DRM_MODE_TYPE_PREFERRED (1<<3) 55 #define DRM_MODE_TYPE_DEFAULT (1<<4) /* deprecated */ 56 #define DRM_MODE_TYPE_USERDEF (1<<5) 57 #define DRM_MODE_TYPE_DRIVER (1<<6) 58 59 #define DRM_MODE_TYPE_ALL (DRM_MODE_TYPE_PREFERRED | \ 60 DRM_MODE_TYPE_USERDEF | \ 61 DRM_MODE_TYPE_DRIVER) 62 63 /* Video mode flags */ 64 /* bit compatible with the xrandr RR_ definitions (bits 0-13) 65 * 66 * ABI warning: Existing userspace really expects 67 * the mode flags to match the xrandr definitions. Any 68 * changes that don't match the xrandr definitions will 69 * likely need a new client cap or some other mechanism 70 * to avoid breaking existing userspace. This includes 71 * allocating new flags in the previously unused bits! 72 */ 73 #define DRM_MODE_FLAG_PHSYNC (1<<0) 74 #define DRM_MODE_FLAG_NHSYNC (1<<1) 75 #define DRM_MODE_FLAG_PVSYNC (1<<2) 76 #define DRM_MODE_FLAG_NVSYNC (1<<3) 77 #define DRM_MODE_FLAG_INTERLACE (1<<4) 78 #define DRM_MODE_FLAG_DBLSCAN (1<<5) 79 #define DRM_MODE_FLAG_CSYNC (1<<6) 80 #define DRM_MODE_FLAG_PCSYNC (1<<7) 81 #define DRM_MODE_FLAG_NCSYNC (1<<8) 82 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */ 83 #define DRM_MODE_FLAG_BCAST (1<<10) /* deprecated */ 84 #define DRM_MODE_FLAG_PIXMUX (1<<11) /* deprecated */ 85 #define DRM_MODE_FLAG_DBLCLK (1<<12) 86 #define DRM_MODE_FLAG_CLKDIV2 (1<<13) 87 /* 88 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX 89 * (define not exposed to user space). 90 */ 91 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14) 92 #define DRM_MODE_FLAG_3D_NONE (0<<14) 93 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14) 94 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14) 95 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14) 96 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14) 97 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14) 98 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14) 99 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14) 100 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14) 101 102 /* Picture aspect ratio options */ 103 #define DRM_MODE_PICTURE_ASPECT_NONE 0 104 #define DRM_MODE_PICTURE_ASPECT_4_3 1 105 #define DRM_MODE_PICTURE_ASPECT_16_9 2 106 #define DRM_MODE_PICTURE_ASPECT_64_27 3 107 #define DRM_MODE_PICTURE_ASPECT_256_135 4 108 109 /* Content type options */ 110 #define DRM_MODE_CONTENT_TYPE_NO_DATA 0 111 #define DRM_MODE_CONTENT_TYPE_GRAPHICS 1 112 #define DRM_MODE_CONTENT_TYPE_PHOTO 2 113 #define DRM_MODE_CONTENT_TYPE_CINEMA 3 114 #define DRM_MODE_CONTENT_TYPE_GAME 4 115 116 /* Aspect ratio flag bitmask (4 bits 22:19) */ 117 #define DRM_MODE_FLAG_PIC_AR_MASK (0x0F<<19) 118 #define DRM_MODE_FLAG_PIC_AR_NONE \ 119 (DRM_MODE_PICTURE_ASPECT_NONE<<19) 120 #define DRM_MODE_FLAG_PIC_AR_4_3 \ 121 (DRM_MODE_PICTURE_ASPECT_4_3<<19) 122 #define DRM_MODE_FLAG_PIC_AR_16_9 \ 123 (DRM_MODE_PICTURE_ASPECT_16_9<<19) 124 #define DRM_MODE_FLAG_PIC_AR_64_27 \ 125 (DRM_MODE_PICTURE_ASPECT_64_27<<19) 126 #define DRM_MODE_FLAG_PIC_AR_256_135 \ 127 (DRM_MODE_PICTURE_ASPECT_256_135<<19) 128 129 #define DRM_MODE_FLAG_ALL (DRM_MODE_FLAG_PHSYNC | \ 130 DRM_MODE_FLAG_NHSYNC | \ 131 DRM_MODE_FLAG_PVSYNC | \ 132 DRM_MODE_FLAG_NVSYNC | \ 133 DRM_MODE_FLAG_INTERLACE | \ 134 DRM_MODE_FLAG_DBLSCAN | \ 135 DRM_MODE_FLAG_CSYNC | \ 136 DRM_MODE_FLAG_PCSYNC | \ 137 DRM_MODE_FLAG_NCSYNC | \ 138 DRM_MODE_FLAG_HSKEW | \ 139 DRM_MODE_FLAG_DBLCLK | \ 140 DRM_MODE_FLAG_CLKDIV2 | \ 141 DRM_MODE_FLAG_3D_MASK) 142 143 /* DPMS flags */ 144 /* bit compatible with the xorg definitions. */ 145 #define DRM_MODE_DPMS_ON 0 146 #define DRM_MODE_DPMS_STANDBY 1 147 #define DRM_MODE_DPMS_SUSPEND 2 148 #define DRM_MODE_DPMS_OFF 3 149 150 /* Scaling mode options */ 151 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or 152 software can still scale) */ 153 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */ 154 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */ 155 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */ 156 157 /* Dithering mode options */ 158 #define DRM_MODE_DITHERING_OFF 0 159 #define DRM_MODE_DITHERING_ON 1 160 #define DRM_MODE_DITHERING_AUTO 2 161 162 /* Dirty info options */ 163 #define DRM_MODE_DIRTY_OFF 0 164 #define DRM_MODE_DIRTY_ON 1 165 #define DRM_MODE_DIRTY_ANNOTATE 2 166 167 /* Link Status options */ 168 #define DRM_MODE_LINK_STATUS_GOOD 0 169 #define DRM_MODE_LINK_STATUS_BAD 1 170 171 /* 172 * DRM_MODE_ROTATE_<degrees> 173 * 174 * Signals that a drm plane is been rotated <degrees> degrees in counter 175 * clockwise direction. 176 * 177 * This define is provided as a convenience, looking up the property id 178 * using the name->prop id lookup is the preferred method. 179 */ 180 #define DRM_MODE_ROTATE_0 (1<<0) 181 #define DRM_MODE_ROTATE_90 (1<<1) 182 #define DRM_MODE_ROTATE_180 (1<<2) 183 #define DRM_MODE_ROTATE_270 (1<<3) 184 185 /* 186 * DRM_MODE_ROTATE_MASK 187 * 188 * Bitmask used to look for drm plane rotations. 189 */ 190 #define DRM_MODE_ROTATE_MASK (\ 191 DRM_MODE_ROTATE_0 | \ 192 DRM_MODE_ROTATE_90 | \ 193 DRM_MODE_ROTATE_180 | \ 194 DRM_MODE_ROTATE_270) 195 196 /* 197 * DRM_MODE_REFLECT_<axis> 198 * 199 * Signals that the contents of a drm plane is reflected along the <axis> axis, 200 * in the same way as mirroring. 201 * See kerneldoc chapter "Plane Composition Properties" for more details. 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 #define DRM_MODE_CONNECTOR_SPI 19 367 368 struct drm_mode_get_connector { 369 370 __u64 encoders_ptr; 371 __u64 modes_ptr; 372 __u64 props_ptr; 373 __u64 prop_values_ptr; 374 375 __u32 count_modes; 376 __u32 count_props; 377 __u32 count_encoders; 378 379 __u32 encoder_id; /**< Current Encoder */ 380 __u32 connector_id; /**< Id */ 381 __u32 connector_type; 382 __u32 connector_type_id; 383 384 __u32 connection; 385 __u32 mm_width; /**< width in millimeters */ 386 __u32 mm_height; /**< height in millimeters */ 387 __u32 subpixel; 388 389 __u32 pad; 390 }; 391 392 #define DRM_MODE_PROP_PENDING (1<<0) /* deprecated, do not use */ 393 #define DRM_MODE_PROP_RANGE (1<<1) 394 #define DRM_MODE_PROP_IMMUTABLE (1<<2) 395 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */ 396 #define DRM_MODE_PROP_BLOB (1<<4) 397 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */ 398 399 /* non-extended types: legacy bitmask, one bit per type: */ 400 #define DRM_MODE_PROP_LEGACY_TYPE ( \ 401 DRM_MODE_PROP_RANGE | \ 402 DRM_MODE_PROP_ENUM | \ 403 DRM_MODE_PROP_BLOB | \ 404 DRM_MODE_PROP_BITMASK) 405 406 /* extended-types: rather than continue to consume a bit per type, 407 * grab a chunk of the bits to use as integer type id. 408 */ 409 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0 410 #define DRM_MODE_PROP_TYPE(n) ((n) << 6) 411 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1) 412 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2) 413 414 /* the PROP_ATOMIC flag is used to hide properties from userspace that 415 * is not aware of atomic properties. This is mostly to work around 416 * older userspace (DDX drivers) that read/write each prop they find, 417 * witout being aware that this could be triggering a lengthy modeset. 418 */ 419 #define DRM_MODE_PROP_ATOMIC 0x80000000 420 421 struct drm_mode_property_enum { 422 __u64 value; 423 char name[DRM_PROP_NAME_LEN]; 424 }; 425 426 struct drm_mode_get_property { 427 __u64 values_ptr; /* values and blob lengths */ 428 __u64 enum_blob_ptr; /* enum and blob id ptrs */ 429 430 __u32 prop_id; 431 __u32 flags; 432 char name[DRM_PROP_NAME_LEN]; 433 434 __u32 count_values; 435 /* This is only used to count enum values, not blobs. The _blobs is 436 * simply because of a historical reason, i.e. backwards compat. */ 437 __u32 count_enum_blobs; 438 }; 439 440 struct drm_mode_connector_set_property { 441 __u64 value; 442 __u32 prop_id; 443 __u32 connector_id; 444 }; 445 446 #define DRM_MODE_OBJECT_CRTC 0xcccccccc 447 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0 448 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0 449 #define DRM_MODE_OBJECT_MODE 0xdededede 450 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0 451 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb 452 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb 453 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee 454 #define DRM_MODE_OBJECT_ANY 0 455 456 struct drm_mode_obj_get_properties { 457 __u64 props_ptr; 458 __u64 prop_values_ptr; 459 __u32 count_props; 460 __u32 obj_id; 461 __u32 obj_type; 462 }; 463 464 struct drm_mode_obj_set_property { 465 __u64 value; 466 __u32 prop_id; 467 __u32 obj_id; 468 __u32 obj_type; 469 }; 470 471 struct drm_mode_get_blob { 472 __u32 blob_id; 473 __u32 length; 474 __u64 data; 475 }; 476 477 struct drm_mode_fb_cmd { 478 __u32 fb_id; 479 __u32 width; 480 __u32 height; 481 __u32 pitch; 482 __u32 bpp; 483 __u32 depth; 484 /* driver specific handle */ 485 __u32 handle; 486 }; 487 488 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */ 489 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */ 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 than 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 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and 637 * 0xffff == 1.0. 638 */ 639 __u16 red; 640 __u16 green; 641 __u16 blue; 642 __u16 reserved; 643 }; 644 645 /** 646 * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data. 647 * 648 * HDR Metadata Infoframe as per CTA 861.G spec. This is expected 649 * to match exactly with the spec. 650 * 651 * Userspace is expected to pass the metadata information as per 652 * the format described in this structure. 653 */ 654 struct hdr_metadata_infoframe { 655 /** 656 * @eotf: Electro-Optical Transfer Function (EOTF) 657 * used in the stream. 658 */ 659 __u8 eotf; 660 /** 661 * @metadata_type: Static_Metadata_Descriptor_ID. 662 */ 663 __u8 metadata_type; 664 /** 665 * @display_primaries: Color Primaries of the Data. 666 * These are coded as unsigned 16-bit values in units of 667 * 0.00002, where 0x0000 represents zero and 0xC350 668 * represents 1.0000. 669 * @display_primaries.x: X cordinate of color primary. 670 * @display_primaries.y: Y cordinate of color primary. 671 */ 672 struct { 673 __u16 x, y; 674 } display_primaries[3]; 675 /** 676 * @white_point: White Point of Colorspace Data. 677 * These are coded as unsigned 16-bit values in units of 678 * 0.00002, where 0x0000 represents zero and 0xC350 679 * represents 1.0000. 680 * @white_point.x: X cordinate of whitepoint of color primary. 681 * @white_point.y: Y cordinate of whitepoint of color primary. 682 */ 683 struct { 684 __u16 x, y; 685 } white_point; 686 /** 687 * @max_display_mastering_luminance: Max Mastering Display Luminance. 688 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 689 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 690 */ 691 __u16 max_display_mastering_luminance; 692 /** 693 * @min_display_mastering_luminance: Min Mastering Display Luminance. 694 * This value is coded as an unsigned 16-bit value in units of 695 * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF 696 * represents 6.5535 cd/m2. 697 */ 698 __u16 min_display_mastering_luminance; 699 /** 700 * @max_cll: Max Content Light Level. 701 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 702 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 703 */ 704 __u16 max_cll; 705 /** 706 * @max_fall: Max Frame Average Light Level. 707 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 708 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 709 */ 710 __u16 max_fall; 711 }; 712 713 /** 714 * struct hdr_output_metadata - HDR output metadata 715 * 716 * Metadata Information to be passed from userspace 717 */ 718 struct hdr_output_metadata { 719 /** 720 * @metadata_type: Static_Metadata_Descriptor_ID. 721 */ 722 __u32 metadata_type; 723 /** 724 * @hdmi_metadata_type1: HDR Metadata Infoframe. 725 */ 726 union { 727 struct hdr_metadata_infoframe hdmi_metadata_type1; 728 }; 729 }; 730 731 #define DRM_MODE_PAGE_FLIP_EVENT 0x01 732 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02 733 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4 734 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8 735 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \ 736 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE) 737 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \ 738 DRM_MODE_PAGE_FLIP_ASYNC | \ 739 DRM_MODE_PAGE_FLIP_TARGET) 740 741 /* 742 * Request a page flip on the specified crtc. 743 * 744 * This ioctl will ask KMS to schedule a page flip for the specified 745 * crtc. Once any pending rendering targeting the specified fb (as of 746 * ioctl time) has completed, the crtc will be reprogrammed to display 747 * that fb after the next vertical refresh. The ioctl returns 748 * immediately, but subsequent rendering to the current fb will block 749 * in the execbuffer ioctl until the page flip happens. If a page 750 * flip is already pending as the ioctl is called, EBUSY will be 751 * returned. 752 * 753 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank 754 * event (see drm.h: struct drm_event_vblank) when the page flip is 755 * done. The user_data field passed in with this ioctl will be 756 * returned as the user_data field in the vblank event struct. 757 * 758 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen 759 * 'as soon as possible', meaning that it not delay waiting for vblank. 760 * This may cause tearing on the screen. 761 * 762 * The reserved field must be zero. 763 */ 764 765 struct drm_mode_crtc_page_flip { 766 __u32 crtc_id; 767 __u32 fb_id; 768 __u32 flags; 769 __u32 reserved; 770 __u64 user_data; 771 }; 772 773 /* 774 * Request a page flip on the specified crtc. 775 * 776 * Same as struct drm_mode_crtc_page_flip, but supports new flags and 777 * re-purposes the reserved field: 778 * 779 * The sequence field must be zero unless either of the 780 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When 781 * the ABSOLUTE flag is specified, the sequence field denotes the absolute 782 * vblank sequence when the flip should take effect. When the RELATIVE 783 * flag is specified, the sequence field denotes the relative (to the 784 * current one when the ioctl is called) vblank sequence when the flip 785 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to 786 * make sure the vblank sequence before the target one has passed before 787 * calling this ioctl. The purpose of the 788 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify 789 * the target for when code dealing with a page flip runs during a 790 * vertical blank period. 791 */ 792 793 struct drm_mode_crtc_page_flip_target { 794 __u32 crtc_id; 795 __u32 fb_id; 796 __u32 flags; 797 __u32 sequence; 798 __u64 user_data; 799 }; 800 801 /* create a dumb scanout buffer */ 802 struct drm_mode_create_dumb { 803 __u32 height; 804 __u32 width; 805 __u32 bpp; 806 __u32 flags; 807 /* handle, pitch, size will be returned */ 808 __u32 handle; 809 __u32 pitch; 810 __u64 size; 811 }; 812 813 /* set up for mmap of a dumb scanout buffer */ 814 struct drm_mode_map_dumb { 815 /** Handle for the object being mapped. */ 816 __u32 handle; 817 __u32 pad; 818 /** 819 * Fake offset to use for subsequent mmap call 820 * 821 * This is a fixed-size type for 32/64 compatibility. 822 */ 823 __u64 offset; 824 }; 825 826 struct drm_mode_destroy_dumb { 827 __u32 handle; 828 }; 829 830 /* page-flip flags are valid, plus: */ 831 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100 832 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200 833 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400 834 835 #define DRM_MODE_ATOMIC_FLAGS (\ 836 DRM_MODE_PAGE_FLIP_EVENT |\ 837 DRM_MODE_PAGE_FLIP_ASYNC |\ 838 DRM_MODE_ATOMIC_TEST_ONLY |\ 839 DRM_MODE_ATOMIC_NONBLOCK |\ 840 DRM_MODE_ATOMIC_ALLOW_MODESET) 841 842 struct drm_mode_atomic { 843 __u32 flags; 844 __u32 count_objs; 845 __u64 objs_ptr; 846 __u64 count_props_ptr; 847 __u64 props_ptr; 848 __u64 prop_values_ptr; 849 __u64 reserved; 850 __u64 user_data; 851 }; 852 853 struct drm_format_modifier_blob { 854 #define FORMAT_BLOB_CURRENT 1 855 /* Version of this blob format */ 856 __u32 version; 857 858 /* Flags */ 859 __u32 flags; 860 861 /* Number of fourcc formats supported */ 862 __u32 count_formats; 863 864 /* Where in this blob the formats exist (in bytes) */ 865 __u32 formats_offset; 866 867 /* Number of drm_format_modifiers */ 868 __u32 count_modifiers; 869 870 /* Where in this blob the modifiers exist (in bytes) */ 871 __u32 modifiers_offset; 872 873 /* __u32 formats[] */ 874 /* struct drm_format_modifier modifiers[] */ 875 }; 876 877 struct drm_format_modifier { 878 /* Bitmask of formats in get_plane format list this info applies to. The 879 * offset allows a sliding window of which 64 formats (bits). 880 * 881 * Some examples: 882 * In today's world with < 65 formats, and formats 0, and 2 are 883 * supported 884 * 0x0000000000000005 885 * ^-offset = 0, formats = 5 886 * 887 * If the number formats grew to 128, and formats 98-102 are 888 * supported with the modifier: 889 * 890 * 0x0000007c00000000 0000000000000000 891 * ^ 892 * |__offset = 64, formats = 0x7c00000000 893 * 894 */ 895 __u64 formats; 896 __u32 offset; 897 __u32 pad; 898 899 /* The modifier that applies to the >get_plane format list bitmask. */ 900 __u64 modifier; 901 }; 902 903 /** 904 * struct drm_mode_create_blob - Create New block property 905 * @data: Pointer to data to copy. 906 * @length: Length of data to copy. 907 * @blob_id: new property ID. 908 * Create a new 'blob' data property, copying length bytes from data pointer, 909 * and returning new blob ID. 910 */ 911 struct drm_mode_create_blob { 912 /** Pointer to data to copy. */ 913 __u64 data; 914 /** Length of data to copy. */ 915 __u32 length; 916 /** Return: new property ID. */ 917 __u32 blob_id; 918 }; 919 920 /** 921 * struct drm_mode_destroy_blob - Destroy user blob 922 * @blob_id: blob_id to destroy 923 * Destroy a user-created blob property. 924 */ 925 struct drm_mode_destroy_blob { 926 __u32 blob_id; 927 }; 928 929 /** 930 * struct drm_mode_create_lease - Create lease 931 * @object_ids: Pointer to array of object ids. 932 * @object_count: Number of object ids. 933 * @flags: flags for new FD. 934 * @lessee_id: unique identifier for lessee. 935 * @fd: file descriptor to new drm_master file. 936 * Lease mode resources, creating another drm_master. 937 */ 938 struct drm_mode_create_lease { 939 /** Pointer to array of object ids (__u32) */ 940 __u64 object_ids; 941 /** Number of object ids */ 942 __u32 object_count; 943 /** flags for new FD (O_CLOEXEC, etc) */ 944 __u32 flags; 945 946 /** Return: unique identifier for lessee. */ 947 __u32 lessee_id; 948 /** Return: file descriptor to new drm_master file */ 949 __u32 fd; 950 }; 951 952 /** 953 * struct drm_mode_list_lessees - List lessees 954 * @count_lessees: Number of lessees. 955 * @pad: pad. 956 * @lessees_ptr: Pointer to lessess. 957 * List lesses from a drm_master 958 */ 959 struct drm_mode_list_lessees { 960 /** Number of lessees. 961 * On input, provides length of the array. 962 * On output, provides total number. No 963 * more than the input number will be written 964 * back, so two calls can be used to get 965 * the size and then the data. 966 */ 967 __u32 count_lessees; 968 __u32 pad; 969 970 /** Pointer to lessees. 971 * pointer to __u64 array of lessee ids 972 */ 973 __u64 lessees_ptr; 974 }; 975 976 /** 977 * struct drm_mode_get_lease - Get Lease 978 * @count_objects: Number of leased objects. 979 * @pad: pad. 980 * @objects_ptr: Pointer to objects. 981 * Get leased objects 982 */ 983 struct drm_mode_get_lease { 984 /** Number of leased objects. 985 * On input, provides length of the array. 986 * On output, provides total number. No 987 * more than the input number will be written 988 * back, so two calls can be used to get 989 * the size and then the data. 990 */ 991 __u32 count_objects; 992 __u32 pad; 993 994 /** Pointer to objects. 995 * pointer to __u32 array of object ids 996 */ 997 __u64 objects_ptr; 998 }; 999 1000 /** 1001 * struct drm_mode_revoke_lease - Revoke lease 1002 * @lessee_id: Unique ID of lessee. 1003 * Revoke lease 1004 */ 1005 struct drm_mode_revoke_lease { 1006 /** Unique ID of lessee 1007 */ 1008 __u32 lessee_id; 1009 }; 1010 1011 /** 1012 * struct drm_mode_rect - Two dimensional rectangle. 1013 * @x1: Horizontal starting coordinate (inclusive). 1014 * @y1: Vertical starting coordinate (inclusive). 1015 * @x2: Horizontal ending coordinate (exclusive). 1016 * @y2: Vertical ending coordinate (exclusive). 1017 * 1018 * With drm subsystem using struct drm_rect to manage rectangular area this 1019 * export it to user-space. 1020 * 1021 * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS. 1022 */ 1023 struct drm_mode_rect { 1024 __s32 x1; 1025 __s32 y1; 1026 __s32 x2; 1027 __s32 y2; 1028 }; 1029 1030 #if defined(__cplusplus) 1031 } 1032 #endif 1033 1034 #endif 1035