Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
FlashIAPBlockDevice Class Reference
BlockDevice using the FlashIAP API. More...
#include <FlashIAPBlockDevice.h>
Inherits mbed::BlockDevice.
Public Member Functions | |
FlashIAPBlockDevice (uint32_t address=MBED_CONF_FLASHIAP_BLOCK_DEVICE_BASE_ADDRESS, uint32_t size=MBED_CONF_FLASHIAP_BLOCK_DEVICE_SIZE) | |
Creates a FlashIAPBlockDevice. | |
virtual int | init () |
Initialize a block device. | |
virtual int | deinit () |
Deinitialize a block device. | |
virtual int | read (void *buffer, mbed::bd_addr_t addr, mbed::bd_size_t size) |
Read blocks from a block device. | |
virtual int | program (const void *buffer, mbed::bd_addr_t addr, mbed::bd_size_t size) |
Program blocks to a block device. | |
virtual int | erase (mbed::bd_addr_t addr, mbed::bd_size_t size) |
Erase blocks on a block device. | |
virtual mbed::bd_size_t | get_read_size () const |
Get the size of a readable block. | |
virtual mbed::bd_size_t | get_program_size () const |
Get the size of a programable block. | |
virtual mbed::bd_size_t | get_erase_size () const |
Get the size of a eraseable block. | |
virtual mbed::bd_size_t | get_erase_size (mbed::bd_addr_t addr) const |
Get the size of an erasable block given address. | |
virtual int | get_erase_value () const |
Get the value of storage when erased. | |
virtual mbed::bd_size_t | size () const |
Get the total size of the underlying device. | |
virtual const char * | get_type () const |
Get the BlockDevice class type. | |
virtual bool | is_valid_erase (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block erase validity. | |
virtual int | sync () |
Ensure data on storage is in sync with the driver. | |
virtual int | trim (bd_addr_t addr, bd_size_t size) |
Mark blocks as no longer in use. | |
virtual bool | is_valid_read (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block read validity. | |
virtual bool | is_valid_program (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block program validity. | |
virtual bool | is_valid_erase (bd_addr_t addr, bd_size_t size) const |
Convenience function for checking block erase validity. | |
Static Public Member Functions | |
static BlockDevice * | get_default_instance () |
Return the default block device. |
Detailed Description
BlockDevice using the FlashIAP API.
Definition at line 29 of file FlashIAPBlockDevice.h.
Constructor & Destructor Documentation
FlashIAPBlockDevice | ( | uint32_t | address = MBED_CONF_FLASHIAP_BLOCK_DEVICE_BASE_ADDRESS , |
uint32_t | size = MBED_CONF_FLASHIAP_BLOCK_DEVICE_SIZE |
||
) |
Creates a FlashIAPBlockDevice.
- Parameters:
-
address Physical address where the block device start size The block device size
Definition at line 39 of file FlashIAPBlockDevice.cpp.
Member Function Documentation
int deinit | ( | ) | [virtual] |
Deinitialize a block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 96 of file FlashIAPBlockDevice.cpp.
int erase | ( | mbed::bd_addr_t | addr, |
mbed::bd_size_t | size | ||
) | [virtual] |
Erase blocks on a block device.
The state of an erased block is undefined until it has been programmed
- Parameters:
-
addr Address of block to begin erasing size Size to erase in bytes, must be a multiple of erase block size
- Returns:
- 0 on success, negative error code on failure
Reimplemented from BlockDevice.
Definition at line 166 of file FlashIAPBlockDevice.cpp.
MBED_WEAK BlockDevice * get_default_instance | ( | ) | [static, inherited] |
Return the default block device.
Returns the default block device based on the configuration JSON. Use the components in target.json or application config to change the default block device.
An application can override all target settings by implementing BlockDevice::get_default_instance() - the default definition is weak, and calls get_target_default_instance().
Definition at line 63 of file SystemStorage.cpp.
bd_size_t get_erase_size | ( | ) | const [virtual] |
Get the size of a eraseable block.
- Returns:
- Size of a eraseable block in bytes
- Note:
- Must be a multiple of the program size
Reimplemented from BlockDevice.
Definition at line 207 of file FlashIAPBlockDevice.cpp.
bd_size_t get_erase_size | ( | mbed::bd_addr_t | addr ) | const [virtual] |
Get the size of an erasable block given address.
- Parameters:
-
addr Address within the erasable block
- Returns:
- Size of an erasable block in bytes
- Note:
- Must be a multiple of the program size
Reimplemented from BlockDevice.
Definition at line 220 of file FlashIAPBlockDevice.cpp.
int get_erase_value | ( | ) | const [virtual] |
Get the value of storage when erased.
- Returns:
- The value of storage when erased
Reimplemented from BlockDevice.
Definition at line 233 of file FlashIAPBlockDevice.cpp.
bd_size_t get_program_size | ( | ) | const [virtual] |
Get the size of a programable block.
- Returns:
- Size of a programable block in bytes
- Note:
- Must be a multiple of the read size
Implements BlockDevice.
Definition at line 194 of file FlashIAPBlockDevice.cpp.
bd_size_t get_read_size | ( | ) | const [virtual] |
Get the size of a readable block.
- Returns:
- Size of a readable block in bytes
Implements BlockDevice.
Definition at line 187 of file FlashIAPBlockDevice.cpp.
const char * get_type | ( | ) | const [virtual] |
Get the BlockDevice class type.
- Returns:
- A string represent the BlockDevice class type.
Implements BlockDevice.
Definition at line 254 of file FlashIAPBlockDevice.cpp.
int init | ( | ) | [virtual] |
Initialize a block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 53 of file FlashIAPBlockDevice.cpp.
virtual bool is_valid_erase | ( | bd_addr_t | addr, |
bd_size_t | size | ||
) | const [virtual, inherited] |
Convenience function for checking block erase validity.
- Parameters:
-
addr Address of block to begin erasing size Size to erase in bytes
- Returns:
- True if erase is valid for underlying block device
Reimplemented in SlicingBlockDevice.
Definition at line 229 of file BlockDevice.h.
virtual bool is_valid_erase | ( | bd_addr_t | addr, |
bd_size_t | size | ||
) | const [virtual] |
Convenience function for checking block erase validity.
- Parameters:
-
addr Address of block to begin erasing size Size to erase in bytes
- Returns:
- True if erase is valid for underlying block device
virtual bool is_valid_program | ( | bd_addr_t | addr, |
bd_size_t | size | ||
) | const [virtual, inherited] |
Convenience function for checking block program validity.
- Parameters:
-
addr Address of block to begin writing to size Size to write in bytes
- Returns:
- True if program is valid for underlying block device
Reimplemented in SlicingBlockDevice.
Definition at line 215 of file BlockDevice.h.
virtual bool is_valid_read | ( | bd_addr_t | addr, |
bd_size_t | size | ||
) | const [virtual, inherited] |
Convenience function for checking block read validity.
- Parameters:
-
addr Address of block to begin reading from size Size to read in bytes
- Returns:
- True if read is valid for underlying block device
Reimplemented in SlicingBlockDevice.
Definition at line 201 of file BlockDevice.h.
int program | ( | const void * | buffer, |
mbed::bd_addr_t | addr, | ||
mbed::bd_size_t | size | ||
) | [virtual] |
Program blocks to a block device.
The blocks must have been erased prior to being programmed
- Parameters:
-
buffer Buffer of data to write to blocks addr Address of block to begin writing to size Size to write in bytes, must be a multiple of program block size
- Returns:
- 0 on success, negative error code on failure
Implements BlockDevice.
Definition at line 140 of file FlashIAPBlockDevice.cpp.
int read | ( | void * | buffer, |
mbed::bd_addr_t | addr, | ||
mbed::bd_size_t | size | ||
) | [virtual] |
Read blocks from a block device.
- Parameters:
-
buffer Buffer to write blocks to addr Address of block to begin reading from size Size to read in bytes, must be a multiple of read block size
- Returns:
- 0 on success, negative error code on failure
Implements BlockDevice.
Definition at line 116 of file FlashIAPBlockDevice.cpp.
bd_size_t size | ( | ) | const [virtual] |
Get the total size of the underlying device.
- Returns:
- Size of the underlying device in bytes
Implements BlockDevice.
Definition at line 247 of file FlashIAPBlockDevice.cpp.
virtual int sync | ( | ) | [virtual, inherited] |
Ensure data on storage is in sync with the driver.
- Returns:
- 0 on success or a negative error code on failure
Reimplemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ProfilingBlockDevice, and SlicingBlockDevice.
Definition at line 82 of file BlockDevice.h.
virtual int trim | ( | bd_addr_t | addr, |
bd_size_t | size | ||
) | [virtual, inherited] |
Mark blocks as no longer in use.
This function provides a hint to the underlying block device that a region of blocks is no longer in use and may be erased without side effects. Erase must still be called before programming, but trimming allows flash-translation-layers to schedule erases when the device is not busy.
- Parameters:
-
addr Address of block to mark as unused size Size to mark as unused in bytes, must be a multiple of the erase block size
- Returns:
- 0 on success or a negative error code on failure
Reimplemented in SDBlockDevice, and BufferedBlockDevice.
Definition at line 136 of file BlockDevice.h.
Generated on Tue Jul 12 2022 13:55:31 by
