xf86drmMode.h

   1 /*
   2  * \file xf86drmMode.h
   3  * Header for DRM modesetting interface.
   4  *
   5  * \author Jakob Bornecrantz <wallbraker@gmail.com>
   6  *
   7  * \par Acknowledgements:
   8  * Feb 2007, Dave Airlie <airlied@linux.ie>
   9  */
  10
  11 /*
  12  * Copyright (c) 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
  13  * Copyright (c) 2007-2008 Dave Airlie <airlied@linux.ie>
  14  * Copyright (c) 2007-2008 Jakob Bornecrantz <wallbraker@gmail.com>
  15  *
  16  * Permission is hereby granted, free of charge, to any person obtaining a
  17  * copy of this software and associated documentation files (the "Software"),
  18  * to deal in the Software without restriction, including without limitation
  19  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  20  * and/or sell copies of the Software, and to permit persons to whom the
  21  * Software is furnished to do so, subject to the following conditions:
  22  *
  23  * The above copyright notice and this permission notice shall be included in
  24  * all copies or substantial portions of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  29  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  30  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  31  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  32  * IN THE SOFTWARE.
  33  *
  34  */
  35
  36 #include <drm.h>
  37
  38 /*
  39  * This is the interface for modesetting for drm.
  40  *
  41  * In order to use this interface you must include either <stdint.h> or another
  42  * header defining uint32_t, int32_t and uint16_t.
  43  *
  44  * It aims to provide a randr1.2 compatible interface for modesettings in the
  45  * kernel, the interface is also ment to be used by libraries like EGL.
  46  *
  47  * More information can be found in randrproto.txt which can be found here:
  48  * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
  49  *
  50  * There are some major diffrences to be noted. Unlike the randr1.2 proto you
  51  * need to create the memory object of the framebuffer yourself with the ttm
  52  * buffer object interface. This object needs to be pinned.
  53  */
  54
  55 /*
  56  * If we pickup an old version of drm.h which doesn't include drm_mode.h
  57  * we should redefine defines. This is so that builds doesn't breaks with
  58  * new libdrm on old kernels.
  59  */
  60 #ifndef _DRM_MODE_H
  61
  62 #define DRM_DISPLAY_INFO_LEN    32
  63 #define DRM_CONNECTOR_NAME_LEN  32
  64 #define DRM_DISPLAY_MODE_LEN    32
  65 #define DRM_PROP_NAME_LEN       32
  66
  67 #define DRM_MODE_TYPE_BUILTIN   (1<<0)
  68 #define DRM_MODE_TYPE_CLOCK_C   ((1<<1) | DRM_MODE_TYPE_BUILTIN)
  69 #define DRM_MODE_TYPE_CRTC_C    ((1<<2) | DRM_MODE_TYPE_BUILTIN)
  70 #define DRM_MODE_TYPE_PREFERRED (1<<3)
  71 #define DRM_MODE_TYPE_DEFAULT   (1<<4)
  72 #define DRM_MODE_TYPE_USERDEF   (1<<5)
  73 #define DRM_MODE_TYPE_DRIVER    (1<<6)
  74
  75 /* Video mode flags */
  76 /* bit compatible with the xorg definitions. */
  77 #define DRM_MODE_FLAG_PHSYNC    (1<<0)
  78 #define DRM_MODE_FLAG_NHSYNC    (1<<1)
  79 #define DRM_MODE_FLAG_PVSYNC    (1<<2)
  80 #define DRM_MODE_FLAG_NVSYNC    (1<<3)
  81 #define DRM_MODE_FLAG_INTERLACE (1<<4)
  82 #define DRM_MODE_FLAG_DBLSCAN   (1<<5)
  83 #define DRM_MODE_FLAG_CSYNC     (1<<6)
  84 #define DRM_MODE_FLAG_PCSYNC    (1<<7)
  85 #define DRM_MODE_FLAG_NCSYNC    (1<<8)
  86 #define DRM_MODE_FLAG_HSKEW     (1<<9) /* hskew provided */
  87 #define DRM_MODE_FLAG_BCAST     (1<<10)
  88 #define DRM_MODE_FLAG_PIXMUX    (1<<11)
  89 #define DRM_MODE_FLAG_DBLCLK    (1<<12)
  90 #define DRM_MODE_FLAG_CLKDIV2   (1<<13)
  91
  92 /* DPMS flags */
  93 /* bit compatible with the xorg definitions. */
  94 #define DRM_MODE_DPMS_ON        0
  95 #define DRM_MODE_DPMS_STANDBY   1
  96 #define DRM_MODE_DPMS_SUSPEND   2
  97 #define DRM_MODE_DPMS_OFF       3
  98
  99 /* Scaling mode options */
 100 #define DRM_MODE_SCALE_NON_GPU          0
 101 #define DRM_MODE_SCALE_FULLSCREEN       1
 102 #define DRM_MODE_SCALE_NO_SCALE         2
 103 #define DRM_MODE_SCALE_ASPECT           3
 104
 105 /* Dithering mode options */
 106 #define DRM_MODE_DITHERING_OFF  0
 107 #define DRM_MODE_DITHERING_ON   1
 108
 109 #define DRM_MODE_ENCODER_NONE   0
 110 #define DRM_MODE_ENCODER_DAC    1
 111 #define DRM_MODE_ENCODER_TMDS   2
 112 #define DRM_MODE_ENCODER_LVDS   3
 113 #define DRM_MODE_ENCODER_TVDAC  4
 114
 115 #define DRM_MODE_SUBCONNECTOR_Automatic 0
 116 #define DRM_MODE_SUBCONNECTOR_Unknown   0
 117 #define DRM_MODE_SUBCONNECTOR_DVID      3
 118 #define DRM_MODE_SUBCONNECTOR_DVIA      4
 119 #define DRM_MODE_SUBCONNECTOR_Composite 5
 120 #define DRM_MODE_SUBCONNECTOR_SVIDEO    6
 121 #define DRM_MODE_SUBCONNECTOR_Component 8
 122
 123 #define DRM_MODE_CONNECTOR_Unknown      0
 124 #define DRM_MODE_CONNECTOR_VGA          1
 125 #define DRM_MODE_CONNECTOR_DVII         2
 126 #define DRM_MODE_CONNECTOR_DVID         3
 127 #define DRM_MODE_CONNECTOR_DVIA         4
 128 #define DRM_MODE_CONNECTOR_Composite    5
 129 #define DRM_MODE_CONNECTOR_SVIDEO       6
 130 #define DRM_MODE_CONNECTOR_LVDS         7
 131 #define DRM_MODE_CONNECTOR_Component    8
 132 #define DRM_MODE_CONNECTOR_9PinDIN      9
 133 #define DRM_MODE_CONNECTOR_DisplayPort  10
 134 #define DRM_MODE_CONNECTOR_HDMIA        11
 135 #define DRM_MODE_CONNECTOR_HDMIB        12
 136
 137 #define DRM_MODE_PROP_PENDING   (1<<0)
 138 #define DRM_MODE_PROP_RANGE     (1<<1)
 139 #define DRM_MODE_PROP_IMMUTABLE (1<<2)
 140 #define DRM_MODE_PROP_ENUM      (1<<3) /* enumerated type with text strings */
 141 #define DRM_MODE_PROP_BLOB      (1<<4)
 142
 143 #define DRM_MODE_CURSOR_BO      (1<<0)
 144 #define DRM_MODE_CURSOR_MOVE    (1<<1)
 145
 146 #endif /* _DRM_MODE_H */
 147
 148
 149 /*
 150  * Feature defines
 151  *
 152  * Just because these are defined doesn't mean that the kernel
 153  * can do that feature, its just for new code vs old libdrm.
 154  */
 155 #define DRM_MODE_FEATURE_KMS            1
 156 #define DRM_MODE_FEATURE_DIRTYFB        1
 157
 158
 159 typedef struct _drmModeRes {
 160
 161         int count_fbs;
 162         uint32_t *fbs;
 163
 164         int count_crtcs;
 165         uint32_t *crtcs;
 166
 167         int count_connectors;
 168         uint32_t *connectors;
 169
 170         int count_encoders;
 171         uint32_t *encoders;
 172
 173         uint32_t min_width, max_width;
 174         uint32_t min_height, max_height;
 175 } drmModeRes, *drmModeResPtr;
 176
 177 typedef struct _drmModeModeInfo {
 178         uint32_t clock;
 179         uint16_t hdisplay, hsync_start, hsync_end, htotal, hskew;
 180         uint16_t vdisplay, vsync_start, vsync_end, vtotal, vscan;
 181
 182         uint32_t vrefresh; /* vertical refresh * 1000 */
 183
 184         uint32_t flags;
 185         uint32_t type;
 186         char name[DRM_DISPLAY_MODE_LEN];
 187 } drmModeModeInfo, *drmModeModeInfoPtr;
 188
 189 typedef struct _drmModeFB {
 190         uint32_t fb_id;
 191         uint32_t width, height;
 192         uint32_t pitch;
 193         uint32_t bpp;
 194         uint32_t depth;
 195         /* driver specific handle */
 196         uint32_t handle;
 197 } drmModeFB, *drmModeFBPtr;
 198
 199 typedef struct drm_clip_rect drmModeClip, *drmModeClipPtr;
 200
 201 typedef struct _drmModePropertyBlob {
 202         uint32_t id;
 203         uint32_t length;
 204         void *data;
 205 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
 206
 207 typedef struct _drmModeProperty {
 208         uint32_t prop_id;
 209         uint32_t flags;
 210         char name[DRM_PROP_NAME_LEN];
 211         int count_values;
 212         uint64_t *values; // store the blob lengths
 213         int count_enums;
 214         struct drm_mode_property_enum *enums;
 215         int count_blobs;
 216         uint32_t *blob_ids; // store the blob IDs
 217 } drmModePropertyRes, *drmModePropertyPtr;
 218
 219 typedef struct _drmModeCrtc {
 220         uint32_t crtc_id;
 221         uint32_t buffer_id; /**< FB id to connect to 0 = disconnect */
 222
 223         uint32_t x, y; /**< Position on the framebuffer */
 224         uint32_t width, height;
 225         int mode_valid;
 226         drmModeModeInfo mode;
 227
 228         int gamma_size; /**< Number of gamma stops */
 229
 230 } drmModeCrtc, *drmModeCrtcPtr;
 231
 232 typedef struct _drmModeEncoder {
 233         uint32_t encoder_id;
 234         uint32_t encoder_type;
 235         uint32_t crtc_id;
 236         uint32_t possible_crtcs;
 237         uint32_t possible_clones;
 238 } drmModeEncoder, *drmModeEncoderPtr;
 239
 240 typedef enum {
 241         DRM_MODE_CONNECTED         = 1,
 242         DRM_MODE_DISCONNECTED      = 2,
 243         DRM_MODE_UNKNOWNCONNECTION = 3
 244 } drmModeConnection;
 245
 246 typedef enum {
 247         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
 248         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
 249         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
 250         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
 251         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
 252         DRM_MODE_SUBPIXEL_NONE           = 6
 253 } drmModeSubPixel;
 254
 255 typedef struct _drmModeConnector {
 256         uint32_t connector_id;
 257         uint32_t encoder_id; /**< Encoder currently connected to */
 258         uint32_t connector_type;
 259         uint32_t connector_type_id;
 260         drmModeConnection connection;
 261         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
 262         drmModeSubPixel subpixel;
 263
 264         int count_modes;
 265         drmModeModeInfoPtr modes;
 266
 267         int count_props;
 268         uint32_t *props; /**< List of property ids */
 269         uint64_t *prop_values; /**< List of property values */
 270
 271         int count_encoders;
 272         uint32_t *encoders; /**< List of encoder ids */
 273 } drmModeConnector, *drmModeConnectorPtr;
 274
 275
 276
 277 extern void drmModeFreeModeInfo( drmModeModeInfoPtr ptr );
 278 extern void drmModeFreeResources( drmModeResPtr ptr );
 279 extern void drmModeFreeFB( drmModeFBPtr ptr );
 280 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
 281 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
 282 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
 283
 284 /**
 285  * Retrives all of the resources associated with a card.
 286  */
 287 extern drmModeResPtr drmModeGetResources(int fd);
 288
 289 /*
 290  * FrameBuffer manipulation.
 291  */
 292
 293 /**
 294  * Retrive information about framebuffer bufferId
 295  */
 296 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
 297
 298 /**
 299  * Creates a new framebuffer with an buffer object as its scanout buffer.
 300  */
 301 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
 302                         uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
 303                         uint32_t *buf_id);
 304 /**
 305  * Destroies the given framebuffer.
 306  */
 307 extern int drmModeRmFB(int fd, uint32_t bufferId);
 308
 309 /**
 310  * Mark a region of a framebuffer as dirty.
 311  */
 312 extern int drmModeDirtyFB(int fd, uint32_t bufferId,
 313                           drmModeClipPtr clips, uint32_t num_clips);
 314
 315
 316 /*
 317  * Crtc functions
 318  */
 319
 320 /**
 321  * Retrive information about the ctrt crtcId
 322  */
 323 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
 324
 325 /**
 326  * Set the mode on a crtc crtcId with the given mode modeId.
 327  */
 328 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
 329                    uint32_t x, uint32_t y, uint32_t *connectors, int count,
 330                    drmModeModeInfoPtr mode);
 331
 332 /*
 333  * Cursor functions
 334  */
 335
 336 /**
 337  * Set the cursor on crtc
 338  */
 339 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
 340
 341 /**
 342  * Move the cursor on crtc
 343  */
 344 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
 345
 346 /**
 347  * Encoder functions
 348  */
 349 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
 350
 351 /*
 352  * Connector manipulation
 353  */
 354
 355 /**
 356  * Retrive information about the connector connectorId.
 357  */
 358 extern drmModeConnectorPtr drmModeGetConnector(int fd,
 359                 uint32_t connectorId);
 360
 361 /**
 362  * Attaches the given mode to an connector.
 363  */
 364 extern int drmModeAttachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
 365
 366 /**
 367  * Detaches a mode from the connector
 368  * must be unused, by the given mode.
 369  */
 370 extern int drmModeDetachMode(int fd, uint32_t connectorId, drmModeModeInfoPtr mode_info);
 371
 372 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
 373 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
 374
 375 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
 376 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
 377 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
 378                                     uint64_t value);
 379 extern int drmCheckModesettingSupported(const char *busid);
 380
 381 extern int drmModeCrtcSetGamma(int fd, uint32_t crtc_id, uint32_t size,
 382                                uint16_t *red, uint16_t *green, uint16_t *blue);
 383 extern int drmModeCrtcGetGamma(int fd, uint32_t crtc_id, uint32_t size,
 384                                uint16_t *red, uint16_t *green, uint16_t *blue);
 385 extern int drmModePageFlip(int fd, uint32_t crtc_id, uint32_t fb_id,
 386                            uint32_t flags, void *user_data);