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_connectors;
  64         uint32_t *connectors;
  65
  66         int count_encoders;
  67         uint32_t *encoders;
  68
  69         uint32_t min_width, max_width;
  70         uint32_t min_height, max_height;
  71 } drmModeRes, *drmModeResPtr;
  72
  73 typedef struct drm_mode_fb_cmd drmModeFB, *drmModeFBPtr;
  74
  75 typedef struct _drmModePropertyBlob {
  76         uint32_t id;
  77         uint32_t length;
  78         void *data;
  79 } drmModePropertyBlobRes, *drmModePropertyBlobPtr;
  80
  81 typedef struct _drmModeProperty {
  82         unsigned int prop_id;
  83         unsigned int flags;
  84         char name[DRM_PROP_NAME_LEN];
  85         int count_values;
  86         uint64_t *values; // store the blob lengths
  87         int count_enums;
  88         struct drm_mode_property_enum *enums;
  89         int count_blobs;
  90         uint32_t *blob_ids; // store the blob IDs
  91 } drmModePropertyRes, *drmModePropertyPtr;
  92
  93 typedef struct _drmModeCrtc {
  94         unsigned int crtc_id;
  95         unsigned int buffer_id; /**< FB id to connect to 0 = disconnect*/
  96
  97         uint32_t x, y; /**< Position on the frameuffer */
  98         uint32_t width, height;
  99         int mode_valid;
 100         struct drm_mode_modeinfo mode;
 101
 102         int count_connectors;
 103         uint32_t connectors; /**< Connectors that are connected */
 104
 105         int count_possibles;
 106         uint32_t possibles; /**< Connectors that can be connected */
 107
 108         int gamma_size; /**< Number of gamma stops */
 109
 110 } drmModeCrtc, *drmModeCrtcPtr;
 111
 112 typedef struct _drmModeEncoder {
 113         unsigned int encoder_id;
 114         unsigned int encoder_type;
 115         uint32_t crtc;
 116         uint32_t crtcs;
 117         uint32_t clones;
 118 } drmModeEncoder, *drmModeEncoderPtr;
 119
 120 typedef enum {
 121         DRM_MODE_CONNECTED         = 1,
 122         DRM_MODE_DISCONNECTED      = 2,
 123         DRM_MODE_UNKNOWNCONNECTION = 3
 124 } drmModeConnection;
 125
 126 typedef enum {
 127         DRM_MODE_SUBPIXEL_UNKNOWN        = 1,
 128         DRM_MODE_SUBPIXEL_HORIZONTAL_RGB = 2,
 129         DRM_MODE_SUBPIXEL_HORIZONTAL_BGR = 3,
 130         DRM_MODE_SUBPIXEL_VERTICAL_RGB   = 4,
 131         DRM_MODE_SUBPIXEL_VERTICAL_BGR   = 5,
 132         DRM_MODE_SUBPIXEL_NONE           = 6
 133 } drmModeSubPixel;
 134
 135 typedef struct _drmModeConnector {
 136         unsigned int connector_id;
 137
 138         unsigned int encoder; /**< Crtc currently connected to */
 139         unsigned int connector_type;
 140         unsigned int connector_type_id;
 141         drmModeConnection connection;
 142         uint32_t mmWidth, mmHeight; /**< HxW in millimeters */
 143         drmModeSubPixel subpixel;
 144
 145         int count_modes;
 146         struct drm_mode_modeinfo *modes;
 147
 148         int count_props;
 149         uint32_t *props; /**< List of property ids */
 150         uint64_t *prop_values; /**< List of property values */
 151
 152         int count_encoders;
 153         uint32_t *encoders; /**< List of encoder ids */
 154 } drmModeConnector, *drmModeConnectorPtr;
 155
 156
 157
 158 extern void drmModeFreeModeInfo( struct drm_mode_modeinfo *ptr );
 159 extern void drmModeFreeResources( drmModeResPtr ptr );
 160 extern void drmModeFreeFB( drmModeFBPtr ptr );
 161 extern void drmModeFreeCrtc( drmModeCrtcPtr ptr );
 162 extern void drmModeFreeConnector( drmModeConnectorPtr ptr );
 163 extern void drmModeFreeEncoder( drmModeEncoderPtr ptr );
 164
 165 /**
 166  * Retrives all of the resources associated with a card.
 167  */
 168 extern drmModeResPtr drmModeGetResources(int fd);
 169
 170 /**
 171  * Retrives the hotplug counter
 172  */
 173 extern uint32_t drmModeGetHotplug(int fd);
 174
 175 /*
 176  * FrameBuffer manipulation.
 177  */
 178
 179 /**
 180  * Retrive information about framebuffer bufferId
 181  */
 182 extern drmModeFBPtr drmModeGetFB(int fd, uint32_t bufferId);
 183
 184 /**
 185  * Creates a new framebuffer with an buffer object as its scanout buffer.
 186  */
 187 extern int drmModeAddFB(int fd, uint32_t width, uint32_t height, uint8_t depth,
 188                         uint8_t bpp, uint32_t pitch, uint32_t bo_handle,
 189                         uint32_t *buf_id);
 190 /**
 191  * Destroies the given framebuffer.
 192  */
 193 extern int drmModeRmFB(int fd, uint32_t bufferId);
 194
 195 /**
 196  * Replace a framebuffer object with a new one - for resizing the screen.
 197  */
 198 extern int drmModeReplaceFB(int fd, uint32_t buffer_id,
 199                             uint32_t width, uint32_t height, uint8_t depth,
 200                             uint8_t bpp, uint32_t pitch, uint32_t bo_handle);
 201
 202 /*
 203  * Crtc functions
 204  */
 205
 206 /**
 207  * Retrive information about the ctrt crtcId
 208  */
 209 extern drmModeCrtcPtr drmModeGetCrtc(int fd, uint32_t crtcId);
 210
 211 /**
 212  * Set the mode on a crtc crtcId with the given mode modeId.
 213  */
 214 int drmModeSetCrtc(int fd, uint32_t crtcId, uint32_t bufferId,
 215                    uint32_t x, uint32_t y, uint32_t *connectors, int count,
 216                    struct drm_mode_modeinfo *mode);
 217
 218 /*
 219  * Cursor functions
 220  */
 221
 222 /**
 223  * Set the cursor on crtc
 224  */
 225 int drmModeSetCursor(int fd, uint32_t crtcId, uint32_t bo_handle, uint32_t width, uint32_t height);
 226
 227 /**
 228  * Move the cursor on crtc
 229  */
 230 int drmModeMoveCursor(int fd, uint32_t crtcId, int x, int y);
 231
 232 /**
 233  * Encoder functions
 234  */
 235 drmModeEncoderPtr drmModeGetEncoder(int fd, uint32_t encoder_id);
 236
 237 /*
 238  * Connector manipulation
 239  */
 240
 241 /**
 242  * Retrive information about the connector connectorId.
 243  */
 244 extern drmModeConnectorPtr drmModeGetConnector(int fd,
 245                 uint32_t connectorId);
 246
 247 /**
 248  * Attaches the given mode to an connector.
 249  */
 250 extern int drmModeAttachMode(int fd, uint32_t connectorId, struct drm_mode_modeinfo *mode_info);
 251
 252 /**
 253  * Detaches a mode from the connector
 254  * must be unused, by the given mode.
 255  */
 256 extern int drmModeDetachMode(int fd, uint32_t connectorId, struct drm_mode_modeinfo *mode_info);
 257
 258 extern drmModePropertyPtr drmModeGetProperty(int fd, uint32_t propertyId);
 259 extern void drmModeFreeProperty(drmModePropertyPtr ptr);
 260
 261 extern drmModePropertyBlobPtr drmModeGetPropertyBlob(int fd, uint32_t blob_id);
 262 extern void drmModeFreePropertyBlob(drmModePropertyBlobPtr ptr);
 263 extern int drmModeConnectorSetProperty(int fd, uint32_t connector_id, uint32_t property_id,
 264                                     uint64_t value);
 265 extern int drmCheckModesettingSupported(const char *busid);