Home | History | Annotate | Download | only in drm
      1 /*
      2  * Copyright (c) 2007 Dave Airlie <airlied (at) linux.ie>
      3  * Copyright (c) 2007 Jakob Bornecrantz <wallbraker (at) 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 
     27 #ifndef _DRM_MODE_H
     28 #define _DRM_MODE_H
     29 
     30 #define DRM_DISPLAY_INFO_LEN	32
     31 #define DRM_CONNECTOR_NAME_LEN	32
     32 #define DRM_DISPLAY_MODE_LEN	32
     33 #define DRM_PROP_NAME_LEN	32
     34 
     35 #define DRM_MODE_TYPE_BUILTIN	(1<<0)
     36 #define DRM_MODE_TYPE_CLOCK_C	((1<<1) | DRM_MODE_TYPE_BUILTIN)
     37 #define DRM_MODE_TYPE_CRTC_C	((1<<2) | DRM_MODE_TYPE_BUILTIN)
     38 #define DRM_MODE_TYPE_PREFERRED	(1<<3)
     39 #define DRM_MODE_TYPE_DEFAULT	(1<<4)
     40 #define DRM_MODE_TYPE_USERDEF	(1<<5)
     41 #define DRM_MODE_TYPE_DRIVER	(1<<6)
     42 
     43 /* Video mode flags */
     44 /* bit compatible with the xorg definitions. */
     45 #define DRM_MODE_FLAG_PHSYNC	(1<<0)
     46 #define DRM_MODE_FLAG_NHSYNC	(1<<1)
     47 #define DRM_MODE_FLAG_PVSYNC	(1<<2)
     48 #define DRM_MODE_FLAG_NVSYNC	(1<<3)
     49 #define DRM_MODE_FLAG_INTERLACE	(1<<4)
     50 #define DRM_MODE_FLAG_DBLSCAN	(1<<5)
     51 #define DRM_MODE_FLAG_CSYNC	(1<<6)
     52 #define DRM_MODE_FLAG_PCSYNC	(1<<7)
     53 #define DRM_MODE_FLAG_NCSYNC	(1<<8)
     54 #define DRM_MODE_FLAG_HSKEW	(1<<9) /* hskew provided */
     55 #define DRM_MODE_FLAG_BCAST	(1<<10)
     56 #define DRM_MODE_FLAG_PIXMUX	(1<<11)
     57 #define DRM_MODE_FLAG_DBLCLK	(1<<12)
     58 #define DRM_MODE_FLAG_CLKDIV2	(1<<13)
     59 
     60 /* DPMS flags */
     61 /* bit compatible with the xorg definitions. */
     62 #define DRM_MODE_DPMS_ON	0
     63 #define DRM_MODE_DPMS_STANDBY	1
     64 #define DRM_MODE_DPMS_SUSPEND	2
     65 #define DRM_MODE_DPMS_OFF	3
     66 
     67 /* Scaling mode options */
     68 #define DRM_MODE_SCALE_NONE		0 /* Unmodified timing (display or
     69 					     software can still scale) */
     70 #define DRM_MODE_SCALE_FULLSCREEN	1 /* Full screen, ignore aspect */
     71 #define DRM_MODE_SCALE_CENTER		2 /* Centered, no scaling */
     72 #define DRM_MODE_SCALE_ASPECT		3 /* Full screen, preserve aspect */
     73 
     74 /* Dithering mode options */
     75 #define DRM_MODE_DITHERING_OFF	0
     76 #define DRM_MODE_DITHERING_ON	1
     77 #define DRM_MODE_DITHERING_AUTO 2
     78 
     79 /* Dirty info options */
     80 #define DRM_MODE_DIRTY_OFF      0
     81 #define DRM_MODE_DIRTY_ON       1
     82 #define DRM_MODE_DIRTY_ANNOTATE 2
     83 
     84 struct drm_mode_modeinfo {
     85 	__u32 clock;
     86 	__u16 hdisplay, hsync_start, hsync_end, htotal, hskew;
     87 	__u16 vdisplay, vsync_start, vsync_end, vtotal, vscan;
     88 
     89 	__u32 vrefresh;
     90 
     91 	__u32 flags;
     92 	__u32 type;
     93 	char name[DRM_DISPLAY_MODE_LEN];
     94 };
     95 
     96 struct drm_mode_card_res {
     97 	__u64 fb_id_ptr;
     98 	__u64 crtc_id_ptr;
     99 	__u64 connector_id_ptr;
    100 	__u64 encoder_id_ptr;
    101 	__u32 count_fbs;
    102 	__u32 count_crtcs;
    103 	__u32 count_connectors;
    104 	__u32 count_encoders;
    105 	__u32 min_width, max_width;
    106 	__u32 min_height, max_height;
    107 };
    108 
    109 struct drm_mode_crtc {
    110 	__u64 set_connectors_ptr;
    111 	__u32 count_connectors;
    112 
    113 	__u32 crtc_id; /**< Id */
    114 	__u32 fb_id; /**< Id of framebuffer */
    115 
    116 	__u32 x, y; /**< Position on the frameuffer */
    117 
    118 	__u32 gamma_size;
    119 	__u32 mode_valid;
    120 	struct drm_mode_modeinfo mode;
    121 };
    122 
    123 #define DRM_MODE_ENCODER_NONE	 0
    124 #define DRM_MODE_ENCODER_DAC	 1
    125 #define DRM_MODE_ENCODER_TMDS	 2
    126 #define DRM_MODE_ENCODER_LVDS	 3
    127 #define DRM_MODE_ENCODER_TVDAC	 4
    128 #define DRM_MODE_ENCODER_VIRTUAL 5
    129 
    130 struct drm_mode_get_encoder {
    131 	__u32 encoder_id;
    132 	__u32 encoder_type;
    133 
    134 	__u32 crtc_id; /**< Id of crtc */
    135 
    136 	__u32 possible_crtcs;
    137 	__u32 possible_clones;
    138 };
    139 
    140 /* This is for connectors with multiple signal types. */
    141 /* Try to match DRM_MODE_CONNECTOR_X as closely as possible. */
    142 #define DRM_MODE_SUBCONNECTOR_Automatic	0
    143 #define DRM_MODE_SUBCONNECTOR_Unknown	0
    144 #define DRM_MODE_SUBCONNECTOR_DVID	3
    145 #define DRM_MODE_SUBCONNECTOR_DVIA	4
    146 #define DRM_MODE_SUBCONNECTOR_Composite	5
    147 #define DRM_MODE_SUBCONNECTOR_SVIDEO	6
    148 #define DRM_MODE_SUBCONNECTOR_Component	8
    149 #define DRM_MODE_SUBCONNECTOR_SCART	9
    150 
    151 #define DRM_MODE_CONNECTOR_Unknown	0
    152 #define DRM_MODE_CONNECTOR_VGA		1
    153 #define DRM_MODE_CONNECTOR_DVII		2
    154 #define DRM_MODE_CONNECTOR_DVID		3
    155 #define DRM_MODE_CONNECTOR_DVIA		4
    156 #define DRM_MODE_CONNECTOR_Composite	5
    157 #define DRM_MODE_CONNECTOR_SVIDEO	6
    158 #define DRM_MODE_CONNECTOR_LVDS		7
    159 #define DRM_MODE_CONNECTOR_Component	8
    160 #define DRM_MODE_CONNECTOR_9PinDIN	9
    161 #define DRM_MODE_CONNECTOR_DisplayPort	10
    162 #define DRM_MODE_CONNECTOR_HDMIA	11
    163 #define DRM_MODE_CONNECTOR_HDMIB	12
    164 #define DRM_MODE_CONNECTOR_TV		13
    165 #define DRM_MODE_CONNECTOR_eDP		14
    166 #define DRM_MODE_CONNECTOR_VIRTUAL      15
    167 
    168 struct drm_mode_get_connector {
    169 
    170 	__u64 encoders_ptr;
    171 	__u64 modes_ptr;
    172 	__u64 props_ptr;
    173 	__u64 prop_values_ptr;
    174 
    175 	__u32 count_modes;
    176 	__u32 count_props;
    177 	__u32 count_encoders;
    178 
    179 	__u32 encoder_id; /**< Current Encoder */
    180 	__u32 connector_id; /**< Id */
    181 	__u32 connector_type;
    182 	__u32 connector_type_id;
    183 
    184 	__u32 connection;
    185 	__u32 mm_width, mm_height; /**< HxW in millimeters */
    186 	__u32 subpixel;
    187 };
    188 
    189 #define DRM_MODE_PROP_PENDING	(1<<0)
    190 #define DRM_MODE_PROP_RANGE	(1<<1)
    191 #define DRM_MODE_PROP_IMMUTABLE	(1<<2)
    192 #define DRM_MODE_PROP_ENUM	(1<<3) /* enumerated type with text strings */
    193 #define DRM_MODE_PROP_BLOB	(1<<4)
    194 
    195 struct drm_mode_property_enum {
    196 	__u64 value;
    197 	char name[DRM_PROP_NAME_LEN];
    198 };
    199 
    200 struct drm_mode_get_property {
    201 	__u64 values_ptr; /* values and blob lengths */
    202 	__u64 enum_blob_ptr; /* enum and blob id ptrs */
    203 
    204 	__u32 prop_id;
    205 	__u32 flags;
    206 	char name[DRM_PROP_NAME_LEN];
    207 
    208 	__u32 count_values;
    209 	__u32 count_enum_blobs;
    210 };
    211 
    212 struct drm_mode_connector_set_property {
    213 	__u64 value;
    214 	__u32 prop_id;
    215 	__u32 connector_id;
    216 };
    217 
    218 struct drm_mode_get_blob {
    219 	__u32 blob_id;
    220 	__u32 length;
    221 	__u64 data;
    222 };
    223 
    224 struct drm_mode_fb_cmd {
    225 	__u32 fb_id;
    226 	__u32 width, height;
    227 	__u32 pitch;
    228 	__u32 bpp;
    229 	__u32 depth;
    230 	/* driver specific handle */
    231 	__u32 handle;
    232 };
    233 
    234 #define DRM_MODE_FB_DIRTY_ANNOTATE_COPY 0x01
    235 #define DRM_MODE_FB_DIRTY_ANNOTATE_FILL 0x02
    236 #define DRM_MODE_FB_DIRTY_FLAGS         0x03
    237 
    238 #define DRM_MODE_FB_DIRTY_MAX_CLIPS     256
    239 
    240 /*
    241  * Mark a region of a framebuffer as dirty.
    242  *
    243  * Some hardware does not automatically update display contents
    244  * as a hardware or software draw to a framebuffer. This ioctl
    245  * allows userspace to tell the kernel and the hardware what
    246  * regions of the framebuffer have changed.
    247  *
    248  * The kernel or hardware is free to update more then just the
    249  * region specified by the clip rects. The kernel or hardware
    250  * may also delay and/or coalesce several calls to dirty into a
    251  * single update.
    252  *
    253  * Userspace may annotate the updates, the annotates are a
    254  * promise made by the caller that the change is either a copy
    255  * of pixels or a fill of a single color in the region specified.
    256  *
    257  * If the DRM_MODE_FB_DIRTY_ANNOTATE_COPY flag is given then
    258  * the number of updated regions are half of num_clips given,
    259  * where the clip rects are paired in src and dst. The width and
    260  * height of each one of the pairs must match.
    261  *
    262  * If the DRM_MODE_FB_DIRTY_ANNOTATE_FILL flag is given the caller
    263  * promises that the region specified of the clip rects is filled
    264  * completely with a single color as given in the color argument.
    265  */
    266 
    267 struct drm_mode_fb_dirty_cmd {
    268 	__u32 fb_id;
    269 	__u32 flags;
    270 	__u32 color;
    271 	__u32 num_clips;
    272 	__u64 clips_ptr;
    273 };
    274 
    275 struct drm_mode_mode_cmd {
    276 	__u32 connector_id;
    277 	struct drm_mode_modeinfo mode;
    278 };
    279 
    280 #define DRM_MODE_CURSOR_BO	(1<<0)
    281 #define DRM_MODE_CURSOR_MOVE	(1<<1)
    282 
    283 /*
    284  * depending on the value in flags different members are used.
    285  *
    286  * CURSOR_BO uses
    287  *    crtc
    288  *    width
    289  *    height
    290  *    handle - if 0 turns the cursor of
    291  *
    292  * CURSOR_MOVE uses
    293  *    crtc
    294  *    x
    295  *    y
    296  */
    297 struct drm_mode_cursor {
    298 	__u32 flags;
    299 	__u32 crtc_id;
    300 	__s32 x;
    301 	__s32 y;
    302 	__u32 width;
    303 	__u32 height;
    304 	/* driver specific handle */
    305 	__u32 handle;
    306 };
    307 
    308 struct drm_mode_crtc_lut {
    309 	__u32 crtc_id;
    310 	__u32 gamma_size;
    311 
    312 	/* pointers to arrays */
    313 	__u64 red;
    314 	__u64 green;
    315 	__u64 blue;
    316 };
    317 
    318 #define DRM_MODE_PAGE_FLIP_EVENT 0x01
    319 #define DRM_MODE_PAGE_FLIP_FLAGS DRM_MODE_PAGE_FLIP_EVENT
    320 
    321 /*
    322  * Request a page flip on the specified crtc.
    323  *
    324  * This ioctl will ask KMS to schedule a page flip for the specified
    325  * crtc.  Once any pending rendering targeting the specified fb (as of
    326  * ioctl time) has completed, the crtc will be reprogrammed to display
    327  * that fb after the next vertical refresh.  The ioctl returns
    328  * immediately, but subsequent rendering to the current fb will block
    329  * in the execbuffer ioctl until the page flip happens.  If a page
    330  * flip is already pending as the ioctl is called, EBUSY will be
    331  * returned.
    332  *
    333  * The ioctl supports one flag, DRM_MODE_PAGE_FLIP_EVENT, which will
    334  * request that drm sends back a vblank event (see drm.h: struct
    335  * drm_event_vblank) when the page flip is done.  The user_data field
    336  * passed in with this ioctl will be returned as the user_data field
    337  * in the vblank event struct.
    338  *
    339  * The reserved field must be zero until we figure out something
    340  * clever to use it for.
    341  */
    342 
    343 struct drm_mode_crtc_page_flip {
    344 	__u32 crtc_id;
    345 	__u32 fb_id;
    346 	__u32 flags;
    347 	__u32 reserved;
    348 	__u64 user_data;
    349 };
    350 
    351 /* create a dumb scanout buffer */
    352 struct drm_mode_create_dumb {
    353 	uint32_t height;
    354 	uint32_t width;
    355 	uint32_t bpp;
    356 	uint32_t flags;
    357 	/* handle, pitch, size will be returned */
    358 	uint32_t handle;
    359 	uint32_t pitch;
    360 	uint64_t size;
    361 };
    362 
    363 /* set up for mmap of a dumb scanout buffer */
    364 struct drm_mode_map_dumb {
    365 	/** Handle for the object being mapped. */
    366 	__u32 handle;
    367 	__u32 pad;
    368 	/**
    369 	 * Fake offset to use for subsequent mmap call
    370 	 *
    371 	 * This is a fixed-size type for 32/64 compatibility.
    372 	 */
    373 	__u64 offset;
    374 };
    375 
    376 struct drm_mode_destroy_dumb {
    377 	uint32_t handle;
    378 };
    379 
    380 #endif
    381