OvmfPkg[all]  0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
grant_table.h File Reference

Data Structures

struct  grant_entry_v1
 
struct  grant_entry_header
 
union  grant_entry_v2
 
struct  gnttab_map_grant_ref
 
struct  gnttab_unmap_grant_ref
 

Macros

#define GNTTAB_NR_RESERVED_ENTRIES   8
 
#define GNTTAB_RESERVED_CONSOLE   0
 
#define GNTTAB_RESERVED_XENSTORE   1
 
#define GTF_invalid   (0U<<0)
 
#define GTF_permit_access   (1U<<0)
 
#define GTF_accept_transfer   (2U<<0)
 
#define GTF_transitive   (3U<<0)
 
#define GTF_type_mask   (3U<<0)
 
#define _GTF_readonly   (2)
 
#define GTF_readonly   (1U<<_GTF_readonly)
 
#define _GTF_reading   (3)
 
#define GTF_reading   (1U<<_GTF_reading)
 
#define _GTF_writing   (4)
 
#define GTF_writing   (1U<<_GTF_writing)
 
#define _GTF_PWT   (5)
 
#define GTF_PWT   (1U<<_GTF_PWT)
 
#define _GTF_PCD   (6)
 
#define GTF_PCD   (1U<<_GTF_PCD)
 
#define _GTF_PAT   (7)
 
#define GTF_PAT   (1U<<_GTF_PAT)
 
#define _GTF_sub_page   (8)
 
#define GTF_sub_page   (1U<<_GTF_sub_page)
 
#define _GTF_transfer_committed   (2)
 
#define GTF_transfer_committed   (1U<<_GTF_transfer_committed)
 
#define _GTF_transfer_completed   (3)
 
#define GTF_transfer_completed   (1U<<_GTF_transfer_completed)
 
#define GNTTABOP_map_grant_ref   0
 
#define GNTTABOP_unmap_grant_ref   1
 
#define _GNTMAP_device_map   (0)
 
#define GNTMAP_device_map   (1<<_GNTMAP_device_map)
 
#define _GNTMAP_host_map   (1)
 
#define GNTMAP_host_map   (1<<_GNTMAP_host_map)
 
#define _GNTMAP_readonly   (2)
 
#define GNTMAP_readonly   (1<<_GNTMAP_readonly)
 
#define _GNTMAP_application_map   (3)
 
#define GNTMAP_application_map   (1<<_GNTMAP_application_map)
 
#define _GNTMAP_contains_pte   (4)
 
#define GNTMAP_contains_pte   (1<<_GNTMAP_contains_pte)
 
#define _GNTMAP_can_fail   (5)
 
#define GNTMAP_can_fail   (1<<_GNTMAP_can_fail)
 
#define _GNTMAP_guest_avail0   (16)
 
#define GNTMAP_guest_avail_mask   ((UINT32)~0 << _GNTMAP_guest_avail0)
 
#define GNTST_okay   (0) /* Normal return. */
 
#define GNTST_general_error   (-1) /* General undefined error. */
 
#define GNTST_bad_domain   (-2) /* Unrecognised domain id. */
 
#define GNTST_bad_gntref   (-3) /* Unrecognised or inappropriate gntref. */
 
#define GNTST_bad_handle   (-4) /* Unrecognised or inappropriate handle. */
 
#define GNTST_bad_virt_addr   (-5) /* Inappropriate virtual address to map. */
 
#define GNTST_bad_dev_addr   (-6) /* Inappropriate device address to unmap.*/
 
#define GNTST_no_device_space   (-7) /* Out of space in I/O MMU. */
 
#define GNTST_permission_denied   (-8) /* Not enough privilege for operation. */
 
#define GNTST_bad_page   (-9) /* Specified page was invalid for op. */
 
#define GNTST_bad_copy_arg   (-10) /* copy arguments cross page boundary. */
 
#define GNTST_address_too_big   (-11) /* transfer page address too large. */
 
#define GNTST_eagain   (-12) /* Operation not done; try again. */
 
#define GNTTABOP_error_msgs
 

Typedefs

typedef UINT32 grant_ref_t
 
typedef struct grant_entry_v1 grant_entry_v1_t
 
typedef struct grant_entry_header grant_entry_header_t
 
typedef union grant_entry_v2 grant_entry_v2_t
 
typedef UINT16 grant_status_t
 
typedef UINT32 grant_handle_t
 
typedef struct gnttab_map_grant_ref gnttab_map_grant_ref_t
 
