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

#include <OSPIFBlockDevice.h>

Inheritance diagram for OSPIFBlockDevice:

Public Member Functions
	OSPIFBlockDevice (PinName io0=NC, PinName io1=NC, PinName io2=NC, PinName io3=NC, PinName io4=NC, PinName io5=NC, PinName io6=NC, PinName io7=NC, PinName sclk=NC, PinName csel=NC, PinName dqs=NC, int clock_mode=0, int freq=40000000)
	Create OSPIFBlockDevice - An SFDP based Flash Block Device over OSPI bus. More...

virtual int	init ()
	Initialize a block device. More...

virtual int	deinit ()
	Deinitialize a block device. More...

	~OSPIFBlockDevice ()
	Desctruct OSPIFBlockDevie. 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)
	Get the size of minimal eraseable 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	change_mode (int mode)
	Change the operation mode(SPI, SOPI or DOPI) of flash. 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...

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

virtual 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 BlockDevice *	get_default_instance ()
	Return the default block device. More...

Detailed Description

BlockDevice for SFDP based flash devices over OSPI bus.

// Here's an example using OSPI flash device on NUCLEO_L4R9I target
#include "mbed.h"
#include "OSPIFBlockDevice.h"
 
OSPIFBlockDevice block_device(OSPI_FLASH1_IO0, OSPI_FLASH1_IO1, OSPI_FLASH1_IO2, OSPI_FLASH1_IO3, OSPI_FLASH1_IO4, OSPI_FLASH1_IO5, OSPI_FLASH1_IO6, OSPI_FLASH1_IO7
                              OSPI_FLASH1_SCK, OSPI_FLASH1_CSN, OSPI_FLASH1_DQS, OSPIF_POLARITY_MODE_0, MBED_CONF_OSPIF_OSPI_FREQ);
 
int main()
{
    printf("OSPI SFDP Flash Block Device example\n");
 
    // Initialize the OSPI flash device and print the memory layout
    block_device.init();
    bd_size_t sector_size_at_address_0 = block_device.get_erase_size(0);
 
    printf("OSPIF BD size: %llu\n",         block_device.size());
    printf("OSPIF BD read size: %llu\n",    block_device.get_read_size());
    printf("OSPIF BD program size: %llu\n", block_device.get_program_size());
    printf("OSPIF BD erase size (at address 0): %llu\n", sector_size_at_address_0);
 
    // Write "Hello World!" to the first block
    char *buffer = (char *) malloc(sector_size_at_address_0);
    sprintf(buffer, "Hello World!\n");
    block_device.erase(0, sector_size_at_address_0);
    block_device.program(buffer, 0, sector_size_at_address_0);
 
    // Read back what was stored
    block_device.read(buffer, 0, sector_size_at_address_0);
    printf("%s", buffer);
 
    // Deinitialize the device
    block_device.deinit();
}

Definition at line 147 of file OSPIFBlockDevice.h.

Constructor & Destructor Documentation

◆ OSPIFBlockDevice()

OSPIFBlockDevice	(	PinName	io0 = `NC`,
		PinName	io1 = `NC`,
		PinName	io2 = `NC`,
		PinName	io3 = `NC`,
		PinName	io4 = `NC`,
		PinName	io5 = `NC`,
		PinName	io6 = `NC`,
		PinName	io7 = `NC`,
		PinName	sclk = `NC`,
		PinName	csel = `NC`,
		PinName	dqs = `NC`,
		int	clock_mode = `0`,
		int	freq = `40000000`
	)

Create OSPIFBlockDevice - An SFDP based Flash Block Device over OSPI bus.

Parameters

