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

#include <SPIFBlockDevice.h>

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.
virtual int	init ()
	Initialize a block device.
virtual int	deinit ()
	Deinitialize a block device.
	~SPIFBlockDevice ()
	Desctruct SPIFBlockDevie.
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	get_erase_size (bd_addr_t addr)
	Get the size of minimal eraseable sector size of given address.
virtual int	get_erase_value () const
	Get the value of storage byte after it was erased.
virtual bd_size_t	size () const
	Get the total size of the underlying device.
virtual int	sync ()
	Ensure data on storage is in sync with the driver.
virtual int	trim (bd_addr_t addr, bd_size_t size)
	Mark blocks as no longer in use.
virtual bd_size_t	get_erase_size (bd_addr_t addr) const
	Get the size of an erasable block given address.
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.
Static Public Member Functions
static BlockDevice *	get_default_instance ()
	Return the default block device.

Detailed Description

BlockDevice for SFDP based flash devices over SPI bus.

  // Here's 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:

mosi	SPI master out, slave in pin
miso	SPI master in, slave out pin
sclk	SPI clock pin
csel	SPI chip select pin
freq	Clock speed of the SPI bus (defaults to 40MHz)

Definition at line 103 of file SPIFBlockDevice.cpp.

~SPIFBlockDevice ( )

Desctruct SPIFBlockDevie.

Definition at line 104 of file SPIFBlockDevice.h.

Member Function Documentation

int deinit ( ) [virtual]

Deinitialize a block device.

Returns:: SPIF_BD_ERROR_OK(0) - success

Implements BlockDevice.

Definition at line 225 of file SPIFBlockDevice.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:

addr	Address of block to begin erasing
size	Size 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_WREN_FAILED - Write Enable failed SPIF_BD_ERROR_INVALID_ERASE_PARAMS - Trying to erase unaligned address or size

Reimplemented from BlockDevice.

Definition at line 329 of file SPIFBlockDevice.cpp.

MBED_WEAK BlockDevice * get_default_instance ( ) [static, inherited]

Return the default block device.

Returns the default BlockDevice base on 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() themselves - the default definition is weak, and calls get_target_default_instance().

Definition at line 35 of file SystemStorage.cpp.

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.

Definition at line 424 of file SPIFBlockDevice.cpp.

bd_size_t get_erase_size ( bd_addr_t addr ) [virtual]

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

Parameters:

addr	Any 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

Definition at line 431 of file SPIFBlockDevice.cpp.

virtual bd_size_t get_erase_size ( bd_addr_t addr ) const [virtual, inherited]

Get the size of an erasable block given address.

Parameters:

addr	Address within the erasable block

Returns:: Size of an erasable block in bytes

Note:: Must be a multiple of the program size

Reimplemented in DataFlashBlockDevice, FlashIAPBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ProfilingBlockDevice, and SlicingBlockDevice.

Definition at line 167 of file BlockDevice.h.

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.

Definition at line 470 of file SPIFBlockDevice.cpp.

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.

Definition at line 418 of file SPIFBlockDevice.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 412 of file SPIFBlockDevice.cpp.

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 timedout SPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables

Implements BlockDevice.

Definition at line 125 of file SPIFBlockDevice.cpp.

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

Convenience function for checking block erase validity.

Parameters:

addr	Address of block to begin erasing
size	Size to erase in bytes

Returns:: True if erase is valid for underlying block device

Definition at line 226 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:

addr	Address of block to begin writing to
size	Size to write in bytes

Returns:: True if program is valid for underlying block device

Definition at line 212 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:

addr	Address of block to begin reading from
size	Size to read in bytes

Returns:: True if read is valid for underlying block device

Definition at line 198 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:

buffer	Buffer of data to write to blocks
addr	Address of block to begin writing to
size	Size 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.

Definition at line 277 of file SPIFBlockDevice.cpp.

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

Read blocks from a block device.

Parameters:

buffer	Buffer to write blocks to
addr	Address of block to begin reading from
size	Size 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.

Definition at line 255 of file SPIFBlockDevice.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 461 of file SPIFBlockDevice.cpp.

virtual int sync ( ) [virtual, inherited]

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, ProfilingBlockDevice, and SlicingBlockDevice.

Definition at line 79 of file BlockDevice.h.

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:

addr	Address of block to mark as unused
size	Size 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 SDBlockDevice, and BufferedBlockDevice.

Definition at line 133 of file BlockDevice.h.

Type:	Program
Mbed OS support:	Mbed OS
Created:	11 Oct 2018
Imports:	23
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	1
Followers:	1

Important changes to repositories hosted on mbed.com

SPIFBlockDevice Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

SPIFBlockDevice Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning