From patchwork Tue Jan 15 09:27:20 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [02/20] target-mips: Clean up mips_cpu_map_tc() documentation Date: Mon, 14 Jan 2013 23:27:20 -0000 From: =?utf-8?q?Andreas_F=C3=A4rber?= X-Patchwork-Id: 212054 Message-Id: <1358242058-1404-3-git-send-email-afaerber@suse.de> To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Andreas=20F=C3=A4rber?= , Aurelien Jarno 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 Reviewed-by: Eric Johnson --- target-mips/op_helper.c | 14 +++++++++----- 1 Datei geändert, 9 Zeilen hinzugefügt(+), 5 Zeilen entfernt(-) diff --git a/target-mips/op_helper.c b/target-mips/op_helper.c index fb63d9e..1816a0e 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)