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 * $FreeBSD$ 27 */ 28 29#ifndef _DRM_MODE_H 30#define _DRM_MODE_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/* DPMS flags */ 63/* bit compatible with the xorg definitions. */ 64#define DRM_MODE_DPMS_ON 0 65#define DRM_MODE_DPMS_STANDBY 1 66#define DRM_MODE_DPMS_SUSPEND 2 67#define DRM_MODE_DPMS_OFF 3 68 69/* Scaling mode options */ 70#define DRM_MODE_SCALE_NONE 0 /* Unmodified timing (display or 71 software can still scale) */ 72#define DRM_MODE_SCALE_FULLSCREEN 1 /* Full screen, ignore aspect */ 73#define DRM_MODE_SCALE_CENTER 2 /* Centered, no scaling */ 74#define DRM_MODE_SCALE_ASPECT 3 /* Full screen, preserve aspect */ 75 76/* Dithering mode options */ 77#define DRM_MODE_DITHERING_OFF 0 78#define DRM_MODE_DITHERING_ON 1 79#define DRM_MODE_DITHERING_AUTO 2 80 81/* Dirty info options */ 82#define DRM_MODE_DIRTY_OFF 0 83#define DRM_MODE_DIRTY_ON 1 84#define DRM_MODE_DIRTY_ANNOTATE 2 85 86struct drm_mode_modeinfo { 87 uint32_t clock; 88 uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew; 89 uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan; 90 91 uint32_t vrefresh; 92 93 uint32_t flags; 94 uint32_t type; 95 char name[DRM_DISPLAY_MODE_LEN]; 96}; 97 98struct drm_mode_card_res { 99 uint64_t fb_id_ptr; 100 uint64_t crtc_id_ptr; 101 uint64_t connector_id_ptr; 102 uint64_t encoder_id_ptr; 103 uint32_t count_fbs; 104 uint32_t count_crtcs; 105 uint32_t count_connectors; 106 uint32_t count_encoders; 107 uint32_t min_width, max_width; 108 uint32_t min_height, max_height; 109}; 110 111struct drm_mode_crtc { 112 uint64_t set_connectors_ptr; 113 uint32_t count_connectors; 114 115 uint32_t crtc_id; /**< Id */ 116 uint32_t fb_id; /**< Id of framebuffer */ 117 118 uint32_t x, y; /**< Position on the frameuffer */ 119 120 uint32_t gamma_size; 121 uint32_t mode_valid; 122 struct drm_mode_modeinfo mode; 123}; 124 125#define DRM_MODE_PRESENT_TOP_FIELD (1<<0) 126#define DRM_MODE_PRESENT_BOTTOM_FIELD (1<<1) 127 128/* Planes blend with or override other bits on the CRTC */ 129struct drm_mode_set_plane { 130 uint32_t plane_id; 131 uint32_t crtc_id; 132 uint32_t fb_id; /* fb object contains surface format type */ 133 uint32_t flags; /* see above flags */ 134 135 /* Signed dest location allows it to be partially off screen */ 136 int32_t crtc_x, crtc_y; 137 uint32_t crtc_w, crtc_h; 138 139 /* Source values are 16.16 fixed point */ 140 uint32_t src_x, src_y; 141 uint32_t src_h, src_w; 142}; 143 144struct drm_mode_get_plane { 145 uint32_t plane_id; 146 147 uint32_t crtc_id; 148 uint32_t fb_id; 149 150 uint32_t possible_crtcs; 151 uint32_t gamma_size; 152 153 uint32_t count_format_types; 154 uint64_t format_type_ptr; 155}; 156 157struct drm_mode_get_plane_res { 158 uint64_t plane_id_ptr; 159 uint32_t count_planes; 160}; 161 162#define DRM_MODE_ENCODER_NONE 0 163#define DRM_MODE_ENCODER_DAC 1 164#define DRM_MODE_ENCODER_TMDS 2 165#define DRM_MODE_ENCODER_LVDS 3 166#define DRM_MODE_ENCODER_TVDAC 4 167 168struct drm_mode_get_encoder { 169 uint32_t encoder_id; 170 uint32_t encoder_type; 171 172 uint32_t crtc_id; /**< Id of crtc */ 173 174 uint32_t possible_crtcs; 175 uint32_t possible_clones; 176}; 177 178/* This is for connectors with multiple signal types. */ 179/* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */ 180#define DRM_MODE_SUBCONNECTOR_Automatic 0 181#define DRM_MODE_SUBCONNECTOR_Unknown 0 182#define DRM_MODE_SUBCONNECTOR_DVID 3 183#define DRM_MODE_SUBCONNECTOR_DVIA 4 184#define DRM_MODE_SUBCONNECTOR_Composite 5 185#define DRM_MODE_SUBCONNECTOR_SVIDEO 6 186#define DRM_MODE_SUBCONNECTOR_Component 8 187#define DRM_MODE_SUBCONNECTOR_SCART 9 188 189#define DRM_MODE_CONNECTOR_Unknown 0 190#define DRM_MODE_CONNECTOR_VGA 1 191#define DRM_MODE_CONNECTOR_DVII 2 192#define DRM_MODE_CONNECTOR_DVID 3 193#define DRM_MODE_CONNECTOR_DVIA 4 194#define DRM_MODE_CONNECTOR_Composite 5 195#define DRM_MODE_CONNECTOR_SVIDEO 6 196#define DRM_MODE_CONNECTOR_LVDS 7 197#define DRM_MODE_CONNECTOR_Component 8 198#define DRM_MODE_CONNECTOR_9PinDIN 9 199#define DRM_MODE_CONNECTOR_DisplayPort 10 200#define DRM_MODE_CONNECTOR_HDMIA 11 201#define DRM_MODE_CONNECTOR_HDMIB 12 202#define DRM_MODE_CONNECTOR_TV 13 203#define DRM_MODE_CONNECTOR_eDP 14 204 205struct drm_mode_get_connector { 206 207 uint64_t encoders_ptr; 208 uint64_t modes_ptr; 209 uint64_t props_ptr; 210 uint64_t prop_values_ptr; 211 212 uint32_t count_modes; 213 uint32_t count_props; 214 uint32_t count_encoders; 215 216 uint32_t encoder_id; /**< Current Encoder */ 217 uint32_t connector_id; /**< Id */ 218 uint32_t connector_type; 219 uint32_t connector_type_id; 220 221 uint32_t connection; 222 uint32_t mm_width, mm_height; /**< HxW in millimeters */ 223 uint32_t subpixel; 224}; 225 226#define DRM_MODE_PROP_PENDING (1<<0) 227#define DRM_MODE_PROP_RANGE (1<<1) 228#define DRM_MODE_PROP_IMMUTABLE (1<<2) 229#define DRM_MODE_PROP_ENUM (1<<3) /* enumerated type with text strings */ 230#define DRM_MODE_PROP_BLOB (1<<4) 231 232struct drm_mode_property_enum { 233 uint64_t value; 234 char name[DRM_PROP_NAME_LEN]; 235}; 236 237struct drm_mode_get_property { 238 uint64_t values_ptr; /* values and blob lengths */ 239 uint64_t enum_blob_ptr; /* enum and blob id ptrs */ 240 241 uint32_t prop_id; 242 uint32_t flags; 243 char name[DRM_PROP_NAME_LEN]; 244 245 uint32_t count_values; 246 uint32_t count_enum_blobs; 247}; 248 249struct drm_mode_connector_set_property { 250 uint64_t value; 251 uint32_t prop_id; 252 uint32_t connector_id; 253}; 254 255struct drm_mode_get_blob { 256 uint32_t blob_id; 257 uint32_t length; 258 uint64_t data; 259}; 260 261struct drm_mode_fb_cmd { 262 uint32_t fb_id; 263 uint32_t width, height; 264 uint32_t pitch; 265 uint32_t bpp; 266 uint32_t depth; 267 /* driver specific handle */ 268 uint32_t handle; 269}; 270 271#define DRM_MODE_FB_INTERLACED (1<<0 /* for interlaced framebuffers */ 272 273struct drm_mode_fb_cmd2 { 274 uint32_t fb_id; 275 uint32_t width, height; 276 uint32_t pixel_format; /* fourcc code from drm_fourcc.h */ 277 uint32_t flags; /* see above flags */ 278 279 /* 280 * In case of planar formats, this ioctl allows up to 4 281 * buffer objects with offets and pitches per plane. 282 * The pitch and offset order is dictated by the fourcc, 283 * e.g. NV12 (http://fourcc.org/yuv.php#NV12) is described as: 284 * 285 * YUV 4:2:0 image with a plane of 8 bit Y samples 286 * followed by an interleaved U/V plane containing 287 * 8 bit 2x2 subsampled colour difference samples. 288 * 289 * So it would consist of Y as offset[0] and UV as 290 * offeset[1]. Note that offset[0] will generally 291 * be 0. 292 */ 293 uint32_t handles[4]; 294 uint32_t pitches[4]; /* pitch for each plane */ 295 uint32_t offsets[4]; /* offset of each plane */ 296}; 297 298#define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01 299#define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02 300#define DRM_MODE_FB_DIRTY_FLAGS 0x03 301 302#define DRM_MODE_FB_DIRTY_MAX_CLIPS 256 303 304/* 305 * Mark a region of a framebuffer as dirty. 306 * 307 * Some hardware does not automatically update display contents 308 * as a hardware or software draw to a framebuffer. This ioctl 309 * allows userspace to tell the kernel and the hardware what 310 * regions of the framebuffer have changed. 311 * 312 * The kernel or hardware is free to update more then just the 313 * region specified by the clip rects. The kernel or hardware 314 * may also delay and/or coalesce several calls to dirty into a 315 * single update. 316 * 317 * Userspace may annotate the updates, the annotates are a 318 * promise made by the caller that the change is either a copy 319 * of pixels or a fill of a single color in the region specified. 320 * 321 * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then 322 * the number of updated regions are half of num_clips given, 323 * where the clip rects are paired in src and dst. The width and 324 * height of each one of the pairs must match. 325 * 326 * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller 327 * promises that the region specified of the clip rects is filled 328 * completely with a single color as given in the color argument. 329 */ 330 331struct drm_mode_fb_dirty_cmd { 332 uint32_t fb_id; 333 uint32_t flags; 334 uint32_t color; 335 uint32_t num_clips; 336 uint64_t clips_ptr; 337}; 338 339struct drm_mode_mode_cmd { 340 uint32_t connector_id; 341 struct drm_mode_modeinfo mode; 342}; 343 344#define DRM_MODE_CURSOR_BO (1<<0) 345#define DRM_MODE_CURSOR_MOVE (1<<1) 346 347/* 348 * depending on the value in flags diffrent members are used. 349 * 350 * CURSOR_BO uses 351 * crtc 352 * width 353 * height 354 * handle - if 0 turns the cursor of 355 * 356 * CURSOR_MOVE uses 357 * crtc 358 * x 359 * y 360 */ 361struct drm_mode_cursor { 362 uint32_t flags; 363 uint32_t crtc_id; 364 int32_t x; 365 int32_t y; 366 uint32_t width; 367 uint32_t height; 368 /* driver specific handle */ 369 uint32_t handle; 370}; 371 372struct drm_mode_crtc_lut { 373 uint32_t crtc_id; 374 uint32_t gamma_size; 375 376 /* pointers to arrays */ 377 uint64_t red; 378 uint64_t green; 379 uint64_t blue; 380}; 381 382#define DRM_MODE_PAGE_FLIP_EVENT 0x01 383#define DRM_MODE_PAGE_FLIP_FLAGS DRM_MODE_PAGE_FLIP_EVENT 384 385/* 386 * Request a page flip on the specified crtc. 387 * 388 * This ioctl will ask KMS to schedule a page flip for the specified 389 * crtc. Once any pending rendering targeting the specified fb (as of 390 * ioctl time) has completed, the crtc will be reprogrammed to display 391 * that fb after the next vertical refresh. The ioctl returns 392 * immediately, but subsequent rendering to the current fb will block 393 * in the execbuffer ioctl until the page flip happens. If a page 394 * flip is already pending as the ioctl is called, EBUSY will be 395 * returned. 396 * 397 * The ioctl supports one flag, DRM_MODE_PAGE_FLIP_EVENT, which will 398 * request that drm sends back a vblank event (see drm.h: struct 399 * drm_event_vblank) when the page flip is done. The user_data field 400 * passed in with this ioctl will be returned as the user_data field 401 * in the vblank event struct. 402 * 403 * The reserved field must be zero until we figure out something 404 * clever to use it for. 405 */ 406 407struct drm_mode_crtc_page_flip { 408 uint32_t crtc_id; 409 uint32_t fb_id; 410 uint32_t flags; 411 uint32_t reserved; 412 uint64_t user_data; 413}; 414 415/* create a dumb scanout buffer */ 416struct drm_mode_create_dumb { 417 uint32_t height; 418 uint32_t width; 419 uint32_t bpp; 420 uint32_t flags; 421 /* handle, pitch, size will be returned */ 422 uint32_t handle; 423 uint32_t pitch; 424 uint64_t size; 425}; 426 427/* set up for mmap of a dumb scanout buffer */ 428struct drm_mode_map_dumb { 429 /** Handle for the object being mapped. */ 430 uint32_t handle; 431 uint32_t pad; 432 /** 433 * Fake offset to use for subsequent mmap call 434 * 435 * This is a fixed-size type for 32/64 compatibility. 436 */ 437 uint64_t offset; 438}; 439 440struct drm_mode_destroy_dumb { 441 uint32_t handle; 442}; 443 444#endif 445