Patchwork [qom-cpu,2/7] target-mips: Clean up mips_cpu_map_tc() documentation

login
register
mail settings
Submitter Andreas Färber
Date Dec. 19, 2012, 3:31 p.m.
Message ID <1355931071-22100-3-git-send-email-afaerber@suse.de>
Download mbox | patch
Permalink /patch/207403/
State New
Headers show

Comments

Andreas Färber - Dec. 19, 2012, 3:31 p.m.
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>
---
 target-mips/op_helper.c |   14 +++++++++-----
 1 Datei geändert, 9 Zeilen hinzugefügt(+), 5 Zeilen entfernt(-)
Eric Johnson - Jan. 8, 2013, 5:43 a.m.
On 12/19/2012 07:31 AM, Andreas Färber wrote:
> 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>
> ---
>   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 f9f2b23..83998ab 100644
> --- a/target-mips/op_helper.c
> +++ b/target-mips/op_helper.c
> @@ -573,11 +573,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)

Reviewed-by: Eric Johnson <ericj@mips.com>

Patch

diff --git a/target-mips/op_helper.c b/target-mips/op_helper.c
index f9f2b23..83998ab 100644
--- a/target-mips/op_helper.c
+++ b/target-mips/op_helper.c
@@ -573,11 +573,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)