[REFACTOR] Hafnium style fixes and other minor fixes.
Change-Id: I8f10a1d82f0de9efc43894a3a7cdd09bbbcfc6ec
diff --git a/inc/hf/cpu.h b/inc/hf/cpu.h
index fe1c7f4..af7391f 100644
--- a/inc/hf/cpu.h
+++ b/inc/hf/cpu.h
@@ -18,7 +18,7 @@
#include "hf/arch/cpu.h"
-/* TODO: Update alignment such that cpus are in different cache lines. */
+/* TODO: Fix alignment such that `cpu` structs are in different cache lines. */
struct cpu {
/** CPU identifier. Doesn't have to be contiguous. */
cpu_id_t id;
@@ -29,7 +29,7 @@
/** See api.c for the partial ordering on locks. */
struct spinlock lock;
- /** Determines whether or not the cpu is currently on. */
+ /** Determines whether the CPU is currently on. */
bool is_on;
};
diff --git a/inc/hf/vcpu.h b/inc/hf/vcpu.h
index 869bf23..87d5e8c 100644
--- a/inc/hf/vcpu.h
+++ b/inc/hf/vcpu.h
@@ -25,22 +25,22 @@
#define INTERRUPT_REGISTER_BITS 32
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,
- /** The vcpu has aborted. */
+ /** The vCPU has aborted. */
VCPU_STATE_ABORTED,
};
diff --git a/inc/vmapi/hf/call.h b/inc/vmapi/hf/call.h
index bd1c0bd..f2455e2 100644
--- a/inc/vmapi/hf/call.h
+++ b/inc/vmapi/hf/call.h
@@ -52,7 +52,7 @@
}
/**
- * Returns the number of VCPUs configured in the given secondary VM.
+ * Returns the number of vCPUs configured in the given secondary VM.
*/
static inline spci_vcpu_count_t hf_vcpu_get_count(spci_vm_id_t vm_id)
{
@@ -70,7 +70,7 @@
}
/**
- * Hints that the vcpu is willing to yield its current use of the physical CPU.
+ * Hints that the vCPU is willing to yield its current use of the physical CPU.
* This call always returns SPCI_SUCCESS.
*/
static inline struct spci_value spci_yield(void)
@@ -140,7 +140,7 @@
* If no message is immediately available and there are no enabled and pending
* interrupts (irrespective of whether interrupts are enabled globally), then
* this will block until a message is available or an enabled interrupt becomes
- * pending. This matches the behaviour of the WFI instruction on aarch64, except
+ * pending. This matches the behaviour of the WFI instruction on AArch64, except
* that a message becoming available is also treated like a wake-up event.
*
* Returns:
@@ -277,7 +277,7 @@
* SPCI interfaces.
*
* Returns:
- * - SPCI_SUCCESS in .func if the the optional interface with function_id is
+ * - SPCI_SUCCESS in .func if the optional interface with function_id is
* implemented.
* - SPCI_ERROR in .func if the optional interface with function_id is not
* implemented.