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>
This commit is contained in:
Andreas Färber 2012-12-17 20:36:30 +01:00
parent ce3960ebe5
commit 66afd1ad5a

View file

@ -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 * mips_cpu_map_tc:
returned CPUMIPSState. * @env: CPU from which mapping is performed.
* @tc: Should point to an int with the value of the global TC index.
FIXME: This code assumes that all VPEs have the same number of TCs, *
* 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 which depends on runtime setup. Can probably be fixed by
walking the list of CPUMIPSStates. */ walking the list of CPUMIPSStates. */
static CPUMIPSState *mips_cpu_map_tc(CPUMIPSState *env, int *tc) static CPUMIPSState *mips_cpu_map_tc(CPUMIPSState *env, int *tc)