MSC - Memory System Controller

Get the status of the MSC register lock.

Returns

Boolean true if register lock is applied, false otherwise.

Set the MSC register lock to a locked state.

Set the MSC register lock to an unlocked state.

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

Returns

The 32-bit value read from the MSC_READCTRL register.

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

Parameters

[in]

value

The 32-bit value to write to the MSC_READCTRL register.

Clear one or more pending MSC interrupts.

Parameters

[in]

flags

Pending MSC interrupt source to clear. Use a bitwise logic OR combination of valid interrupt flags for the MSC module (MSC_IF_nnn).

Disable one or more MSC interrupts.

Parameters

[in]

flags

MSC interrupt sources to disable. Use a bitwise logic OR combination of valid interrupt flags for the MSC module (MSC_IF_nnn).

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.

Parameters

[in]

flags

MSC interrupt sources to enable. Use a bitwise logic OR combination of valid interrupt flags for the MSC module (MSC_IF_nnn).

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

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

Set one or more pending MSC interrupts from SW.

Parameters

[in]

flags

MSC interrupt sources to set to pending. Use a bitwise logic OR combination of valid interrupt flags for the MSC module (MSC_IF_nnn).

Start measuring the cache hit ratio.

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

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.

Flush contents of instruction cache.

Enable or disable instruction cache functionality.

Parameters

[in]

enable

Enable instruction cache. Default is on.

Enable or disable instruction cache functionality in IRQs.

Parameters

[in]

enable

Enable instruction cache. Default is on.

Enable or disable instruction cache flushing when writing to flash.

Parameters

[in]

enable

Enable automatic cache flushing. Default is on.

Configure which unit should get priority on system bus.

Parameters

[in]

mode

Unit to prioritize bus accesses for.

Set the MSC code execution configuration.

Parameters

[in]

execConfig

The code execution configuration.

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.

Warning

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.

Parameters

[in]	address	A pointer to the flash word to write to. Must be aligned to words.
[in]	data	Data to write to flash.
[in]	numBytes	A number of bytes to write from the Flash. NB: Must be divisible by four.

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

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.

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.

Parameters

[in]

startAddress

A pointer to the flash page to erase. Must be aligned to the beginning of the page boundary.

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

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.

Parameters

[in]	address	A pointer to the flash word to write to. Must be aligned to words.
[in]	data	Data to write to flash.
[in]	numBytes	A number of bytes to write from flash. NB: Must be divisible by four.

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

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.

Disables the flash controller for writing.

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.

Default MSC ExecConfig initialization.

Return codes for writing/erasing Flash.

Strategy for prioritized bus access.