SYSTEM - System Utils#

System API.

This module contains functions to read information such as RAM and Flash size, device unique ID, chip revision, family, and part number from DEVINFO and SCB blocks. Functions to configure and read status from FPU are available for compatible devices.

Modules#

SYSTEM_ChipRevision_TypeDef

SYSTEM_CalAddrVal_TypeDef

Enumerations#

enum

SYSTEM_PartFamily_TypeDef {

systemPartFamilyFlex23 = DEVINFO_PART_FAMILY_FG | (23 << _DEVINFO_PART_FAMILYNUM_SHIFT)

systemPartFamilyZen23 = DEVINFO_PART_FAMILY_ZG | (23 << _DEVINFO_PART_FAMILYNUM_SHIFT)

systemPartFamilyEfm32Pearl23 = DEVINFO_PART_FAMILY_PG | (23 << _DEVINFO_PART_FAMILYNUM_SHIFT)

systemPartFamilySideWalk23 = DEVINFO_PART_FAMILY_SG | (23 << _DEVINFO_PART_FAMILYNUM_SHIFT)

systemPartFamilyUnknown = 0xFF

}

Family identifiers.

enum

SYSTEM_FpuAccess_TypeDef {

fpuAccessDenied = (0x0 << 20)

fpuAccessPrivilegedOnly = (0x5 << 20)

fpuAccessReserved = (0xA << 20)

fpuAccessFull = (0xF << 20)

}

Floating point co-processor access modes.

enum

SYSTEM_SecurityCapability_TypeDef {

securityCapabilityUnknown

securityCapabilityNA

securityCapabilityBasic

securityCapabilityRoT

securityCapabilitySE

securityCapabilityVault

}

Family security capability.

Functions#

void

SYSTEM_ChipRevisionGet(SYSTEM_ChipRevision_TypeDef *rev)

Get a chip major/minor revision.

SYSTEM_PartFamily_TypeDef

SYSTEM_GetFamily(void)

Get the MCU family identifier.

uint8_t

SYSTEM_GetDevinfoRev(void)

Get DEVINFO revision.

void

SYSTEM_FpuAccessModeSet(SYSTEM_FpuAccess_TypeDef accessMode)

Set floating point co-processor (FPU) access mode.

bool

SYSTEM_GetCalibrationValue(volatile uint32_t *regAddress)

Get a factory calibration value for a given peripheral register.

SYSTEM_SecurityCapability_TypeDef

SYSTEM_GetSecurityCapability(void)

Get family security capability.

uint64_t

SYSTEM_GetUnique(void)

Get the unique number for this device.

uint8_t

SYSTEM_GetProdRev(void)

Get the production revision for this part.

uint32_t

SYSTEM_GetSRAMBaseAddress(void)

Get the SRAM Base Address.

uint16_t

SYSTEM_GetSRAMSize(void)

Get the SRAM size (in KB).

uint16_t

SYSTEM_GetFlashSize(void)

Get the flash size (in KB).

uint32_t

SYSTEM_GetFlashPageSize(void)

Get the flash page size in bytes.

uint16_t

SYSTEM_GetPartNumber(void)

Get the MCU part number.

uint8_t

SYSTEM_GetCalibrationTemperature(void)

Get the calibration temperature (in degrees Celsius).

Enumeration Documentation#

SYSTEM_PartFamily_TypeDef#

SYSTEM_PartFamily_TypeDef

Family identifiers.

Enumerator
systemPartFamilyFlex23	EFR32 Flex Gecko Series 2 Config 3 Value Device Family.
systemPartFamilyZen23	EFR32 Zen Gecko Series 2 Config 3 Value Device Family.
systemPartFamilyEfm32Pearl23	EFM32 Pearl Gecko Series 2 Config 3 Value Device Family.
systemPartFamilySideWalk23	EFR32 Side Walk Gecko Series 2 Config 3 Value Device Family.
systemPartFamilyUnknown	Unknown Device Family.

SYSTEM_FpuAccess_TypeDef#

SYSTEM_FpuAccess_TypeDef

Floating point co-processor access modes.

Enumerator
fpuAccessDenied	Access denied, any attempted access generates a NOCP UsageFault.
fpuAccessPrivilegedOnly	Privileged access only, an unprivileged access generates a NOCP UsageFault.
fpuAccessReserved	Reserved.
fpuAccessFull	Full access.

SYSTEM_SecurityCapability_TypeDef#

SYSTEM_SecurityCapability_TypeDef

Family security capability.

