sf_block_media_api_t Struct Reference

#include <sf_block_media_api.h>

Data Fields
ssp_err_t(*	open )(sf_block_media_ctrl_t *p_ctrl, sf_block_media_cfg_t const *const p_cfg)
ssp_err_t(*	read )(sf_block_media_ctrl_t *p_ctrl, uint8_t *const p_dest, uint32_t const start_sector, uint32_t const sector_count)
ssp_err_t(*	write )(sf_block_media_ctrl_t *p_ctrl, uint8_t const *const p_src, uint32_t const start_sector, uint32_t const sector_count)
ssp_err_t(*	ioctl )(sf_block_media_ctrl_t *p_ctrl, ssp_command_t const command, void *p_data)
ssp_err_t(*	close )(sf_block_media_ctrl_t *p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

Shared Interface definition for Block Media

Field Documentation

close

ssp_err_t(* sf_block_media_api_t::close) (sf_block_media_ctrl_t *p_ctrl)

Close the open media channel.

Implemented as

• SF_Block_Media_SDMMC_Close()
• SF_BLOCK_MEDIA_RAM_Close()
• SF_BLOCK_MEDIA_QSPI_Close()
• SF_BLOCK_MEDIA_LX_NOR_Close()

Parameters

[in]

p_cfg

Pointer to the media configuration structure for a channel.

ioctl

ssp_err_t(* sf_block_media_api_t::ioctl) (sf_block_media_ctrl_t *p_ctrl, ssp_command_t const command, void *p_data)

Send control commands to and receives the status from the media port.

Implemented as

• SF_Block_Media_SDMMC_Control()
• SF_BLOCK_MEDIA_RAM_Control()
• SF_BLOCK_MEDIA_QSPI_Control()
• SF_BLOCK_MEDIA_LX_NOR_Control()

Parameters

[in]	p_cfg	Pointer to the media configuration structure for a channel.
[in]	command	Command to execute.
[in,out]	p_data	Void pointer to data in or out.

open

ssp_err_t(* sf_block_media_api_t::open) (sf_block_media_ctrl_t *p_ctrl, sf_block_media_cfg_t const *const p_cfg)

Open a device channel for read/write and control.

Implemented as

• SF_Block_Media_SDMMC_Open()
• SF_BLOCK_MEDIA_RAM_Open()
• SF_BLOCK_MEDIA_QSPI_Open()
• SF_BLOCK_MEDIA_LX_NOR_Open()

Parameters

[in]

p_cfg

Pointer to the media configuration structure for a channel.

read

ssp_err_t(* sf_block_media_api_t::read) (sf_block_media_ctrl_t *p_ctrl, uint8_t *const p_dest, uint32_t const start_sector, uint32_t const sector_count)

Read data from a media channel.

Implemented as

• SF_Block_Media_SDMMC_Read()
• SF_BLOCK_MEDIA_RAM_Read()
• SF_BLOCK_MEDIA_QSPI_Read()
• SF_BLOCK_MEDIA_LX_NOR_Read()

Parameters

[in]	p_cfg	Pointer to the media configuration structure for a channel.
[in]	p_dest	Destination address to read data out.
[in]	start_sector	Beginning sector address to read.
[in]	sector_count	Number of sectors to read.

versionGet

ssp_err_t(* sf_block_media_api_t::versionGet) (ssp_version_t *const p_version)

Return the version of the driver.

Implemented as

• SF_Block_Media_SDMMC_VersionGet()
• SF_BLOCK_MEDIA_RAM_VersionGet()
• SF_BLOCK_MEDIA_QSPI_VersionGet()
• SF_BLOCK_MEDIA_LX_NOR_VersionGet()

Parameters

[in]	p_cfg	Pointer to the media configuration structure for a channel.
[out]	p_version	Memory address to return version information to.

write

ssp_err_t(* sf_block_media_api_t::write) (sf_block_media_ctrl_t *p_ctrl, uint8_t const *const p_src, uint32_t const start_sector, uint32_t const sector_count)

Write data to a media channel.

Implemented as

• SF_Block_Media_SDMMC_Write()
• SF_BLOCK_MEDIA_RAM_Write()
• SF_BLOCK_MEDIA_QSPI_Write()
• SF_BLOCK_MEDIA_LX_NOR_Write()

Parameters

[in]	p_cfg	Pointer to the media configuration structure for a channel.
[in]	p_src	Source address of data for writing.
[in]	start_sector	Beginning sector address to write to.
[in]	sector_count	Number of sectors to write.

---

The documentation for this struct was generated from the following file:

• sf_block_media_api.h