MSC - Memory System Controller#

sl_hal_msc_status_t#

sl_hal_msc_status_t

Return codes for writing/erasing Flash.

sl_hal_msc_init#

void sl_hal_msc_init (void )

Enable MSC module.

Puts MSC hardware in a known state.

sl_hal_msc_wait_status#

SL_HAL_MSC_CODE_RAM sl_hal_msc_status_t sl_hal_msc_wait_status (uint32_t mask, uint32_t value)

Wait for a specified MSC status or timeout.

Returns

• Returns the status of a write or erase operation, sl_hal_msc_status_t SL_HAL_MSC_OK - Specified status criteria fulfilled. SL_HAL_MSC_INVALID_ADDR - Operation tried to write or erase a non-flash area. SL_HAL_MSC_LOCKED - MSC registers are locked or the operation tried to write or erase a locked area of the flash. SL_HAL_MSC_TIMEOUT - Operation timed out.

sl_hal_msc_write_burst#

SL_HAL_MSC_CODE_RAM sl_hal_msc_status_t sl_hal_msc_write_burst (uint32_t address, const uint32_t * data, uint32_t num_bytes)

Writes data to flash memory.

It is assumed that start address is word aligned and that num_bytes is an integer multiple of four, and that the write operation does not cross a flash page boundary.

Returns

• Returns the status of the write operation, sl_hal_msc_status_t SL_HAL_MSC_OK - Operation completed successfully. SL_HAL_MSC_INVALID_ADDR - Operation tried to write to a non-flash area. SL_HAL_MSC_LOCKED - MSC registers are locked or the operation tried to program a locked area of the flash. SL_HAL_MSC_TIMEOUT - Operation timed out.

sl_hal_msc_set_exec_config#

void sl_hal_msc_set_exec_config (const sl_hal_msc_exec_config_t * exec_config)

Set MSC code execution configuration.

sl_hal_msc_mass_erase#

SL_HAL_MSC_CODE_RAM sl_hal_msc_status_t sl_hal_msc_mass_erase (void )

Erase the entire Flash in one operation.

Returns

• Returns the status of the 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.

sl_hal_msc_erase_page#

SL_HAL_MSC_CODE_RAM sl_hal_msc_status_t sl_hal_msc_erase_page (uint32_t * start_address)

Erases a page in flash memory.

Returns

• Returns the status of erase operation, sl_hal_msc_status_t SL_HAL_MSC_OK - Operation completed successfully. SL_HAL_MSC_INVALID_ADDR - Operation tried to erase a non-flash area. SL_HAL_MSC_LOCKED - MSC registers are locked or the operation tried to erase a locked area of the flash. SL_HAL_MSC_TIMEOUT - Operation timed out.

sl_hal_msc_write_word#

SL_HAL_MSC_CODE_RAM sl_hal_msc_status_t sl_hal_msc_write_word (uint32_t * address, void const * data, uint32_t num_bytes)

Writes data to flash memory.

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

Returns

• Returns the status of the write operation, sl_hal_msc_status_t SL_HAL_MSC_OK - Operation completed successfully. SL_HAL_MSC_INVALID_ADDR - Operation tried to write to a non-flash area. SL_HAL_MSC_LOCKED - MSC registers are locked or the operation tried to program a locked area of the flash. SL_HAL_MSC_TIMEOUT - Operation timed out.

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.

sl_hal_msc_write_word_dma#

sl_hal_msc_status_t sl_hal_msc_write_word_dma (uint32_t channel, uint32_t * address, const void * data, uint32_t num_bytes)

Writes data to flash memory using the DMA.

Returns

• Returns the status of the write operation. SL_HAL_MSC_OK - The operation completed successfully. SL_HAL_MSC_INVALID_ADDR -The operation tried to erase a non-flash area.

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 user can use sl_clock_manager_enable_bus_clock() to enable the clock.

sl_hal_msc_is_locked#

bool sl_hal_msc_is_locked (void )

Get the status of the MSC register lock.

Returns

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

sl_hal_msc_lock#

void sl_hal_msc_lock (void )

Set the MSC register lock to a locked state.

sl_hal_msc_unlock#

void sl_hal_msc_unlock (void )

Set the MSC register lock to an unlocked state.

sl_hal_msc_set_readctrl#

void sl_hal_msc_set_readctrl (uint32_t value)

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

sl_hal_msc_get_readctrl#

uint32_t sl_hal_msc_get_readctrl (void )

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

Returns

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

sl_hal_msc_lock_page#

void sl_hal_msc_lock_page (uint32_t page_number)

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

sl_hal_msc_page_is_locked#

bool sl_hal_msc_page_is_locked (uint32_t page_number)

Get the value of the lockbit for a flash page.

Returns

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

sl_hal_msc_get_size_userdata#

uint32_t sl_hal_msc_get_size_userdata (void )

Get the size of the user data region in flash.

Returns

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

sl_hal_msc_set_misc_lock_word#

void sl_hal_msc_set_misc_lock_word (uint32_t value)

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

sl_hal_msc_get_misc_lock_word#

uint32_t sl_hal_msc_get_misc_lock_word (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.

sl_hal_msc_enable_interrupts#

void sl_hal_msc_enable_interrupts (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 sl_hal_msc_clear_interrupts() prior to enabling the interrupt.

sl_hal_msc_disable_interrupts#

void sl_hal_msc_disable_interrupts (uint32_t flags)

Disable one or more MSC interrupts.

sl_hal_msc_set_pending_interrupts#

void sl_hal_msc_set_pending_interrupts (uint32_t flags)

Set one or more pending MSC interrupts from SW.

sl_hal_msc_clear_interrupts#

void sl_hal_msc_clear_interrupts (uint32_t flags)

Clear one or more pending MSC interrupts.

sl_hal_msc_get_pending_interrupts#

uint32_t sl_hal_msc_get_pending_interrupts (void )

Get pending MSC interrupt flags.

Returns

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

Note

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

sl_hal_msc_get_enabled_pending_interrupts#

uint32_t sl_hal_msc_get_enabled_pending_interrupts (void )

Get enabled and pending MSC interrupt flags.

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

Note

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