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 /** 37 * DOC: overview 38 * 39 * DRM exposes many UAPI and structure definition to have a consistent 40 * and standardized interface with user. 41 * Userspace can refer to these structure definitions and UAPI formats 42 * to communicate to driver 43 */ 44 45 #define DRM_CONNECTOR_NAME_LEN 32 46 #define DRM_DISPLAY_MODE_LEN 32 47 #define DRM_PROP_NAME_LEN 32 48 49 #define DRM_MODE_TYPE_BUILTIN (1<<0) /* deprecated */ 50 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN) /* deprecated */ 51 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN) /* deprecated */ 52 #define DRM_MODE_TYPE_PREFERRED (1<<3) 53 #define DRM_MODE_TYPE_DEFAULT (1<<4) /* deprecated */ 54 #define DRM_MODE_TYPE_USERDEF (1<<5) 55 #define DRM_MODE_TYPE_DRIVER (1<<6) 56 57 #define DRM_MODE_TYPE_ALL (DRM_MODE_TYPE_PREFERRED | \ 58 DRM_MODE_TYPE_USERDEF | \ 59 DRM_MODE_TYPE_DRIVER) 60 61 /* Video mode flags */ 62 /* bit compatible with the xrandr RR_ definitions (bits 0-13) 63 * 64 * ABI warning: Existing userspace really expects 65 * the mode flags to match the xrandr definitions. Any 66 * changes that don't match the xrandr definitions will 67 * likely need a new client cap or some other mechanism 68 * to avoid breaking existing userspace. This includes 69 * allocating new flags in the previously unused bits! 70 */ 71 #define DRM_MODE_FLAG_PHSYNC (1<<0) 72 #define DRM_MODE_FLAG_NHSYNC (1<<1) 73 #define DRM_MODE_FLAG_PVSYNC (1<<2) 74 #define DRM_MODE_FLAG_NVSYNC (1<<3) 75 #define DRM_MODE_FLAG_INTERLACE (1<<4) 76 #define DRM_MODE_FLAG_DBLSCAN (1<<5) 77 #define DRM_MODE_FLAG_CSYNC (1<<6) 78 #define DRM_MODE_FLAG_PCSYNC (1<<7) 79 #define DRM_MODE_FLAG_NCSYNC (1<<8) 80 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */ 81 #define DRM_MODE_FLAG_BCAST (1<<10) /* deprecated */ 82 #define DRM_MODE_FLAG_PIXMUX (1<<11) /* deprecated */ 83 #define DRM_MODE_FLAG_DBLCLK (1<<12) 84 #define DRM_MODE_FLAG_CLKDIV2 (1<<13) 85 /* 86 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX 87 * (define not exposed to user space). 88 */ 89 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14) 90 #define DRM_MODE_FLAG_3D_NONE (0<<14) 91 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14) 92 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14) 93 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14) 94 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14) 95 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14) 96 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14) 97 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14) 98 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14) 99 100 /* Picture aspect ratio options */ 101 #define DRM_MODE_PICTURE_ASPECT_NONE 0 102 #define DRM_MODE_PICTURE_ASPECT_4_3 1 103 #define DRM_MODE_PICTURE_ASPECT_16_9 2 104 #define DRM_MODE_PICTURE_ASPECT_64_27 3 105 #define DRM_MODE_PICTURE_ASPECT_256_135 4 106 107 /* Content type options */ 108 #define DRM_MODE_CONTENT_TYPE_NO_DATA 0 109 #define DRM_MODE_CONTENT_TYPE_GRAPHICS 1 110 #define DRM_MODE_CONTENT_TYPE_PHOTO 2 111 #define DRM_MODE_CONTENT_TYPE_CINEMA 3 112 #define DRM_MODE_CONTENT_TYPE_GAME 4 113 114 /* Aspect ratio flag bitmask (4 bits 22:19) */ 115 #define DRM_MODE_FLAG_PIC_AR_MASK (0x0F<<19) 116 #define DRM_MODE_FLAG_PIC_AR_NONE \ 117 (DRM_MODE_PICTURE_ASPECT_NONE<<19) 118 #define DRM_MODE_FLAG_PIC_AR_4_3 \ 119 (DRM_MODE_PICTURE_ASPECT_4_3<<19) 120 #define DRM_MODE_FLAG_PIC_AR_16_9 \ 121 (DRM_MODE_PICTURE_ASPECT_16_9<<19) 122 #define DRM_MODE_FLAG_PIC_AR_64_27 \ 123 (DRM_MODE_PICTURE_ASPECT_64_27<<19) 124 #define DRM_MODE_FLAG_PIC_AR_256_135 \ 125 (DRM_MODE_PICTURE_ASPECT_256_135<<19) 126 127 #define DRM_MODE_FLAG_ALL (DRM_MODE_FLAG_PHSYNC | \ 128 DRM_MODE_FLAG_NHSYNC | \ 129 DRM_MODE_FLAG_PVSYNC | \ 130 DRM_MODE_FLAG_NVSYNC | \ 131 DRM_MODE_FLAG_INTERLACE | \ 132 DRM_MODE_FLAG_DBLSCAN | \ 133 DRM_MODE_FLAG_CSYNC | \ 134 DRM_MODE_FLAG_PCSYNC | \ 135 DRM_MODE_FLAG_NCSYNC | \ 136 DRM_MODE_FLAG_HSKEW | \ 137 DRM_MODE_FLAG_DBLCLK | \ 138 DRM_MODE_FLAG_CLKDIV2 | \ 139 DRM_MODE_FLAG_3D_MASK) 140 141 /* DPMS flags */ 142 /* bit compatible with the xorg definitions. */ 143 #define DRM_MODE_DPMS_ON 0 144 #define DRM_MODE_DPMS_STANDBY 1 145 #define DRM_MODE_DPMS_SUSPEND 2 146 #define DRM_MODE_DPMS_OFF 3 147 148 /* Scaling mode options */ 149 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or 150 software can still scale) */ 151 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */ 152 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */ 153 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */ 154 155 /* Dithering mode options */ 156 #define DRM_MODE_DITHERING_OFF 0 157 #define DRM_MODE_DITHERING_ON 1 158 #define DRM_MODE_DITHERING_AUTO 2 159 160 /* Dirty info options */ 161 #define DRM_MODE_DIRTY_OFF 0 162 #define DRM_MODE_DIRTY_ON 1 163 #define DRM_MODE_DIRTY_ANNOTATE 2 164 165 /* Link Status options */ 166 #define DRM_MODE_LINK_STATUS_GOOD 0 167 #define DRM_MODE_LINK_STATUS_BAD 1 168 169 /* 170 * DRM_MODE_ROTATE_<degrees> 171 * 172 * Signals that a drm plane is been rotated <degrees> degrees in counter 173 * clockwise direction. 174 * 175 * This define is provided as a convenience, looking up the property id 176 * using the name->prop id lookup is the preferred method. 177 */ 178 #define DRM_MODE_ROTATE_0 (1<<0) 179 #define DRM_MODE_ROTATE_90 (1<<1) 180 #define DRM_MODE_ROTATE_180 (1<<2) 181 #define DRM_MODE_ROTATE_270 (1<<3) 182 183 /* 184 * DRM_MODE_ROTATE_MASK 185 * 186 * Bitmask used to look for drm plane rotations. 187 */ 188 #define DRM_MODE_ROTATE_MASK (\ 189 DRM_MODE_ROTATE_0 | \ 190 DRM_MODE_ROTATE_90 | \ 191 DRM_MODE_ROTATE_180 | \ 192 DRM_MODE_ROTATE_270) 193 194 /* 195 * DRM_MODE_REFLECT_<axis> 196 * 197 * Signals that the contents of a drm plane is reflected along the <axis> axis, 198 * in the same way as mirroring. 199 * See kerneldoc chapter "Plane Composition Properties" for more details. 200 * 201 * This define is provided as a convenience, looking up the property id 202 * using the name->prop id lookup is the preferred method. 203 */ 204 #define DRM_MODE_REFLECT_X (1<<4) 205 #define DRM_MODE_REFLECT_Y (1<<5) 206 207 /* 208 * DRM_MODE_REFLECT_MASK 209 * 210 * Bitmask used to look for drm plane reflections. 211 */ 212 #define DRM_MODE_REFLECT_MASK (\ 213 DRM_MODE_REFLECT_X | \ 214 DRM_MODE_REFLECT_Y) 215 216 /* Content Protection Flags */ 217 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED 0 218 #define DRM_MODE_CONTENT_PROTECTION_DESIRED 1 219 #define DRM_MODE_CONTENT_PROTECTION_ENABLED 2 220 221 /** 222 * struct drm_mode_modeinfo - Display mode information. 223 * @clock: pixel clock in kHz 224 * @hdisplay: horizontal display size 225 * @hsync_start: horizontal sync start 226 * @hsync_end: horizontal sync end 227 * @htotal: horizontal total size 228 * @hskew: horizontal skew 229 * @vdisplay: vertical display size 230 * @vsync_start: vertical sync start 231 * @vsync_end: vertical sync end 232 * @vtotal: vertical total size 233 * @vscan: vertical scan 234 * @vrefresh: approximate vertical refresh rate in Hz 235 * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines 236 * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines 237 * @name: string describing the mode resolution 238 * 239 * This is the user-space API display mode information structure. For the 240 * kernel version see struct drm_display_mode. 241 */ 242 struct drm_mode_modeinfo { 243 __u32 clock; 244 __u16 hdisplay; 245 __u16 hsync_start; 246 __u16 hsync_end; 247 __u16 htotal; 248 __u16 hskew; 249 __u16 vdisplay; 250 __u16 vsync_start; 251 __u16 vsync_end; 252 __u16 vtotal; 253 __u16 vscan; 254 255 __u32 vrefresh; 256 257 __u32 flags; 258 __u32 type; 259 char name[DRM_DISPLAY_MODE_LEN]; 260 }; 261 262 struct drm_mode_card_res { 263 __u64 fb_id_ptr; 264 __u64 crtc_id_ptr; 265 __u64 connector_id_ptr; 266 __u64 encoder_id_ptr; 267 __u32 count_fbs; 268 __u32 count_crtcs; 269 __u32 count_connectors; 270 __u32 count_encoders; 271 __u32 min_width; 272 __u32 max_width; 273 __u32 min_height; 274 __u32 max_height; 275 }; 276 277 struct drm_mode_crtc { 278 __u64 set_connectors_ptr; 279 __u32 count_connectors; 280 281 __u32 crtc_id; /**< Id */ 282 __u32 fb_id; /**< Id of framebuffer */ 283 284 __u32 x; /**< x Position on the framebuffer */ 285 __u32 y; /**< y Position on the framebuffer */ 286 287 __u32 gamma_size; 288 __u32 mode_valid; 289 struct drm_mode_modeinfo mode; 290 }; 291 292 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0) 293 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1) 294 295 /* Planes blend with or override other bits on the CRTC */ 296 struct drm_mode_set_plane { 297 __u32 plane_id; 298 __u32 crtc_id; 299 __u32 fb_id; /* fb object contains surface format type */ 300 __u32 flags; /* see above flags */ 301 302 /* Signed dest location allows it to be partially off screen */ 303 __s32 crtc_x; 304 __s32 crtc_y; 305 __u32 crtc_w; 306 __u32 crtc_h; 307 308 /* Source values are 16.16 fixed point */ 309 __u32 src_x; 310 __u32 src_y; 311 __u32 src_h; 312 __u32 src_w; 313 }; 314 315 struct drm_mode_get_plane { 316 __u32 plane_id; 317 318 __u32 crtc_id; 319 __u32 fb_id; 320 321 __u32 possible_crtcs; 322 __u32 gamma_size; 323 324 __u32 count_format_types; 325 __u64 format_type_ptr; 326 }; 327 328 struct drm_mode_get_plane_res { 329 __u64 plane_id_ptr; 330 __u32 count_planes; 331 }; 332 333 #define DRM_MODE_ENCODER_NONE 0 334 #define DRM_MODE_ENCODER_DAC 1 335 #define DRM_MODE_ENCODER_TMDS 2 336 #define DRM_MODE_ENCODER_LVDS 3 337 #define DRM_MODE_ENCODER_TVDAC 4 338 #define DRM_MODE_ENCODER_VIRTUAL 5 339 #define DRM_MODE_ENCODER_DSI 6 340 #define DRM_MODE_ENCODER_DPMST 7 341 #define DRM_MODE_ENCODER_DPI 8 342 343 struct drm_mode_get_encoder { 344 __u32 encoder_id; 345 __u32 encoder_type; 346 347 __u32 crtc_id; /**< Id of crtc */ 348 349 __u32 possible_crtcs; 350 __u32 possible_clones; 351 }; 352 353 /* This is for connectors with multiple signal types. */ 354 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */ 355 enum drm_mode_subconnector { 356 DRM_MODE_SUBCONNECTOR_Automatic = 0, /* DVI-I, TV */ 357 DRM_MODE_SUBCONNECTOR_Unknown = 0, /* DVI-I, TV, DP */ 358 DRM_MODE_SUBCONNECTOR_VGA = 1, /* DP */ 359 DRM_MODE_SUBCONNECTOR_DVID = 3, /* DVI-I DP */ 360 DRM_MODE_SUBCONNECTOR_DVIA = 4, /* DVI-I */ 361 DRM_MODE_SUBCONNECTOR_Composite = 5, /* TV */ 362 DRM_MODE_SUBCONNECTOR_SVIDEO = 6, /* TV */ 363 DRM_MODE_SUBCONNECTOR_Component = 8, /* TV */ 364 DRM_MODE_SUBCONNECTOR_SCART = 9, /* TV */ 365 DRM_MODE_SUBCONNECTOR_DisplayPort = 10, /* DP */ 366 DRM_MODE_SUBCONNECTOR_HDMIA = 11, /* DP */ 367 DRM_MODE_SUBCONNECTOR_Native = 15, /* DP */ 368 DRM_MODE_SUBCONNECTOR_Wireless = 18, /* DP */ 369 }; 370 371 #define DRM_MODE_CONNECTOR_Unknown 0 372 #define DRM_MODE_CONNECTOR_VGA 1 373 #define DRM_MODE_CONNECTOR_DVII 2 374 #define DRM_MODE_CONNECTOR_DVID 3 375 #define DRM_MODE_CONNECTOR_DVIA 4 376 #define DRM_MODE_CONNECTOR_Composite 5 377 #define DRM_MODE_CONNECTOR_SVIDEO 6 378 #define DRM_MODE_CONNECTOR_LVDS 7 379 #define DRM_MODE_CONNECTOR_Component 8 380 #define DRM_MODE_CONNECTOR_9PinDIN 9 381 #define DRM_MODE_CONNECTOR_DisplayPort 10 382 #define DRM_MODE_CONNECTOR_HDMIA 11 383 #define DRM_MODE_CONNECTOR_HDMIB 12 384 #define DRM_MODE_CONNECTOR_TV 13 385 #define DRM_MODE_CONNECTOR_eDP 14 386 #define DRM_MODE_CONNECTOR_VIRTUAL 15 387 #define DRM_MODE_CONNECTOR_DSI 16 388 #define DRM_MODE_CONNECTOR_DPI 17 389 #define DRM_MODE_CONNECTOR_WRITEBACK 18 390 #define DRM_MODE_CONNECTOR_SPI 19 391 #define DRM_MODE_CONNECTOR_USB 20 392 393 /** 394 * struct drm_mode_get_connector - Get connector metadata. 395 * 396 * User-space can perform a GETCONNECTOR ioctl to retrieve information about a 397 * connector. User-space is expected to retrieve encoders, modes and properties 398 * by performing this ioctl at least twice: the first time to retrieve the 399 * number of elements, the second time to retrieve the elements themselves. 400 * 401 * To retrieve the number of elements, set @count_props and @count_encoders to 402 * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct 403 * drm_mode_modeinfo element. 404 * 405 * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr, 406 * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and 407 * @count_encoders to their capacity. 408 * 409 * Performing the ioctl only twice may be racy: the number of elements may have 410 * changed with a hotplug event in-between the two ioctls. User-space is 411 * expected to retry the last ioctl until the number of elements stabilizes. 412 * The kernel won't fill any array which doesn't have the expected length. 413 * 414 * **Force-probing a connector** 415 * 416 * If the @count_modes field is set to zero and the DRM client is the current 417 * DRM master, the kernel will perform a forced probe on the connector to 418 * refresh the connector status, modes and EDID. A forced-probe can be slow, 419 * might cause flickering and the ioctl will block. 420 * 421 * User-space needs to force-probe connectors to ensure their metadata is 422 * up-to-date at startup and after receiving a hot-plug event. User-space 423 * may perform a forced-probe when the user explicitly requests it. User-space 424 * shouldn't perform a forced-probe in other situations. 425 */ 426 struct drm_mode_get_connector { 427 /** @encoders_ptr: Pointer to ``__u32`` array of object IDs. */ 428 __u64 encoders_ptr; 429 /** @modes_ptr: Pointer to struct drm_mode_modeinfo array. */ 430 __u64 modes_ptr; 431 /** @props_ptr: Pointer to ``__u32`` array of property IDs. */ 432 __u64 props_ptr; 433 /** @prop_values_ptr: Pointer to ``__u64`` array of property values. */ 434 __u64 prop_values_ptr; 435 436 /** @count_modes: Number of modes. */ 437 __u32 count_modes; 438 /** @count_props: Number of properties. */ 439 __u32 count_props; 440 /** @count_encoders: Number of encoders. */ 441 __u32 count_encoders; 442 443 /** @encoder_id: Object ID of the current encoder. */ 444 __u32 encoder_id; 445 /** @connector_id: Object ID of the connector. */ 446 __u32 connector_id; 447 /** 448 * @connector_type: Type of the connector. 449 * 450 * See DRM_MODE_CONNECTOR_* defines. 451 */ 452 __u32 connector_type; 453 /** 454 * @connector_type_id: Type-specific connector number. 455 * 456 * This is not an object ID. This is a per-type connector number. Each 457 * (type, type_id) combination is unique across all connectors of a DRM 458 * device. 459 */ 460 __u32 connector_type_id; 461 462 /** 463 * @connection: Status of the connector. 464 * 465 * See enum drm_connector_status. 466 */ 467 __u32 connection; 468 /** @mm_width: Width of the connected sink in millimeters. */ 469 __u32 mm_width; 470 /** @mm_height: Height of the connected sink in millimeters. */ 471 __u32 mm_height; 472 /** 473 * @subpixel: Subpixel order of the connected sink. 474 * 475 * See enum subpixel_order. 476 */ 477 __u32 subpixel; 478 479 /** @pad: Padding, must be zero. */ 480 __u32 pad; 481 }; 482 483 #define DRM_MODE_PROP_PENDING (1<<0) /* deprecated, do not use */ 484 #define DRM_MODE_PROP_RANGE (1<<1) 485 #define DRM_MODE_PROP_IMMUTABLE (1<<2) 486 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */ 487 #define DRM_MODE_PROP_BLOB (1<<4) 488 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */ 489 490 /* non-extended types: legacy bitmask, one bit per type: */ 491 #define DRM_MODE_PROP_LEGACY_TYPE ( \ 492 DRM_MODE_PROP_RANGE | \ 493 DRM_MODE_PROP_ENUM | \ 494 DRM_MODE_PROP_BLOB | \ 495 DRM_MODE_PROP_BITMASK) 496 497 /* extended-types: rather than continue to consume a bit per type, 498 * grab a chunk of the bits to use as integer type id. 499 */ 500 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0 501 #define DRM_MODE_PROP_TYPE(n) ((n) << 6) 502 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1) 503 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2) 504 505 /* the PROP_ATOMIC flag is used to hide properties from userspace that 506 * is not aware of atomic properties. This is mostly to work around 507 * older userspace (DDX drivers) that read/write each prop they find, 508 * witout being aware that this could be triggering a lengthy modeset. 509 */ 510 #define DRM_MODE_PROP_ATOMIC 0x80000000 511 512 struct drm_mode_property_enum { 513 __u64 value; 514 char name[DRM_PROP_NAME_LEN]; 515 }; 516 517 struct drm_mode_get_property { 518 __u64 values_ptr; /* values and blob lengths */ 519 __u64 enum_blob_ptr; /* enum and blob id ptrs */ 520 521 __u32 prop_id; 522 __u32 flags; 523 char name[DRM_PROP_NAME_LEN]; 524 525 __u32 count_values; 526 /* This is only used to count enum values, not blobs. The _blobs is 527 * simply because of a historical reason, i.e. backwards compat. */ 528 __u32 count_enum_blobs; 529 }; 530 531 struct drm_mode_connector_set_property { 532 __u64 value; 533 __u32 prop_id; 534 __u32 connector_id; 535 }; 536 537 #define DRM_MODE_OBJECT_CRTC 0xcccccccc 538 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0 539 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0 540 #define DRM_MODE_OBJECT_MODE 0xdededede 541 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0 542 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb 543 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb 544 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee 545 #define DRM_MODE_OBJECT_ANY 0 546 547 struct drm_mode_obj_get_properties { 548 __u64 props_ptr; 549 __u64 prop_values_ptr; 550 __u32 count_props; 551 __u32 obj_id; 552 __u32 obj_type; 553 }; 554 555 struct drm_mode_obj_set_property { 556 __u64 value; 557 __u32 prop_id; 558 __u32 obj_id; 559 __u32 obj_type; 560 }; 561 562 struct drm_mode_get_blob { 563 __u32 blob_id; 564 __u32 length; 565 __u64 data; 566 }; 567 568 struct drm_mode_fb_cmd { 569 __u32 fb_id; 570 __u32 width; 571 __u32 height; 572 __u32 pitch; 573 __u32 bpp; 574 __u32 depth; 575 /* driver specific handle */ 576 __u32 handle; 577 }; 578 579 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */ 580 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */ 581 582 struct drm_mode_fb_cmd2 { 583 __u32 fb_id; 584 __u32 width; 585 __u32 height; 586 __u32 pixel_format; /* fourcc code from drm_fourcc.h */ 587 __u32 flags; /* see above flags */ 588 589 /* 590 * In case of planar formats, this ioctl allows up to 4 591 * buffer objects with offsets and pitches per plane. 592 * The pitch and offset order is dictated by the fourcc, 593 * e.g. NV12 (https://fourcc.org/yuv.php#NV12) is described as: 594 * 595 * YUV 4:2:0 image with a plane of 8 bit Y samples 596 * followed by an interleaved U/V plane containing 597 * 8 bit 2x2 subsampled colour difference samples. 598 * 599 * So it would consist of Y as offsets[0] and UV as 600 * offsets[1]. Note that offsets[0] will generally 601 * be 0 (but this is not required). 602 * 603 * To accommodate tiled, compressed, etc formats, a 604 * modifier can be specified. The default value of zero 605 * indicates "native" format as specified by the fourcc. 606 * Vendor specific modifier token. Note that even though 607 * it looks like we have a modifier per-plane, we in fact 608 * do not. The modifier for each plane must be identical. 609 * Thus all combinations of different data layouts for 610 * multi plane formats must be enumerated as separate 611 * modifiers. 612 */ 613 __u32 handles[4]; 614 __u32 pitches[4]; /* pitch for each plane */ 615 __u32 offsets[4]; /* offset of each plane */ 616 __u64 modifier[4]; /* ie, tiling, compress */ 617 }; 618 619 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01 620 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02 621 #define DRM_MODE_FB_DIRTY_FLAGS 0x03 622 623 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256 624 625 /* 626 * Mark a region of a framebuffer as dirty. 627 * 628 * Some hardware does not automatically update display contents 629 * as a hardware or software draw to a framebuffer. This ioctl 630 * allows userspace to tell the kernel and the hardware what 631 * regions of the framebuffer have changed. 632 * 633 * The kernel or hardware is free to update more then just the 634 * region specified by the clip rects. The kernel or hardware 635 * may also delay and/or coalesce several calls to dirty into a 636 * single update. 637 * 638 * Userspace may annotate the updates, the annotates are a 639 * promise made by the caller that the change is either a copy 640 * of pixels or a fill of a single color in the region specified. 641 * 642 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then 643 * the number of updated regions are half of num_clips given, 644 * where the clip rects are paired in src and dst. The width and 645 * height of each one of the pairs must match. 646 * 647 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller 648 * promises that the region specified of the clip rects is filled 649 * completely with a single color as given in the color argument. 650 */ 651 652 struct drm_mode_fb_dirty_cmd { 653 __u32 fb_id; 654 __u32 flags; 655 __u32 color; 656 __u32 num_clips; 657 __u64 clips_ptr; 658 }; 659 660 struct drm_mode_mode_cmd { 661 __u32 connector_id; 662 struct drm_mode_modeinfo mode; 663 }; 664 665 #define DRM_MODE_CURSOR_BO 0x01 666 #define DRM_MODE_CURSOR_MOVE 0x02 667 #define DRM_MODE_CURSOR_FLAGS 0x03 668 669 /* 670 * depending on the value in flags different members are used. 671 * 672 * CURSOR_BO uses 673 * crtc_id 674 * width 675 * height 676 * handle - if 0 turns the cursor off 677 * 678 * CURSOR_MOVE uses 679 * crtc_id 680 * x 681 * y 682 */ 683 struct drm_mode_cursor { 684 __u32 flags; 685 __u32 crtc_id; 686 __s32 x; 687 __s32 y; 688 __u32 width; 689 __u32 height; 690 /* driver specific handle */ 691 __u32 handle; 692 }; 693 694 struct drm_mode_cursor2 { 695 __u32 flags; 696 __u32 crtc_id; 697 __s32 x; 698 __s32 y; 699 __u32 width; 700 __u32 height; 701 /* driver specific handle */ 702 __u32 handle; 703 __s32 hot_x; 704 __s32 hot_y; 705 }; 706 707 struct drm_mode_crtc_lut { 708 __u32 crtc_id; 709 __u32 gamma_size; 710 711 /* pointers to arrays */ 712 __u64 red; 713 __u64 green; 714 __u64 blue; 715 }; 716 717 struct drm_color_ctm { 718 /* 719 * Conversion matrix in S31.32 sign-magnitude 720 * (not two's complement!) format. 721 */ 722 __u64 matrix[9]; 723 }; 724 725 struct drm_color_lut { 726 /* 727 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and 728 * 0xffff == 1.0. 729 */ 730 __u16 red; 731 __u16 green; 732 __u16 blue; 733 __u16 reserved; 734 }; 735 736 /** 737 * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data. 738 * 739 * HDR Metadata Infoframe as per CTA 861.G spec. This is expected 740 * to match exactly with the spec. 741 * 742 * Userspace is expected to pass the metadata information as per 743 * the format described in this structure. 744 */ 745 struct hdr_metadata_infoframe { 746 /** 747 * @eotf: Electro-Optical Transfer Function (EOTF) 748 * used in the stream. 749 */ 750 __u8 eotf; 751 /** 752 * @metadata_type: Static_Metadata_Descriptor_ID. 753 */ 754 __u8 metadata_type; 755 /** 756 * @display_primaries: Color Primaries of the Data. 757 * These are coded as unsigned 16-bit values in units of 758 * 0.00002, where 0x0000 represents zero and 0xC350 759 * represents 1.0000. 760 * @display_primaries.x: X cordinate of color primary. 761 * @display_primaries.y: Y cordinate of color primary. 762 */ 763 struct { 764 __u16 x, y; 765 } display_primaries[3]; 766 /** 767 * @white_point: White Point of Colorspace Data. 768 * These are coded as unsigned 16-bit values in units of 769 * 0.00002, where 0x0000 represents zero and 0xC350 770 * represents 1.0000. 771 * @white_point.x: X cordinate of whitepoint of color primary. 772 * @white_point.y: Y cordinate of whitepoint of color primary. 773 */ 774 struct { 775 __u16 x, y; 776 } white_point; 777 /** 778 * @max_display_mastering_luminance: Max Mastering Display Luminance. 779 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 780 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 781 */ 782 __u16 max_display_mastering_luminance; 783 /** 784 * @min_display_mastering_luminance: Min Mastering Display Luminance. 785 * This value is coded as an unsigned 16-bit value in units of 786 * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF 787 * represents 6.5535 cd/m2. 788 */ 789 __u16 min_display_mastering_luminance; 790 /** 791 * @max_cll: Max Content Light Level. 792 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 793 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 794 */ 795 __u16 max_cll; 796 /** 797 * @max_fall: Max Frame Average Light Level. 798 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 799 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 800 */ 801 __u16 max_fall; 802 }; 803 804 /** 805 * struct hdr_output_metadata - HDR output metadata 806 * 807 * Metadata Information to be passed from userspace 808 */ 809 struct hdr_output_metadata { 810 /** 811 * @metadata_type: Static_Metadata_Descriptor_ID. 812 */ 813 __u32 metadata_type; 814 /** 815 * @hdmi_metadata_type1: HDR Metadata Infoframe. 816 */ 817 union { 818 struct hdr_metadata_infoframe hdmi_metadata_type1; 819 }; 820 }; 821 822 #define DRM_MODE_PAGE_FLIP_EVENT 0x01 823 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02 824 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4 825 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8 826 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \ 827 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE) 828 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \ 829 DRM_MODE_PAGE_FLIP_ASYNC | \ 830 DRM_MODE_PAGE_FLIP_TARGET) 831 832 /* 833 * Request a page flip on the specified crtc. 834 * 835 * This ioctl will ask KMS to schedule a page flip for the specified 836 * crtc. Once any pending rendering targeting the specified fb (as of 837 * ioctl time) has completed, the crtc will be reprogrammed to display 838 * that fb after the next vertical refresh. The ioctl returns 839 * immediately, but subsequent rendering to the current fb will block 840 * in the execbuffer ioctl until the page flip happens. If a page 841 * flip is already pending as the ioctl is called, EBUSY will be 842 * returned. 843 * 844 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank 845 * event (see drm.h: struct drm_event_vblank) when the page flip is 846 * done. The user_data field passed in with this ioctl will be 847 * returned as the user_data field in the vblank event struct. 848 * 849 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen 850 * 'as soon as possible', meaning that it not delay waiting for vblank. 851 * This may cause tearing on the screen. 852 * 853 * The reserved field must be zero. 854 */ 855 856 struct drm_mode_crtc_page_flip { 857 __u32 crtc_id; 858 __u32 fb_id; 859 __u32 flags; 860 __u32 reserved; 861 __u64 user_data; 862 }; 863 864 /* 865 * Request a page flip on the specified crtc. 866 * 867 * Same as struct drm_mode_crtc_page_flip, but supports new flags and 868 * re-purposes the reserved field: 869 * 870 * The sequence field must be zero unless either of the 871 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When 872 * the ABSOLUTE flag is specified, the sequence field denotes the absolute 873 * vblank sequence when the flip should take effect. When the RELATIVE 874 * flag is specified, the sequence field denotes the relative (to the 875 * current one when the ioctl is called) vblank sequence when the flip 876 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to 877 * make sure the vblank sequence before the target one has passed before 878 * calling this ioctl. The purpose of the 879 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify 880 * the target for when code dealing with a page flip runs during a 881 * vertical blank period. 882 */ 883 884 struct drm_mode_crtc_page_flip_target { 885 __u32 crtc_id; 886 __u32 fb_id; 887 __u32 flags; 888 __u32 sequence; 889 __u64 user_data; 890 }; 891 892 /* create a dumb scanout buffer */ 893 struct drm_mode_create_dumb { 894 __u32 height; 895 __u32 width; 896 __u32 bpp; 897 __u32 flags; 898 /* handle, pitch, size will be returned */ 899 __u32 handle; 900 __u32 pitch; 901 __u64 size; 902 }; 903 904 /* set up for mmap of a dumb scanout buffer */ 905 struct drm_mode_map_dumb { 906 /** Handle for the object being mapped. */ 907 __u32 handle; 908 __u32 pad; 909 /** 910 * Fake offset to use for subsequent mmap call 911 * 912 * This is a fixed-size type for 32/64 compatibility. 913 */ 914 __u64 offset; 915 }; 916 917 struct drm_mode_destroy_dumb { 918 __u32 handle; 919 }; 920 921 /* page-flip flags are valid, plus: */ 922 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100 923 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200 924 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400 925 926 #define DRM_MODE_ATOMIC_FLAGS (\ 927 DRM_MODE_PAGE_FLIP_EVENT |\ 928 DRM_MODE_PAGE_FLIP_ASYNC |\ 929 DRM_MODE_ATOMIC_TEST_ONLY |\ 930 DRM_MODE_ATOMIC_NONBLOCK |\ 931 DRM_MODE_ATOMIC_ALLOW_MODESET) 932 933 struct drm_mode_atomic { 934 __u32 flags; 935 __u32 count_objs; 936 __u64 objs_ptr; 937 __u64 count_props_ptr; 938 __u64 props_ptr; 939 __u64 prop_values_ptr; 940 __u64 reserved; 941 __u64 user_data; 942 }; 943 944 struct drm_format_modifier_blob { 945 #define FORMAT_BLOB_CURRENT 1 946 /* Version of this blob format */ 947 __u32 version; 948 949 /* Flags */ 950 __u32 flags; 951 952 /* Number of fourcc formats supported */ 953 __u32 count_formats; 954 955 /* Where in this blob the formats exist (in bytes) */ 956 __u32 formats_offset; 957 958 /* Number of drm_format_modifiers */ 959 __u32 count_modifiers; 960 961 /* Where in this blob the modifiers exist (in bytes) */ 962 __u32 modifiers_offset; 963 964 /* __u32 formats[] */ 965 /* struct drm_format_modifier modifiers[] */ 966 }; 967 968 struct drm_format_modifier { 969 /* Bitmask of formats in get_plane format list this info applies to. The 970 * offset allows a sliding window of which 64 formats (bits). 971 * 972 * Some examples: 973 * In today's world with < 65 formats, and formats 0, and 2 are 974 * supported 975 * 0x0000000000000005 976 * ^-offset = 0, formats = 5 977 * 978 * If the number formats grew to 128, and formats 98-102 are 979 * supported with the modifier: 980 * 981 * 0x0000007c00000000 0000000000000000 982 * ^ 983 * |__offset = 64, formats = 0x7c00000000 984 * 985 */ 986 __u64 formats; 987 __u32 offset; 988 __u32 pad; 989 990 /* The modifier that applies to the >get_plane format list bitmask. */ 991 __u64 modifier; 992 }; 993 994 /** 995 * struct drm_mode_create_blob - Create New blob property 996 * 997 * Create a new 'blob' data property, copying length bytes from data pointer, 998 * and returning new blob ID. 999 */ 1000 struct drm_mode_create_blob { 1001 /** @data: Pointer to data to copy. */ 1002 __u64 data; 1003 /** @length: Length of data to copy. */ 1004 __u32 length; 1005 /** @blob_id: Return: new property ID. */ 1006 __u32 blob_id; 1007 }; 1008 1009 /** 1010 * struct drm_mode_destroy_blob - Destroy user blob 1011 * @blob_id: blob_id to destroy 1012 * 1013 * Destroy a user-created blob property. 1014 * 1015 * User-space can release blobs as soon as they do not need to refer to them by 1016 * their blob object ID. For instance, if you are using a MODE_ID blob in an 1017 * atomic commit and you will not make another commit re-using the same ID, you 1018 * can destroy the blob as soon as the commit has been issued, without waiting 1019 * for it to complete. 1020 */ 1021 struct drm_mode_destroy_blob { 1022 __u32 blob_id; 1023 }; 1024 1025 /** 1026 * struct drm_mode_create_lease - Create lease 1027 * 1028 * Lease mode resources, creating another drm_master. 1029 */ 1030 struct drm_mode_create_lease { 1031 /** @object_ids: Pointer to array of object ids (__u32) */ 1032 __u64 object_ids; 1033 /** @object_count: Number of object ids */ 1034 __u32 object_count; 1035 /** @flags: flags for new FD (O_CLOEXEC, etc) */ 1036 __u32 flags; 1037 1038 /** @lessee_id: Return: unique identifier for lessee. */ 1039 __u32 lessee_id; 1040 /** @fd: Return: file descriptor to new drm_master file */ 1041 __u32 fd; 1042 }; 1043 1044 /** 1045 * struct drm_mode_list_lessees - List lessees 1046 * 1047 * List lesses from a drm_master. 1048 */ 1049 struct drm_mode_list_lessees { 1050 /** 1051 * @count_lessees: Number of lessees. 1052 * 1053 * On input, provides length of the array. 1054 * On output, provides total number. No 1055 * more than the input number will be written 1056 * back, so two calls can be used to get 1057 * the size and then the data. 1058 */ 1059 __u32 count_lessees; 1060 /** @pad: Padding. */ 1061 __u32 pad; 1062 1063 /** 1064 * @lessees_ptr: Pointer to lessees. 1065 * 1066 * Pointer to __u64 array of lessee ids 1067 */ 1068 __u64 lessees_ptr; 1069 }; 1070 1071 /** 1072 * struct drm_mode_get_lease - Get Lease 1073 * 1074 * Get leased objects. 1075 */ 1076 struct drm_mode_get_lease { 1077 /** 1078 * @count_objects: Number of leased objects. 1079 * 1080 * On input, provides length of the array. 1081 * On output, provides total number. No 1082 * more than the input number will be written 1083 * back, so two calls can be used to get 1084 * the size and then the data. 1085 */ 1086 __u32 count_objects; 1087 /** @pad: Padding. */ 1088 __u32 pad; 1089 1090 /** 1091 * @objects_ptr: Pointer to objects. 1092 * 1093 * Pointer to __u32 array of object ids. 1094 */ 1095 __u64 objects_ptr; 1096 }; 1097 1098 /** 1099 * struct drm_mode_revoke_lease - Revoke lease 1100 */ 1101 struct drm_mode_revoke_lease { 1102 /** @lessee_id: Unique ID of lessee */ 1103 __u32 lessee_id; 1104 }; 1105 1106 /** 1107 * struct drm_mode_rect - Two dimensional rectangle. 1108 * @x1: Horizontal starting coordinate (inclusive). 1109 * @y1: Vertical starting coordinate (inclusive). 1110 * @x2: Horizontal ending coordinate (exclusive). 1111 * @y2: Vertical ending coordinate (exclusive). 1112 * 1113 * With drm subsystem using struct drm_rect to manage rectangular area this 1114 * export it to user-space. 1115 * 1116 * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS. 1117 */ 1118 struct drm_mode_rect { 1119 __s32 x1; 1120 __s32 y1; 1121 __s32 x2; 1122 __s32 y2; 1123 }; 1124 1125 #if defined(__cplusplus) 1126 } 1127 #endif 1128 1129 #endif 1130