1 /*
2 * Copyright (c) 2014-2016, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 #ifndef __TZC400_H__
8 #define __TZC400_H__
9
10 #include <tzc_common.h>
11
12 #define BUILD_CONFIG_OFF 0x000
13 #define GATE_KEEPER_OFF 0x008
14 #define SPECULATION_CTRL_OFF 0x00c
15 #define INT_STATUS 0x010
16 #define INT_CLEAR 0x014
17
18 #define FAIL_ADDRESS_LOW_OFF 0x020
19 #define FAIL_ADDRESS_HIGH_OFF 0x024
20 #define FAIL_CONTROL_OFF 0x028
21 #define FAIL_ID 0x02c
22
23 /* ID registers not common across different varieties of TZC */
24 #define PID5 0xFD4
25 #define PID6 0xFD8
26 #define PID7 0xFDC
27
28 #define BUILD_CONFIG_NF_SHIFT 24
29 #define BUILD_CONFIG_NF_MASK 0x3
30 #define BUILD_CONFIG_AW_SHIFT 8
31 #define BUILD_CONFIG_AW_MASK 0x3f
32 #define BUILD_CONFIG_NR_SHIFT 0
33 #define BUILD_CONFIG_NR_MASK 0x1f
34
35 /*
36 * Number of gate keepers is implementation defined. But we know the max for
37 * this device is 4. Get implementation details from BUILD_CONFIG.
38 */
39 #define GATE_KEEPER_OS_SHIFT 16
40 #define GATE_KEEPER_OS_MASK 0xf
41 #define GATE_KEEPER_OR_SHIFT 0
42 #define GATE_KEEPER_OR_MASK 0xf
43 #define GATE_KEEPER_FILTER_MASK 0x1
44
45 /* Speculation is enabled by default. */
46 #define SPECULATION_CTRL_WRITE_DISABLE (1 << 1)
47 #define SPECULATION_CTRL_READ_DISABLE (1 << 0)
48
49 /* Max number of filters allowed is 4. */
50 #define INT_STATUS_OVERLAP_SHIFT 16
51 #define INT_STATUS_OVERLAP_MASK 0xf
52 #define INT_STATUS_OVERRUN_SHIFT 8
53 #define INT_STATUS_OVERRUN_MASK 0xf
54 #define INT_STATUS_STATUS_SHIFT 0
55 #define INT_STATUS_STATUS_MASK 0xf
56
57 #define INT_CLEAR_CLEAR_SHIFT 0
58 #define INT_CLEAR_CLEAR_MASK 0xf
59
60 #define FAIL_CONTROL_DIR_SHIFT (1 << 24)
61 #define FAIL_CONTROL_DIR_READ 0x0
62 #define FAIL_CONTROL_DIR_WRITE 0x1
63 #define FAIL_CONTROL_NS_SHIFT (1 << 21)
64 #define FAIL_CONTROL_NS_SECURE 0x0
65 #define FAIL_CONTROL_NS_NONSECURE 0x1
66 #define FAIL_CONTROL_PRIV_SHIFT (1 << 20)
67 #define FAIL_CONTROL_PRIV_PRIV 0x0
68 #define FAIL_CONTROL_PRIV_UNPRIV 0x1
69
70 /*
71 * FAIL_ID_ID_MASK depends on AID_WIDTH which is platform specific.
72 * Platform should provide the value on initialisation.
73 */
74 #define FAIL_ID_VNET_SHIFT 24
75 #define FAIL_ID_VNET_MASK 0xf
76 #define FAIL_ID_ID_SHIFT 0
77
78 #define TZC_400_PERIPHERAL_ID 0x460
79
80 /* Filter enable bits in a TZC */
81 #define TZC_400_REGION_ATTR_F_EN_MASK 0xf
82 #define TZC_400_REGION_ATTR_FILTER_BIT(x) ((1 << x) \
83 << TZC_REGION_ATTR_F_EN_SHIFT)
84 #define TZC_400_REGION_ATTR_FILTER_BIT_ALL \
85 (TZC_400_REGION_ATTR_F_EN_MASK << \
86 TZC_REGION_ATTR_F_EN_SHIFT)
87
88 /*
89 * Define some macros for backward compatibility with existing tzc400 clients.
90 */
91 #if !ERROR_DEPRECATED
92 #define REG_ATTR_FILTER_BIT(x) ((1 << x) \
93 << TZC_REGION_ATTR_F_EN_SHIFT)
94 #define REG_ATTR_FILTER_BIT_ALL (TZC_400_REGION_ATTR_F_EN_MASK << \
95 TZC_REGION_ATTR_F_EN_SHIFT)
96 #endif /* __ERROR_DEPRECATED__ */
97
98 /*
99 * All TZC region configuration registers are placed one after another. It
100 * depicts size of block of registers for programming each region.
101 */
102 #define TZC_400_REGION_SIZE 0x20
103 #define TZC_400_ACTION_OFF 0x4
104
105 #ifndef __ASSEMBLY__
106
107 #include <cdefs.h>
108 #include <stdint.h>
109
110 /*******************************************************************************
111 * Function & variable prototypes
112 ******************************************************************************/
113 void tzc400_init(uintptr_t base);
114 void tzc400_configure_region0(tzc_region_attributes_t sec_attr,
115 unsigned int ns_device_access);
116 void tzc400_configure_region(unsigned int filters,
117 int region,
118 unsigned long long region_base,
119 unsigned long long region_top,
120 tzc_region_attributes_t sec_attr,
121 unsigned int ns_device_access);
122 void tzc400_set_action(tzc_action_t action);
123 void tzc400_enable_filters(void);
124 void tzc400_disable_filters(void);
125
126 /*
127 * Deprecated APIs
128 */
129 static inline void tzc_init(uintptr_t base) __deprecated;
130 static inline void tzc_configure_region0(
131 tzc_region_attributes_t sec_attr,
132 unsigned int ns_device_access) __deprecated;
133 static inline void tzc_configure_region(
134 unsigned int filters,
135 int region,
136 unsigned long long region_base,
137 unsigned long long region_top,
138 tzc_region_attributes_t sec_attr,
139 unsigned int ns_device_access) __deprecated;
140 static inline void tzc_set_action(tzc_action_t action) __deprecated;
141 static inline void tzc_enable_filters(void) __deprecated;
142 static inline void tzc_disable_filters(void) __deprecated;
143
tzc_init(uintptr_t base)144 static inline void tzc_init(uintptr_t base)
145 {
146 tzc400_init(base);
147 }
148
tzc_configure_region0(tzc_region_attributes_t sec_attr,unsigned int ns_device_access)149 static inline void tzc_configure_region0(
150 tzc_region_attributes_t sec_attr,
151 unsigned int ns_device_access)
152 {
153 tzc400_configure_region0(sec_attr, ns_device_access);
154 }
155
tzc_configure_region(unsigned int filters,int region,unsigned long long region_base,unsigned long long region_top,tzc_region_attributes_t sec_attr,unsigned int ns_device_access)156 static inline void tzc_configure_region(
157 unsigned int filters,
158 int region,
159 unsigned long long region_base,
160 unsigned long long region_top,
161 tzc_region_attributes_t sec_attr,
162 unsigned int ns_device_access)
163 {
164 tzc400_configure_region(filters, region, region_base,
165 region_top, sec_attr, ns_device_access);
166 }
167
tzc_set_action(tzc_action_t action)168 static inline void tzc_set_action(tzc_action_t action)
169 {
170 tzc400_set_action(action);
171 }
172
173
tzc_enable_filters(void)174 static inline void tzc_enable_filters(void)
175 {
176 tzc400_enable_filters();
177 }
178
tzc_disable_filters(void)179 static inline void tzc_disable_filters(void)
180 {
181 tzc400_disable_filters();
182 }
183
184 #endif /* __ASSEMBLY__ */
185
186 #endif /* __TZC400__ */
187