Mailing List Archive

[PATCH v2 09/14] kernel-doc: public/sched.h
Convert in-code comments to kernel-doc format wherever possible.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
---
Changes in v2:
- remove "enum" comments
---
xen/include/public/sched.h | 134 +++++++++++++++++++++++++------------
1 file changed, 92 insertions(+), 42 deletions(-)

diff --git a/xen/include/public/sched.h b/xen/include/public/sched.h
index 811bd87c82..f6f0263569 100644
--- a/xen/include/public/sched.h
+++ b/xen/include/public/sched.h
@@ -29,41 +29,48 @@

#include "event_channel.h"

-/*
- * `incontents 150 sched Guest Scheduler Operations
+/**
+ * DOC: Guest Scheduler Operations
*
* The SCHEDOP interface provides mechanisms for a guest to interact
* with the scheduler, including yield, blocking and shutting itself
* down.
*/

-/*
+/**
+ * DOC: HYPERVISOR_sched_op
+ *
* The prototype for this hypercall is:
- * ` long HYPERVISOR_sched_op(enum sched_op cmd, void *arg, ...)
*
- * @cmd == SCHEDOP_??? (scheduler operation).
- * @arg == Operation-specific extra argument(s), as described below.
- * ... == Additional Operation-specific extra arguments, described below.
+ * long HYPERVISOR_sched_op(enum sched_op cmd, void *arg, ...)
+ *
+ * - @cmd == SCHEDOP_??? (scheduler operation).
+ * - @arg == Operation-specific extra argument(s), as described below.
+ * - ... == Additional Operation-specific extra arguments, described below.
*
* Versions of Xen prior to 3.0.2 provided only the following legacy version
* of this hypercall, supporting only the commands yield, block and shutdown:
+ *
* long sched_op(int cmd, unsigned long arg)
- * @cmd == SCHEDOP_??? (scheduler operation).
- * @arg == 0 (SCHEDOP_yield and SCHEDOP_block)
- * == SHUTDOWN_* code (SCHEDOP_shutdown)
+ *
+ * - @cmd == SCHEDOP_??? (scheduler operation).
+ * - @arg == 0 (SCHEDOP_yield and SCHEDOP_block)
+ * - == SHUTDOWN_* code (SCHEDOP_shutdown)
*
* This legacy version is available to new guests as:
- * ` long HYPERVISOR_sched_op_compat(enum sched_op cmd, unsigned long arg)
+ *
+ * long HYPERVISOR_sched_op_compat(enum sched_op cmd, unsigned long arg)
*/

-/* ` enum sched_op { // SCHEDOP_* => struct sched_* */
-/*
- * Voluntarily yield the CPU.
- * @arg == NULL.
+/**
+ * DOC: SCHEDOP_yield
+ * Voluntarily yield the CPU. @arg == NULL.
*/
#define SCHEDOP_yield 0

-/*
+/**
+ * DOC: SCHEDOP_block
+ *
* Block execution of this VCPU until an event is received for processing.
* If called with event upcalls masked, this operation will atomically
* reenable event delivery and check for pending events before blocking the
@@ -72,7 +79,9 @@
*/
#define SCHEDOP_block 1

-/*
+/**
+ * DOC: SCHEDOP_shutdown
+ *
* Halt execution of this domain (all VCPUs) and notify the system controller.
* @arg == pointer to sched_shutdown_t structure.
*
@@ -87,14 +96,18 @@
*/
#define SCHEDOP_shutdown 2

-/*
+/**
+ * DOC: SCHEDOP_poll
+ *
* Poll a set of event-channel ports. Return when one or more are pending. An
* optional timeout may be specified.
* @arg == pointer to sched_poll_t structure.
*/
#define SCHEDOP_poll 3

-/*
+/**
+ * DOC: SCHEDOP_remote_shutdown
+ *
* Declare a shutdown for another domain. The main use of this function is
* in interpreting shutdown requests and reasons for fully-virtualized
* domains. A para-virtualized domain may use SCHEDOP_shutdown directly.
@@ -102,14 +115,18 @@
*/
#define SCHEDOP_remote_shutdown 4

-/*
+/**
+ * DOC: SCHEDOP_shutdown_code
+ *
* Latch a shutdown code, so that when the domain later shuts down it
* reports this code to the control tools.
* @arg == sched_shutdown_t, as for SCHEDOP_shutdown.
*/
#define SCHEDOP_shutdown_code 5

-/*
+/**
+ * DOC: SCHEDOP_watchdog
+ *
* Setup, poke and destroy a domain watchdog timer.
* @arg == pointer to sched_watchdog_t structure.
* With id == 0, setup a domain watchdog timer to cause domain shutdown
@@ -119,7 +136,9 @@
*/
#define SCHEDOP_watchdog 6

