[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH qemu 1/3] hw/misc: Implement STM32L4xx SYSCFG
From: |
Alistair Francis |
Subject: |
Re: [PATCH qemu 1/3] hw/misc: Implement STM32L4xx SYSCFG |
Date: |
Mon, 18 Dec 2023 13:52:13 +1000 |
On Mon, Dec 11, 2023 at 5:06 AM ~inesvarhol <inesvarhol@git.sr.ht> wrote:
>
> From: Inès Varhol <ines.varhol@telecom-paris.fr>
>
> Signed-off-by: Arnaud Minier <arnaud.minier@telecom-paris.fr>
> Signed-off-by: Inès Varhol <ines.varhol@telecom-paris.fr>
> ---
> hw/misc/Kconfig | 3 +
> hw/misc/meson.build | 1 +
> hw/misc/stm32l4xx_syscfg.c | 277 +++++++++++++++++++++++++++++
> hw/misc/trace-events | 6 +
> include/hw/misc/stm32l4xx_syscfg.h | 62 +++++++
> 5 files changed, 349 insertions(+)
> create mode 100644 hw/misc/stm32l4xx_syscfg.c
> create mode 100644 include/hw/misc/stm32l4xx_syscfg.h
>
> diff --git a/hw/misc/Kconfig b/hw/misc/Kconfig
> index 3efe3dc2cc..a20427a9be 100644
> --- a/hw/misc/Kconfig
> +++ b/hw/misc/Kconfig
> @@ -90,6 +90,9 @@ config STM32F4XX_EXTI
> config STM32L4X5_EXTI
> bool
>
> +config STM32L4XX_SYSCFG
> + bool
> +
> config MIPS_ITU
> bool
>
> diff --git a/hw/misc/meson.build b/hw/misc/meson.build
> index 16db6e228d..120c59d9f4 100644
> --- a/hw/misc/meson.build
> +++ b/hw/misc/meson.build
> @@ -111,6 +111,7 @@ system_ss.add(when: 'CONFIG_STM32F2XX_SYSCFG', if_true:
> files('stm32f2xx_syscfg.
> system_ss.add(when: 'CONFIG_STM32F4XX_SYSCFG', if_true:
> files('stm32f4xx_syscfg.c'))
> system_ss.add(when: 'CONFIG_STM32F4XX_EXTI', if_true:
> files('stm32f4xx_exti.c'))
> system_ss.add(when: 'CONFIG_STM32L4X5_EXTI', if_true:
> files('stm32l4x5_exti.c'))
> +system_ss.add(when: 'CONFIG_STM32L4XX_SYSCFG', if_true:
> files('stm32l4xx_syscfg.c'))
> system_ss.add(when: 'CONFIG_MPS2_FPGAIO', if_true: files('mps2-fpgaio.c'))
> system_ss.add(when: 'CONFIG_MPS2_SCC', if_true: files('mps2-scc.c'))
>
> diff --git a/hw/misc/stm32l4xx_syscfg.c b/hw/misc/stm32l4xx_syscfg.c
> new file mode 100644
> index 0000000000..a8ef370117
> --- /dev/null
> +++ b/hw/misc/stm32l4xx_syscfg.c
> @@ -0,0 +1,277 @@
> +/*
> + * STM32L4xx SYSCFG (System Configuration Controller)
> + *
> + * Copyright (c) 2014 Alistair Francis <alistair@alistair23.me>
> + * Copyright (c) 2023 Arnaud Minier <arnaud.minier@telecom-paris.fr>
> + * Copyright (c) 2023 Inès Varhol <ines.varhol@telecom-paris.fr>
> + *
> + * SPDX-License-Identifier: GPL-2.0-or-later
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> copy
> + * of this software and associated documentation files (the "Software"), to
> deal
> + * in the Software without restriction, including without limitation the
> rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
> + *
> + * Based on the stm32f4xx_syscfg by Alistair Francis.
> + * The reference used is the STMicroElectronics RM0351 Reference manual
> + * for STM32L4x5 and STM32L4x6 advanced Arm ® -based 32-bit MCUs.
> + *
> https://www.st.com/en/microcontrollers-microprocessors/stm32l4x5/documentation.html
> + */
> +
> +#include "qemu/osdep.h"
> +#include "qemu/log.h"
> +#include "trace.h"
> +#include "hw/irq.h"
> +#include "migration/vmstate.h"
> +#include "hw/misc/stm32l4xx_syscfg.h"
> +
> +#define NUM_GPIOS 7
> +
> +#define SYSCFG_MEMRMP 0x00
> +#define SYSCFG_CFGR1 0x04
> +#define SYSCFG_EXTICR1 0x08
> +#define SYSCFG_EXTICR2 0x0C
> +#define SYSCFG_EXTICR3 0x10
> +#define SYSCFG_EXTICR4 0x14
> +#define SYSCFG_SCSR 0x18
> +#define SYSCFG_CFGR2 0x1C
> +#define SYSCFG_SWPR 0x20
> +#define SYSCFG_SKR 0x24
> +#define SYSCFG_SWPR2 0x28
> +
> +/* 00000000_00000000_00000001_00000111 */
> +#define ACTIVABLE_BITS_MEMRP 0x00000107
> +
> +/* 11111100_11111111_00000001_00000000 */
> +#define ACTIVABLE_BITS_CFGR1 0xFCFF0100
> +/* 00000000_00000000_00000000_00000001 */
> +#define FIREWALL_DISABLE_CFGR1 0x00000001
> +
> +/* 00000000_00000000_00000000_00000001 */
> +#define ACTIVABLE_BITS_EXTICR 0x0000FFFF
This doesn't match the comment
> +
> +/* 00000000_00000000_00000000_00000011 */
> +/* #define ACTIVABLE_BITS_SCSR 0x00000003 */
> +
> +/* 00000000_00000000_00000000_00001111 */
> +#define ECC_LOCK_CFGR2 0x0000000F
> +/* 00000000_00000000_00000001_00000000 */
> +#define SRAM2_PARITY_ERROR_FLAG_CFGR2 0x00000100
> +
> +/* 00000000_00000000_00000000_11111111 */
> +#define ACTIVABLE_BITS_SKR 0x000000FF
> +
> +static void stm32l4xx_syscfg_hold_reset(Object *obj)
> +{
> + STM32L4xxSyscfgState *s = STM32L4XX_SYSCFG(obj);
> +
> + s->memrmp = 0x00000000;
> + s->cfgr1 = 0x7C000001;
> + s->exticr[0] = 0x00000000;
> + s->exticr[1] = 0x00000000;
> + s->exticr[2] = 0x00000000;
> + s->exticr[3] = 0x00000000;
> + s->scsr = 0x00000000;
> + s->cfgr2 = 0x00000000;
> + s->swpr = 0x00000000;
> + s->skr = 0x00000000;
> + s->swpr2 = 0x00000000;
> +}
> +
> +static void stm32l4xx_syscfg_set_irq(void *opaque, int irq, int level)
> +{
> + STM32L4xxSyscfgState *s = opaque;
> + uint8_t gpio = irq / 16;
> + g_assert(gpio < NUM_GPIOS);
> +
> + int line = irq % 16;
> + int exticr_reg = line / 4;
> + int startbit = (irq % 4) * 4;
> +
> + trace_stm32l4xx_syscfg_set_irq(gpio, irq % 16, level);
`irq % 16` is just `line`
Also it would probably be worth replacing the 16 with a macro.
Otherwise looks good
Alistair
> +
> + if (extract32(s->exticr[exticr_reg], startbit, 4) == gpio) {
> + trace_stm32l4xx_syscfg_pulse_exti(line);
> + qemu_set_irq(s->gpio_out[line], level);
> + }
> +}
> +
> +static uint64_t stm32l4xx_syscfg_read(void *opaque, hwaddr addr,
> + unsigned int size)
> +{
> + STM32L4xxSyscfgState *s = opaque;
> +
> + trace_stm32l4xx_syscfg_read(addr);
> +
> + switch (addr) {
> + case SYSCFG_MEMRMP:
> + return s->memrmp;
> + case SYSCFG_CFGR1:
> + return s->cfgr1;
> + case SYSCFG_EXTICR1...SYSCFG_EXTICR4:
> + return s->exticr[(addr - SYSCFG_EXTICR1) / 4];
> + case SYSCFG_SCSR:
> + return s->scsr;
> + case SYSCFG_CFGR2:
> + return s->cfgr2;
> + case SYSCFG_SWPR:
> + return s->swpr;
> + case SYSCFG_SKR:
> + return s->skr;
> + case SYSCFG_SWPR2:
> + return s->swpr2;
> + default:
> + qemu_log_mask(LOG_GUEST_ERROR,
> + "%s: Bad offset 0x%"HWADDR_PRIx"\n", __func__, addr);
> + return 0;
> + }
> +}
> +
> +static void stm32l4xx_syscfg_write(void *opaque, hwaddr addr,
> + uint64_t val64, unsigned int size)
> +{
> + STM32L4xxSyscfgState *s = opaque;
> + uint32_t value = val64;
> +
> + trace_stm32l4xx_syscfg_write(value, addr);
> +
> + switch (addr) {
> + case SYSCFG_MEMRMP:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Changing the memory mapping isn't supported\n",
> + __func__);
> + s->memrmp = value & ACTIVABLE_BITS_MEMRP;
> + return;
> + case SYSCFG_CFGR1:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Functions in CFGRx aren't supported\n",
> + __func__);
> + /* bit 0 (firewall dis.) is cleared by software, set only by reset.
> */
> + s->cfgr1 = (s->cfgr1 & value & FIREWALL_DISABLE_CFGR1) |
> + (value & ACTIVABLE_BITS_CFGR1);
> + return;
> + case SYSCFG_EXTICR1...SYSCFG_EXTICR4:
> + s->exticr[(addr - SYSCFG_EXTICR1) / 4] =
> + (value & ACTIVABLE_BITS_EXTICR);
> + return;
> + case SYSCFG_SCSR:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Erasing SRAM2 isn't supported\n",
> + __func__);
> + /*
> + * only non reserved bits are :
> + * bit 0 (write-protected by a passkey), bit 1 (meant to be read)
> + * so it serves no purpose yet to add :
> + * s->scsr = value & 0x3;
> + */
> + return;
> + case SYSCFG_CFGR2:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Functions in CFGRx aren't supported\n",
> + __func__);
> + /* bit 8 (SRAM2 PEF) is cleared by software by writing a '1'.*/
> + /* bits[3:0] (ECC Lock) are set by software, cleared only by reset.*/
> + s->cfgr2 = (s->cfgr2 | (value & ECC_LOCK_CFGR2)) &
> + ~(value & SRAM2_PARITY_ERROR_FLAG_CFGR2);
> + return;
> + case SYSCFG_SWPR:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Write protecting SRAM2 isn't supported\n",
> + __func__);
> + /* These bits are set by software and cleared only by reset.*/
> + s->swpr |= value;
> + return;
> + case SYSCFG_SKR:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Erasing SRAM2 isn't supported\n",
> + __func__);
> + s->skr = value & ACTIVABLE_BITS_SKR;
> + return;
> + case SYSCFG_SWPR2:
> + qemu_log_mask(LOG_UNIMP,
> + "%s: Write protecting SRAM2 isn't supported\n",
> + __func__);
> + /* These bits are set by software and cleared only by reset.*/
> + s->swpr2 |= value;
> + return;
> + default:
> + qemu_log_mask(LOG_GUEST_ERROR,
> + "%s: Bad offset 0x%"HWADDR_PRIx"\n", __func__, addr);
> + }
> +}
> +
> +static const MemoryRegionOps stm32l4xx_syscfg_ops = {
> + .read = stm32l4xx_syscfg_read,
> + .write = stm32l4xx_syscfg_write,
> + .endianness = DEVICE_NATIVE_ENDIAN,
> + .impl.min_access_size = 4,
> + .impl.max_access_size = 4,
> + .impl.unaligned = false,
> + .valid.min_access_size = 4,
> + .valid.max_access_size = 4,
> + .valid.unaligned = false,
> +};
> +
> +static void stm32l4xx_syscfg_init(Object *obj)
> +{
> + STM32L4xxSyscfgState *s = STM32L4XX_SYSCFG(obj);
> +
> + memory_region_init_io(&s->mmio, obj, &stm32l4xx_syscfg_ops, s,
> + TYPE_STM32L4XX_SYSCFG, 0x400);
> + sysbus_init_mmio(SYS_BUS_DEVICE(obj), &s->mmio);
> +
> + qdev_init_gpio_in(DEVICE(obj), stm32l4xx_syscfg_set_irq, 16 * NUM_GPIOS);
> + qdev_init_gpio_out(DEVICE(obj), s->gpio_out, 16);
> +}
> +
> +static const VMStateDescription vmstate_stm32l4xx_syscfg = {
> + .name = TYPE_STM32L4XX_SYSCFG,
> + .version_id = 1,
> + .minimum_version_id = 1,
> + .fields = (VMStateField[]) {
> + VMSTATE_UINT32(memrmp, STM32L4xxSyscfgState),
> + VMSTATE_UINT32(cfgr1, STM32L4xxSyscfgState),
> + VMSTATE_UINT32_ARRAY(exticr, STM32L4xxSyscfgState,
> + SYSCFG_NUM_EXTICR),
> + VMSTATE_UINT32(scsr, STM32L4xxSyscfgState),
> + VMSTATE_UINT32(cfgr2, STM32L4xxSyscfgState),
> + VMSTATE_UINT32(swpr, STM32L4xxSyscfgState),
> + VMSTATE_UINT32(skr, STM32L4xxSyscfgState),
> + VMSTATE_UINT32(swpr2, STM32L4xxSyscfgState),
> + VMSTATE_END_OF_LIST()
> + }
> +};
> +
> +static void stm32l4xx_syscfg_class_init(ObjectClass *klass, void *data)
> +{
> + DeviceClass *dc = DEVICE_CLASS(klass);
> + ResettableClass *rc = RESETTABLE_CLASS(klass);
> +
> + dc->vmsd = &vmstate_stm32l4xx_syscfg;
> + rc->phases.hold = stm32l4xx_syscfg_hold_reset;
> +}
> +
> +static const TypeInfo stm32l4xx_syscfg_info[] = {
> + {
> + .name = TYPE_STM32L4XX_SYSCFG,
> + .parent = TYPE_SYS_BUS_DEVICE,
> + .instance_size = sizeof(STM32L4xxSyscfgState),
> + .instance_init = stm32l4xx_syscfg_init,
> + .class_init = stm32l4xx_syscfg_class_init,
> + }
> +};
> +
> +DEFINE_TYPES(stm32l4xx_syscfg_info)
> diff --git a/hw/misc/trace-events b/hw/misc/trace-events
> index 2f01c62c0e..756cb45bd6 100644
> --- a/hw/misc/trace-events
> +++ b/hw/misc/trace-events
> @@ -163,6 +163,12 @@ stm32f4xx_exti_set_irq(int irq, int level) "Set EXTI: %d
> to %d"
> stm32f4xx_exti_read(uint64_t addr) "reg read: addr: 0x%" PRIx64 " "
> stm32f4xx_exti_write(uint64_t addr, uint64_t data) "reg write: addr: 0x%"
> PRIx64 " val: 0x%" PRIx64 ""
>
> +# stm32l4xx_syscfg.c
> +stm32l4xx_syscfg_set_irq(int gpio, int line, int level) "irq from GPIO: %d,
> line: %d, level: %d"
> +stm32l4xx_syscfg_pulse_exti(int irq) "irq %d forwarded to EXTI"
> +stm32l4xx_syscfg_read(uint64_t addr) "reg read: addr: 0x%" PRIx64 " "
> +stm32l4xx_syscfg_write(uint64_t addr, uint64_t data) "reg write: addr: 0x%"
> PRIx64 " val: 0x%" PRIx64 ""
> +
> # stm32l4x5_exti.c
> stm32l4x5_exti_set_irq(int irq, int level) "Set EXTI: %d to %d"
> stm32l4x5_exti_read(uint64_t addr, uint64_t data) "reg read: addr: 0x%"
> PRIx64 " val: 0x%" PRIx64 ""
> diff --git a/include/hw/misc/stm32l4xx_syscfg.h
> b/include/hw/misc/stm32l4xx_syscfg.h
> new file mode 100644
> index 0000000000..d9ed4da74e
> --- /dev/null
> +++ b/include/hw/misc/stm32l4xx_syscfg.h
> @@ -0,0 +1,62 @@
> +/*
> + * STM32L4xx SYSCFG (System Configuration Controller)
> + *
> + * Copyright (c) 2014 Alistair Francis <alistair@alistair23.me>
> + * Copyright (c) 2023 Arnaud Minier <arnaud.minier@telecom-paris.fr>
> + * Copyright (c) 2023 Inès Varhol <ines.varhol@telecom-paris.fr>
> + *
> + * SPDX-License-Identifier: GPL-2.0-or-later
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> copy
> + * of this software and associated documentation files (the "Software"), to
> deal
> + * in the Software without restriction, including without limitation the
> rights
> + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> + * copies of the Software, and to permit persons to whom the Software is
> + * furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice shall be included in
> + * all copies or substantial portions of the Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> FROM,
> + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
> + * THE SOFTWARE.
> + *
> + * Based on the stm32f4xx_syscfg by Alistair Francis.
> + * The reference used is the STMicroElectronics RM0351 Reference manual
> + * for STM32L4x5 and STM32L4x6 advanced Arm ® -based 32-bit MCUs.
> + *
> https://www.st.com/en/microcontrollers-microprocessors/stm32l4x5/documentation.html
> + */
> +
> +#ifndef HW_STM32L4XX_SYSCFG_H
> +#define HW_STM32L4XX_SYSCFG_H
> +
> +#include "hw/sysbus.h"
> +#include "qom/object.h"
> +
> +#define TYPE_STM32L4XX_SYSCFG "stm32l4xx-syscfg"
> +OBJECT_DECLARE_SIMPLE_TYPE(STM32L4xxSyscfgState, STM32L4XX_SYSCFG)
> +
> +#define SYSCFG_NUM_EXTICR 4
> +
> +struct STM32L4xxSyscfgState {
> + SysBusDevice parent_obj;
> +
> + MemoryRegion mmio;
> +
> + uint32_t memrmp;
> + uint32_t cfgr1;
> + uint32_t exticr[SYSCFG_NUM_EXTICR];
> + uint32_t scsr;
> + uint32_t cfgr2;
> + uint32_t swpr;
> + uint32_t skr;
> + uint32_t swpr2;
> +
> + qemu_irq gpio_out[16];
> +};
> +
> +#endif
> --
> 2.38.5
>
>