Mbed OS Reference
Loading...
Searching...
No Matches
FlashIAPBlockDevice Class Reference

BlockDevice using the FlashIAP API. More...

#include <FlashIAPBlockDevice.h>

Inheritance diagram for FlashIAPBlockDevice:
BlockDevice

Public Member Functions

 FlashIAPBlockDevice (uint32_t address=0xFFFFFFFF, uint32_t size=0)
 Creates a FlashIAPBlockDevice. More...
 
virtual int init ()
 Initialize a block device. More...
 
virtual int deinit ()
 Deinitialize a block device. More...
 
virtual int read (void *buffer, mbed::bd_addr_t addr, mbed::bd_size_t size)
 Read blocks from a block device. More...
 
virtual int program (const void *buffer, mbed::bd_addr_t addr, mbed::bd_size_t size)
 Program blocks to a block device. More...
 
virtual int erase (mbed::bd_addr_t addr, mbed::bd_size_t size)
 Erase blocks on a block device. More...
 
virtual mbed::bd_size_t get_read_size () const
 Get the size of a readable block. More...
 
virtual mbed::bd_size_t get_program_size () const
 Get the size of a programable block. More...
 
virtual mbed::bd_size_t get_erase_size () const
 Get the size of a eraseable block. More...
 
virtual mbed::bd_size_t get_erase_size (mbed::bd_addr_t addr) const
 Get the size of an erasable block given address. More...
 
virtual int get_erase_value () const
 Get the value of storage when erased. More...
 
virtual mbed::bd_size_t size () const
 Get the total size of the underlying device. More...
 
virtual const char * get_type () const
 Get the BlockDevice class type. More...
 
virtual bool is_valid_erase (mbed::bd_addr_t addr, mbed::bd_size_t size) const
 Convenience function for checking block erase validity. More...
 
virtual int sync ()
 Ensure data on storage is in sync with the driver. More...
 
virtual int trim (bd_addr_t addr, bd_size_t size)
 Mark blocks as no longer in use. More...
 
virtual bool is_valid_read (bd_addr_t addr, bd_size_t size) const
 Convenience function for checking block read validity. More...
 
virtual bool is_valid_program (bd_addr_t addr, bd_size_t size) const
 Convenience function for checking block program validity. More...
 

Static Public Member Functions

static BlockDeviceget_default_instance ()
 Return the default block device. More...
 

Detailed Description

BlockDevice using the FlashIAP API.

Definition at line 38 of file FlashIAPBlockDevice.h.

Constructor & Destructor Documentation

◆ FlashIAPBlockDevice()

FlashIAPBlockDevice ( uint32_t  address = 0xFFFFFFFF,
uint32_t  size = 0 
)

Creates a FlashIAPBlockDevice.

Parameters
addressPhysical address where the block device start
sizeThe block device size

Member Function Documentation

◆ init()

virtual int init ( )
virtual

Initialize a block device.

Returns
0 on success or a negative error code on failure

Implements BlockDevice.

◆ deinit()

virtual int deinit ( )
virtual

Deinitialize a block device.

Returns
0 on success or a negative error code on failure

Implements BlockDevice.

◆ read()

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

Read blocks from a block device.

Parameters
bufferBuffer to write blocks to
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.

◆ program()

virtual int program ( const void *  buffer,
mbed::bd_addr_t  addr,
mbed::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.

◆ erase()

virtual int erase ( mbed::bd_addr_t  addr,
mbed::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.

◆ get_read_size()

virtual mbed::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.

◆ get_program_size()

virtual mbed::bd_size_t get_program_size ( ) const
virtual

Get the size of a programable block.

Returns
Size of a programable block in bytes
Note
Must be a multiple of the read size

Implements BlockDevice.

◆ get_erase_size() [1/2]

virtual mbed::bd_size_t get_erase_size ( ) const
virtual

Get the size of a eraseable block.

Returns
Size of a eraseable block in bytes
Note
Must be a multiple of the program size

Reimplemented from BlockDevice.

◆ get_erase_size() [2/2]

virtual mbed::bd_size_t get_erase_size ( mbed::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.

◆ get_erase_value()

virtual int get_erase_value ( ) const
virtual

Get the value of storage when erased.

Returns
The value of storage when erased

Reimplemented from BlockDevice.

◆ size()

virtual mbed::bd_size_t size ( ) const
virtual

Get the total size of the underlying device.

Returns
Size of the underlying device in bytes

Implements BlockDevice.

◆ get_type()

virtual const char * get_type ( ) const
virtual

Get the BlockDevice class type.

Returns
A string represent the BlockDevice class type.

Implements BlockDevice.

◆ is_valid_erase()

virtual bool is_valid_erase ( mbed::bd_addr_t  addr,
mbed::bd_size_t  size 
) const
virtual

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

Reimplemented from BlockDevice.

◆ get_default_instance()

static BlockDevice * get_default_instance ( )
staticinherited

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().

◆ sync()

virtual int sync ( )
virtualinherited

Ensure data on storage is in sync with the driver.

Returns
0 on success or a negative error code on failure

Reimplemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, and SlicingBlockDevice.

Definition at line 88 of file BlockDevice.h.

◆ trim()

virtual int trim ( bd_addr_t  addr,
bd_size_t  size 
)
virtualinherited

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 the erase block size
Returns
0 on success or a negative error code on failure

Reimplemented in BufferedBlockDevice, and SDBlockDevice.

Definition at line 142 of file BlockDevice.h.

◆ is_valid_read()

virtual bool is_valid_read ( bd_addr_t  addr,
bd_size_t  size 
) const
virtualinherited

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

Reimplemented in SlicingBlockDevice.

Definition at line 207 of file BlockDevice.h.

◆ is_valid_program()

virtual bool is_valid_program ( bd_addr_t  addr,
bd_size_t  size 
) const
virtualinherited

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

Reimplemented in SlicingBlockDevice.

Definition at line 221 of file BlockDevice.h.