em_mpu.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef EM_MPU_H
#define EM_MPU_H

#include "em_device.h"

#if defined(__MPU_PRESENT) && (__MPU_PRESENT == 1)
#include "em_assert.h"

#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************/
/***************************************************************************/
#define MPU_CTRL_PRIVDEFENA    MPU_CTRL_PRIVDEFENA_Msk

#define MPU_CTRL_HFNMIENA      MPU_CTRL_HFNMIENA_Msk

/*******************************************************************************
 ********************************   ENUMS   ************************************
 ******************************************************************************/

typedef enum
{
  mpuRegionSize32b   = 4,        
  mpuRegionSize64b   = 5,        
  mpuRegionSize128b  = 6,        
  mpuRegionSize256b  = 7,        
  mpuRegionSize512b  = 8,        
  mpuRegionSize1Kb   = 9,        
  mpuRegionSize2Kb   = 10,       
  mpuRegionSize4Kb   = 11,       
  mpuRegionSize8Kb   = 12,       
  mpuRegionSize16Kb  = 13,       
  mpuRegionSize32Kb  = 14,       
  mpuRegionSize64Kb  = 15,       
  mpuRegionSize128Kb = 16,       
  mpuRegionSize256Kb = 17,       
  mpuRegionSize512Kb = 18,       
  mpuRegionSize1Mb   = 19,       
  mpuRegionSize2Mb   = 20,       
  mpuRegionSize4Mb   = 21,       
  mpuRegionSize8Mb   = 22,       
  mpuRegionSize16Mb  = 23,       
  mpuRegionSize32Mb  = 24,       
  mpuRegionSize64Mb  = 25,       
  mpuRegionSize128Mb = 26,       
  mpuRegionSize256Mb = 27,       
  mpuRegionSize512Mb = 28,       
  mpuRegionSize1Gb   = 29,       
  mpuRegionSize2Gb   = 30,       
  mpuRegionSize4Gb   = 31        
} MPU_RegionSize_TypeDef;

typedef enum
{
  mpuRegionNoAccess     = 0,  
  mpuRegionApPRw        = 1,  
  mpuRegionApPRwURo     = 2,  
  mpuRegionApFullAccess = 3,  
  mpuRegionApPRo        = 5,  
  mpuRegionApPRo_URo    = 6   
} MPU_RegionAp_TypeDef;


/*******************************************************************************
 *******************************   STRUCTS   ***********************************
 ******************************************************************************/

typedef struct
{
  bool                   regionEnable;     
  uint8_t                regionNo;         
  uint32_t               baseAddress;      
  MPU_RegionSize_TypeDef size;             
  MPU_RegionAp_TypeDef   accessPermission; 
  bool                   disableExec;      
  bool                   shareable;        
  bool                   cacheable;        
  bool                   bufferable;       
  uint8_t                srd;              
  uint8_t                tex;              
} MPU_RegionInit_TypeDef;

#define MPU_INIT_FLASH_DEFAULT                                \
{                                                             \
  true,                   /* Enable MPU region.            */ \
  0,                      /* MPU Region number.            */ \
  FLASH_MEM_BASE,         /* Flash base address.           */ \
  mpuRegionSize1Mb,       /* Size - Set to max. */            \
  mpuRegionApFullAccess,  /* Access permissions.           */ \
  false,                  /* Execution allowed.            */ \
  false,                  /* Not shareable.                */ \
  true,                   /* Cacheable.                    */ \
  false,                  /* Not bufferable.               */ \
  0,                      /* No subregions.                */ \
  0                       /* No TEX attributes.            */ \
}


#define MPU_INIT_SRAM_DEFAULT                                 \
{                                                             \
  true,                   /* Enable MPU region.            */ \
  1,                      /* MPU Region number.            */ \
  RAM_MEM_BASE,           /* SRAM base address.            */ \
  mpuRegionSize128Kb,     /* Size - Set to max. */            \
  mpuRegionApFullAccess,  /* Access permissions.           */ \
  false,                  /* Execution allowed.            */ \
  true,                   /* Shareable.                    */ \
  true,                   /* Cacheable.                    */ \
  false,                  /* Not bufferable.               */ \
  0,                      /* No subregions.                */ \
  0                       /* No TEX attributes.            */ \
}


#define MPU_INIT_PERIPHERAL_DEFAULT                           \
{                                                             \
  true,                   /* Enable MPU region.            */ \
  0,                      /* MPU Region number.            */ \
  0,                      /* Region base address.          */ \
  mpuRegionSize32b,       /* Size - Set to minimum         */ \
  mpuRegionApFullAccess,  /* Access permissions.           */ \
  true,                   /* Execution not allowed.        */ \
  true,                   /* Shareable.                    */ \
  false,                  /* Not cacheable.                */ \
  true,                   /* Bufferable.                   */ \
  0,                      /* No subregions.                */ \
  0                       /* No TEX attributes.            */ \
}


/*******************************************************************************
 *****************************   PROTOTYPES   **********************************
 ******************************************************************************/


void MPU_ConfigureRegion(const MPU_RegionInit_TypeDef *init);


/***************************************************************************/
__STATIC_INLINE void MPU_Disable(void)
{
  SCB->SHCSR &= ~SCB_SHCSR_MEMFAULTENA_Msk;      /* Disable fault exceptions */
  MPU->CTRL  &= ~MPU_CTRL_ENABLE_Msk;            /* Disable the MPU */
}


/***************************************************************************/
__STATIC_INLINE void MPU_Enable(uint32_t flags)
{
  EFM_ASSERT(!(flags & ~(MPU_CTRL_PRIVDEFENA_Msk
                         | MPU_CTRL_HFNMIENA_Msk
                         | MPU_CTRL_ENABLE_Msk)));

  MPU->CTRL   = flags | MPU_CTRL_ENABLE_Msk;     /* Enable the MPU */
  SCB->SHCSR |= SCB_SHCSR_MEMFAULTENA_Msk;       /* Enable fault exceptions */
}


#ifdef __cplusplus
}
#endif

#endif /* defined(__MPU_PRESENT) && (__MPU_PRESENT == 1) */

#endif /* EM_MPU_H */