aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Färber <afaerber@suse.de>2012-12-17 20:36:30 +0100
committerAndreas Färber <afaerber@suse.de>2013-01-15 04:09:13 +0100
commit66afd1ad5a7a25e573577ac45979d8a3213796c3 (patch)
tree05b8f670bf84abe986a90cabfaeb765e47a1b6f1
parentce3960ebe57d0601a3628b64adac6fd23c901f70 (diff)
target-mips: Clean up mips_cpu_map_tc() documentation
This function will be touched again soon, so a good understanding of env vs. other helps. Adopt gtk-doc style. Signed-off-by: Andreas Färber <afaerber@suse.de> Reviewed-by: Eric Johnson <ericj@mips.com>
-rw-r--r--target-mips/op_helper.c14
1 files changed, 9 insertions, 5 deletions
diff --git a/target-mips/op_helper.c b/target-mips/op_helper.c
index fb63d9e402..1816a0ec8d 100644
--- a/target-mips/op_helper.c
+++ b/target-mips/op_helper.c
@@ -572,11 +572,15 @@ static inline void mips_tc_sleep(MIPSCPU *cpu, int tc)
}
}
-/* tc should point to an int with the value of the global TC index.
- This function will transform it into a local index within the
- returned CPUMIPSState.
-
- FIXME: This code assumes that all VPEs have the same number of TCs,
+/**
+ * mips_cpu_map_tc:
+ * @env: CPU from which mapping is performed.
+ * @tc: Should point to an int with the value of the global TC index.
+ *
+ * This function will transform @tc into a local index within the
+ * returned #CPUMIPSState.
+ */
+/* FIXME: This code assumes that all VPEs have the same number of TCs,
which depends on runtime setup. Can probably be fixed by
walking the list of CPUMIPSStates. */
static CPUMIPSState *mips_cpu_map_tc(CPUMIPSState *env, int *tc)