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
BufferedBlockDevice Class Reference
Block device for allowing minimal read and program sizes (of 1) for the underlying BD, using a buffer on the heap. More...
#include <BufferedBlockDevice.h>
Inherits mbed::BlockDevice.
Public Member Functions | |
| BufferedBlockDevice (BlockDevice *bd) | |
| Lifetime of a memory-buffered block device wrapping an underlying block device. | |
| virtual | ~BufferedBlockDevice () |
| Lifetime of the memory-buffered block device. | |
| virtual int | init () |
| Initialize a buffered-memory block device and its underlying block device. | |
| virtual int | deinit () |
| Deinitialize the buffered-memory block device and its underlying block device. | |
| virtual int | sync () |
| Ensure that data on the underlying storage block device is in sync with the memory-buffered block device. | |
| virtual int | read (void *buffer, bd_addr_t addr, bd_size_t size) |
| Read blocks from the memory-buffered block device. | |
| virtual int | program (const void *buffer, bd_addr_t addr, bd_size_t size) |
| Program data to the memory-buffered block device. | |
| virtual int | erase (bd_addr_t addr, bd_size_t size) |
| Erase blocks from the memory-buffered 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 |
| 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 of a given address. | |
| virtual int | get_erase_value () const |
| Get the value of storage data after being erased. | |
| virtual bd_size_t | size () const |
| Get the total size of the underlying device. | |
| virtual const char * | get_type () const |
| Get the underlying BlockDevice class type. | |
| 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. | |
Protected Member Functions | |
| int | flush () |
| Flush data in cache. | |
| void | invalidate_write_cache () |
| Invalidate write cache. | |
Detailed Description
Block device for allowing minimal read and program sizes (of 1) for the underlying BD, using a buffer on the heap.
Definition at line 36 of file BufferedBlockDevice.h.
Constructor & Destructor Documentation
| BufferedBlockDevice | ( | BlockDevice * | bd ) |
Lifetime of a memory-buffered block device wrapping an underlying block device.
- Parameters:
-
bd Block device to back the BufferedBlockDevice
Definition at line 30 of file BufferedBlockDevice.cpp.
| ~BufferedBlockDevice | ( | ) | [virtual] |
Lifetime of the memory-buffered block device.
Definition at line 37 of file BufferedBlockDevice.cpp.
Member Function Documentation
| int deinit | ( | ) | [virtual] |
Deinitialize the buffered-memory block device and its underlying block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 73 of file BufferedBlockDevice.cpp.
| int erase | ( | bd_addr_t | addr, |
| bd_size_t | size | ||
| ) | [virtual] |
Erase blocks from the memory-buffered 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 from BlockDevice.
Definition at line 272 of file BufferedBlockDevice.cpp.
| int flush | ( | ) | [protected] |
Flush data in cache.
- Returns:
- 0 on success or a negative error code on failure
Definition at line 99 of file BufferedBlockDevice.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
- Note:
- Must be a multiple of the program size
Reimplemented from BlockDevice.
Definition at line 308 of file BufferedBlockDevice.cpp.
| bd_size_t get_erase_size | ( | bd_addr_t | addr ) | const [virtual] |
Get the size of an erasable block of a 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 317 of file BufferedBlockDevice.cpp.
| int get_erase_value | ( | ) | const [virtual] |
Get the value of storage data after being 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 from BlockDevice.
Definition at line 326 of file BufferedBlockDevice.cpp.
| bd_size_t get_program_size | ( | ) | const [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
Implements BlockDevice.
Definition at line 303 of file BufferedBlockDevice.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 298 of file BufferedBlockDevice.cpp.
| const char * get_type | ( | ) | const [virtual] |
Get the underlying BlockDevice class type.
- Returns:
- A string representing the underlying BlockDevice class type
Implements BlockDevice.
Definition at line 344 of file BufferedBlockDevice.cpp.
| int init | ( | ) | [virtual] |
Initialize a buffered-memory block device and its underlying block device.
- Returns:
- 0 on success or a negative error code on failure
Implements BlockDevice.
Definition at line 42 of file BufferedBlockDevice.cpp.
| void invalidate_write_cache | ( | ) | [protected] |
| 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 data to the memory-buffered block device.
The write address blocks must be 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 197 of file BufferedBlockDevice.cpp.
| int read | ( | void * | buffer, |
| bd_addr_t | addr, | ||
| bd_size_t | size | ||
| ) | [virtual] |
Read blocks from the memory-buffered 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 136 of file BufferedBlockDevice.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 335 of file BufferedBlockDevice.cpp.
| int sync | ( | ) | [virtual] |
Ensure that data on the underlying storage block device is in sync with the memory-buffered block device.
- Returns:
- 0 on success or a negative error code on failure
Reimplemented from BlockDevice.
Definition at line 122 of file BufferedBlockDevice.cpp.
| 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 from BlockDevice.
Definition at line 285 of file BufferedBlockDevice.cpp.
Generated on Tue Jul 12 2022 13:55:43 by
1.7.2