xref: /netbsd-src/sys/arch/xen/include/granttables.h (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /* $NetBSD: granttables.h,v 1.6 2008/10/30 09:24:37 cegger 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 <xen/xen3-public/xen.h>
34 #include <xen/xen3-public/grant_table.h>
35 
36 void xengnt_init(void);
37 
38 /*
39  * grant access to a remote domain. Returns a handle on the allocated grant
40  * entry in table in grant_ref_t *.
41  */
42 int xengnt_grant_access(domid_t, paddr_t, int, grant_ref_t *);
43 
44 /*
45  * Revoke access. Caller is responsible to ensure that the grant entry is
46  * not referenced any more.
47  */
48 void xengnt_revoke_access(grant_ref_t);
49 
50 /* allow a page transfer from a remote domain */
51 int xengnt_grant_transfer(domid_t, grant_ref_t *);
52 
53 /* end transfer, return the new page address or 0 */
54 paddr_t xengnt_revoke_transfer(grant_ref_t);
55 
56 /*
57  * Query grant status (i.e. if remote has a valid mapping to this grant).
58  * Returns GTF_reading | GTF_writing (0 if remote does not use it anymore).
59  */
60 int xengnt_status(grant_ref_t);
61