Hilscher netX microcontroller driver  V0.0.5.0
Documentation of the netX driver package
mpu_armv7.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ARM_MPU_Region_t
 

Macros

#define ARM_MPU_ARMV7_H
 
#define ARM_MPU_REGION_SIZE_32B   ((uint8_t)0x04U)
 
#define ARM_MPU_REGION_SIZE_64B   ((uint8_t)0x05U)
 
#define ARM_MPU_REGION_SIZE_128B   ((uint8_t)0x06U)
 
#define ARM_MPU_REGION_SIZE_256B   ((uint8_t)0x07U)
 
#define ARM_MPU_REGION_SIZE_512B   ((uint8_t)0x08U)
 
#define ARM_MPU_REGION_SIZE_1KB   ((uint8_t)0x09U)
 
#define ARM_MPU_REGION_SIZE_2KB   ((uint8_t)0x0AU)
 
#define ARM_MPU_REGION_SIZE_4KB   ((uint8_t)0x0BU)
 
#define ARM_MPU_REGION_SIZE_8KB   ((uint8_t)0x0CU)
 
#define ARM_MPU_REGION_SIZE_16KB   ((uint8_t)0x0DU)
 
#define ARM_MPU_REGION_SIZE_32KB   ((uint8_t)0x0EU)
 
#define ARM_MPU_REGION_SIZE_64KB   ((uint8_t)0x0FU)
 
#define ARM_MPU_REGION_SIZE_128KB   ((uint8_t)0x10U)
 
#define ARM_MPU_REGION_SIZE_256KB   ((uint8_t)0x11U)
 
#define ARM_MPU_REGION_SIZE_512KB   ((uint8_t)0x12U)
 
#define ARM_MPU_REGION_SIZE_1MB   ((uint8_t)0x13U)
 
#define ARM_MPU_REGION_SIZE_2MB   ((uint8_t)0x14U)
 
#define ARM_MPU_REGION_SIZE_4MB   ((uint8_t)0x15U)
 
#define ARM_MPU_REGION_SIZE_8MB   ((uint8_t)0x16U)
 
#define ARM_MPU_REGION_SIZE_16MB   ((uint8_t)0x17U)
 
#define ARM_MPU_REGION_SIZE_32MB   ((uint8_t)0x18U)
 
#define ARM_MPU_REGION_SIZE_64MB   ((uint8_t)0x19U)
 
#define ARM_MPU_REGION_SIZE_128MB   ((uint8_t)0x1AU)
 
#define ARM_MPU_REGION_SIZE_256MB   ((uint8_t)0x1BU)
 
#define ARM_MPU_REGION_SIZE_512MB   ((uint8_t)0x1CU)
 
#define ARM_MPU_REGION_SIZE_1GB   ((uint8_t)0x1DU)
 
#define ARM_MPU_REGION_SIZE_2GB   ((uint8_t)0x1EU)
 
#define ARM_MPU_REGION_SIZE_4GB   ((uint8_t)0x1FU)
 
#define ARM_MPU_AP_NONE   0U
 
#define ARM_MPU_AP_PRIV   1U
 
#define ARM_MPU_AP_URO   2U
 
#define ARM_MPU_AP_FULL   3U
 
#define ARM_MPU_AP_PRO   5U
 
#define ARM_MPU_AP_RO   6U
 
#define ARM_MPU_RBAR(Region, BaseAddress)
 
#define ARM_MPU_RASR(DisableExec, AccessPermission, TypeExtField, IsShareable, IsCacheable, IsBufferable, SubRegionDisable, Size)
 

Functions

__STATIC_INLINE void ARM_MPU_Enable (uint32_t MPU_Control)
 
__STATIC_INLINE void ARM_MPU_Disable (void)
 
__STATIC_INLINE void ARM_MPU_ClrRegion (uint32_t rnr)
 
