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
       
        SMU_Init_TypeDef
       
       init =
       
        SMU_INIT_DEFAULT
       
       ;
      
       init.
       
        ppu
       
       .
       
        access
       
       .
       
        privilegedCMU
       
       =
       
        true
       
       ;
      
       init.
       
        ppu
       
       .
       
        access
       
       .
       
        privilegedEMU
       
       =
       
        true
       
       ;
      
       init.
       
        ppu
       
       .
       
        access
       
       .
       
        privilegedSMU
       
       =
       
        true
       
       ;
      
       init.
       
        ppu
       
       .
       
        access
       
       .
       
        privilegedGPIO
       
       =
       
        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.

Macros
#define	SMU_INIT_DEFAULT
	Default SMU initialization structure settings.

Enumerations
enum	SMU_Peripheral_TypeDef { smuPeripheralACMP0 = _SMU_PPUPATD0_ACMP0_SHIFT, smuPeripheralACMP1 = _SMU_PPUPATD0_ACMP1_SHIFT, smuPeripheralADC0 = _SMU_PPUPATD0_ADC0_SHIFT, smuPeripheralCAN0 = _SMU_PPUPATD0_CAN0_SHIFT, smuPeripheralCMU = _SMU_PPUPATD0_CMU_SHIFT, smuPeripheralCRYOTIMER = _SMU_PPUPATD0_CRYOTIMER_SHIFT, smuPeripheralCRYPTO0 = _SMU_PPUPATD0_CRYPTO0_SHIFT, smuPeripheralCSEN = _SMU_PPUPATD0_CSEN_SHIFT, smuPeripheralVDAC0 = _SMU_PPUPATD0_VDAC0_SHIFT, smuPeripheralPRS = _SMU_PPUPATD0_PRS_SHIFT, smuPeripheralEMU = _SMU_PPUPATD0_EMU_SHIFT, smuPeripheralGPCRC = _SMU_PPUPATD0_GPCRC_SHIFT, smuPeripheralGPIO = _SMU_PPUPATD0_GPIO_SHIFT, smuPeripheralI2C0 = _SMU_PPUPATD0_I2C0_SHIFT, smuPeripheralI2C1 = _SMU_PPUPATD0_I2C1_SHIFT, smuPeripheralMSC = _SMU_PPUPATD0_MSC_SHIFT, smuPeripheralLCD = _SMU_PPUPATD0_LCD_SHIFT, smuPeripheralLDMA = _SMU_PPUPATD0_LDMA_SHIFT, smuPeripheralLESENSE = _SMU_PPUPATD0_LESENSE_SHIFT, smuPeripheralLETIMER0 = _SMU_PPUPATD0_LETIMER0_SHIFT, smuPeripheralLEUART0 = _SMU_PPUPATD0_LEUART0_SHIFT, smuPeripheralPCNT0 = _SMU_PPUPATD0_PCNT0_SHIFT, smuPeripheralRMU = _SMU_PPUPATD0_RMU_SHIFT, smuPeripheralRTCC = _SMU_PPUPATD0_RTCC_SHIFT, smuPeripheralSMU = _SMU_PPUPATD0_SMU_SHIFT, smuPeripheralTIMER0 = _SMU_PPUPATD0_TIMER0_SHIFT, smuPeripheralTIMER1 = _SMU_PPUPATD0_TIMER1_SHIFT, smuPeripheralTRNG0 = _SMU_PPUPATD0_TRNG0_SHIFT, smuPeripheralUART0 = _SMU_PPUPATD0_UART0_SHIFT, smuPeripheralUSART0 = _SMU_PPUPATD0_USART0_SHIFT, smuPeripheralUSART1 = _SMU_PPUPATD0_USART1_SHIFT, smuPeripheralUSART2 = _SMU_PPUPATD0_USART2_SHIFT, smuPeripheralUSART3 = 32 + _SMU_PPUPATD1_USART3_SHIFT, smuPeripheralWDOG0 = 32 + _SMU_PPUPATD1_WDOG0_SHIFT, smuPeripheralWTIMER0 = 32 + _SMU_PPUPATD1_WTIMER0_SHIFT, smuPeripheralWTIMER1 = 32 + _SMU_PPUPATD1_WTIMER1_SHIFT, smuPeripheralEnd }
	SMU peripheral identifiers.

