1 /* 2 * Copyright (c) 2015-2017, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __GICV3_H__ 8 #define __GICV3_H__ 9 10 #include "utils_def.h" 11 12 /******************************************************************************* 13 * GICv3 miscellaneous definitions 14 ******************************************************************************/ 15 /* Interrupt group definitions */ 16 #define INTR_GROUP1S 0 17 #define INTR_GROUP0 1 18 #define INTR_GROUP1NS 2 19 20 /* Interrupt IDs reported by the HPPIR and IAR registers */ 21 #define PENDING_G1S_INTID 1020 22 #define PENDING_G1NS_INTID 1021 23 24 /* Constant to categorize LPI interrupt */ 25 #define MIN_LPI_ID 8192 26 27 /******************************************************************************* 28 * GICv3 specific Distributor interface register offsets and constants. 29 ******************************************************************************/ 30 #define GICD_STATUSR 0x10 31 #define GICD_SETSPI_NSR 0x40 32 #define GICD_CLRSPI_NSR 0x48 33 #define GICD_SETSPI_SR 0x50 34 #define GICD_CLRSPI_SR 0x50 35 #define GICD_IGRPMODR 0xd00 36 /* 37 * GICD_IROUTER<n> register is at 0x6000 + 8n, where n is the interrupt id and 38 * n >= 32, making the effective offset as 0x6100. 39 */ 40 #define GICD_IROUTER 0x6000 41 #define GICD_PIDR2_GICV3 0xffe8 42 43 #define IGRPMODR_SHIFT 5 44 45 /* GICD_CTLR bit definitions */ 46 #define CTLR_ENABLE_G1NS_SHIFT 1 47 #define CTLR_ENABLE_G1S_SHIFT 2 48 #define CTLR_ARE_S_SHIFT 4 49 #define CTLR_ARE_NS_SHIFT 5 50 #define CTLR_DS_SHIFT 6 51 #define CTLR_E1NWF_SHIFT 7 52 #define GICD_CTLR_RWP_SHIFT 31 53 54 #define CTLR_ENABLE_G1NS_MASK 0x1 55 #define CTLR_ENABLE_G1S_MASK 0x1 56 #define CTLR_ARE_S_MASK 0x1 57 #define CTLR_ARE_NS_MASK 0x1 58 #define CTLR_DS_MASK 0x1 59 #define CTLR_E1NWF_MASK 0x1 60 #define GICD_CTLR_RWP_MASK 0x1 61 62 #define CTLR_ENABLE_G1NS_BIT (1 << CTLR_ENABLE_G1NS_SHIFT) 63 #define CTLR_ENABLE_G1S_BIT (1 << CTLR_ENABLE_G1S_SHIFT) 64 #define CTLR_ARE_S_BIT (1 << CTLR_ARE_S_SHIFT) 65 #define CTLR_ARE_NS_BIT (1 << CTLR_ARE_NS_SHIFT) 66 #define CTLR_DS_BIT (1 << CTLR_DS_SHIFT) 67 #define CTLR_E1NWF_BIT (1 << CTLR_E1NWF_SHIFT) 68 #define GICD_CTLR_RWP_BIT (1 << GICD_CTLR_RWP_SHIFT) 69 70 /* GICD_IROUTER shifts and masks */ 71 #define IROUTER_SHIFT 0 72 #define IROUTER_IRM_SHIFT 31 73 #define IROUTER_IRM_MASK 0x1 74 75 #define NUM_OF_DIST_REGS 30 76 77 /******************************************************************************* 78 * GICv3 Re-distributor interface registers & constants 79 ******************************************************************************/ 80 #define GICR_PCPUBASE_SHIFT 0x11 81 #define GICR_SGIBASE_OFFSET (1 << 0x10) /* 64 KB */ 82 #define GICR_CTLR 0x0 83 #define GICR_TYPER 0x08 84 #define GICR_WAKER 0x14 85 #define GICR_PROPBASER 0x70 86 #define GICR_PENDBASER 0x78 87 #define GICR_IGROUPR0 (GICR_SGIBASE_OFFSET + 0x80) 88 #define GICR_ISENABLER0 (GICR_SGIBASE_OFFSET + 0x100) 89 #define GICR_ICENABLER0 (GICR_SGIBASE_OFFSET + 0x180) 90 #define GICR_ISPENDR0 (GICR_SGIBASE_OFFSET + 0x200) 91 #define GICR_ICPENDR0 (GICR_SGIBASE_OFFSET + 0x280) 92 #define GICR_ISACTIVER0 (GICR_SGIBASE_OFFSET + 0x300) 93 #define GICR_ICACTIVER0 (GICR_SGIBASE_OFFSET + 0x380) 94 #define GICR_IPRIORITYR (GICR_SGIBASE_OFFSET + 0x400) 95 #define GICR_ICFGR0 (GICR_SGIBASE_OFFSET + 0xc00) 96 #define GICR_ICFGR1 (GICR_SGIBASE_OFFSET + 0xc04) 97 #define GICR_IGRPMODR0 (GICR_SGIBASE_OFFSET + 0xd00) 98 #define GICR_NSACR (GICR_SGIBASE_OFFSET + 0xe00) 99 100 /* GICR_CTLR bit definitions */ 101 #define GICR_CTLR_UWP_SHIFT 31 102 #define GICR_CTLR_UWP_MASK 0x1 103 #define GICR_CTLR_UWP_BIT (1U << GICR_CTLR_UWP_SHIFT) 104 #define GICR_CTLR_RWP_SHIFT 3 105 #define GICR_CTLR_RWP_MASK 0x1 106 #define GICR_CTLR_RWP_BIT (1U << GICR_CTLR_RWP_SHIFT) 107 #define GICR_CTLR_EN_LPIS_BIT (1U << 0) 108 109 /* GICR_WAKER bit definitions */ 110 #define WAKER_CA_SHIFT 2 111 #define WAKER_PS_SHIFT 1 112 113 #define WAKER_CA_MASK 0x1 114 #define WAKER_PS_MASK 0x1 115 116 #define WAKER_CA_BIT (1 << WAKER_CA_SHIFT) 117 #define WAKER_PS_BIT (1 << WAKER_PS_SHIFT) 118 119 /* GICR_TYPER bit definitions */ 120 #define TYPER_AFF_VAL_SHIFT 32 121 #define TYPER_PROC_NUM_SHIFT 8 122 #define TYPER_LAST_SHIFT 4 123 124 #define TYPER_AFF_VAL_MASK 0xffffffff 125 #define TYPER_PROC_NUM_MASK 0xffff 126 #define TYPER_LAST_MASK 0x1 127 128 #define TYPER_LAST_BIT (1 << TYPER_LAST_SHIFT) 129 130 #define NUM_OF_REDIST_REGS 30 131 132 /******************************************************************************* 133 * GICv3 CPU interface registers & constants 134 ******************************************************************************/ 135 /* ICC_SRE bit definitions*/ 136 #define ICC_SRE_EN_BIT (1 << 3) 137 #define ICC_SRE_DIB_BIT (1 << 2) 138 #define ICC_SRE_DFB_BIT (1 << 1) 139 #define ICC_SRE_SRE_BIT (1 << 0) 140 141 /* ICC_IGRPEN1_EL3 bit definitions */ 142 #define IGRPEN1_EL3_ENABLE_G1NS_SHIFT 0 143 #define IGRPEN1_EL3_ENABLE_G1S_SHIFT 1 144 145 #define IGRPEN1_EL3_ENABLE_G1NS_BIT (1 << IGRPEN1_EL3_ENABLE_G1NS_SHIFT) 146 #define IGRPEN1_EL3_ENABLE_G1S_BIT (1 << IGRPEN1_EL3_ENABLE_G1S_SHIFT) 147 148 /* ICC_IGRPEN0_EL1 bit definitions */ 149 #define IGRPEN1_EL1_ENABLE_G0_SHIFT 0 150 #define IGRPEN1_EL1_ENABLE_G0_BIT (1 << IGRPEN1_EL1_ENABLE_G0_SHIFT) 151 152 /* ICC_HPPIR0_EL1 bit definitions */ 153 #define HPPIR0_EL1_INTID_SHIFT 0 154 #define HPPIR0_EL1_INTID_MASK 0xffffff 155 156 /* ICC_HPPIR1_EL1 bit definitions */ 157 #define HPPIR1_EL1_INTID_SHIFT 0 158 #define HPPIR1_EL1_INTID_MASK 0xffffff 159 160 /* ICC_IAR0_EL1 bit definitions */ 161 #define IAR0_EL1_INTID_SHIFT 0 162 #define IAR0_EL1_INTID_MASK 0xffffff 163 164 /* ICC_IAR1_EL1 bit definitions */ 165 #define IAR1_EL1_INTID_SHIFT 0 166 #define IAR1_EL1_INTID_MASK 0xffffff 167 168 #ifndef __ASSEMBLY__ 169 170 #include <gic_common.h> 171 #include <stdint.h> 172 #include <types.h> 173 #include <utils_def.h> 174 175 #define gicv3_is_intr_id_special_identifier(id) \ 176 (((id) >= PENDING_G1S_INTID) && ((id) <= GIC_SPURIOUS_INTERRUPT)) 177 178 /******************************************************************************* 179 * Helper GICv3 macros for SEL1 180 ******************************************************************************/ 181 #define gicv3_acknowledge_interrupt_sel1() read_icc_iar1_el1() &\ 182 IAR1_EL1_INTID_MASK 183 #define gicv3_get_pending_interrupt_id_sel1() read_icc_hppir1_el1() &\ 184 HPPIR1_EL1_INTID_MASK 185 #define gicv3_end_of_interrupt_sel1(id) write_icc_eoir1_el1(id) 186 187 188 /******************************************************************************* 189 * Helper GICv3 macros for EL3 190 ******************************************************************************/ 191 #define gicv3_acknowledge_interrupt() read_icc_iar0_el1() &\ 192 IAR0_EL1_INTID_MASK 193 #define gicv3_end_of_interrupt(id) write_icc_eoir0_el1(id) 194 195 /* 196 * This macro returns the total number of GICD registers corresponding to 197 * the name. 198 */ 199 #define GICD_NUM_REGS(reg_name) \ 200 DIV_ROUND_UP_2EVAL(TOTAL_SPI_INTR_NUM, (1 << reg_name ## _SHIFT)) 201 202 #define GICR_NUM_REGS(reg_name) \ 203 DIV_ROUND_UP_2EVAL(TOTAL_PCPU_INTR_NUM, (1 << reg_name ## _SHIFT)) 204 205 /******************************************************************************* 206 * This structure describes some of the implementation defined attributes of the 207 * GICv3 IP. It is used by the platform port to specify these attributes in order 208 * to initialise the GICV3 driver. The attributes are described below. 209 * 210 * 1. The 'gicd_base' field contains the base address of the Distributor 211 * interface programmer's view. 212 * 213 * 2. The 'gicr_base' field contains the base address of the Re-distributor 214 * interface programmer's view. 215 * 216 * 3. The 'g0_interrupt_array' field is a ponter to an array in which each 217 * entry corresponds to an ID of a Group 0 interrupt. 218 * 219 * 4. The 'g0_interrupt_num' field contains the number of entries in the 220 * 'g0_interrupt_array'. 221 * 222 * 5. The 'g1s_interrupt_array' field is a ponter to an array in which each 223 * entry corresponds to an ID of a Group 1 interrupt. 224 * 225 * 6. The 'g1s_interrupt_num' field contains the number of entries in the 226 * 'g1s_interrupt_array'. 227 * 228 * 7. The 'rdistif_num' field contains the number of Redistributor interfaces 229 * the GIC implements. This is equal to the number of CPUs or CPU interfaces 230 * instantiated in the GIC. 231 * 232 * 8. The 'rdistif_base_addrs' field is a pointer to an array that has an entry 233 * for storing the base address of the Redistributor interface frame of each 234 * CPU in the system. The size of the array = 'rdistif_num'. The base 235 * addresses are detected during driver initialisation. 236 * 237 * 9. The 'mpidr_to_core_pos' field is a pointer to a hash function which the 238 * driver will use to convert an MPIDR value to a linear core index. This 239 * index will be used for accessing the 'rdistif_base_addrs' array. This is 240 * an optional field. A GICv3 implementation maps each MPIDR to a linear core 241 * index as well. This mapping can be found by reading the "Affinity Value" 242 * and "Processor Number" fields in the GICR_TYPER. It is IMP. DEF. if the 243 * "Processor Numbers" are suitable to index into an array to access core 244 * specific information. If this not the case, the platform port must provide 245 * a hash function. Otherwise, the "Processor Number" field will be used to 246 * access the array elements. 247 ******************************************************************************/ 248 typedef unsigned int (*mpidr_hash_fn)(u_register_t mpidr); 249 250 typedef struct gicv3_driver_data { 251 uintptr_t gicd_base; 252 uintptr_t gicr_base; 253 unsigned int g0_interrupt_num; 254 unsigned int g1s_interrupt_num; 255 const unsigned int *g0_interrupt_array; 256 const unsigned int *g1s_interrupt_array; 257 unsigned int rdistif_num; 258 uintptr_t *rdistif_base_addrs; 259 mpidr_hash_fn mpidr_to_core_pos; 260 } gicv3_driver_data_t; 261 262 typedef struct gicv3_redist_ctx { 263 /* 64 bits registers */ 264 uint64_t gicr_propbaser; 265 uint64_t gicr_pendbaser; 266 267 /* 32 bits registers */ 268 uint32_t gicr_ctlr; 269 uint32_t gicr_igroupr0; 270 uint32_t gicr_isenabler0; 271 uint32_t gicr_ispendr0; 272 uint32_t gicr_isactiver0; 273 uint32_t gicr_ipriorityr[GICR_NUM_REGS(IPRIORITYR)]; 274 uint32_t gicr_icfgr0; 275 uint32_t gicr_icfgr1; 276 uint32_t gicr_igrpmodr0; 277 uint32_t gicr_nsacr; 278 } gicv3_redist_ctx_t; 279 280 typedef struct gicv3_dist_ctx { 281 /* 64 bits registers */ 282 uint64_t gicd_irouter[TOTAL_SPI_INTR_NUM]; 283 284 /* 32 bits registers */ 285 uint32_t gicd_ctlr; 286 uint32_t gicd_igroupr[GICD_NUM_REGS(IGROUPR)]; 287 uint32_t gicd_isenabler[GICD_NUM_REGS(ISENABLER)]; 288 uint32_t gicd_ispendr[GICD_NUM_REGS(ISPENDR)]; 289 uint32_t gicd_isactiver[GICD_NUM_REGS(ISACTIVER)]; 290 uint32_t gicd_ipriorityr[GICD_NUM_REGS(IPRIORITYR)]; 291 uint32_t gicd_icfgr[GICD_NUM_REGS(ICFGR)]; 292 uint32_t gicd_igrpmodr[GICD_NUM_REGS(IGRPMODR)]; 293 uint32_t gicd_nsacr[GICD_NUM_REGS(NSACR)]; 294 } gicv3_dist_ctx_t; 295 296 /******************************************************************************* 297 * GICv3 EL3 driver API 298 ******************************************************************************/ 299 void gicv3_driver_init(const gicv3_driver_data_t *plat_driver_data); 300 void gicv3_distif_init(void); 301 void gicv3_rdistif_init(unsigned int proc_num); 302 void gicv3_rdistif_on(unsigned int proc_num); 303 void gicv3_rdistif_off(unsigned int proc_num); 304 void gicv3_cpuif_enable(unsigned int proc_num); 305 void gicv3_cpuif_disable(unsigned int proc_num); 306 unsigned int gicv3_get_pending_interrupt_type(void); 307 unsigned int gicv3_get_pending_interrupt_id(void); 308 unsigned int gicv3_get_interrupt_type(unsigned int id, 309 unsigned int proc_num); 310 void gicv3_distif_init_restore(const gicv3_dist_ctx_t * const dist_ctx); 311 void gicv3_distif_save(gicv3_dist_ctx_t * const dist_ctx); 312 /* 313 * gicv3_distif_post_restore and gicv3_distif_pre_save must be implemented if 314 * gicv3_distif_save and gicv3_rdistif_init_restore are used. If no 315 * implementation-defined sequence is needed at these steps, an empty function 316 * can be provided. 317 */ 318 void gicv3_distif_post_restore(unsigned int proc_num); 319 void gicv3_distif_pre_save(unsigned int proc_num); 320 void gicv3_rdistif_init_restore(unsigned int proc_num, const gicv3_redist_ctx_t * const rdist_ctx); 321 void gicv3_rdistif_save(unsigned int proc_num, gicv3_redist_ctx_t * const rdist_ctx); 322 323 #endif /* __ASSEMBLY__ */ 324 #endif /* __GICV3_H__ */ 325