#include <SDBlockDevice.h>

Inheritance diagram for SDBlockDevice:

Public Member Functions
	SDBlockDevice (PinName mosi=NC, PinName miso=NC, PinName sclk=NC, PinName cs=NC, uint64_t hz=1000000, bool crc_on=0)
	Creates an SDBlockDevice on a SPI bus specified by pins (using dynamic pin-map) More...

	SDBlockDevice (const spi_pinmap_t &spi_pinmap, PinName cs=NC, uint64_t hz=1000000, bool crc_on=0)
	Creates an SDBlockDevice on a SPI bus specified by pins (using static pin-map) More...

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

void	set_async_spi_mode (bool enabled, DMAUsage dma_usage_hint=DMAUsage::DMA_USAGE_NEVER)
	Configure the usage of asynchronous SPI by this class. 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	trim (mbed::bd_addr_t addr, mbed::bd_size_t size)
	Mark blocks as no longer in use. 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 programmable block. More...

virtual mbed::bd_size_t	size () const
	Get the total size of the underlying device. More...

virtual void	debug (bool dbg)
	Enable or disable debugging. More...

virtual int	frequency (uint64_t freq)
	Set the transfer frequency. 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	erase (bd_addr_t addr, bd_size_t size)
	Erase blocks on a block device. More...

virtual bd_size_t	get_erase_size () const
	Get the size of an erasable block. More...

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

SDBlockDevice class.

Access an SD Card using SPI bus

Definition at line 59 of file SDBlockDevice.h.

Constructor & Destructor Documentation

◆ SDBlockDevice() [1/2]

SDBlockDevice	(	PinName	mosi = `NC`,
		PinName	miso = `NC`,
		PinName	sclk = `NC`,
		PinName	cs = `NC`,
		uint64_t	hz = `1000000`,
		bool	crc_on = `0`
	)

Creates an SDBlockDevice on a SPI bus specified by pins (using dynamic pin-map)

Parameters

mosi	SPI master out, slave in pin
miso	SPI master in, slave out pin
sclk	SPI clock pin
cs	SPI chip select pin. Currently, GPIO chip selects are always used.
hz	Clock speed of the SPI bus (defaults to 1MHz)
crc_on	Enable cyclic redundancy check (defaults to disabled)

◆ SDBlockDevice() [2/2]

SDBlockDevice	(	const spi_pinmap_t &	spi_pinmap,
		PinName	cs = `NC`,
		uint64_t	hz = `1000000`,
		bool	crc_on = `0`
	)

Creates an SDBlockDevice on a SPI bus specified by pins (using static pin-map)

Parameters

spi_pinmap	Static SPI pin-map
cs	Chip select pin (can be any GPIO)
hz	Clock speed of the SPI bus (defaults to 1MHz)
crc_on	Enable cyclic redundancy check (defaults to disabled)

Member Function Documentation

◆ init()

virtual int init ( )

virtual

Initialize a block device.

Returns: BD_ERROR_OK(0) - success BD_ERROR_DEVICE_ERROR - device driver transaction failed SD_BLOCK_DEVICE_ERROR_NO_DEVICE - device (SD card) is missing or not connected SD_BLOCK_DEVICE_ERROR_UNUSABLE - unusable card SD_BLOCK_DEVICE_ERROR_CRC - crc error

Implements BlockDevice.

◆ set_async_spi_mode()

void set_async_spi_mode	(	bool	enabled,
		DMAUsage	dma_usage_hint = `DMAUsage::DMA_USAGE_NEVER`
	)

Configure the usage of asynchronous SPI by this class.

By default, async SPI is not enabled, so this class will simply busy-wait while communicating with the card. When async SPI is enabled, SPI operations will be done in blocking asynchronous mode, so other threads may execute in the background while data is going to and from the card.

Parameters

enabled	Whether usage of async SPI is enabled.
dma_usage_hint	DMA usage hint to pass to the underlying SPI instance.

◆ deinit()

virtual int deinit ( )

virtual

Deinitialize a block device.

