On Wed, Mar 12, 2025 at 7:43 PM Ethan Chen via <qemu-devel@nongnu.org> wrote:
>
> - Add 'iopmp=on' option to enable IOPMP. It adds iopmp devices virt machine
>   to protect all regions of system memory.
>
> Signed-off-by: Ethan Chen <etha...@andestech.com>
> ---
>  docs/specs/index.rst       |  1 +
>  docs/specs/riscv-iopmp.rst | 60 ++++++++++++++++++++++++++++++
>  docs/system/riscv/virt.rst |  9 +++++
>  hw/riscv/Kconfig           |  1 +
>  hw/riscv/virt.c            | 75 ++++++++++++++++++++++++++++++++++++++
>  include/hw/riscv/virt.h    |  3 ++
>  6 files changed, 149 insertions(+)
>  create mode 100644 docs/specs/riscv-iopmp.rst
>
> diff --git a/docs/specs/index.rst b/docs/specs/index.rst
> index f19d73c9f6..0871c17b8f 100644
> --- a/docs/specs/index.rst
> +++ b/docs/specs/index.rst
> @@ -39,3 +39,4 @@ guest hardware that is specific to QEMU.
>     riscv-iommu
>     riscv-aia
>     aspeed-intc
> +   riscv-iopmp
> diff --git a/docs/specs/riscv-iopmp.rst b/docs/specs/riscv-iopmp.rst
> new file mode 100644
> index 0000000000..36a395e552
> --- /dev/null
> +++ b/docs/specs/riscv-iopmp.rst
> @@ -0,0 +1,60 @@
> +.. _riscv-iopmp:
> +
> +RISC-V IOPMP support for RISC-V machines
> +========================================
> +
> +IOPMP support is based on `IOPMP specification version 0.7`_. The device is
> +available on the RISC-V virt machine but is disabled by default. To enable
> +iopmp device, use the 'iopmp' machine option
> +
> +.. code-block:: bash
> +
> +  $ qemu-system-riscv64 -M virt,iopmp=on
> +
> +On the virt board, the number of IOPMP device is fixed at 1, and its protect
> +region is fixed to 0x0~0xFFFFFFFF.
> +
> +To configure IOPMP device, modify gloal driver property
> +
> +.. code-block:: bash
> +
> +  -global driver=riscv_iopmp, property=<property>, value=<value>
> +
> +Below are the IOPMP device properties and their default values:
> +
> +- mdcfg_fmt: 1 (Options: 0/1/2)
> +- srcmd_fmt: 0 (Options: 0/1/2)
> +- tor_en: true (Options: true/false)
> +- sps_en: false (Options: true/false)
> +- prient_prog: true (Options: true/false)
> +- rrid_transl_en: false (Options: true/false)
> +- rrid_transl_prog: false (Options: true/false)
> +- chk_x: true (Options: true/false)
> +- no_x: false (Options: true/false)
> +- no_w: false (Options: true/false)
> +- stall_en: false (Options: true/false)
> +- peis: true (Options: true/false)
> +- pees: true (Options: true/false)
> +- mfr_en: true (Options: true/false)
> +- md_entry_num: 5 (IMP: Valid only for mdcfg_fmt 1/2)
> +- md_num: 8 (Range: 0-63)
> +- rrid_num: 16 (Range: srcmd_fmt ≠ 2: 0-65535, srcmd_fmt = 2: 0-32)
> +- entry_num: 48 (Range: 0-IMP. For mdcfg_fmt = 1,
> +  it is fixed as md_num * (md_entry_num + 1).
> +  Entry registers must not overlap with other registers.)
> +- prio_entry: 65535 (Range: 0-IMP. If prio_entry > entry_num,
> +  it will be set to entry_num.)
> +- rrid_transl: 0x0 (Range: 0-65535)
> +- entry_offset: 0x4000 (IMP: Entry registers must not overlap
> +  with other registers.)
> +- err_rdata: 0x0 (uint32. Specifies the value used in responses to
> +  read transactions when errors are suppressed)
> +- msi_en: false (Options: true/false)
> +- msidata: 12 (Range: 1-1023)
> +- stall_violation_en: true (Options: true/false)
> +- err_msiaddr: 0x24000000 (lower-part 32-bit address)
> +- err_msiaddrh: 0x0 (higher-part 32-bit address)
> +- msi_rrid: 0 (Range: 0-65535. Specifies the rrid used by the IOPMP to send
> +  the MSI.)

I'm not sure this is clear to a user, what are people supposed to do
with all these values?

Alistair

