Knight KE / Mbed OS Game_Master
Embed: (wiki syntax)

« Back to documentation index

FlashSimBlockDevice Class Reference

FlashSimBlockDevice Class Reference

Flash simulating block device. More...

#include <FlashSimBlockDevice.h>

Inherits 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 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

Flash simulating block device.

Flash simulation BD adaptor

Definition at line 36 of file FlashSimBlockDevice.h.


Constructor & Destructor Documentation

FlashSimBlockDevice ( BlockDevice bd,
uint8_t  erase_value = 0xFF 
)

Constructor.

Parameters:
bdBlock device to back the FlashSimBlockDevice
erase_valueValue stored in a block after it's erased

Definition at line 30 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 56 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:
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 124 of file FlashSimBlockDevice.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 76 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:
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.

Definition at line 81 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 146 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 71 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 66 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 42 of file FlashSimBlockDevice.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 213 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 199 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 185 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:
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 96 of file FlashSimBlockDevice.cpp.

int read ( void *  buffer,
bd_addr_t  addr,
bd_size_t  size 
) [virtual]

Read blocks from the 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 91 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 86 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 61 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:
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

Reimplemented in BufferedBlockDevice.

Definition at line 120 of file BlockDevice.h.