Mailing List Archive

Convert in-code comments to kernel-doc format wherever possible.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
---
Changes in v2:
- use oneline comments even for nested struct members
- remove redundant "EVTCHNOP_status:" prefix
---
xen/include/public/event_channel.h | 184 ++++++++++++++++++-----------
1 file changed, 115 insertions(+), 69 deletions(-)

diff --git a/xen/include/public/event_channel.h b/xen/include/public/event_channel.h
index 73c9f38ce1..10b2d4d210 100644
--- a/xen/include/public/event_channel.h
+++ b/xen/include/public/event_channel.h
@@ -29,8 +29,8 @@

#include "xen.h"

-/*
- * `incontents 150 evtchn Event Channels
+/**
+ * DOC: Event Channels
*
* Event channels are the basic primitive provided by Xen for event
* notifications. An event is the Xen equivalent of a hardware
@@ -82,27 +82,34 @@
typedef uint32_t evtchn_port_t;
DEFINE_XEN_GUEST_HANDLE(evtchn_port_t);

-/*
- * EVTCHNOP_alloc_unbound: Allocate a port in domain <dom> and mark as
- * accepting interdomain bindings from domain <remote_dom>. A fresh port
- * is allocated in <dom> and returned as <port>.
+/**
+ * struct evtchn_alloc_unbound - EVTCHNOP_alloc_unbound
+ *
+ * Allocate a port in domain <dom> and mark as accepting interdomain
+ * bindings from domain <remote_dom>. A fresh port is allocated in <dom>
+ * and returned as <port>.
+ *
* NOTES:
* 1. If the caller is unprivileged then <dom> must be DOMID_SELF.
* 2. <remote_dom> may be DOMID_SELF, allowing loopback connections.
*/
struct evtchn_alloc_unbound {
- /* IN parameters */
- domid_t dom, remote_dom;
- /* OUT parameters */
+ /** @dom: IN parameter */
+ domid_t dom;
+ /** @remote_dom: IN parameter */
+ domid_t remote_dom;
+ /** @port: OUT parameter */
evtchn_port_t port;
};
typedef struct evtchn_alloc_unbound evtchn_alloc_unbound_t;

-/*
- * EVTCHNOP_bind_interdomain: Construct an interdomain event channel between
- * the calling domain and <remote_dom>. <remote_dom,remote_port> must identify
- * a port that is unbound and marked as accepting bindings from the calling
- * domain. A fresh port is allocated in the calling domain and returned as
+/**
+ * struct evtchn_bind_interdomain - EVTCHNOP_bind_interdomain
+ *
+ * Construct an interdomain event channel between the calling domain and
+ * <remote_dom>. <remote_dom,remote_port> must identify a port that is
+ * unbound and marked as accepting bindings from the calling domain. A
+ * fresh port is allocated in the calling domain and returned as
* <local_port>.
*
* In case the peer domain has already tried to set our event channel
@@ -119,17 +126,20 @@ typedef struct evtchn_alloc_unbound evtchn_alloc_unbound_t;
* 1. <remote_dom> may be DOMID_SELF, allowing loopback connections.
*/
struct evtchn_bind_interdomain {
- /* IN parameters. */
+ /** @remote_dom: IN parameter */
domid_t remote_dom;
+ /** @remote_port: IN parameter */
evtchn_port_t remote_port;
- /* OUT parameters. */
+ /** @local_port:OUT parameter */
evtchn_port_t local_port;
};
typedef struct evtchn_bind_interdomain evtchn_bind_interdomain_t;

-/*
- * EVTCHNOP_bind_virq: Bind a local event channel to VIRQ <irq> on specified
- * vcpu.
+/**
+ * struct evtchn_bind_virq - EVTCHNOP_bind_virq
+ *
+ * Bind a local event channel to VIRQ <irq> on specified vcpu.
+ *
* NOTES:
* 1. Virtual IRQs are classified as per-vcpu or global. See the VIRQ list
* in xen.h for the classification of each VIRQ.
@@ -140,77 +150,91 @@ typedef struct evtchn_bind_interdomain evtchn_bind_interdomain_t;
* binding cannot be changed.
*/
struct evtchn_bind_virq {
- /* IN parameters. */
- uint32_t virq; /* enum virq */
+ /** @virq: IN parameter, enum virq */
+ uint32_t virq;
+ /** @vcpu: IN parameter */
uint32_t vcpu;
- /* OUT parameters. */
+ /** @port: OUT parameter */
evtchn_port_t port;
};
typedef struct evtchn_bind_virq evtchn_bind_virq_t;

