16eee5d24SPeter Maydell /* 20829d24eSPeter Maydell * ARM SSE (Subsystems for Embedded): IoTKit, SSE-200 36eee5d24SPeter Maydell * 46eee5d24SPeter Maydell * Copyright (c) 2018 Linaro Limited 56eee5d24SPeter Maydell * Written by Peter Maydell 66eee5d24SPeter Maydell * 76eee5d24SPeter Maydell * This program is free software; you can redistribute it and/or modify 86eee5d24SPeter Maydell * it under the terms of the GNU General Public License version 2 or 96eee5d24SPeter Maydell * (at your option) any later version. 106eee5d24SPeter Maydell */ 116eee5d24SPeter Maydell 126eee5d24SPeter Maydell /* 136eee5d24SPeter Maydell * This is a model of the Arm "Subsystems for Embedded" family of 146eee5d24SPeter Maydell * hardware, which include the IoT Kit and the SSE-050, SSE-100 and 150829d24eSPeter Maydell * SSE-200. Currently we model: 160829d24eSPeter Maydell * - the Arm IoT Kit which is documented in 1750b52b18SPeter Maydell * https://developer.arm.com/documentation/ecm0601256/latest 180829d24eSPeter Maydell * - the SSE-200 which is documented in 1950b52b18SPeter Maydell * https://developer.arm.com/documentation/101104/latest/ 200829d24eSPeter Maydell * 210829d24eSPeter Maydell * The IoTKit contains: 226eee5d24SPeter Maydell * a Cortex-M33 236eee5d24SPeter Maydell * the IDAU 246eee5d24SPeter Maydell * some timers and watchdogs 256eee5d24SPeter Maydell * two peripheral protection controllers 266eee5d24SPeter Maydell * a memory protection controller 276eee5d24SPeter Maydell * a security controller 286eee5d24SPeter Maydell * a bus fabric which arranges that some parts of the address 296eee5d24SPeter Maydell * space are secure and non-secure aliases of each other 300829d24eSPeter Maydell * The SSE-200 additionally contains: 310829d24eSPeter Maydell * a second Cortex-M33 320829d24eSPeter Maydell * two Message Handling Units (MHUs) 330829d24eSPeter Maydell * an optional CryptoCell (which we do not model) 340829d24eSPeter Maydell * more SRAM banks with associated MPCs 350829d24eSPeter Maydell * multiple Power Policy Units (PPUs) 360829d24eSPeter Maydell * a control interface for an icache for each CPU 370829d24eSPeter Maydell * per-CPU identity and control register blocks 386eee5d24SPeter Maydell * 396eee5d24SPeter Maydell * QEMU interface: 408fd34dc0SPeter Maydell * + Clock input "MAINCLK": clock for CPUs and most peripherals 418fd34dc0SPeter Maydell * + Clock input "S32KCLK": slow 32KHz clock used for a few peripherals 426eee5d24SPeter Maydell * + QOM property "memory" is a MemoryRegion containing the devices provided 436eee5d24SPeter Maydell * by the board model. 4491c1e9fcSPeter Maydell * + QOM property "EXP_NUMIRQ" sets the number of expansion interrupts. 4591c1e9fcSPeter Maydell * (In hardware, the SSE-200 permits the number of expansion interrupts 4691c1e9fcSPeter Maydell * for the two CPUs to be configured separately, but we restrict it to 4791c1e9fcSPeter Maydell * being the same for both, to avoid having to have separate Property 4891c1e9fcSPeter Maydell * lists for different variants. This restriction can be relaxed later 4991c1e9fcSPeter Maydell * if necessary.) 5074ecf767SPeter Maydell * + QOM property "SRAM_ADDR_WIDTH" sets the number of bits used for the 5174ecf767SPeter Maydell * address of each SRAM bank (and thus the total amount of internal SRAM) 5232187419SPeter Maydell * + QOM property "init-svtor" sets the initial value of the CPU SVTOR register 5332187419SPeter Maydell * (where it expects to load the PC and SP from the vector table on reset) 54a90a862bSPeter Maydell * + QOM properties "CPU0_FPU", "CPU0_DSP", "CPU1_FPU" and "CPU1_DSP" which 55a90a862bSPeter Maydell * set whether the CPUs have the FPU and DSP features present. The default 56a90a862bSPeter Maydell * (matching the hardware) is that for CPU0 in an IoTKit and CPU1 in an 57a90a862bSPeter Maydell * SSE-200 both are present; CPU0 in an SSE-200 has neither. 58a90a862bSPeter Maydell * Since the IoTKit has only one CPU, it does not have the CPU1_* properties. 59*e73b8bb8SPeter Maydell * + QOM properties "CPU0_MPU_NS", "CPU0_MPU_S", "CPU1_MPU_NS" and "CPU1_MPU_S" 60*e73b8bb8SPeter Maydell * which set the number of MPU regions on the CPUs. If there is only one 61*e73b8bb8SPeter Maydell * CPU the CPU1 properties are not present. 6291c1e9fcSPeter Maydell * + Named GPIO inputs "EXP_IRQ" 0..n are the expansion interrupts for CPU 0, 6391c1e9fcSPeter Maydell * which are wired to its NVIC lines 32 .. n+32 6491c1e9fcSPeter Maydell * + Named GPIO inputs "EXP_CPU1_IRQ" 0..n are the expansion interrupts for 6591c1e9fcSPeter Maydell * CPU 1, which are wired to its NVIC lines 32 .. n+32 666eee5d24SPeter Maydell * + sysbus MMIO region 0 is the "AHB Slave Expansion" which allows 676eee5d24SPeter Maydell * bus master devices in the board model to make transactions into 686eee5d24SPeter Maydell * all the devices and memory areas in the IoTKit 696eee5d24SPeter Maydell * Controlling up to 4 AHB expansion PPBs which a system using the IoTKit 706eee5d24SPeter Maydell * might provide: 716eee5d24SPeter Maydell * + named GPIO outputs apb_ppcexp{0,1,2,3}_nonsec[0..15] 726eee5d24SPeter Maydell * + named GPIO outputs apb_ppcexp{0,1,2,3}_ap[0..15] 736eee5d24SPeter Maydell * + named GPIO outputs apb_ppcexp{0,1,2,3}_irq_enable 746eee5d24SPeter Maydell * + named GPIO outputs apb_ppcexp{0,1,2,3}_irq_clear 756eee5d24SPeter Maydell * + named GPIO inputs apb_ppcexp{0,1,2,3}_irq_status 766eee5d24SPeter Maydell * Controlling each of the 4 expansion AHB PPCs which a system using the IoTKit 776eee5d24SPeter Maydell * might provide: 786eee5d24SPeter Maydell * + named GPIO outputs ahb_ppcexp{0,1,2,3}_nonsec[0..15] 796eee5d24SPeter Maydell * + named GPIO outputs ahb_ppcexp{0,1,2,3}_ap[0..15] 806eee5d24SPeter Maydell * + named GPIO outputs ahb_ppcexp{0,1,2,3}_irq_enable 816eee5d24SPeter Maydell * + named GPIO outputs ahb_ppcexp{0,1,2,3}_irq_clear 826eee5d24SPeter Maydell * + named GPIO inputs ahb_ppcexp{0,1,2,3}_irq_status 836eee5d24SPeter Maydell * Controlling each of the 16 expansion MPCs which a system using the IoTKit 846eee5d24SPeter Maydell * might provide: 856eee5d24SPeter Maydell * + named GPIO inputs mpcexp_status[0..15] 866eee5d24SPeter Maydell * Controlling each of the 16 expansion MSCs which a system using the IoTKit 876eee5d24SPeter Maydell * might provide: 886eee5d24SPeter Maydell * + named GPIO inputs mscexp_status[0..15] 896eee5d24SPeter Maydell * + named GPIO outputs mscexp_clear[0..15] 906eee5d24SPeter Maydell * + named GPIO outputs mscexp_ns[0..15] 916eee5d24SPeter Maydell */ 926eee5d24SPeter Maydell 936eee5d24SPeter Maydell #ifndef ARMSSE_H 946eee5d24SPeter Maydell #define ARMSSE_H 956eee5d24SPeter Maydell 966eee5d24SPeter Maydell #include "hw/sysbus.h" 976eee5d24SPeter Maydell #include "hw/arm/armv7m.h" 986eee5d24SPeter Maydell #include "hw/misc/iotkit-secctl.h" 996eee5d24SPeter Maydell #include "hw/misc/tz-ppc.h" 1006eee5d24SPeter Maydell #include "hw/misc/tz-mpc.h" 1016eee5d24SPeter Maydell #include "hw/timer/cmsdk-apb-timer.h" 1026eee5d24SPeter Maydell #include "hw/timer/cmsdk-apb-dualtimer.h" 1039febd175SPeter Maydell #include "hw/timer/sse-counter.h" 104f11de231SPeter Maydell #include "hw/timer/sse-timer.h" 1056eee5d24SPeter Maydell #include "hw/watchdog/cmsdk-apb-watchdog.h" 1066eee5d24SPeter Maydell #include "hw/misc/iotkit-sysctl.h" 1076eee5d24SPeter Maydell #include "hw/misc/iotkit-sysinfo.h" 108ade67dcdSPeter Maydell #include "hw/misc/armsse-cpuid.h" 10968d6b36fSPeter Maydell #include "hw/misc/armsse-mhu.h" 1104668b441SPeter Maydell #include "hw/misc/armsse-cpu-pwrctrl.h" 111f8574705SPeter Maydell #include "hw/misc/unimp.h" 1126eee5d24SPeter Maydell #include "hw/or-irq.h" 1138fd34dc0SPeter Maydell #include "hw/clock.h" 1146eee5d24SPeter Maydell #include "hw/core/split-irq.h" 1157cd3a2e0SPeter Maydell #include "hw/cpu/cluster.h" 116db1015e9SEduardo Habkost #include "qom/object.h" 1176eee5d24SPeter Maydell 1188055340fSEduardo Habkost #define TYPE_ARM_SSE "arm-sse" 119c821774aSEduardo Habkost OBJECT_DECLARE_TYPE(ARMSSE, ARMSSEClass, 12030b5707cSEduardo Habkost ARM_SSE) 1216eee5d24SPeter Maydell 1226eee5d24SPeter Maydell /* 1236eee5d24SPeter Maydell * These type names are for specific IoTKit subsystems; other than 1246eee5d24SPeter Maydell * instantiating them, code using these devices should always handle 1256eee5d24SPeter Maydell * them via the ARMSSE base class, so they have no IOTKIT() etc macros. 1266eee5d24SPeter Maydell */ 1276eee5d24SPeter Maydell #define TYPE_IOTKIT "iotkit" 1280829d24eSPeter Maydell #define TYPE_SSE200 "sse-200" 1298901bb41SPeter Maydell #define TYPE_SSE300 "sse-300" 1306eee5d24SPeter Maydell 1316eee5d24SPeter Maydell /* We have an IRQ splitter and an OR gate input for each external PPC 1326eee5d24SPeter Maydell * and the 2 internal PPCs 1336eee5d24SPeter Maydell */ 13491eb4f64SPeter Maydell #define NUM_INTERNAL_PPCS 2 1356eee5d24SPeter Maydell #define NUM_EXTERNAL_PPCS (IOTS_NUM_AHB_EXP_PPC + IOTS_NUM_APB_EXP_PPC) 13691eb4f64SPeter Maydell #define NUM_PPCS (NUM_EXTERNAL_PPCS + NUM_INTERNAL_PPCS) 1376eee5d24SPeter Maydell 138f0cab7feSPeter Maydell #define MAX_SRAM_BANKS 4 139f0cab7feSPeter Maydell #if MAX_SRAM_BANKS > IOTS_NUM_MPC 140f0cab7feSPeter Maydell #error Too many SRAM banks 141f0cab7feSPeter Maydell #endif 142f0cab7feSPeter Maydell 14391c1e9fcSPeter Maydell #define SSE_MAX_CPUS 2 14491c1e9fcSPeter Maydell 1456fe8acb4SPeter Maydell #define NUM_PPUS 8 146e0b00f1bSPeter Maydell 14733788738SPeter Maydell /* Number of CPU IRQs used by the SSE itself */ 14833788738SPeter Maydell #define NUM_SSE_IRQS 32 14933788738SPeter Maydell 150db1015e9SEduardo Habkost struct ARMSSE { 1516eee5d24SPeter Maydell /*< private >*/ 1526eee5d24SPeter Maydell SysBusDevice parent_obj; 1536eee5d24SPeter Maydell 1546eee5d24SPeter Maydell /*< public >*/ 15591c1e9fcSPeter Maydell ARMv7MState armv7m[SSE_MAX_CPUS]; 1567cd3a2e0SPeter Maydell CPUClusterState cluster[SSE_MAX_CPUS]; 1576eee5d24SPeter Maydell IoTKitSecCtl secctl; 15891eb4f64SPeter Maydell TZPPC apb_ppc[NUM_INTERNAL_PPCS]; 159f0cab7feSPeter Maydell TZMPC mpc[IOTS_NUM_MPC]; 16099865afcSPeter Maydell CMSDKAPBTimer timer[3]; 161e844f0c5SPhilippe Mathieu-Daudé OrIRQState ppc_irq_orgate; 1626eee5d24SPeter Maydell SplitIRQ sec_resp_splitter; 1636eee5d24SPeter Maydell SplitIRQ ppc_irq_splitter[NUM_PPCS]; 1646eee5d24SPeter Maydell SplitIRQ mpc_irq_splitter[IOTS_NUM_EXP_MPC + IOTS_NUM_MPC]; 165e844f0c5SPhilippe Mathieu-Daudé OrIRQState mpc_irq_orgate; 166e844f0c5SPhilippe Mathieu-Daudé OrIRQState nmi_orgate; 1676eee5d24SPeter Maydell 16833788738SPeter Maydell SplitIRQ cpu_irq_splitter[NUM_SSE_IRQS]; 16991c1e9fcSPeter Maydell 1706eee5d24SPeter Maydell CMSDKAPBDualTimer dualtimer; 1716eee5d24SPeter Maydell 1721292b932SPeter Maydell CMSDKAPBWatchdog cmsdk_watchdog[3]; 1736eee5d24SPeter Maydell 1749febd175SPeter Maydell SSECounter sse_counter; 175f11de231SPeter Maydell SSETimer sse_timer[4]; 1769febd175SPeter Maydell 1776eee5d24SPeter Maydell IoTKitSysCtl sysctl; 1786eee5d24SPeter Maydell IoTKitSysCtl sysinfo; 1796eee5d24SPeter Maydell 18068d6b36fSPeter Maydell ARMSSEMHU mhu[2]; 181a459e849SPeter Maydell UnimplementedDeviceState unimp[NUM_PPUS]; 1822357bca5SPeter Maydell UnimplementedDeviceState cachectrl[SSE_MAX_CPUS]; 183c1f57257SPeter Maydell UnimplementedDeviceState cpusecctrl[SSE_MAX_CPUS]; 184f8574705SPeter Maydell 185ade67dcdSPeter Maydell ARMSSECPUID cpuid[SSE_MAX_CPUS]; 186ade67dcdSPeter Maydell 1874668b441SPeter Maydell ARMSSECPUPwrCtrl cpu_pwrctrl[SSE_MAX_CPUS]; 1884668b441SPeter Maydell 189d847ca51SPeter Maydell /* 190d847ca51SPeter Maydell * 'container' holds all devices seen by all CPUs. 191d847ca51SPeter Maydell * 'cpu_container[i]' is the view that CPU i has: this has the 192d847ca51SPeter Maydell * per-CPU devices of that CPU, plus as the background 'container' 193d847ca51SPeter Maydell * (or an alias of it, since we can only use it directly once). 194d847ca51SPeter Maydell * container_alias[i] is the alias of 'container' used by CPU i+1; 195d847ca51SPeter Maydell * CPU 0 can use 'container' directly. 196d847ca51SPeter Maydell */ 1976eee5d24SPeter Maydell MemoryRegion container; 198d847ca51SPeter Maydell MemoryRegion container_alias[SSE_MAX_CPUS - 1]; 199d847ca51SPeter Maydell MemoryRegion cpu_container[SSE_MAX_CPUS]; 2006eee5d24SPeter Maydell MemoryRegion alias1; 2016eee5d24SPeter Maydell MemoryRegion alias2; 2023733f803SPeter Maydell MemoryRegion alias3[SSE_MAX_CPUS]; 203f0cab7feSPeter Maydell MemoryRegion sram[MAX_SRAM_BANKS]; 204cbb56388SPeter Maydell MemoryRegion itcm; 205cbb56388SPeter Maydell MemoryRegion dtcm; 2066eee5d24SPeter Maydell 20791c1e9fcSPeter Maydell qemu_irq *exp_irqs[SSE_MAX_CPUS]; 2086eee5d24SPeter Maydell qemu_irq ppc0_irq; 2096eee5d24SPeter Maydell qemu_irq ppc1_irq; 2106eee5d24SPeter Maydell qemu_irq sec_resp_cfg; 2116eee5d24SPeter Maydell qemu_irq sec_resp_cfg_in; 2126eee5d24SPeter Maydell qemu_irq nsc_cfg_in; 2136eee5d24SPeter Maydell 2146eee5d24SPeter Maydell qemu_irq irq_status_in[NUM_EXTERNAL_PPCS]; 2156eee5d24SPeter Maydell qemu_irq mpcexp_status_in[IOTS_NUM_EXP_MPC]; 2166eee5d24SPeter Maydell 2176eee5d24SPeter Maydell uint32_t nsccfg; 2186eee5d24SPeter Maydell 2198fd34dc0SPeter Maydell Clock *mainclk; 2208fd34dc0SPeter Maydell Clock *s32kclk; 2218fd34dc0SPeter Maydell 2226eee5d24SPeter Maydell /* Properties */ 2236eee5d24SPeter Maydell MemoryRegion *board_memory; 2246eee5d24SPeter Maydell uint32_t exp_numirq; 2254b635cf7SPeter Maydell uint32_t sram_addr_width; 22632187419SPeter Maydell uint32_t init_svtor; 227*e73b8bb8SPeter Maydell uint32_t cpu_mpu_ns[SSE_MAX_CPUS]; 228*e73b8bb8SPeter Maydell uint32_t cpu_mpu_s[SSE_MAX_CPUS]; 229a90a862bSPeter Maydell bool cpu_fpu[SSE_MAX_CPUS]; 230a90a862bSPeter Maydell bool cpu_dsp[SSE_MAX_CPUS]; 231db1015e9SEduardo Habkost }; 2326eee5d24SPeter Maydell 2336eee5d24SPeter Maydell typedef struct ARMSSEInfo ARMSSEInfo; 2346eee5d24SPeter Maydell 235db1015e9SEduardo Habkost struct ARMSSEClass { 236512c65e6SEduardo Habkost SysBusDeviceClass parent_class; 2376eee5d24SPeter Maydell const ARMSSEInfo *info; 238db1015e9SEduardo Habkost }; 2396eee5d24SPeter Maydell 2406eee5d24SPeter Maydell 2416eee5d24SPeter Maydell #endif 242