1
/**************************************************************************
3
* Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
6
* Permission is hereby granted, free of charge, to any person obtaining a
7
* copy of this software and associated documentation files (the
8
* "Software"), to deal in the Software without restriction, including
9
* without limitation the rights to use, copy, modify, merge, publish,
10
* distribute, sub license, and/or sell copies of the Software, and to
11
* permit persons to whom the Software is furnished to do so, subject to
12
* the following conditions:
14
* The above copyright notice and this permission notice (including the
15
* next paragraph) shall be included in all copies or substantial portions
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 NON-INFRINGEMENT. IN NO EVENT SHALL
21
* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24
* USE OR OTHER DEALINGS IN THE SOFTWARE.
26
**************************************************************************/
28
#ifndef __VMWGFX_DRM_H__
29
#define __VMWGFX_DRM_H__
31
#define DRM_VMW_MAX_SURFACE_FACES 6
32
#define DRM_VMW_MAX_MIP_LEVELS 24
34
#define DRM_VMW_EXT_NAME_LEN 128
36
#define DRM_VMW_GET_PARAM 0
37
#define DRM_VMW_ALLOC_DMABUF 1
38
#define DRM_VMW_UNREF_DMABUF 2
39
#define DRM_VMW_CURSOR_BYPASS 3
40
/* guarded by DRM_VMW_PARAM_NUM_STREAMS != 0*/
41
#define DRM_VMW_CONTROL_STREAM 4
42
#define DRM_VMW_CLAIM_STREAM 5
43
#define DRM_VMW_UNREF_STREAM 6
44
/* guarded by DRM_VMW_PARAM_3D == 1 */
45
#define DRM_VMW_CREATE_CONTEXT 7
46
#define DRM_VMW_UNREF_CONTEXT 8
47
#define DRM_VMW_CREATE_SURFACE 9
48
#define DRM_VMW_UNREF_SURFACE 10
49
#define DRM_VMW_REF_SURFACE 11
50
#define DRM_VMW_EXECBUF 12
51
#define DRM_VMW_FIFO_DEBUG 13
52
#define DRM_VMW_FENCE_WAIT 14
53
/* guarded by minor version >= 2 */
54
#define DRM_VMW_UPDATE_LAYOUT 15
57
/*************************************************************************/
59
* DRM_VMW_GET_PARAM - get device information.
61
* DRM_VMW_PARAM_FIFO_OFFSET:
62
* Offset to use to map the first page of the FIFO read-only.
63
* The fifo is mapped using the mmap() system call on the drm device.
65
* DRM_VMW_PARAM_OVERLAY_IOCTL:
66
* Does the driver support the overlay ioctl.
69
#define DRM_VMW_PARAM_NUM_STREAMS 0
70
#define DRM_VMW_PARAM_NUM_FREE_STREAMS 1
71
#define DRM_VMW_PARAM_3D 2
72
#define DRM_VMW_PARAM_FIFO_OFFSET 3
73
#define DRM_VMW_PARAM_HW_CAPS 4
74
#define DRM_VMW_PARAM_FIFO_CAPS 5
75
#define DRM_VMW_PARAM_MAX_FB_SIZE 6
78
* struct drm_vmw_getparam_arg
80
* @value: Returned value. //Out
81
* @param: Parameter to query. //In.
83
* Argument to the DRM_VMW_GET_PARAM Ioctl.
86
struct drm_vmw_getparam_arg {
92
/*************************************************************************/
94
* DRM_VMW_CREATE_CONTEXT - Create a host context.
96
* Allocates a device unique context id, and queues a create context command
97
* for the host. Does not wait for host completion.
101
* struct drm_vmw_context_arg
103
* @cid: Device unique context ID.
105
* Output argument to the DRM_VMW_CREATE_CONTEXT Ioctl.
106
* Input argument to the DRM_VMW_UNREF_CONTEXT Ioctl.
109
struct drm_vmw_context_arg {
114
/*************************************************************************/
116
* DRM_VMW_UNREF_CONTEXT - Create a host context.
118
* Frees a global context id, and queues a destroy host command for the host.
119
* Does not wait for host completion. The context ID can be used directly
120
* in the command stream and shows up as the same context ID on the host.
123
/*************************************************************************/
125
* DRM_VMW_CREATE_SURFACE - Create a host suface.
127
* Allocates a device unique surface id, and queues a create surface command
128
* for the host. Does not wait for host completion. The surface ID can be
129
* used directly in the command stream and shows up as the same surface
134
* struct drm_wmv_surface_create_req
136
* @flags: Surface flags as understood by the host.
137
* @format: Surface format as understood by the host.
138
* @mip_levels: Number of mip levels for each face.
139
* An unused face should have 0 encoded.
140
* @size_addr: Address of a user-space array of sruct drm_vmw_size
141
* cast to an uint64_t for 32-64 bit compatibility.
142
* The size of the array should equal the total number of mipmap levels.
143
* @shareable: Boolean whether other clients (as identified by file descriptors)
144
* may reference this surface.
145
* @scanout: Boolean whether the surface is intended to be used as a
148
* Input data to the DRM_VMW_CREATE_SURFACE Ioctl.
149
* Output data from the DRM_VMW_REF_SURFACE Ioctl.
152
struct drm_vmw_surface_create_req {
155
uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
162
* struct drm_wmv_surface_arg
164
* @sid: Surface id of created surface or surface to destroy or reference.
166
* Output data from the DRM_VMW_CREATE_SURFACE Ioctl.
167
* Input argument to the DRM_VMW_UNREF_SURFACE Ioctl.
168
* Input argument to the DRM_VMW_REF_SURFACE Ioctl.
171
struct drm_vmw_surface_arg {
177
* struct drm_vmw_size ioctl.
179
* @width - mip level width
180
* @height - mip level height
181
* @depth - mip level depth
183
* Description of a mip level.
184
* Input data to the DRM_WMW_CREATE_SURFACE Ioctl.
187
struct drm_vmw_size {
195
* union drm_vmw_surface_create_arg
197
* @rep: Output data as described above.
198
* @req: Input data as described above.
200
* Argument to the DRM_VMW_CREATE_SURFACE Ioctl.
203
union drm_vmw_surface_create_arg {
204
struct drm_vmw_surface_arg rep;
205
struct drm_vmw_surface_create_req req;
208
/*************************************************************************/
210
* DRM_VMW_REF_SURFACE - Reference a host surface.
212
* Puts a reference on a host surface with a give sid, as previously
213
* returned by the DRM_VMW_CREATE_SURFACE ioctl.
214
* A reference will make sure the surface isn't destroyed while we hold
215
* it and will allow the calling client to use the surface ID in the command
218
* On successful return, the Ioctl returns the surface information given
219
* in the DRM_VMW_CREATE_SURFACE ioctl.
223
* union drm_vmw_surface_reference_arg
225
* @rep: Output data as described above.
226
* @req: Input data as described above.
228
* Argument to the DRM_VMW_REF_SURFACE Ioctl.
231
union drm_vmw_surface_reference_arg {
232
struct drm_vmw_surface_create_req rep;
233
struct drm_vmw_surface_arg req;
236
/*************************************************************************/
238
* DRM_VMW_UNREF_SURFACE - Unreference a host surface.
240
* Clear a reference previously put on a host surface.
241
* When all references are gone, including the one implicitly placed
243
* a destroy surface command will be queued for the host.
244
* Does not wait for completion.
247
/*************************************************************************/
251
* Submit a command buffer for execution on the host, and return a
252
* fence sequence that when signaled, indicates that the command buffer has
257
* struct drm_vmw_execbuf_arg
259
* @commands: User-space address of a command buffer cast to an uint64_t.
260
* @command-size: Size in bytes of the command buffer.
261
* @throttle-us: Sleep until software is less than @throttle_us
262
* microseconds ahead of hardware. The driver may round this value
263
* to the nearest kernel tick.
264
* @fence_rep: User-space address of a struct drm_vmw_fence_rep cast to an
266
* @version: Allows expanding the execbuf ioctl parameters without breaking
267
* backwards compatibility, since user-space will always tell the kernel
268
* which version it uses.
269
* @flags: Execbuf flags. None currently.
271
* Argument to the DRM_VMW_EXECBUF Ioctl.
274
#define DRM_VMW_EXECBUF_VERSION 0
276
struct drm_vmw_execbuf_arg {
278
uint32_t command_size;
279
uint32_t throttle_us;
286
* struct drm_vmw_fence_rep
288
* @fence_seq: Fence sequence associated with a command submission.
289
* @error: This member should've been set to -EFAULT on submission.
290
* The following actions should be take on completion:
291
* error == -EFAULT: Fence communication failed. The host is synchronized.
292
* Use the last fence id read from the FIFO fence register.
293
* error != 0 && error != -EFAULT:
294
* Fence submission failed. The host is synchronized. Use the fence_seq member.
295
* error == 0: All is OK, The host may not be synchronized.
296
* Use the fence_seq member.
298
* Input / Output data to the DRM_VMW_EXECBUF Ioctl.
301
struct drm_vmw_fence_rep {
307
/*************************************************************************/
309
* DRM_VMW_ALLOC_DMABUF
311
* Allocate a DMA buffer that is visible also to the host.
312
* NOTE: The buffer is
313
* identified by a handle and an offset, which are private to the guest, but
314
* useable in the command stream. The guest kernel may translate these
315
* and patch up the command stream accordingly. In the future, the offset may
316
* be zero at all times, or it may disappear from the interface before it is
319
* The DMA buffer may stay user-space mapped in the guest at all times,
320
* and is thus suitable for sub-allocation.
322
* DMA buffers are mapped using the mmap() syscall on the drm device.
326
* struct drm_vmw_alloc_dmabuf_req
328
* @size: Required minimum size of the buffer.
330
* Input data to the DRM_VMW_ALLOC_DMABUF Ioctl.
333
struct drm_vmw_alloc_dmabuf_req {
339
* struct drm_vmw_dmabuf_rep
341
* @map_handle: Offset to use in the mmap() call used to map the buffer.
342
* @handle: Handle unique to this buffer. Used for unreferencing.
343
* @cur_gmr_id: GMR id to use in the command stream when this buffer is
344
* referenced. See not above.
345
* @cur_gmr_offset: Offset to use in the command stream when this buffer is
346
* referenced. See note above.
348
* Output data from the DRM_VMW_ALLOC_DMABUF Ioctl.
351
struct drm_vmw_dmabuf_rep {
355
uint32_t cur_gmr_offset;
360
* union drm_vmw_dmabuf_arg
362
* @req: Input data as described above.
363
* @rep: Output data as described above.
365
* Argument to the DRM_VMW_ALLOC_DMABUF Ioctl.
368
union drm_vmw_alloc_dmabuf_arg {
369
struct drm_vmw_alloc_dmabuf_req req;
370
struct drm_vmw_dmabuf_rep rep;
373
/*************************************************************************/
375
* DRM_VMW_UNREF_DMABUF - Free a DMA buffer.
380
* struct drm_vmw_unref_dmabuf_arg
382
* @handle: Handle indicating what buffer to free. Obtained from the
383
* DRM_VMW_ALLOC_DMABUF Ioctl.
385
* Argument to the DRM_VMW_UNREF_DMABUF Ioctl.
388
struct drm_vmw_unref_dmabuf_arg {
393
/*************************************************************************/
395
* DRM_VMW_FIFO_DEBUG - Get last FIFO submission.
397
* This IOCTL copies the last FIFO submission directly out of the FIFO buffer.
401
* struct drm_vmw_fifo_debug_arg
403
* @debug_buffer: User space address of a debug_buffer cast to an uint64_t //In
404
* @debug_buffer_size: Size in bytes of debug buffer //In
405
* @used_size: Number of bytes copied to the buffer // Out
406
* @did_not_fit: Boolean indicating that the fifo contents did not fit. //Out
408
* Argument to the DRM_VMW_FIFO_DEBUG Ioctl.
411
struct drm_vmw_fifo_debug_arg {
412
uint64_t debug_buffer;
413
uint32_t debug_buffer_size;
419
struct drm_vmw_fence_wait_arg {
421
uint64_t kernel_cookie;
422
int32_t cookie_valid;
426
/*************************************************************************/
428
* DRM_VMW_CONTROL_STREAM - Control overlays, aka streams.
430
* This IOCTL controls the overlay units of the svga device.
431
* The SVGA overlay units does not work like regular hardware units in
432
* that they do not automaticaly read back the contents of the given dma
433
* buffer. But instead only read back for each call to this ioctl, and
434
* at any point between this call being made and a following call that
435
* either changes the buffer or disables the stream.
439
* struct drm_vmw_rect
441
* Defines a rectangle. Used in the overlay ioctl to define
442
* source and destination rectangle.
445
struct drm_vmw_rect {
453
* struct drm_vmw_control_stream_arg
455
* @stream_id: Stearm to control
456
* @enabled: If false all following arguments are ignored.
457
* @handle: Handle to buffer for getting data from.
458
* @format: Format of the overlay as understood by the host.
459
* @width: Width of the overlay.
460
* @height: Height of the overlay.
461
* @size: Size of the overlay in bytes.
462
* @pitch: Array of pitches, the two last are only used for YUV12 formats.
463
* @offset: Offset from start of dma buffer to overlay.
464
* @src: Source rect, must be within the defined area above.
465
* @dst: Destination rect, x and y may be negative.
467
* Argument to the DRM_VMW_CONTROL_STREAM Ioctl.
470
struct drm_vmw_control_stream_arg {
486
struct drm_vmw_rect src;
487
struct drm_vmw_rect dst;
490
/*************************************************************************/
492
* DRM_VMW_CURSOR_BYPASS - Give extra information about cursor bypass.
496
#define DRM_VMW_CURSOR_BYPASS_ALL (1 << 0)
497
#define DRM_VMW_CURSOR_BYPASS_FLAGS (1)
500
* struct drm_vmw_cursor_bypass_arg
503
* @crtc_id: Crtc id, only used if DMR_CURSOR_BYPASS_ALL isn't passed.
504
* @xpos: X position of cursor.
505
* @ypos: Y position of cursor.
509
* Argument to the DRM_VMW_CURSOR_BYPASS Ioctl.
512
struct drm_vmw_cursor_bypass_arg {
521
/*************************************************************************/
523
* DRM_VMW_CLAIM_STREAM - Claim a single stream.
527
* struct drm_vmw_context_arg
529
* @stream_id: Device unique context ID.
531
* Output argument to the DRM_VMW_CREATE_CONTEXT Ioctl.
532
* Input argument to the DRM_VMW_UNREF_CONTEXT Ioctl.
535
struct drm_vmw_stream_arg {
540
/*************************************************************************/
542
* DRM_VMW_UNREF_STREAM - Unclaim a stream.
544
* Return a single stream that was claimed by this process. Also makes
545
* sure that the stream has been stopped.
548
/*************************************************************************/
550
* DRM_VMW_UPDATE_LAYOUT - Update layout
552
* Updates the prefered modes and connection status for connectors. The
553
* command conisits of one drm_vmw_update_layout_arg pointing out a array
554
* of num_outputs drm_vmw_rect's.
558
* struct drm_vmw_update_layout_arg
560
* @num_outputs: number of active
561
* @rects: pointer to array of drm_vmw_rect
563
* Input argument to the DRM_VMW_UPDATE_LAYOUT Ioctl.
566
struct drm_vmw_update_layout_arg {
567
uint32_t num_outputs;