Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

HeapBlockDevice Class Reference
Public Member Functions

HeapBlockDevice Class Reference

Lazily allocated heap-backed block device. More...

#include <HeapBlockDevice.h>

Inherits BlockDevice.

Public Member Functions

 HeapBlockDevice (bd_size_t size, bd_size_t block=512)
 Lifetime of the memory block device.
 HeapBlockDevice (bd_size_t size, bd_size_t read, bd_size_t program, bd_size_t erase)
 Lifetime of the memory block device.
virtual int init ()
 Initialize a block device.
virtual int deinit ()
 Deinitialize a block device.
virtual int read (void *buffer, bd_addr_t addr, bd_size_t size)
 Read blocks from a block device.
virtual int program (const void *buffer, bd_addr_t addr, bd_size_t size)
 Program blocks to a block device.
virtual int erase (bd_addr_t addr, bd_size_t size)
 Erase blocks on a 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 programable block.
virtual bd_size_t get_erase_size () const
 Get the size of a eraseable block.
virtual bd_size_t size () const
 Get the total size of the underlying device.
virtual int trim (bd_addr_t addr, bd_size_t size)
 Mark blocks as no longer in use.
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.

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();
 }

Definition at line 52 of file HeapBlockDevice.h.

Constructor & Destructor Documentation

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

Definition at line 20 of file HeapBlockDevice.cpp.

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

Definition at line 27 of file HeapBlockDevice.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 58 of file HeapBlockDevice.cpp.

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

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.

Definition at line 141 of file HeapBlockDevice.cpp.

bd_size_t get_erase_size (  ) const [virtual]

Get the size of a eraseable block.

Returns:
Size of a eraseable block in bytes

Reimplemented from BlockDevice.

Definition at line 78 of file HeapBlockDevice.cpp.

bd_size_t get_program_size (  ) const [virtual]

Get the size of a programable block.

Returns:
Size of a programable block in bytes

Implements BlockDevice.

Definition at line 72 of file HeapBlockDevice.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 66 of file HeapBlockDevice.cpp.

int init (  ) [virtual]

Initialize a block device.

Returns:
0 on success or a negative error code on failure

Implements BlockDevice.

Definition at line 46 of file HeapBlockDevice.cpp.

bool is_valid_erase ( bd_addr_t  addr,
bd_size_t  size 
) const [inherited]

Convenience function for checking block erase validity.

Parameters:
addrAddress of block to begin erasing
sizeSize to erase in bytes
Returns:
True if erase is valid for underlying block device

Definition at line 178 of file BlockDevice.h.

bool is_valid_program ( bd_addr_t  addr,
bd_size_t  size 
) const [inherited]

Convenience function for checking block program validity.

Parameters:
addrAddress of block to begin writing to
sizeSize to write in bytes
Returns:
True if program is valid for underlying block device

Definition at line 164 of file BlockDevice.h.

bool is_valid_read ( bd_addr_t  addr,
bd_size_t  size 
) const [inherited]

Convenience function for checking block read validity.

Parameters:
addrAddress of block to begin reading from
sizeSize to read in bytes
Returns:
True if read is valid for underlying block device

Definition at line 150 of file BlockDevice.h.

int 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.

Definition at line 114 of file HeapBlockDevice.cpp.

int 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.

Definition at line 90 of file HeapBlockDevice.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 84 of file HeapBlockDevice.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:
addrAddress of block to mark as unused
sizeSize to mark as unused in bytes, must be a multiple of erase block size
Returns:
0 on success, negative error code on failure

Definition at line 110 of file BlockDevice.h.

Generated on Sun Jul 17 2022 08:25:40 by  doxygen 1.7.2