Documentation: Improve hypercall subsystem description

[jailhouse.git] / hypervisor / include / jailhouse / hypercall.h

diff --git a/hypervisor/include/jailhouse/hypercall.h b/hypervisor/include/jailhouse/hypercall.h
index 0087d661861e85db57427aca61efd9aecc559449..92c9fee1f9bf89ea80ca505736bd5d5aeb20e8c1 100644 (file)
--- a/hypervisor/include/jailhouse/hypercall.h
+++ b/hypervisor/include/jailhouse/hypercall.h
@@ -88,11 +88,16 @@
 #define JAILHOUSE_CELL_SHUT_DOWN               2 /* terminal state */
 #define JAILHOUSE_CELL_FAILED                  3 /* terminal state */
 
-#define COMM_REGION_GENERIC_HEADER             \
-       volatile __u32 msg_to_cell;             \
-       volatile __u32 reply_from_cell;         \
-       volatile __u32 cell_state;              \
-       volatile __u32 padding
+#define COMM_REGION_GENERIC_HEADER                                     \
+       /** Message code sent from hypervisor to cell. */               \
+       volatile __u32 msg_to_cell;                                     \
+       /** Reply code sent from cell to hypervisor. */                 \
+       volatile __u32 reply_from_cell;                                 \
+       /** Cell state, initialized by hypervisor, updated by cell. */  \
+       volatile __u32 cell_state;                                      \
+       /** \privatesection */                                          \
+       volatile __u32 padding;                                         \
+       /** \publicsection */
 
 #include <asm/jailhouse_hypercall.h>