Document return value of sync_exception_current.
Bug: 140916188
Change-Id: I06c2cbe37703562bc6cdf9259a6f30f186cd5804
diff --git a/src/arch/aarch64/hftest/interrupts.c b/src/arch/aarch64/hftest/interrupts.c
index a7eb401..5baa8c2 100644
--- a/src/arch/aarch64/hftest/interrupts.c
+++ b/src/arch/aarch64/hftest/interrupts.c
@@ -65,6 +65,14 @@
}
}
+/**
+ * Handles a synchronous exception at the current exception level.
+ *
+ * Returns true if the value of elr_el1 should be kept as-is rather than
+ * restored from the stack. This enables exception handlers to indicate whether
+ * they have changed the value of elr_el1 (e.g., to skip the faulting
+ * instruction).
+ */
bool sync_exception_current(void)
{
if (exception_callback != NULL) {