Returns: BD_ERROR_OK(0) - success

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: BD_ERROR_OK(0) - success SD_BLOCK_DEVICE_ERROR_NO_DEVICE - device (SD card) is missing or not connected SD_BLOCK_DEVICE_ERROR_CRC - crc error SD_BLOCK_DEVICE_ERROR_PARAMETER - invalid parameter SD_BLOCK_DEVICE_ERROR_NO_RESPONSE - no response from device SD_BLOCK_DEVICE_ERROR_UNSUPPORTED - unsupported command

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.

Note: The blocks must be erased prior to programming

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: BD_ERROR_OK(0) - success SD_BLOCK_DEVICE_ERROR_NO_DEVICE - device (SD card) is missing or not connected SD_BLOCK_DEVICE_ERROR_CRC - crc error SD_BLOCK_DEVICE_ERROR_PARAMETER - invalid parameter SD_BLOCK_DEVICE_ERROR_UNSUPPORTED - unsupported command SD_BLOCK_DEVICE_ERROR_NO_INIT - device is not initialized SD_BLOCK_DEVICE_ERROR_WRITE - SPI write error SD_BLOCK_DEVICE_ERROR_ERASE - erase error

Implements BlockDevice.

◆ trim()

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

virtual

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: BD_ERROR_OK(0) - success SD_BLOCK_DEVICE_ERROR_NO_DEVICE - device (SD card) is missing or not connected SD_BLOCK_DEVICE_ERROR_CRC - crc error SD_BLOCK_DEVICE_ERROR_PARAMETER - invalid parameter SD_BLOCK_DEVICE_ERROR_UNSUPPORTED - unsupported command SD_BLOCK_DEVICE_ERROR_NO_INIT - device is not initialized SD_BLOCK_DEVICE_ERROR_ERASE - erase error

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

Returns: Size of a programmable block in bytes

Note: Must be a multiple of the read size

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

◆ debug()

virtual void debug ( bool dbg )

virtual

Enable or disable debugging.

Parameters

dbg	State of debugging

◆ frequency()

virtual int frequency ( uint64_t freq )

virtual

Set the transfer frequency.

Parameters

freq	Transfer frequency

Note: Max frequency supported is 25MHZ

◆ get_type()

virtual const char * get_type ( ) const

virtual

Get the BlockDevice class type.

Returns: A string representation of the BlockDevice class type.

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

◆ erase()

virtual int erase	(	bd_addr_t	addr,
		bd_size_t	size
	)

virtualinherited

Erase blocks on a block device.

The state of an erased block is undefined until it has been programmed, unless get_erase_value returns a non-negative byte value

Parameters

addr	Address of block to begin erasing
size	Size to erase 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, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, HeapBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, DataFlashBlockDevice, I2CEEBlockDevice, OSPIFBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, SPINANDBlockDevice, and FlashIAPBlockDevice.

Definition at line 126 of file BlockDevice.h.

◆ get_erase_size() [1/2]

virtual bd_size_t get_erase_size ( ) const

virtualinherited

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

Definition at line 165 of file BlockDevice.h.

◆ get_erase_size() [2/2]

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.

◆ get_erase_value()

virtual int get_erase_value ( ) const

virtualinherited

Get the value of storage when 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 the erased storage

Reimplemented in OSPIFBlockDevice, QSPIFBlockDevice, SPIFBlockDevice, SPINANDBlockDevice, BufferedBlockDevice, ChainingBlockDevice, ExhaustibleBlockDevice, FlashSimBlockDevice, MBRBlockDevice, ObservingBlockDevice, ProfilingBlockDevice, ReadOnlyBlockDevice, SlicingBlockDevice, and FlashIAPBlockDevice.

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

◆ SDBlockDevice() [1/2]

◆ SDBlockDevice() [2/2]

Member Function Documentation

◆ init()

◆ set_async_spi_mode()

◆ deinit()

◆ read()

◆ program()

◆ trim()

◆ get_read_size()

◆ get_program_size()

◆ size()

◆ debug()

◆ frequency()

◆ get_type()

◆ get_default_instance()

◆ sync()

◆ erase()

◆ get_erase_size() [1/2]

◆ get_erase_size() [2/2]

◆ get_erase_value()

◆ is_valid_read()

◆ is_valid_program()

◆ is_valid_erase()