]>
Commit | Line | Data |
---|---|---|
fb1d9738 JB |
1 | /************************************************************************** |
2 | * | |
3 | * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA | |
4 | * All Rights Reserved. | |
5 | * | |
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: | |
13 | * | |
14 | * The above copyright notice and this permission notice (including the | |
15 | * next paragraph) shall be included in all copies or substantial portions | |
16 | * 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 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. | |
25 | * | |
26 | **************************************************************************/ | |
27 | ||
28 | #ifndef __VMWGFX_DRM_H__ | |
29 | #define __VMWGFX_DRM_H__ | |
30 | ||
31 | #define DRM_VMW_MAX_SURFACE_FACES 6 | |
32 | #define DRM_VMW_MAX_MIP_LEVELS 24 | |
33 | ||
34 | #define DRM_VMW_EXT_NAME_LEN 128 | |
35 | ||
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 | ||
54 | ||
55 | /*************************************************************************/ | |
56 | /** | |
57 | * DRM_VMW_GET_PARAM - get device information. | |
58 | * | |
59 | * DRM_VMW_PARAM_FIFO_OFFSET: | |
60 | * Offset to use to map the first page of the FIFO read-only. | |
61 | * The fifo is mapped using the mmap() system call on the drm device. | |
62 | * | |
63 | * DRM_VMW_PARAM_OVERLAY_IOCTL: | |
64 | * Does the driver support the overlay ioctl. | |
65 | */ | |
66 | ||
67 | #define DRM_VMW_PARAM_NUM_STREAMS 0 | |
68 | #define DRM_VMW_PARAM_NUM_FREE_STREAMS 1 | |
69 | #define DRM_VMW_PARAM_3D 2 | |
70 | #define DRM_VMW_PARAM_FIFO_OFFSET 3 | |
71 | ||
72 | ||
73 | /** | |
74 | * struct drm_vmw_getparam_arg | |
75 | * | |
76 | * @value: Returned value. //Out | |
77 | * @param: Parameter to query. //In. | |
78 | * | |
79 | * Argument to the DRM_VMW_GET_PARAM Ioctl. | |
80 | */ | |
81 | ||
82 | struct drm_vmw_getparam_arg { | |
83 | uint64_t value; | |
84 | uint32_t param; | |
85 | uint32_t pad64; | |
86 | }; | |
87 | ||
88 | /*************************************************************************/ | |
89 | /** | |
90 | * DRM_VMW_EXTENSION - Query device extensions. | |
91 | */ | |
92 | ||
93 | /** | |
94 | * struct drm_vmw_extension_rep | |
95 | * | |
96 | * @exists: The queried extension exists. | |
97 | * @driver_ioctl_offset: Ioctl number of the first ioctl in the extension. | |
98 | * @driver_sarea_offset: Offset to any space in the DRI SAREA | |
99 | * used by the extension. | |
100 | * @major: Major version number of the extension. | |
101 | * @minor: Minor version number of the extension. | |
102 | * @pl: Patch level version number of the extension. | |
103 | * | |
104 | * Output argument to the DRM_VMW_EXTENSION Ioctl. | |
105 | */ | |
106 | ||
107 | struct drm_vmw_extension_rep { | |
108 | int32_t exists; | |
109 | uint32_t driver_ioctl_offset; | |
110 | uint32_t driver_sarea_offset; | |
111 | uint32_t major; | |
112 | uint32_t minor; | |
113 | uint32_t pl; | |
114 | uint32_t pad64; | |
115 | }; | |
116 | ||
117 | /** | |
118 | * union drm_vmw_extension_arg | |
119 | * | |
120 | * @extension - Ascii name of the extension to be queried. //In | |
121 | * @rep - Reply as defined above. //Out | |
122 | * | |
123 | * Argument to the DRM_VMW_EXTENSION Ioctl. | |
124 | */ | |
125 | ||
126 | union drm_vmw_extension_arg { | |
127 | char extension[DRM_VMW_EXT_NAME_LEN]; | |
128 | struct drm_vmw_extension_rep rep; | |
129 | }; | |
130 | ||
131 | /*************************************************************************/ | |
132 | /** | |
133 | * DRM_VMW_CREATE_CONTEXT - Create a host context. | |
134 | * | |
135 | * Allocates a device unique context id, and queues a create context command | |
136 | * for the host. Does not wait for host completion. | |
137 | */ | |
138 | ||
139 | /** | |
140 | * struct drm_vmw_context_arg | |
141 | * | |
142 | * @cid: Device unique context ID. | |
143 | * | |
144 | * Output argument to the DRM_VMW_CREATE_CONTEXT Ioctl. | |
145 | * Input argument to the DRM_VMW_UNREF_CONTEXT Ioctl. | |
146 | */ | |
147 | ||
148 | struct drm_vmw_context_arg { | |
149 | int32_t cid; | |
150 | uint32_t pad64; | |
151 | }; | |
152 | ||
153 | /*************************************************************************/ | |
154 | /** | |
155 | * DRM_VMW_UNREF_CONTEXT - Create a host context. | |
156 | * | |
157 | * Frees a global context id, and queues a destroy host command for the host. | |
158 | * Does not wait for host completion. The context ID can be used directly | |
159 | * in the command stream and shows up as the same context ID on the host. | |
160 | */ | |
161 | ||
162 | /*************************************************************************/ | |
163 | /** | |
164 | * DRM_VMW_CREATE_SURFACE - Create a host suface. | |
165 | * | |
166 | * Allocates a device unique surface id, and queues a create surface command | |
167 | * for the host. Does not wait for host completion. The surface ID can be | |
168 | * used directly in the command stream and shows up as the same surface | |
169 | * ID on the host. | |
170 | */ | |
171 | ||
172 | /** | |
173 | * struct drm_wmv_surface_create_req | |
174 | * | |
175 | * @flags: Surface flags as understood by the host. | |
176 | * @format: Surface format as understood by the host. | |
177 | * @mip_levels: Number of mip levels for each face. | |
178 | * An unused face should have 0 encoded. | |
179 | * @size_addr: Address of a user-space array of sruct drm_vmw_size | |
180 | * cast to an uint64_t for 32-64 bit compatibility. | |
181 | * The size of the array should equal the total number of mipmap levels. | |
182 | * @shareable: Boolean whether other clients (as identified by file descriptors) | |
183 | * may reference this surface. | |
184 | * | |
185 | * Input data to the DRM_VMW_CREATE_SURFACE Ioctl. | |
186 | * Output data from the DRM_VMW_REF_SURFACE Ioctl. | |
187 | */ | |
188 | ||
189 | struct drm_vmw_surface_create_req { | |
190 | uint32_t flags; | |
191 | uint32_t format; | |
192 | uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES]; | |
193 | uint64_t size_addr; | |
194 | int32_t shareable; | |
195 | uint32_t pad64; | |
196 | }; | |
197 | ||
198 | /** | |
199 | * struct drm_wmv_surface_arg | |
200 | * | |
201 | * @sid: Surface id of created surface or surface to destroy or reference. | |
202 | * | |
203 | * Output data from the DRM_VMW_CREATE_SURFACE Ioctl. | |
204 | * Input argument to the DRM_VMW_UNREF_SURFACE Ioctl. | |
205 | * Input argument to the DRM_VMW_REF_SURFACE Ioctl. | |
206 | */ | |
207 | ||
208 | struct drm_vmw_surface_arg { | |
209 | int32_t sid; | |
210 | uint32_t pad64; | |
211 | }; | |
212 | ||
213 | /** | |
214 | * struct drm_vmw_size ioctl. | |
215 | * | |
216 | * @width - mip level width | |
217 | * @height - mip level height | |
218 | * @depth - mip level depth | |
219 | * | |
220 | * Description of a mip level. | |
221 | * Input data to the DRM_WMW_CREATE_SURFACE Ioctl. | |
222 | */ | |
223 | ||
224 | struct drm_vmw_size { | |
225 | uint32_t width; | |
226 | uint32_t height; | |
227 | uint32_t depth; | |
228 | uint32_t pad64; | |
229 | }; | |
230 | ||
231 | /** | |
232 | * union drm_vmw_surface_create_arg | |
233 | * | |
234 | * @rep: Output data as described above. | |
235 | * @req: Input data as described above. | |
236 | * | |
237 | * Argument to the DRM_VMW_CREATE_SURFACE Ioctl. | |
238 | */ | |
239 | ||
240 | union drm_vmw_surface_create_arg { | |
241 | struct drm_vmw_surface_arg rep; | |
242 | struct drm_vmw_surface_create_req req; | |
243 | }; | |
244 | ||
245 | /*************************************************************************/ | |
246 | /** | |
247 | * DRM_VMW_REF_SURFACE - Reference a host surface. | |
248 | * | |
249 | * Puts a reference on a host surface with a give sid, as previously | |
250 | * returned by the DRM_VMW_CREATE_SURFACE ioctl. | |
251 | * A reference will make sure the surface isn't destroyed while we hold | |
252 | * it and will allow the calling client to use the surface ID in the command | |
253 | * stream. | |
254 | * | |
255 | * On successful return, the Ioctl returns the surface information given | |
256 | * in the DRM_VMW_CREATE_SURFACE ioctl. | |
257 | */ | |
258 | ||
259 | /** | |
260 | * union drm_vmw_surface_reference_arg | |
261 | * | |
262 | * @rep: Output data as described above. | |
263 | * @req: Input data as described above. | |
264 | * | |
265 | * Argument to the DRM_VMW_REF_SURFACE Ioctl. | |
266 | */ | |
267 | ||
268 | union drm_vmw_surface_reference_arg { | |
269 | struct drm_vmw_surface_create_req rep; | |
270 | struct drm_vmw_surface_arg req; | |
271 | }; | |
272 | ||
273 | /*************************************************************************/ | |
274 | /** | |
275 | * DRM_VMW_UNREF_SURFACE - Unreference a host surface. | |
276 | * | |
277 | * Clear a reference previously put on a host surface. | |
278 | * When all references are gone, including the one implicitly placed | |
279 | * on creation, | |
280 | * a destroy surface command will be queued for the host. | |
281 | * Does not wait for completion. | |
282 | */ | |
283 | ||
284 | /*************************************************************************/ | |
285 | /** | |
286 | * DRM_VMW_EXECBUF | |
287 | * | |
288 | * Submit a command buffer for execution on the host, and return a | |
289 | * fence sequence that when signaled, indicates that the command buffer has | |
290 | * executed. | |
291 | */ | |
292 | ||
293 | /** | |
294 | * struct drm_vmw_execbuf_arg | |
295 | * | |
296 | * @commands: User-space address of a command buffer cast to an uint64_t. | |
297 | * @command-size: Size in bytes of the command buffer. | |
298 | * @fence_rep: User-space address of a struct drm_vmw_fence_rep cast to an | |
299 | * uint64_t. | |
300 | * | |
301 | * Argument to the DRM_VMW_EXECBUF Ioctl. | |
302 | */ | |
303 | ||
304 | struct drm_vmw_execbuf_arg { | |
305 | uint64_t commands; | |
306 | uint32_t command_size; | |
307 | uint32_t pad64; | |
308 | uint64_t fence_rep; | |
309 | }; | |
310 | ||
311 | /** | |
312 | * struct drm_vmw_fence_rep | |
313 | * | |
314 | * @fence_seq: Fence sequence associated with a command submission. | |
315 | * @error: This member should've been set to -EFAULT on submission. | |
316 | * The following actions should be take on completion: | |
317 | * error == -EFAULT: Fence communication failed. The host is synchronized. | |
318 | * Use the last fence id read from the FIFO fence register. | |
319 | * error != 0 && error != -EFAULT: | |
320 | * Fence submission failed. The host is synchronized. Use the fence_seq member. | |
321 | * error == 0: All is OK, The host may not be synchronized. | |
322 | * Use the fence_seq member. | |
323 | * | |
324 | * Input / Output data to the DRM_VMW_EXECBUF Ioctl. | |
325 | */ | |
326 | ||
327 | struct drm_vmw_fence_rep { | |
328 | uint64_t fence_seq; | |
329 | int32_t error; | |
330 | uint32_t pad64; | |
331 | }; | |
332 | ||
333 | /*************************************************************************/ | |
334 | /** | |
335 | * DRM_VMW_ALLOC_DMABUF | |
336 | * | |
337 | * Allocate a DMA buffer that is visible also to the host. | |
338 | * NOTE: The buffer is | |
339 | * identified by a handle and an offset, which are private to the guest, but | |
340 | * useable in the command stream. The guest kernel may translate these | |
341 | * and patch up the command stream accordingly. In the future, the offset may | |
342 | * be zero at all times, or it may disappear from the interface before it is | |
343 | * fixed. | |
344 | * | |
345 | * The DMA buffer may stay user-space mapped in the guest at all times, | |
346 | * and is thus suitable for sub-allocation. | |
347 | * | |
348 | * DMA buffers are mapped using the mmap() syscall on the drm device. | |
349 | */ | |
350 | ||
351 | /** | |
352 | * struct drm_vmw_alloc_dmabuf_req | |
353 | * | |
354 | * @size: Required minimum size of the buffer. | |
355 | * | |
356 | * Input data to the DRM_VMW_ALLOC_DMABUF Ioctl. | |
357 | */ | |
358 | ||
359 | struct drm_vmw_alloc_dmabuf_req { | |
360 | uint32_t size; | |
361 | uint32_t pad64; | |
362 | }; | |
363 | ||
364 | /** | |
365 | * struct drm_vmw_dmabuf_rep | |
366 | * | |
367 | * @map_handle: Offset to use in the mmap() call used to map the buffer. | |
368 | * @handle: Handle unique to this buffer. Used for unreferencing. | |
369 | * @cur_gmr_id: GMR id to use in the command stream when this buffer is | |
370 | * referenced. See not above. | |
371 | * @cur_gmr_offset: Offset to use in the command stream when this buffer is | |
372 | * referenced. See note above. | |
373 | * | |
374 | * Output data from the DRM_VMW_ALLOC_DMABUF Ioctl. | |
375 | */ | |
376 | ||
377 | struct drm_vmw_dmabuf_rep { | |
378 | uint64_t map_handle; | |
379 | uint32_t handle; | |
380 | uint32_t cur_gmr_id; | |
381 | uint32_t cur_gmr_offset; | |
382 | uint32_t pad64; | |
383 | }; | |
384 | ||
385 | /** | |
386 | * union drm_vmw_dmabuf_arg | |
387 | * | |
388 | * @req: Input data as described above. | |
389 | * @rep: Output data as described above. | |
390 | * | |
391 | * Argument to the DRM_VMW_ALLOC_DMABUF Ioctl. | |
392 | */ | |
393 | ||
394 | union drm_vmw_alloc_dmabuf_arg { | |
395 | struct drm_vmw_alloc_dmabuf_req req; | |
396 | struct drm_vmw_dmabuf_rep rep; | |
397 | }; | |
398 | ||
399 | /*************************************************************************/ | |
400 | /** | |
401 | * DRM_VMW_UNREF_DMABUF - Free a DMA buffer. | |
402 | * | |
403 | */ | |
404 | ||
405 | /** | |
406 | * struct drm_vmw_unref_dmabuf_arg | |
407 | * | |
408 | * @handle: Handle indicating what buffer to free. Obtained from the | |
409 | * DRM_VMW_ALLOC_DMABUF Ioctl. | |
410 | * | |
411 | * Argument to the DRM_VMW_UNREF_DMABUF Ioctl. | |
412 | */ | |
413 | ||
414 | struct drm_vmw_unref_dmabuf_arg { | |
415 | uint32_t handle; | |
416 | uint32_t pad64; | |
417 | }; | |
418 | ||
419 | /*************************************************************************/ | |
420 | /** | |
421 | * DRM_VMW_FIFO_DEBUG - Get last FIFO submission. | |
422 | * | |
423 | * This IOCTL copies the last FIFO submission directly out of the FIFO buffer. | |
424 | */ | |
425 | ||
426 | /** | |
427 | * struct drm_vmw_fifo_debug_arg | |
428 | * | |
429 | * @debug_buffer: User space address of a debug_buffer cast to an uint64_t //In | |
430 | * @debug_buffer_size: Size in bytes of debug buffer //In | |
431 | * @used_size: Number of bytes copied to the buffer // Out | |
432 | * @did_not_fit: Boolean indicating that the fifo contents did not fit. //Out | |
433 | * | |
434 | * Argument to the DRM_VMW_FIFO_DEBUG Ioctl. | |
435 | */ | |
436 | ||
437 | struct drm_vmw_fifo_debug_arg { | |
438 | uint64_t debug_buffer; | |
439 | uint32_t debug_buffer_size; | |
440 | uint32_t used_size; | |
441 | int32_t did_not_fit; | |
442 | uint32_t pad64; | |
443 | }; | |
444 | ||
445 | struct drm_vmw_fence_wait_arg { | |
446 | uint64_t sequence; | |
447 | uint64_t kernel_cookie; | |
448 | int32_t cookie_valid; | |
449 | int32_t pad64; | |
450 | }; | |
451 | ||
452 | /*************************************************************************/ | |
453 | /** | |
454 | * DRM_VMW_CONTROL_STREAM - Control overlays, aka streams. | |
455 | * | |
456 | * This IOCTL controls the overlay units of the svga device. | |
457 | * The SVGA overlay units does not work like regular hardware units in | |
458 | * that they do not automaticaly read back the contents of the given dma | |
459 | * buffer. But instead only read back for each call to this ioctl, and | |
460 | * at any point between this call being made and a following call that | |
461 | * either changes the buffer or disables the stream. | |
462 | */ | |
463 | ||
464 | /** | |
465 | * struct drm_vmw_rect | |
466 | * | |
467 | * Defines a rectangle. Used in the overlay ioctl to define | |
468 | * source and destination rectangle. | |
469 | */ | |
470 | ||
471 | struct drm_vmw_rect { | |
472 | int32_t x; | |
473 | int32_t y; | |
474 | uint32_t w; | |
475 | uint32_t h; | |
476 | }; | |
477 | ||
478 | /** | |
479 | * struct drm_vmw_control_stream_arg | |
480 | * | |
481 | * @stream_id: Stearm to control | |
482 | * @enabled: If false all following arguments are ignored. | |
483 | * @handle: Handle to buffer for getting data from. | |
484 | * @format: Format of the overlay as understood by the host. | |
485 | * @width: Width of the overlay. | |
486 | * @height: Height of the overlay. | |
487 | * @size: Size of the overlay in bytes. | |
488 | * @pitch: Array of pitches, the two last are only used for YUV12 formats. | |
489 | * @offset: Offset from start of dma buffer to overlay. | |
490 | * @src: Source rect, must be within the defined area above. | |
491 | * @dst: Destination rect, x and y may be negative. | |
492 | * | |
493 | * Argument to the DRM_VMW_CONTROL_STREAM Ioctl. | |
494 | */ | |
495 | ||
496 | struct drm_vmw_control_stream_arg { | |
497 | uint32_t stream_id; | |
498 | uint32_t enabled; | |
499 | ||
500 | uint32_t flags; | |
501 | uint32_t color_key; | |
502 | ||
503 | uint32_t handle; | |
504 | uint32_t offset; | |
505 | int32_t format; | |
506 | uint32_t size; | |
507 | uint32_t width; | |
508 | uint32_t height; | |
509 | uint32_t pitch[3]; | |
510 | ||
511 | uint32_t pad64; | |
512 | struct drm_vmw_rect src; | |
513 | struct drm_vmw_rect dst; | |
514 | }; | |
515 | ||
516 | /*************************************************************************/ | |
517 | /** | |
518 | * DRM_VMW_CURSOR_BYPASS - Give extra information about cursor bypass. | |
519 | * | |
520 | */ | |
521 | ||
522 | #define DRM_VMW_CURSOR_BYPASS_ALL (1 << 0) | |
523 | #define DRM_VMW_CURSOR_BYPASS_FLAGS (1) | |
524 | ||
525 | /** | |
526 | * struct drm_vmw_cursor_bypass_arg | |
527 | * | |
528 | * @flags: Flags. | |
529 | * @crtc_id: Crtc id, only used if DMR_CURSOR_BYPASS_ALL isn't passed. | |
530 | * @xpos: X position of cursor. | |
531 | * @ypos: Y position of cursor. | |
532 | * @xhot: X hotspot. | |
533 | * @yhot: Y hotspot. | |
534 | * | |
535 | * Argument to the DRM_VMW_CURSOR_BYPASS Ioctl. | |
536 | */ | |
537 | ||
538 | struct drm_vmw_cursor_bypass_arg { | |
539 | uint32_t flags; | |
540 | uint32_t crtc_id; | |
541 | int32_t xpos; | |
542 | int32_t ypos; | |
543 | int32_t xhot; | |
544 | int32_t yhot; | |
545 | }; | |
546 | ||
547 | /*************************************************************************/ | |
548 | /** | |
549 | * DRM_VMW_CLAIM_STREAM - Claim a single stream. | |
550 | */ | |
551 | ||
552 | /** | |
553 | * struct drm_vmw_context_arg | |
554 | * | |
555 | * @stream_id: Device unique context ID. | |
556 | * | |
557 | * Output argument to the DRM_VMW_CREATE_CONTEXT Ioctl. | |
558 | * Input argument to the DRM_VMW_UNREF_CONTEXT Ioctl. | |
559 | */ | |
560 | ||
561 | struct drm_vmw_stream_arg { | |
562 | uint32_t stream_id; | |
563 | uint32_t pad64; | |
564 | }; | |
565 | ||
566 | /*************************************************************************/ | |
567 | /** | |
568 | * DRM_VMW_UNREF_STREAM - Unclaim a stream. | |
569 | * | |
570 | * Return a single stream that was claimed by this process. Also makes | |
571 | * sure that the stream has been stopped. | |
572 | */ | |
573 | ||
574 | #endif |