Function Documentation

◆ SMU_EnablePPU()

void SMU_EnablePPU ( bool enable )

inline

Enable or disable PPU of SMU.

Parameters

[in] enable Set 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] init Pointer 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]	`peripheral`	ID of the peripheral to change access settings for.
[in]	`privileged`	Set 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] flags Bitwise 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] flags SMU 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] flags SMU 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] flags SMU interrupt sources to set to pending.

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

enum SMU_Peripheral_TypeDef

SMU peripheral identifiers.

Enumerator
smuPeripheralACMP0	SMU peripheral identifier for ACMP0.
smuPeripheralACMP1	SMU peripheral identifier for ACMP1.
smuPeripheralADC0	SMU peripheral identifier for ADC0.
smuPeripheralCAN0	SMU peripheral identifier for CAN0.
smuPeripheralCMU	SMU peripheral identifier for CMU.
smuPeripheralCRYOTIMER	SMU peripheral identifier for CRYOTIMER.
smuPeripheralCRYPTO0	SMU peripheral identifier for CRYPTO0.
smuPeripheralCSEN	SMU peripheral identifier for CSEN.
smuPeripheralVDAC0	SMU peripheral identifier for VDAC0.
smuPeripheralPRS	SMU peripheral identifier for PRS.
smuPeripheralEMU	SMU peripheral identifier for EMU.
smuPeripheralGPCRC	SMU peripheral identifier for GPCRC.
smuPeripheralGPIO	SMU peripheral identifier for GPIO.
smuPeripheralI2C0	SMU peripheral identifier for I2C0.
smuPeripheralI2C1	SMU peripheral identifier for I2C1.
smuPeripheralMSC	SMU peripheral identifier for MAC.
smuPeripheralLCD	SMU peripheral identifier for LCD.
smuPeripheralLDMA	SMU peripheral identifier for LDMA.
smuPeripheralLESENSE	SMU peripheral identifier for LESENSE.
smuPeripheralLETIMER0	SMU peripheral identifier for LETIMER0.
smuPeripheralLEUART0	SMU peripheral identifier for LEUART0.
smuPeripheralPCNT0	SMU peripheral identifier for PCNT0.
smuPeripheralRMU	SMU peripheral identifier for RMU.
smuPeripheralRTCC	SMU peripheral identifier for RTCC.
smuPeripheralSMU	SMU peripheral identifier for SMU.
smuPeripheralTIMER0	SMU peripheral identifier for TIMER0.
smuPeripheralTIMER1	SMU peripheral identifier for TIMER0.
smuPeripheralTRNG0	SMU peripheral identifier for TRNG0.
smuPeripheralUART0	SMU peripheral identifier for UART0.
smuPeripheralUSART0	SMU peripheral identifier for USART0.
smuPeripheralUSART1	SMU peripheral identifier for USART1.
smuPeripheralUSART2	SMU peripheral identifier for USART2.
smuPeripheralUSART3	SMU peripheral identifier for USART3.
smuPeripheralWDOG0	SMU peripheral identifier for WDOG0.
smuPeripheralWTIMER0	SMU peripheral identifier for WTIMER0.
smuPeripheralWTIMER1	SMU peripheral identifier for WTIMER1.
smuPeripheralEnd	SMU peripheral end.

SMU - Security Management Unit

Description

Data Structures

Functions

Macros

Enumerations

Function Documentation

◆ SMU_EnablePPU()

◆ SMU_Init()

◆ SMU_SetPrivilegedAccess()

◆ SMU_GetFaultingPeripheral()

◆ SMU_IntClear()

◆ SMU_IntDisable()

◆ SMU_IntEnable()

◆ SMU_IntGet()

◆ SMU_IntGetEnabled()

◆ SMU_IntSet()

Macro Definition Documentation

◆ SMU_INIT_DEFAULT

Enumeration Type Documentation

◆ SMU_Peripheral_TypeDef