src/gallium/winsys/drm/vmware/core/vmwgfx_drm.h

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