io0	1st IO pin used for sending/receiving data during data phase of a transaction
io1	2nd IO pin used for sending/receiving data during data phase of a transaction
io2	3rd IO pin used for sending/receiving data during data phase of a transaction
io3	4th IO pin used for sending/receiving data during data phase of a transaction
io4	5th IO pin used for sending/receiving data during data phase of a transaction
io5	6th IO pin used for sending/receiving data during data phase of a transaction
io6	7th IO pin used for sending/receiving data during data phase of a transaction
io7	8th IO pin used for sending/receiving data during data phase of a transaction
sclk	OSPI Clock pin
csel	OSPI chip select pin
dqs	OSPI dqs pin
clock_mode	specifies the OSPI Clock Polarity mode (OSPIF_POLARITY_MODE_0/OSPIF_POLARITY_MODE_1) default value = 0
freq	Clock frequency of the OSPI bus (defaults to 40MHz)

◆ ~OSPIFBlockDevice()

~OSPIFBlockDevice ( )

Desctruct OSPIFBlockDevie.

Definition at line 198 of file OSPIFBlockDevice.h.

Member Function Documentation

◆ init()

virtual int init ( )

virtual

Initialize a block device.

Returns: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed OSPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timedout OSPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables

Implements BlockDevice.

◆ deinit()

virtual int deinit ( )

virtual

Deinitialize a block device.

Returns: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed

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

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: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed

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

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: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed OSPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out OSPIF_BD_ERROR_WREN_FAILED - Write Enable failed OSPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables

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

addr	Address of block to begin erasing
size	Size to erase in bytes, must be a multiple of erase block size

Returns: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed OSPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out OSPIF_BD_ERROR_WREN_FAILED - Write Enable failed OSPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables OSPIF_BD_ERROR_INVALID_ERASE_PARAMS - Trying to erase unaligned address or size

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 program block size in bytes

Note: Must be a multiple of the read size

Implements BlockDevice.

◆ get_erase_size() [1/3]

virtual mbed::bd_size_t get_erase_size ( ) const

virtual

Get the size of a eraseable block.

Returns: Size of a minimal erase block, common to all regions, in bytes

Note: Must be a multiple of the program size

Reimplemented from BlockDevice.

◆ get_erase_size() [2/3]

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

◆ get_erase_value()

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.

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

◆ change_mode()

virtual int change_mode ( int mode )

virtual

Change the operation mode(SPI, SOPI or DOPI) of flash.

Returns: OSPIF_BD_ERROR_OK(0) - success OSPIF_BD_ERROR_DEVICE_ERROR - device driver transaction failed OSPIF_BD_ERROR_READY_FAILED - Waiting for Memory ready failed or timed out OSPIF_BD_ERROR_WREN_FAILED - Write Enable failed OSPIF_BD_ERROR_PARSING_FAILED - unexpected format or values in one of the SFDP tables OSPIF_BD_ERROR_INVALID_ERASE_PARAMS - Trying to erase unaligned address or size

◆ 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

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

◆ get_erase_size() [3/3]

virtual bd_size_t get_erase_size ( bd_addr_t addr ) const

virtualinherited

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

Definition at line 176 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

addr	Address of block to begin reading from
size	Size 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

addr	Address of block to begin writing to
size	Size 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.

◆ is_valid_erase()

virtual bool is_valid_erase	(	bd_addr_t	addr,
		bd_size_t	size
	)		const

virtualinherited

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

Reimplemented in SlicingBlockDevice, and FlashIAPBlockDevice.

Definition at line 235 of file BlockDevice.h.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OSPIFBlockDevice()

◆ ~OSPIFBlockDevice()

Member Function Documentation

◆ init()

◆ deinit()

◆ read()

◆ program()

◆ erase()

◆ get_read_size()

◆ get_program_size()

◆ get_erase_size() [1/3]

◆ get_erase_size() [2/3]

◆ get_erase_value()

◆ size()

◆ get_type()

◆ change_mode()

◆ get_default_instance()

◆ sync()

◆ trim()

◆ get_erase_size() [3/3]

◆ is_valid_read()

◆ is_valid_program()

◆ is_valid_erase()