Introduction

This module contains APIs to program and use the QSPI module. The APIs can be used by other drivers to get access to QSPI and also by application to initiate data transfer operation.

Files
file	qspi/v0/qspi.h
	QSPI Driver API/interface file.

Data Structures
struct	QSPI_Transaction
	Data structure used with QSPI_Transfers - QSPI_writeConfigMode, QSPI_readMemMapMode. More...

struct	QSPI_ReadCmdParams

struct	QSPI_WriteCmdParams

struct	QSPI_Params
	QSPI Parameters. More...

struct	QSPI_Object
	QSPI driver object. More...

struct	QSPI_Attrs
	QSPI instance attributes - used during init time. More...

struct	QSPI_Config

Functions
void	QSPI_init (void)
	This function initializes the QSPI module. More...

void	QSPI_deinit (void)
	This function de-initializes the QSPI module. More...

void	QSPI_Params_init (QSPI_Params *qspiParams)
	Initialize data structure with defaults. More...

QSPI_Handle	QSPI_open (uint32_t index, const QSPI_Params *openParams)
	This function opens a given QSPI peripheral. More...

void	QSPI_close (QSPI_Handle handle)
	Function to close a QSPI peripheral specified by the QSPI handle. More...

QSPI_Handle	QSPI_getHandle (uint32_t index)
	This function returns the handle of an open QSPI Instance from the instance index. More...

uint32_t	QSPI_getInputClk (QSPI_Handle handle)
	This function returns the input clock at which QSPI was programmed. More...

void	QSPI_transaction_init (QSPI_Transaction *trans)
	Function to initialize the QSPI_Transaction structure. More...

void	QSPI_readCmdParams_init (QSPI_ReadCmdParams *rdParams)
	Function to initialize the QSPI_Transaction structure. More...

void	QSPI_writeCmdParams_init (QSPI_WriteCmdParams *wrParams)
	Function to initialize the QSPI_Transaction structure. More...

int32_t	QSPI_setPreScaler (QSPI_Handle handle, uint32_t clkDividerVal)
	Set the QSPI clock register divider value. More...

int32_t	QSPI_setWriteCmd (QSPI_Handle handle, uint8_t command)
	Function to set write command to be used. More...

int32_t	QSPI_setReadCmd (QSPI_Handle handle, uint8_t command)
	Function to set read command to be used. More...

int32_t	QSPI_setAddressByteCount (QSPI_Handle handle, uint32_t count)
	Function to set number of address bytes to be used. More...

int32_t	QSPI_setDummyBitCount (QSPI_Handle handle, uint32_t count)
	Function to set number of dummy bits to be used. More...

int32_t	QSPI_setMemAddrSpace (QSPI_Handle handle, uint32_t memMappedPortSwitch)
	This function is used to switch between memory mapped and configuration mode. More...

int32_t	QSPI_intEnable (QSPI_Handle handle, uint32_t intFlag)
	This function is used to enable word or frame complete interrupt. More...

int32_t	QSPI_intDisable (QSPI_Handle handle, uint32_t intFlag)
	This function is used to disable word or frame complete interrupt. More...

int32_t	QSPI_intClear (QSPI_Handle handle, uint32_t intFlag)
	This function is used to clear word or frame complete interrupt. More...

int32_t	QSPI_setRxLines (QSPI_Handle handle, uint32_t rxLines)
	Set QSPI Rx lines in the QSPI object. More...

uint32_t	QSPI_getRxLines (QSPI_Handle handle)
	Get QSPI Rx lines in the QSPI object. More...

void	OSPI_phyGetTuningData (uint32_t phyTuningData, uint32_t phyTuningDataSize)

Typedefs
typedef void *	QSPI_Handle
	A handle that is returned from a QSPI_open() call. More...

Macros for invalid commands
Macros for invalid commands
#define	QSPI_CMD_INVALID_OPCODE (0xFFU)

#define	QSPI_CMD_INVALID_ADDR (0xFFFFFFFFU)

Transfer Status Code
Status codes that are set by the QSPI driver
#define	QSPI_TRANSFER_COMPLETED (0U)

#define	QSPI_TRANSFER_STARTED (1U)

#define	QSPI_TRANSFER_CANCELLED (2U)

#define	QSPI_TRANSFER_FAILED (3U)

#define	QSPI_TRANSFER_CSN_DEASSERT (4U)

#define	QSPI_TRANSFER_TIMEOUT (5U)

Different QSPI Transfer functions

