Use Doxygen style comments consistently.
We were already using them for functions; use them for struct members
and enum values as well.
Change-Id: I89c1ef9e4a4f19424186b4da5855522bac0a2c4d
diff --git a/inc/hf/addr.h b/inc/hf/addr.h
index 7121744..09a6c09 100644
--- a/inc/hf/addr.h
+++ b/inc/hf/addr.h
@@ -21,17 +21,17 @@
#include "hf/arch/addr.h"
-/* An opaque type for a physical address. */
+/** An opaque type for a physical address. */
typedef struct {
uintpaddr_t pa;
} paddr_t;
-/* An opaque type for an intermediate physical address. */
+/** An opaque type for an intermediate physical address. */
typedef struct {
uintpaddr_t ipa;
} ipaddr_t;
-/* An opaque type for a virtual address. */
+/** An opaque type for a virtual address. */
typedef struct {
uintvaddr_t va;
} vaddr_t;
diff --git a/inc/hf/cpu.h b/inc/hf/cpu.h
index 94ca629..60261fe 100644
--- a/inc/hf/cpu.h
+++ b/inc/hf/cpu.h
@@ -26,19 +26,19 @@
#include "hf/spinlock.h"
enum vcpu_state {
- /* The vcpu is switched off. */
+ /** The vcpu is switched off. */
vcpu_state_off,
- /* The vcpu is ready to be run. */
+ /** The vcpu is ready to be run. */
vcpu_state_ready,
- /* The vcpu is currently running. */
+ /** The vcpu is currently running. */
vcpu_state_running,
- /* The vcpu is waiting for a message. */
+ /** The vcpu is waiting for a message. */
vcpu_state_blocked_mailbox,
- /* The vcpu is waiting for an interrupt. */
+ /** The vcpu is waiting for an interrupt. */
vcpu_state_blocked_interrupt,
};
@@ -53,13 +53,13 @@
/* TODO: Update alignment such that cpus are in different cache lines. */
struct cpu {
- /* CPU identifier. Doesn't have to be contiguous. */
+ /** CPU identifier. Doesn't have to be contiguous. */
size_t id;
- /* Pointer to bottom of the stack. */
+ /** Pointer to bottom of the stack. */
void *stack_bottom;
- /*
+ /**
* Enabling/disabling irqs are counted per-cpu. They are enabled when
* the count is zero, and disabled when it's non-zero.
*/
@@ -67,7 +67,7 @@
struct spinlock lock;
- /* Determines whether or not the cpu is currently on. */
+ /** Determines whether or not the cpu is currently on. */
bool is_on;
};
diff --git a/inc/hf/mm.h b/inc/hf/mm.h
index 0f5a4a6..d5752f4 100644
--- a/inc/hf/mm.h
+++ b/inc/hf/mm.h
@@ -46,21 +46,21 @@
#define MM_MODE_X 0x04 /* execute */
#define MM_MODE_D 0x08 /* device */
-/*
+/**
* This flag indicates that memory allocation must not use locks. This is
* relevant in systems where interlocked operations are only available after
* virtual memory is enabled.
*/
#define MM_MODE_NOSYNC 0x10
-/*
+/**
* This flag indicates that the mapping is intended to be used in a first
* stage translation table, which might have different encodings for the
* attribute bits than the second stage table.
*/
#define MM_MODE_STAGE1 0x20
-/*
+/**
* This flag indicates that no TLB invalidations should be issued for the
* changes in the page table.
*/
diff --git a/inc/hf/vm.h b/inc/hf/vm.h
index 6bc4882..dfe80b9 100644
--- a/inc/hf/vm.h
+++ b/inc/hf/vm.h
@@ -20,13 +20,13 @@
#include "hf/mm.h"
enum mailbox_state {
- /* There is no message in the mailbox. */
+ /** There is no message in the mailbox. */
mailbox_state_empty,
- /* There is a message in the mailbox that is waiting for a reader. */
+ /** There is a message in the mailbox that is waiting for a reader. */
mailbox_state_received,
- /* There is a message in the mailbox that has been read. */
+ /** There is a message in the mailbox that has been read. */
mailbox_state_read,
};
diff --git a/inc/vmapi/hf/call.h b/inc/vmapi/hf/call.h
index ac1ddff..102fd6c 100644
--- a/inc/vmapi/hf/call.h
+++ b/inc/vmapi/hf/call.h
@@ -31,7 +31,7 @@
#define HF_MAILBOX_RECEIVE 0xff05
#define HF_MAILBOX_CLEAR 0xff06
-/* The amount of data that can be sent to a mailbox. */
+/** The amount of data that can be sent to a mailbox. */
#define HF_MAILBOX_SIZE 4096
/* clang-format on */
diff --git a/inc/vmapi/hf/types.h b/inc/vmapi/hf/types.h
index 55de5f1..45aa257 100644
--- a/inc/vmapi/hf/types.h
+++ b/inc/vmapi/hf/types.h
@@ -33,7 +33,7 @@
#endif
-/* The ID of the primary VM which is responsile for scheduling. */
+/** The ID of the primary VM which is responsible for scheduling. */
#define HF_PRIMARY_VM_ID 0
/* Invalid values for fields to indicate absence or errors. */
diff --git a/src/arch/aarch64/inc/hf/arch/addr.h b/src/arch/aarch64/inc/hf/arch/addr.h
index a6c5f8b..61483ed 100644
--- a/src/arch/aarch64/inc/hf/arch/addr.h
+++ b/src/arch/aarch64/inc/hf/arch/addr.h
@@ -20,8 +20,8 @@
#define PAGE_BITS 12
-/* Integer type large enough to hold a physical address. */
+/** Integer type large enough to hold a physical address. */
typedef uintptr_t uintpaddr_t;
-/* Integer type large enough to hold a virtual address. */
+/** Integer type large enough to hold a virtual address. */
typedef uintptr_t uintvaddr_t;
diff --git a/src/arch/aarch64/inc/hf/arch/mm.h b/src/arch/aarch64/inc/hf/arch/mm.h
index 9753795..b2552e3 100644
--- a/src/arch/aarch64/inc/hf/arch/mm.h
+++ b/src/arch/aarch64/inc/hf/arch/mm.h
@@ -21,7 +21,7 @@
#include "hf/addr.h"
-/* A page table entry. */
+/** A page table entry. */
typedef uint64_t pte_t;
#define PAGE_LEVEL_BITS 9
diff --git a/src/arch/fake/inc/hf/arch/addr.h b/src/arch/fake/inc/hf/arch/addr.h
index a6c5f8b..61483ed 100644
--- a/src/arch/fake/inc/hf/arch/addr.h
+++ b/src/arch/fake/inc/hf/arch/addr.h
@@ -20,8 +20,8 @@
#define PAGE_BITS 12
-/* Integer type large enough to hold a physical address. */
+/** Integer type large enough to hold a physical address. */
typedef uintptr_t uintpaddr_t;
-/* Integer type large enough to hold a virtual address. */
+/** Integer type large enough to hold a virtual address. */
typedef uintptr_t uintvaddr_t;
diff --git a/src/arch/fake/inc/hf/arch/mm.h b/src/arch/fake/inc/hf/arch/mm.h
index 8033f46..d0daa55 100644
--- a/src/arch/fake/inc/hf/arch/mm.h
+++ b/src/arch/fake/inc/hf/arch/mm.h
@@ -34,7 +34,7 @@
* <attrs> are always 0 for now.
*/
-/* A page table entry. */
+/** A page table entry. */
typedef uint64_t pte_t;
#define PAGE_LEVEL_BITS 9
