1 /**************************************************************************//**
3 * @brief CMSIS Cortex-A Core Peripheral Access Layer Header File
6 ******************************************************************************/
8 * Copyright (c) 2009-2017 ARM Limited. All rights reserved.
10 * SPDX-License-Identifier: Apache-2.0
12 * Licensed under the Apache License, Version 2.0 (the License); you may
13 * not use this file except in compliance with the License.
14 * You may obtain a copy of the License at
16 * www.apache.org/licenses/LICENSE-2.0
18 * Unless required by applicable law or agreed to in writing, software
19 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 * See the License for the specific language governing permissions and
22 * limitations under the License.
25 #if defined ( __ICCARM__ )
26 #pragma system_include /* treat file as system include file for MISRA check */
27 #elif defined (__clang__)
28 #pragma clang system_header /* treat file as system include file */
35 #ifndef __CORE_CA_H_GENERIC
36 #define __CORE_CA_H_GENERIC
39 /*******************************************************************************
41 ******************************************************************************/
43 /* CMSIS CA definitions */
44 #define __CA_CMSIS_VERSION_MAIN (1U) /*!< \brief [31:16] CMSIS-Core(A) main version */
45 #define __CA_CMSIS_VERSION_SUB (1U) /*!< \brief [15:0] CMSIS-Core(A) sub version */
46 #define __CA_CMSIS_VERSION ((__CA_CMSIS_VERSION_MAIN << 16U) | \
47 __CA_CMSIS_VERSION_SUB ) /*!< \brief CMSIS-Core(A) version number */
49 #if defined ( __CC_ARM )
50 #if defined __TARGET_FPU_VFP
51 #if (__FPU_PRESENT == 1)
54 #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
61 #elif defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
62 #if defined __ARM_PCS_VFP
63 #if defined (__FPU_PRESENT) && (__FPU_PRESENT == 1U)
66 #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
73 #elif defined ( __ICCARM__ )
74 #if defined __ARMVFP__
75 #if (__FPU_PRESENT == 1)
78 #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
85 #elif defined ( __TMS470__ )
86 #if defined __TI_VFP_SUPPORT__
87 #if (__FPU_PRESENT == 1)
90 #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
97 #elif defined ( __GNUC__ )
98 #if defined (__VFP_FP__) && !defined(__SOFTFP__)
99 #if (__FPU_PRESENT == 1)
100 #define __FPU_USED 1U
102 #warning "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
103 #define __FPU_USED 0U
106 #define __FPU_USED 0U
109 #elif defined ( __TASKING__ )
110 #if defined __FPU_VFP__
111 #if (__FPU_PRESENT == 1)
112 #define __FPU_USED 1U
114 #error "Compiler generates FPU instructions for a device without an FPU (check __FPU_PRESENT)"
115 #define __FPU_USED 0U
118 #define __FPU_USED 0U
122 #include "cmsis_compiler.h" /* CMSIS compiler specific defines */
128 #endif /* __CORE_CA_H_GENERIC */
130 #ifndef __CMSIS_GENERIC
132 #ifndef __CORE_CA_H_DEPENDANT
133 #define __CORE_CA_H_DEPENDANT
139 /* check device defines and use defaults */
140 #if defined __CHECK_DEVICE_DEFINES
142 #define __CA_REV 0x0000U
143 #warning "__CA_REV not defined in device header file; using default!"
146 #ifndef __FPU_PRESENT
147 #define __FPU_PRESENT 0U
148 #warning "__FPU_PRESENT not defined in device header file; using default!"
151 #ifndef __GIC_PRESENT
152 #define __GIC_PRESENT 1U
153 #warning "__GIC_PRESENT not defined in device header file; using default!"
156 #ifndef __TIM_PRESENT
157 #define __TIM_PRESENT 1U
158 #warning "__TIM_PRESENT not defined in device header file; using default!"
161 #ifndef __L2C_PRESENT
162 #define __L2C_PRESENT 0U
163 #warning "__L2C_PRESENT not defined in device header file; using default!"
167 /* IO definitions (access restrictions to peripheral registers) */
169 #define __I volatile /*!< \brief Defines 'read only' permissions */
171 #define __I volatile const /*!< \brief Defines 'read only' permissions */
173 #define __O volatile /*!< \brief Defines 'write only' permissions */
174 #define __IO volatile /*!< \brief Defines 'read / write' permissions */
176 /* following defines should be used for structure members */
177 #define __IM volatile const /*!< \brief Defines 'read only' structure member permissions */
178 #define __OM volatile /*!< \brief Defines 'write only' structure member permissions */
179 #define __IOM volatile /*!< \brief Defines 'read / write' structure member permissions */
180 #define RESERVED(N, T) T RESERVED##N; // placeholder struct members used for "reserved" areas
182 /*******************************************************************************
183 * Register Abstraction
184 Core Register contain:
187 - L2C-310 Cache Controller
188 - Generic Interrupt Controller Distributor
189 - Generic Interrupt Controller Interface
190 ******************************************************************************/
192 /* Core Register CPSR */
197 uint32_t M:5; /*!< \brief bit: 0.. 4 Mode field */
198 uint32_t T:1; /*!< \brief bit: 5 Thumb execution state bit */
199 uint32_t F:1; /*!< \brief bit: 6 FIQ mask bit */
200 uint32_t I:1; /*!< \brief bit: 7 IRQ mask bit */
201 uint32_t A:1; /*!< \brief bit: 8 Asynchronous abort mask bit */
202 uint32_t E:1; /*!< \brief bit: 9 Endianness execution state bit */
203 uint32_t IT1:6; /*!< \brief bit: 10..15 If-Then execution state bits 2-7 */
204 uint32_t GE:4; /*!< \brief bit: 16..19 Greater than or Equal flags */
205 RESERVED(0:4, uint32_t)
206 uint32_t J:1; /*!< \brief bit: 24 Jazelle bit */
207 uint32_t IT0:2; /*!< \brief bit: 25..26 If-Then execution state bits 0-1 */
208 uint32_t Q:1; /*!< \brief bit: 27 Saturation condition flag */
209 uint32_t V:1; /*!< \brief bit: 28 Overflow condition code flag */
210 uint32_t C:1; /*!< \brief bit: 29 Carry condition code flag */
211 uint32_t Z:1; /*!< \brief bit: 30 Zero condition code flag */
212 uint32_t N:1; /*!< \brief bit: 31 Negative condition code flag */
213 } b; /*!< \brief Structure used for bit access */
214 uint32_t w; /*!< \brief Type used for word access */
219 /* CPSR Register Definitions */
220 #define CPSR_N_Pos 31U /*!< \brief CPSR: N Position */
221 #define CPSR_N_Msk (1UL << CPSR_N_Pos) /*!< \brief CPSR: N Mask */
223 #define CPSR_Z_Pos 30U /*!< \brief CPSR: Z Position */
224 #define CPSR_Z_Msk (1UL << CPSR_Z_Pos) /*!< \brief CPSR: Z Mask */
226 #define CPSR_C_Pos 29U /*!< \brief CPSR: C Position */
227 #define CPSR_C_Msk (1UL << CPSR_C_Pos) /*!< \brief CPSR: C Mask */
229 #define CPSR_V_Pos 28U /*!< \brief CPSR: V Position */
230 #define CPSR_V_Msk (1UL << CPSR_V_Pos) /*!< \brief CPSR: V Mask */
232 #define CPSR_Q_Pos 27U /*!< \brief CPSR: Q Position */
233 #define CPSR_Q_Msk (1UL << CPSR_Q_Pos) /*!< \brief CPSR: Q Mask */
235 #define CPSR_IT0_Pos 25U /*!< \brief CPSR: IT0 Position */
236 #define CPSR_IT0_Msk (3UL << CPSR_IT0_Pos) /*!< \brief CPSR: IT0 Mask */
238 #define CPSR_J_Pos 24U /*!< \brief CPSR: J Position */
239 #define CPSR_J_Msk (1UL << CPSR_J_Pos) /*!< \brief CPSR: J Mask */
241 #define CPSR_GE_Pos 16U /*!< \brief CPSR: GE Position */
242 #define CPSR_GE_Msk (0xFUL << CPSR_GE_Pos) /*!< \brief CPSR: GE Mask */
244 #define CPSR_IT1_Pos 10U /*!< \brief CPSR: IT1 Position */
245 #define CPSR_IT1_Msk (0x3FUL << CPSR_IT1_Pos) /*!< \brief CPSR: IT1 Mask */
247 #define CPSR_E_Pos 9U /*!< \brief CPSR: E Position */
248 #define CPSR_E_Msk (1UL << CPSR_E_Pos) /*!< \brief CPSR: E Mask */
250 #define CPSR_A_Pos 8U /*!< \brief CPSR: A Position */
251 #define CPSR_A_Msk (1UL << CPSR_A_Pos) /*!< \brief CPSR: A Mask */
253 #define CPSR_I_Pos 7U /*!< \brief CPSR: I Position */
254 #define CPSR_I_Msk (1UL << CPSR_I_Pos) /*!< \brief CPSR: I Mask */
256 #define CPSR_F_Pos 6U /*!< \brief CPSR: F Position */
257 #define CPSR_F_Msk (1UL << CPSR_F_Pos) /*!< \brief CPSR: F Mask */
259 #define CPSR_T_Pos 5U /*!< \brief CPSR: T Position */
260 #define CPSR_T_Msk (1UL << CPSR_T_Pos) /*!< \brief CPSR: T Mask */
262 #define CPSR_M_Pos 0U /*!< \brief CPSR: M Position */
263 #define CPSR_M_Msk (0x1FUL << CPSR_M_Pos) /*!< \brief CPSR: M Mask */
265 #define CPSR_M_USR 0x10U /*!< \brief CPSR: M User mode (PL0) */
266 #define CPSR_M_FIQ 0x11U /*!< \brief CPSR: M Fast Interrupt mode (PL1) */
267 #define CPSR_M_IRQ 0x12U /*!< \brief CPSR: M Interrupt mode (PL1) */
268 #define CPSR_M_SVC 0x13U /*!< \brief CPSR: M Supervisor mode (PL1) */
269 #define CPSR_M_MON 0x16U /*!< \brief CPSR: M Monitor mode (PL1) */
270 #define CPSR_M_ABT 0x17U /*!< \brief CPSR: M Abort mode (PL1) */
271 #define CPSR_M_HYP 0x1AU /*!< \brief CPSR: M Hypervisor mode (PL2) */
272 #define CPSR_M_UND 0x1BU /*!< \brief CPSR: M Undefined mode (PL1) */
273 #define CPSR_M_SYS 0x1FU /*!< \brief CPSR: M System mode (PL1) */
275 /* CP15 Register SCTLR */
280 uint32_t M:1; /*!< \brief bit: 0 MMU enable */
281 uint32_t A:1; /*!< \brief bit: 1 Alignment check enable */
282 uint32_t C:1; /*!< \brief bit: 2 Cache enable */
283 RESERVED(0:2, uint32_t)
284 uint32_t CP15BEN:1; /*!< \brief bit: 5 CP15 barrier enable */
285 RESERVED(1:1, uint32_t)
286 uint32_t B:1; /*!< \brief bit: 7 Endianness model */
287 RESERVED(2:2, uint32_t)
288 uint32_t SW:1; /*!< \brief bit: 10 SWP and SWPB enable */
289 uint32_t Z:1; /*!< \brief bit: 11 Branch prediction enable */
290 uint32_t I:1; /*!< \brief bit: 12 Instruction cache enable */
291 uint32_t V:1; /*!< \brief bit: 13 Vectors bit */
292 uint32_t RR:1; /*!< \brief bit: 14 Round Robin select */
293 RESERVED(3:2, uint32_t)
294 uint32_t HA:1; /*!< \brief bit: 17 Hardware Access flag enable */
295 RESERVED(4:1, uint32_t)
296 uint32_t WXN:1; /*!< \brief bit: 19 Write permission implies XN */
297 uint32_t UWXN:1; /*!< \brief bit: 20 Unprivileged write permission implies PL1 XN */
298 uint32_t FI:1; /*!< \brief bit: 21 Fast interrupts configuration enable */
299 uint32_t U:1; /*!< \brief bit: 22 Alignment model */
300 RESERVED(5:1, uint32_t)
301 uint32_t VE:1; /*!< \brief bit: 24 Interrupt Vectors Enable */
302 uint32_t EE:1; /*!< \brief bit: 25 Exception Endianness */
303 RESERVED(6:1, uint32_t)
304 uint32_t NMFI:1; /*!< \brief bit: 27 Non-maskable FIQ (NMFI) support */
305 uint32_t TRE:1; /*!< \brief bit: 28 TEX remap enable. */
306 uint32_t AFE:1; /*!< \brief bit: 29 Access flag enable */
307 uint32_t TE:1; /*!< \brief bit: 30 Thumb Exception enable */
308 RESERVED(7:1, uint32_t)
309 } b; /*!< \brief Structure used for bit access */
310 uint32_t w; /*!< \brief Type used for word access */
313 #define SCTLR_TE_Pos 30U /*!< \brief SCTLR: TE Position */
314 #define SCTLR_TE_Msk (1UL << SCTLR_TE_Pos) /*!< \brief SCTLR: TE Mask */
316 #define SCTLR_AFE_Pos 29U /*!< \brief SCTLR: AFE Position */
317 #define SCTLR_AFE_Msk (1UL << SCTLR_AFE_Pos) /*!< \brief SCTLR: AFE Mask */
319 #define SCTLR_TRE_Pos 28U /*!< \brief SCTLR: TRE Position */
320 #define SCTLR_TRE_Msk (1UL << SCTLR_TRE_Pos) /*!< \brief SCTLR: TRE Mask */
322 #define SCTLR_NMFI_Pos 27U /*!< \brief SCTLR: NMFI Position */
323 #define SCTLR_NMFI_Msk (1UL << SCTLR_NMFI_Pos) /*!< \brief SCTLR: NMFI Mask */
325 #define SCTLR_EE_Pos 25U /*!< \brief SCTLR: EE Position */
326 #define SCTLR_EE_Msk (1UL << SCTLR_EE_Pos) /*!< \brief SCTLR: EE Mask */
328 #define SCTLR_VE_Pos 24U /*!< \brief SCTLR: VE Position */
329 #define SCTLR_VE_Msk (1UL << SCTLR_VE_Pos) /*!< \brief SCTLR: VE Mask */
331 #define SCTLR_U_Pos 22U /*!< \brief SCTLR: U Position */
332 #define SCTLR_U_Msk (1UL << SCTLR_U_Pos) /*!< \brief SCTLR: U Mask */
334 #define SCTLR_FI_Pos 21U /*!< \brief SCTLR: FI Position */
335 #define SCTLR_FI_Msk (1UL << SCTLR_FI_Pos) /*!< \brief SCTLR: FI Mask */
337 #define SCTLR_UWXN_Pos 20U /*!< \brief SCTLR: UWXN Position */
338 #define SCTLR_UWXN_Msk (1UL << SCTLR_UWXN_Pos) /*!< \brief SCTLR: UWXN Mask */
340 #define SCTLR_WXN_Pos 19U /*!< \brief SCTLR: WXN Position */
341 #define SCTLR_WXN_Msk (1UL << SCTLR_WXN_Pos) /*!< \brief SCTLR: WXN Mask */
343 #define SCTLR_HA_Pos 17U /*!< \brief SCTLR: HA Position */
344 #define SCTLR_HA_Msk (1UL << SCTLR_HA_Pos) /*!< \brief SCTLR: HA Mask */
346 #define SCTLR_RR_Pos 14U /*!< \brief SCTLR: RR Position */
347 #define SCTLR_RR_Msk (1UL << SCTLR_RR_Pos) /*!< \brief SCTLR: RR Mask */
349 #define SCTLR_V_Pos 13U /*!< \brief SCTLR: V Position */
350 #define SCTLR_V_Msk (1UL << SCTLR_V_Pos) /*!< \brief SCTLR: V Mask */
352 #define SCTLR_I_Pos 12U /*!< \brief SCTLR: I Position */
353 #define SCTLR_I_Msk (1UL << SCTLR_I_Pos) /*!< \brief SCTLR: I Mask */
355 #define SCTLR_Z_Pos 11U /*!< \brief SCTLR: Z Position */
356 #define SCTLR_Z_Msk (1UL << SCTLR_Z_Pos) /*!< \brief SCTLR: Z Mask */
358 #define SCTLR_SW_Pos 10U /*!< \brief SCTLR: SW Position */
359 #define SCTLR_SW_Msk (1UL << SCTLR_SW_Pos) /*!< \brief SCTLR: SW Mask */
361 #define SCTLR_B_Pos 7U /*!< \brief SCTLR: B Position */
362 #define SCTLR_B_Msk (1UL << SCTLR_B_Pos) /*!< \brief SCTLR: B Mask */
364 #define SCTLR_CP15BEN_Pos 5U /*!< \brief SCTLR: CP15BEN Position */
365 #define SCTLR_CP15BEN_Msk (1UL << SCTLR_CP15BEN_Pos) /*!< \brief SCTLR: CP15BEN Mask */
367 #define SCTLR_C_Pos 2U /*!< \brief SCTLR: C Position */
368 #define SCTLR_C_Msk (1UL << SCTLR_C_Pos) /*!< \brief SCTLR: C Mask */
370 #define SCTLR_A_Pos 1U /*!< \brief SCTLR: A Position */
371 #define SCTLR_A_Msk (1UL << SCTLR_A_Pos) /*!< \brief SCTLR: A Mask */
373 #define SCTLR_M_Pos 0U /*!< \brief SCTLR: M Position */
374 #define SCTLR_M_Msk (1UL << SCTLR_M_Pos) /*!< \brief SCTLR: M Mask */
376 /* CP15 Register ACTLR */
379 #if __CORTEX_A == 5 || defined(DOXYGEN)
380 /** \brief Structure used for bit access on Cortex-A5 */
383 uint32_t FW:1; /*!< \brief bit: 0 Cache and TLB maintenance broadcast */
384 RESERVED(0:5, uint32_t)
385 uint32_t SMP:1; /*!< \brief bit: 6 Enables coherent requests to the processor */
386 uint32_t EXCL:1; /*!< \brief bit: 7 Exclusive L1/L2 cache control */
387 RESERVED(1:2, uint32_t)
388 uint32_t DODMBS:1; /*!< \brief bit: 10 Disable optimized data memory barrier behavior */
389 uint32_t DWBST:1; /*!< \brief bit: 11 AXI data write bursts to Normal memory */
390 uint32_t RADIS:1; /*!< \brief bit: 12 L1 Data Cache read-allocate mode disable */
391 uint32_t L1PCTL:2; /*!< \brief bit:13..14 L1 Data prefetch control */
392 uint32_t BP:2; /*!< \brief bit:16..15 Branch prediction policy */
393 uint32_t RSDIS:1; /*!< \brief bit: 17 Disable return stack operation */
394 uint32_t BTDIS:1; /*!< \brief bit: 18 Disable indirect Branch Target Address Cache (BTAC) */
395 RESERVED(3:9, uint32_t)
396 uint32_t DBDI:1; /*!< \brief bit: 28 Disable branch dual issue */
397 RESERVED(7:3, uint32_t)
400 #if __CORTEX_A == 7 || defined(DOXYGEN)
401 /** \brief Structure used for bit access on Cortex-A7 */
404 RESERVED(0:6, uint32_t)
405 uint32_t SMP:1; /*!< \brief bit: 6 Enables coherent requests to the processor */
406 RESERVED(1:3, uint32_t)
407 uint32_t DODMBS:1; /*!< \brief bit: 10 Disable optimized data memory barrier behavior */
408 uint32_t L2RADIS:1; /*!< \brief bit: 11 L2 Data Cache read-allocate mode disable */
409 uint32_t L1RADIS:1; /*!< \brief bit: 12 L1 Data Cache read-allocate mode disable */
410 uint32_t L1PCTL:2; /*!< \brief bit:13..14 L1 Data prefetch control */
411 uint32_t DDVM:1; /*!< \brief bit: 15 Disable Distributed Virtual Memory (DVM) transactions */
412 RESERVED(3:12, uint32_t)
413 uint32_t DDI:1; /*!< \brief bit: 28 Disable dual issue */
414 RESERVED(7:3, uint32_t)
417 #if __CORTEX_A == 9 || defined(DOXYGEN)
418 /** \brief Structure used for bit access on Cortex-A9 */
421 uint32_t FW:1; /*!< \brief bit: 0 Cache and TLB maintenance broadcast */
422 RESERVED(0:1, uint32_t)
423 uint32_t L1PE:1; /*!< \brief bit: 2 Dside prefetch */
424 uint32_t WFLZM:1; /*!< \brief bit: 3 Cache and TLB maintenance broadcast */
425 RESERVED(1:2, uint32_t)
426 uint32_t SMP:1; /*!< \brief bit: 6 Enables coherent requests to the processor */
427 uint32_t EXCL:1; /*!< \brief bit: 7 Exclusive L1/L2 cache control */
428 uint32_t AOW:1; /*!< \brief bit: 8 Enable allocation in one cache way only */
429 uint32_t PARITY:1; /*!< \brief bit: 9 Support for parity checking, if implemented */
430 RESERVED(7:22, uint32_t)
433 uint32_t w; /*!< \brief Type used for word access */
436 #define ACTLR_DDI_Pos 28U /*!< \brief ACTLR: DDI Position */
437 #define ACTLR_DDI_Msk (1UL << ACTLR_DDI_Pos) /*!< \brief ACTLR: DDI Mask */
439 #define ACTLR_DBDI_Pos 28U /*!< \brief ACTLR: DBDI Position */
440 #define ACTLR_DBDI_Msk (1UL << ACTLR_DBDI_Pos) /*!< \brief ACTLR: DBDI Mask */
442 #define ACTLR_BTDIS_Pos 18U /*!< \brief ACTLR: BTDIS Position */
443 #define ACTLR_BTDIS_Msk (1UL << ACTLR_BTDIS_Pos) /*!< \brief ACTLR: BTDIS Mask */
445 #define ACTLR_RSDIS_Pos 17U /*!< \brief ACTLR: RSDIS Position */
446 #define ACTLR_RSDIS_Msk (1UL << ACTLR_RSDIS_Pos) /*!< \brief ACTLR: RSDIS Mask */
448 #define ACTLR_BP_Pos 15U /*!< \brief ACTLR: BP Position */
449 #define ACTLR_BP_Msk (3UL << ACTLR_BP_Pos) /*!< \brief ACTLR: BP Mask */
451 #define ACTLR_DDVM_Pos 15U /*!< \brief ACTLR: DDVM Position */
452 #define ACTLR_DDVM_Msk (1UL << ACTLR_DDVM_Pos) /*!< \brief ACTLR: DDVM Mask */
454 #define ACTLR_L1PCTL_Pos 13U /*!< \brief ACTLR: L1PCTL Position */
455 #define ACTLR_L1PCTL_Msk (3UL << ACTLR_L1PCTL_Pos) /*!< \brief ACTLR: L1PCTL Mask */
457 #define ACTLR_RADIS_Pos 12U /*!< \brief ACTLR: RADIS Position */
458 #define ACTLR_RADIS_Msk (1UL << ACTLR_RADIS_Pos) /*!< \brief ACTLR: RADIS Mask */
460 #define ACTLR_L1RADIS_Pos 12U /*!< \brief ACTLR: L1RADIS Position */
461 #define ACTLR_L1RADIS_Msk (1UL << ACTLR_L1RADIS_Pos) /*!< \brief ACTLR: L1RADIS Mask */
463 #define ACTLR_DWBST_Pos 11U /*!< \brief ACTLR: DWBST Position */
464 #define ACTLR_DWBST_Msk (1UL << ACTLR_DWBST_Pos) /*!< \brief ACTLR: DWBST Mask */
466 #define ACTLR_L2RADIS_Pos 11U /*!< \brief ACTLR: L2RADIS Position */
467 #define ACTLR_L2RADIS_Msk (1UL << ACTLR_L2RADIS_Pos) /*!< \brief ACTLR: L2RADIS Mask */
469 #define ACTLR_DODMBS_Pos 10U /*!< \brief ACTLR: DODMBS Position */
470 #define ACTLR_DODMBS_Msk (1UL << ACTLR_DODMBS_Pos) /*!< \brief ACTLR: DODMBS Mask */
472 #define ACTLR_PARITY_Pos 9U /*!< \brief ACTLR: PARITY Position */
473 #define ACTLR_PARITY_Msk (1UL << ACTLR_PARITY_Pos) /*!< \brief ACTLR: PARITY Mask */
475 #define ACTLR_AOW_Pos 8U /*!< \brief ACTLR: AOW Position */
476 #define ACTLR_AOW_Msk (1UL << ACTLR_AOW_Pos) /*!< \brief ACTLR: AOW Mask */
478 #define ACTLR_EXCL_Pos 7U /*!< \brief ACTLR: EXCL Position */
479 #define ACTLR_EXCL_Msk (1UL << ACTLR_EXCL_Pos) /*!< \brief ACTLR: EXCL Mask */
481 #define ACTLR_SMP_Pos 6U /*!< \brief ACTLR: SMP Position */
482 #define ACTLR_SMP_Msk (1UL << ACTLR_SMP_Pos) /*!< \brief ACTLR: SMP Mask */
484 #define ACTLR_WFLZM_Pos 3U /*!< \brief ACTLR: WFLZM Position */
485 #define ACTLR_WFLZM_Msk (1UL << ACTLR_WFLZM_Pos) /*!< \brief ACTLR: WFLZM Mask */
487 #define ACTLR_L1PE_Pos 2U /*!< \brief ACTLR: L1PE Position */
488 #define ACTLR_L1PE_Msk (1UL << ACTLR_L1PE_Pos) /*!< \brief ACTLR: L1PE Mask */
490 #define ACTLR_FW_Pos 0U /*!< \brief ACTLR: FW Position */
491 #define ACTLR_FW_Msk (1UL << ACTLR_FW_Pos) /*!< \brief ACTLR: FW Mask */
493 /* CP15 Register CPACR */
498 uint32_t CP0:2; /*!< \brief bit: 0..1 Access rights for coprocessor 0 */
499 uint32_t CP1:2; /*!< \brief bit: 2..3 Access rights for coprocessor 1 */
500 uint32_t CP2:2; /*!< \brief bit: 4..5 Access rights for coprocessor 2 */
501 uint32_t CP3:2; /*!< \brief bit: 6..7 Access rights for coprocessor 3 */
502 uint32_t CP4:2; /*!< \brief bit: 8..9 Access rights for coprocessor 4 */
503 uint32_t CP5:2; /*!< \brief bit:10..11 Access rights for coprocessor 5 */
504 uint32_t CP6:2; /*!< \brief bit:12..13 Access rights for coprocessor 6 */
505 uint32_t CP7:2; /*!< \brief bit:14..15 Access rights for coprocessor 7 */
506 uint32_t CP8:2; /*!< \brief bit:16..17 Access rights for coprocessor 8 */
507 uint32_t CP9:2; /*!< \brief bit:18..19 Access rights for coprocessor 9 */
508 uint32_t CP10:2; /*!< \brief bit:20..21 Access rights for coprocessor 10 */
509 uint32_t CP11:2; /*!< \brief bit:22..23 Access rights for coprocessor 11 */
510 uint32_t CP12:2; /*!< \brief bit:24..25 Access rights for coprocessor 11 */
511 uint32_t CP13:2; /*!< \brief bit:26..27 Access rights for coprocessor 11 */
512 uint32_t TRCDIS:1; /*!< \brief bit: 28 Disable CP14 access to trace registers */
513 RESERVED(0:1, uint32_t)
514 uint32_t D32DIS:1; /*!< \brief bit: 30 Disable use of registers D16-D31 of the VFP register file */
515 uint32_t ASEDIS:1; /*!< \brief bit: 31 Disable Advanced SIMD Functionality */
516 } b; /*!< \brief Structure used for bit access */
517 uint32_t w; /*!< \brief Type used for word access */
520 #define CPACR_ASEDIS_Pos 31U /*!< \brief CPACR: ASEDIS Position */
521 #define CPACR_ASEDIS_Msk (1UL << CPACR_ASEDIS_Pos) /*!< \brief CPACR: ASEDIS Mask */
523 #define CPACR_D32DIS_Pos 30U /*!< \brief CPACR: D32DIS Position */
524 #define CPACR_D32DIS_Msk (1UL << CPACR_D32DIS_Pos) /*!< \brief CPACR: D32DIS Mask */
526 #define CPACR_TRCDIS_Pos 28U /*!< \brief CPACR: D32DIS Position */
527 #define CPACR_TRCDIS_Msk (1UL << CPACR_D32DIS_Pos) /*!< \brief CPACR: D32DIS Mask */
529 #define CPACR_CP_Pos_(n) (n*2U) /*!< \brief CPACR: CPn Position */
530 #define CPACR_CP_Msk_(n) (3UL << CPACR_CP_Pos_(n)) /*!< \brief CPACR: CPn Mask */
532 #define CPACR_CP_NA 0U /*!< \brief CPACR CPn field: Access denied. */
533 #define CPACR_CP_PL1 1U /*!< \brief CPACR CPn field: Accessible from PL1 only. */
534 #define CPACR_CP_FA 3U /*!< \brief CPACR CPn field: Full access. */
536 /* CP15 Register DFSR */
541 uint32_t FS0:4; /*!< \brief bit: 0.. 3 Fault Status bits bit 0-3 */
542 uint32_t Domain:4; /*!< \brief bit: 4.. 7 Fault on which domain */
543 RESERVED(0:1, uint32_t)
544 uint32_t LPAE:1; /*!< \brief bit: 9 Large Physical Address Extension */
545 uint32_t FS1:1; /*!< \brief bit: 10 Fault Status bits bit 4 */
546 uint32_t WnR:1; /*!< \brief bit: 11 Write not Read bit */
547 uint32_t ExT:1; /*!< \brief bit: 12 External abort type */
548 uint32_t CM:1; /*!< \brief bit: 13 Cache maintenance fault */
549 RESERVED(1:18, uint32_t)
550 } s; /*!< \brief Structure used for bit access in short format */
553 uint32_t STATUS:5; /*!< \brief bit: 0.. 5 Fault Status bits */
554 RESERVED(0:3, uint32_t)
555 uint32_t LPAE:1; /*!< \brief bit: 9 Large Physical Address Extension */
556 RESERVED(1:1, uint32_t)
557 uint32_t WnR:1; /*!< \brief bit: 11 Write not Read bit */
558 uint32_t ExT:1; /*!< \brief bit: 12 External abort type */
559 uint32_t CM:1; /*!< \brief bit: 13 Cache maintenance fault */
560 RESERVED(2:18, uint32_t)
561 } l; /*!< \brief Structure used for bit access in long format */
562 uint32_t w; /*!< \brief Type used for word access */
565 #define DFSR_CM_Pos 13U /*!< \brief DFSR: CM Position */
566 #define DFSR_CM_Msk (1UL << DFSR_CM_Pos) /*!< \brief DFSR: CM Mask */
568 #define DFSR_Ext_Pos 12U /*!< \brief DFSR: Ext Position */
569 #define DFSR_Ext_Msk (1UL << DFSR_Ext_Pos) /*!< \brief DFSR: Ext Mask */
571 #define DFSR_WnR_Pos 11U /*!< \brief DFSR: WnR Position */
572 #define DFSR_WnR_Msk (1UL << DFSR_WnR_Pos) /*!< \brief DFSR: WnR Mask */
574 #define DFSR_FS1_Pos 10U /*!< \brief DFSR: FS1 Position */
575 #define DFSR_FS1_Msk (1UL << DFSR_FS1_Pos) /*!< \brief DFSR: FS1 Mask */
577 #define DFSR_LPAE_Pos 9U /*!< \brief DFSR: LPAE Position */
578 #define DFSR_LPAE_Msk (1UL << DFSR_LPAE_Pos) /*!< \brief DFSR: LPAE Mask */
580 #define DFSR_Domain_Pos 4U /*!< \brief DFSR: Domain Position */
581 #define DFSR_Domain_Msk (0xFUL << DFSR_Domain_Pos) /*!< \brief DFSR: Domain Mask */
583 #define DFSR_FS0_Pos 0U /*!< \brief DFSR: FS0 Position */
584 #define DFSR_FS0_Msk (0xFUL << DFSR_FS0_Pos) /*!< \brief DFSR: FS0 Mask */
586 #define DFSR_STATUS_Pos 0U /*!< \brief DFSR: STATUS Position */
587 #define DFSR_STATUS_Msk (0x3FUL << DFSR_STATUS_Pos) /*!< \brief DFSR: STATUS Mask */
589 /* CP15 Register IFSR */
594 uint32_t FS0:4; /*!< \brief bit: 0.. 3 Fault Status bits bit 0-3 */
595 RESERVED(0:5, uint32_t)
596 uint32_t LPAE:1; /*!< \brief bit: 9 Large Physical Address Extension */
597 uint32_t FS1:1; /*!< \brief bit: 10 Fault Status bits bit 4 */
598 RESERVED(1:1, uint32_t)
599 uint32_t ExT:1; /*!< \brief bit: 12 External abort type */
600 RESERVED(2:19, uint32_t)
601 } s; /*!< \brief Structure used for bit access in short format */
604 uint32_t STATUS:6; /*!< \brief bit: 0.. 5 Fault Status bits */
605 RESERVED(0:3, uint32_t)
606 uint32_t LPAE:1; /*!< \brief bit: 9 Large Physical Address Extension */
607 RESERVED(1:2, uint32_t)
608 uint32_t ExT:1; /*!< \brief bit: 12 External abort type */
609 RESERVED(2:19, uint32_t)
610 } l; /*!< \brief Structure used for bit access in long format */
611 uint32_t w; /*!< \brief Type used for word access */
614 #define IFSR_ExT_Pos 12U /*!< \brief IFSR: ExT Position */
615 #define IFSR_ExT_Msk (1UL << IFSR_ExT_Pos) /*!< \brief IFSR: ExT Mask */
617 #define IFSR_FS1_Pos 10U /*!< \brief IFSR: FS1 Position */
618 #define IFSR_FS1_Msk (1UL << IFSR_FS1_Pos) /*!< \brief IFSR: FS1 Mask */
620 #define IFSR_LPAE_Pos 9U /*!< \brief IFSR: LPAE Position */
621 #define IFSR_LPAE_Msk (0x1UL << IFSR_LPAE_Pos) /*!< \brief IFSR: LPAE Mask */
623 #define IFSR_FS0_Pos 0U /*!< \brief IFSR: FS0 Position */
624 #define IFSR_FS0_Msk (0xFUL << IFSR_FS0_Pos) /*!< \brief IFSR: FS0 Mask */
626 #define IFSR_STATUS_Pos 0U /*!< \brief IFSR: STATUS Position */
627 #define IFSR_STATUS_Msk (0x3FUL << IFSR_STATUS_Pos) /*!< \brief IFSR: STATUS Mask */
629 /* CP15 Register ISR */
634 RESERVED(0:6, uint32_t)
635 uint32_t F:1; /*!< \brief bit: 6 FIQ pending bit */
636 uint32_t I:1; /*!< \brief bit: 7 IRQ pending bit */
637 uint32_t A:1; /*!< \brief bit: 8 External abort pending bit */
638 RESERVED(1:23, uint32_t)
639 } b; /*!< \brief Structure used for bit access */
640 uint32_t w; /*!< \brief Type used for word access */
643 #define ISR_A_Pos 13U /*!< \brief ISR: A Position */
644 #define ISR_A_Msk (1UL << ISR_A_Pos) /*!< \brief ISR: A Mask */
646 #define ISR_I_Pos 12U /*!< \brief ISR: I Position */
647 #define ISR_I_Msk (1UL << ISR_I_Pos) /*!< \brief ISR: I Mask */
649 #define ISR_F_Pos 11U /*!< \brief ISR: F Position */
650 #define ISR_F_Msk (1UL << ISR_F_Pos) /*!< \brief ISR: F Mask */
653 #define DACR_D_Pos_(n) (2U*n) /*!< \brief DACR: Dn Position */
654 #define DACR_D_Msk_(n) (3UL << DACR_D_Pos_(n)) /*!< \brief DACR: Dn Mask */
655 #define DACR_Dn_NOACCESS 0U /*!< \brief DACR Dn field: No access */
656 #define DACR_Dn_CLIENT 1U /*!< \brief DACR Dn field: Client */
657 #define DACR_Dn_MANAGER 3U /*!< \brief DACR Dn field: Manager */
660 \brief Mask and shift a bit field value for use in a register bit range.
661 \param [in] field Name of the register bit field.
662 \param [in] value Value of the bit field. This parameter is interpreted as an uint32_t type.
663 \return Masked and shifted value.
665 #define _VAL2FLD(field, value) (((uint32_t)(value) << field ## _Pos) & field ## _Msk)
668 \brief Mask and shift a register value to extract a bit filed value.
669 \param [in] field Name of the register bit field.
670 \param [in] value Value of register. This parameter is interpreted as an uint32_t type.
671 \return Masked and shifted bit field value.
673 #define _FLD2VAL(field, value) (((uint32_t)(value) & field ## _Msk) >> field ## _Pos)
677 \brief Union type to access the L2C_310 Cache Controller.
679 #if (__L2C_PRESENT == 1U) || defined(DOXYGEN)
682 __IM uint32_t CACHE_ID; /*!< \brief Offset: 0x0000 (R/ ) Cache ID Register */
683 __IM uint32_t CACHE_TYPE; /*!< \brief Offset: 0x0004 (R/ ) Cache Type Register */
684 RESERVED(0[0x3e], uint32_t)
685 __IOM uint32_t CONTROL; /*!< \brief Offset: 0x0100 (R/W) Control Register */
686 __IOM uint32_t AUX_CNT; /*!< \brief Offset: 0x0104 (R/W) Auxiliary Control */
687 RESERVED(1[0x3e], uint32_t)
688 __IOM uint32_t EVENT_CONTROL; /*!< \brief Offset: 0x0200 (R/W) Event Counter Control */
689 __IOM uint32_t EVENT_COUNTER1_CONF; /*!< \brief Offset: 0x0204 (R/W) Event Counter 1 Configuration */
690 __IOM uint32_t EVENT_COUNTER0_CONF; /*!< \brief Offset: 0x0208 (R/W) Event Counter 1 Configuration */
691 RESERVED(2[0x2], uint32_t)
692 __IOM uint32_t INTERRUPT_MASK; /*!< \brief Offset: 0x0214 (R/W) Interrupt Mask */
693 __IM uint32_t MASKED_INT_STATUS; /*!< \brief Offset: 0x0218 (R/ ) Masked Interrupt Status */
694 __IM uint32_t RAW_INT_STATUS; /*!< \brief Offset: 0x021c (R/ ) Raw Interrupt Status */
695 __OM uint32_t INTERRUPT_CLEAR; /*!< \brief Offset: 0x0220 ( /W) Interrupt Clear */
696 RESERVED(3[0x143], uint32_t)
697 __IOM uint32_t CACHE_SYNC; /*!< \brief Offset: 0x0730 (R/W) Cache Sync */
698 RESERVED(4[0xf], uint32_t)
699 __IOM uint32_t INV_LINE_PA; /*!< \brief Offset: 0x0770 (R/W) Invalidate Line By PA */
700 RESERVED(6[2], uint32_t)
701 __IOM uint32_t INV_WAY; /*!< \brief Offset: 0x077c (R/W) Invalidate by Way */
702 RESERVED(5[0xc], uint32_t)
703 __IOM uint32_t CLEAN_LINE_PA; /*!< \brief Offset: 0x07b0 (R/W) Clean Line by PA */
704 RESERVED(7[1], uint32_t)
705 __IOM uint32_t CLEAN_LINE_INDEX_WAY; /*!< \brief Offset: 0x07b8 (R/W) Clean Line by Index/Way */
706 __IOM uint32_t CLEAN_WAY; /*!< \brief Offset: 0x07bc (R/W) Clean by Way */
707 RESERVED(8[0xc], uint32_t)
708 __IOM uint32_t CLEAN_INV_LINE_PA; /*!< \brief Offset: 0x07f0 (R/W) Clean and Invalidate Line by PA */
709 RESERVED(9[1], uint32_t)
710 __IOM uint32_t CLEAN_INV_LINE_INDEX_WAY; /*!< \brief Offset: 0x07f8 (R/W) Clean and Invalidate Line by Index/Way */
711 __IOM uint32_t CLEAN_INV_WAY; /*!< \brief Offset: 0x07fc (R/W) Clean and Invalidate by Way */
712 RESERVED(10[0x40], uint32_t)
713 __IOM uint32_t DATA_LOCK_0_WAY; /*!< \brief Offset: 0x0900 (R/W) Data Lockdown 0 by Way */
714 __IOM uint32_t INST_LOCK_0_WAY; /*!< \brief Offset: 0x0904 (R/W) Instruction Lockdown 0 by Way */
715 __IOM uint32_t DATA_LOCK_1_WAY; /*!< \brief Offset: 0x0908 (R/W) Data Lockdown 1 by Way */
716 __IOM uint32_t INST_LOCK_1_WAY; /*!< \brief Offset: 0x090c (R/W) Instruction Lockdown 1 by Way */
717 __IOM uint32_t DATA_LOCK_2_WAY; /*!< \brief Offset: 0x0910 (R/W) Data Lockdown 2 by Way */
718 __IOM uint32_t INST_LOCK_2_WAY; /*!< \brief Offset: 0x0914 (R/W) Instruction Lockdown 2 by Way */
719 __IOM uint32_t DATA_LOCK_3_WAY; /*!< \brief Offset: 0x0918 (R/W) Data Lockdown 3 by Way */
720 __IOM uint32_t INST_LOCK_3_WAY; /*!< \brief Offset: 0x091c (R/W) Instruction Lockdown 3 by Way */
721 __IOM uint32_t DATA_LOCK_4_WAY; /*!< \brief Offset: 0x0920 (R/W) Data Lockdown 4 by Way */
722 __IOM uint32_t INST_LOCK_4_WAY; /*!< \brief Offset: 0x0924 (R/W) Instruction Lockdown 4 by Way */
723 __IOM uint32_t DATA_LOCK_5_WAY; /*!< \brief Offset: 0x0928 (R/W) Data Lockdown 5 by Way */
724 __IOM uint32_t INST_LOCK_5_WAY; /*!< \brief Offset: 0x092c (R/W) Instruction Lockdown 5 by Way */
725 __IOM uint32_t DATA_LOCK_6_WAY; /*!< \brief Offset: 0x0930 (R/W) Data Lockdown 5 by Way */
726 __IOM uint32_t INST_LOCK_6_WAY; /*!< \brief Offset: 0x0934 (R/W) Instruction Lockdown 5 by Way */
727 __IOM uint32_t DATA_LOCK_7_WAY; /*!< \brief Offset: 0x0938 (R/W) Data Lockdown 6 by Way */
728 __IOM uint32_t INST_LOCK_7_WAY; /*!< \brief Offset: 0x093c (R/W) Instruction Lockdown 6 by Way */
729 RESERVED(11[0x4], uint32_t)
730 __IOM uint32_t LOCK_LINE_EN; /*!< \brief Offset: 0x0950 (R/W) Lockdown by Line Enable */
731 __IOM uint32_t UNLOCK_ALL_BY_WAY; /*!< \brief Offset: 0x0954 (R/W) Unlock All Lines by Way */
732 RESERVED(12[0xaa], uint32_t)
733 __IOM uint32_t ADDRESS_FILTER_START; /*!< \brief Offset: 0x0c00 (R/W) Address Filtering Start */
734 __IOM uint32_t ADDRESS_FILTER_END; /*!< \brief Offset: 0x0c04 (R/W) Address Filtering End */
735 RESERVED(13[0xce], uint32_t)
736 __IOM uint32_t DEBUG_CONTROL; /*!< \brief Offset: 0x0f40 (R/W) Debug Control Register */
739 #define L2C_310 ((L2C_310_TypeDef *)L2C_310_BASE) /*!< \brief L2C_310 register set access pointer */
742 #if (__GIC_PRESENT == 1U) || defined(DOXYGEN)
744 /** \brief Structure type to access the Generic Interrupt Controller Distributor (GICD)
748 __IOM uint32_t CTLR; /*!< \brief Offset: 0x000 (R/W) Distributor Control Register */
749 __IM uint32_t TYPER; /*!< \brief Offset: 0x004 (R/ ) Interrupt Controller Type Register */
750 __IM uint32_t IIDR; /*!< \brief Offset: 0x008 (R/ ) Distributor Implementer Identification Register */
751 RESERVED(0, uint32_t)
752 __IOM uint32_t STATUSR; /*!< \brief Offset: 0x010 (R/W) Error Reporting Status Register, optional */
753 RESERVED(1[11], uint32_t)
754 __OM uint32_t SETSPI_NSR; /*!< \brief Offset: 0x040 ( /W) Set SPI Register */
755 RESERVED(2, uint32_t)
756 __OM uint32_t CLRSPI_NSR; /*!< \brief Offset: 0x048 ( /W) Clear SPI Register */
757 RESERVED(3, uint32_t)
758 __OM uint32_t SETSPI_SR; /*!< \brief Offset: 0x050 ( /W) Set SPI, Secure Register */
759 RESERVED(4, uint32_t)
760 __OM uint32_t CLRSPI_SR; /*!< \brief Offset: 0x058 ( /W) Clear SPI, Secure Register */
761 RESERVED(5[9], uint32_t)
762 __IOM uint32_t IGROUPR[32]; /*!< \brief Offset: 0x080 (R/W) Interrupt Group Registers */
763 __IOM uint32_t ISENABLER[32]; /*!< \brief Offset: 0x100 (R/W) Interrupt Set-Enable Registers */
764 __IOM uint32_t ICENABLER[32]; /*!< \brief Offset: 0x180 (R/W) Interrupt Clear-Enable Registers */
765 __IOM uint32_t ISPENDR[32]; /*!< \brief Offset: 0x200 (R/W) Interrupt Set-Pending Registers */
766 __IOM uint32_t ICPENDR[32]; /*!< \brief Offset: 0x280 (R/W) Interrupt Clear-Pending Registers */
767 __IOM uint32_t ISACTIVER[32]; /*!< \brief Offset: 0x300 (R/W) Interrupt Set-Active Registers */
768 __IOM uint32_t ICACTIVER[32]; /*!< \brief Offset: 0x380 (R/W) Interrupt Clear-Active Registers */
769 __IOM uint32_t IPRIORITYR[255]; /*!< \brief Offset: 0x400 (R/W) Interrupt Priority Registers */
770 RESERVED(6, uint32_t)
771 __IOM uint32_t ITARGETSR[255]; /*!< \brief Offset: 0x800 (R/W) Interrupt Targets Registers */
772 RESERVED(7, uint32_t)
773 __IOM uint32_t ICFGR[64]; /*!< \brief Offset: 0xC00 (R/W) Interrupt Configuration Registers */
774 __IOM uint32_t IGRPMODR[32]; /*!< \brief Offset: 0xD00 (R/W) Interrupt Group Modifier Registers */
775 RESERVED(8[32], uint32_t)
776 __IOM uint32_t NSACR[64]; /*!< \brief Offset: 0xE00 (R/W) Non-secure Access Control Registers */
777 __OM uint32_t SGIR; /*!< \brief Offset: 0xF00 ( /W) Software Generated Interrupt Register */
778 RESERVED(9[3], uint32_t)
779 __IOM uint32_t CPENDSGIR[4]; /*!< \brief Offset: 0xF10 (R/W) SGI Clear-Pending Registers */
780 __IOM uint32_t SPENDSGIR[4]; /*!< \brief Offset: 0xF20 (R/W) SGI Set-Pending Registers */
781 RESERVED(10[5236], uint32_t)
782 __IOM uint64_t IROUTER[988]; /*!< \brief Offset: 0x6100(R/W) Interrupt Routing Registers */
783 } GICDistributor_Type;
785 #define GICDistributor ((GICDistributor_Type *) GIC_DISTRIBUTOR_BASE ) /*!< \brief GIC Distributor register set access pointer */
787 /** \brief Structure type to access the Generic Interrupt Controller Interface (GICC)
791 __IOM uint32_t CTLR; /*!< \brief Offset: 0x000 (R/W) CPU Interface Control Register */
792 __IOM uint32_t PMR; /*!< \brief Offset: 0x004 (R/W) Interrupt Priority Mask Register */
793 __IOM uint32_t BPR; /*!< \brief Offset: 0x008 (R/W) Binary Point Register */
794 __IM uint32_t IAR; /*!< \brief Offset: 0x00C (R/ ) Interrupt Acknowledge Register */
795 __OM uint32_t EOIR; /*!< \brief Offset: 0x010 ( /W) End Of Interrupt Register */
796 __IM uint32_t RPR; /*!< \brief Offset: 0x014 (R/ ) Running Priority Register */
797 __IM uint32_t HPPIR; /*!< \brief Offset: 0x018 (R/ ) Highest Priority Pending Interrupt Register */
798 __IOM uint32_t ABPR; /*!< \brief Offset: 0x01C (R/W) Aliased Binary Point Register */
799 __IM uint32_t AIAR; /*!< \brief Offset: 0x020 (R/ ) Aliased Interrupt Acknowledge Register */
800 __OM uint32_t AEOIR; /*!< \brief Offset: 0x024 ( /W) Aliased End Of Interrupt Register */
801 __IM uint32_t AHPPIR; /*!< \brief Offset: 0x028 (R/ ) Aliased Highest Priority Pending Interrupt Register */
802 __IOM uint32_t STATUSR; /*!< \brief Offset: 0x02C (R/W) Error Reporting Status Register, optional */
803 RESERVED(1[40], uint32_t)
804 __IOM uint32_t APR[4]; /*!< \brief Offset: 0x0D0 (R/W) Active Priority Register */
805 __IOM uint32_t NSAPR[4]; /*!< \brief Offset: 0x0E0 (R/W) Non-secure Active Priority Register */
806 RESERVED(2[3], uint32_t)
807 __IM uint32_t IIDR; /*!< \brief Offset: 0x0FC (R/ ) CPU Interface Identification Register */
808 RESERVED(3[960], uint32_t)
809 __OM uint32_t DIR; /*!< \brief Offset: 0x1000( /W) Deactivate Interrupt Register */
812 #define GICInterface ((GICInterface_Type *) GIC_INTERFACE_BASE ) /*!< \brief GIC Interface register set access pointer */
815 #if (__TIM_PRESENT == 1U) || defined(DOXYGEN)
816 #if ((__CORTEX_A == 5U) || (__CORTEX_A == 9U)) || defined(DOXYGEN)
817 /** \brief Structure type to access the Private Timer
821 __IOM uint32_t LOAD; //!< \brief Offset: 0x000 (R/W) Private Timer Load Register
822 __IOM uint32_t COUNTER; //!< \brief Offset: 0x004 (R/W) Private Timer Counter Register
823 __IOM uint32_t CONTROL; //!< \brief Offset: 0x008 (R/W) Private Timer Control Register
824 __IOM uint32_t ISR; //!< \brief Offset: 0x00C (R/W) Private Timer Interrupt Status Register
825 RESERVED(0[4], uint32_t)
826 __IOM uint32_t WLOAD; //!< \brief Offset: 0x020 (R/W) Watchdog Load Register
827 __IOM uint32_t WCOUNTER; //!< \brief Offset: 0x024 (R/W) Watchdog Counter Register
828 __IOM uint32_t WCONTROL; //!< \brief Offset: 0x028 (R/W) Watchdog Control Register
829 __IOM uint32_t WISR; //!< \brief Offset: 0x02C (R/W) Watchdog Interrupt Status Register
830 __IOM uint32_t WRESET; //!< \brief Offset: 0x030 (R/W) Watchdog Reset Status Register
831 __OM uint32_t WDISABLE; //!< \brief Offset: 0x034 ( /W) Watchdog Disable Register
833 #define PTIM ((Timer_Type *) TIMER_BASE ) /*!< \brief Timer register struct */
837 /*******************************************************************************
838 * Hardware Abstraction Layer
839 Core Function Interface contains:
841 - L2C-310 Cache Controller Functions
842 - PL1 Timer Functions
845 ******************************************************************************/
847 /* ########################## L1 Cache functions ################################# */
849 /** \brief Enable Caches by setting I and C bits in SCTLR register.
851 __STATIC_INLINE void L1C_EnableCaches(void) {
852 __set_SCTLR( __get_SCTLR() | (1U << SCTLR_I_Pos) | (1U << SCTLR_C_Pos));
856 /** \brief Disable Caches by clearing I and C bits in SCTLR register.
858 __STATIC_INLINE void L1C_DisableCaches(void) {
859 __set_SCTLR( __get_SCTLR() & ~(1U << SCTLR_I_Pos) & ~(1U << SCTLR_C_Pos));
863 /** \brief Enable Branch Prediction by setting Z bit in SCTLR register.
865 __STATIC_INLINE void L1C_EnableBTAC(void) {
866 __set_SCTLR( __get_SCTLR() | (1U << SCTLR_Z_Pos));
870 /** \brief Disable Branch Prediction by clearing Z bit in SCTLR register.
872 __STATIC_INLINE void L1C_DisableBTAC(void) {
873 __set_SCTLR( __get_SCTLR() & ~(1U << SCTLR_Z_Pos));
877 /** \brief Invalidate entire branch predictor array
879 __STATIC_INLINE void L1C_InvalidateBTAC(void) {
881 __DSB(); //ensure completion of the invalidation
882 __ISB(); //ensure instruction fetch path sees new state
885 /** \brief Invalidate the whole instruction cache
887 __STATIC_INLINE void L1C_InvalidateICacheAll(void) {
889 __DSB(); //ensure completion of the invalidation
890 __ISB(); //ensure instruction fetch path sees new I cache state
893 /** \brief Clean data cache line by address.
894 * \param [in] va Pointer to data to clear the cache for.
896 __STATIC_INLINE void L1C_CleanDCacheMVA(void *va) {
897 __set_DCCMVAC((uint32_t)va);
898 __DMB(); //ensure the ordering of data cache maintenance operations and their effects
901 /** \brief Invalidate data cache line by address.
902 * \param [in] va Pointer to data to invalidate the cache for.
904 __STATIC_INLINE void L1C_InvalidateDCacheMVA(void *va) {
905 __set_DCIMVAC((uint32_t)va);
906 __DMB(); //ensure the ordering of data cache maintenance operations and their effects
909 /** \brief Clean and Invalidate data cache by address.
910 * \param [in] va Pointer to data to invalidate the cache for.
912 __STATIC_INLINE void L1C_CleanInvalidateDCacheMVA(void *va) {
913 __set_DCCIMVAC((uint32_t)va);
914 __DMB(); //ensure the ordering of data cache maintenance operations and their effects
917 /** \brief Clean and Invalidate the entire data or unified cache
918 * \param [in] op 0 - invalidate, 1 - clean, otherwise - invalidate and clean
919 * \see __L1C_CleanInvalidateCache
921 __STATIC_INLINE void L1C_CleanInvalidateCache(uint32_t op) {
922 __L1C_CleanInvalidateCache(op);
925 /** \brief Invalidate the whole data cache.
927 __STATIC_INLINE void L1C_InvalidateDCacheAll(void) {
928 L1C_CleanInvalidateCache(0);
931 /** \brief Clean the whole data cache.
933 __STATIC_INLINE void L1C_CleanDCacheAll(void) {
934 L1C_CleanInvalidateCache(1);
937 /** \brief Clean and invalidate the whole data cache.
939 __STATIC_INLINE void L1C_CleanInvalidateDCacheAll(void) {
940 L1C_CleanInvalidateCache(2);
944 /* ########################## L2 Cache functions ################################# */
945 #if (__L2C_PRESENT == 1U) || defined(DOXYGEN)
946 /** \brief Cache Sync operation by writing CACHE_SYNC register.
948 __STATIC_INLINE void L2C_Sync(void)
950 L2C_310->CACHE_SYNC = 0x0;
953 /** \brief Read cache controller cache ID from CACHE_ID register.
954 * \return L2C_310_TypeDef::CACHE_ID
956 __STATIC_INLINE int L2C_GetID (void)
958 return L2C_310->CACHE_ID;
961 /** \brief Read cache controller cache type from CACHE_TYPE register.
962 * \return L2C_310_TypeDef::CACHE_TYPE
964 __STATIC_INLINE int L2C_GetType (void)
966 return L2C_310->CACHE_TYPE;
969 /** \brief Invalidate all cache by way
971 __STATIC_INLINE void L2C_InvAllByWay (void)
975 if (L2C_310->AUX_CNT & (1U << 16U)) {
981 L2C_310->INV_WAY = (1U << assoc) - 1U;
982 while(L2C_310->INV_WAY & ((1U << assoc) - 1U)); //poll invalidate
987 /** \brief Clean and Invalidate all cache by way
989 __STATIC_INLINE void L2C_CleanInvAllByWay (void)
993 if (L2C_310->AUX_CNT & (1U << 16U)) {
999 L2C_310->CLEAN_INV_WAY = (1U << assoc) - 1U;
1000 while(L2C_310->CLEAN_INV_WAY & ((1U << assoc) - 1U)); //poll invalidate
1005 /** \brief Enable Level 2 Cache
1007 __STATIC_INLINE void L2C_Enable(void)
1009 L2C_310->CONTROL = 0;
1010 L2C_310->INTERRUPT_CLEAR = 0x000001FFuL;
1011 L2C_310->DEBUG_CONTROL = 0;
1012 L2C_310->DATA_LOCK_0_WAY = 0;
1013 L2C_310->CACHE_SYNC = 0;
1014 L2C_310->CONTROL = 0x01;
1018 /** \brief Disable Level 2 Cache
1020 __STATIC_INLINE void L2C_Disable(void)
1022 L2C_310->CONTROL = 0x00;
1026 /** \brief Invalidate cache by physical address
1027 * \param [in] pa Pointer to data to invalidate cache for.
1029 __STATIC_INLINE void L2C_InvPa (void *pa)
1031 L2C_310->INV_LINE_PA = (unsigned int)pa;
1035 /** \brief Clean cache by physical address
1036 * \param [in] pa Pointer to data to invalidate cache for.
1038 __STATIC_INLINE void L2C_CleanPa (void *pa)
1040 L2C_310->CLEAN_LINE_PA = (unsigned int)pa;
1044 /** \brief Clean and invalidate cache by physical address
1045 * \param [in] pa Pointer to data to invalidate cache for.
1047 __STATIC_INLINE void L2C_CleanInvPa (void *pa)
1049 L2C_310->CLEAN_INV_LINE_PA = (unsigned int)pa;
1054 /* ########################## GIC functions ###################################### */
1055 #if (__GIC_PRESENT == 1U) || defined(DOXYGEN)
1057 /** \brief Enable the interrupt distributor using the GIC's CTLR register.
1059 __STATIC_INLINE void GIC_EnableDistributor(void)
1061 GICDistributor->CTLR |= 1U;
1064 /** \brief Disable the interrupt distributor using the GIC's CTLR register.
1066 __STATIC_INLINE void GIC_DisableDistributor(void)
1068 GICDistributor->CTLR &=~1U;
1071 /** \brief Read the GIC's TYPER register.
1072 * \return GICDistributor_Type::TYPER
1074 __STATIC_INLINE uint32_t GIC_DistributorInfo(void)
1076 return (GICDistributor->TYPER);
1079 /** \brief Reads the GIC's IIDR register.
1080 * \return GICDistributor_Type::IIDR
1082 __STATIC_INLINE uint32_t GIC_DistributorImplementer(void)
1084 return (GICDistributor->IIDR);
1087 /** \brief Sets the GIC's ITARGETSR register for the given interrupt.
1088 * \param [in] IRQn Interrupt to be configured.
1089 * \param [in] cpu_target CPU interfaces to assign this interrupt to.
1091 __STATIC_INLINE void GIC_SetTarget(IRQn_Type IRQn, uint32_t cpu_target)
1093 uint32_t mask = GICDistributor->ITARGETSR[IRQn / 4U] & ~(0xFFUL << ((IRQn % 4U) * 8U));
1094 GICDistributor->ITARGETSR[IRQn / 4U] = mask | ((cpu_target & 0xFFUL) << ((IRQn % 4U) * 8U));
1097 /** \brief Read the GIC's ITARGETSR register.
1098 * \param [in] IRQn Interrupt to acquire the configuration for.
1099 * \return GICDistributor_Type::ITARGETSR
1101 __STATIC_INLINE uint32_t GIC_GetTarget(IRQn_Type IRQn)
1103 return (GICDistributor->ITARGETSR[IRQn / 4U] >> ((IRQn % 4U) * 8U)) & 0xFFUL;
1106 /** \brief Enable the CPU's interrupt interface.
1108 __STATIC_INLINE void GIC_EnableInterface(void)
1110 GICInterface->CTLR |= 1U; //enable interface
1113 /** \brief Disable the CPU's interrupt interface.
1115 __STATIC_INLINE void GIC_DisableInterface(void)
1117 GICInterface->CTLR &=~1U; //disable distributor
1120 /** \brief Read the CPU's IAR register.
1121 * \return GICInterface_Type::IAR
1123 __STATIC_INLINE IRQn_Type GIC_AcknowledgePending(void)
1125 return (IRQn_Type)(GICInterface->IAR);
1128 /** \brief Writes the given interrupt number to the CPU's EOIR register.
1129 * \param [in] IRQn The interrupt to be signaled as finished.
1131 __STATIC_INLINE void GIC_EndInterrupt(IRQn_Type IRQn)
1133 GICInterface->EOIR = IRQn;
1136 /** \brief Enables the given interrupt using GIC's ISENABLER register.
1137 * \param [in] IRQn The interrupt to be enabled.
1139 __STATIC_INLINE void GIC_EnableIRQ(IRQn_Type IRQn)
1141 GICDistributor->ISENABLER[IRQn / 32U] = 1U << (IRQn % 32U);
1144 /** \brief Get interrupt enable status using GIC's ISENABLER register.
1145 * \param [in] IRQn The interrupt to be queried.
1146 * \return 0 - interrupt is not enabled, 1 - interrupt is enabled.
1148 __STATIC_INLINE uint32_t GIC_GetEnableIRQ(IRQn_Type IRQn)
1150 return (GICDistributor->ISENABLER[IRQn / 32U] >> (IRQn % 32U)) & 1UL;
1153 /** \brief Disables the given interrupt using GIC's ICENABLER register.
1154 * \param [in] IRQn The interrupt to be disabled.
1156 __STATIC_INLINE void GIC_DisableIRQ(IRQn_Type IRQn)
1158 GICDistributor->ICENABLER[IRQn / 32U] = 1U << (IRQn % 32U);
1161 /** \brief Get interrupt pending status from GIC's ISPENDR register.
1162 * \param [in] IRQn The interrupt to be queried.
1163 * \return 0 - interrupt is not pending, 1 - interrupt is pendig.
1165 __STATIC_INLINE uint32_t GIC_GetPendingIRQ(IRQn_Type IRQn)
1170 pend = (GICDistributor->ISPENDR[IRQn / 32U] >> (IRQn % 32U)) & 1UL;
1172 // INTID 0-15 Software Generated Interrupt
1173 pend = (GICDistributor->SPENDSGIR[IRQn / 4U] >> ((IRQn % 4U) * 8U)) & 0xFFUL;
1174 // No CPU identification offered
1185 /** \brief Sets the given interrupt as pending using GIC's ISPENDR register.
1186 * \param [in] IRQn The interrupt to be enabled.
1188 __STATIC_INLINE void GIC_SetPendingIRQ(IRQn_Type IRQn)
1191 GICDistributor->ISPENDR[IRQn / 32U] = 1U << (IRQn % 32U);
1193 // INTID 0-15 Software Generated Interrupt
1194 GICDistributor->SPENDSGIR[IRQn / 4U] = 1U << ((IRQn % 4U) * 8U);
1195 // Forward the interrupt to the CPU interface that requested it
1196 GICDistributor->SGIR = (IRQn | 0x02000000U);
1200 /** \brief Clears the given interrupt from being pending using GIC's ICPENDR register.
1201 * \param [in] IRQn The interrupt to be enabled.
1203 __STATIC_INLINE void GIC_ClearPendingIRQ(IRQn_Type IRQn)
1206 GICDistributor->ICPENDR[IRQn / 32U] = 1U << (IRQn % 32U);
1208 // INTID 0-15 Software Generated Interrupt
1209 GICDistributor->CPENDSGIR[IRQn / 4U] = 1U << ((IRQn % 4U) * 8U);
1213 /** \brief Sets the interrupt configuration using GIC's ICFGR register.
1214 * \param [in] IRQn The interrupt to be configured.
1215 * \param [in] int_config Int_config field value. Bit 0: Reserved (0 - N-N model, 1 - 1-N model for some GIC before v1)
1216 * Bit 1: 0 - level sensitive, 1 - edge triggered
1218 __STATIC_INLINE void GIC_SetConfiguration(IRQn_Type IRQn, uint32_t int_config)
1220 uint32_t icfgr = GICDistributor->ICFGR[IRQn / 16U];
1221 uint32_t shift = (IRQn % 16U) << 1U;
1223 icfgr &= (~(3U << shift));
1224 icfgr |= ( int_config << shift);
1226 GICDistributor->ICFGR[IRQn / 16U] = icfgr;
1229 /** \brief Get the interrupt configuration from the GIC's ICFGR register.
1230 * \param [in] IRQn Interrupt to acquire the configuration for.
1231 * \return Int_config field value. Bit 0: Reserved (0 - N-N model, 1 - 1-N model for some GIC before v1)
1232 * Bit 1: 0 - level sensitive, 1 - edge triggered
1234 __STATIC_INLINE uint32_t GIC_GetConfiguration(IRQn_Type IRQn)
1236 return (GICDistributor->ICFGR[IRQn / 16U] >> ((IRQn % 16U) >> 1U));
1239 /** \brief Set the priority for the given interrupt in the GIC's IPRIORITYR register.
1240 * \param [in] IRQn The interrupt to be configured.
1241 * \param [in] priority The priority for the interrupt, lower values denote higher priorities.
1243 __STATIC_INLINE void GIC_SetPriority(IRQn_Type IRQn, uint32_t priority)
1245 uint32_t mask = GICDistributor->IPRIORITYR[IRQn / 4U] & ~(0xFFUL << ((IRQn % 4U) * 8U));
1246 GICDistributor->IPRIORITYR[IRQn / 4U] = mask | ((priority & 0xFFUL) << ((IRQn % 4U) * 8U));
1249 /** \brief Read the current interrupt priority from GIC's IPRIORITYR register.
1250 * \param [in] IRQn The interrupt to be queried.
1252 __STATIC_INLINE uint32_t GIC_GetPriority(IRQn_Type IRQn)
1254 return (GICDistributor->IPRIORITYR[IRQn / 4U] >> ((IRQn % 4U) * 8U)) & 0xFFUL;
1257 /** \brief Set the interrupt priority mask using CPU's PMR register.
1258 * \param [in] priority Priority mask to be set.
1260 __STATIC_INLINE void GIC_SetInterfacePriorityMask(uint32_t priority)
1262 GICInterface->PMR = priority & 0xFFUL; //set priority mask
1265 /** \brief Read the current interrupt priority mask from CPU's PMR register.
1266 * \result GICInterface_Type::PMR
1268 __STATIC_INLINE uint32_t GIC_GetInterfacePriorityMask(void)
1270 return GICInterface->PMR;
1273 /** \brief Configures the group priority and subpriority split point using CPU's BPR register.
1274 * \param [in] binary_point Amount of bits used as subpriority.
1276 __STATIC_INLINE void GIC_SetBinaryPoint(uint32_t binary_point)
1278 GICInterface->BPR = binary_point & 7U; //set binary point
1281 /** \brief Read the current group priority and subpriority split point from CPU's BPR register.
1282 * \return GICInterface_Type::BPR
1284 __STATIC_INLINE uint32_t GIC_GetBinaryPoint(void)
1286 return GICInterface->BPR;
1289 /** \brief Get the status for a given interrupt.
1290 * \param [in] IRQn The interrupt to get status for.
1291 * \return 0 - not pending/active, 1 - pending, 2 - active, 3 - pending and active
1293 __STATIC_INLINE uint32_t GIC_GetIRQStatus(IRQn_Type IRQn)
1295 uint32_t pending, active;
1297 active = ((GICDistributor->ISACTIVER[IRQn / 32U]) >> (IRQn % 32U)) & 1UL;
1298 pending = ((GICDistributor->ISPENDR[IRQn / 32U]) >> (IRQn % 32U)) & 1UL;
1300 return ((active<<1U) | pending);
1303 /** \brief Generate a software interrupt using GIC's SGIR register.
1304 * \param [in] IRQn Software interrupt to be generated.
1305 * \param [in] target_list List of CPUs the software interrupt should be forwarded to.
1306 * \param [in] filter_list Filter to be applied to determine interrupt receivers.
1308 __STATIC_INLINE void GIC_SendSGI(IRQn_Type IRQn, uint32_t target_list, uint32_t filter_list)
1310 GICDistributor->SGIR = ((filter_list & 3U) << 24U) | ((target_list & 0xFFUL) << 16U) | (IRQn & 0x0FUL);
1313 /** \brief Get the interrupt number of the highest interrupt pending from CPU's HPPIR register.
1314 * \return GICInterface_Type::HPPIR
1316 __STATIC_INLINE uint32_t GIC_GetHighPendingIRQ(void)
1318 return GICInterface->HPPIR;
1321 /** \brief Provides information about the implementer and revision of the CPU interface.
1322 * \return GICInterface_Type::IIDR
1324 __STATIC_INLINE uint32_t GIC_GetInterfaceId(void)
1326 return GICInterface->IIDR;
1329 /** \brief Set the interrupt group from the GIC's IGROUPR register.
1330 * \param [in] IRQn The interrupt to be queried.
1331 * \param [in] group Interrupt group number: 0 - Group 0, 1 - Group 1
1333 __STATIC_INLINE void GIC_SetGroup(IRQn_Type IRQn, uint32_t group)
1335 uint32_t igroupr = GICDistributor->IGROUPR[IRQn / 32U];
1336 uint32_t shift = (IRQn % 32U);
1338 igroupr &= (~(1U << shift));
1339 igroupr |= ( (group & 1U) << shift);
1341 GICDistributor->IGROUPR[IRQn / 32U] = igroupr;
1343 #define GIC_SetSecurity GIC_SetGroup
1345 /** \brief Get the interrupt group from the GIC's IGROUPR register.
1346 * \param [in] IRQn The interrupt to be queried.
1347 * \return 0 - Group 0, 1 - Group 1
1349 __STATIC_INLINE uint32_t GIC_GetGroup(IRQn_Type IRQn)
1351 return (GICDistributor->IGROUPR[IRQn / 32U] >> (IRQn % 32U)) & 1UL;
1353 #define GIC_GetSecurity GIC_GetGroup
1355 /** \brief Initialize the interrupt distributor.
1357 __STATIC_INLINE void GIC_DistInit(void)
1360 uint32_t num_irq = 0U;
1361 uint32_t priority_field;
1363 //A reset sets all bits in the IGROUPRs corresponding to the SPIs to 0,
1364 //configuring all of the interrupts as Secure.
1366 //Disable interrupt forwarding
1367 GIC_DisableDistributor();
1368 //Get the maximum number of interrupts that the GIC supports
1369 num_irq = 32U * ((GIC_DistributorInfo() & 0x1FU) + 1U);
1371 /* Priority level is implementation defined.
1372 To determine the number of priority bits implemented write 0xFF to an IPRIORITYR
1373 priority field and read back the value stored.*/
1374 GIC_SetPriority((IRQn_Type)0U, 0xFFU);
1375 priority_field = GIC_GetPriority((IRQn_Type)0U);
1377 for (i = 32U; i < num_irq; i++)
1379 //Disable the SPI interrupt
1380 GIC_DisableIRQ((IRQn_Type)i);
1381 //Set level-sensitive (and N-N model)
1382 GIC_SetConfiguration((IRQn_Type)i, 0U);
1384 GIC_SetPriority((IRQn_Type)i, priority_field/2U);
1385 //Set target list to CPU0
1386 GIC_SetTarget((IRQn_Type)i, 1U);
1388 //Enable distributor
1389 GIC_EnableDistributor();
1392 /** \brief Initialize the CPU's interrupt interface
1394 __STATIC_INLINE void GIC_CPUInterfaceInit(void)
1397 uint32_t priority_field;
1399 //A reset sets all bits in the IGROUPRs corresponding to the SPIs to 0,
1400 //configuring all of the interrupts as Secure.
1402 //Disable interrupt forwarding
1403 GIC_DisableInterface();
1405 /* Priority level is implementation defined.
1406 To determine the number of priority bits implemented write 0xFF to an IPRIORITYR
1407 priority field and read back the value stored.*/
1408 GIC_SetPriority((IRQn_Type)0U, 0xFFU);
1409 priority_field = GIC_GetPriority((IRQn_Type)0U);
1412 for (i = 0U; i < 32U; i++)
1415 //Set level-sensitive (and N-N model) for PPI
1416 GIC_SetConfiguration((IRQn_Type)i, 0U);
1418 //Disable SGI and PPI interrupts
1419 GIC_DisableIRQ((IRQn_Type)i);
1421 GIC_SetPriority((IRQn_Type)i, priority_field/2U);
1424 GIC_EnableInterface();
1425 //Set binary point to 0
1426 GIC_SetBinaryPoint(0U);
1428 GIC_SetInterfacePriorityMask(0xFFU);
1431 /** \brief Initialize and enable the GIC
1433 __STATIC_INLINE void GIC_Enable(void)
1436 GIC_CPUInterfaceInit(); //per CPU
1440 /* ########################## Generic Timer functions ############################ */
1441 #if (__TIM_PRESENT == 1U) || defined(DOXYGEN)
1443 /* PL1 Physical Timer */
1444 #if (__CORTEX_A == 7U) || defined(DOXYGEN)
1446 /** \brief Physical Timer Control register */
1451 uint32_t ENABLE:1; /*!< \brief bit: 0 Enables the timer. */
1452 uint32_t IMASK:1; /*!< \brief bit: 1 Timer output signal mask bit. */
1453 uint32_t ISTATUS:1; /*!< \brief bit: 2 The status of the timer. */
1454 RESERVED(0:29, uint32_t)
1455 } b; /*!< \brief Structure used for bit access */
1456 uint32_t w; /*!< \brief Type used for word access */
1459 /** \brief Configures the frequency the timer shall run at.
1460 * \param [in] value The timer frequency in Hz.
1462 __STATIC_INLINE void PL1_SetCounterFrequency(uint32_t value)
1464 __set_CNTFRQ(value);
1468 /** \brief Sets the reset value of the timer.
1469 * \param [in] value The value the timer is loaded with.
1471 __STATIC_INLINE void PL1_SetLoadValue(uint32_t value)
1473 __set_CNTP_TVAL(value);
1477 /** \brief Get the current counter value.
1478 * \return Current counter value.
1480 __STATIC_INLINE uint32_t PL1_GetCurrentValue(void)
1482 return(__get_CNTP_TVAL());
1485 /** \brief Get the current physical counter value.
1486 * \return Current physical counter value.
1488 __STATIC_INLINE uint64_t PL1_GetCurrentPhysicalValue(void)
1490 return(__get_CNTPCT());
1493 /** \brief Set the physical compare value.
1494 * \param [in] value New physical timer compare value.
1496 __STATIC_INLINE void PL1_SetPhysicalCompareValue(uint64_t value)
1498 __set_CNTP_CVAL(value);
1502 /** \brief Get the physical compare value.
1503 * \return Physical compare value.
1505 __STATIC_INLINE uint64_t PL1_GetPhysicalCompareValue(void)
1507 return(__get_CNTP_CVAL());
1510 /** \brief Configure the timer by setting the control value.
1511 * \param [in] value New timer control value.
1513 __STATIC_INLINE void PL1_SetControl(uint32_t value)
1515 __set_CNTP_CTL(value);
1519 /** \brief Get the control value.
1520 * \return Control value.
1522 __STATIC_INLINE uint32_t PL1_GetControl(void)
1524 return(__get_CNTP_CTL());
1529 #if ((__CORTEX_A == 5U) || (__CORTEX_A == 9U)) || defined(DOXYGEN)
1530 /** \brief Set the load value to timers LOAD register.
1531 * \param [in] value The load value to be set.
1533 __STATIC_INLINE void PTIM_SetLoadValue(uint32_t value)
1538 /** \brief Get the load value from timers LOAD register.
1539 * \return Timer_Type::LOAD
1541 __STATIC_INLINE uint32_t PTIM_GetLoadValue(void)
1546 /** \brief Set current counter value from its COUNTER register.
1548 __STATIC_INLINE void PTIM_SetCurrentValue(uint32_t value)
1550 PTIM->COUNTER = value;
1553 /** \brief Get current counter value from timers COUNTER register.
1554 * \result Timer_Type::COUNTER
1556 __STATIC_INLINE uint32_t PTIM_GetCurrentValue(void)
1558 return(PTIM->COUNTER);
1561 /** \brief Configure the timer using its CONTROL register.
1562 * \param [in] value The new configuration value to be set.
1564 __STATIC_INLINE void PTIM_SetControl(uint32_t value)
1566 PTIM->CONTROL = value;
1569 /** ref Timer_Type::CONTROL Get the current timer configuration from its CONTROL register.
1570 * \return Timer_Type::CONTROL
1572 __STATIC_INLINE uint32_t PTIM_GetControl(void)
1574 return(PTIM->CONTROL);
1577 /** ref Timer_Type::CONTROL Get the event flag in timers ISR register.
1578 * \return 0 - flag is not set, 1- flag is set
1580 __STATIC_INLINE uint32_t PTIM_GetEventFlag(void)
1582 return (PTIM->ISR & 1UL);
1585 /** ref Timer_Type::CONTROL Clears the event flag in timers ISR register.
1587 __STATIC_INLINE void PTIM_ClearEventFlag(void)
1594 /* ########################## MMU functions ###################################### */
1596 #define SECTION_DESCRIPTOR (0x2)
1597 #define SECTION_MASK (0xFFFFFFFC)
1599 #define SECTION_TEXCB_MASK (0xFFFF8FF3)
1600 #define SECTION_B_SHIFT (2)
1601 #define SECTION_C_SHIFT (3)
1602 #define SECTION_TEX0_SHIFT (12)
1603 #define SECTION_TEX1_SHIFT (13)
1604 #define SECTION_TEX2_SHIFT (14)
1606 #define SECTION_XN_MASK (0xFFFFFFEF)
1607 #define SECTION_XN_SHIFT (4)
1609 #define SECTION_DOMAIN_MASK (0xFFFFFE1F)
1610 #define SECTION_DOMAIN_SHIFT (5)
1612 #define SECTION_P_MASK (0xFFFFFDFF)
1613 #define SECTION_P_SHIFT (9)
1615 #define SECTION_AP_MASK (0xFFFF73FF)
1616 #define SECTION_AP_SHIFT (10)
1617 #define SECTION_AP2_SHIFT (15)
1619 #define SECTION_S_MASK (0xFFFEFFFF)
1620 #define SECTION_S_SHIFT (16)
1622 #define SECTION_NG_MASK (0xFFFDFFFF)
1623 #define SECTION_NG_SHIFT (17)
1625 #define SECTION_NS_MASK (0xFFF7FFFF)
1626 #define SECTION_NS_SHIFT (19)
1628 #define PAGE_L1_DESCRIPTOR (0x1)
1629 #define PAGE_L1_MASK (0xFFFFFFFC)
1631 #define PAGE_L2_4K_DESC (0x2)
1632 #define PAGE_L2_4K_MASK (0xFFFFFFFD)
1634 #define PAGE_L2_64K_DESC (0x1)
1635 #define PAGE_L2_64K_MASK (0xFFFFFFFC)
1637 #define PAGE_4K_TEXCB_MASK (0xFFFFFE33)
1638 #define PAGE_4K_B_SHIFT (2)
1639 #define PAGE_4K_C_SHIFT (3)
1640 #define PAGE_4K_TEX0_SHIFT (6)
1641 #define PAGE_4K_TEX1_SHIFT (7)
1642 #define PAGE_4K_TEX2_SHIFT (8)
1644 #define PAGE_64K_TEXCB_MASK (0xFFFF8FF3)
1645 #define PAGE_64K_B_SHIFT (2)
1646 #define PAGE_64K_C_SHIFT (3)
1647 #define PAGE_64K_TEX0_SHIFT (12)
1648 #define PAGE_64K_TEX1_SHIFT (13)
1649 #define PAGE_64K_TEX2_SHIFT (14)
1651 #define PAGE_TEXCB_MASK (0xFFFF8FF3)
1652 #define PAGE_B_SHIFT (2)
1653 #define PAGE_C_SHIFT (3)
1654 #define PAGE_TEX_SHIFT (12)
1656 #define PAGE_XN_4K_MASK (0xFFFFFFFE)
1657 #define PAGE_XN_4K_SHIFT (0)
1658 #define PAGE_XN_64K_MASK (0xFFFF7FFF)
1659 #define PAGE_XN_64K_SHIFT (15)
1661 #define PAGE_DOMAIN_MASK (0xFFFFFE1F)
1662 #define PAGE_DOMAIN_SHIFT (5)
1664 #define PAGE_P_MASK (0xFFFFFDFF)
1665 #define PAGE_P_SHIFT (9)
1667 #define PAGE_AP_MASK (0xFFFFFDCF)
1668 #define PAGE_AP_SHIFT (4)
1669 #define PAGE_AP2_SHIFT (9)
1671 #define PAGE_S_MASK (0xFFFFFBFF)
1672 #define PAGE_S_SHIFT (10)
1674 #define PAGE_NG_MASK (0xFFFFF7FF)
1675 #define PAGE_NG_SHIFT (11)
1677 #define PAGE_NS_MASK (0xFFFFFFF7)
1678 #define PAGE_NS_SHIFT (3)
1680 #define OFFSET_1M (0x00100000)
1681 #define OFFSET_64K (0x00010000)
1682 #define OFFSET_4K (0x00001000)
1684 #define DESCRIPTOR_FAULT (0x00000000)
1686 /* Attributes enumerations */
1688 /* Region size attributes */
1694 } mmu_region_size_Type;
1696 /* Region type attributes */
1706 /* Region cacheability attributes */
1713 } mmu_cacheability_Type;
1715 /* Region parity check attributes */
1720 } mmu_ecc_check_Type;
1722 /* Region execution attributes */
1729 /* Region global attributes */
1736 /* Region shareability attributes */
1743 /* Region security attributes */
1750 /* Region access attributes */
1758 /* Memory Region definition */
1759 typedef struct RegionStruct {
1760 mmu_region_size_Type rg_t;
1761 mmu_memory_Type mem_t;
1763 mmu_cacheability_Type inner_norm_t;
1764 mmu_cacheability_Type outer_norm_t;
1765 mmu_ecc_check_Type e_t;
1766 mmu_execute_Type xn_t;
1767 mmu_global_Type g_t;
1768 mmu_secure_Type sec_t;
1769 mmu_access_Type priv_t;
1770 mmu_access_Type user_t;
1771 mmu_shared_Type sh_t;
1773 } mmu_region_attributes_Type;
1775 //Following macros define the descriptors and attributes
1776 //Sect_Normal. Outer & inner wb/wa, non-shareable, executable, rw, domain 0
1777 #define section_normal(descriptor_l1, region) region.rg_t = SECTION; \
1778 region.domain = 0x0; \
1779 region.e_t = ECC_DISABLED; \
1780 region.g_t = GLOBAL; \
1781 region.inner_norm_t = WB_WA; \
1782 region.outer_norm_t = WB_WA; \
1783 region.mem_t = NORMAL; \
1784 region.sec_t = SECURE; \
1785 region.xn_t = EXECUTE; \
1786 region.priv_t = RW; \
1787 region.user_t = RW; \
1788 region.sh_t = NON_SHARED; \
1789 MMU_GetSectionDescriptor(&descriptor_l1, region);
1791 //Sect_Normal_Cod. Outer & inner wb/wa, non-shareable, executable, ro, domain 0
1792 #define section_normal_cod(descriptor_l1, region) region.rg_t = SECTION; \
1793 region.domain = 0x0; \
1794 region.e_t = ECC_DISABLED; \
1795 region.g_t = GLOBAL; \
1796 region.inner_norm_t = WB_WA; \
1797 region.outer_norm_t = WB_WA; \
1798 region.mem_t = NORMAL; \
1799 region.sec_t = SECURE; \
1800 region.xn_t = EXECUTE; \
1801 region.priv_t = READ; \
1802 region.user_t = READ; \
1803 region.sh_t = NON_SHARED; \
1804 MMU_GetSectionDescriptor(&descriptor_l1, region);
1806 //Sect_Normal_RO. Sect_Normal_Cod, but not executable
1807 #define section_normal_ro(descriptor_l1, region) region.rg_t = SECTION; \
1808 region.domain = 0x0; \
1809 region.e_t = ECC_DISABLED; \
1810 region.g_t = GLOBAL; \
1811 region.inner_norm_t = WB_WA; \
1812 region.outer_norm_t = WB_WA; \
1813 region.mem_t = NORMAL; \
1814 region.sec_t = SECURE; \
1815 region.xn_t = NON_EXECUTE; \
1816 region.priv_t = READ; \
1817 region.user_t = READ; \
1818 region.sh_t = NON_SHARED; \
1819 MMU_GetSectionDescriptor(&descriptor_l1, region);
1821 //Sect_Normal_RW. Sect_Normal_Cod, but writeable and not executable
1822 #define section_normal_rw(descriptor_l1, region) region.rg_t = SECTION; \
1823 region.domain = 0x0; \
1824 region.e_t = ECC_DISABLED; \
1825 region.g_t = GLOBAL; \
1826 region.inner_norm_t = WB_WA; \
1827 region.outer_norm_t = WB_WA; \
1828 region.mem_t = NORMAL; \
1829 region.sec_t = SECURE; \
1830 region.xn_t = NON_EXECUTE; \
1831 region.priv_t = RW; \
1832 region.user_t = RW; \
1833 region.sh_t = NON_SHARED; \
1834 MMU_GetSectionDescriptor(&descriptor_l1, region);
1835 //Sect_SO. Strongly-ordered (therefore shareable), not executable, rw, domain 0, base addr 0
1836 #define section_so(descriptor_l1, region) region.rg_t = SECTION; \
1837 region.domain = 0x0; \
1838 region.e_t = ECC_DISABLED; \
1839 region.g_t = GLOBAL; \
1840 region.inner_norm_t = NON_CACHEABLE; \
1841 region.outer_norm_t = NON_CACHEABLE; \
1842 region.mem_t = STRONGLY_ORDERED; \
1843 region.sec_t = SECURE; \
1844 region.xn_t = NON_EXECUTE; \
1845 region.priv_t = RW; \
1846 region.user_t = RW; \
1847 region.sh_t = NON_SHARED; \
1848 MMU_GetSectionDescriptor(&descriptor_l1, region);
1850 //Sect_Device_RO. Device, non-shareable, non-executable, ro, domain 0, base addr 0
1851 #define section_device_ro(descriptor_l1, region) region.rg_t = SECTION; \
1852 region.domain = 0x0; \
1853 region.e_t = ECC_DISABLED; \
1854 region.g_t = GLOBAL; \
1855 region.inner_norm_t = NON_CACHEABLE; \
1856 region.outer_norm_t = NON_CACHEABLE; \
1857 region.mem_t = STRONGLY_ORDERED; \
1858 region.sec_t = SECURE; \
1859 region.xn_t = NON_EXECUTE; \
1860 region.priv_t = READ; \
1861 region.user_t = READ; \
1862 region.sh_t = NON_SHARED; \
1863 MMU_GetSectionDescriptor(&descriptor_l1, region);
1865 //Sect_Device_RW. Sect_Device_RO, but writeable
1866 #define section_device_rw(descriptor_l1, region) region.rg_t = SECTION; \
1867 region.domain = 0x0; \
1868 region.e_t = ECC_DISABLED; \
1869 region.g_t = GLOBAL; \
1870 region.inner_norm_t = NON_CACHEABLE; \
1871 region.outer_norm_t = NON_CACHEABLE; \
1872 region.mem_t = STRONGLY_ORDERED; \
1873 region.sec_t = SECURE; \
1874 region.xn_t = NON_EXECUTE; \
1875 region.priv_t = RW; \
1876 region.user_t = RW; \
1877 region.sh_t = NON_SHARED; \
1878 MMU_GetSectionDescriptor(&descriptor_l1, region);
1879 //Page_4k_Device_RW. Shared device, not executable, rw, domain 0
1880 #define page4k_device_rw(descriptor_l1, descriptor_l2, region) region.rg_t = PAGE_4k; \
1881 region.domain = 0x0; \
1882 region.e_t = ECC_DISABLED; \
1883 region.g_t = GLOBAL; \
1884 region.inner_norm_t = NON_CACHEABLE; \
1885 region.outer_norm_t = NON_CACHEABLE; \
1886 region.mem_t = SHARED_DEVICE; \
1887 region.sec_t = SECURE; \
1888 region.xn_t = NON_EXECUTE; \
1889 region.priv_t = RW; \
1890 region.user_t = RW; \
1891 region.sh_t = NON_SHARED; \
1892 MMU_GetPageDescriptor(&descriptor_l1, &descriptor_l2, region);
1894 //Page_64k_Device_RW. Shared device, not executable, rw, domain 0
1895 #define page64k_device_rw(descriptor_l1, descriptor_l2, region) region.rg_t = PAGE_64k; \
1896 region.domain = 0x0; \
1897 region.e_t = ECC_DISABLED; \
1898 region.g_t = GLOBAL; \
1899 region.inner_norm_t = NON_CACHEABLE; \
1900 region.outer_norm_t = NON_CACHEABLE; \
1901 region.mem_t = SHARED_DEVICE; \
1902 region.sec_t = SECURE; \
1903 region.xn_t = NON_EXECUTE; \
1904 region.priv_t = RW; \
1905 region.user_t = RW; \
1906 region.sh_t = NON_SHARED; \
1907 MMU_GetPageDescriptor(&descriptor_l1, &descriptor_l2, region);
1909 /** \brief Set section execution-never attribute
1911 \param [out] descriptor_l1 L1 descriptor.
1912 \param [in] xn Section execution-never attribute : EXECUTE , NON_EXECUTE.
1916 __STATIC_INLINE int MMU_XNSection(uint32_t *descriptor_l1, mmu_execute_Type xn)
1918 *descriptor_l1 &= SECTION_XN_MASK;
1919 *descriptor_l1 |= ((xn & 0x1) << SECTION_XN_SHIFT);
1923 /** \brief Set section domain
1925 \param [out] descriptor_l1 L1 descriptor.
1926 \param [in] domain Section domain
1930 __STATIC_INLINE int MMU_DomainSection(uint32_t *descriptor_l1, uint8_t domain)
1932 *descriptor_l1 &= SECTION_DOMAIN_MASK;
1933 *descriptor_l1 |= ((domain & 0xF) << SECTION_DOMAIN_SHIFT);
1937 /** \brief Set section parity check
1939 \param [out] descriptor_l1 L1 descriptor.
1940 \param [in] p_bit Parity check: ECC_DISABLED, ECC_ENABLED
1944 __STATIC_INLINE int MMU_PSection(uint32_t *descriptor_l1, mmu_ecc_check_Type p_bit)
1946 *descriptor_l1 &= SECTION_P_MASK;
1947 *descriptor_l1 |= ((p_bit & 0x1) << SECTION_P_SHIFT);
1951 /** \brief Set section access privileges
1953 \param [out] descriptor_l1 L1 descriptor.
1954 \param [in] user User Level Access: NO_ACCESS, RW, READ
1955 \param [in] priv Privilege Level Access: NO_ACCESS, RW, READ
1956 \param [in] afe Access flag enable
1960 __STATIC_INLINE int MMU_APSection(uint32_t *descriptor_l1, mmu_access_Type user, mmu_access_Type priv, uint32_t afe)
1964 if (afe == 0) { //full access
1965 if ((priv == NO_ACCESS) && (user == NO_ACCESS)) { ap = 0x0; }
1966 else if ((priv == RW) && (user == NO_ACCESS)) { ap = 0x1; }
1967 else if ((priv == RW) && (user == READ)) { ap = 0x2; }
1968 else if ((priv == RW) && (user == RW)) { ap = 0x3; }
1969 else if ((priv == READ) && (user == NO_ACCESS)) { ap = 0x5; }
1970 else if ((priv == READ) && (user == READ)) { ap = 0x7; }
1973 else { //Simplified access
1974 if ((priv == RW) && (user == NO_ACCESS)) { ap = 0x1; }
1975 else if ((priv == RW) && (user == RW)) { ap = 0x3; }
1976 else if ((priv == READ) && (user == NO_ACCESS)) { ap = 0x5; }
1977 else if ((priv == READ) && (user == READ)) { ap = 0x7; }
1980 *descriptor_l1 &= SECTION_AP_MASK;
1981 *descriptor_l1 |= (ap & 0x3) << SECTION_AP_SHIFT;
1982 *descriptor_l1 |= ((ap & 0x4)>>2) << SECTION_AP2_SHIFT;
1987 /** \brief Set section shareability
1989 \param [out] descriptor_l1 L1 descriptor.
1990 \param [in] s_bit Section shareability: NON_SHARED, SHARED
1994 __STATIC_INLINE int MMU_SharedSection(uint32_t *descriptor_l1, mmu_shared_Type s_bit)
1996 *descriptor_l1 &= SECTION_S_MASK;
1997 *descriptor_l1 |= ((s_bit & 0x1) << SECTION_S_SHIFT);
2001 /** \brief Set section Global attribute
2003 \param [out] descriptor_l1 L1 descriptor.
2004 \param [in] g_bit Section attribute: GLOBAL, NON_GLOBAL
2008 __STATIC_INLINE int MMU_GlobalSection(uint32_t *descriptor_l1, mmu_global_Type g_bit)
2010 *descriptor_l1 &= SECTION_NG_MASK;
2011 *descriptor_l1 |= ((g_bit & 0x1) << SECTION_NG_SHIFT);
2015 /** \brief Set section Security attribute
2017 \param [out] descriptor_l1 L1 descriptor.
2018 \param [in] s_bit Section Security attribute: SECURE, NON_SECURE
2022 __STATIC_INLINE int MMU_SecureSection(uint32_t *descriptor_l1, mmu_secure_Type s_bit)
2024 *descriptor_l1 &= SECTION_NS_MASK;
2025 *descriptor_l1 |= ((s_bit & 0x1) << SECTION_NS_SHIFT);
2029 /* Page 4k or 64k */
2030 /** \brief Set 4k/64k page execution-never attribute
2032 \param [out] descriptor_l2 L2 descriptor.
2033 \param [in] xn Page execution-never attribute : EXECUTE , NON_EXECUTE.
2034 \param [in] page Page size: PAGE_4k, PAGE_64k,
2038 __STATIC_INLINE int MMU_XNPage(uint32_t *descriptor_l2, mmu_execute_Type xn, mmu_region_size_Type page)
2040 if (page == PAGE_4k)
2042 *descriptor_l2 &= PAGE_XN_4K_MASK;
2043 *descriptor_l2 |= ((xn & 0x1) << PAGE_XN_4K_SHIFT);
2047 *descriptor_l2 &= PAGE_XN_64K_MASK;
2048 *descriptor_l2 |= ((xn & 0x1) << PAGE_XN_64K_SHIFT);
2053 /** \brief Set 4k/64k page domain
2055 \param [out] descriptor_l1 L1 descriptor.
2056 \param [in] domain Page domain
2060 __STATIC_INLINE int MMU_DomainPage(uint32_t *descriptor_l1, uint8_t domain)
2062 *descriptor_l1 &= PAGE_DOMAIN_MASK;
2063 *descriptor_l1 |= ((domain & 0xf) << PAGE_DOMAIN_SHIFT);
2067 /** \brief Set 4k/64k page parity check
2069 \param [out] descriptor_l1 L1 descriptor.
2070 \param [in] p_bit Parity check: ECC_DISABLED, ECC_ENABLED
2074 __STATIC_INLINE int MMU_PPage(uint32_t *descriptor_l1, mmu_ecc_check_Type p_bit)
2076 *descriptor_l1 &= SECTION_P_MASK;
2077 *descriptor_l1 |= ((p_bit & 0x1) << SECTION_P_SHIFT);
2081 /** \brief Set 4k/64k page access privileges
2083 \param [out] descriptor_l2 L2 descriptor.
2084 \param [in] user User Level Access: NO_ACCESS, RW, READ
2085 \param [in] priv Privilege Level Access: NO_ACCESS, RW, READ
2086 \param [in] afe Access flag enable
2090 __STATIC_INLINE int MMU_APPage(uint32_t *descriptor_l2, mmu_access_Type user, mmu_access_Type priv, uint32_t afe)
2094 if (afe == 0) { //full access
2095 if ((priv == NO_ACCESS) && (user == NO_ACCESS)) { ap = 0x0; }
2096 else if ((priv == RW) && (user == NO_ACCESS)) { ap = 0x1; }
2097 else if ((priv == RW) && (user == READ)) { ap = 0x2; }
2098 else if ((priv == RW) && (user == RW)) { ap = 0x3; }
2099 else if ((priv == READ) && (user == NO_ACCESS)) { ap = 0x5; }
2100 else if ((priv == READ) && (user == READ)) { ap = 0x6; }
2103 else { //Simplified access
2104 if ((priv == RW) && (user == NO_ACCESS)) { ap = 0x1; }
2105 else if ((priv == RW) && (user == RW)) { ap = 0x3; }
2106 else if ((priv == READ) && (user == NO_ACCESS)) { ap = 0x5; }
2107 else if ((priv == READ) && (user == READ)) { ap = 0x7; }
2110 *descriptor_l2 &= PAGE_AP_MASK;
2111 *descriptor_l2 |= (ap & 0x3) << PAGE_AP_SHIFT;
2112 *descriptor_l2 |= ((ap & 0x4)>>2) << PAGE_AP2_SHIFT;
2117 /** \brief Set 4k/64k page shareability
2119 \param [out] descriptor_l2 L2 descriptor.
2120 \param [in] s_bit 4k/64k page shareability: NON_SHARED, SHARED
2124 __STATIC_INLINE int MMU_SharedPage(uint32_t *descriptor_l2, mmu_shared_Type s_bit)
2126 *descriptor_l2 &= PAGE_S_MASK;
2127 *descriptor_l2 |= ((s_bit & 0x1) << PAGE_S_SHIFT);
2131 /** \brief Set 4k/64k page Global attribute
2133 \param [out] descriptor_l2 L2 descriptor.
2134 \param [in] g_bit 4k/64k page attribute: GLOBAL, NON_GLOBAL
2138 __STATIC_INLINE int MMU_GlobalPage(uint32_t *descriptor_l2, mmu_global_Type g_bit)
2140 *descriptor_l2 &= PAGE_NG_MASK;
2141 *descriptor_l2 |= ((g_bit & 0x1) << PAGE_NG_SHIFT);
2145 /** \brief Set 4k/64k page Security attribute
2147 \param [out] descriptor_l1 L1 descriptor.
2148 \param [in] s_bit 4k/64k page Security attribute: SECURE, NON_SECURE
2152 __STATIC_INLINE int MMU_SecurePage(uint32_t *descriptor_l1, mmu_secure_Type s_bit)
2154 *descriptor_l1 &= PAGE_NS_MASK;
2155 *descriptor_l1 |= ((s_bit & 0x1) << PAGE_NS_SHIFT);
2159 /** \brief Set Section memory attributes
2161 \param [out] descriptor_l1 L1 descriptor.
2162 \param [in] mem Section memory type: NORMAL, DEVICE, SHARED_DEVICE, NON_SHARED_DEVICE, STRONGLY_ORDERED
2163 \param [in] outer Outer cacheability: NON_CACHEABLE, WB_WA, WT, WB_NO_WA,
2164 \param [in] inner Inner cacheability: NON_CACHEABLE, WB_WA, WT, WB_NO_WA,
2168 __STATIC_INLINE int MMU_MemorySection(uint32_t *descriptor_l1, mmu_memory_Type mem, mmu_cacheability_Type outer, mmu_cacheability_Type inner)
2170 *descriptor_l1 &= SECTION_TEXCB_MASK;
2172 if (STRONGLY_ORDERED == mem)
2176 else if (SHARED_DEVICE == mem)
2178 *descriptor_l1 |= (1 << SECTION_B_SHIFT);
2180 else if (NON_SHARED_DEVICE == mem)
2182 *descriptor_l1 |= (1 << SECTION_TEX1_SHIFT);
2184 else if (NORMAL == mem)
2186 *descriptor_l1 |= 1 << SECTION_TEX2_SHIFT;
2192 *descriptor_l1 |= (1 << SECTION_B_SHIFT);
2195 *descriptor_l1 |= 1 << SECTION_C_SHIFT;
2198 *descriptor_l1 |= (1 << SECTION_B_SHIFT) | (1 << SECTION_C_SHIFT);
2206 *descriptor_l1 |= (1 << SECTION_TEX0_SHIFT);
2209 *descriptor_l1 |= 1 << SECTION_TEX1_SHIFT;
2212 *descriptor_l1 |= (1 << SECTION_TEX0_SHIFT) | (1 << SECTION_TEX0_SHIFT);
2219 /** \brief Set 4k/64k page memory attributes
2221 \param [out] descriptor_l2 L2 descriptor.
2222 \param [in] mem 4k/64k page memory type: NORMAL, DEVICE, SHARED_DEVICE, NON_SHARED_DEVICE, STRONGLY_ORDERED
2223 \param [in] outer Outer cacheability: NON_CACHEABLE, WB_WA, WT, WB_NO_WA,
2224 \param [in] inner Inner cacheability: NON_CACHEABLE, WB_WA, WT, WB_NO_WA,
2225 \param [in] page Page size
2229 __STATIC_INLINE int MMU_MemoryPage(uint32_t *descriptor_l2, mmu_memory_Type mem, mmu_cacheability_Type outer, mmu_cacheability_Type inner, mmu_region_size_Type page)
2231 *descriptor_l2 &= PAGE_4K_TEXCB_MASK;
2233 if (page == PAGE_64k)
2236 MMU_MemorySection(descriptor_l2, mem, outer, inner);
2240 if (STRONGLY_ORDERED == mem)
2244 else if (SHARED_DEVICE == mem)
2246 *descriptor_l2 |= (1 << PAGE_4K_B_SHIFT);
2248 else if (NON_SHARED_DEVICE == mem)
2250 *descriptor_l2 |= (1 << PAGE_4K_TEX1_SHIFT);
2252 else if (NORMAL == mem)
2254 *descriptor_l2 |= 1 << PAGE_4K_TEX2_SHIFT;
2260 *descriptor_l2 |= (1 << PAGE_4K_B_SHIFT);
2263 *descriptor_l2 |= 1 << PAGE_4K_C_SHIFT;
2266 *descriptor_l2 |= (1 << PAGE_4K_B_SHIFT) | (1 << PAGE_4K_C_SHIFT);
2274 *descriptor_l2 |= (1 << PAGE_4K_TEX0_SHIFT);
2277 *descriptor_l2 |= 1 << PAGE_4K_TEX1_SHIFT;
2280 *descriptor_l2 |= (1 << PAGE_4K_TEX0_SHIFT) | (1 << PAGE_4K_TEX0_SHIFT);
2289 /** \brief Create a L1 section descriptor
2291 \param [out] descriptor L1 descriptor
2292 \param [in] reg Section attributes
2296 __STATIC_INLINE int MMU_GetSectionDescriptor(uint32_t *descriptor, mmu_region_attributes_Type reg)
2300 MMU_MemorySection(descriptor, reg.mem_t, reg.outer_norm_t, reg.inner_norm_t);
2301 MMU_XNSection(descriptor,reg.xn_t);
2302 MMU_DomainSection(descriptor, reg.domain);
2303 MMU_PSection(descriptor, reg.e_t);
2304 MMU_APSection(descriptor, reg.priv_t, reg.user_t, 1);
2305 MMU_SharedSection(descriptor,reg.sh_t);
2306 MMU_GlobalSection(descriptor,reg.g_t);
2307 MMU_SecureSection(descriptor,reg.sec_t);
2308 *descriptor &= SECTION_MASK;
2309 *descriptor |= SECTION_DESCRIPTOR;
2315 /** \brief Create a L1 and L2 4k/64k page descriptor
2317 \param [out] descriptor L1 descriptor
2318 \param [out] descriptor2 L2 descriptor
2319 \param [in] reg 4k/64k page attributes
2323 __STATIC_INLINE int MMU_GetPageDescriptor(uint32_t *descriptor, uint32_t *descriptor2, mmu_region_attributes_Type reg)
2331 MMU_MemoryPage(descriptor2, reg.mem_t, reg.outer_norm_t, reg.inner_norm_t, PAGE_4k);
2332 MMU_XNPage(descriptor2, reg.xn_t, PAGE_4k);
2333 MMU_DomainPage(descriptor, reg.domain);
2334 MMU_PPage(descriptor, reg.e_t);
2335 MMU_APPage(descriptor2, reg.priv_t, reg.user_t, 1);
2336 MMU_SharedPage(descriptor2,reg.sh_t);
2337 MMU_GlobalPage(descriptor2,reg.g_t);
2338 MMU_SecurePage(descriptor,reg.sec_t);
2339 *descriptor &= PAGE_L1_MASK;
2340 *descriptor |= PAGE_L1_DESCRIPTOR;
2341 *descriptor2 &= PAGE_L2_4K_MASK;
2342 *descriptor2 |= PAGE_L2_4K_DESC;
2346 MMU_MemoryPage(descriptor2, reg.mem_t, reg.outer_norm_t, reg.inner_norm_t, PAGE_64k);
2347 MMU_XNPage(descriptor2, reg.xn_t, PAGE_64k);
2348 MMU_DomainPage(descriptor, reg.domain);
2349 MMU_PPage(descriptor, reg.e_t);
2350 MMU_APPage(descriptor2, reg.priv_t, reg.user_t, 1);
2351 MMU_SharedPage(descriptor2,reg.sh_t);
2352 MMU_GlobalPage(descriptor2,reg.g_t);
2353 MMU_SecurePage(descriptor,reg.sec_t);
2354 *descriptor &= PAGE_L1_MASK;
2355 *descriptor |= PAGE_L1_DESCRIPTOR;
2356 *descriptor2 &= PAGE_L2_64K_MASK;
2357 *descriptor2 |= PAGE_L2_64K_DESC;
2368 /** \brief Create a 1MB Section
2370 \param [in] ttb Translation table base address
2371 \param [in] base_address Section base address
2372 \param [in] count Number of sections to create
2373 \param [in] descriptor_l1 L1 descriptor (region attributes)
2376 __STATIC_INLINE void MMU_TTSection(uint32_t *ttb, uint32_t base_address, uint32_t count, uint32_t descriptor_l1)
2382 offset = base_address >> 20;
2383 entry = (base_address & 0xFFF00000) | descriptor_l1;
2388 for (i = 0; i < count; i++ )
2396 /** \brief Create a 4k page entry
2398 \param [in] ttb L1 table base address
2399 \param [in] base_address 4k base address
2400 \param [in] count Number of 4k pages to create
2401 \param [in] descriptor_l1 L1 descriptor (region attributes)
2402 \param [in] ttb_l2 L2 table base address
2403 \param [in] descriptor_l2 L2 descriptor (region attributes)
2406 __STATIC_INLINE void MMU_TTPage4k(uint32_t *ttb, uint32_t base_address, uint32_t count, uint32_t descriptor_l1, uint32_t *ttb_l2, uint32_t descriptor_l2 )
2409 uint32_t offset, offset2;
2410 uint32_t entry, entry2;
2413 offset = base_address >> 20;
2414 entry = ((int)ttb_l2 & 0xFFFFFC00) | descriptor_l1;
2421 offset2 = (base_address & 0xff000) >> 12;
2423 entry2 = (base_address & 0xFFFFF000) | descriptor_l2;
2424 for (i = 0; i < count; i++ )
2428 entry2 += OFFSET_4K;
2432 /** \brief Create a 64k page entry
2434 \param [in] ttb L1 table base address
2435 \param [in] base_address 64k base address
2436 \param [in] count Number of 64k pages to create
2437 \param [in] descriptor_l1 L1 descriptor (region attributes)
2438 \param [in] ttb_l2 L2 table base address
2439 \param [in] descriptor_l2 L2 descriptor (region attributes)
2442 __STATIC_INLINE void MMU_TTPage64k(uint32_t *ttb, uint32_t base_address, uint32_t count, uint32_t descriptor_l1, uint32_t *ttb_l2, uint32_t descriptor_l2 )
2444 uint32_t offset, offset2;
2445 uint32_t entry, entry2;
2449 offset = base_address >> 20;
2450 entry = ((int)ttb_l2 & 0xFFFFFC00) | descriptor_l1;
2457 offset2 = (base_address & 0xff000) >> 12;
2459 entry2 = (base_address & 0xFFFF0000) | descriptor_l2;
2460 for (i = 0; i < count; i++ )
2463 for (j = 0; j < 16; j++)
2468 entry2 += OFFSET_64K;
2472 /** \brief Enable MMU
2474 __STATIC_INLINE void MMU_Enable(void)
2476 // Set M bit 0 to enable the MMU
2477 // Set AFE bit to enable simplified access permissions model
2478 // Clear TRE bit to disable TEX remap and A bit to disable strict alignment fault checking
2479 __set_SCTLR( (__get_SCTLR() & ~(1 << 28) & ~(1 << 1)) | 1 | (1 << 29));
2483 /** \brief Disable MMU
2485 __STATIC_INLINE void MMU_Disable(void)
2487 // Clear M bit 0 to disable the MMU
2488 __set_SCTLR( __get_SCTLR() & ~1);
2492 /** \brief Invalidate entire unified TLB
2495 __STATIC_INLINE void MMU_InvalidateTLB(void)
2498 __DSB(); //ensure completion of the invalidation
2499 __ISB(); //ensure instruction fetch path sees new state
2507 #endif /* __CORE_CA_H_DEPENDANT */
2509 #endif /* __CMSIS_GENERIC */