diff options
author | Ian Jackson <ian.jackson@eu.citrix.com> | 2011-11-29 15:48:07 +0000 |
---|---|---|
committer | Ian Jackson <ian.jackson@eu.citrix.com> | 2011-11-29 15:48:07 +0000 |
commit | 262e118a370a55e47fc5d46ff169e9049b8defaf (patch) | |
tree | 0fe0037ab35a837fba1180f64b55cc554ba2ec1d /xen/include/public/xen.h | |
parent | 445e84f517a14e0ec583de4928fbc421944d6d1b (diff) | |
download | xen-262e118a370a55e47fc5d46ff169e9049b8defaf.tar.gz xen-262e118a370a55e47fc5d46ff169e9049b8defaf.tar.bz2 xen-262e118a370a55e47fc5d46ff169e9049b8defaf.zip |
docs/html/: Annotations for two hypercalls
Add annotations for a couple of the hypercalls:
HYPERVISOR_set_trap_table
HYPERVISOR_mmu_update
We do this by
* annotating the list of #defines for hypercall numbers
* annotating the list of error values
* providing a function prototype for the systematically-named functions
The header generator does the rest.
This exercise revealed a couple of infelicities:
* In the actual source code, do_mmu_update is defined to return an int
and do_set_trap_table a long. However both functions return either
-Efoo (on error) or 0 for success.
* The error numbers are defined only in the private header file
xen/include/xen/errno.h and then only with names which will
typically clash with other projects. It would be nice to include a
public version of this header which defines XEN_E*. But for now
we run xen-headers on errno.h too.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Diffstat (limited to 'xen/include/public/xen.h')
-rw-r--r-- | xen/include/public/xen.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/xen/include/public/xen.h b/xen/include/public/xen.h index fde9fa5091..f2c9e6fc97 100644 --- a/xen/include/public/xen.h +++ b/xen/include/public/xen.h @@ -55,6 +55,8 @@ DEFINE_XEN_GUEST_HANDLE(xen_pfn_t); * HYPERCALLS */ +/* ` enum hypercall_num { // __HYPERVISOR_* => HYPERVISOR_*() */ + #define __HYPERVISOR_set_trap_table 0 #define __HYPERVISOR_mmu_update 1 #define __HYPERVISOR_set_gdt 2 @@ -105,6 +107,8 @@ DEFINE_XEN_GUEST_HANDLE(xen_pfn_t); #define __HYPERVISOR_arch_6 54 #define __HYPERVISOR_arch_7 55 +/* ` } */ + /* * HYPERCALL COMPATIBILITY. */ @@ -163,8 +167,11 @@ DEFINE_XEN_GUEST_HANDLE(xen_pfn_t); #define NR_VIRQS 24 /* - * HYPERVISOR_mmu_update(reqs, count, pdone, foreigndom) - * + * ` enum neg_errnoval + * ` HYPERVISOR_mmu_update(const struct mmu_update reqs[], + * ` unsigned count, unsigned *done_out, + * ` unsigned foreigndom) + * ` * @reqs is an array of mmu_update_t structures ((ptr, val) pairs). * @count is the length of the above array. * @pdone is an output parameter indicating number of completed operations |