-/*
- * EVTCHNOP_bind_pirq: Bind a local event channel to a real IRQ (PIRQ <irq>).
+/**
+ * struct evtchn_bind_pirq - EVTCHNOP_bind_pirq
+ *
+ * Bind a local event channel to a real IRQ (PIRQ <irq>).
* NOTES:
* 1. A physical IRQ may be bound to at most one event channel per domain.
* 2. Only a sufficiently-privileged domain may bind to a physical IRQ.
*/
struct evtchn_bind_pirq {
- /* IN parameters. */
+ /** @pirq: IN parameter */
uint32_t pirq;
+ /** @flags: IN parameter, BIND_PIRQ__* */
#define BIND_PIRQ__WILL_SHARE 1
- uint32_t flags; /* BIND_PIRQ__* */
- /* OUT parameters. */
+ uint32_t flags;
+ /** @port: OUT parameter */
evtchn_port_t port;
};
typedef struct evtchn_bind_pirq evtchn_bind_pirq_t;

-/*
- * EVTCHNOP_bind_ipi: Bind a local event channel to receive events.
+/**
+ * struct struct evtchn_bind_ipi - EVTCHNOP_bind_ipi
+ *
+ * Bind a local event channel to receive events.
* NOTES:
* 1. The allocated event channel is bound to the specified vcpu. The binding
* may not be changed.
*/
struct evtchn_bind_ipi {
+ /** @vcpu: IN parameter */
uint32_t vcpu;
- /* OUT parameters. */
+ /** @port: OUT parameter */
evtchn_port_t port;
};
typedef struct evtchn_bind_ipi evtchn_bind_ipi_t;

-/*
- * EVTCHNOP_close: Close a local event channel <port>. If the channel is
- * interdomain then the remote end is placed in the unbound state
+/**
+ * struct evtchn_close - EVTCHNOP_close
+ *
+ * Close a local event channel <port>. If the channel is interdomain
+ * then the remote end is placed in the unbound state
* (EVTCHNSTAT_unbound), awaiting a new connection.
*/
struct evtchn_close {
- /* IN parameters. */
+ /** @port: IN parameter */
evtchn_port_t port;
};
typedef struct evtchn_close evtchn_close_t;

-/*
- * EVTCHNOP_send: Send an event to the remote end of the channel whose local
- * endpoint is <port>.
+/**
+ * struct evtchn_send - EVTCHNOP_send
+ *
+ * Send an event to the remote end of the channel whose local endpoint
+ * is <port>.
*/
struct evtchn_send {
- /* IN parameters. */
+ /** @port: IN parameter */
evtchn_port_t port;
};
typedef struct evtchn_send evtchn_send_t;

-/*
- * EVTCHNOP_status: Get the current status of the communication channel which
- * has an endpoint at <dom, port>.
+/**
+ * struct evtchn_status - EVTCHNOP_status
+ *
+ * Get the current status of the communication channel which has an
+ * endpoint at <dom, port>.
* NOTES:
* 1. <dom> may be specified as DOMID_SELF.
* 2. Only a sufficiently-privileged domain may obtain the status of an event
* channel for which <dom> is not DOMID_SELF.
*/
struct evtchn_status {
- /* IN parameters */
+ /** @dom: IN parameter */
domid_t dom;
+ /** @port: IN parameter */
evtchn_port_t port;
- /* OUT parameters */
+ /** @status: OUT parameter */
#define EVTCHNSTAT_closed 0 /* Channel is not in use. */
#define EVTCHNSTAT_unbound 1 /* Channel is waiting interdom connection.*/
#define EVTCHNSTAT_interdomain 2 /* Channel is connected to remote domain. */
@@ -218,24 +242,31 @@ struct evtchn_status {
#define EVTCHNSTAT_virq 4 /* Channel is bound to a virtual IRQ line */
#define EVTCHNSTAT_ipi 5 /* Channel is bound to a virtual IPI line */
uint32_t status;
- uint32_t vcpu; /* VCPU to which this channel is bound. */
+ /** @vcpu: OUT parameter, VCPU to which this channel is bound */
+ uint32_t vcpu;
+ /** @u: OUT parameter */
union {
+ /** @u.unbound: EVTCHNSTAT_unbound */
struct {
domid_t dom;
- } unbound; /* EVTCHNSTAT_unbound */
+ } unbound;
+ /** @u.interdomain: EVTCHNSTAT_interdomain */
struct {
domid_t dom;
evtchn_port_t port;
- } interdomain; /* EVTCHNSTAT_interdomain */
- uint32_t pirq; /* EVTCHNSTAT_pirq */
- uint32_t virq; /* EVTCHNSTAT_virq */
+ } interdomain;
+ /** @u.pirq: EVTCHNSTAT_pirq */
+ uint32_t pirq;
+ /** @u.virq: EVTCHNSTAT_virq */
+ uint32_t virq;
} u;
};
typedef struct evtchn_status evtchn_status_t;

