mbed official
mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
Functions | |
| int32_t | flash_init (flash_t *obj) |
| Initialize the flash peripheral and the flash_t object. | |
| int32_t | flash_free (flash_t *obj) |
| Uninitialize the flash peripheral and the flash_t object. | |
| int32_t | flash_erase_sector (flash_t *obj, uint32_t address) |
| Erase one sector starting at defined address. | |
| int32_t | flash_read (flash_t *obj, uint32_t address, uint8_t *data, uint32_t size) |
| Read data starting at defined address. | |
| int32_t | flash_program_page (flash_t *obj, uint32_t address, const uint8_t *data, uint32_t size) |
| Program pages starting at defined address. | |
| uint32_t | flash_get_sector_size (const flash_t *obj, uint32_t address) |
| Get sector size. | |
| uint32_t | flash_get_page_size (const flash_t *obj) |
| Get page size. | |
| uint32_t | flash_get_start_address (const flash_t *obj) |
| Get start address for the flash region. | |
| uint32_t | flash_get_size (const flash_t *obj) |
| Get the flash region size. | |
| uint8_t | flash_get_erase_value (const flash_t *obj) |
| Get the flash erase value. | |
Function Documentation
| int32_t flash_erase_sector | ( | flash_t * | obj, |
| uint32_t | address | ||
| ) |
Erase one sector starting at defined address.
The address should be at sector boundary. This function does not do any check for address alignments
- Parameters:
-
obj The flash object address The sector starting address
- Returns:
- 0 for success, -1 for error
| int32_t flash_free | ( | flash_t * | obj ) |
Uninitialize the flash peripheral and the flash_t object.
- Parameters:
-
obj The flash object
- Returns:
- 0 for success, -1 for error
| uint8_t flash_get_erase_value | ( | const flash_t * | obj ) |
Get the flash erase value.
- Parameters:
-
obj The flash object
- Returns:
- The flash erase value
| uint32_t flash_get_page_size | ( | const flash_t * | obj ) |
Get page size.
The page size defines the writable page size
- Parameters:
-
obj The flash object
- Returns:
- The size of a page
| uint32_t flash_get_sector_size | ( | const flash_t * | obj, |
| uint32_t | address | ||
| ) |
Get sector size.
- Parameters:
-
obj The flash object address The sector starting address
- Returns:
- The size of a sector
| uint32_t flash_get_size | ( | const flash_t * | obj ) |
Get the flash region size.
- Parameters:
-
obj The flash object
- Returns:
- The flash region size
| uint32_t flash_get_start_address | ( | const flash_t * | obj ) |
Get start address for the flash region.
- Parameters:
-
obj The flash object
- Returns:
- The start address for the flash region
| int32_t flash_init | ( | flash_t * | obj ) |
Initialize the flash peripheral and the flash_t object.
- Parameters:
-
obj The flash object
- Returns:
- 0 for success, -1 for error
| int32_t flash_program_page | ( | flash_t * | obj, |
| uint32_t | address, | ||
| const uint8_t * | data, | ||
| uint32_t | size | ||
| ) |
Program pages starting at defined address.
The pages should not cross multiple sectors. This function does not do any check for address alignments or if size is aligned to a page size.
- Parameters:
-
obj The flash object address The sector starting address data The data buffer to be programmed size The number of bytes to program
- Returns:
- 0 for success, -1 for error
| int32_t flash_read | ( | flash_t * | obj, |
| uint32_t | address, | ||
| uint8_t * | data, | ||
| uint32_t | size | ||
| ) |
Read data starting at defined address.
This function has a WEAK implementation using memcpy for backwards compatibility.
- Parameters:
-
obj The flash object address Address to begin reading from data The buffer to read data into size The number of bytes to read
- Returns:
- 0 for success, -1 for error
Definition at line 25 of file mbed_flash_api.c.
Generated on Tue Jul 12 2022 20:41:16 by
1.7.2
