MSC - Memory System Controller#

MSC_Status_TypeDef#

MSC_Status_TypeDef

Return codes for writing/erasing Flash.

MSC_Init#

void MSC_Init (void )

Enables the flash controller for writing.

Note

• This function must be called before flash operations when AUXHFRCO clock has been changed from a default band.

MSC_Deinit#

void MSC_Deinit (void )

Disables the flash controller for writing.

MSC_ExecConfigSet#

void MSC_ExecConfigSet (MSC_ExecConfig_TypeDef * execConfig)

Set the MSC code execution configuration.

MSC_ErasePage#

MSC_RAMFUNC_DECLARATOR MSC_Status_TypeDef MSC_ErasePage (uint32_t * startAddress)

Erases a page in flash memory.

Note

• For the Gecko family, it is required to run this function from RAM.

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

Returns

• Returns the status of erase operation, MSC_Status_TypeDef

  *   mscReturnOk - The operation completed successfully.
  *   mscReturnInvalidAddr - The operation tried to erase a non-flash area.
  *   mscReturnLocked - The operation tried to erase a locked area of the flash.
  *   mscReturnTimeOut - The operation timed out waiting for the flash operation
  *       to complete.
  * 

MSC_WriteWord#

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

Writes data to flash memory.

This function is interrupt-safe, but slower than MSC_WriteWordFast(), which writes to flash with interrupts disabled. 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 the Gecko family, it is required to run this function from RAM.

For IAR Embedded Workbench, Simplicity Studio and GCC, this is done automatically by using attributes in the function proctype. For Keil uVision IDE, define a section called "ram_code" and place it manually in the project's scatter file.

This function requires a system core clock at 1 MHz or higher.

Returns

• Returns the status of the write operation.

  *   flashReturnOk - The operation completed successfully.
  *   flashReturnInvalidAddr - The operation tried to erase a non-flash area.
  *   flashReturnLocked - The operation tried to erase a locked area of the Flash.
  *   flashReturnTimeOut - The operation timed out waiting for the flash operation
  *       to complete, or the MSC module timed out waiting for the software to write
  *       the next word into the DWORD register.
  * 

MSC_WriteWordFast#

MSC_RAMFUNC_DECLARATOR MSC_Status_TypeDef MSC_WriteWordFast (uint32_t * address, void const * data, uint32_t numBytes)

Writes data to flash memory.

This function is faster than MSC_WriteWord(), but it disables interrupts. Write data must be aligned to words and contain a number of bytes that is divisible by four. Warnings

• This function is only available for certain devices.

Note

• It is recommended to erase the flash page before performing a write. It is required to run this function from RAM on parts that include a flash write buffer.

For IAR Embedded Workbench, Simplicity Studio and GCC, this is done automatically by using attributes in the function proctype. For Keil uVision IDE, define a section called "ram_code" and place this manually in the project's scatter file.

Returns

• Returns the status of the write operation.

  *   flashReturnOk - The operation completed successfully.
  *   flashReturnInvalidAddr - The operation tried to erase a non-flash area.
  *   flashReturnLocked - The operation tried to erase a locked area of the flash.
  *   flashReturnTimeOut - The operation timed out waiting for flash operation
  *       to complete. Or the MSC timed out waiting for the software to write
  *       the next word into the DWORD register.
  * 

MSC_WriteWordDma#

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

Writes data from RAM 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 this function only supports writing data from RAM to flash, it does not support writing data from flash to flash.

Note

• This function requires that the LDMA 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_MassErase#

SL_RAMFUNC_DECLARATOR 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_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_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_StartCacheMeasurement#

void MSC_StartCacheMeasurement (void )

Start measuring the cache hit ratio.

Starts performance counters. It is defined inline to minimize the impact of this code on the measurement itself.

MSC_GetCacheMeasurement#

int32_t MSC_GetCacheMeasurement (void )

Stop measuring the hit rate.

Note

• Defined inline to minimize the impact of this code on the measurement itself. Only works for relatively short sections of code. To measure longer sections of code, implement an IRQ Handler for the CHOF and CMOF overflow interrupts. These overflows need to be counted and included in the total. Functions can then be implemented as follows:

  * volatile uint32_t hitOverflows
  * volatile uint32_t missOverflows
  *
  * void MSC_IRQHandler(void)
  * {
  *   uint32_t flags;
  *   flags = MSC->IF;
  *   if (flags & MSC_IF_CHOF) {
  *      MSC->IFC = MSC_IF_CHOF;
  *      hitOverflows++;
  *   }
  *   if (flags & MSC_IF_CMOF) {
  *     MSC->IFC = MSC_IF_CMOF;
  *     missOverflows++;
  *   }
  * }
  *
  * void startPerformanceCounters(void)
  * {
  *   hitOverflows = 0;
  *   missOverflows = 0;
  *
  *   MSC_IntEnable(MSC_IF_CHOF | MSC_IF_CMOF);
  *   NVIC_EnableIRQ(MSC_IRQn);
  *
  *   MSC_StartCacheMeasurement();
  * }
  * 

Returns

• Returns -1 if there has been no cache accesses. Returns -2 if there has been an overflow in the performance counters. If not, it will return the percentage of hits versus misses.

MSC_FlushCache#

void MSC_FlushCache (void )

Flush contents of instruction cache.

MSC_EnableCache#

void MSC_EnableCache (bool enable)

Enable or disable instruction cache functionality.

MSC_EnableCacheIRQs#

void MSC_EnableCacheIRQs (bool enable)

Enable or disable instruction cache functionality in IRQs.

MSC_EnableAutoCacheFlush#

void MSC_EnableAutoCacheFlush (bool enable)

Enable or disable instruction cache flushing when writing to flash.

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.