aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--include/mips_cpu.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/include/mips_cpu.h b/include/mips_cpu.h
index 117d869..8af9827 100644
--- a/include/mips_cpu.h
+++ b/include/mips_cpu.h
@@ -77,8 +77,14 @@ mips_error mips_cpu_set_pc(
uint32_t pc //!< Address of the next instruction to exectute.
);
-/*! Gets the pc for the next instruction. */
-mips_error mips_cpu_get_pc(mips_cpu_h state, uint32_t *pc);
+/*! Gets the pc for the next instruction.
+
+ Returns the program counter for the next instruction to be executed.
+*/
+mips_error mips_cpu_get_pc(
+ mips_cpu_h state, //!< Valid (non-empty) handle to a CPU
+ uint32_t *pc //!< Where to write the byte address too
+);
/*! Advances the processor by one instruction.