__STATIC_INLINE void ARM_MPU_SetRegion (uint32_t rbar, uint32_t rasr)
 
__STATIC_INLINE void ARM_MPU_SetRegionEx (uint32_t rnr, uint32_t rbar, uint32_t rasr)
 
__STATIC_INLINE void orderedCpy (volatile uint32_t *dst, const uint32_t *__RESTRICT src, uint32_t len)
 
__STATIC_INLINE void ARM_MPU_Load (ARM_MPU_Region_t const *table, uint32_t cnt)
 

Macro Definition Documentation

#define ARM_MPU_AP_FULL   3U

Definition at line 66 of file mpu_armv7.h.

#define ARM_MPU_AP_NONE   0U

Definition at line 63 of file mpu_armv7.h.

#define ARM_MPU_AP_PRIV   1U

Definition at line 64 of file mpu_armv7.h.

#define ARM_MPU_AP_PRO   5U

Definition at line 67 of file mpu_armv7.h.

#define ARM_MPU_AP_RO   6U

Definition at line 68 of file mpu_armv7.h.

#define ARM_MPU_AP_URO   2U

Definition at line 65 of file mpu_armv7.h.

#define ARM_MPU_ARMV7_H

Definition at line 32 of file mpu_armv7.h.

#define ARM_MPU_RASR (   DisableExec,
  AccessPermission,
  TypeExtField,
  IsShareable,
  IsCacheable,
  IsBufferable,
  SubRegionDisable,
  Size 
)
Value:
((((DisableExec ) << MPU_RASR_XN_Pos) & MPU_RASR_XN_Msk) | \
(((AccessPermission) << MPU_RASR_AP_Pos) & MPU_RASR_AP_Msk) | \
(((TypeExtField ) << MPU_RASR_TEX_Pos) & MPU_RASR_TEX_Msk) | \
(((IsShareable ) << MPU_RASR_S_Pos) & MPU_RASR_S_Msk) | \
(((IsCacheable ) << MPU_RASR_C_Pos) & MPU_RASR_C_Msk) | \
(((IsBufferable ) << MPU_RASR_B_Pos) & MPU_RASR_B_Msk) | \
(((SubRegionDisable) << MPU_RASR_SRD_Pos) & MPU_RASR_SRD_Msk) | \
(((Size ) << MPU_RASR_SIZE_Pos) & MPU_RASR_SIZE_Msk) | \
(MPU_RASR_ENABLE_Msk))

MPU Region Attribute and Size Register Value

Parameters
DisableExecInstruction access disable bit, 1= disable instruction fetches.
AccessPermissionData access permissions, allows you to configure read/write access for User and Privileged mode.
TypeExtFieldType extension field, allows you to configure memory access type, for example strongly ordered, peripheral.
IsShareableRegion is shareable between multiple bus masters.
IsCacheableRegion is cacheable, i.e. its value may be kept in cache.
IsBufferableRegion is bufferable, i.e. using write-back caching. Cacheable but non-bufferable regions use write-through policy.
SubRegionDisableSub-region disable field.
SizeRegion size of the region to be configured, for example 4K, 8K.

Definition at line 92 of file mpu_armv7.h.

#define ARM_MPU_RBAR (   Region,
  BaseAddress 
)
Value:
(((BaseAddress) & MPU_RBAR_ADDR_Msk) | \
((Region) & MPU_RBAR_REGION_Msk) | \
(MPU_RBAR_VALID_Msk))

MPU Region Base Address Register Value

Parameters
RegionThe region to be configured, number 0 to 15.
BaseAddressThe base address for the region.

Definition at line 75 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_128B   ((uint8_t)0x06U)

Definition at line 36 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_128KB   ((uint8_t)0x10U)

Definition at line 46 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_128MB   ((uint8_t)0x1AU)

Definition at line 56 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_16KB   ((uint8_t)0x0DU)

Definition at line 43 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_16MB   ((uint8_t)0x17U)

