LXR qemu/include/hw/arm/iotkit.h

   1/*
   2 * ARM IoT Kit
   3 *
   4 * Copyright (c) 2018 Linaro Limited
   5 * Written by Peter Maydell
   6 *
   7 * This program is free software; you can redistribute it and/or modify
   8 * it under the terms of the GNU General Public License version 2 or
   9 * (at your option) any later version.
  10 */
  11
  12/* This is a model of the Arm IoT Kit which is documented in
  13 * http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ecm0601256/index.html
  14 * It contains:
  15 *  a Cortex-M33
  16 *  the IDAU
  17 *  some timers and watchdogs
  18 *  two peripheral protection controllers
  19 *  a memory protection controller
  20 *  a security controller
  21 *  a bus fabric which arranges that some parts of the address
  22 *  space are secure and non-secure aliases of each other
  23 *
  24 * QEMU interface:
  25 *  + QOM property "memory" is a MemoryRegion containing the devices provided
  26 *    by the board model.
  27 *  + QOM property "MAINCLK" is the frequency of the main system clock
  28 *  + QOM property "EXP_NUMIRQ" sets the number of expansion interrupts
  29 *  + Named GPIO inputs "EXP_IRQ" 0..n are the expansion interrupts, which
  30 *    are wired to the NVIC lines 32 .. n+32
  31 * Controlling up to 4 AHB expansion PPBs which a system using the IoTKit
  32 * might provide:
  33 *  + named GPIO outputs apb_ppcexp{0,1,2,3}_nonsec[0..15]
  34 *  + named GPIO outputs apb_ppcexp{0,1,2,3}_ap[0..15]
  35 *  + named GPIO outputs apb_ppcexp{0,1,2,3}_irq_enable
  36 *  + named GPIO outputs apb_ppcexp{0,1,2,3}_irq_clear
  37 *  + named GPIO inputs apb_ppcexp{0,1,2,3}_irq_status
  38 * Controlling each of the 4 expansion AHB PPCs which a system using the IoTKit
  39 * might provide:
  40 *  + named GPIO outputs ahb_ppcexp{0,1,2,3}_nonsec[0..15]
  41 *  + named GPIO outputs ahb_ppcexp{0,1,2,3}_ap[0..15]
  42 *  + named GPIO outputs ahb_ppcexp{0,1,2,3}_irq_enable
  43 *  + named GPIO outputs ahb_ppcexp{0,1,2,3}_irq_clear
  44 *  + named GPIO inputs ahb_ppcexp{0,1,2,3}_irq_status
  45 * Controlling each of the 16 expansion MPCs which a system using the IoTKit
  46 * might provide:
  47 *  + named GPIO inputs mpcexp_status[0..15]
  48 */
  49
  50#ifndef IOTKIT_H
  51#define IOTKIT_H
  52
  53#include "hw/sysbus.h"
  54#include "hw/arm/armv7m.h"
  55#include "hw/misc/iotkit-secctl.h"
  56#include "hw/misc/tz-ppc.h"
  57#include "hw/misc/tz-mpc.h"
  58#include "hw/timer/cmsdk-apb-timer.h"
  59#include "hw/misc/unimp.h"
  60#include "hw/or-irq.h"
  61#include "hw/core/split-irq.h"
  62
  63#define TYPE_IOTKIT "iotkit"
  64#define IOTKIT(obj) OBJECT_CHECK(IoTKit, (obj), TYPE_IOTKIT)
  65
  66/* We have an IRQ splitter and an OR gate input for each external PPC
  67 * and the 2 internal PPCs
  68 */
  69#define NUM_EXTERNAL_PPCS (IOTS_NUM_AHB_EXP_PPC + IOTS_NUM_APB_EXP_PPC)
  70#define NUM_PPCS (NUM_EXTERNAL_PPCS + 2)
  71
  72typedef struct IoTKit {
  73    /*< private >*/
  74    SysBusDevice parent_obj;
  75
  76    /*< public >*/
  77    ARMv7MState armv7m;
  78    IoTKitSecCtl secctl;
  79    TZPPC apb_ppc0;
  80    TZPPC apb_ppc1;
  81    TZMPC mpc;
  82    CMSDKAPBTIMER timer0;
  83    CMSDKAPBTIMER timer1;
  84    qemu_or_irq ppc_irq_orgate;
  85    SplitIRQ sec_resp_splitter;
  86    SplitIRQ ppc_irq_splitter[NUM_PPCS];
  87    SplitIRQ mpc_irq_splitter[IOTS_NUM_EXP_MPC + IOTS_NUM_MPC];
  88    qemu_or_irq mpc_irq_orgate;
  89
  90    UnimplementedDeviceState dualtimer;
  91    UnimplementedDeviceState s32ktimer;
  92
  93    MemoryRegion container;
  94    MemoryRegion alias1;
  95    MemoryRegion alias2;
  96    MemoryRegion alias3;
  97    MemoryRegion sram0;
  98
  99    qemu_irq *exp_irqs;
 100    qemu_irq ppc0_irq;
 101    qemu_irq ppc1_irq;
 102    qemu_irq sec_resp_cfg;
 103    qemu_irq sec_resp_cfg_in;
 104    qemu_irq nsc_cfg_in;
 105
 106    qemu_irq irq_status_in[NUM_EXTERNAL_PPCS];
 107    qemu_irq mpcexp_status_in[IOTS_NUM_EXP_MPC];
 108
 109    uint32_t nsccfg;
 110
 111    /* Properties */
 112    MemoryRegion *board_memory;
 113    uint32_t exp_numirq;
 114    uint32_t mainclk_frq;
 115} IoTKit;
 116
 117#endif
 118