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
FlashSimBlockDevice Class Reference
Flash simulating block device. More...
#include <FlashSimBlockDevice.h>
Inherits mbed::BlockDevice.
Public Member Functions | |
| FlashSimBlockDevice (BlockDevice *bd, uint8_t erase_value=0xFF) | |
| Constructor. | |
| virtual int | init () |
| Initialize a block device. | |
| virtual int | deinit () |
| Deinitialize the 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) |
| Read blocks from the block device. | |
| virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size) |
| Program blocks to the block device. | |
| virtual int | erase (bd_addr_t addr, bd_size_t size) |
| Erase blocks on the block device. | |
| virtual bd_size_t | get_read_size () const |
| Get the size of a readable block. | |
| virtual bd_size_t | get_program_size () const |
| 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 |
| Get the total size of the underlying device. | |
| virtual const char * | get_type () const |
| Get the BlockDevice class type. | |
| 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
Flash simulating block device.
Flash simulation BD adaptor
Definition at line 42 of file FlashSimBlockDevice.h.
Constructor & Destructor Documentation
| FlashSimBlockDevice | ( | BlockDevice * | bd, |
| uint8_t | erase_value = 0xFF |
||
| ) |
Constructor.
- Parameters:
-
bd Block device to back the FlashSimBlockDevice erase_value Value stored in a block after it's erased
Definition at line 34 of file FlashSimBlockDevice.cpp.
Member Function Documentation
| int deinit | ( | ) | [virtual] |
Deinitialize the block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 75 of file FlashSimBlockDevice.cpp.
| int erase | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | [virtual] |
Erase blocks on the block device.
Required before any write to these addresses
- 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 186 of file FlashSimBlockDevice.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 an erasable block.
- Returns:
- Size of an erasable block in bytes
Reimplemented from BlockDevice.
Definition at line 118 of file FlashSimBlockDevice.cpp.
| 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 from BlockDevice.
Definition at line 127 of file FlashSimBlockDevice.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 212 of file FlashSimBlockDevice.cpp.
| bd_size_t get_program_size | ( | ) | const [virtual] |
Get the size of a programmable block.
- Returns:
- Size of a programmable block in bytes
Implements BlockDevice.
Definition at line 109 of file FlashSimBlockDevice.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 100 of file FlashSimBlockDevice.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 217 of file FlashSimBlockDevice.cpp.
| int init | ( | ) | [virtual] |
Initialize a block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 47 of file FlashSimBlockDevice.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_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, |
| bd_addr_t | addr, | ||
| bd_size_t | size | ||
| ) | [virtual] |
Program blocks to the 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 154 of file FlashSimBlockDevice.cpp.
| int read | ( | void * | buffer, |
| bd_addr_t | addr, | ||
| bd_size_t | size | ||
| ) | [virtual] |
Read blocks from the block device.
- Parameters:
-
buffer Buffer to read blocks into 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 145 of file FlashSimBlockDevice.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 136 of file FlashSimBlockDevice.cpp.
| 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 from BlockDevice.
Definition at line 91 of file FlashSimBlockDevice.cpp.
| 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:43 by
1.7.2