int32_t	QSPI_readMemMapMode (QSPI_Handle handle, QSPI_Transaction *trans)
	Function to perform reads from the flash in memory mapped mode. More...

int32_t	QSPI_writeCmd (QSPI_Handle handle, QSPI_WriteCmdParams *wrParams)
	Function to send specific commands and related data to flash. More...

int32_t	QSPI_writeConfigMode (QSPI_Handle handle, const QSPI_Transaction *trans)
	Function to perform writes to the flash in configuration mode. More...

int32_t	QSPI_writeConfigModeIntr (QSPI_Handle handle, QSPI_WriteCmdParams *wrParams)
	Function to perform write to the flash in interrupt mode mode. More...

int32_t	QSPI_readCmd (QSPI_Handle handle, QSPI_ReadCmdParams *rdParams)
	Function to send specific commands and receive related data from flash. More...

int32_t	QSPI_readConfigModeIntr (QSPI_Handle handle, QSPI_ReadCmdParams *rdParams)
	Function to perform read from the flash in interrupt mode. More...

Macro Definition Documentation

◆ QSPI_CMD_INVALID_OPCODE

#define QSPI_CMD_INVALID_OPCODE (0xFFU)

◆ QSPI_CMD_INVALID_ADDR

#define QSPI_CMD_INVALID_ADDR (0xFFFFFFFFU)

◆ QSPI_TRANSFER_COMPLETED

#define QSPI_TRANSFER_COMPLETED (0U)

◆ QSPI_TRANSFER_STARTED

#define QSPI_TRANSFER_STARTED (1U)

◆ QSPI_TRANSFER_CANCELLED

#define QSPI_TRANSFER_CANCELLED (2U)

◆ QSPI_TRANSFER_FAILED

#define QSPI_TRANSFER_FAILED (3U)

◆ QSPI_TRANSFER_CSN_DEASSERT

#define QSPI_TRANSFER_CSN_DEASSERT (4U)

◆ QSPI_TRANSFER_TIMEOUT

#define QSPI_TRANSFER_TIMEOUT (5U)

Typedef Documentation

◆ QSPI_Handle

typedef void* QSPI_Handle

A handle that is returned from a QSPI_open() call.

Function Documentation

◆ QSPI_init()

void QSPI_init ( void )

This function initializes the QSPI module.

◆ QSPI_deinit()

void QSPI_deinit ( void )

This function de-initializes the QSPI module.

◆ QSPI_Params_init()

void QSPI_Params_init ( QSPI_Params * qspiParams )

Initialize data structure with defaults.

Parameters

qspiParams [out] Initialized parameters

◆ QSPI_open()

QSPI_Handle QSPI_open	(	uint32_t	index,
		const QSPI_Params *	openParams
	)

This function opens a given QSPI peripheral.

Precondition: QSPI controller has been initialized using QSPI_init()

Parameters

index	Index of config to use in the QSPI_Config array
openParams	Pointer to parameters to open the driver with

Returns: A QSPI_Handle on success or a NULL on an error or if it has been opened already

See also: QSPI_init(); QSPI_close()

◆ QSPI_close()

void QSPI_close ( QSPI_Handle handle )

Function to close a QSPI peripheral specified by the QSPI handle.

Precondition: QSPI_open() has to be called first

Parameters

handle QSPI_Handle returned from QSPI_open()

See also: QSPI_open()

◆ QSPI_getHandle()

QSPI_Handle QSPI_getHandle ( uint32_t index )

This function returns the handle of an open QSPI Instance from the instance index.

Precondition: QSPI controller has been opened using QSPI_open()

Parameters

index Index of config to use in the QSPI_Config array

Returns: A QSPI_Handle if it has been opened already or NULL otherwise

See also: QSPI_init(); QSPI_open()

◆ QSPI_getInputClk()

uint32_t QSPI_getInputClk ( QSPI_Handle handle )

This function returns the input clock at which QSPI was programmed.

Precondition: QSPI controller has been opened using QSPI_open()

Parameters

handle QSPI_Handle returned from QSPI_open()

Returns: Clock frequency of the QSPI peripheral in Hertz

See also: QSPI_init(); QSPI_open()

◆ QSPI_readMemMapMode()

int32_t QSPI_readMemMapMode	(	QSPI_Handle	handle,
		QSPI_Transaction *	trans
	)

Function to perform reads from the flash in memory mapped mode.

Parameters

handle	QSPI_Handle returned from QSPI_open()
trans	Pointer to a QSPI_Transaction

