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

BlockDevice for SFDP based flash devices over SPI bus. More...

#include <SPIFBlockDevice.h>

Inheritance diagram for SPIFBlockDevice:
BlockDevice

Public Member Functions

 SPIFBlockDevice (PinName mosi, PinName miso, PinName sclk, PinName csel, int freq=40000000)
 Creates a SPIFBlockDevice on a SPI bus specified by pins. More...
 
virtual int init ()
 Initialize a block device. More...
 
virtual int deinit ()
 Deinitialize a block device. More...
 
 ~SPIFBlockDevice ()
 Desctruct SPIFBlockDevice. 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 an erasable block. More...
 
virtual mbed::bd_size_t get_erase_size (mbed::bd_addr_t addr)
 Get the size of minimal erasable sector size of given address. More...
 
virtual int get_erase_value () const
 Get the value of storage byte after it was 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 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 bd_size_t get_erase_size (bd_addr_t addr) const
 Get the size of an erasable block given address. More...
 
bool is_valid_read (bd_addr_t addr, bd_size_t size) const
 Convenience function for checking block read validity. More...
 
bool is_valid_program (bd_addr_t addr, bd_size_t size) const
 Convenience function for checking block program validity. More...
 
bool is_valid_erase (bd_addr_t addr, bd_size_t size) const
 Convenience function for checking block erase validity. More...
 

Static Public Member Functions

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

Detailed Description

BlockDevice for SFDP based flash devices over SPI bus.

// An example using SPI flash device on K82F target
#include "mbed.h"
#include "SPIFBlockDevice.h"
// Create flash device on SPI bus with PTE5 as chip select
SPIFBlockDevice spif(PTE2, PTE4, PTE1, PTE5);
int main() {
printf("spif test\n");
// Initialize the SPI flash device and print the memory layout
spif.init();
printf("spif size: %llu\n", spif.size());
printf("spif read size: %llu\n", spif.get_read_size());
printf("spif program size: %llu\n", spif.get_program_size());
printf("spif erase size: %llu\n", spif.get_erase_size());
// Write "Hello World!" to the first block
char *buffer = (char*)malloc(spif.get_erase_size());
sprintf(buffer, "Hello World!\n");
spif.erase(0, spif.get_erase_size());
spif.program(buffer, 0, spif.get_erase_size());
// Read back what was stored
spif.read(buffer, 0, spif.get_erase_size());
printf("%s", buffer);
// Deinitialize the device
spif.deinit();
}

Definition at line 75 of file SPIFBlockDevice.h.

Constructor & Destructor Documentation

SPIFBlockDevice ( PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  csel,
int  freq = 40000000 
)

Creates a SPIFBlockDevice on a SPI bus specified by pins.

Parameters
mosiSPI master out, slave in pin
misoSPI master in, slave out pin
sclkSPI clock pin
cselSPI chip select pin
freqClock speed of the SPI bus (defaults to 40MHz)

Desctruct SPIFBlockDevice.

Definition at line 104 of file SPIFBlockDevice.h.

Member Function Documentation

virtual int deinit ( )
virtual

Deinitialize a block device.

Returns
SPIF_BD_ERROR_OK(0) - success

Implements BlockDevice.

virtual int erase ( mbed::bd_addr_t  addr,
mbed::bd_size_t  size 
)
virtual

Erase blocks on a block device.

Note
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
SPIF_BD_ERROR_OK(0) - success SPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed SPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out SPIF_BD_ERROR_INVALID_ERASE_PARAMS - Trying to erase unaligned address or size

Reimplemented from BlockDevice.

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

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

virtual bd_size_t get_erase_size ( bd_addr_t  addr) const
virtualinherited

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 in MBRBlockDevice, ChainingBlockDevice, DataFlashBlockDevice, HeapBlockDevice, SPIFReducedBlockDevice, ExhaustibleBlockDevice, BufferedBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ProfilingBlockDevice, ObservingBlockDevice, ReadOnlyBlockDevice, and FlashIAPBlockDevice.

Definition at line 170 of file BlockDevice.h.

virtual mbed::bd_size_t get_erase_size ( mbed::bd_addr_t  addr)
virtual

Get the size of minimal erasable sector size of given address.

Parameters
addrAny address within block queried for erase sector size (can be any address within flash size offset)
Returns
Size of minimal erase sector size, in given address region, in bytes
Note
Must be a multiple of the program size
virtual int get_erase_value ( ) const
virtual

Get the value of storage byte after it was 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.

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.

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.

virtual const char* get_type ( ) const
virtual

Get the BlockDevice class type.

Returns
A string representation of the BlockDevice class type.

Implements BlockDevice.

virtual int init ( )
virtual

Initialize a block device.

Returns
SPIF_BD_ERROR_OK(0) - success SPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed SPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out SPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables

Implements BlockDevice.

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 229 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 215 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 201 of file BlockDevice.h.

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

Program blocks to a block device.

Note
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
SPIF_BD_ERROR_OK(0) - success SPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed SPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out SPIF_BD_ERROR_WREN_FAILED - Write Enable failed

Implements BlockDevice.

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
SPIF_BD_ERROR_OK(0) - success SPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed

Implements BlockDevice.

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.

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 MBRBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, SlicingBlockDevice, FlashSimBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, BufferedBlockDevice, and ReadOnlyBlockDevice.

Definition at line 82 of file BlockDevice.h.

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 SDBlockDevice, and BufferedBlockDevice.

Definition at line 136 of file BlockDevice.h.

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.