path: root/vmwgfx/vmwgfx_drmi.c

/*
 * Copyright 2011 VMWare, Inc.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * Author: Jakob Bornecrantz <wallbraker@gmail.com>
 * Author: Thomas Hellstrom <thellstrom@vmware.com>
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdint.h>
#include <errno.h>
#include <sys/mman.h>
#include "vmwgfx_drm.h"
#include <xf86drm.h>
#include "vmwgfx_drmi.h"

#define uint32 uint32_t
#define int32 int32_t
#define uint16 uint16_t
#define uint8 uint8_t

#include "svga3d_reg.h"
#include "vmwgfx_driver.h"
#include "common_compat.h"

static int
vmwgfx_fence_wait(int drm_fd, uint32_t handle, Bool unref)
{
	struct drm_vmw_fence_wait_arg farg;
	memset(&farg, 0, sizeof(farg));

	farg.handle = handle;
	farg.flags = DRM_VMW_FENCE_FLAG_EXEC;
	farg.timeout_us = 10*1000000;
	farg.cookie_valid = 0;

	if (unref)
	    farg.wait_options |= DRM_VMW_WAIT_OPTION_UNREF;

	return drmCommandWriteRead(drm_fd, DRM_VMW_FENCE_WAIT, &farg,
				   sizeof(farg));
}

static void
vmwgfx_fence_unref(int drm_fd, uint32_t handle)
{
	struct drm_vmw_fence_arg farg;
	memset(&farg, 0, sizeof(farg));

	farg.handle = handle;

	(void) drmCommandWrite(drm_fd, DRM_VMW_FENCE_UNREF, &farg,
			       sizeof(farg));
}


int
vmwgfx_present_readback(int drm_fd, uint32_t fb_id, RegionPtr region)
{
    BoxPtr clips = REGION_RECTS(region);
    unsigned int num_clips = REGION_NUM_RECTS(region);
    struct drm_vmw_fence_rep rep;
    struct drm_vmw_present_readback_arg arg;
    int ret;
    unsigned i;
    struct drm_vmw_rect *rects, *r;

    rects = calloc(num_clips, sizeof(*rects));
    if (!rects) {
	LogMessage(X_ERROR, "Failed to alloc cliprects for "
		   "present readback.\n");
	return -1;
    }

    memset(&arg, 0, sizeof(arg));
    memset(&rep, 0, sizeof(rep));

    arg.fb_id = fb_id;
    arg.num_clips = num_clips;
    arg.clips_ptr = (unsigned long) rects;
    arg.fence_rep = (unsigned long) &rep;
    rep.error = -EFAULT;

    for (i = 0, r = rects; i < num_clips; ++i, ++r, ++clips) {
	r->x = clips->x1;
	r->y = clips->y1;
	r->w = clips->x2 - clips->x1;
	r->h = clips->y2 - clips->y1;
    }

    ret = drmCommandWrite(drm_fd, DRM_VMW_PRESENT_READBACK, &arg, sizeof(arg));
    if (ret)
	LogMessage(X_ERROR, "Present readback error %s.\n", strerror(-ret));
    free(rects);

    /*
     * Sync to avoid racing with Xorg SW rendering.
     */

    if (rep.error == 0) {
	ret = vmwgfx_fence_wait(drm_fd, rep.handle, TRUE);
	if (ret) {
	    LogMessage(X_ERROR, "Present readback fence wait error %s.\n",
		       strerror(-ret));
	    vmwgfx_fence_unref(drm_fd, rep.handle);
	}
    }

    return 0;
}


int
vmwgfx_present(int drm_fd, uint32_t fb_id, unsigned int dst_x,
	       unsigned int dst_y, RegionPtr region, uint32_t handle)
{
    BoxPtr clips = REGION_RECTS(region);
    unsigned int num_clips = REGION_NUM_RECTS(region);
    unsigned int alloc_clips = min(num_clips, DRM_MODE_FB_DIRTY_MAX_CLIPS);
    struct drm_vmw_present_arg arg;
    unsigned int i;
    struct drm_vmw_rect *rects, *r;
    int ret;

    if (num_clips == 0)
	return 0;

    rects = malloc(alloc_clips * sizeof(*rects));
    if (!rects) {
	LogMessage(X_ERROR, "Failed to alloc cliprects for "
		   "present.\n");
	return -1;
    }

    while (num_clips > 0) {
	unsigned int cur_clips = min(num_clips, DRM_MODE_FB_DIRTY_MAX_CLIPS);

	memset(&arg, 0, sizeof(arg));
	memset(rects, 0, alloc_clips * sizeof(*rects));
	arg.fb_id = fb_id;
	arg.sid = handle;
	arg.dest_x = dst_x;
	arg.dest_y = dst_y;
	arg.num_clips = cur_clips;
	arg.clips_ptr = (unsigned long) rects;

	for (i = 0, r = rects; i < cur_clips; ++i, ++r, ++clips) {
	    r->x = clips->x1;
	    r->y = clips->y1;
	    r->w = clips->x2 - clips->x1;
	    r->h = clips->y2 - clips->y1;
	}

	ret = drmCommandWrite(drm_fd, DRM_VMW_PRESENT, &arg, sizeof(arg));
	if (ret)
	    LogMessage(X_ERROR, "Present error %s.\n", strerror(-ret));

	num_clips -= cur_clips;
    }

    free(rects);

    return 0;
}


struct vmwgfx_int_dmabuf {
    struct vmwgfx_dmabuf buf;
    uint64_t map_handle;
    uint64_t sync_handle;
    int sync_valid;
    int drm_fd;
    uint32_t map_count;
    void *addr;
};

static inline struct vmwgfx_int_dmabuf *
vmwgfx_int_dmabuf(struct vmwgfx_dmabuf *buf)
{
    return (struct vmwgfx_int_dmabuf *) buf;
}

struct vmwgfx_dmabuf*
vmwgfx_dmabuf_alloc(int drm_fd, size_t size)
{
    union drm_vmw_alloc_dmabuf_arg arg;
    struct vmwgfx_dmabuf *buf;
    struct vmwgfx_int_dmabuf *ibuf;
    int ret;

    ibuf = calloc(1, sizeof(*ibuf));
    if (!ibuf)
	return NULL;

    buf = &ibuf->buf;
    memset(&arg, 0, sizeof(arg));
    arg.req.size = size;

    ret = drmCommandWriteRead(drm_fd, DRM_VMW_ALLOC_DMABUF, &arg,
			      sizeof(arg));
    if (ret)
	goto out_kernel_fail;

    ibuf = vmwgfx_int_dmabuf(buf);
    ibuf->map_handle = arg.rep.map_handle;
    ibuf->drm_fd = drm_fd;
    buf->handle = arg.rep.handle;
    buf->gmr_id = arg.rep.cur_gmr_id;
    buf->gmr_offset = arg.rep.cur_gmr_offset;
    buf->size = size;

    return buf;
  out_kernel_fail:
    free(buf);
    return NULL;
}

void *
vmwgfx_dmabuf_map(struct vmwgfx_dmabuf *buf)
{
    struct vmwgfx_int_dmabuf *ibuf = vmwgfx_int_dmabuf(buf);

    if (ibuf->addr)
	return ibuf->addr;

    ibuf->addr =  mmap(NULL, buf->size, PROT_READ | PROT_WRITE, MAP_SHARED,
		       ibuf->drm_fd, ibuf->map_handle);

    if (ibuf->addr == MAP_FAILED) {
	ibuf->addr = NULL;
	return NULL;
    }

    ibuf->map_count++;
    return ibuf->addr;
}

void
vmwgfx_dmabuf_unmap(struct vmwgfx_dmabuf *buf)
{
    struct vmwgfx_int_dmabuf *ibuf = vmwgfx_int_dmabuf(buf);

    if (--ibuf->map_count)
	return;

    /*
     * It's a pretty important performance optimzation not to call
     * munmap here, although we should watch out for cases where we might fill
     * the virtual memory space of the process.
     */
}

void
vmwgfx_dmabuf_destroy(struct vmwgfx_dmabuf *buf)
{
    struct vmwgfx_int_dmabuf *ibuf = vmwgfx_int_dmabuf(buf);
    struct drm_vmw_unref_dmabuf_arg arg;

    if (ibuf->addr) {
	munmap(ibuf->addr, buf->size);
	ibuf->addr = NULL;
    }

    memset(&arg, 0, sizeof(arg));
    arg.handle = buf->handle;

    (void) drmCommandWrite(ibuf->drm_fd, DRM_VMW_UNREF_DMABUF, &arg,
			   sizeof(arg));
    free(buf);
}