typedef struct
gnttab_unmap_grant_ref 
gnttab_unmap_grant_ref_t
 

Functions

 DEFINE_XEN_GUEST_HANDLE (gnttab_map_grant_ref_t)
 
 DEFINE_XEN_GUEST_HANDLE (gnttab_unmap_grant_ref_t)
 

Macro Definition Documentation

#define _GNTMAP_application_map   (3)
#define _GNTMAP_can_fail   (5)
#define _GNTMAP_contains_pte   (4)
#define _GNTMAP_device_map   (0)
#define _GNTMAP_guest_avail0   (16)
#define _GNTMAP_host_map   (1)
#define _GNTMAP_readonly   (2)
#define _GTF_PAT   (7)
#define _GTF_PCD   (6)
#define _GTF_PWT   (5)
#define _GTF_reading   (3)
#define _GTF_readonly   (2)
#define _GTF_sub_page   (8)
#define _GTF_transfer_committed   (2)
#define _GTF_transfer_completed   (3)
#define _GTF_writing   (4)
#define GNTMAP_application_map   (1<<_GNTMAP_application_map)
#define GNTMAP_can_fail   (1<<_GNTMAP_can_fail)
#define GNTMAP_contains_pte   (1<<_GNTMAP_contains_pte)
#define GNTMAP_device_map   (1<<_GNTMAP_device_map)
#define GNTMAP_guest_avail_mask   ((UINT32)~0 << _GNTMAP_guest_avail0)
#define GNTMAP_host_map   (1<<_GNTMAP_host_map)
#define GNTMAP_readonly   (1<<_GNTMAP_readonly)
#define GNTST_address_too_big   (-11) /* transfer page address too large. */
#define GNTST_bad_copy_arg   (-10) /* copy arguments cross page boundary. */
#define GNTST_bad_dev_addr   (-6) /* Inappropriate device address to unmap.*/
#define GNTST_bad_domain   (-2) /* Unrecognised domain id. */
#define GNTST_bad_gntref   (-3) /* Unrecognised or inappropriate gntref. */
#define GNTST_bad_handle   (-4) /* Unrecognised or inappropriate handle. */
#define GNTST_bad_page   (-9) /* Specified page was invalid for op. */
#define GNTST_bad_virt_addr   (-5) /* Inappropriate virtual address to map. */
#define GNTST_eagain   (-12) /* Operation not done; try again. */
#define GNTST_general_error   (-1) /* General undefined error. */
#define GNTST_no_device_space   (-7) /* Out of space in I/O MMU. */
#define GNTST_okay   (0) /* Normal return. */
#define GNTST_permission_denied   (-8) /* Not enough privilege for operation. */
#define GNTTAB_NR_RESERVED_ENTRIES   8
#define GNTTAB_RESERVED_CONSOLE   0
#define GNTTAB_RESERVED_XENSTORE   1
#define GNTTABOP_error_msgs
Value:
{ \
"okay", \
"undefined error", \
"unrecognised domain id", \
"invalid grant reference", \
"invalid mapping handle", \
"invalid virtual address", \
"invalid device address", \
"no spare translation slot in the I/O MMU", \
"permission denied", \
"bad page", \
"copy arguments cross page boundary", \
"page address size too large", \
"operation not done; try again" \
}
#define GNTTABOP_map_grant_ref   0
#define GNTTABOP_unmap_grant_ref   1
#define GTF_accept_transfer   (2U<<0)
#define GTF_invalid   (0U<<0)
#define GTF_PAT   (1U<<_GTF_PAT)
#define GTF_PCD   (1U<<_GTF_PCD)
#define GTF_permit_access   (1U<<0)
#define GTF_PWT   (1U<<_GTF_PWT)
#define GTF_reading   (1U<<_GTF_reading)
#define GTF_readonly   (1U<<_GTF_readonly)
#define GTF_sub_page   (1U<<_GTF_sub_page)
#define GTF_transfer_committed   (1U<<_GTF_transfer_committed)
#define GTF_transfer_completed   (1U<<_GTF_transfer_completed)
#define GTF_transitive   (3U<<0)
#define GTF_type_mask   (3U<<0)
#define GTF_writing   (1U<<_GTF_writing)

Typedef Documentation

typedef UINT16 grant_status_t

Function Documentation

DEFINE_XEN_GUEST_HANDLE ( gnttab_map_grant_ref_t  )
DEFINE_XEN_GUEST_HANDLE ( gnttab_unmap_grant_ref_t  )