Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
HeapBlockDevice Class Reference

#include <HeapBlockDevice.h>

Inheritance diagram for HeapBlockDevice:
BlockDevice

Public Member Functions

 HeapBlockDevice (bd_size_t size, bd_size_t block=512)
 
 HeapBlockDevice (bd_size_t size, bd_size_t read, bd_size_t program, bd_size_t erase)
 
virtual int init ()
 
virtual int deinit ()
 
virtual int read (void *buffer, bd_addr_t addr, bd_size_t size)
 
virtual int program (const void *buffer, bd_addr_t addr, bd_size_t size)
 
virtual int erase (bd_addr_t addr, bd_size_t size)
 
virtual bd_size_t get_read_size () const
 
virtual bd_size_t get_program_size () const
 
virtual bd_size_t get_erase_size () const
 
virtual bd_size_t get_erase_size (bd_addr_t addr) const
 
virtual bd_size_t size () const
 
- Public Member Functions inherited from BlockDevice
virtual ~BlockDevice ()
 
virtual int sync ()
 
virtual int trim (bd_addr_t addr, bd_size_t size)
 
virtual int get_erase_value () const
 
bool is_valid_read (bd_addr_t addr, bd_size_t size) const
 
bool is_valid_program (bd_addr_t addr, bd_size_t size) const
 
bool is_valid_erase (bd_addr_t addr, bd_size_t size) const
 

Detailed Description

Lazily allocated heap-backed block device

Useful for simulating a block device and tests

#include "mbed.h"
#include "HeapBlockDevice.h"
#define BLOCK_SIZE 512
HeapBlockDevice bd(2048, BLOCK_SIZE); // 2048 bytes with a block size of 512 bytes
uint8_t block[BLOCK_SIZE] = "Hello World!\n";
int main() {
bd.init();
bd.erase(0, BLOCK_SIZE);
bd.program(block, 0, BLOCK_SIZE);
bd.read(block, 0, BLOCK_SIZE);
printf("%s", block);
bd.deinit();
}

Constructor & Destructor Documentation

HeapBlockDevice::HeapBlockDevice ( bd_size_t  size,
bd_size_t  block = 512 
)

Lifetime of the memory block device

Parameters
sizeSize of the Block Device in bytes
blockBlock size in bytes. Minimum read, program, and erase sizes are configured to this value
HeapBlockDevice::HeapBlockDevice ( bd_size_t  size,
bd_size_t  read,
bd_size_t  program,
bd_size_t  erase 
)

Lifetime of the memory block device

Parameters
sizeSize of the Block Device in bytes
readMinimum read size required in bytes
programMinimum program size required in bytes
eraseMinimum erase size required in bytes

Member Function Documentation

int HeapBlockDevice::deinit ( )
virtual

Deinitialize a block device

Returns
0 on success or a negative error code on failure

Implements BlockDevice.

int HeapBlockDevice::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

Parameters
addrAddress of block to begin erasing
sizeSize to erase in bytes, must be a multiple of erase block size
Returns
0 on success, negative error code on failure

Reimplemented from BlockDevice.

bd_size_t HeapBlockDevice::get_erase_size ( ) const
virtual

Get the size of an erasable block

Returns
Size of an erasable block in bytes

Reimplemented from BlockDevice.

bd_size_t HeapBlockDevice::get_erase_size ( bd_addr_t  addr) const
virtual

Get the size of an erasable block given address

Parameters
addrAddress within the erasable block
Returns
Size of an erasable block in bytes
Note
Must be a multiple of the program size

Reimplemented from BlockDevice.

bd_size_t HeapBlockDevice::get_program_size ( ) const
virtual

Get the size of a programmable block

Returns
Size of a programmable block in bytes

Implements BlockDevice.

bd_size_t HeapBlockDevice::get_read_size ( ) const
virtual

Get the size of a readable block

Returns
Size of a readable block in bytes

Implements BlockDevice.

int HeapBlockDevice::init ( )
virtual

Initialize a block device

Returns
0 on success or a negative error code on failure

Implements BlockDevice.

int HeapBlockDevice::program ( const void *  buffer,
bd_addr_t  addr,
bd_size_t  size 
)
virtual

Program blocks to a block device

The blocks must have been erased prior to being programmed

Parameters
bufferBuffer of data to write to blocks
addrAddress of block to begin writing to
sizeSize to write in bytes, must be a multiple of program block size
Returns
0 on success, negative error code on failure

Implements BlockDevice.

int HeapBlockDevice::read ( void *  buffer,
bd_addr_t  addr,
bd_size_t  size 
)
virtual

Read blocks from a block device

Parameters
bufferBuffer to read blocks into
addrAddress of block to begin reading from
sizeSize to read in bytes, must be a multiple of read block size
Returns
0 on success, negative error code on failure

Implements BlockDevice.

bd_size_t HeapBlockDevice::size ( ) const
virtual

Get the total size of the underlying device

Returns
Size of the underlying device in bytes

Implements BlockDevice.


The documentation for this class was generated from the following files:
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.