![]() |
Mbed OS Reference
|
BlockDevice for SFDP based flash devices over OSPI bus. More...
#include <OSPIFBlockDevice.h>
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... | |
BlockDevice for SFDP based flash devices over OSPI bus.
Definition at line 147 of file OSPIFBlockDevice.h.
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.
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 | ( | ) |
Desctruct OSPIFBlockDevie.
Definition at line 198 of file OSPIFBlockDevice.h.
|
virtual |
Initialize a block device.
Implements BlockDevice.
|
virtual |
Deinitialize a block device.
Implements BlockDevice.
|
virtual |
Read blocks from a block device.
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 |
Implements BlockDevice.
|
virtual |
Program blocks to a block device.
The blocks must have been erased prior to being programmed
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 |
Implements BlockDevice.
|
virtual |
Erase blocks on a block device.
The state of an erased block is undefined until it has been programmed
addr | Address of block to begin erasing |
size | Size to erase in bytes, must be a multiple of erase block size |
Reimplemented from BlockDevice.
|
virtual |
|
virtual |
Get the size of a programable block.
Implements BlockDevice.
|
virtual |
Get the size of a eraseable block.
Reimplemented from BlockDevice.
|
virtual |
Get the size of minimal eraseable sector size of given address.
addr | Any address within block queried for erase sector size (can be any address within flash size offset) |
|
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.
Reimplemented from BlockDevice.
|
virtual |
Get the total size of the underlying device.
Implements BlockDevice.
|
virtual |
Get the BlockDevice class type.
Implements BlockDevice.
|
virtual |
Change the operation mode(SPI, SOPI or DOPI) of flash.
|
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().
|
virtualinherited |
Ensure data on storage is in sync with the driver.
Reimplemented in BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, and SlicingBlockDevice.
Definition at line 88 of file BlockDevice.h.
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.
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 |
Reimplemented in BufferedBlockDevice, and SDBlockDevice.
Definition at line 142 of file BlockDevice.h.
|
virtualinherited |
Get the size of an erasable block given address.
addr | Address within the erasable block |
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.
Convenience function for checking block read validity.
addr | Address of block to begin reading from |
size | Size to read in bytes |
Reimplemented in SlicingBlockDevice.
Definition at line 207 of file BlockDevice.h.
Convenience function for checking block program validity.
addr | Address of block to begin writing to |
size | Size to write in bytes |
Reimplemented in SlicingBlockDevice.
Definition at line 221 of file BlockDevice.h.
Convenience function for checking block erase validity.
addr | Address of block to begin erasing |
size | Size to erase in bytes |
Reimplemented in SlicingBlockDevice, and FlashIAPBlockDevice.
Definition at line 235 of file BlockDevice.h.