Returns: SystemP_SUCCESS on successful read; else error on failure

See also: QSPI_open

◆ QSPI_writeCmd()

int32_t QSPI_writeCmd	(	QSPI_Handle	handle,
		QSPI_WriteCmdParams *	wrParams
	)

Function to send specific commands and related data to flash.

Parameters

handle	QSPI_Handle returned from QSPI_open()
wrParams	Pointer to a QSPI_WriteCmdParams

Returns: SystemP_SUCCESS if command write was successful; else error on failure

See also: QSPI_open

◆ QSPI_writeConfigMode()

int32_t QSPI_writeConfigMode	(	QSPI_Handle	handle,
		const QSPI_Transaction *	trans
	)

Function to perform writes to the flash in configuration mode.

Parameters

handle	QSPI_Handle returned from QSPI_open()
trans	Pointer to a QSPI_Transaction

Returns: SystemP_SUCCESS on successful write; else error on failure

See also: QSPI_open

◆ QSPI_writeConfigModeIntr()

int32_t QSPI_writeConfigModeIntr	(	QSPI_Handle	handle,
		QSPI_WriteCmdParams *	wrParams
	)

Function to perform write to the flash in interrupt mode mode.

Parameters

handle	QSPI_Handle returned from QSPI_open()
wrParams	Pointer to a QSPI_WriteCmdParams

Returns: SystemP_SUCCESS on successful read; else error on failure

See also: QSPI_open

◆ QSPI_readCmd()

int32_t QSPI_readCmd	(	QSPI_Handle	handle,
		QSPI_ReadCmdParams *	rdParams
	)

Function to send specific commands and receive related data from flash.

Parameters

handle	QSPI_Handle returned from QSPI_open()
rdParams	Pointer to a QSPI_ReadCmdParams

Returns: SystemP_SUCCESS if command read was successful; else error on failure

See also: QSPI_open

◆ QSPI_readConfigModeIntr()

int32_t QSPI_readConfigModeIntr	(	QSPI_Handle	handle,
		QSPI_ReadCmdParams *	rdParams
	)

Function to perform read from the flash in interrupt mode.

Parameters

handle	QSPI_Handle returned from QSPI_open()
rdParams	Pointer to a QSPI_ReadCmdParams

Returns: SystemP_SUCCESS on successful read; else error on failure

See also: QSPI_open

◆ QSPI_transaction_init()

void QSPI_transaction_init ( QSPI_Transaction * trans )

Function to initialize the QSPI_Transaction structure.

Parameters

trans Pointer to a QSPI_Transaction

◆ QSPI_readCmdParams_init()

void QSPI_readCmdParams_init ( QSPI_ReadCmdParams * rdParams )

Function to initialize the QSPI_Transaction structure.

Parameters

rdParams Pointer to a QSPI_ReadCmdParams

◆ QSPI_writeCmdParams_init()

void QSPI_writeCmdParams_init ( QSPI_WriteCmdParams * wrParams )

Function to initialize the QSPI_Transaction structure.

Parameters

wrParams Pointer to a QSPI_WriteCmdParams

◆ QSPI_setPreScaler()

int32_t QSPI_setPreScaler	(	QSPI_Handle	handle,
		uint32_t	clkDividerVal
	)

Set the QSPI clock register divider value.

This function sets the QSPI clock control register with serial data clock divider ratio (DCLK_DIV) according to the input clock provided and the output clock required. DCLK_DIV = ((input clock) / (output clock)) - 1. This function also enables the clock for QSPI module. This can only be done if QSPI module is not busy.

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
clkDividerVal	Clock divider value to be set.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setWriteCmd()

int32_t QSPI_setWriteCmd	(	QSPI_Handle	handle,
		uint8_t	command
	)

Function to set write command to be used.

Parameters

handle	QSPI_Handle returned from QSPI_open()
command	Write command for a particular flash

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setReadCmd()

int32_t QSPI_setReadCmd	(	QSPI_Handle	handle,
		uint8_t	command
	)

Function to set read command to be used.

Parameters

handle	QSPI_Handle returned from QSPI_open()
command	Read command for a particular flash

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setAddressByteCount()

int32_t QSPI_setAddressByteCount	(	QSPI_Handle	handle,
		uint32_t	count
	)

Function to set number of address bytes to be used.

Parameters

handle	QSPI_Handle returned from QSPI_open()
count	Number of Address Bytes. This function should always be called before accessing a memory location that doesn't fit in the current address byte range.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setDummyBitCount()

