SMU - Security Management Unit

Description

Security Management Unit (SMU) Peripheral API.

SMU forms the control and status/reporting component of bus-level security in EFM32/EFR32 devices.

Peripheral-level protection is provided via the Peripheral Protection Unit (PPU). PPU provides hardware access barrier to any peripheral that is configured to be protected. When an attempt is made to access a peripheral without the required privilege/security level, PPU detects the fault and intercepts the access. No write or read of the peripheral register space occurs, and an all-zero value is returned if the access is a read.

Usage example

// SMU is always clocked, so no call to CMU_ClockEnable() is necessary
// Initialize SMU to prevent access to CMU, EMU, SMU and GPIO
init.ppu.access.privilegedCMU = true;
init.ppu.access.privilegedEMU = true;
init.ppu.access.privilegedSMU = true;
SMU_Init(&init);

Data Structures

struct  SMU_PrivilegedAccess_TypeDef
 SMU peripheral privileged access enablers.
 
struct  SMU_Init_TypeDef
 SMU initialization structure.
 

Functions

void SMU_EnablePPU (bool enable)
 Enable or disable PPU of SMU.
 
void SMU_Init (const SMU_Init_TypeDef *init)
 Initialize PPU of SMU.
 
void SMU_SetPrivilegedAccess (SMU_Peripheral_TypeDef peripheral, bool privileged)
 Change access settings for a peripheral.
 
SMU_Peripheral_TypeDef SMU_GetFaultingPeripheral (void)
 Get the ID of the peripheral that caused an access fault.
 
void SMU_IntClear (uint32_t flags)
 Clear one or more pending SMU interrupts.
 
void SMU_IntDisable (uint32_t flags)
 Disable one or more SMU interrupts.
 
void SMU_IntEnable (uint32_t flags)
 Enable one or more SMU interrupts.
 
uint32_t SMU_IntGet (void)
 Get pending SMU interrupts.
 
uint32_t SMU_IntGetEnabled (void)
 Get enabled and pending SMU interrupt flags.
 
void SMU_IntSet (uint32_t flags)
 Set one or more pending SMU interrupts from SW.
 
void SMU_SECURE_IRQHandler (void)
 SMU secure IRQ Handler.
 

Macros

#define SMU_INIT_DEFAULT
 Default SMU initialization structure settings.
 

Enumerations

enum  SMU_Peripheral_TypeDef {
  smuPeripheralEMU = _SMU_PPUPATD0_EMU_SHIFT,
  smuPeripheralCMU = _SMU_PPUPATD0_CMU_SHIFT,
  smuPeripheralHFXO = _SMU_PPUPATD0_HFXO0_SHIFT,
  smuPeripheralHFRCO0 = _SMU_PPUPATD0_HFRCO0_SHIFT,
  smuPeripheralFSRCO = _SMU_PPUPATD0_FSRCO_SHIFT,
  smuPeripheralDPLL0 = _SMU_PPUPATD0_DPLL0_SHIFT,
  smuPeripheralLFXO = _SMU_PPUPATD0_LFXO_SHIFT,
  smuPeripheralLFRCO = _SMU_PPUPATD0_LFRCO_SHIFT,
  smuPeripheralULFRCO = _SMU_PPUPATD0_ULFRCO_SHIFT,
  smuPeripheralMSC = _SMU_PPUPATD0_MSC_SHIFT,
  smuPeripheralICACHE0 = _SMU_PPUPATD0_ICACHE0_SHIFT,
  smuPeripheralPRS = _SMU_PPUPATD0_PRS_SHIFT,
  smuPeripheralGPIO = _SMU_PPUPATD0_GPIO_SHIFT,
  smuPeripheralLDMA = _SMU_PPUPATD0_LDMA_SHIFT,
  smuPeripheralLDMAXBAR = _SMU_PPUPATD0_LDMAXBAR_SHIFT,
  smuPeripheralTIMER0 = _SMU_PPUPATD0_TIMER0_SHIFT,
  smuPeripheralTIMER1 = _SMU_PPUPATD0_TIMER1_SHIFT,
  smuPeripheralTIMER2 = _SMU_PPUPATD0_TIMER2_SHIFT,
  smuPeripheralTIMER3 = _SMU_PPUPATD0_TIMER3_SHIFT,
  smuPeripheralUSART0 = _SMU_PPUPATD0_USART0_SHIFT,
  smuPeripheralUSART1 = _SMU_PPUPATD0_USART1_SHIFT,
  smuPeripheralUSART2 = _SMU_PPUPATD0_USART2_SHIFT,
  smuPeripheralBURTC = _SMU_PPUPATD0_BURTC_SHIFT,
  smuPeripheralI2C1 = _SMU_PPUPATD0_I2C1_SHIFT,
  smuPeripheralCHIPTESTCTRL = _SMU_PPUPATD0_CHIPTESTCTRL_SHIFT,
  smuPeripheralLVGD = _SMU_PPUPATD0_LVGD_SHIFT,
  smuPeripheralSYSCFG = _SMU_PPUPATD0_SYSCFG_SHIFT,
  smuPeripheralBURAM = _SMU_PPUPATD0_BURAM_SHIFT,
  smuPeripheralIFADCDEBUG = _SMU_PPUPATD0_IFADCDEBUG_SHIFT,
  smuPeripheralGPCRC = _SMU_PPUPATD0_GPCRC_SHIFT,
  smuPeripheralRTCC = _SMU_PPUPATD0_RTCC_SHIFT,
  smuPeripheralLETIMER0 = 32 + _SMU_PPUPATD1_LETIMER0_SHIFT,
  smuPeripheralIADC0 = 32 + _SMU_PPUPATD1_IADC0_SHIFT,
  smuPeripheralACMP0 = 32 + _SMU_PPUPATD1_ACMP0_SHIFT,
  smuPeripheralACMP1 = 32 + _SMU_PPUPATD1_ACMP1_SHIFT,
  smuPeripheralI2C0 = 32 + _SMU_PPUPATD1_I2C0_SHIFT,
  smuPeripheralHFRCOEM23 = 32 + _SMU_PPUPATD1_HFRCOEM23_SHIFT,
  smuPeripheralWDOG0 = 32 + _SMU_PPUPATD1_WDOG0_SHIFT,
  smuPeripheralWDOG1 = 32 + _SMU_PPUPATD1_WDOG1_SHIFT,
  smuPeripheralAMUXCP0 = 32 + _SMU_PPUPATD1_AMUXCP0_SHIFT,
  smuPeripheralRADIOAES = 32 + _SMU_PPUPATD1_RADIOAES_SHIFT,
  smuPeripheralBUFC = 32 + _SMU_PPUPATD1_BUFC_SHIFT,
  smuPeripheralSMU = 32 + _SMU_PPUPATD1_SMU_SHIFT,
  smuPeripheralAHBRADIO = 32 + _SMU_PPUPATD1_AHBRADIO_SHIFT,
  smuPeripheralSEMAILBOX = 32 + _SMU_PPUPATD1_SEMAILBOX_SHIFT,
  smuPeripheralEnd
}
 SMU peripheral identifiers.
 

