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.
BlockDevice Class Reference
A hardware device capable of writing and reading blocks. More...
#include <BlockDevice.h>
Inherited by BufferedBlockDevice, ChainingBlockDevice, DataFlashBlockDevice, ExhaustibleBlockDevice, FlashIAPBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SDBlockDevice, SlicingBlockDevice, SPIFBlockDevice, and USBHostMSD.
Public Member Functions | |
| virtual | ~BlockDevice () |
| Lifetime of a block device. | |
| virtual int | init ()=0 |
| Initialize a block device. | |
| virtual int | deinit ()=0 |
| Deinitialize a block device. | |
| virtual int | sync () |
| Ensure data on storage is in sync with the driver. | |
| virtual int | read (void *buffer, bd_addr_t addr, bd_size_t size)=0 |
| Read blocks from a block device. | |
| virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size)=0 |
| Program blocks to a block device. | |
| virtual int | erase (bd_addr_t addr, bd_size_t size) |
| Erase blocks on a block device. | |
| virtual int | trim (bd_addr_t addr, bd_size_t size) |
| Mark blocks as no longer in use. | |
| virtual bd_size_t | get_read_size () const =0 |
| Get the size of a readable block. | |
| virtual bd_size_t | get_program_size () const =0 |
| Get the size of a programmable block. | |
| virtual bd_size_t | get_erase_size () const |
| Get the size of an erasable block. | |
| virtual bd_size_t | get_erase_size (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 bd_size_t | size () const =0 |
| Get the total size of the underlying device. | |
| bool | is_valid_read (bd_addr_t addr, bd_size_t size) const |
| Convenience function for checking block read validity. | |
| bool | is_valid_program (bd_addr_t addr, bd_size_t size) const |
| Convenience function for checking block program validity. | |
| 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
A hardware device capable of writing and reading blocks.
Definition at line 43 of file BlockDevice.h.
Constructor & Destructor Documentation
| virtual ~BlockDevice | ( | ) | [virtual] |
Lifetime of a block device.
Definition at line 61 of file BlockDevice.h.
Member Function Documentation
| virtual int deinit | ( | ) | [pure virtual] |
Deinitialize a block device.
- Returns:
- 0 on success or a negative error code on failure
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual int erase | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | [virtual] |
Erase blocks on a block device.
The state of an erased block is undefined until it has been programmed, unless get_erase_value returns a non-negative byte value
- 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 in DataFlashBlockDevice, FlashIAPBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
Definition at line 117 of file BlockDevice.h.
| MBED_WEAK BlockDevice * get_default_instance | ( | ) | [static] |
Return the default block device.
Returns the default BlockDevice base on 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() themselves - the default definition is weak, and calls get_target_default_instance().
Definition at line 35 of file SystemStorage.cpp.
| virtual bd_size_t get_erase_size | ( | ) | const [virtual] |
Get the size of an erasable block.
- Returns:
- Size of an erasable block in bytes
- Note:
- Must be a multiple of the program size
Reimplemented in DataFlashBlockDevice, FlashIAPBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
Definition at line 156 of file BlockDevice.h.
| virtual bd_size_t get_erase_size | ( | 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 in DataFlashBlockDevice, FlashIAPBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, and SlicingBlockDevice.
Definition at line 167 of file BlockDevice.h.
| virtual int get_erase_value | ( | ) | const [virtual] |
Get the value of storage when erased.
If get_erase_value returns a non-negative byte value, the underlying storage is set to that value when erased, and storage containing that value can be programmed without another erase.
- Returns:
- The value of storage when erased, or -1 if you can't rely on the value of erased storage
Reimplemented in SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ProfilingBlockDevice, and SlicingBlockDevice.
Definition at line 181 of file BlockDevice.h.
| virtual bd_size_t get_program_size | ( | ) | const [pure virtual] |
Get the size of a programmable block.
- Returns:
- Size of a programmable block in bytes
- Note:
- Must be a multiple of the read size
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual bd_size_t get_read_size | ( | ) | const [pure virtual] |
Get the size of a readable block.
- Returns:
- Size of a readable block in bytes
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual int init | ( | ) | [pure virtual] |
Initialize a block device.
- Returns:
- 0 on success or a negative error code on failure
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| bool is_valid_erase | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | const |
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
Definition at line 226 of file BlockDevice.h.
| bool is_valid_program | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | const |
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
Definition at line 212 of file BlockDevice.h.
| bool is_valid_read | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | const |
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
Definition at line 198 of file BlockDevice.h.
| virtual int program | ( | const void * | buffer, |
| bd_addr_t | addr, | ||
| bd_size_t | size | ||
| ) | [pure virtual] |
Program blocks to a block device.
The blocks must have been erased prior to being programmed
If a failure occurs, it is not possible to determine how many bytes succeeded
- 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
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual int read | ( | void * | buffer, |
| bd_addr_t | addr, | ||
| bd_size_t | size | ||
| ) | [pure virtual] |
Read blocks from a block device.
If a failure occurs, it is not possible to determine how many bytes succeeded
- 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
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual bd_size_t size | ( | ) | const [pure virtual] |
Get the total size of the underlying device.
- Returns:
- Size of the underlying device in bytes
Implemented in DataFlashBlockDevice, FlashIAPBlockDevice, SDBlockDevice, SPIFBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, SlicingBlockDevice, and USBHostMSD.
| virtual int sync | ( | ) | [virtual] |
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 79 of file BlockDevice.h.
| virtual int trim | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | [virtual] |
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 erase block size
- Returns:
- 0 on success, negative error code on failure
Reimplemented in SDBlockDevice, and BufferedBlockDevice.
Definition at line 133 of file BlockDevice.h.
Generated on Tue Aug 9 2022 00:37:33 by
1.7.2