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 {
systemPartFamilyFlex28 = DEVINFO_PART_FAMILY_FG | (28 << _DEVINFO_PART_FAMILYNUM_SHIFT)
systemPartFamilyZen28 = DEVINFO_PART_FAMILY_ZG | (28 << _DEVINFO_PART_FAMILYNUM_SHIFT)
systemPartFamilySideWalk28 = DEVINFO_PART_FAMILY_SG | (28 << _DEVINFO_PART_FAMILYNUM_SHIFT)
systemPartFamilyEfm32Pearl28 = DEVINFO_PART_FAMILY_PG | (28 << _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.

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
systemPartFamilyFlex28

EFR32 Flex Gecko Series 2 Config 8 Value Device Family.

systemPartFamilyZen28

EFR32 Zen Gecko Series 2 Config 8 Value Device Family.

systemPartFamilySideWalk28

EFR32 Side Walk Gecko Series 2 Config 8 Value Device Family.

systemPartFamilyEfm32Pearl28

EFM32 Pearl Gecko Series 2 Config 8 Value Device Family.

systemPartFamilyUnknown

Unknown Device Family.


Definition at line 57 of file platform/emlib/inc/em_system.h

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.


Definition at line 310 of file platform/emlib/inc/em_system.h

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.


Definition at line 50 of file platform/emlib/inc/em_system_generic.h

Function Documentation#

SYSTEM_ChipRevisionGet#

void SYSTEM_ChipRevisionGet (SYSTEM_ChipRevision_TypeDef * rev)

Get a chip major/minor revision.

Parameters
[out]rev

A location to place the chip revision information.


Definition at line 69 of file platform/emlib/src/em_system.c

SYSTEM_GetFamily#

SYSTEM_PartFamily_TypeDef SYSTEM_GetFamily (void )

Get the MCU family identifier.

Parameters
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.


Definition at line 418 of file platform/emlib/src/em_system.c

SYSTEM_GetDevinfoRev#

uint8_t SYSTEM_GetDevinfoRev (void )

Get DEVINFO revision.

Parameters
N/A

Returns

  • Revision of the DEVINFO contents.


Definition at line 333 of file platform/emlib/inc/em_system.h

SYSTEM_FpuAccessModeSet#

void SYSTEM_FpuAccessModeSet (SYSTEM_FpuAccess_TypeDef accessMode)

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

Parameters
[in]accessMode

Floating point co-processor access mode. See SYSTEM_FpuAccess_TypeDef for details.


Definition at line 354 of file platform/emlib/inc/em_system.h

SYSTEM_GetCalibrationValue#

bool SYSTEM_GetCalibrationValue (volatile uint32_t * regAddress)

Get a factory calibration value for a given peripheral register.

Parameters
[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.


Definition at line 120 of file platform/emlib/src/em_system.c

SYSTEM_GetSecurityCapability#

SYSTEM_SecurityCapability_TypeDef SYSTEM_GetSecurityCapability (void )

Get family security capability.

Parameters
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.


Definition at line 162 of file platform/emlib/src/em_system.c

SYSTEM_GetUnique#

uint64_t SYSTEM_GetUnique (void )

Get the unique number for this device.

Parameters
N/A

Returns

  • Unique number for this device.


Definition at line 213 of file platform/emlib/src/em_system.c

SYSTEM_GetProdRev#

uint8_t SYSTEM_GetProdRev (void )

Get the production revision for this part.

Parameters
N/A

Returns

  • Production revision for this part.


Definition at line 233 of file platform/emlib/src/em_system.c

SYSTEM_GetSRAMBaseAddress#

uint32_t SYSTEM_GetSRAMBaseAddress (void )

Get the SRAM Base Address.

Parameters
N/A

Note

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

Returns

  • Base address SRAM (32-bit unsigned integer).


Definition at line 256 of file platform/emlib/src/em_system.c

SYSTEM_GetSRAMSize#

uint16_t SYSTEM_GetSRAMSize (void )

Get the SRAM size (in KB).

Parameters
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).


Definition at line 273 of file platform/emlib/src/em_system.c

SYSTEM_GetFlashSize#

uint16_t SYSTEM_GetFlashSize (void )

Get the flash size (in KB).

Parameters
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).


Definition at line 307 of file platform/emlib/src/em_system.c

SYSTEM_GetFlashPageSize#

uint32_t SYSTEM_GetFlashPageSize (void )

Get the flash page size in bytes.

Parameters
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.


Definition at line 332 of file platform/emlib/src/em_system.c

SYSTEM_GetPartNumber#

uint16_t SYSTEM_GetPartNumber (void )

Get the MCU part number.

Parameters
N/A

Returns

  • The part number of MCU.


Definition at line 371 of file platform/emlib/src/em_system.c

SYSTEM_GetCalibrationTemperature#

uint8_t SYSTEM_GetCalibrationTemperature (void )

Get the calibration temperature (in degrees Celsius).

Parameters
N/A

Returns

  • Calibration temperature in Celsius.


Definition at line 391 of file platform/emlib/src/em_system.c