int
vmwgfx_dma(int host_x, int host_y,
	   RegionPtr region, struct vmwgfx_dmabuf *buf,
	   uint32_t buf_pitch, uint32_t surface_handle, int to_surface)
{
    BoxPtr clips = REGION_RECTS(region);
    unsigned int num_clips = REGION_NUM_RECTS(region);
    struct drm_vmw_execbuf_arg arg;
    struct drm_vmw_fence_rep rep;
    int ret;
    unsigned i;
    SVGA3dCopyBox *cb;
    SVGA3dCmdSurfaceDMASuffix *suffix;
    SVGA3dCmdSurfaceDMA *body;
    struct vmwgfx_int_dmabuf *ibuf = vmwgfx_int_dmabuf(buf);
    struct {
	SVGA3dCmdHeader header;
	SVGA3dCmdSurfaceDMA body;
	SVGA3dCopyBox cb;
    } *cmd;
    static unsigned int max_clips =
	(SVGA_CB_MAX_COMMAND_SIZE - sizeof(*cmd) - sizeof(*suffix)) /
	sizeof(cmd->cb) + 1;

    while (num_clips > 0) {
	unsigned int size;
	unsigned int cur_clips;

	cur_clips = min(num_clips, max_clips);
	size = sizeof(*cmd) + (cur_clips - 1) * sizeof(cmd->cb) +
	    sizeof(*suffix);

	cmd = calloc(1, size);
	if (!cmd)
	    return -1;

	cmd->header.id = SVGA_3D_CMD_SURFACE_DMA;
	cmd->header.size = sizeof(cmd->body) + cur_clips * sizeof(cmd->cb) +
	    sizeof(*suffix);
	cb = &cmd->cb;

	suffix = (SVGA3dCmdSurfaceDMASuffix *) &cb[cur_clips];
	suffix->suffixSize = sizeof(*suffix);
	suffix->maximumOffset = (uint32_t) -1;
	suffix->flags.discard = 0;
	suffix->flags.unsynchronized = 0;
	suffix->flags.reserved = 0;

	body = &cmd->body;
	body->guest.ptr.gmrId = buf->gmr_id;
	body->guest.ptr.offset = buf->gmr_offset;
	body->guest.pitch = buf_pitch;
	body->host.sid = surface_handle;
	body->host.face = 0;
	body->host.mipmap = 0;

	body->transfer = (to_surface ? SVGA3D_WRITE_HOST_VRAM :
			  SVGA3D_READ_HOST_VRAM);

	for (i = 0; i < cur_clips; i++, cb++, clips++) {
	    cb->x = (uint16_t) clips->x1 + host_x;
	    cb->y = (uint16_t) clips->y1 + host_y;
	    cb->z = 0;
	    cb->srcx = (uint16_t) clips->x1;
	    cb->srcy = (uint16_t) clips->y1;
	    cb->srcz = 0;
	    cb->w = (uint16_t) (clips->x2 - clips->x1);
	    cb->h = (uint16_t) (clips->y2 - clips->y1);
	    cb->d = 1;
#if 0
	    LogMessage(X_INFO, "DMA! x: %u y: %u srcx: %u srcy: %u w: %u h: %u %s\n",
		       cb->x, cb->y, cb->srcx, cb->srcy, cb->w, cb->h,
		       to_surface ? "to" : "from");
#endif

	}

	memset(&arg, 0, sizeof(arg));
	memset(&rep, 0, sizeof(rep));

	rep.error = -EFAULT;

	/* Only require a fence if readback and last batch of cliprects. */
	arg.fence_rep = ((to_surface && (cur_clips == num_clips)) ?
			 0UL : (unsigned long) &rep);
	arg.commands = (unsigned long)cmd;
	arg.command_size = size;
	arg.throttle_us = 0;
	arg.version = DRM_VMW_EXECBUF_VERSION;

	ret = drmCommandWrite(ibuf->drm_fd, DRM_VMW_EXECBUF, &arg, sizeof(arg));
	if (ret) {
	    LogMessage(X_ERROR, "DMA error %s.\n", strerror(-ret));
	}

	free(cmd);
	num_clips -= cur_clips;

	if (rep.error == 0) {
	    ret = vmwgfx_fence_wait(ibuf->drm_fd, rep.handle, TRUE);
	    if (ret) {
		LogMessage(X_ERROR, "DMA from host fence wait error %s.\n",
			   strerror(-ret));
		/* vmwgfx_fence_wait() takes care of this if ret == 0. */
		vmwgfx_fence_unref(ibuf->drm_fd, rep.handle);
	    }
	}
    }

    return 0;
}

