RTEMS: Flash Erase

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
Functions
Flash Erase
Board Support Packages » ARM » Intel Cyclone V » Contributed Code » QSPI Flash Controller Module

## Functions
ALT_STATUS_CODE | alt_qspi_erase_subsector (const uint32_t addr)
ALT_STATUS_CODE | alt_qspi_erase_sector (const uint32_t addr)
ALT_STATUS_CODE | alt_qspi_erase_chip (void)

## Detailed Description

The functions in this group are used to erase selected portions of a flash device.

## Function Documentation

## ◆ alt_qspi_erase_chip()

ALT_STATUS_CODE alt_qspi_erase_chip | ( | void |  | ) |

This function erases the entire flash device.

Return values

  ALT_E_SUCCESS | Indicates successful completion.
  ALT_E_ERROR | Indicates an error occurred.

## ◆ alt_qspi_erase_sector()

ALT_STATUS_CODE alt_qspi_erase_sector | ( | const uint32_t | addr | ) |

This function erases the designated flash device sector.

This function erases the flash device sector containing the designated flash address. Any address within the sector is valid.

Parameters

  addr | A flash address contained within the the sector to be erased.

Return values

  ALT_E_SUCCESS | Indicates successful completion.
  ALT_E_ERROR | Indicates an error occurred.

## ◆ alt_qspi_erase_subsector()

ALT_STATUS_CODE alt_qspi_erase_subsector | ( | const uint32_t | addr | ) |

This function erases the designated flash device subsector.

This function erases the flash device subsector containing the designated flash address. Any address within the subsector is valid.

Parameters

  addr | A flash address contained within the the subsector to be erased.

Return values

  ALT_E_SUCCESS | Indicates successful completion.
  ALT_E_ERROR | Indicates an error occurred.