int32_t QSPI_setDummyBitCount	(	QSPI_Handle	handle,
		uint32_t	count
	)

Function to set number of dummy bits to be used.

Parameters

handle	QSPI_Handle returned from QSPI_open()
count	Number of Dummy Bits. This should be either less than 8 or a multiple of 8, because Bit count field in setup register works only if Byte count is 0.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setMemAddrSpace()

int32_t QSPI_setMemAddrSpace	(	QSPI_Handle	handle,
		uint32_t	memMappedPortSwitch
	)

This function is used to switch between memory mapped and configuration mode.

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
memMappedPortSwitch	Flag for switching mode.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_intEnable()

int32_t QSPI_intEnable	(	QSPI_Handle	handle,
		uint32_t	intFlag
	)

This function is used to enable word or frame complete interrupt.

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
intFlag	Flag for enabling interrupt.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_intDisable()

int32_t QSPI_intDisable	(	QSPI_Handle	handle,
		uint32_t	intFlag
	)

This function is used to disable word or frame complete interrupt.

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
intFlag	Flag for disabling interrupt.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_intClear()

int32_t QSPI_intClear	(	QSPI_Handle	handle,
		uint32_t	intFlag
	)

This function is used to clear word or frame complete interrupt.

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
intFlag	Flag for clearing interrupt.

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_setRxLines()

int32_t QSPI_setRxLines	(	QSPI_Handle	handle,
		uint32_t	rxLines
	)

Set QSPI Rx lines in the QSPI object.

This function sets the QSPI RX lines in QSPI object so that it can be used in a subsequent read

Parameters

handle	A QSPI_Handle returned from a QSPI_open()
rxLines	QSPI_TransferLines value

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ QSPI_getRxLines()

uint32_t QSPI_getRxLines ( QSPI_Handle handle )

Get QSPI Rx lines in the QSPI object.

This function returns the QSPI RX lines in QSPI object

Parameters

handle A QSPI_Handle returned from a QSPI_open()

Returns: SystemP_SUCCESS on success, SystemP_FAILURE otherwise

◆ OSPI_phyGetTuningData()

void OSPI_phyGetTuningData	(	uint32_t *	phyTuningData,
		uint32_t *	phyTuningDataSize
	)

Variable Documentation

◆ gQspiConfig

QSPI_Config gQspiConfig[]

extern

Externally defined driver configuration array.

◆ gQspiConfigNum

uint32_t gQspiConfigNum

extern

Externally defined driver configuration array size.

◆ gqspiEdmaParam

QSPI_EdmaParams gqspiEdmaParam

EDMA Paramter for QSPI Transaction.

Introduction

Files

Data Structures

Functions

Typedefs

Macros for invalid commands

Transfer Status Code

Different QSPI Transfer functions

Macro Definition Documentation

◆ QSPI_CMD_INVALID_OPCODE

◆ QSPI_CMD_INVALID_ADDR

◆ QSPI_TRANSFER_COMPLETED

◆ QSPI_TRANSFER_STARTED

◆ QSPI_TRANSFER_CANCELLED

◆ QSPI_TRANSFER_FAILED

◆ QSPI_TRANSFER_CSN_DEASSERT

◆ QSPI_TRANSFER_TIMEOUT

Typedef Documentation

◆ QSPI_Handle

Function Documentation

◆ QSPI_init()

◆ QSPI_deinit()

◆ QSPI_Params_init()

◆ QSPI_open()

◆ QSPI_close()

◆ QSPI_getHandle()

◆ QSPI_getInputClk()

◆ QSPI_readMemMapMode()

◆ QSPI_writeCmd()

◆ QSPI_writeConfigMode()

◆ QSPI_writeConfigModeIntr()

◆ QSPI_readCmd()

◆ QSPI_readConfigModeIntr()

◆ QSPI_transaction_init()

◆ QSPI_readCmdParams_init()

◆ QSPI_writeCmdParams_init()

◆ QSPI_setPreScaler()

◆ QSPI_setWriteCmd()

◆ QSPI_setReadCmd()

◆ QSPI_setAddressByteCount()

◆ QSPI_setDummyBitCount()

◆ QSPI_setMemAddrSpace()

◆ QSPI_intEnable()

◆ QSPI_intDisable()

◆ QSPI_intClear()

◆ QSPI_setRxLines()

◆ QSPI_getRxLines()

◆ OSPI_phyGetTuningData()

Variable Documentation

◆ gQspiConfig

◆ gQspiConfigNum

◆ gqspiEdmaParam