int
vmwgfx_get_param(int drm_fd, uint32_t param, uint64_t *out)
{
    struct drm_vmw_getparam_arg gp_arg;
    int ret;

    memset(&gp_arg, 0, sizeof(gp_arg));
    gp_arg.param = param;
    ret = drmCommandWriteRead(drm_fd, DRM_VMW_GET_PARAM,
	    &gp_arg, sizeof(gp_arg));

    if (ret == 0) {
	*out = gp_arg.value;
    }

    return ret;
}

int
vmwgfx_num_streams(int drm_fd, uint32_t *ntot, uint32_t *nfree)
{
    uint64_t v1, v2;
    int ret;

    ret = vmwgfx_get_param(drm_fd, DRM_VMW_PARAM_NUM_STREAMS, &v1);
    if (ret)
	return ret;

    ret = vmwgfx_get_param(drm_fd, DRM_VMW_PARAM_NUM_FREE_STREAMS, &v2);
    if (ret)
	return ret;

    *ntot = (uint32_t)v1;
    *nfree = (uint32_t)v2;

    return 0;
}

int
vmwgfx_claim_stream(int drm_fd, uint32_t *out)
{
    struct drm_vmw_stream_arg s_arg;
    int ret;

    ret = drmCommandRead(drm_fd, DRM_VMW_CLAIM_STREAM,
			 &s_arg, sizeof(s_arg));

    if (ret)
	return -1;

    *out = s_arg.stream_id;
    return 0;
}

int
vmwgfx_unref_stream(int drm_fd, uint32_t stream_id)
{
    struct drm_vmw_stream_arg s_arg;
    int ret;

    memset(&s_arg, 0, sizeof(s_arg));
    s_arg.stream_id = stream_id;

    ret = drmCommandWrite(drm_fd, DRM_VMW_UNREF_STREAM,
			  &s_arg, sizeof(s_arg));

    return (ret != 0) ? -1 : 0;
}

int
vmwgfx_cursor_bypass(int drm_fd, int xhot, int yhot)
{
    struct drm_vmw_cursor_bypass_arg arg;
    int ret;

    memset(&arg, 0, sizeof(arg));
    arg.flags = DRM_VMW_CURSOR_BYPASS_ALL;
    arg.xhot = xhot;
    arg.yhot = yhot;

    ret = drmCommandWrite(drm_fd, DRM_VMW_CURSOR_BYPASS,
			  &arg, sizeof(arg));

    return ret;
}

int
vmwgfx_update_gui_layout(int drm_fd, unsigned int num_rects,
			 struct drm_vmw_rect *rects)
{
    struct drm_vmw_update_layout_arg arg;

    memset(&arg, 0, sizeof(arg));

    arg.num_outputs = num_rects;
    arg.rects = (unsigned long) rects;

    return drmCommandWrite(drm_fd, DRM_VMW_UPDATE_LAYOUT, &arg,
			   sizeof(arg));
}


int
vmwgfx_max_fb_size(int drm_fd, size_t *size)
{
    uint64_t tmp_size;

    if (vmwgfx_get_param(drm_fd, DRM_VMW_PARAM_MAX_FB_SIZE, &tmp_size) != 0)
	return -1;

    *size = tmp_size;

    return 0;
}

#ifdef HAVE_LIBDRM_2_4_38
/**
 * vmwgfx_prime_fd_to_handle - Return a TTM handle to a prime object
 *
 * @drm_fd: File descriptor for the drm connection.
 * @prime_fd: File descriptor identifying the prime object.
 * @handle: Pointer to returned TTM handle.
 *
 * Takes a reference on the underlying object and returns a TTM handle to it.
 */
int
vmwgfx_prime_fd_to_handle(int drm_fd, int prime_fd, uint32_t *handle)
{
    *handle = 0;

    return drmPrimeFDToHandle(drm_fd, prime_fd, handle);
}

/**
 * vmwgfx_prime_release_handle - Release a reference on a TTM object
 *
 * @drm_fd: File descriptor for the drm connection.
 * @handle: TTM handle as returned by vmwgfx_prime_fd_to_handle.
 *
 * Releases the reference obtained by vmwgfx_prime_fd_to_handle().
 */
void
vmwgfx_prime_release_handle(int drm_fd, uint32_t handle)
{
    struct drm_vmw_surface_arg s_arg;

    memset(&s_arg, 0, sizeof(s_arg));
    s_arg.sid = handle;

    (void) drmCommandWrite(drm_fd, DRM_VMW_UNREF_SURFACE, &s_arg,
			   sizeof(s_arg));
}
#endif /* HAVE_LIBDRM_2_4_38 */