> +
> +.. _IOPMP specification version 0.7: 
> https://github.com/riscv-non-isa/iopmp-spec/releases/download/v0.7/iopmp-v0.7.pdf
> diff --git a/docs/system/riscv/virt.rst b/docs/system/riscv/virt.rst
> index 60850970ce..77c8d386d5 100644
> --- a/docs/system/riscv/virt.rst
> +++ b/docs/system/riscv/virt.rst
> @@ -146,6 +146,15 @@ The following machine-specific options are supported:
>
>    Enables the riscv-iommu-sys platform device. Defaults to 'off'.
>
> +- iopmp=[on|off]
> +
> +  When this option is "on", IOPMP devices are added to machine. IOPMP checks
> +  memory transcations in system memory. This option is assumed to be "off". 
> To
> +  enable the CPU to perform transactions with a specified RRID, use the CPU
> +  option "-cpu <cpu>,iopmp=true,iopmp_rrid=<rrid>"
> +
> +  See :ref:`riscv-iopmp` for configurations of IOPMP
> +
>  Running Linux kernel
>  --------------------
>
> diff --git a/hw/riscv/Kconfig b/hw/riscv/Kconfig
> index e6a0ac1fa1..637438af2c 100644
> --- a/hw/riscv/Kconfig
> +++ b/hw/riscv/Kconfig
> @@ -68,6 +68,7 @@ config RISCV_VIRT
>      select PLATFORM_BUS
>      select ACPI
>      select ACPI_PCI
> +    select RISCV_IOPMP
>
>  config SHAKTI_C
>      bool
> diff --git a/hw/riscv/virt.c b/hw/riscv/virt.c
> index dae46f4733..0d62e7786c 100644
> --- a/hw/riscv/virt.c
> +++ b/hw/riscv/virt.c
> @@ -57,6 +57,8 @@
>  #include "hw/acpi/aml-build.h"
>  #include "qapi/qapi-visit-common.h"
>  #include "hw/virtio/virtio-iommu.h"
> +#include "hw/misc/riscv_iopmp.h"
> +#include "hw/misc/riscv_iopmp_dispatcher.h"
>
>  /* KVM AIA only supports APLIC MSI. APLIC Wired is always emulated by QEMU. 
> */
>  static bool virt_use_kvm_aia_aplic_imsic(RISCVVirtAIAType aia_type)
> @@ -94,6 +96,7 @@ static const MemMapEntry virt_memmap[] = {
>      [VIRT_UART0] =        { 0x10000000,         0x100 },
>      [VIRT_VIRTIO] =       { 0x10001000,        0x1000 },
>      [VIRT_FW_CFG] =       { 0x10100000,          0x18 },
> +    [VIRT_IOPMP] =        { 0x10200000,      0x100000 },
>      [VIRT_FLASH] =        { 0x20000000,     0x4000000 },
>      [VIRT_IMSIC_M] =      { 0x24000000, VIRT_IMSIC_MAX_SIZE },
>      [VIRT_IMSIC_S] =      { 0x28000000, VIRT_IMSIC_MAX_SIZE },
> @@ -102,6 +105,11 @@ static const MemMapEntry virt_memmap[] = {
>      [VIRT_DRAM] =         { 0x80000000,           0x0 },
>  };
>
> +static const MemMapEntry iopmp_protect_memmap[] = {
> +    /* IOPMP protect all regions by default */
> +    {0x0, 0xFFFFFFFF},
> +};
> +
>  /* PCIe high mmio is fixed for RV32 */
>  #define VIRT32_HIGH_PCIE_MMIO_BASE  0x300000000ULL
>  #define VIRT32_HIGH_PCIE_MMIO_SIZE  (4 * GiB)
> @@ -1118,6 +1126,24 @@ static void create_fdt_iommu(RISCVVirtState *s, 
> uint16_t bdf)
>                             bdf + 1, iommu_phandle, bdf + 1, 0xffff - bdf);
>  }
>
> +static void create_fdt_iopmp(RISCVVirtState *s, const MemMapEntry *memmap,
> +                             uint32_t irq_mmio_phandle) {
> +    g_autofree char *name = NULL;
> +    MachineState *ms = MACHINE(s);
> +
> +    name = g_strdup_printf("/soc/iopmp@%lx", (long)memmap[VIRT_IOPMP].base);
> +    qemu_fdt_add_subnode(ms->fdt, name);
> +    qemu_fdt_setprop_string(ms->fdt, name, "compatible", "riscv_iopmp");
> +    qemu_fdt_setprop_cells(ms->fdt, name, "reg", 0x0, 
> memmap[VIRT_IOPMP].base,
> +        0x0, memmap[VIRT_IOPMP].size);
> +    qemu_fdt_setprop_cell(ms->fdt, name, "interrupt-parent", 
> irq_mmio_phandle);
> +    if (s->aia_type == VIRT_AIA_TYPE_NONE) {
> +        qemu_fdt_setprop_cell(ms->fdt, name, "interrupts", IOPMP_IRQ);
> +    } else {
> +        qemu_fdt_setprop_cells(ms->fdt, name, "interrupts", IOPMP_IRQ, 0x4);
> +    }
> +}
> +
>  static void finalize_fdt(RISCVVirtState *s)
>  {
>      uint32_t phandle = 1, irq_mmio_phandle = 1, msi_pcie_phandle = 1;
> @@ -1142,6 +1168,10 @@ static void finalize_fdt(RISCVVirtState *s)
>      create_fdt_uart(s, virt_memmap, irq_mmio_phandle);
>
>      create_fdt_rtc(s, virt_memmap, irq_mmio_phandle);
> +
> +    if (s->have_iopmp) {
> +        create_fdt_iopmp(s, virt_memmap, irq_mmio_phandle);
> +    }
>  }
>
>  static void create_fdt(RISCVVirtState *s, const MemMapEntry *memmap)
> @@ -1532,6 +1562,8 @@ static void virt_machine_init(MachineState *machine)
>      DeviceState *mmio_irqchip, *virtio_irqchip, *pcie_irqchip;
>      int i, base_hartid, hart_count;
>      int socket_count = riscv_socket_count(machine);
> +    DeviceState *iopmp_dev, *iopmp_disp_dev;
> +    StreamSink *iopmp_ss, *iopmp_disp_ss;
>
>      /* Check socket count limit */
>      if (VIRT_SOCKETS_MAX < socket_count) {
> @@ -1713,6 +1745,29 @@ static void virt_machine_init(MachineState *machine)
>      }
>      virt_flash_map(s, system_memory);
>
> +    if (s->have_iopmp) {
> +        iopmp_dev = iopmp_create(memmap[VIRT_IOPMP].base,
> +            qdev_get_gpio_in(DEVICE(mmio_irqchip), IOPMP_IRQ));
> +
> +        iopmp_setup_system_memory(iopmp_dev, &iopmp_protect_memmap[0], 1, 0);
> +
> +        iopmp_disp_dev = qdev_new(TYPE_RISCV_IOPMP_DISP);
> +        qdev_prop_set_uint32(DEVICE(iopmp_disp_dev), "target-num", 1);
> +        qdev_prop_set_uint32(DEVICE(iopmp_disp_dev), "stage-num", 1);
> +        qdev_realize(DEVICE(iopmp_disp_dev), NULL, &error_fatal);
> +
> +        /* Add memmap inforamtion to dispatcher */
> +        iopmp_ss = (StreamSink *)&(RISCV_IOPMP(iopmp_dev)->txn_info_sink);
> +        iopmp_dispatcher_add_target(DEVICE(iopmp_disp_dev), iopmp_ss,
> +                                    iopmp_protect_memmap[0].base,
> +                                    iopmp_protect_memmap[0].size,
> +                                    0, 0);
> +
> +        iopmp_disp_ss =
> +            (StreamSink *)&(RISCV_IOPMP_DISP(iopmp_disp_dev)->txn_info_sink);
> +        iopmp_setup_sink(iopmp_dev, iopmp_disp_ss);
> +    }
> +
>      /* load/create device tree */
>      if (machine->dtb) {
>          machine->fdt = load_device_tree(machine->dtb, &s->fdt_size);
> @@ -1848,6 +1903,20 @@ static void virt_set_iommu_sys(Object *obj, Visitor 
> *v, const char *name,
>      visit_type_OnOffAuto(v, name, &s->iommu_sys, errp);
>  }
>
> +static bool virt_get_iopmp(Object *obj, Error **errp)
> +{
> +    RISCVVirtState *s = RISCV_VIRT_MACHINE(obj);
> +
> +    return s->have_iopmp;
> +}
> +
> +static void virt_set_iopmp(Object *obj, bool value, Error **errp)
> +{
> +    RISCVVirtState *s = RISCV_VIRT_MACHINE(obj);
> +
> +    s->have_iopmp = value;
> +}
> +
>  bool virt_is_acpi_enabled(RISCVVirtState *s)
>  {
>      return s->acpi != ON_OFF_AUTO_OFF;
> @@ -1975,6 +2044,12 @@ static void virt_machine_class_init(ObjectClass *oc, 
> void *data)
>                                NULL, NULL);
>      object_class_property_set_description(oc, "iommu-sys",
>                                            "Enable IOMMU platform device");
> +
> +    object_class_property_add_bool(oc, "iopmp", virt_get_iopmp,
> +                                   virt_set_iopmp);
> +    object_class_property_set_description(oc, "iopmp",
> +                                          "Set on/off to enable/disable "
> +                                          "iopmp device");
>  }
>
>  static const TypeInfo virt_machine_typeinfo = {
> diff --git a/include/hw/riscv/virt.h b/include/hw/riscv/virt.h
> index 48a14bea2e..cf1e5bd872 100644
> --- a/include/hw/riscv/virt.h
> +++ b/include/hw/riscv/virt.h
> @@ -55,6 +55,7 @@ struct RISCVVirtState {
>
>      int fdt_size;
>      bool have_aclint;
> +    bool have_iopmp;
>      RISCVVirtAIAType aia_type;
>      int aia_guests;
>      char *oem_id;
> @@ -87,11 +88,13 @@ enum {
>      VIRT_PLATFORM_BUS,
>      VIRT_PCIE_ECAM,
>      VIRT_IOMMU_SYS,
> +    VIRT_IOPMP,
>  };
>
>  enum {
>      UART0_IRQ = 10,
>      RTC_IRQ = 11,
> +    IOPMP_IRQ = 12,
>      VIRTIO_IRQ = 1, /* 1 to 8 */
>      VIRTIO_COUNT = 8,
>      PCIE_IRQ = 0x20, /* 32 to 35 */
> --
> 2.34.1
>
>

Reply via email to