diff mbox series

[for-3.2] RISC-V: Deprecate hifive_e and hifive_u machines

Message ID 20181121233123.6408-1-palmer@sifive.com
State New
Headers show
Series [for-3.2] RISC-V: Deprecate hifive_e and hifive_u machines | expand

Commit Message

Palmer Dabbelt Nov. 21, 2018, 11:31 p.m. UTC
These machines had names that were too general: there are many E
and U machines, and it's easy for users to get confused about which one
is which.  The one configuration that can faithfully match an existing
ASIC-based board has been renamed to 'sifive-hifive1', we'll work
through the emulation fidelity issues apparent in the other targets
before adding machines for those.

Signed-off-by: Palmer Dabbelt <palmer@sifive.com>
---
 hw/riscv/sifive_e.c  | 26 ++++++++++++++++++++++++--
 hw/riscv/sifive_u.c  |  2 ++
 qemu-deprecated.texi |  7 +++++++
 3 files changed, 33 insertions(+), 2 deletions(-)

Comments

Thomas Huth Nov. 22, 2018, 8:44 a.m. UTC | #1
Hi,

On 2018-11-22 00:31, Palmer Dabbelt wrote:
> These machines had names that were too general: there are many E
> and U machines, and it's easy for users to get confused about which one
> is which.  The one configuration that can faithfully match an existing
> ASIC-based board has been renamed to 'sifive-hifive1', we'll work
> through the emulation fidelity issues apparent in the other targets
> before adding machines for those.
> 
> Signed-off-by: Palmer Dabbelt <palmer@sifive.com>
> ---
>  hw/riscv/sifive_e.c  | 26 ++++++++++++++++++++++++--
>  hw/riscv/sifive_u.c  |  2 ++
>  qemu-deprecated.texi |  7 +++++++
>  3 files changed, 33 insertions(+), 2 deletions(-)
> 
> diff --git a/hw/riscv/sifive_e.c b/hw/riscv/sifive_e.c
> index cb513cc3bb50..439d20e0efe7 100644
> --- a/hw/riscv/sifive_e.c
> +++ b/hw/riscv/sifive_e.c
> @@ -95,7 +95,7 @@ static void sifive_mmio_emulate(MemoryRegion *parent, const char *name,
>      memory_region_add_subregion(parent, offset, mock_mmio);
>  }
>  
> -static void riscv_sifive_e_init(MachineState *machine)
> +static void riscv_sifive_hifive1_init(MachineState *machine)
>  {
>      const struct MemmapEntry *memmap = sifive_e_memmap;
>  
> @@ -135,6 +135,17 @@ static void riscv_sifive_e_init(MachineState *machine)
>      }
>  }
>  
> +static void riscv_sifive_e_init(MachineState *machine)
> +{
> +#if defined(TARGET_RISCV32)
> +    warn_report("The sifive_e machine is deprecated in favor of sifive-hifive1");
> +#else
> +    warn_report("The sifive_e machine is deprecated.");
> +#endif
> +
> +    return riscv_sifive_hifive1_init(machine);
> +}
> +
>  static void riscv_sifive_e_soc_init(Object *obj)
>  {
>      SiFiveESoCState *s = RISCV_E_SOC(obj);
> @@ -213,13 +224,24 @@ static void riscv_sifive_e_soc_realize(DeviceState *dev, Error **errp)
>  
>  static void riscv_sifive_e_machine_init(MachineClass *mc)
>  {
> -    mc->desc = "RISC-V Board compatible with SiFive E SDK";
> +    mc->desc = "(deprecated) RISC-V Board compatible with SiFive E SDK";
>      mc->init = riscv_sifive_e_init;
>      mc->max_cpus = 1;
>  }
>  
>  DEFINE_MACHINE("sifive_e", riscv_sifive_e_machine_init)
>  
> +#if defined(TARGET_RISCV32)
> +static void riscv_sifive_hifive1_machine_init(MachineClass *mc)
> +{
> +    mc->desc = "SiFive's HiFive1 Development Board";
> +    mc->init = riscv_sifive_hifive1_init;
> +    mc->max_cpus = 1;
> +}
> +
> +DEFINE_MACHINE("sifive-hifive1", riscv_sifive_hifive1_machine_init)
> +#endif
> +
>  static void riscv_sifive_e_soc_class_init(ObjectClass *oc, void *data)
>  {
>      DeviceClass *dc = DEVICE_CLASS(oc);
> diff --git a/hw/riscv/sifive_u.c b/hw/riscv/sifive_u.c
> index ef07df244241..0ce6a9dd2609 100644
> --- a/hw/riscv/sifive_u.c
> +++ b/hw/riscv/sifive_u.c
> @@ -238,6 +238,8 @@ static void create_fdt(SiFiveUState *s, const struct MemmapEntry *memmap,
>  
>  static void riscv_sifive_u_init(MachineState *machine)
>  {
> +    warn_report("The sifive_u machine is deprecated.");

FWIW, you can also simply set MachineClass->deprecation_reason nowadays
instead of manually issuing a warn_report() and tweaking the description
... that would be a little bit easier and is in sync with the other
deprecated boards (see e.g. commit 08fe68244 or 54c86f5a4844d51 for
other examples).

 Thomas
Palmer Dabbelt Nov. 26, 2018, 7:17 p.m. UTC | #2
On Thu, 22 Nov 2018 00:44:32 PST (-0800), thuth@redhat.com wrote:
>  Hi,
>
> On 2018-11-22 00:31, Palmer Dabbelt wrote:
>> These machines had names that were too general: there are many E
>> and U machines, and it's easy for users to get confused about which one
>> is which.  The one configuration that can faithfully match an existing
>> ASIC-based board has been renamed to 'sifive-hifive1', we'll work
>> through the emulation fidelity issues apparent in the other targets
>> before adding machines for those.
>>
>> Signed-off-by: Palmer Dabbelt <palmer@sifive.com>
>> ---
>>  hw/riscv/sifive_e.c  | 26 ++++++++++++++++++++++++--
>>  hw/riscv/sifive_u.c  |  2 ++
>>  qemu-deprecated.texi |  7 +++++++
>>  3 files changed, 33 insertions(+), 2 deletions(-)
>>
>> diff --git a/hw/riscv/sifive_e.c b/hw/riscv/sifive_e.c
>> index cb513cc3bb50..439d20e0efe7 100644
>> --- a/hw/riscv/sifive_e.c
>> +++ b/hw/riscv/sifive_e.c
>> @@ -95,7 +95,7 @@ static void sifive_mmio_emulate(MemoryRegion *parent, const char *name,
>>      memory_region_add_subregion(parent, offset, mock_mmio);
>>  }
>>
>> -static void riscv_sifive_e_init(MachineState *machine)
>> +static void riscv_sifive_hifive1_init(MachineState *machine)
>>  {
>>      const struct MemmapEntry *memmap = sifive_e_memmap;
>>
>> @@ -135,6 +135,17 @@ static void riscv_sifive_e_init(MachineState *machine)
>>      }
>>  }
>>
>> +static void riscv_sifive_e_init(MachineState *machine)
>> +{
>> +#if defined(TARGET_RISCV32)
>> +    warn_report("The sifive_e machine is deprecated in favor of sifive-hifive1");
>> +#else
>> +    warn_report("The sifive_e machine is deprecated.");
>> +#endif
>> +
>> +    return riscv_sifive_hifive1_init(machine);
>> +}
>> +
>>  static void riscv_sifive_e_soc_init(Object *obj)
>>  {
>>      SiFiveESoCState *s = RISCV_E_SOC(obj);
>> @@ -213,13 +224,24 @@ static void riscv_sifive_e_soc_realize(DeviceState *dev, Error **errp)
>>
>>  static void riscv_sifive_e_machine_init(MachineClass *mc)
>>  {
>> -    mc->desc = "RISC-V Board compatible with SiFive E SDK";
>> +    mc->desc = "(deprecated) RISC-V Board compatible with SiFive E SDK";
>>      mc->init = riscv_sifive_e_init;
>>      mc->max_cpus = 1;
>>  }
>>
>>  DEFINE_MACHINE("sifive_e", riscv_sifive_e_machine_init)
>>
>> +#if defined(TARGET_RISCV32)
>> +static void riscv_sifive_hifive1_machine_init(MachineClass *mc)
>> +{
>> +    mc->desc = "SiFive's HiFive1 Development Board";
>> +    mc->init = riscv_sifive_hifive1_init;
>> +    mc->max_cpus = 1;
>> +}
>> +
>> +DEFINE_MACHINE("sifive-hifive1", riscv_sifive_hifive1_machine_init)
>> +#endif
>> +
>>  static void riscv_sifive_e_soc_class_init(ObjectClass *oc, void *data)
>>  {
>>      DeviceClass *dc = DEVICE_CLASS(oc);
>> diff --git a/hw/riscv/sifive_u.c b/hw/riscv/sifive_u.c
>> index ef07df244241..0ce6a9dd2609 100644
>> --- a/hw/riscv/sifive_u.c
>> +++ b/hw/riscv/sifive_u.c
>> @@ -238,6 +238,8 @@ static void create_fdt(SiFiveUState *s, const struct MemmapEntry *memmap,
>>
>>  static void riscv_sifive_u_init(MachineState *machine)
>>  {
>> +    warn_report("The sifive_u machine is deprecated.");
>
> FWIW, you can also simply set MachineClass->deprecation_reason nowadays
> instead of manually issuing a warn_report() and tweaking the description
> ... that would be a little bit easier and is in sync with the other
> deprecated boards (see e.g. commit 08fe68244 or 54c86f5a4844d51 for
> other examples).

Perfect, thanks!  I couldn't find anything when grepping around, the explicit 
warning seemed a bit ugly.

I'll spin another patch set.
diff mbox series

Patch

diff --git a/hw/riscv/sifive_e.c b/hw/riscv/sifive_e.c
index cb513cc3bb50..439d20e0efe7 100644
--- a/hw/riscv/sifive_e.c
+++ b/hw/riscv/sifive_e.c
@@ -95,7 +95,7 @@  static void sifive_mmio_emulate(MemoryRegion *parent, const char *name,
     memory_region_add_subregion(parent, offset, mock_mmio);
 }
 
-static void riscv_sifive_e_init(MachineState *machine)
+static void riscv_sifive_hifive1_init(MachineState *machine)
 {
     const struct MemmapEntry *memmap = sifive_e_memmap;
 
@@ -135,6 +135,17 @@  static void riscv_sifive_e_init(MachineState *machine)
     }
 }
 
+static void riscv_sifive_e_init(MachineState *machine)
+{
+#if defined(TARGET_RISCV32)
+    warn_report("The sifive_e machine is deprecated in favor of sifive-hifive1");
+#else
+    warn_report("The sifive_e machine is deprecated.");
+#endif
+
+    return riscv_sifive_hifive1_init(machine);
+}
+
 static void riscv_sifive_e_soc_init(Object *obj)
 {
     SiFiveESoCState *s = RISCV_E_SOC(obj);
@@ -213,13 +224,24 @@  static void riscv_sifive_e_soc_realize(DeviceState *dev, Error **errp)
 
 static void riscv_sifive_e_machine_init(MachineClass *mc)
 {
-    mc->desc = "RISC-V Board compatible with SiFive E SDK";
+    mc->desc = "(deprecated) RISC-V Board compatible with SiFive E SDK";
     mc->init = riscv_sifive_e_init;
     mc->max_cpus = 1;
 }
 
 DEFINE_MACHINE("sifive_e", riscv_sifive_e_machine_init)
 
+#if defined(TARGET_RISCV32)
+static void riscv_sifive_hifive1_machine_init(MachineClass *mc)
+{
+    mc->desc = "SiFive's HiFive1 Development Board";
+    mc->init = riscv_sifive_hifive1_init;
+    mc->max_cpus = 1;
+}
+
+DEFINE_MACHINE("sifive-hifive1", riscv_sifive_hifive1_machine_init)
+#endif
+
 static void riscv_sifive_e_soc_class_init(ObjectClass *oc, void *data)
 {
     DeviceClass *dc = DEVICE_CLASS(oc);
diff --git a/hw/riscv/sifive_u.c b/hw/riscv/sifive_u.c
index ef07df244241..0ce6a9dd2609 100644
--- a/hw/riscv/sifive_u.c
+++ b/hw/riscv/sifive_u.c
@@ -238,6 +238,8 @@  static void create_fdt(SiFiveUState *s, const struct MemmapEntry *memmap,
 
 static void riscv_sifive_u_init(MachineState *machine)
 {
+    warn_report("The sifive_u machine is deprecated.");
+
     const struct MemmapEntry *memmap = sifive_u_memmap;
 
     SiFiveUState *s = g_new0(SiFiveUState, 1);
diff --git a/qemu-deprecated.texi b/qemu-deprecated.texi
index cb4291f1e5bc..f50696d3dc53 100644
--- a/qemu-deprecated.texi
+++ b/qemu-deprecated.texi
@@ -148,6 +148,13 @@  This machine type uses an unmaintained firmware, broken in lots of ways,
 and unable to start post-2004 operating systems. 40p machine type should be
 used instead.
 
+@subsection sifive_e and sifive_u (RISC-V) (since 3.2)
+
+The names for these machine types are a bit too ambiguous.  The 32-bit sifive_e
+machine has been replaced by the 'sifive-hifive1' machine, which closely
+matches that hardware.  The 'virt' machine type should be used instead of all
+others.
+
 @section Device options
 
 @subsection Block device options