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 randr1.2 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  * There are some major diffrences to be noted. Unlike the randr1.2 proto you
  50  * need to create the memory object of the framebuffer yourself with the ttm
  51  * buffer object interface. This object needs to be pinned.
  52  */
  53
  54
  55 typedef struct _drmModeRes {
  56
  57         int count_fbs;
  58         uint32_t *fbs;
  59
  60         int count_crtcs;
  61         uint32_t *crtcs;
  62
  63         int count_outputs;
  64         uint32_t *outputs;
  65
  66 } drmModeRes, *drmModeResPtr;
  67
  68 typedef struct drm_mode_fb_cmd drmModeFB, *drmModeFBPtr;
  69
  70 typedef struct _drmModeProperty {
  71         unsigned int prop_id;
  72         unsigned int flags;
  73         unsigned char name[DRM_PROP_NAME_LEN];
  74         int count_values;
  75         uint32_t *values;
  76         int count_enums;
  77         struct drm_mode_property_enum *enums;
  78
  79 } drmModePropertyRes, *drmModePropertyPtr;
  80
  81 typedef struct _drmModeCrtc {
  82         unsigned int crtc_id;
  83         unsigned int buffer_id; /**< FB id to connect to 0 = disconnect*/
  84
  85         uint32_t x, y; /**< Position on the frameuffer */
  86         uint32_t width, height;
  87         int mode_valid;
  88         struct drm_mode_modeinfo mode;
  89
  90         int count_outputs;
  91         uint32_t outputs; /**< Outputs that are connected */
  92
  93         int count_possibles;
  94         uint32_t possibles; /**< Outputs that can be connected */
  95
  96         int gamma_size; /**< Number of gamma stops */
  97
  98 } drmModeCrtc, *drmModeCrtcPtr;
  99
 100 typedef enum {
 101         DRM_MODE_CONNECTED         = 1,
 102         DRM_MODE_DISCONNECTED      = 2,
 103         DRM_MODE_UNKNOWNCONNECTION = 3
 104 } drmModeConnection;
 105
 106 typedef enum {
 107         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
 108         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
 109         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
 110         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
 111         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
 112         DRM_MODE_SUBPIXEL_NONE           = 6
 113 } drmModeSubPixel;
 114
 115 typedef struct _drmModeOutput {
 116         unsigned int output_id;
 117
 118         unsigned int crtc; /**< Crtc currently connected to */
 119         unsigned char name[DRM_OUTPUT_NAME_LEN];
 120         drmModeConnection connection;
 121         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
 122         drmModeSubPixel subpixel;
 123
 124         int count_crtcs;
 125         uint32_t crtcs; /**< Possible crtc to connect to */
 126
 127         int count_clones;
 128         uint32_t clones; /**< Mask of clones */
 129
 130         int count_modes;
 131         struct drm_mode_modeinfo *modes;
 132
 133         int count_props;
 134         uint32_t *props; /**< List of property ids */
 135         uint32_t *prop_values; /**< List of property values */
 136
 137 } drmModeOutput, *drmModeOutputPtr;
 138
 139
 140
 141 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
 142 extern void drmModeFreeResources( drmModeResPtr ptr );
 143 extern void drmModeFreeFB( drmModeFBPtr ptr );
 144 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
 145 extern void drmModeFreeOutput( drmModeOutputPtr ptr );
 146
 147 /**
 148  * Retrives all of the resources associated with a card.
 149  */
 150 extern drmModeResPtr drmModeGetResources(int fd);
 151
 152
 153 /*
 154  * FrameBuffer manipulation.
 155  */
 156
 157 /**
 158  * Retrive information about framebuffer bufferId
 159  */
 160 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
 161
 162 /**
 163  * Creates a new framebuffer with an buffer object as its scanout buffer.
 164  */
 165 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
 166                         uint8_t bpp, uint32_t pitch, drmBO *bo,
 167                         uint32_t *buf_id);
 168 /**
 169  * Destroies the given framebuffer.
 170  */
 171 extern int drmModeRmFB(int fd, uint32_t bufferId);
 172
 173
 174 /*
 175  * Crtc functions
 176  */
 177
 178 /**
 179  * Retrive information about the ctrt crtcId
 180  */
 181 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
 182
 183 /**
 184  * Set the mode on a crtc crtcId with the given mode modeId.
 185  */
 186 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
 187                    uint32_t x, uint32_t y, uint32_t *outputs, int count,
 188                    struct drm_mode_modeinfo *mode);
 189
 190
 191 /*
 192  * Output manipulation
 193  */
 194
 195 /**
 196  * Retrive information about the output outputId.
 197  */
 198 extern drmModeOutputPtr drmModeGetOutput(int fd,
 199                 uint32_t outputId);
 200
 201 /**
 202  * Adds a new mode from the given mode info.
 203  * Name must be unique.
 204  */
 205 extern uint32_t drmModeAddMode(int fd, struct drm_mode_modeinfo *modeInfo);
 206
 207 /**
 208  * Removes a mode created with AddMode, must be unused.
 209  */
 210 extern int drmModeRmMode(int fd, uint32_t modeId);
 211
 212 /**
 213  * Attaches the given mode to an output.
 214  */
 215 extern int drmModeAttachMode(int fd, uint32_t outputId, uint32_t modeId);
 216
 217 /**
 218  * Detaches a mode from the output
 219  * must be unused, by the given mode.
 220  */
 221 extern int drmModeDetachMode(int fd, uint32_t outputId, uint32_t modeId);
 222
 223 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
 224 extern void drmModeFreeProperty(drmModePropertyPtr ptr);