granttables.h revision 1.1 
1/* $NetBSD: granttables.h,v 1.1 2006/03/06 20:30:40 bouyer 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 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *      This product includes software developed by Manuel Bouyer.
16 * 4. The name of the author may not be used to endorse or promote products
17 *    derived from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 */
31
32/* Interface to the Xen Grant tables */
33#include <machine/xen3-public/grant_table.h>
34
35/* must be less or equal to what's configured in Xen */
36#define NR_GRANT_FRAMES 4
37
38void xengnt_init(void);
39
40/*
41 * grant access to a remote domain. Returns a handle on the allocated grant
42 * entry in table in grant_ref_t *.
43 */
44int xengnt_grant_access(domid_t, paddr_t, int, grant_ref_t *);
45
46/*
47 * Revoke access. Caller is responsible to ensure that the grant entry is
48 * not referenced any more.
49 */
50void xengnt_revoke_access(grant_ref_t);
51
52/* allow a page transfer from a remote domain */
53int xengnt_grant_transfer(domid_t, grant_ref_t *);
54
55/* end transfer, return the new page address or 0 */
56paddr_t xengnt_revoke_transfer(grant_ref_t);
57
58/*
59 * Query grant status (i.e. if remote has a valid mapping to this grant).
60 * Returns GTF_reading | GTF_writing.
61 */
62int xengnt_status(grant_ref_t);
63