libdrm/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) <year> <copyright holders>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the "Software"),
  16  * to deal in the Software without restriction, including without limitation
  17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18  * and/or sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  27  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  29  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  30  * IN THE SOFTWARE.
  31  *
  32  */
  33
  34 #include <drm.h>
  35 #include "xf86mm.h"
  36
  37 /*
  38  * This is the interface for modesetting for drm.
  39  *
  40  * In order to use this interface you must include either <stdint.h> or another
  41  * header defining uint32_t, int32_t and uint16_t.
  42  *
  43  * It aims to provide a randr compatible interface for modesettings in the
  44  * kernel, the interface is also ment to be used by libraries like EGL.
  45  *
  46  * More information can be found in randrproto.txt which can be found here:
  47  * http://gitweb.freedesktop.org/?p=xorg/proto/randrproto.git
  48  *
  49  * All framebuffer, crtc and output ids start at 1 while 0 is either an invalid
  50  * parameter or used to indicate that the command should disconnect from the
  51  * currently bound target, as with drmModeMapOutput.
  52  *
  53  * Currently only one framebuffer exist and has a id of 1, which is also the
  54  * default framebuffer and should allways be avaible to the client, unless
  55  * it is locked/used or any other limiting state is applied on it.
  56  *
  57  */
  58
  59 typedef struct _drmModeGammaTriple {
  60         uint16_t r, g, b;
  61 } drmModeGammaTriple, *drmModeGammaTriplePtr;
  62
  63 typedef struct _drmModeRes {
  64
  65         int count_fbs;
  66         uint32_t *fbs;
  67
  68         int count_crtcs;
  69         uint32_t *crtcs;
  70
  71         int count_outputs;
  72         uint32_t *outputs;
  73
  74         int count_modes;
  75         struct drm_mode_modeinfo *modes;
  76
  77 } drmModeRes, *drmModeResPtr;
  78
  79 typedef struct _drmModeFrameBuffer {
  80
  81         uint32_t width;
  82         uint32_t height;
  83         uint32_t pitch;
  84         uint8_t bpp;
  85
  86 } drmModeFrameBuffer, *drmModeFrameBufferPtr;
  87
  88 typedef struct _drmModeCrtc {
  89
  90         unsigned int bufferId; /**< Buffer currently connected to */
  91
  92         uint32_t x, y; /**< Position on the frameuffer */
  93         uint32_t width, height;
  94         uint32_t mode; /**< Current mode used */
  95
  96         int count_outputs;
  97         uint32_t outputs; /**< Outputs that are connected */
  98
  99         int count_possibles;
 100         uint32_t possibles; /**< Outputs that can be connected */
 101
 102         int gamma_size; /**< Number of gamma stops */
 103
 104 } drmModeCrtc, *drmModeCrtcPtr;
 105
 106 typedef enum {
 107         DRM_MODE_CONNECTED         = 1,
 108         DRM_MODE_DISCONNECTED      = 2,
 109         DRM_MODE_UNKNOWNCONNECTION = 3
 110 } drmModeConnection;
 111
 112 typedef enum {
 113         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
 114         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
 115         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
 116         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
 117         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
 118         DRM_MODE_SUBPIXEL_NONE           = 6
 119 } drmModeSubPixel;
 120
 121 typedef struct _drmModeOutput {
 122
 123         unsigned int crtc; /**< Crtc currently connected to */
 124         unsigned char name[DRM_OUTPUT_NAME_LEN];
 125         drmModeConnection connection;
 126         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
 127         drmModeSubPixel subpixel;
 128
 129         int count_crtcs;
 130         uint32_t crtcs; /**< Possible crtc to connect to */
 131
 132         int count_clones;
 133         uint32_t clones; /**< Mask of clones */
 134
 135         int count_modes;
 136         uint32_t *modes; /**< List of modes ids */
 137
 138 } drmModeOutput, *drmModeOutputPtr;
 139
 140 /*
 141  * RRSetScreenConfig o
 142  * RRGetScreenInfo o
 143  *
 144  * RRGetScreenSizeRange - see frameBuffer info
 145  * RRSetScreenSize
 146  * RRGetScreenResources
 147  *
 148  * RRGetOutputInfo
 149  *
 150  * RRListOutputProperties *
 151  * RRQueryOutputProperty *
 152  * RRConfigureOutputProperty *
 153  * RRChangeOutputProperty *
 154  * RRDeleteOutputProperty *
 155  * RRGetOutputProperty *
 156  *
 157  * RRCreateMode
 158  * RRDestroyMode
 159  * RRAddOutputMode
 160  * RRDeleteOutputMode
 161  *
 162  * RRGetCrtcInfo
 163  * RRSetCrtcConfig
 164  *
 165  * RRGetCrtcGammaSize - see crtc info
 166  * RRGetCrtcGamma
 167  * RRSetCrtcGamma
 168  *
 169  * drmModeGetResources
 170  * drmModeForceProbe
 171  *
 172  * drmModeGetFrameBufferInfo
 173  * drmModeSetFrameBufferSize
 174  *
 175  * drmModeGetCrtcInfo
 176  * drmModeSetCrtcConfig
 177  * drmModeGetCrtcGamma
 178  * drmModeSetCrtcGamma
 179  *
 180  * drmModeGetOutputInfo
 181  *
 182  * drmModeAddMode
 183  * drmModeDestroyMode
 184  * drmModeAddOutputMode
 185  * drmModeDeleteOutputMode
 186  */
 187
 188 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
 189 extern void drmModeFreeResources( drmModeResPtr ptr );
 190 extern void drmModeFreeFrameBuffer( drmModeFrameBufferPtr ptr );
 191 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
 192 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
 193
 194 /**
 195  * Retrives all of the resources associated with a card.
 196  */
 197 extern drmModeResPtr drmModeGetResources(int fd);
 198
 199 /**
 200  * Forces a probe of the give output outputId, on 0 all will be probed.
 201  */
 202 extern int drmModeForceProbe(int fd, uint32_t outputId);
 203
 204
 205 /*
 206  * FrameBuffer manipulation.
 207  */
 208
 209 /**
 210  * Retrive information about framebuffer bufferId
 211  */
 212 extern drmModeFrameBufferPtr drmModeGetFB(int fd,
 213                 uint32_t bufferId);
 214
 215 /**
 216  * Creates a new framebuffer with an buffer object as its scanout buffer.
 217  */
 218 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height,
 219                         uint8_t bpp, uint32_t pitch, drmBO *bo, uint32_t *buf_id);
 220 /**
 221  * Destroies the given framebuffer.
 222  */
 223 extern int drmModeRmFB(int fd, uint32_t bufferId);
 224
 225 /**
 226  * Changes the scanout buffer to the given buffer object.
 227  */
 228 extern int drmModeFlipFrameBuffer(int fd, uint32_t bufferId, drmBO *bo);
 229
 230 /*
 231  * Crtc function.
 232  */
 233
 234 /**
 235  * Retrive information about the ctrt crtcId
 236  */
 237 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
 238
 239 /**
 240  * Set the mode on a crtc crtcId with the given mode modeId.
 241  */
 242 extern int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
 243                 uint32_t x, uint32_t y, uint32_t modeId,
 244                 uint32_t *outputs, int count);
 245
 246 /**
 247  * Gets the gamma from a crtc
 248  */
 249 extern drmModeGammaTriplePtr drmModeGetCrtcGamma(int fd, uint32_t crtcId,
 250                 int *count);
 251
 252 /**
 253  * Sets the gamma on a crtc
 254  */
 255 extern int drmModeSetCrtcGamma(int fd, uint32_t crtcId,
 256                 drmModeGammaTriplePtr ptr, int count);
 257
 258
 259
 260 /*
 261  * Output manipulation
 262  */
 263
 264 /**
 265  * Retrive information about the output outputId.
 266  */
 267 extern drmModeOutputPtr drmModeGetOutput(int fd,
 268                 uint32_t outputId);
 269
 270 /**
 271  * Creates a new mode from the given mode info.
 272  * Name must be unique.
 273  */
 274 extern uint32_t drmModeNewMode(int fd, struct drm_mode_modeinfo *modeInfo);
 275
 276 /**
 277  * Destroys a mode created with CreateMode, must be unused.
 278  */
 279 extern int drmModeDesMode(int fd, uint32_t modeId);
 280
 281 /**
 282  * Adds the given mode to an output.
 283  */
 284 extern int drmModeAddMode(int fd, uint32_t outputId, uint32_t modeId);
 285
 286 /**
 287  * Deletes a mode Added with AddOutputMode from the output,
 288  * must be unused, by the given mode.
 289  */
 290 extern int drmModeDelMode(int fd, uint32_t outputId, uint32_t modeId);
 291