-/*
- * EVTCHNOP_bind_vcpu: Specify which vcpu a channel should notify when an
- * event is pending.
+/**
+ * struct evtchn_bind_vcpu - EVTCHNOP_bind_vcpu
+ *
+ * Specify which vcpu a channel should notify when an event is pending.
* NOTES:
* 1. IPI-bound channels always notify the vcpu specified at bind time.
* This binding cannot be changed.
@@ -246,24 +277,29 @@ typedef struct evtchn_status evtchn_status_t;
* has its binding reset to vcpu0).
*/
struct evtchn_bind_vcpu {
- /* IN parameters. */
+ /** @port: IN parameter */
evtchn_port_t port;
+ /** @vcpu: IN parameter */
uint32_t vcpu;
};
typedef struct evtchn_bind_vcpu evtchn_bind_vcpu_t;

-/*
- * EVTCHNOP_unmask: Unmask the specified local event-channel port and deliver
- * a notification to the appropriate VCPU if an event is pending.
+/**
+ * struct evtchn_unmask - EVTCHNOP_unmask
+ *
+ * Unmask the specified local event-channel port and deliver a
+ * notification to the appropriate VCPU if an event is pending.
*/
struct evtchn_unmask {
- /* IN parameters. */
+ /** @port: IN parameter */
evtchn_port_t port;
};
typedef struct evtchn_unmask evtchn_unmask_t;

-/*
- * EVTCHNOP_reset: Close all event channels associated with specified domain.
+/**
+ * struct evtchn_reset - EVTCHNOP_reset
+ *
+ * Close all event channels associated with specified domain.
* NOTES:
* 1. <dom> may be specified as DOMID_SELF.
* 2. Only a sufficiently-privileged domain may specify other than DOMID_SELF.
@@ -273,44 +309,54 @@ typedef struct evtchn_unmask evtchn_unmask_t;
* as these events are likely to be lost.
*/
struct evtchn_reset {
- /* IN parameters. */
+ /** @dom: IN parameter */
domid_t dom;
};
typedef struct evtchn_reset evtchn_reset_t;

-/*
- * EVTCHNOP_init_control: initialize the control block for the FIFO ABI.
+/**
+ * struct evtchn_init_control - EVTCHNOP_init_control
+ *
+ * Initialize the control block for the FIFO ABI.
*
* Note: any events that are currently pending will not be resent and
* will be lost. Guests should call this before binding any event to
* avoid losing any events.
*/
struct evtchn_init_control {
- /* IN parameters. */
+ /** @control_gfn: IN parameter */
uint64_t control_gfn;
+ /** @offset: IN parameter */
uint32_t offset;
+ /** @vcpu: IN parameter */
uint32_t vcpu;
- /* OUT parameters. */
+ /** @link_bits: OUT parameter */
uint8_t link_bits;
+ /** @_pad: padding */
uint8_t _pad[7];
};
typedef struct evtchn_init_control evtchn_init_control_t;

-/*
- * EVTCHNOP_expand_array: add an additional page to the event array.
+/**
+ * struct evtchn_expand_array - EVTCHNOP_expand_array
+ *
+ * Add an additional page to the event array.
*/
struct evtchn_expand_array {
- /* IN parameters. */
+ /** @array_gfn: IN parameter */
uint64_t array_gfn;
};
typedef struct evtchn_expand_array evtchn_expand_array_t;

-/*
- * EVTCHNOP_set_priority: set the priority for an event channel.
+/**
+ * struct evtchn_set_priority - EVTCHNOP_set_priority
+ *
+ * Set the priority for an event channel.
*/
struct evtchn_set_priority {
- /* IN parameters. */
+ /** @port: IN parameter */
evtchn_port_t port;
+ /** @priority: IN parameter */
uint32_t priority;
};
typedef struct evtchn_set_priority evtchn_set_priority_t;
--
2.17.1