sifive: Move QOM typedefs and add missing includes
[qemu.git] / include / hw / misc / tz-mpc.h
1 /*
2 * ARM AHB5 TrustZone Memory Protection Controller emulation
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 TrustZone memory protection controller (MPC).
13 * It is documented in the ARM CoreLink SIE-200 System IP for Embedded TRM
14 * (DDI 0571G):
15 * https://developer.arm.com/products/architecture/m-profile/docs/ddi0571/g
16 *
17 * The MPC sits in front of memory and allows secure software to
18 * configure it to either pass through or reject transactions.
19 * Rejected transactions may be configured to either be aborted, or to
20 * behave as RAZ/WI. An interrupt can be signalled for a rejected transaction.
21 *
22 * The MPC has a register interface which the guest uses to configure it.
23 *
24 * QEMU interface:
25 * + sysbus MMIO region 0: MemoryRegion for the MPC's config registers
26 * + sysbus MMIO region 1: MemoryRegion for the upstream end of the MPC
27 * + Property "downstream": MemoryRegion defining the downstream memory
28 * + Named GPIO output "irq": set for a transaction-failed interrupt
29 */
30
31 #ifndef TZ_MPC_H
32 #define TZ_MPC_H
33
34 #include "hw/sysbus.h"
35 #include "qom/object.h"
36
37 #define TYPE_TZ_MPC "tz-mpc"
38 typedef struct TZMPC TZMPC;
39 DECLARE_INSTANCE_CHECKER(TZMPC, TZ_MPC,
40 TYPE_TZ_MPC)
41
42 #define TZ_NUM_PORTS 16
43
44 #define TYPE_TZ_MPC_IOMMU_MEMORY_REGION "tz-mpc-iommu-memory-region"
45
46
47 struct TZMPC {
48 /*< private >*/
49 SysBusDevice parent_obj;
50
51 /*< public >*/
52
53 /* State */
54 uint32_t ctrl;
55 uint32_t blk_idx;
56 uint32_t int_stat;
57 uint32_t int_en;
58 uint32_t int_info1;
59 uint32_t int_info2;
60
61 uint32_t *blk_lut;
62
63 qemu_irq irq;
64
65 /* Properties */
66 MemoryRegion *downstream;
67
68 hwaddr blocksize;
69 uint32_t blk_max;
70
71 /* MemoryRegions exposed to user */
72 MemoryRegion regmr;
73 IOMMUMemoryRegion upstream;
74
75 /* MemoryRegion used internally */
76 MemoryRegion blocked_io;
77
78 AddressSpace downstream_as;
79 AddressSpace blocked_io_as;
80 };
81
82 #endif