qspi_api_t Struct Reference

#include <r_qspi_api.h>

Data Fields
ssp_err_t(*	open )(qspi_ctrl_t *p_ctrl, qspi_cfg_t const *const p_cfg)
ssp_err_t(*	close )(qspi_ctrl_t *p_ctrl)
ssp_err_t(*	read )(qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint8_t *p_memory_address, uint32_t byte_count)
ssp_err_t(*	pageProgram )(qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint8_t *p_memory_address, uint32_t byte_count)
ssp_err_t(*	erase )(qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint32_t byte_count)
ssp_err_t(*	infoGet )(qspi_ctrl_t *const p_ctrl, qspi_info_t *const p_info)
ssp_err_t(*	sectorErase )(qspi_ctrl_t *p_ctrl, uint8_t *p_device_address)
ssp_err_t(*	statusGet )(qspi_ctrl_t *p_ctrl, bool *p_write_in_progress)
ssp_err_t(*	bankSelect )(uint32_t bank)
ssp_err_t(*	versionGet )(ssp_version_t *const p_version)

Detailed Description

QSPI functions implemented at the HAL layer follow this API.

Field Documentation

bankSelect

ssp_err_t(* qspi_api_t::bankSelect) (uint32_t bank)

Select the bank to access.

Implemented as

• R_QSPI_BankSelect()

Parameters

[in]

bank

The bank number

close

ssp_err_t(* qspi_api_t::close) (qspi_ctrl_t *p_ctrl)

Close the QSPI driver module.

Implemented as

• R_QSPI_Close()

Parameters

[in]

p_ctrl

Pointer to a driver handle

erase

ssp_err_t(* qspi_api_t::erase) (qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint32_t byte_count)

Erase a certain number of bytes of the flash.

Implemented as

• R_QSPI_Erase()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_device_address	The location in the flash device address space to start the erase from
[in]	byte_count	The number of bytes to erase

infoGet

ssp_err_t(* qspi_api_t::infoGet) (qspi_ctrl_t *const p_ctrl, qspi_info_t *const p_info)

Get information about this specific QSPI flash.

Implemented as

• R_QSPI_InfoGet()

Parameters

[in]	p_ctrl	Control block set in qspi_api_t::open call for this timer.
[out]	p_info	Collection of information for this QSPI.

open

ssp_err_t(* qspi_api_t::open) (qspi_ctrl_t *p_ctrl, qspi_cfg_t const *const p_cfg)

Open the QSPI driver module.

Implemented as

• R_QSPI_Open()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_cfg	Pointer to a configuration structure

pageProgram

ssp_err_t(* qspi_api_t::pageProgram) (qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint8_t *p_memory_address, uint32_t byte_count)

Program a page of data to the flash.

Implemented as

• R_QSPI_PageProgram()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_device_address	The location in the flash device address space to write the data to
[in]	p_memory_address	The memory address of the data to write to the flash device
[in]	byte_count	The number of bytes to write

read

ssp_err_t(* qspi_api_t::read) (qspi_ctrl_t *p_ctrl, uint8_t *p_device_address, uint8_t *p_memory_address, uint32_t byte_count)

Read a block of data from the flash.

Implemented as

• R_QSPI_Read()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_device_address	The location in the flash device address space to read
[in]	p_memory_address	The memory address of a buffer to place the read data in
[in]	byte_count	The number of bytes to read

sectorErase

ssp_err_t(* qspi_api_t::sectorErase) (qspi_ctrl_t *p_ctrl, uint8_t *p_device_address)

Erase a sector of the flash.

Implemented as

• R_QSPI_SectorErase()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_device_address	The location in the flash device address space to start the erase from

statusGet

ssp_err_t(* qspi_api_t::statusGet) (qspi_ctrl_t *p_ctrl, bool *p_write_in_progress)

Get the write or erase status of the flash.

Implemented as

• R_QSPI_StatusGet()

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_write_in_progress	The write or erase status - TRUE = write/erase in progress

versionGet

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

Get the driver version based on compile time macros.

Implemented as

• R_QSPI_VersionGet()

Parameters

[out]

p_version

Code and API version used.

---

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

• r_qspi_api.h