Function Documentation

◆ SMU_EnablePPU()

void SMU_EnablePPU ( bool  enable)
inline

Enable or disable PPU of SMU.

Parameters
[in]enableSet to true to enable PPU; set to false otherwise.

◆ SMU_Init()

void SMU_Init ( const SMU_Init_TypeDef init)
inline

Initialize PPU of SMU.

Parameters
[in]initPointer to initialization structure that defines which peripherals should only be accessed from privileged mode, and if PPU should be enabled.

◆ SMU_SetPrivilegedAccess()

void SMU_SetPrivilegedAccess ( SMU_Peripheral_TypeDef  peripheral,
bool  privileged 
)
inline

Change access settings for a peripheral.

Set to limit access of a peripheral from privileged mode.

Parameters
[in]peripheralID of the peripheral to change access settings for.
[in]privilegedSet to true if the peripheral should only be accessed from privileged mode; set to false otherwise.

◆ SMU_GetFaultingPeripheral()

SMU_Peripheral_TypeDef SMU_GetFaultingPeripheral ( void  )
inline

Get the ID of the peripheral that caused an access fault.

Note
The return value is only valid if SMU_IF_PPUPRIV interrupt flag is set.
Returns
ID of the peripheral that caused an access fault.

◆ SMU_IntClear()

void SMU_IntClear ( uint32_t  flags)
inline

Clear one or more pending SMU interrupts.

Parameters
[in]flagsBitwise logic OR of SMU interrupt sources to clear.

◆ SMU_IntDisable()

void SMU_IntDisable ( uint32_t  flags)
inline

Disable one or more SMU interrupts.

Parameters
[in]flagsSMU interrupt sources to disable.

◆ SMU_IntEnable()

void SMU_IntEnable ( uint32_t  flags)
inline

Enable one or more SMU interrupts.

Note
Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using SMU_IntClear() prior to enabling the interrupt.
Parameters
[in]flagsSMU interrupt sources to enable.

◆ SMU_IntGet()

uint32_t SMU_IntGet ( void  )
inline

Get pending SMU interrupts.

Returns
SMU interrupt sources pending.

◆ SMU_IntGetEnabled()

uint32_t SMU_IntGetEnabled ( void  )
inline

Get enabled and pending SMU interrupt flags.

Useful for handling more interrupt sources in the same interrupt handler.

Note
Interrupt flags are not cleared by this function.
Returns
Pending and enabled SMU interrupt sources. The return value is the bitwise AND combination of
  • the OR combination of enabled interrupt sources in SMU_IEN register and
  • the OR combination of valid interrupt flags in SMU_IF register.

