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 definitions to have a consistent 40 * and standardized interface with users. 41 * Userspace can refer to these structure definitions and UAPI formats 42 * to communicate to drivers. 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 /* Panel type property */ 170 #define DRM_MODE_PANEL_TYPE_UNKNOWN 0 171 #define DRM_MODE_PANEL_TYPE_OLED 1 172 173 /* 174 * DRM_MODE_ROTATE_<degrees> 175 * 176 * Signals that a drm plane is been rotated <degrees> degrees in counter 177 * clockwise direction. 178 * 179 * This define is provided as a convenience, looking up the property id 180 * using the name->prop id lookup is the preferred method. 181 */ 182 #define DRM_MODE_ROTATE_0 (1<<0) 183 #define DRM_MODE_ROTATE_90 (1<<1) 184 #define DRM_MODE_ROTATE_180 (1<<2) 185 #define DRM_MODE_ROTATE_270 (1<<3) 186 187 /* 188 * DRM_MODE_ROTATE_MASK 189 * 190 * Bitmask used to look for drm plane rotations. 191 */ 192 #define DRM_MODE_ROTATE_MASK (\ 193 DRM_MODE_ROTATE_0 | \ 194 DRM_MODE_ROTATE_90 | \ 195 DRM_MODE_ROTATE_180 | \ 196 DRM_MODE_ROTATE_270) 197 198 /* 199 * DRM_MODE_REFLECT_<axis> 200 * 201 * Signals that the contents of a drm plane is reflected along the <axis> axis, 202 * in the same way as mirroring. 203 * See kerneldoc chapter "Plane Composition Properties" for more details. 204 * 205 * This define is provided as a convenience, looking up the property id 206 * using the name->prop id lookup is the preferred method. 207 */ 208 #define DRM_MODE_REFLECT_X (1<<4) 209 #define DRM_MODE_REFLECT_Y (1<<5) 210 211 /* 212 * DRM_MODE_REFLECT_MASK 213 * 214 * Bitmask used to look for drm plane reflections. 215 */ 216 #define DRM_MODE_REFLECT_MASK (\ 217 DRM_MODE_REFLECT_X | \ 218 DRM_MODE_REFLECT_Y) 219 220 /* Content Protection Flags */ 221 #define DRM_MODE_CONTENT_PROTECTION_UNDESIRED 0 222 #define DRM_MODE_CONTENT_PROTECTION_DESIRED 1 223 #define DRM_MODE_CONTENT_PROTECTION_ENABLED 2 224 225 /** 226 * struct drm_mode_modeinfo - Display mode information. 227 * @clock: pixel clock in kHz 228 * @hdisplay: horizontal display size 229 * @hsync_start: horizontal sync start 230 * @hsync_end: horizontal sync end 231 * @htotal: horizontal total size 232 * @hskew: horizontal skew 233 * @vdisplay: vertical display size 234 * @vsync_start: vertical sync start 235 * @vsync_end: vertical sync end 236 * @vtotal: vertical total size 237 * @vscan: vertical scan 238 * @vrefresh: approximate vertical refresh rate in Hz 239 * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines 240 * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines 241 * @name: string describing the mode resolution 242 * 243 * This is the user-space API display mode information structure. For the 244 * kernel version see struct drm_display_mode. 245 */ 246 struct drm_mode_modeinfo { 247 __u32 clock; 248 __u16 hdisplay; 249 __u16 hsync_start; 250 __u16 hsync_end; 251 __u16 htotal; 252 __u16 hskew; 253 __u16 vdisplay; 254 __u16 vsync_start; 255 __u16 vsync_end; 256 __u16 vtotal; 257 __u16 vscan; 258 259 __u32 vrefresh; 260 261 __u32 flags; 262 __u32 type; 263 char name[DRM_DISPLAY_MODE_LEN]; 264 }; 265 266 struct drm_mode_card_res { 267 __u64 fb_id_ptr; 268 __u64 crtc_id_ptr; 269 __u64 connector_id_ptr; 270 __u64 encoder_id_ptr; 271 __u32 count_fbs; 272 __u32 count_crtcs; 273 __u32 count_connectors; 274 __u32 count_encoders; 275 __u32 min_width; 276 __u32 max_width; 277 __u32 min_height; 278 __u32 max_height; 279 }; 280 281 struct drm_mode_crtc { 282 __u64 set_connectors_ptr; 283 __u32 count_connectors; 284 285 __u32 crtc_id; /**< Id */ 286 __u32 fb_id; /**< Id of framebuffer */ 287 288 __u32 x; /**< x Position on the framebuffer */ 289 __u32 y; /**< y Position on the framebuffer */ 290 291 __u32 gamma_size; 292 __u32 mode_valid; 293 struct drm_mode_modeinfo mode; 294 }; 295 296 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0) 297 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1) 298 299 /* Planes blend with or override other bits on the CRTC */ 300 struct drm_mode_set_plane { 301 __u32 plane_id; 302 __u32 crtc_id; 303 __u32 fb_id; /* fb object contains surface format type */ 304 __u32 flags; /* see above flags */ 305 306 /* Signed dest location allows it to be partially off screen */ 307 __s32 crtc_x; 308 __s32 crtc_y; 309 __u32 crtc_w; 310 __u32 crtc_h; 311 312 /* Source values are 16.16 fixed point */ 313 __u32 src_x; 314 __u32 src_y; 315 __u32 src_h; 316 __u32 src_w; 317 }; 318 319 /** 320 * struct drm_mode_get_plane - Get plane metadata. 321 * 322 * Userspace can perform a GETPLANE ioctl to retrieve information about a 323 * plane. 324 * 325 * To retrieve the number of formats supported, set @count_format_types to zero 326 * and call the ioctl. @count_format_types will be updated with the value. 327 * 328 * To retrieve these formats, allocate an array with the memory needed to store 329 * @count_format_types formats. Point @format_type_ptr to this array and call 330 * the ioctl again (with @count_format_types still set to the value returned in 331 * the first ioctl call). 332 */ 333 struct drm_mode_get_plane { 334 /** 335 * @plane_id: Object ID of the plane whose information should be 336 * retrieved. Set by caller. 337 */ 338 __u32 plane_id; 339 340 /** @crtc_id: Object ID of the current CRTC. */ 341 __u32 crtc_id; 342 /** @fb_id: Object ID of the current fb. */ 343 __u32 fb_id; 344 345 /** 346 * @possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's 347 * are created and they receive an index, which corresponds to their 348 * position in the bitmask. Bit N corresponds to 349 * :ref:`CRTC index<crtc_index>` N. 350 */ 351 __u32 possible_crtcs; 352 /** @gamma_size: Never used. */ 353 __u32 gamma_size; 354 355 /** @count_format_types: Number of formats. */ 356 __u32 count_format_types; 357 /** 358 * @format_type_ptr: Pointer to ``__u32`` array of formats that are 359 * supported by the plane. These formats do not require modifiers. 360 */ 361 __u64 format_type_ptr; 362 }; 363 364 struct drm_mode_get_plane_res { 365 __u64 plane_id_ptr; 366 __u32 count_planes; 367 }; 368 369 #define DRM_MODE_ENCODER_NONE 0 370 #define DRM_MODE_ENCODER_DAC 1 371 #define DRM_MODE_ENCODER_TMDS 2 372 #define DRM_MODE_ENCODER_LVDS 3 373 #define DRM_MODE_ENCODER_TVDAC 4 374 #define DRM_MODE_ENCODER_VIRTUAL 5 375 #define DRM_MODE_ENCODER_DSI 6 376 #define DRM_MODE_ENCODER_DPMST 7 377 #define DRM_MODE_ENCODER_DPI 8 378 379 struct drm_mode_get_encoder { 380 __u32 encoder_id; 381 __u32 encoder_type; 382 383 __u32 crtc_id; /**< Id of crtc */ 384 385 __u32 possible_crtcs; 386 __u32 possible_clones; 387 }; 388 389 /* This is for connectors with multiple signal types. */ 390 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */ 391 enum drm_mode_subconnector { 392 DRM_MODE_SUBCONNECTOR_Automatic = 0, /* DVI-I, TV */ 393 DRM_MODE_SUBCONNECTOR_Unknown = 0, /* DVI-I, TV, DP */ 394 DRM_MODE_SUBCONNECTOR_VGA = 1, /* DP */ 395 DRM_MODE_SUBCONNECTOR_DVID = 3, /* DVI-I DP */ 396 DRM_MODE_SUBCONNECTOR_DVIA = 4, /* DVI-I */ 397 DRM_MODE_SUBCONNECTOR_Composite = 5, /* TV */ 398 DRM_MODE_SUBCONNECTOR_SVIDEO = 6, /* TV */ 399 DRM_MODE_SUBCONNECTOR_Component = 8, /* TV */ 400 DRM_MODE_SUBCONNECTOR_SCART = 9, /* TV */ 401 DRM_MODE_SUBCONNECTOR_DisplayPort = 10, /* DP */ 402 DRM_MODE_SUBCONNECTOR_HDMIA = 11, /* DP */ 403 DRM_MODE_SUBCONNECTOR_Native = 15, /* DP */ 404 DRM_MODE_SUBCONNECTOR_Wireless = 18, /* DP */ 405 }; 406 407 #define DRM_MODE_CONNECTOR_Unknown 0 408 #define DRM_MODE_CONNECTOR_VGA 1 409 #define DRM_MODE_CONNECTOR_DVII 2 410 #define DRM_MODE_CONNECTOR_DVID 3 411 #define DRM_MODE_CONNECTOR_DVIA 4 412 #define DRM_MODE_CONNECTOR_Composite 5 413 #define DRM_MODE_CONNECTOR_SVIDEO 6 414 #define DRM_MODE_CONNECTOR_LVDS 7 415 #define DRM_MODE_CONNECTOR_Component 8 416 #define DRM_MODE_CONNECTOR_9PinDIN 9 417 #define DRM_MODE_CONNECTOR_DisplayPort 10 418 #define DRM_MODE_CONNECTOR_HDMIA 11 419 #define DRM_MODE_CONNECTOR_HDMIB 12 420 #define DRM_MODE_CONNECTOR_TV 13 421 #define DRM_MODE_CONNECTOR_eDP 14 422 #define DRM_MODE_CONNECTOR_VIRTUAL 15 423 #define DRM_MODE_CONNECTOR_DSI 16 424 #define DRM_MODE_CONNECTOR_DPI 17 425 #define DRM_MODE_CONNECTOR_WRITEBACK 18 426 #define DRM_MODE_CONNECTOR_SPI 19 427 #define DRM_MODE_CONNECTOR_USB 20 428 429 /** 430 * struct drm_mode_get_connector - Get connector metadata. 431 * 432 * User-space can perform a GETCONNECTOR ioctl to retrieve information about a 433 * connector. User-space is expected to retrieve encoders, modes and properties 434 * by performing this ioctl at least twice: the first time to retrieve the 435 * number of elements, the second time to retrieve the elements themselves. 436 * 437 * To retrieve the number of elements, set @count_props and @count_encoders to 438 * zero, set @count_modes to 1, and set @modes_ptr to a temporary struct 439 * drm_mode_modeinfo element. 440 * 441 * To retrieve the elements, allocate arrays for @encoders_ptr, @modes_ptr, 442 * @props_ptr and @prop_values_ptr, then set @count_modes, @count_props and 443 * @count_encoders to their capacity. 444 * 445 * Performing the ioctl only twice may be racy: the number of elements may have 446 * changed with a hotplug event in-between the two ioctls. User-space is 447 * expected to retry the last ioctl until the number of elements stabilizes. 448 * The kernel won't fill any array which doesn't have the expected length. 449 * 450 * **Force-probing a connector** 451 * 452 * If the @count_modes field is set to zero and the DRM client is the current 453 * DRM master, the kernel will perform a forced probe on the connector to 454 * refresh the connector status, modes and EDID. A forced-probe can be slow, 455 * might cause flickering and the ioctl will block. 456 * 457 * User-space needs to force-probe connectors to ensure their metadata is 458 * up-to-date at startup and after receiving a hot-plug event. User-space 459 * may perform a forced-probe when the user explicitly requests it. User-space 460 * shouldn't perform a forced-probe in other situations. 461 */ 462 struct drm_mode_get_connector { 463 /** @encoders_ptr: Pointer to ``__u32`` array of object IDs. */ 464 __u64 encoders_ptr; 465 /** @modes_ptr: Pointer to struct drm_mode_modeinfo array. */ 466 __u64 modes_ptr; 467 /** @props_ptr: Pointer to ``__u32`` array of property IDs. */ 468 __u64 props_ptr; 469 /** @prop_values_ptr: Pointer to ``__u64`` array of property values. */ 470 __u64 prop_values_ptr; 471 472 /** @count_modes: Number of modes. */ 473 __u32 count_modes; 474 /** @count_props: Number of properties. */ 475 __u32 count_props; 476 /** @count_encoders: Number of encoders. */ 477 __u32 count_encoders; 478 479 /** @encoder_id: Object ID of the current encoder. */ 480 __u32 encoder_id; 481 /** @connector_id: Object ID of the connector. */ 482 __u32 connector_id; 483 /** 484 * @connector_type: Type of the connector. 485 * 486 * See DRM_MODE_CONNECTOR_* defines. 487 */ 488 __u32 connector_type; 489 /** 490 * @connector_type_id: Type-specific connector number. 491 * 492 * This is not an object ID. This is a per-type connector number. Each 493 * (type, type_id) combination is unique across all connectors of a DRM 494 * device. 495 * 496 * The (type, type_id) combination is not a stable identifier: the 497 * type_id can change depending on the driver probe order. 498 */ 499 __u32 connector_type_id; 500 501 /** 502 * @connection: Status of the connector. 503 * 504 * See enum drm_connector_status. 505 */ 506 __u32 connection; 507 /** @mm_width: Width of the connected sink in millimeters. */ 508 __u32 mm_width; 509 /** @mm_height: Height of the connected sink in millimeters. */ 510 __u32 mm_height; 511 /** 512 * @subpixel: Subpixel order of the connected sink. 513 * 514 * See enum subpixel_order. 515 */ 516 __u32 subpixel; 517 518 /** @pad: Padding, must be zero. */ 519 __u32 pad; 520 }; 521 522 #define DRM_MODE_PROP_PENDING (1<<0) /* deprecated, do not use */ 523 #define DRM_MODE_PROP_RANGE (1<<1) 524 #define DRM_MODE_PROP_IMMUTABLE (1<<2) 525 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */ 526 #define DRM_MODE_PROP_BLOB (1<<4) 527 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */ 528 529 /* non-extended types: legacy bitmask, one bit per type: */ 530 #define DRM_MODE_PROP_LEGACY_TYPE ( \ 531 DRM_MODE_PROP_RANGE | \ 532 DRM_MODE_PROP_ENUM | \ 533 DRM_MODE_PROP_BLOB | \ 534 DRM_MODE_PROP_BITMASK) 535 536 /* extended-types: rather than continue to consume a bit per type, 537 * grab a chunk of the bits to use as integer type id. 538 */ 539 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0 540 #define DRM_MODE_PROP_TYPE(n) ((n) << 6) 541 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1) 542 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2) 543 544 /* the PROP_ATOMIC flag is used to hide properties from userspace that 545 * is not aware of atomic properties. This is mostly to work around 546 * older userspace (DDX drivers) that read/write each prop they find, 547 * without being aware that this could be triggering a lengthy modeset. 548 */ 549 #define DRM_MODE_PROP_ATOMIC 0x80000000 550 551 /** 552 * struct drm_mode_property_enum - Description for an enum/bitfield entry. 553 * @value: numeric value for this enum entry. 554 * @name: symbolic name for this enum entry. 555 * 556 * See struct drm_property_enum for details. 557 */ 558 struct drm_mode_property_enum { 559 __u64 value; 560 char name[DRM_PROP_NAME_LEN]; 561 }; 562 563 /** 564 * struct drm_mode_get_property - Get property metadata. 565 * 566 * User-space can perform a GETPROPERTY ioctl to retrieve information about a 567 * property. The same property may be attached to multiple objects, see 568 * "Modeset Base Object Abstraction". 569 * 570 * The meaning of the @values_ptr field changes depending on the property type. 571 * See &drm_property.flags for more details. 572 * 573 * The @enum_blob_ptr and @count_enum_blobs fields are only meaningful when the 574 * property has the type &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK. For 575 * backwards compatibility, the kernel will always set @count_enum_blobs to 576 * zero when the property has the type &DRM_MODE_PROP_BLOB. User-space must 577 * ignore these two fields if the property has a different type. 578 * 579 * User-space is expected to retrieve values and enums by performing this ioctl 580 * at least twice: the first time to retrieve the number of elements, the 581 * second time to retrieve the elements themselves. 582 * 583 * To retrieve the number of elements, set @count_values and @count_enum_blobs 584 * to zero, then call the ioctl. @count_values will be updated with the number 585 * of elements. If the property has the type &DRM_MODE_PROP_ENUM or 586 * &DRM_MODE_PROP_BITMASK, @count_enum_blobs will be updated as well. 587 * 588 * To retrieve the elements themselves, allocate an array for @values_ptr and 589 * set @count_values to its capacity. If the property has the type 590 * &DRM_MODE_PROP_ENUM or &DRM_MODE_PROP_BITMASK, allocate an array for 591 * @enum_blob_ptr and set @count_enum_blobs to its capacity. Calling the ioctl 592 * again will fill the arrays. 593 */ 594 struct drm_mode_get_property { 595 /** @values_ptr: Pointer to a ``__u64`` array. */ 596 __u64 values_ptr; 597 /** @enum_blob_ptr: Pointer to a struct drm_mode_property_enum array. */ 598 __u64 enum_blob_ptr; 599 600 /** 601 * @prop_id: Object ID of the property which should be retrieved. Set 602 * by the caller. 603 */ 604 __u32 prop_id; 605 /** 606 * @flags: ``DRM_MODE_PROP_*`` bitfield. See &drm_property.flags for 607 * a definition of the flags. 608 */ 609 __u32 flags; 610 /** 611 * @name: Symbolic property name. User-space should use this field to 612 * recognize properties. 613 */ 614 char name[DRM_PROP_NAME_LEN]; 615 616 /** @count_values: Number of elements in @values_ptr. */ 617 __u32 count_values; 618 /** @count_enum_blobs: Number of elements in @enum_blob_ptr. */ 619 __u32 count_enum_blobs; 620 }; 621 622 struct drm_mode_connector_set_property { 623 __u64 value; 624 __u32 prop_id; 625 __u32 connector_id; 626 }; 627 628 #define DRM_MODE_OBJECT_CRTC 0xcccccccc 629 #define DRM_MODE_OBJECT_CONNECTOR 0xc0c0c0c0 630 #define DRM_MODE_OBJECT_ENCODER 0xe0e0e0e0 631 #define DRM_MODE_OBJECT_MODE 0xdededede 632 #define DRM_MODE_OBJECT_PROPERTY 0xb0b0b0b0 633 #define DRM_MODE_OBJECT_FB 0xfbfbfbfb 634 #define DRM_MODE_OBJECT_BLOB 0xbbbbbbbb 635 #define DRM_MODE_OBJECT_PLANE 0xeeeeeeee 636 #define DRM_MODE_OBJECT_COLOROP 0xfafafafa 637 #define DRM_MODE_OBJECT_ANY 0 638 639 struct drm_mode_obj_get_properties { 640 __u64 props_ptr; 641 __u64 prop_values_ptr; 642 __u32 count_props; 643 __u32 obj_id; 644 __u32 obj_type; 645 }; 646 647 struct drm_mode_obj_set_property { 648 __u64 value; 649 __u32 prop_id; 650 __u32 obj_id; 651 __u32 obj_type; 652 }; 653 654 struct drm_mode_get_blob { 655 __u32 blob_id; 656 __u32 length; 657 __u64 data; 658 }; 659 660 struct drm_mode_fb_cmd { 661 __u32 fb_id; 662 __u32 width; 663 __u32 height; 664 __u32 pitch; 665 __u32 bpp; 666 __u32 depth; 667 /* driver specific handle */ 668 __u32 handle; 669 }; 670 671 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */ 672 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifier[] */ 673 674 /** 675 * struct drm_mode_fb_cmd2 - Frame-buffer metadata. 676 * 677 * This struct holds frame-buffer metadata. There are two ways to use it: 678 * 679 * - User-space can fill this struct and perform a &DRM_IOCTL_MODE_ADDFB2 680 * ioctl to register a new frame-buffer. The new frame-buffer object ID will 681 * be set by the kernel in @fb_id. 682 * - User-space can set @fb_id and perform a &DRM_IOCTL_MODE_GETFB2 ioctl to 683 * fetch metadata about an existing frame-buffer. 684 * 685 * In case of planar formats, this struct allows up to 4 buffer objects with 686 * offsets and pitches per plane. The pitch and offset order are dictated by 687 * the format FourCC as defined by ``drm_fourcc.h``, e.g. NV12 is described as: 688 * 689 * YUV 4:2:0 image with a plane of 8-bit Y samples followed by an 690 * interleaved U/V plane containing 8-bit 2x2 subsampled colour difference 691 * samples. 692 * 693 * So it would consist of a Y plane at ``offsets[0]`` and a UV plane at 694 * ``offsets[1]``. 695 * 696 * To accommodate tiled, compressed, etc formats, a modifier can be specified. 697 * For more information see the "Format Modifiers" section. Note that even 698 * though it looks like we have a modifier per-plane, we in fact do not. The 699 * modifier for each plane must be identical. Thus all combinations of 700 * different data layouts for multi-plane formats must be enumerated as 701 * separate modifiers. 702 * 703 * All of the entries in @handles, @pitches, @offsets and @modifier must be 704 * zero when unused. Warning, for @offsets and @modifier zero can't be used to 705 * figure out whether the entry is used or not since it's a valid value (a zero 706 * offset is common, and a zero modifier is &DRM_FORMAT_MOD_LINEAR). 707 */ 708 struct drm_mode_fb_cmd2 { 709 /** @fb_id: Object ID of the frame-buffer. */ 710 __u32 fb_id; 711 /** @width: Width of the frame-buffer. */ 712 __u32 width; 713 /** @height: Height of the frame-buffer. */ 714 __u32 height; 715 /** 716 * @pixel_format: FourCC format code, see ``DRM_FORMAT_*`` constants in 717 * ``drm_fourcc.h``. 718 */ 719 __u32 pixel_format; 720 /** 721 * @flags: Frame-buffer flags (see &DRM_MODE_FB_INTERLACED and 722 * &DRM_MODE_FB_MODIFIERS). 723 */ 724 __u32 flags; 725 726 /** 727 * @handles: GEM buffer handle, one per plane. Set to 0 if the plane is 728 * unused. The same handle can be used for multiple planes. 729 */ 730 __u32 handles[4]; 731 /** @pitches: Pitch (aka. stride) in bytes, one per plane. */ 732 __u32 pitches[4]; 733 /** @offsets: Offset into the buffer in bytes, one per plane. */ 734 __u32 offsets[4]; 735 /** 736 * @modifier: Format modifier, one per plane. See ``DRM_FORMAT_MOD_*`` 737 * constants in ``drm_fourcc.h``. All planes must use the same 738 * modifier. Ignored unless &DRM_MODE_FB_MODIFIERS is set in @flags. 739 */ 740 __u64 modifier[4]; 741 }; 742 743 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01 744 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02 745 #define DRM_MODE_FB_DIRTY_FLAGS 0x03 746 747 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256 748 749 /* 750 * Mark a region of a framebuffer as dirty. 751 * 752 * Some hardware does not automatically update display contents 753 * as a hardware or software draw to a framebuffer. This ioctl 754 * allows userspace to tell the kernel and the hardware what 755 * regions of the framebuffer have changed. 756 * 757 * The kernel or hardware is free to update more then just the 758 * region specified by the clip rects. The kernel or hardware 759 * may also delay and/or coalesce several calls to dirty into a 760 * single update. 761 * 762 * Userspace may annotate the updates, the annotates are a 763 * promise made by the caller that the change is either a copy 764 * of pixels or a fill of a single color in the region specified. 765 * 766 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then 767 * the number of updated regions are half of num_clips given, 768 * where the clip rects are paired in src and dst. The width and 769 * height of each one of the pairs must match. 770 * 771 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller 772 * promises that the region specified of the clip rects is filled 773 * completely with a single color as given in the color argument. 774 */ 775 776 struct drm_mode_fb_dirty_cmd { 777 __u32 fb_id; 778 __u32 flags; 779 __u32 color; 780 __u32 num_clips; 781 __u64 clips_ptr; 782 }; 783 784 struct drm_mode_mode_cmd { 785 __u32 connector_id; 786 struct drm_mode_modeinfo mode; 787 }; 788 789 #define DRM_MODE_CURSOR_BO 0x01 790 #define DRM_MODE_CURSOR_MOVE 0x02 791 #define DRM_MODE_CURSOR_FLAGS 0x03 792 793 /* 794 * depending on the value in flags different members are used. 795 * 796 * CURSOR_BO uses 797 * crtc_id 798 * width 799 * height 800 * handle - if 0 turns the cursor off 801 * 802 * CURSOR_MOVE uses 803 * crtc_id 804 * x 805 * y 806 */ 807 struct drm_mode_cursor { 808 __u32 flags; 809 __u32 crtc_id; 810 __s32 x; 811 __s32 y; 812 __u32 width; 813 __u32 height; 814 /* driver specific handle */ 815 __u32 handle; 816 }; 817 818 struct drm_mode_cursor2 { 819 __u32 flags; 820 __u32 crtc_id; 821 __s32 x; 822 __s32 y; 823 __u32 width; 824 __u32 height; 825 /* driver specific handle */ 826 __u32 handle; 827 __s32 hot_x; 828 __s32 hot_y; 829 }; 830 831 struct drm_mode_crtc_lut { 832 __u32 crtc_id; 833 __u32 gamma_size; 834 835 /* pointers to arrays */ 836 __u64 red; 837 __u64 green; 838 __u64 blue; 839 }; 840 841 struct drm_color_ctm { 842 /* 843 * Conversion matrix in S31.32 sign-magnitude 844 * (not two's complement!) format. 845 * 846 * out matrix in 847 * |R| |0 1 2| |R| 848 * |G| = |3 4 5| x |G| 849 * |B| |6 7 8| |B| 850 */ 851 __u64 matrix[9]; 852 }; 853 854 struct drm_color_ctm_3x4 { 855 /* 856 * Conversion matrix with 3x4 dimensions in S31.32 sign-magnitude 857 * (not two's complement!) format. 858 * 859 * out matrix in 860 * |R| |0 1 2 3 | | R | 861 * |G| = |4 5 6 7 | x | G | 862 * |B| |8 9 10 11| | B | 863 * |1.0| 864 */ 865 __u64 matrix[12]; 866 }; 867 868 struct drm_color_lut { 869 /* 870 * Values are mapped linearly to 0.0 - 1.0 range, with 0x0 == 0.0 and 871 * 0xffff == 1.0. 872 */ 873 __u16 red; 874 __u16 green; 875 __u16 blue; 876 __u16 reserved; 877 }; 878 879 /* 880 * struct drm_color_lut32 881 * 882 * 32-bit per channel color LUT entry, similar to drm_color_lut. 883 */ 884 struct drm_color_lut32 { 885 __u32 red; 886 __u32 green; 887 __u32 blue; 888 __u32 reserved; 889 }; 890 891 /** 892 * enum drm_colorop_type - Type of color operation 893 * 894 * drm_colorops can be of many different types. Each type behaves differently 895 * and defines a different set of properties. This enum defines all types and 896 * gives a high-level description. 897 */ 898 enum drm_colorop_type { 899 /** 900 * @DRM_COLOROP_1D_CURVE: 901 * 902 * enum string "1D Curve" 903 * 904 * A 1D curve that is being applied to all color channels. The 905 * curve is specified via the CURVE_1D_TYPE colorop property. 906 */ 907 DRM_COLOROP_1D_CURVE, 908 909 /** 910 * @DRM_COLOROP_1D_LUT: 911 * 912 * enum string "1D LUT" 913 * 914 * A simple 1D LUT of uniformly spaced &drm_color_lut32 entries, 915 * packed into a blob via the DATA property. The driver's 916 * expected LUT size is advertised via the SIZE property. 917 * 918 * The DATA blob is an array of struct drm_color_lut32 with size 919 * of "size". 920 */ 921 DRM_COLOROP_1D_LUT, 922 923 /** 924 * @DRM_COLOROP_CTM_3X4: 925 * 926 * enum string "3x4 Matrix" 927 * 928 * A 3x4 matrix. Its values are specified via the 929 * &drm_color_ctm_3x4 struct provided via the DATA property. 930 * 931 * The DATA blob is a float[12]: 932 * out matrix in 933 * | R | | 0 1 2 3 | | R | 934 * | G | = | 4 5 6 7 | x | G | 935 * | B | | 8 9 10 12 | | B | 936 */ 937 DRM_COLOROP_CTM_3X4, 938 939 /** 940 * @DRM_COLOROP_MULTIPLIER: 941 * 942 * enum string "Multiplier" 943 * 944 * A simple multiplier, applied to all color values. The 945 * multiplier is specified as a S31.32 via the MULTIPLIER 946 * property. 947 */ 948 DRM_COLOROP_MULTIPLIER, 949 950 /** 951 * @DRM_COLOROP_3D_LUT: 952 * 953 * enum string "3D LUT" 954 * 955 * A 3D LUT of &drm_color_lut32 entries, 956 * packed into a blob via the DATA property. The driver's expected 957 * LUT size is advertised via the SIZE property, i.e., a 3D LUT with 958 * 17x17x17 entries will have SIZE set to 17. 959 * 960 * The DATA blob is a 3D array of struct drm_color_lut32 with dimension 961 * length of "size". 962 * The LUT elements are traversed like so: 963 * 964 * for B in range 0..n 965 * for G in range 0..n 966 * for R in range 0..n 967 * index = R + n * (G + n * B) 968 * color = lut3d[index] 969 */ 970 DRM_COLOROP_3D_LUT, 971 }; 972 973 /** 974 * enum drm_colorop_lut3d_interpolation_type - type of 3DLUT interpolation 975 */ 976 enum drm_colorop_lut3d_interpolation_type { 977 /** 978 * @DRM_COLOROP_LUT3D_INTERPOLATION_TETRAHEDRAL: 979 * 980 * Tetrahedral 3DLUT interpolation 981 */ 982 DRM_COLOROP_LUT3D_INTERPOLATION_TETRAHEDRAL, 983 }; 984 985 /** 986 * enum drm_colorop_lut1d_interpolation_type - type of interpolation for 1D LUTs 987 */ 988 enum drm_colorop_lut1d_interpolation_type { 989 /** 990 * @DRM_COLOROP_LUT1D_INTERPOLATION_LINEAR: 991 * 992 * Linear interpolation. Values between points of the LUT will be 993 * linearly interpolated. 994 */ 995 DRM_COLOROP_LUT1D_INTERPOLATION_LINEAR, 996 }; 997 998 /** 999 * struct drm_plane_size_hint - Plane size hints 1000 * @width: The width of the plane in pixel 1001 * @height: The height of the plane in pixel 1002 * 1003 * The plane SIZE_HINTS property blob contains an 1004 * array of struct drm_plane_size_hint. 1005 */ 1006 struct drm_plane_size_hint { 1007 __u16 width; 1008 __u16 height; 1009 }; 1010 1011 /** 1012 * struct hdr_metadata_infoframe - HDR Metadata Infoframe Data. 1013 * 1014 * HDR Metadata Infoframe as per CTA 861.G spec. This is expected 1015 * to match exactly with the spec. 1016 * 1017 * Userspace is expected to pass the metadata information as per 1018 * the format described in this structure. 1019 */ 1020 struct hdr_metadata_infoframe { 1021 /** 1022 * @eotf: Electro-Optical Transfer Function (EOTF) 1023 * used in the stream. 1024 */ 1025 __u8 eotf; 1026 /** 1027 * @metadata_type: Static_Metadata_Descriptor_ID. 1028 */ 1029 __u8 metadata_type; 1030 /** 1031 * @display_primaries: Color Primaries of the Data. 1032 * These are coded as unsigned 16-bit values in units of 1033 * 0.00002, where 0x0000 represents zero and 0xC350 1034 * represents 1.0000. 1035 * @display_primaries.x: X coordinate of color primary. 1036 * @display_primaries.y: Y coordinate of color primary. 1037 */ 1038 struct { 1039 __u16 x, y; 1040 } display_primaries[3]; 1041 /** 1042 * @white_point: White Point of Colorspace Data. 1043 * These are coded as unsigned 16-bit values in units of 1044 * 0.00002, where 0x0000 represents zero and 0xC350 1045 * represents 1.0000. 1046 * @white_point.x: X coordinate of whitepoint of color primary. 1047 * @white_point.y: Y coordinate of whitepoint of color primary. 1048 */ 1049 struct { 1050 __u16 x, y; 1051 } white_point; 1052 /** 1053 * @max_display_mastering_luminance: Max Mastering Display Luminance. 1054 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 1055 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 1056 */ 1057 __u16 max_display_mastering_luminance; 1058 /** 1059 * @min_display_mastering_luminance: Min Mastering Display Luminance. 1060 * This value is coded as an unsigned 16-bit value in units of 1061 * 0.0001 cd/m2, where 0x0001 represents 0.0001 cd/m2 and 0xFFFF 1062 * represents 6.5535 cd/m2. 1063 */ 1064 __u16 min_display_mastering_luminance; 1065 /** 1066 * @max_cll: Max Content Light Level. 1067 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 1068 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 1069 */ 1070 __u16 max_cll; 1071 /** 1072 * @max_fall: Max Frame Average Light Level. 1073 * This value is coded as an unsigned 16-bit value in units of 1 cd/m2, 1074 * where 0x0001 represents 1 cd/m2 and 0xFFFF represents 65535 cd/m2. 1075 */ 1076 __u16 max_fall; 1077 }; 1078 1079 /** 1080 * struct hdr_output_metadata - HDR output metadata 1081 * 1082 * Metadata Information to be passed from userspace 1083 */ 1084 struct hdr_output_metadata { 1085 /** 1086 * @metadata_type: Static_Metadata_Descriptor_ID. 1087 */ 1088 __u32 metadata_type; 1089 /** 1090 * @hdmi_metadata_type1: HDR Metadata Infoframe. 1091 */ 1092 union { 1093 struct hdr_metadata_infoframe hdmi_metadata_type1; 1094 }; 1095 }; 1096 1097 /** 1098 * DRM_MODE_PAGE_FLIP_EVENT 1099 * 1100 * Request that the kernel sends back a vblank event (see 1101 * struct drm_event_vblank) with the &DRM_EVENT_FLIP_COMPLETE type when the 1102 * page-flip is done. 1103 * 1104 * When used with atomic uAPI, one event will be delivered per CRTC included in 1105 * the atomic commit. A CRTC is included in an atomic commit if one of its 1106 * properties is set, or if a property is set on a connector or plane linked 1107 * via the CRTC_ID property to the CRTC. At least one CRTC must be included, 1108 * and all pulled in CRTCs must be either previously or newly powered on (in 1109 * other words, a powered off CRTC which stays off cannot be included in the 1110 * atomic commit). 1111 */ 1112 #define DRM_MODE_PAGE_FLIP_EVENT 0x01 1113 /** 1114 * DRM_MODE_PAGE_FLIP_ASYNC 1115 * 1116 * Request that the page-flip is performed as soon as possible, ie. with no 1117 * delay due to waiting for vblank. This may cause tearing to be visible on 1118 * the screen. 1119 * 1120 * When used with atomic uAPI, the driver will return an error if the hardware 1121 * doesn't support performing an asynchronous page-flip for this update. 1122 * User-space should handle this, e.g. by falling back to a regular page-flip. 1123 * 1124 * Note, some hardware might need to perform one last synchronous page-flip 1125 * before being able to switch to asynchronous page-flips. As an exception, 1126 * the driver will return success even though that first page-flip is not 1127 * asynchronous. 1128 */ 1129 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02 1130 #define DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE 0x4 1131 #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8 1132 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \ 1133 DRM_MODE_PAGE_FLIP_TARGET_RELATIVE) 1134 /** 1135 * DRM_MODE_PAGE_FLIP_FLAGS 1136 * 1137 * Bitmask of flags suitable for &drm_mode_crtc_page_flip_target.flags. 1138 */ 1139 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT | \ 1140 DRM_MODE_PAGE_FLIP_ASYNC | \ 1141 DRM_MODE_PAGE_FLIP_TARGET) 1142 1143 /* 1144 * Request a page flip on the specified crtc. 1145 * 1146 * This ioctl will ask KMS to schedule a page flip for the specified 1147 * crtc. Once any pending rendering targeting the specified fb (as of 1148 * ioctl time) has completed, the crtc will be reprogrammed to display 1149 * that fb after the next vertical refresh. The ioctl returns 1150 * immediately, but subsequent rendering to the current fb will block 1151 * in the execbuffer ioctl until the page flip happens. If a page 1152 * flip is already pending as the ioctl is called, EBUSY will be 1153 * returned. 1154 * 1155 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank 1156 * event (see drm.h: struct drm_event_vblank) when the page flip is 1157 * done. The user_data field passed in with this ioctl will be 1158 * returned as the user_data field in the vblank event struct. 1159 * 1160 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen 1161 * 'as soon as possible', meaning that it not delay waiting for vblank. 1162 * This may cause tearing on the screen. 1163 * 1164 * The reserved field must be zero. 1165 */ 1166 1167 struct drm_mode_crtc_page_flip { 1168 __u32 crtc_id; 1169 __u32 fb_id; 1170 __u32 flags; 1171 __u32 reserved; 1172 __u64 user_data; 1173 }; 1174 1175 /* 1176 * Request a page flip on the specified crtc. 1177 * 1178 * Same as struct drm_mode_crtc_page_flip, but supports new flags and 1179 * re-purposes the reserved field: 1180 * 1181 * The sequence field must be zero unless either of the 1182 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is specified. When 1183 * the ABSOLUTE flag is specified, the sequence field denotes the absolute 1184 * vblank sequence when the flip should take effect. When the RELATIVE 1185 * flag is specified, the sequence field denotes the relative (to the 1186 * current one when the ioctl is called) vblank sequence when the flip 1187 * should take effect. NOTE: DRM_IOCTL_WAIT_VBLANK must still be used to 1188 * make sure the vblank sequence before the target one has passed before 1189 * calling this ioctl. The purpose of the 1190 * DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags is merely to clarify 1191 * the target for when code dealing with a page flip runs during a 1192 * vertical blank period. 1193 */ 1194 1195 struct drm_mode_crtc_page_flip_target { 1196 __u32 crtc_id; 1197 __u32 fb_id; 1198 __u32 flags; 1199 __u32 sequence; 1200 __u64 user_data; 1201 }; 1202 1203 /** 1204 * struct drm_mode_create_dumb - Create a KMS dumb buffer for scanout. 1205 * @height: buffer height in pixels 1206 * @width: buffer width in pixels 1207 * @bpp: color mode 1208 * @flags: must be zero 1209 * @handle: buffer object handle 1210 * @pitch: number of bytes between two consecutive lines 1211 * @size: size of the whole buffer in bytes 1212 * 1213 * User-space fills @height, @width, @bpp and @flags. If the IOCTL succeeds, 1214 * the kernel fills @handle, @pitch and @size. 1215 * 1216 * The value of @bpp is a color-mode number describing a specific format 1217 * or a variant thereof. The value often corresponds to the number of bits 1218 * per pixel for most modes, although there are exceptions. Each color mode 1219 * maps to a DRM format plus a number of modes with similar pixel layout. 1220 * Framebuffer layout is always linear. 1221 * 1222 * Support for all modes and formats is optional. Even if dumb-buffer 1223 * creation with a certain color mode succeeds, it is not guaranteed that 1224 * the DRM driver supports any of the related formats. Most drivers support 1225 * a color mode of 32 with a format of DRM_FORMAT_XRGB8888 on their primary 1226 * plane. 1227 * 1228 * +------------+------------------------+------------------------+ 1229 * | Color mode | Framebuffer format | Compatible formats | 1230 * +============+========================+========================+ 1231 * | 32 | * DRM_FORMAT_XRGB8888 | * DRM_FORMAT_BGRX8888 | 1232 * | | | * DRM_FORMAT_RGBX8888 | 1233 * | | | * DRM_FORMAT_XBGR8888 | 1234 * +------------+------------------------+------------------------+ 1235 * | 24 | * DRM_FORMAT_RGB888 | * DRM_FORMAT_BGR888 | 1236 * +------------+------------------------+------------------------+ 1237 * | 16 | * DRM_FORMAT_RGB565 | * DRM_FORMAT_BGR565 | 1238 * +------------+------------------------+------------------------+ 1239 * | 15 | * DRM_FORMAT_XRGB1555 | * DRM_FORMAT_BGRX1555 | 1240 * | | | * DRM_FORMAT_RGBX1555 | 1241 * | | | * DRM_FORMAT_XBGR1555 | 1242 * +------------+------------------------+------------------------+ 1243 * | 8 | * DRM_FORMAT_C8 | * DRM_FORMAT_D8 | 1244 * | | | * DRM_FORMAT_R8 | 1245 * +------------+------------------------+------------------------+ 1246 * | 4 | * DRM_FORMAT_C4 | * DRM_FORMAT_D4 | 1247 * | | | * DRM_FORMAT_R4 | 1248 * +------------+------------------------+------------------------+ 1249 * | 2 | * DRM_FORMAT_C2 | * DRM_FORMAT_D2 | 1250 * | | | * DRM_FORMAT_R2 | 1251 * +------------+------------------------+------------------------+ 1252 * | 1 | * DRM_FORMAT_C1 | * DRM_FORMAT_D1 | 1253 * | | | * DRM_FORMAT_R1 | 1254 * +------------+------------------------+------------------------+ 1255 * 1256 * Color modes of 10, 12, 15, 30 and 64 are only supported for use by 1257 * legacy user space. Please don't use them in new code. Other modes 1258 * are not support. 1259 * 1260 * Do not attempt to allocate anything but linear framebuffer memory 1261 * with single-plane RGB data. Allocation of other framebuffer 1262 * layouts requires dedicated ioctls in the respective DRM driver. 1263 */ 1264 struct drm_mode_create_dumb { 1265 __u32 height; 1266 __u32 width; 1267 __u32 bpp; 1268 __u32 flags; 1269 1270 __u32 handle; 1271 __u32 pitch; 1272 __u64 size; 1273 }; 1274 1275 /* set up for mmap of a dumb scanout buffer */ 1276 struct drm_mode_map_dumb { 1277 /** Handle for the object being mapped. */ 1278 __u32 handle; 1279 __u32 pad; 1280 /** 1281 * Fake offset to use for subsequent mmap call 1282 * 1283 * This is a fixed-size type for 32/64 compatibility. 1284 */ 1285 __u64 offset; 1286 }; 1287 1288 struct drm_mode_destroy_dumb { 1289 __u32 handle; 1290 }; 1291 1292 /** 1293 * DRM_MODE_ATOMIC_TEST_ONLY 1294 * 1295 * Do not apply the atomic commit, instead check whether the hardware supports 1296 * this configuration. 1297 * 1298 * See &drm_mode_config_funcs.atomic_check for more details on test-only 1299 * commits. 1300 */ 1301 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100 1302 /** 1303 * DRM_MODE_ATOMIC_NONBLOCK 1304 * 1305 * Do not block while applying the atomic commit. The &DRM_IOCTL_MODE_ATOMIC 1306 * IOCTL returns immediately instead of waiting for the changes to be applied 1307 * in hardware. Note, the driver will still check that the update can be 1308 * applied before retuning. 1309 */ 1310 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200 1311 /** 1312 * DRM_MODE_ATOMIC_ALLOW_MODESET 1313 * 1314 * Allow the update to result in temporary or transient visible artifacts while 1315 * the update is being applied. Applying the update may also take significantly 1316 * more time than a page flip. All visual artifacts will disappear by the time 1317 * the update is completed, as signalled through the vblank event's timestamp 1318 * (see struct drm_event_vblank). 1319 * 1320 * This flag must be set when the KMS update might cause visible artifacts. 1321 * Without this flag such KMS update will return a EINVAL error. What kind of 1322 * update may cause visible artifacts depends on the driver and the hardware. 1323 * User-space that needs to know beforehand if an update might cause visible 1324 * artifacts can use &DRM_MODE_ATOMIC_TEST_ONLY without 1325 * &DRM_MODE_ATOMIC_ALLOW_MODESET to see if it fails. 1326 * 1327 * To the best of the driver's knowledge, visual artifacts are guaranteed to 1328 * not appear when this flag is not set. Some sinks might display visual 1329 * artifacts outside of the driver's control. 1330 */ 1331 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400 1332 1333 /** 1334 * DRM_MODE_ATOMIC_FLAGS 1335 * 1336 * Bitfield of flags accepted by the &DRM_IOCTL_MODE_ATOMIC IOCTL in 1337 * &drm_mode_atomic.flags. 1338 */ 1339 #define DRM_MODE_ATOMIC_FLAGS (\ 1340 DRM_MODE_PAGE_FLIP_EVENT |\ 1341 DRM_MODE_PAGE_FLIP_ASYNC |\ 1342 DRM_MODE_ATOMIC_TEST_ONLY |\ 1343 DRM_MODE_ATOMIC_NONBLOCK |\ 1344 DRM_MODE_ATOMIC_ALLOW_MODESET) 1345 1346 struct drm_mode_atomic { 1347 __u32 flags; 1348 __u32 count_objs; 1349 __u64 objs_ptr; 1350 __u64 count_props_ptr; 1351 __u64 props_ptr; 1352 __u64 prop_values_ptr; 1353 __u64 reserved; 1354 __u64 user_data; 1355 }; 1356 1357 struct drm_format_modifier_blob { 1358 #define FORMAT_BLOB_CURRENT 1 1359 /* Version of this blob format */ 1360 __u32 version; 1361 1362 /* Flags */ 1363 __u32 flags; 1364 1365 /* Number of fourcc formats supported */ 1366 __u32 count_formats; 1367 1368 /* Where in this blob the formats exist (in bytes) */ 1369 __u32 formats_offset; 1370 1371 /* Number of drm_format_modifiers */ 1372 __u32 count_modifiers; 1373 1374 /* Where in this blob the modifiers exist (in bytes) */ 1375 __u32 modifiers_offset; 1376 1377 /* __u32 formats[] */ 1378 /* struct drm_format_modifier modifiers[] */ 1379 }; 1380 1381 struct drm_format_modifier { 1382 /* Bitmask of formats in get_plane format list this info applies to. The 1383 * offset allows a sliding window of which 64 formats (bits). 1384 * 1385 * Some examples: 1386 * In today's world with < 65 formats, and formats 0, and 2 are 1387 * supported 1388 * 0x0000000000000005 1389 * ^-offset = 0, formats = 5 1390 * 1391 * If the number formats grew to 128, and formats 98-102 are 1392 * supported with the modifier: 1393 * 1394 * 0x0000007c00000000 0000000000000000 1395 * ^ 1396 * |__offset = 64, formats = 0x7c00000000 1397 * 1398 */ 1399 __u64 formats; 1400 __u32 offset; 1401 __u32 pad; 1402 1403 /* The modifier that applies to the >get_plane format list bitmask. */ 1404 __u64 modifier; 1405 }; 1406 1407 /** 1408 * struct drm_mode_create_blob - Create New blob property 1409 * 1410 * Create a new 'blob' data property, copying length bytes from data pointer, 1411 * and returning new blob ID. 1412 */ 1413 struct drm_mode_create_blob { 1414 /** @data: Pointer to data to copy. */ 1415 __u64 data; 1416 /** @length: Length of data to copy. */ 1417 __u32 length; 1418 /** @blob_id: Return: new property ID. */ 1419 __u32 blob_id; 1420 }; 1421 1422 /** 1423 * struct drm_mode_destroy_blob - Destroy user blob 1424 * @blob_id: blob_id to destroy 1425 * 1426 * Destroy a user-created blob property. 1427 * 1428 * User-space can release blobs as soon as they do not need to refer to them by 1429 * their blob object ID. For instance, if you are using a MODE_ID blob in an 1430 * atomic commit and you will not make another commit re-using the same ID, you 1431 * can destroy the blob as soon as the commit has been issued, without waiting 1432 * for it to complete. 1433 */ 1434 struct drm_mode_destroy_blob { 1435 __u32 blob_id; 1436 }; 1437 1438 /** 1439 * struct drm_mode_create_lease - Create lease 1440 * 1441 * Lease mode resources, creating another drm_master. 1442 * 1443 * The @object_ids array must reference at least one CRTC, one connector and 1444 * one plane if &DRM_CLIENT_CAP_UNIVERSAL_PLANES is enabled. Alternatively, 1445 * the lease can be completely empty. 1446 */ 1447 struct drm_mode_create_lease { 1448 /** @object_ids: Pointer to array of object ids (__u32) */ 1449 __u64 object_ids; 1450 /** @object_count: Number of object ids */ 1451 __u32 object_count; 1452 /** @flags: flags for new FD (O_CLOEXEC, etc) */ 1453 __u32 flags; 1454 1455 /** @lessee_id: Return: unique identifier for lessee. */ 1456 __u32 lessee_id; 1457 /** @fd: Return: file descriptor to new drm_master file */ 1458 __u32 fd; 1459 }; 1460 1461 /** 1462 * struct drm_mode_list_lessees - List lessees 1463 * 1464 * List lesses from a drm_master. 1465 */ 1466 struct drm_mode_list_lessees { 1467 /** 1468 * @count_lessees: Number of lessees. 1469 * 1470 * On input, provides length of the array. 1471 * On output, provides total number. No 1472 * more than the input number will be written 1473 * back, so two calls can be used to get 1474 * the size and then the data. 1475 */ 1476 __u32 count_lessees; 1477 /** @pad: Padding. */ 1478 __u32 pad; 1479 1480 /** 1481 * @lessees_ptr: Pointer to lessees. 1482 * 1483 * Pointer to __u64 array of lessee ids 1484 */ 1485 __u64 lessees_ptr; 1486 }; 1487 1488 /** 1489 * struct drm_mode_get_lease - Get Lease 1490 * 1491 * Get leased objects. 1492 */ 1493 struct drm_mode_get_lease { 1494 /** 1495 * @count_objects: Number of leased objects. 1496 * 1497 * On input, provides length of the array. 1498 * On output, provides total number. No 1499 * more than the input number will be written 1500 * back, so two calls can be used to get 1501 * the size and then the data. 1502 */ 1503 __u32 count_objects; 1504 /** @pad: Padding. */ 1505 __u32 pad; 1506 1507 /** 1508 * @objects_ptr: Pointer to objects. 1509 * 1510 * Pointer to __u32 array of object ids. 1511 */ 1512 __u64 objects_ptr; 1513 }; 1514 1515 /** 1516 * struct drm_mode_revoke_lease - Revoke lease 1517 */ 1518 struct drm_mode_revoke_lease { 1519 /** @lessee_id: Unique ID of lessee */ 1520 __u32 lessee_id; 1521 }; 1522 1523 /** 1524 * struct drm_mode_rect - Two dimensional rectangle. 1525 * @x1: Horizontal starting coordinate (inclusive). 1526 * @y1: Vertical starting coordinate (inclusive). 1527 * @x2: Horizontal ending coordinate (exclusive). 1528 * @y2: Vertical ending coordinate (exclusive). 1529 * 1530 * With drm subsystem using struct drm_rect to manage rectangular area this 1531 * export it to user-space. 1532 * 1533 * Currently used by drm_mode_atomic blob property FB_DAMAGE_CLIPS. 1534 */ 1535 struct drm_mode_rect { 1536 __s32 x1; 1537 __s32 y1; 1538 __s32 x2; 1539 __s32 y2; 1540 }; 1541 1542 /** 1543 * struct drm_mode_closefb 1544 * @fb_id: Framebuffer ID. 1545 * @pad: Must be zero. 1546 */ 1547 struct drm_mode_closefb { 1548 __u32 fb_id; 1549 __u32 pad; 1550 }; 1551 1552 #if defined(__cplusplus) 1553 } 1554 #endif 1555 1556 #endif 1557