-/*
+/**
+ * DOC: SCHEDOP_pin_override
+ *
* Override the current vcpu affinity by pinning it to one physical cpu or
* undo this override restoring the previous affinity.
* @arg == pointer to sched_pin_override_t structure.
@@ -130,14 +149,20 @@
* to be part of the domain's cpupool.
*/
#define SCHEDOP_pin_override 7
-/* ` } */

+/**
+ * struct sched_shutdown
+ */
struct sched_shutdown {
- unsigned int reason; /* SHUTDOWN_* => enum sched_shutdown_reason */
+ /** @reason: SHUTDOWN_* => enum sched_shutdown_reason */
+ unsigned int reason;
};
typedef struct sched_shutdown sched_shutdown_t;
DEFINE_XEN_GUEST_HANDLE(sched_shutdown_t);

+/**
+ * struct sched_poll
+ */
struct sched_poll {
XEN_GUEST_HANDLE(evtchn_port_t) ports;
unsigned int nr_ports;
@@ -146,39 +171,61 @@ struct sched_poll {
typedef struct sched_poll sched_poll_t;
DEFINE_XEN_GUEST_HANDLE(sched_poll_t);

+/**
+ * struct sched_remote_shutdown
+ */
struct sched_remote_shutdown {
- domid_t domain_id; /* Remote domain ID */
- unsigned int reason; /* SHUTDOWN_* => enum sched_shutdown_reason */
+ /** @domain_id: Remote domain ID */
+ domid_t domain_id;
+ /** @reason: SHUTDOWN_* => enum sched_shutdown_reason */
+ unsigned int reason;
};
typedef struct sched_remote_shutdown sched_remote_shutdown_t;
DEFINE_XEN_GUEST_HANDLE(sched_remote_shutdown_t);

+/**
+ * struct sched_watchdog
+ */
struct sched_watchdog {
- uint32_t id; /* watchdog ID */
- uint32_t timeout; /* timeout */
+ /** @id: watchdog ID */
+ uint32_t id;
+ /** @timeout: timeout */
+ uint32_t timeout;
};
typedef struct sched_watchdog sched_watchdog_t;
DEFINE_XEN_GUEST_HANDLE(sched_watchdog_t);

+/**
+ * struct sched_pin_override
+ */
struct sched_pin_override {
int32_t pcpu;
};
typedef struct sched_pin_override sched_pin_override_t;
DEFINE_XEN_GUEST_HANDLE(sched_pin_override_t);

-/*
- * Reason codes for SCHEDOP_shutdown. These may be interpreted by control
- * software to determine the appropriate action. For the most part, Xen does
- * not care about the shutdown code.
+/**
+ * DOC: Reason codes for SCHEDOP_shutdown
+ *
+ * These may be interpreted by control software to determine the
+ * appropriate action. For the most part, Xen does not care about the
+ * shutdown code.
+ *
+ * - SHUTDOWN_poweroff: Domain exited normally. Clean up and kill.
+ * - SHUTDOWN_reboot: Clean up, kill, and then restart.
+ * - SHUTDOWN_suspend: Clean up, save suspend info, kill.
+ * - SHUTDOWN_crash: Tell controller we've crashed.
+ * - SHUTDOWN_watchdog: Restart because watchdog time expired.
*/
-/* ` enum sched_shutdown_reason { */
-#define SHUTDOWN_poweroff 0 /* Domain exited normally. Clean up and kill. */
-#define SHUTDOWN_reboot 1 /* Clean up, kill, and then restart. */
-#define SHUTDOWN_suspend 2 /* Clean up, save suspend info, kill. */
-#define SHUTDOWN_crash 3 /* Tell controller we've crashed. */
-#define SHUTDOWN_watchdog 4 /* Restart because watchdog time expired. */
-
-/*
+#define SHUTDOWN_poweroff 0
+#define SHUTDOWN_reboot 1
+#define SHUTDOWN_suspend 2
+#define SHUTDOWN_crash 3
+#define SHUTDOWN_watchdog 4
+
+/**
+ * DOC: SHUTDOWN_soft_reset
+ *
* Domain asked to perform 'soft reset' for it. The expected behavior is to
* reset internal Xen state for the domain returning it to the point where it
* was created but leaving the domain's memory contents and vCPU contexts
@@ -186,8 +233,11 @@ DEFINE_XEN_GUEST_HANDLE(sched_pin_override_t);
* interfaces again.
*/
#define SHUTDOWN_soft_reset 5
-#define SHUTDOWN_MAX 5 /* Maximum valid shutdown reason. */
-/* ` } */
+/**
+ * DOC: SHUTDOWN_MAX
+ * Maximum valid shutdown reason
+ */
+#define SHUTDOWN_MAX 5

#endif /* __XEN_PUBLIC_SCHED_H__ */

--
2.17.1