1/* $NetBSD: granttables.h,v 1.8 2011/09/20 00:12:23 jym Exp $ */
2/*
3 * Copyright (c) 2006 Manuel Bouyer.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 *
25 */
26
27/* Interface to the Xen Grant tables */
28#include <xen/xen-public/xen.h>
29#include <xen/xen-public/grant_table.h>
30
31void xengnt_init(void);
32
33/* suspend/resume grant table, for save/restore operations */
34bool xengnt_suspend(void);
35bool xengnt_resume(void);
36
37/*
38 * grant access to a remote domain. Returns a handle on the allocated grant
39 * entry in table in grant_ref_t *.
40 */
41int xengnt_grant_access(domid_t, paddr_t, int, grant_ref_t *);
42
43/*
44 * Revoke access. Caller is responsible to ensure that the grant entry is
45 * not referenced any more.
46 */
47void xengnt_revoke_access(grant_ref_t);
48
49/* allow a page transfer from a remote domain */
50int xengnt_grant_transfer(domid_t, grant_ref_t *);
51
52/* end transfer, return the new page address or 0 */
53paddr_t xengnt_revoke_transfer(grant_ref_t);
54
55/*
56 * Query grant status (i.e. if remote has a valid mapping to this grant).
57 * Returns GTF_reading | GTF_writing (0 if remote does not use it anymore).
58 */
59int xengnt_status(grant_ref_t);
60