Definition at line 53 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_1GB   ((uint8_t)0x1DU)

Definition at line 59 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_1KB   ((uint8_t)0x09U)

Definition at line 39 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_1MB   ((uint8_t)0x13U)

Definition at line 49 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_256B   ((uint8_t)0x07U)

Definition at line 37 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_256KB   ((uint8_t)0x11U)

Definition at line 47 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_256MB   ((uint8_t)0x1BU)

Definition at line 57 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_2GB   ((uint8_t)0x1EU)

Definition at line 60 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_2KB   ((uint8_t)0x0AU)

Definition at line 40 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_2MB   ((uint8_t)0x14U)

Definition at line 50 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_32B   ((uint8_t)0x04U)

Definition at line 34 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_32KB   ((uint8_t)0x0EU)

Definition at line 44 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_32MB   ((uint8_t)0x18U)

Definition at line 54 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_4GB   ((uint8_t)0x1FU)

Definition at line 61 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_4KB   ((uint8_t)0x0BU)

Definition at line 41 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_4MB   ((uint8_t)0x15U)

Definition at line 51 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_512B   ((uint8_t)0x08U)

Definition at line 38 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_512KB   ((uint8_t)0x12U)

Definition at line 48 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_512MB   ((uint8_t)0x1CU)

Definition at line 58 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_64B   ((uint8_t)0x05U)

Definition at line 35 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_64KB   ((uint8_t)0x0FU)

Definition at line 45 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_64MB   ((uint8_t)0x19U)

Definition at line 55 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_8KB   ((uint8_t)0x0CU)

Definition at line 42 of file mpu_armv7.h.

#define ARM_MPU_REGION_SIZE_8MB   ((uint8_t)0x16U)

Definition at line 52 of file mpu_armv7.h.

Function Documentation

__STATIC_INLINE void ARM_MPU_ClrRegion ( uint32_t  rnr)

Clear and disable the given MPU region.

Parameters
rnrRegion number to be cleared.

Definition at line 140 of file mpu_armv7.h.

__STATIC_INLINE void ARM_MPU_Disable ( void  )

Disable the MPU.

Definition at line 127 of file mpu_armv7.h.

Here is the call graph for this function:

__STATIC_INLINE void ARM_MPU_Enable ( uint32_t  MPU_Control)

Enable the MPU.

Parameters
MPU_ControlDefault access permissions for unconfigured regions.

Definition at line 115 of file mpu_armv7.h.

Here is the call graph for this function:

__STATIC_INLINE void ARM_MPU_Load ( ARM_MPU_Region_t const *  table,
uint32_t  cnt 
)

Load the given number of MPU regions from a table.

Parameters
tablePointer to the MPU configuration table.
cntAmount of regions to be configured.

Definition at line 186 of file mpu_armv7.h.

Here is the call graph for this function:

__STATIC_INLINE void ARM_MPU_SetRegion ( uint32_t  rbar,
uint32_t  rasr 
)

Configure an MPU region.

Parameters
rbarValue for RBAR register.
rsarValue for RSAR register.

Definition at line 150 of file mpu_armv7.h.

__STATIC_INLINE void ARM_MPU_SetRegionEx ( uint32_t  rnr,
uint32_t  rbar,
uint32_t  rasr 
)

Configure the given MPU region.

Parameters
rnrRegion number to be configured.
rbarValue for RBAR register.
rsarValue for RSAR register.

Definition at line 161 of file mpu_armv7.h.

__STATIC_INLINE void orderedCpy ( volatile uint32_t *  dst,
const uint32_t *__RESTRICT  src,
uint32_t  len 
)

Memcopy with strictly ordered memory access, e.g. for register targets.

Parameters
dstDestination data is copied to.
srcSource data is copied from.
lenAmount of data words to be copied.

Definition at line 173 of file mpu_armv7.h.

Here is the caller graph for this function: