MSC - Memory System Controller#

MSC_Status_TypeDef#

MSC_Status_TypeDef

Return codes for writing/erasing Flash.

MSC_LockGetLocked#

bool MSC_LockGetLocked (void )

Get the status of the MSC register lock.

Returns

• Boolean true if register lock is applied, false otherwise.

MSC_LockSetLocked#

void MSC_LockSetLocked (void )

Set the MSC register lock to a locked state.

MSC_LockSetUnlocked#

void MSC_LockSetUnlocked (void )

Set the MSC register lock to an unlocked state.

MSC_ReadCTRLGet#

uint32_t MSC_ReadCTRLGet (void )

Get the current value of the read control register (MSC_READCTRL).

Returns

• The 32-bit value read from the MSC_READCTRL register.

MSC_ReadCTRLSet#

void MSC_ReadCTRLSet (uint32_t value)

Write a value to the read control register (MSC_READCTRL).

MSC_PageLockSetLocked#

void MSC_PageLockSetLocked (uint32_t page_number)

Set the lockbit for a flash page in order to prevent page writes/erases to the corresponding page.

MSC_PageLockGetLocked#

bool MSC_PageLockGetLocked (uint32_t page_number)

Get the value of the lockbit for a flash page.

Returns

• Boolean true if the page is locked, false otherwise.

MSC_UserDataGetSize#

uint32_t MSC_UserDataGetSize (void )

Get the size of the user data region in flash.

Returns

• The size of the user data region divided by 256.

MSC_MiscLockWordGet#

uint32_t MSC_MiscLockWordGet (void )

Get the current value of the mass erase and user data page lock word (MSC_MISCLOCKWORD).

Returns

• The 32-bit value read from the MSC_MISCLOCKWORD register.

MSC_MiscLockWordSet#

void MSC_MiscLockWordSet (uint32_t value)

Write a value to the mass erase and user data page lock word (MSC_MISCLOCKWORD).

MSC_IntClear#

void MSC_IntClear (uint32_t flags)

Clear one or more pending MSC interrupts.

MSC_IntDisable#

void MSC_IntDisable (uint32_t flags)

Disable one or more MSC interrupts.

MSC_IntEnable#

void MSC_IntEnable (uint32_t flags)

Enable one or more MSC 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 MSC_IntClear() prior to enabling the interrupt.

MSC_IntGet#

uint32_t MSC_IntGet (void )

Get pending MSC interrupt flags.

Note

• The event bits are not cleared by the use of this function.

Returns

• MSC interrupt sources pending. A bitwise logic OR combination of valid interrupt flags for the MSC module (MSC_IF_nnn).

MSC_IntGetEnabled#

uint32_t MSC_IntGetEnabled (void )

Get enabled and pending MSC interrupt flags.

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

Note

• Interrupt flags are not cleared by the use of this function.

Returns

• Pending and enabled MSC interrupt sources. The return value is the bitwise AND of

  • the enabled interrupt sources in MSC_IEN and

  • the pending interrupt flags MSC_IF

MSC_IntSet#

void MSC_IntSet (uint32_t flags)

Set one or more pending MSC interrupts from SW.

MSC_ExecConfigSet#

void MSC_ExecConfigSet (MSC_ExecConfig_TypeDef * execConfig)

Set MSC code execution configuration.

MSC_EccConfigSet#

void MSC_EccConfigSet (MSC_EccConfig_TypeDef * eccConfig)

Configure Error Correcting Code (ECC).

This function configures ECC support according to the configuration input parameter. If the user requests enabling ECC for a given RAM bank this function will initialize ECC memory (syndromes) for the bank by reading and writing the existing values in memory. I.e. all data is preserved. The initialization process runs in a critical section disallowing interrupts and thread scheduling, and will consume a considerable amount of clock cycles. Therefore the user should carefully assess where to call this function. The user can consider to increase the clock frequency in order to reduce the execution time. This function makes use of 2 DMA channels to move data to/from RAM in an efficient way. The user can select which 2 DMA channels to use in order to avoid conflicts with the application. However the user must make sure that no other DMA operations takes place while this function is executing. If the application has been using the DMA controller prior to calling this function, the application will need to reinitialize DMA registers after this function has completed.

Note

• This function protects the ECC initialization procedure from interrupts and other threads by using a critical section (defined by em_core.h) When running on RTOS the user may need to override CORE_EnterCritical CORE_ExitCritical which are declared as 'SL_WEAK' in em_core.c.

MSC_MassErase#

MSC_RAMFUNC_DEFINITION_END MSC_RAMFUNC_DEFINITION_BEGIN MSC_Status_TypeDef MSC_MassErase (void )

Erase the entire Flash in one operation.

Note

• This command will erase the entire contents of the device. Use with care, both a debug session and all contents of the flash will be lost. The lock bit, MLW will prevent this operation from executing and might prevent a successful mass erase.

Returns

• Returns the status of the operation.

MSC_ErasePage#

MSC_RAMFUNC_DEFINITION_BEGIN MSC_Status_TypeDef MSC_ErasePage (uint32_t * startAddress)

Erases a page in flash memory.

For IAR Embedded Workbench, Simplicity Studio and GCC this will be achieved automatically by using attributes in the function proctype. For Keil uVision you must define a section called "ram_code" and place this manually in your project's scatter file.

Returns

• Returns the status of erase operation, MSC_Status_TypeDef

  *   mscReturnOk - Operation completed successfully.
  *   mscReturnInvalidAddr - Operation tried to erase a non-flash area.
  *   flashReturnLocked - MSC registers are locked or the operation tried to
  *                       erase a locked area of the flash.
  *   flashReturnTimeOut - Operation timed out.
  * 

MSC_WriteWord#

MSC_RAMFUNC_DEFINITION_END MSC_RAMFUNC_DEFINITION_BEGIN MSC_Status_TypeDef MSC_WriteWord (uint32_t * address, void const * data, uint32_t numBytes)

Writes data to flash memory.

Write data must be aligned to words and contain a number of bytes that is divisible by four. Note

• It is recommended to erase the flash page before performing a write.

For IAR Embedded Workbench, Simplicity Studio and GCC this will be achieved automatically by using attributes in the function proctype. For Keil uVision you must define a section called "ram_code" and place this manually in your project's scatter file.

The Flash memory is organized into 64-bit wide double-words. Each 64-bit double-word can be written only twice using burst write operation between erasing cycles. The user's application must store data in RAM to sustain burst write operation.

EFR32XG21 RevC is not able to program every word twice before the next erase.

Returns

• Returns the status of the write operation, MSC_Status_TypeDef

  *   flashReturnOk - Operation completed successfully.
  *   flashReturnInvalidAddr - Operation tried to write to a non-flash area.
  *   flashReturnLocked - MSC registers are locked or the operation tried to
  *                       program a locked area of the flash.
  *   flashReturnTimeOut - Operation timed out.
  * 

MSC_WriteWordDma#

MSC_RAMFUNC_DEFINITION_END MSC_Status_TypeDef MSC_WriteWordDma (int ch, uint32_t * address, const void * data, uint32_t numBytes)

Writes data to flash memory using the DMA.

This function uses the LDMA to write data to the internal flash memory. This is the fastest way to write data to the flash and should be used when the application wants to achieve write speeds like they are reported in the datasheet. Note that copying data from flash to flash will be slower than copying from RAM to flash. So the source data must be in RAM in order to see the write speeds similar to the datasheet numbers.

Note

• This function requires that the LDMA and LDMAXBAR clock is enabled.

Returns

• Returns the status of the write operation.

  *   flashReturnOk - The operation completed successfully.
  *   flashReturnInvalidAddr - The operation tried to erase a non-flash area.
  * 

MSC_Init#

void MSC_Init (void )

Initialize MSC module.

Puts MSC hw in a known state.

MSC_Deinit#

void MSC_Deinit (void )

Turn off MSC flash write enable and lock MSC registers.

mscEccReadWriteExistingPio#

static void mscEccReadWriteExistingPio (const MSC_EccBank_Typedef * eccBank)

Read and write existing values in RAM (for ECC initialization).

This function uses core to load and store the existing data values in the given RAM bank.

mscEccBankInit#

static void mscEccBankInit (const MSC_EccBank_Typedef * eccBank, uint32_t dmaChannels)

Initialize ECC for a given memory bank.

This function initializes ECC for a given memory bank which is specified with the MSC_EccBank_Typedef structure input parameter.

mscEccBankDisable#

static void mscEccBankDisable (const MSC_EccBank_Typedef * eccBank)

Disable ECC for a given memory bank.

This function disables ECC for a given memory bank which is specified with the MSC_EccBank_Typedef structure input parameter.

MSC_PROGRAM_TIMEOUT#

#define MSC_PROGRAM_TIMEOUT

10000000UL

Timeout used while waiting for Flash to become ready after a write.

This number indicates the number of iterations to perform before issuing a timeout.

Note

• Timeout is set very large (in the order of 100x longer than necessary). This is to avoid any corner case.

MSC_EXECCONFIG_DEFAULT#

#define MSC_EXECCONFIG_DEFAULT

Default MSC ExecConfig initialization.

MSC_ECC_BANKS#

#define MSC_ECC_BANKS

(1)

Series 2 chips incorporate 1 memory bank including ECC support.

MSC_ECCCONFIG_DEFAULT#

#define MSC_ECCCONFIG_DEFAULT

Default MSC EccConfig initialization.