Enumerator
securityCapabilityUnknown	Unknown security capability.
securityCapabilityNA	Security capability not applicable.
securityCapabilityBasic	Basic security capability.
securityCapabilityRoT	Root of Trust security capability.
securityCapabilitySE	Secure Element security capability.
securityCapabilityVault	Secure Vault security capability.

Function Documentation#

SYSTEM_ChipRevisionGet#

void SYSTEM_ChipRevisionGet (SYSTEM_ChipRevision_TypeDef * rev)

Get a chip major/minor revision.

Parameters

Type	Direction	Argument Name	Description
SYSTEM_ChipRevision_TypeDef *	[out]	rev	A location to place the chip revision information.

SYSTEM_GetFamily#

SYSTEM_PartFamily_TypeDef SYSTEM_GetFamily (void )

Get the MCU family identifier.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function retrieves family ID by reading the chip's device info structure in flash memory. Users can retrieve family ID directly by reading DEVINFO->PART item and decode with mask and shift #defines defined in <part_family>_devinfo.h (refer to code below for details).

Returns

Family identifier of MCU.

SYSTEM_GetDevinfoRev#

uint8_t SYSTEM_GetDevinfoRev (void )

Get DEVINFO revision.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Revision of the DEVINFO contents.

SYSTEM_FpuAccessModeSet#

void SYSTEM_FpuAccessModeSet (SYSTEM_FpuAccess_TypeDef accessMode)

Set floating point co-processor (FPU) access mode.

Parameters

Type	Direction	Argument Name	Description
SYSTEM_FpuAccess_TypeDef	[in]	accessMode	Floating point co-processor access mode. See SYSTEM_FpuAccess_TypeDef for details.

SYSTEM_GetCalibrationValue#

bool SYSTEM_GetCalibrationValue (volatile uint32_t * regAddress)

Get a factory calibration value for a given peripheral register.

Parameters

Type	Direction	Argument Name	Description
volatile uint32_t *	[in]	regAddress	The peripheral calibration register address to get a calibration value for. If the calibration value is found, this register is updated with the calibration value.

Returns

True if a calibration value exists, false otherwise.

SYSTEM_GetSecurityCapability#

SYSTEM_SecurityCapability_TypeDef SYSTEM_GetSecurityCapability (void )

Get family security capability.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function retrieves the family security capability based on the device number. The device number is one letter and 3 digits: DEVICENUMBER = (alpha-'A')*1000 + numeric. i.e. 0d = "A000"; 1123d = "B123". The security capabilities are represented by SYSTEM_SecurityCapability_TypeDef.

Returns

Security capability of MCU.

SYSTEM_GetUnique#

uint64_t SYSTEM_GetUnique (void )

Get the unique number for this device.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Unique number for this device.

SYSTEM_GetProdRev#

uint8_t SYSTEM_GetProdRev (void )

Get the production revision for this part.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Production revision for this part.

SYSTEM_GetSRAMBaseAddress#

uint32_t SYSTEM_GetSRAMBaseAddress (void )

Get the SRAM Base Address.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function is used to retrieve the base address of the SRAM.

Returns

Base address SRAM (32-bit unsigned integer).

SYSTEM_GetSRAMSize#

uint16_t SYSTEM_GetSRAMSize (void )

Get the SRAM size (in KB).

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function retrieves SRAM size by reading the chip device info structure. If your binary is made for one specific device only, use SRAM_SIZE instead.

Returns

Size of internal SRAM (in KB).

SYSTEM_GetFlashSize#

uint16_t SYSTEM_GetFlashSize (void )

Get the flash size (in KB).

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function retrieves flash size by reading the chip device info structure. If your binary is made for one specific device only, use FLASH_SIZE instead.

Returns

Size of internal flash (in KB).

SYSTEM_GetFlashPageSize#

uint32_t SYSTEM_GetFlashPageSize (void )

Get the flash page size in bytes.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Note

This function retrieves flash page size by reading the chip device info structure. If your binary is made for one specific device only, use FLASH_PAGE_SIZE instead.

Returns

Page size of internal flash in bytes.

SYSTEM_GetPartNumber#

uint16_t SYSTEM_GetPartNumber (void )

Get the MCU part number.

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

The part number of MCU.

SYSTEM_GetCalibrationTemperature#

uint8_t SYSTEM_GetCalibrationTemperature (void )

Get the calibration temperature (in degrees Celsius).

Parameters

Type	Direction	Argument Name	Description
void	N/A

Returns

Calibration temperature in Celsius.