◆ SMU_IntSet()

void SMU_IntSet ( uint32_t  flags)
inline

Set one or more pending SMU interrupts from SW.

Parameters
[in]flagsSMU interrupt sources to set to pending.

◆ SMU_SECURE_IRQHandler()

void SMU_SECURE_IRQHandler ( void  )

SMU secure IRQ Handler.

When a PPU detects an access to a secure peripheral at its non-secure address or an access to a non-secure peripheral at its secure address, PPUSECIF in SMU_IF is set and the ID of the peripheral being accessed is written to SMU_PPUFS. If PPUSECIEN is set and the SMU's Secure IRQ enabled, the CPU will be interrupted and SMU_SECURE_IRQHandler Will handle the interrupt.

Macro Definition Documentation

◆ SMU_INIT_DEFAULT

#define SMU_INIT_DEFAULT
Value:
{ \
{ { 0 } }, /* No peripherals access protected. */ \
true /* Enable SMU.*/ \
}

Default SMU initialization structure settings.

Enumeration Type Documentation

◆ SMU_Peripheral_TypeDef

SMU peripheral identifiers.

Enumerator
smuPeripheralEMU 

SMU peripheral identifier for EMU

smuPeripheralCMU 

SMU peripheral identifier for CMU

smuPeripheralHFXO 

SMU peripheral identifier for HFXO0

smuPeripheralHFRCO0 

SMU peripheral identifier for HFRCO0

smuPeripheralFSRCO 

SMU peripheral identifier for FSRCO

smuPeripheralDPLL0 

SMU peripheral identifier for DPLL0

smuPeripheralLFXO 

SMU peripheral identifier for LFXO

smuPeripheralLFRCO 

SMU peripheral identifier for LFRCO

smuPeripheralULFRCO 

SMU peripheral identifier for ULFRCO

smuPeripheralMSC 

SMU peripheral identifier for MSC

smuPeripheralICACHE0 

SMU peripheral identifier for ICACHE0

smuPeripheralPRS 

SMU peripheral identifier for PRS

smuPeripheralGPIO 

SMU peripheral identifier for GPIO

smuPeripheralLDMA 

SMU peripheral identifier for LDMA

smuPeripheralLDMAXBAR 

SMU peripheral identifier for LDMAXBAR

smuPeripheralTIMER0 

SMU peripheral identifier for TIMER0

smuPeripheralTIMER1 

SMU peripheral identifier for TIMER1

smuPeripheralTIMER2 

SMU peripheral identifier for TIMER2

smuPeripheralTIMER3 

SMU peripheral identifier for TIMER3

smuPeripheralUSART0 

SMU peripheral identifier for USART0

smuPeripheralUSART1 

SMU peripheral identifier for USART1

smuPeripheralUSART2 

SMU peripheral identifier for USART2

smuPeripheralBURTC 

SMU peripheral identifier for BURTC

smuPeripheralI2C1 

SMU peripheral identifier for I2C1

smuPeripheralCHIPTESTCTRL 

SMU peripheral identifier for CHIPTESTCTRL.

smuPeripheralLVGD 

SMU peripheral identifier for LVGD

smuPeripheralSYSCFG 

SMU peripheral identifier for SYSCFG

smuPeripheralBURAM 

SMU peripheral identifier for BURAM

smuPeripheralIFADCDEBUG 

SMU peripheral identifier for IFADCDEBUG.

smuPeripheralGPCRC 

SMU peripheral identifier for GPCRC

smuPeripheralRTCC 

SMU peripheral identifier for RTCC

smuPeripheralLETIMER0 

SMU peripheral identifier for LETIMER

smuPeripheralIADC0 

SMU peripheral identifier for IADC0

smuPeripheralACMP0 

SMU peripheral identifier for ACMP0

smuPeripheralACMP1 

SMU peripheral identifier for ACMP1

smuPeripheralI2C0 

SMU peripheral identifier for I2C0

smuPeripheralHFRCOEM23 

SMU peripheral identifier for HFRCOEM23.

smuPeripheralWDOG0 

SMU peripheral identifier for WDOG0

smuPeripheralWDOG1 

SMU peripheral identifier for WDOG1

smuPeripheralAMUXCP0 

SMU peripheral identifier for AMUXCP0

smuPeripheralRADIOAES 

SMU peripheral identifier for RADIOAES

smuPeripheralBUFC 

SMU peripheral identifier for BUFC

smuPeripheralSMU 

SMU peripheral identifier for SMU

smuPeripheralAHBRADIO 

SMU peripheral identifier for AHBRADIO

smuPeripheralSEMAILBOX 

SMU peripheral identifier for SEMAILBOX.

smuPeripheralEnd 

SMU peripheral end.