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 #define DRM_DISPLAY_INFO_LEN 32 33 #define DRM_CONNECTOR_NAME_LEN 32 34 #define DRM_DISPLAY_MODE_LEN 32 35 #define DRM_PROP_NAME_LEN 32 36 37 #define DRM_MODE_TYPE_BUILTIN (1<<0) 38 #define DRM_MODE_TYPE_CLOCK_C ((1<<1) | DRM_MODE_TYPE_BUILTIN) 39 #define DRM_MODE_TYPE_CRTC_C ((1<<2) | DRM_MODE_TYPE_BUILTIN) 40 #define DRM_MODE_TYPE_PREFERRED (1<<3) 41 #define DRM_MODE_TYPE_DEFAULT (1<<4) 42 #define DRM_MODE_TYPE_USERDEF (1<<5) 43 #define DRM_MODE_TYPE_DRIVER (1<<6) 44 45 /* Video mode flags */ 46 /* bit compatible with the xorg definitions. */ 47 #define DRM_MODE_FLAG_PHSYNC (1<<0) 48 #define DRM_MODE_FLAG_NHSYNC (1<<1) 49 #define DRM_MODE_FLAG_PVSYNC (1<<2) 50 #define DRM_MODE_FLAG_NVSYNC (1<<3) 51 #define DRM_MODE_FLAG_INTERLACE (1<<4) 52 #define DRM_MODE_FLAG_DBLSCAN (1<<5) 53 #define DRM_MODE_FLAG_CSYNC (1<<6) 54 #define DRM_MODE_FLAG_PCSYNC (1<<7) 55 #define DRM_MODE_FLAG_NCSYNC (1<<8) 56 #define DRM_MODE_FLAG_HSKEW (1<<9) /* hskew provided */ 57 #define DRM_MODE_FLAG_BCAST (1<<10) 58 #define DRM_MODE_FLAG_PIXMUX (1<<11) 59 #define DRM_MODE_FLAG_DBLCLK (1<<12) 60 #define DRM_MODE_FLAG_CLKDIV2 (1<<13) 61 /* 62 * When adding a new stereo mode don't forget to adjust DRM_MODE_FLAGS_3D_MAX 63 * (define not exposed to user space). 64 */ 65 #define DRM_MODE_FLAG_3D_MASK (0x1f<<14) 66 #define DRM_MODE_FLAG_3D_NONE (0<<14) 67 #define DRM_MODE_FLAG_3D_FRAME_PACKING (1<<14) 68 #define DRM_MODE_FLAG_3D_FIELD_ALTERNATIVE (2<<14) 69 #define DRM_MODE_FLAG_3D_LINE_ALTERNATIVE (3<<14) 70 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_FULL (4<<14) 71 #define DRM_MODE_FLAG_3D_L_DEPTH (5<<14) 72 #define DRM_MODE_FLAG_3D_L_DEPTH_GFX_GFX_DEPTH (6<<14) 73 #define DRM_MODE_FLAG_3D_TOP_AND_BOTTOM (7<<14) 74 #define DRM_MODE_FLAG_3D_SIDE_BY_SIDE_HALF (8<<14) 75 76 77 /* DPMS flags */ 78 /* bit compatible with the xorg definitions. */ 79 #define DRM_MODE_DPMS_ON 0 80 #define DRM_MODE_DPMS_STANDBY 1 81 #define DRM_MODE_DPMS_SUSPEND 2 82 #define DRM_MODE_DPMS_OFF 3 83 84 /* Scaling mode options */ 85 #define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or 86 software can still scale) */ 87 #define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */ 88 #define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */ 89 #define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */ 90 91 /* Picture aspect ratio options */ 92 #define DRM_MODE_PICTURE_ASPECT_NONE 0 93 #define DRM_MODE_PICTURE_ASPECT_4_3 1 94 #define DRM_MODE_PICTURE_ASPECT_16_9 2 95 96 /* Dithering mode options */ 97 #define DRM_MODE_DITHERING_OFF 0 98 #define DRM_MODE_DITHERING_ON 1 99 #define DRM_MODE_DITHERING_AUTO 2 100 101 /* Dirty info options */ 102 #define DRM_MODE_DIRTY_OFF 0 103 #define DRM_MODE_DIRTY_ON 1 104 #define DRM_MODE_DIRTY_ANNOTATE 2 105 106 struct drm_mode_modeinfo { 107 __u32 clock; 108 __u16 hdisplay; 109 __u16 hsync_start; 110 __u16 hsync_end; 111 __u16 htotal; 112 __u16 hskew; 113 __u16 vdisplay; 114 __u16 vsync_start; 115 __u16 vsync_end; 116 __u16 vtotal; 117 __u16 vscan; 118 119 __u32 vrefresh; 120 121 __u32 flags; 122 __u32 type; 123 char name[DRM_DISPLAY_MODE_LEN]; 124 }; 125 126 struct drm_mode_card_res { 127 __u64 fb_id_ptr; 128 __u64 crtc_id_ptr; 129 __u64 connector_id_ptr; 130 __u64 encoder_id_ptr; 131 __u32 count_fbs; 132 __u32 count_crtcs; 133 __u32 count_connectors; 134 __u32 count_encoders; 135 __u32 min_width; 136 __u32 max_width; 137 __u32 min_height; 138 __u32 max_height; 139 }; 140 141 struct drm_mode_crtc { 142 __u64 set_connectors_ptr; 143 __u32 count_connectors; 144 145 __u32 crtc_id; /**< Id */ 146 __u32 fb_id; /**< Id of framebuffer */ 147 148 __u32 x; /**< x Position on the framebuffer */ 149 __u32 y; /**< y Position on the framebuffer */ 150 151 __u32 gamma_size; 152 __u32 mode_valid; 153 struct drm_mode_modeinfo mode; 154 }; 155 156 #define DRM_MODE_PRESENT_TOP_FIELD (1<<0) 157 #define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1) 158 159 /* Planes blend with or override other bits on the CRTC */ 160 struct drm_mode_set_plane { 161 __u32 plane_id; 162 __u32 crtc_id; 163 __u32 fb_id; /* fb object contains surface format type */ 164 __u32 flags; /* see above flags */ 165 166 /* Signed dest location allows it to be partially off screen */ 167 __s32 crtc_x; 168 __s32 crtc_y; 169 __u32 crtc_w; 170 __u32 crtc_h; 171 172 /* Source values are 16.16 fixed point */ 173 __u32 src_x; 174 __u32 src_y; 175 __u32 src_h; 176 __u32 src_w; 177 }; 178 179 struct drm_mode_get_plane { 180 __u32 plane_id; 181 182 __u32 crtc_id; 183 __u32 fb_id; 184 185 __u32 possible_crtcs; 186 __u32 gamma_size; 187 188 __u32 count_format_types; 189 __u64 format_type_ptr; 190 }; 191 192 struct drm_mode_get_plane_res { 193 __u64 plane_id_ptr; 194 __u32 count_planes; 195 }; 196 197 #define DRM_MODE_ENCODER_NONE 0 198 #define DRM_MODE_ENCODER_DAC 1 199 #define DRM_MODE_ENCODER_TMDS 2 200 #define DRM_MODE_ENCODER_LVDS 3 201 #define DRM_MODE_ENCODER_TVDAC 4 202 #define DRM_MODE_ENCODER_VIRTUAL 5 203 #define DRM_MODE_ENCODER_DSI 6 204 #define DRM_MODE_ENCODER_DPMST 7 205 #define DRM_MODE_ENCODER_DPI 8 206 207 struct drm_mode_get_encoder { 208 __u32 encoder_id; 209 __u32 encoder_type; 210 211 __u32 crtc_id; /**< Id of crtc */ 212 213 __u32 possible_crtcs; 214 __u32 possible_clones; 215 }; 216 217 /* This is for connectors with multiple signal types. */ 218 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */ 219 #define DRM_MODE_SUBCONNECTOR_Automatic 0 220 #define DRM_MODE_SUBCONNECTOR_Unknown 0 221 #define DRM_MODE_SUBCONNECTOR_DVID 3 222 #define DRM_MODE_SUBCONNECTOR_DVIA 4 223 #define DRM_MODE_SUBCONNECTOR_Composite 5 224 #define DRM_MODE_SUBCONNECTOR_SVIDEO 6 225 #define DRM_MODE_SUBCONNECTOR_Component 8 226 #define DRM_MODE_SUBCONNECTOR_SCART 9 227 228 #define DRM_MODE_CONNECTOR_Unknown 0 229 #define DRM_MODE_CONNECTOR_VGA 1 230 #define DRM_MODE_CONNECTOR_DVII 2 231 #define DRM_MODE_CONNECTOR_DVID 3 232 #define DRM_MODE_CONNECTOR_DVIA 4 233 #define DRM_MODE_CONNECTOR_Composite 5 234 #define DRM_MODE_CONNECTOR_SVIDEO 6 235 #define DRM_MODE_CONNECTOR_LVDS 7 236 #define DRM_MODE_CONNECTOR_Component 8 237 #define DRM_MODE_CONNECTOR_9PinDIN 9 238 #define DRM_MODE_CONNECTOR_DisplayPort 10 239 #define DRM_MODE_CONNECTOR_HDMIA 11 240 #define DRM_MODE_CONNECTOR_HDMIB 12 241 #define DRM_MODE_CONNECTOR_TV 13 242 #define DRM_MODE_CONNECTOR_eDP 14 243 #define DRM_MODE_CONNECTOR_VIRTUAL 15 244 #define DRM_MODE_CONNECTOR_DSI 16 245 #define DRM_MODE_CONNECTOR_DPI 17 246 247 struct drm_mode_get_connector { 248 249 __u64 encoders_ptr; 250 __u64 modes_ptr; 251 __u64 props_ptr; 252 __u64 prop_values_ptr; 253 254 __u32 count_modes; 255 __u32 count_props; 256 __u32 count_encoders; 257 258 __u32 encoder_id; /**< Current Encoder */ 259 __u32 connector_id; /**< Id */ 260 __u32 connector_type; 261 __u32 connector_type_id; 262 263 __u32 connection; 264 __u32 mm_width; /**< width in millimeters */ 265 __u32 mm_height; /**< height in millimeters */ 266 __u32 subpixel; 267 268 __u32 pad; 269 }; 270 271 #define DRM_MODE_PROP_PENDING (1<<0) 272 #define DRM_MODE_PROP_RANGE (1<<1) 273 #define DRM_MODE_PROP_IMMUTABLE (1<<2) 274 #define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */ 275 #define DRM_MODE_PROP_BLOB (1<<4) 276 #define DRM_MODE_PROP_BITMASK (1<<5) /* bitmask of enumerated types */ 277 278 /* non-extended types: legacy bitmask, one bit per type: */ 279 #define DRM_MODE_PROP_LEGACY_TYPE ( \ 280 DRM_MODE_PROP_RANGE | \ 281 DRM_MODE_PROP_ENUM | \ 282 DRM_MODE_PROP_BLOB | \ 283 DRM_MODE_PROP_BITMASK) 284 285 /* extended-types: rather than continue to consume a bit per type, 286 * grab a chunk of the bits to use as integer type id. 287 */ 288 #define DRM_MODE_PROP_EXTENDED_TYPE 0x0000ffc0 289 #define DRM_MODE_PROP_TYPE(n) ((n) << 6) 290 #define DRM_MODE_PROP_OBJECT DRM_MODE_PROP_TYPE(1) 291 #define DRM_MODE_PROP_SIGNED_RANGE DRM_MODE_PROP_TYPE(2) 292 293 /* the PROP_ATOMIC flag is used to hide properties from userspace that 294 * is not aware of atomic properties. This is mostly to work around 295 * older userspace (DDX drivers) that read/write each prop they find, 296 * witout being aware that this could be triggering a lengthy modeset. 297 */ 298 #define DRM_MODE_PROP_ATOMIC 0x80000000 299 300 struct drm_mode_property_enum { 301 __u64 value; 302 char name[DRM_PROP_NAME_LEN]; 303 }; 304 305 struct drm_mode_get_property { 306 __u64 values_ptr; /* values and blob lengths */ 307 __u64 enum_blob_ptr; /* enum and blob id ptrs */ 308 309 __u32 prop_id; 310 __u32 flags; 311 char name[DRM_PROP_NAME_LEN]; 312 313 __u32 count_values; 314 /* This is only used to count enum values, not blobs. The _blobs is 315 * simply because of a historical reason, i.e. backwards compat. */ 316 __u32 count_enum_blobs; 317 }; 318 319 struct drm_mode_connector_set_property { 320 __u64 value; 321 __u32 prop_id; 322 __u32 connector_id; 323 }; 324 325 struct drm_mode_obj_get_properties { 326 __u64 props_ptr; 327 __u64 prop_values_ptr; 328 __u32 count_props; 329 __u32 obj_id; 330 __u32 obj_type; 331 }; 332 333 struct drm_mode_obj_set_property { 334 __u64 value; 335 __u32 prop_id; 336 __u32 obj_id; 337 __u32 obj_type; 338 }; 339 340 struct drm_mode_get_blob { 341 __u32 blob_id; 342 __u32 length; 343 __u64 data; 344 }; 345 346 struct drm_mode_fb_cmd { 347 __u32 fb_id; 348 __u32 width; 349 __u32 height; 350 __u32 pitch; 351 __u32 bpp; 352 __u32 depth; 353 /* driver specific handle */ 354 __u32 handle; 355 }; 356 357 #define DRM_MODE_FB_INTERLACED (1<<0) /* for interlaced framebuffers */ 358 #define DRM_MODE_FB_MODIFIERS (1<<1) /* enables ->modifer[] */ 359 360 struct drm_mode_fb_cmd2 { 361 __u32 fb_id; 362 __u32 width; 363 __u32 height; 364 __u32 pixel_format; /* fourcc code from drm_fourcc.h */ 365 __u32 flags; /* see above flags */ 366 367 /* 368 * In case of planar formats, this ioctl allows up to 4 369 * buffer objects with offsets and pitches per plane. 370 * The pitch and offset order is dictated by the fourcc, 371 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as: 372 * 373 * YUV 4:2:0 image with a plane of 8 bit Y samples 374 * followed by an interleaved U/V plane containing 375 * 8 bit 2x2 subsampled colour difference samples. 376 * 377 * So it would consist of Y as offsets[0] and UV as 378 * offsets[1]. Note that offsets[0] will generally 379 * be 0 (but this is not required). 380 * 381 * To accommodate tiled, compressed, etc formats, a per-plane 382 * modifier can be specified. The default value of zero 383 * indicates "native" format as specified by the fourcc. 384 * Vendor specific modifier token. This allows, for example, 385 * different tiling/swizzling pattern on different planes. 386 * See discussion above of DRM_FORMAT_MOD_xxx. 387 */ 388 __u32 handles[4]; 389 __u32 pitches[4]; /* pitch for each plane */ 390 __u32 offsets[4]; /* offset of each plane */ 391 __u64 modifier[4]; /* ie, tiling, compressed (per plane) */ 392 }; 393 394 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01 395 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02 396 #define DRM_MODE_FB_DIRTY_FLAGS 0x03 397 398 #define DRM_MODE_FB_DIRTY_MAX_CLIPS 256 399 400 /* 401 * Mark a region of a framebuffer as dirty. 402 * 403 * Some hardware does not automatically update display contents 404 * as a hardware or software draw to a framebuffer. This ioctl 405 * allows userspace to tell the kernel and the hardware what 406 * regions of the framebuffer have changed. 407 * 408 * The kernel or hardware is free to update more then just the 409 * region specified by the clip rects. The kernel or hardware 410 * may also delay and/or coalesce several calls to dirty into a 411 * single update. 412 * 413 * Userspace may annotate the updates, the annotates are a 414 * promise made by the caller that the change is either a copy 415 * of pixels or a fill of a single color in the region specified. 416 * 417 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then 418 * the number of updated regions are half of num_clips given, 419 * where the clip rects are paired in src and dst. The width and 420 * height of each one of the pairs must match. 421 * 422 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller 423 * promises that the region specified of the clip rects is filled 424 * completely with a single color as given in the color argument. 425 */ 426 427 struct drm_mode_fb_dirty_cmd { 428 __u32 fb_id; 429 __u32 flags; 430 __u32 color; 431 __u32 num_clips; 432 __u64 clips_ptr; 433 }; 434 435 struct drm_mode_mode_cmd { 436 __u32 connector_id; 437 struct drm_mode_modeinfo mode; 438 }; 439 440 #define DRM_MODE_CURSOR_BO 0x01 441 #define DRM_MODE_CURSOR_MOVE 0x02 442 #define DRM_MODE_CURSOR_FLAGS 0x03 443 444 /* 445 * depending on the value in flags different members are used. 446 * 447 * CURSOR_BO uses 448 * crtc_id 449 * width 450 * height 451 * handle - if 0 turns the cursor off 452 * 453 * CURSOR_MOVE uses 454 * crtc_id 455 * x 456 * y 457 */ 458 struct drm_mode_cursor { 459 __u32 flags; 460 __u32 crtc_id; 461 __s32 x; 462 __s32 y; 463 __u32 width; 464 __u32 height; 465 /* driver specific handle */ 466 __u32 handle; 467 }; 468 469 struct drm_mode_cursor2 { 470 __u32 flags; 471 __u32 crtc_id; 472 __s32 x; 473 __s32 y; 474 __u32 width; 475 __u32 height; 476 /* driver specific handle */ 477 __u32 handle; 478 __s32 hot_x; 479 __s32 hot_y; 480 }; 481 482 struct drm_mode_crtc_lut { 483 __u32 crtc_id; 484 __u32 gamma_size; 485 486 /* pointers to arrays */ 487 __u64 red; 488 __u64 green; 489 __u64 blue; 490 }; 491 492 struct drm_color_ctm { 493 /* Conversion matrix in S31.32 format. */ 494 __s64 matrix[9]; 495 }; 496 497 struct drm_color_lut { 498 /* 499 * Data is U0.16 fixed point format. 500 */ 501 __u16 red; 502 __u16 green; 503 __u16 blue; 504 __u16 reserved; 505 }; 506 507 #define DRM_MODE_PAGE_FLIP_EVENT 0x01 508 #define DRM_MODE_PAGE_FLIP_ASYNC 0x02 509 #define DRM_MODE_PAGE_FLIP_FLAGS (DRM_MODE_PAGE_FLIP_EVENT|DRM_MODE_PAGE_FLIP_ASYNC) 510 511 /* 512 * Request a page flip on the specified crtc. 513 * 514 * This ioctl will ask KMS to schedule a page flip for the specified 515 * crtc. Once any pending rendering targeting the specified fb (as of 516 * ioctl time) has completed, the crtc will be reprogrammed to display 517 * that fb after the next vertical refresh. The ioctl returns 518 * immediately, but subsequent rendering to the current fb will block 519 * in the execbuffer ioctl until the page flip happens. If a page 520 * flip is already pending as the ioctl is called, EBUSY will be 521 * returned. 522 * 523 * Flag DRM_MODE_PAGE_FLIP_EVENT requests that drm sends back a vblank 524 * event (see drm.h: struct drm_event_vblank) when the page flip is 525 * done. The user_data field passed in with this ioctl will be 526 * returned as the user_data field in the vblank event struct. 527 * 528 * Flag DRM_MODE_PAGE_FLIP_ASYNC requests that the flip happen 529 * 'as soon as possible', meaning that it not delay waiting for vblank. 530 * This may cause tearing on the screen. 531 * 532 * The reserved field must be zero until we figure out something 533 * clever to use it for. 534 */ 535 536 struct drm_mode_crtc_page_flip { 537 __u32 crtc_id; 538 __u32 fb_id; 539 __u32 flags; 540 __u32 reserved; 541 __u64 user_data; 542 }; 543 544 /* create a dumb scanout buffer */ 545 struct drm_mode_create_dumb { 546 __u32 height; 547 __u32 width; 548 __u32 bpp; 549 __u32 flags; 550 /* handle, pitch, size will be returned */ 551 __u32 handle; 552 __u32 pitch; 553 __u64 size; 554 }; 555 556 /* set up for mmap of a dumb scanout buffer */ 557 struct drm_mode_map_dumb { 558 /** Handle for the object being mapped. */ 559 __u32 handle; 560 __u32 pad; 561 /** 562 * Fake offset to use for subsequent mmap call 563 * 564 * This is a fixed-size type for 32/64 compatibility. 565 */ 566 __u64 offset; 567 }; 568 569 struct drm_mode_destroy_dumb { 570 __u32 handle; 571 }; 572 573 /* page-flip flags are valid, plus: */ 574 #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100 575 #define DRM_MODE_ATOMIC_NONBLOCK 0x0200 576 #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400 577 578 #define DRM_MODE_ATOMIC_FLAGS (\ 579 DRM_MODE_PAGE_FLIP_EVENT |\ 580 DRM_MODE_PAGE_FLIP_ASYNC |\ 581 DRM_MODE_ATOMIC_TEST_ONLY |\ 582 DRM_MODE_ATOMIC_NONBLOCK |\ 583 DRM_MODE_ATOMIC_ALLOW_MODESET) 584 585 struct drm_mode_atomic { 586 __u32 flags; 587 __u32 count_objs; 588 __u64 objs_ptr; 589 __u64 count_props_ptr; 590 __u64 props_ptr; 591 __u64 prop_values_ptr; 592 __u64 reserved; 593 __u64 user_data; 594 }; 595 596 /** 597 * Create a new 'blob' data property, copying length bytes from data pointer, 598 * and returning new blob ID. 599 */ 600 struct drm_mode_create_blob { 601 /** Pointer to data to copy. */ 602 __u64 data; 603 /** Length of data to copy. */ 604 __u32 length; 605 /** Return: new property ID. */ 606 __u32 blob_id; 607 }; 608 609 /** 610 * Destroy a user-created blob property. 611 */ 612 struct drm_mode_destroy_blob { 613 __u32 blob_id; 614 }; 615 616 #endif 617