nRF5 SDK v17.1.0
Modules | Data Structures | Macros | Typedefs | Enumerations | Functions
QSPI driver

Quad Serial Peripheral Interface (QSPI) peripheral driver. More...

Modules

 QSPI peripheral driver configuration
 

Data Structures

struct  nrfx_qspi_config_t
 QSPI driver instance configuration structure. More...
 

Macros

#define NRFX_QSPI_DEFAULT_CONFIG
 QSPI instance default configuration. More...
 
#define NRFX_QSPI_DEFAULT_CINSTR(opc, len)
 QSPI custom instruction helper with the default configuration. More...
 

Typedefs

typedef void(* nrfx_qspi_handler_t )(nrfx_qspi_evt_t event, void *p_context)
 QSPI driver event handler type.
 

Enumerations

enum  nrfx_qspi_evt_t { NRFX_QSPI_EVENT_DONE }
 QSPI master driver event types, passed to the handler routine provided during initialization. More...
 

Functions

nrfx_err_t nrfx_qspi_init (nrfx_qspi_config_t const *p_config, nrfx_qspi_handler_t handler, void *p_context)
 Function for initializing the QSPI driver instance. More...
 
void nrfx_qspi_uninit (void)
 Function for uninitializing the QSPI driver instance.
 
nrfx_err_t nrfx_qspi_read (void *p_rx_buffer, size_t rx_buffer_length, uint32_t src_address)
 Function for reading data from the QSPI memory. More...
 
nrfx_err_t nrfx_qspi_write (void const *p_tx_buffer, size_t tx_buffer_length, uint32_t dst_address)
 Function for writing data to QSPI memory. More...
 
nrfx_err_t nrfx_qspi_erase (nrf_qspi_erase_len_t length, uint32_t start_address)
 Function for starting erasing of one memory block - 4KB, 64KB, or the whole chip. More...
 
nrfx_err_t nrfx_qspi_chip_erase (void)
 Function for starting an erase operation of the whole chip. More...
 
nrfx_err_t nrfx_qspi_mem_busy_check (void)
 Function for getting the current driver status and status byte of memory device with testing WIP (write in progress) bit. More...
 
nrfx_err_t nrfx_qspi_cinstr_xfer (nrf_qspi_cinstr_conf_t const *p_config, void const *p_tx_buffer, void *p_rx_buffer)
 Function for sending operation code, sending data, and receiving data from the memory device. More...
 
nrfx_err_t nrfx_qspi_cinstr_quick_send (uint8_t opcode, nrf_qspi_cinstr_len_t length, void const *p_tx_buffer)
 Function for sending operation code and data to the memory device with simpler configuration. More...
 
nrfx_err_t nrfx_qspi_lfm_start (nrf_qspi_cinstr_conf_t const *p_config)
 Function for starting the custom instruction long frame mode. More...
 
nrfx_err_t nrfx_qspi_lfm_xfer (void const *p_tx_buffer, void *p_rx_buffer, size_t transfer_length, bool finalize)
 Function for sending and receiving data in the custom instruction long frame mode. More...
 

Detailed Description

Quad Serial Peripheral Interface (QSPI) peripheral driver.

Macro Definition Documentation

#define NRFX_QSPI_DEFAULT_CINSTR (   opc,
  len 
)
Value:
{ \
.opcode = (opc), \
.length = (len), \
.io2_level = false, \
.io3_level = false, \
.wipwait = false, \
.wren = false \
}

QSPI custom instruction helper with the default configuration.

#define NRFX_QSPI_DEFAULT_CONFIG
Value:
{ \
.xip_offset = NRFX_QSPI_CONFIG_XIP_OFFSET, \
.pins = { \
.sck_pin = NRFX_QSPI_PIN_SCK, \
.csn_pin = NRFX_QSPI_PIN_CSN, \
.io0_pin = NRFX_QSPI_PIN_IO0, \
.io1_pin = NRFX_QSPI_PIN_IO1, \
.io2_pin = NRFX_QSPI_PIN_IO2, \
.io3_pin = NRFX_QSPI_PIN_IO3, \
}, \
.prot_if = { \
.dpmconfig = false, \
}, \
.phy_if = { \
.sck_delay = (uint8_t)NRFX_QSPI_CONFIG_SCK_DELAY, \
.dpmen = false, \
}, \
.irq_priority = (uint8_t)NRFX_QSPI_CONFIG_IRQ_PRIORITY, \
}

QSPI instance default configuration.

Enumeration Type Documentation

QSPI master driver event types, passed to the handler routine provided during initialization.

Enumerator
NRFX_QSPI_EVENT_DONE 

Transfer done.

Function Documentation

nrfx_err_t nrfx_qspi_chip_erase ( void  )

Function for starting an erase operation of the whole chip.

Return values
NRFX_SUCCESSThe operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSYThe driver currently handles another operation.
nrfx_err_t nrfx_qspi_cinstr_quick_send ( uint8_t  opcode,
nrf_qspi_cinstr_len_t  length,
void const *  p_tx_buffer 
)

Function for sending operation code and data to the memory device with simpler configuration.

Use this function to transfer configuration data to memory and to receive data from memory. This function is a synchronous function and should be used only if necessary.

Parameters
[in]opcodeOperation code. Sending first.
[in]lengthLength of the data to send and opcode. See nrf_qspi_cinstr_len_t.
[in]p_tx_bufferPointer to input data array.
Return values
NRFX_SUCCESSThe operation was successful.
NRFX_ERROR_BUSYThe driver currently handles another operation.
nrfx_err_t nrfx_qspi_cinstr_xfer ( nrf_qspi_cinstr_conf_t const *  p_config,
void const *  p_tx_buffer,
void *  p_rx_buffer 
)

Function for sending operation code, sending data, and receiving data from the memory device.

Use this function to transfer configuration data to memory and to receive data from memory. Pointers can be addresses from flash memory. This function is a synchronous function and should be used only if necessary.

Parameters
[in]p_configPointer to the structure with opcode and transfer configuration.
[in]p_tx_bufferPointer to the array with data to send. Can be NULL if only opcode is transmitted.
[out]p_rx_bufferPointer to the array for data to receive. Can be NULL if there is nothing to receive.
Return values
NRFX_SUCCESSThe operation was successful.
NRFX_ERROR_TIMEOUTThe external memory is busy or there are connection issues.
NRFX_ERROR_BUSYThe driver currently handles other operation.
nrfx_err_t nrfx_qspi_erase ( nrf_qspi_erase_len_t  length,
uint32_t  start_address 
)

Function for starting erasing of one memory block - 4KB, 64KB, or the whole chip.

Write, read, and erase operations check memory device busy state before starting the operation. If the memory is busy, the resulting action depends on the mode in which the erase operation is used:

  • blocking mode (without handler) - a delay occurs until the last operation runs or until the operation data is being sent.
  • interrupt mode (with handler) - event emission occurs after the last operation and sending of operation data are finished. To manually control operation execution in the memory device, use nrfx_qspi_mem_busy_check after executing the erase function. Remember that an incoming event signalizes only that data was sent to the memory device and the periheral before the erase operation checked if memory was busy.
Parameters
[in]lengthSize of data to erase. See nrf_qspi_erase_len_t.
[in]start_addressMemory address to start erasing. If chip erase is performed, address field is ommited.
Return values
NRFX_SUCCESSThe operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_INVALID_ADDRThe provided start address is not aligned to a 32-bit word.
NRFX_ERROR_BUSYThe driver currently handles another operation.
nrfx_err_t nrfx_qspi_init ( nrfx_qspi_config_t const *  p_config,
nrfx_qspi_handler_t  handler,
void *  p_context 
)

Function for initializing the QSPI driver instance.

This function configures the peripheral and its interrupts, and activates it. During the activation process, the internal clocks are started and the QSPI peripheral tries to read the status byte to read the busy bit. Reading the status byte is done in a simple poll and wait mechanism. If the busy bit is 1, this indicates issues with the external memory device. As a result, nrfx_qspi_init returns NRFX_ERROR_TIMEOUT.

In case of issues:

  • Check the connection.
  • Make sure that the memory device does not perform other operations like erasing or writing.
  • Check if there is a short circuit.
Parameters
[in]p_configPointer to the structure with the initial configuration.
[in]handlerEvent handler provided by the user. If NULL, transfers will be performed in blocking mode.
[in]p_contextPointer to context. Use in the interrupt handler.
Return values
NRFX_SUCCESSInitialization was successful.
NRFX_ERROR_TIMEOUTThe peripheral cannot connect with external memory.
NRFX_ERROR_INVALID_STATEThe driver was already initialized.
NRFX_ERROR_INVALID_PARAMThe pin configuration was incorrect.
nrfx_err_t nrfx_qspi_lfm_start ( nrf_qspi_cinstr_conf_t const *  p_config)

Function for starting the custom instruction long frame mode.

The long frame mode is a mechanism that allows for arbitrary byte length custom instructions. Use this function to initiate a custom transaction by sending custom instruction opcode. To send and receive data, use nrfx_qspi_lfm_xfer.

Parameters
[in]p_configPointer to the structure with custom instruction opcode and transfer configuration. Transfer length must be set to NRF_QSPI_CINSTR_LEN_1B.
Return values
NRFX_SUCCESSOperation was successful.
NRFX_ERROR_BUSYDriver currently handles other operation.
NRFX_ERROR_TIMEOUTExternal memory is busy or there are connection issues.
nrfx_err_t nrfx_qspi_lfm_xfer ( void const *  p_tx_buffer,
void *  p_rx_buffer,
size_t  transfer_length,
bool  finalize 
)

Function for sending and receiving data in the custom instruction long frame mode.

Both specified buffers must be at least transfer_length bytes in size.

Parameters
[in]p_tx_bufferPointer to the array with data to send. Can be NULL if there is nothing to send.
[out]p_rx_bufferPointer to the array for receiving data. Can be NULL if there is nothing to receive.
[in]transfer_lengthNumber of bytes to send and receive.
[in]finalizeTrue if custom instruction long frame mode is to be finalized after this transfer.
Return values
NRFX_SUCCESSOperation was successful.
NRFX_ERROR_TIMEOUTExternal memory is busy or there are connection issues. Long frame mode becomes deactivated.
nrfx_err_t nrfx_qspi_mem_busy_check ( void  )

Function for getting the current driver status and status byte of memory device with testing WIP (write in progress) bit.

Return values
NRFX_SUCCESSThe driver and memory are ready to handle a new operation.
NRFX_ERROR_BUSYThe driver or memory currently handle another operation.
nrfx_err_t nrfx_qspi_read ( void *  p_rx_buffer,
size_t  rx_buffer_length,
uint32_t  src_address 
)

Function for reading data from the QSPI memory.

Write, read, and erase operations check memory device busy state before starting the operation. If the memory is busy, the resulting action depends on the mode in which the read operation is used:

  • blocking mode (without handler) - a delay occurs until the last operation runs and until the operation data is being read.
  • interrupt mode (with handler) - event emission occurs after the last operation and reading of data are finished.
Parameters
[out]p_rx_bufferPointer to the receive buffer.
[in]rx_buffer_lengthSize of the data to read.
[in]src_addressAddress in memory to read from.
Return values
NRFX_SUCCESSThe operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSYThe driver currently handles another operation.
NRFX_ERROR_INVALID_ADDRThe provided buffer is not placed in the Data RAM region or its address is not aligned to a 32-bit word.
nrfx_err_t nrfx_qspi_write ( void const *  p_tx_buffer,
size_t  tx_buffer_length,
uint32_t  dst_address 
)

Function for writing data to QSPI memory.

Write, read, and erase operations check memory device busy state before starting the operation. If the memory is busy, the resulting action depends on the mode in which the write operation is used:

  • blocking mode (without handler) - a delay occurs until the last operation runs or until the operation data is being sent.
  • interrupt mode (with handler) - event emission occurs after the last operation and sending of operation data are finished. To manually control operation execution in the memory device, use nrfx_qspi_mem_busy_check after executing the write function. Remember that an incoming event signalizes only that data was sent to the memory device and the periheral before the write operation checked if memory was busy.
Parameters
[in]p_tx_bufferPointer to the writing buffer.
[in]tx_buffer_lengthSize of the data to write.
[in]dst_addressAddress in memory to write to.
Return values
NRFX_SUCCESSThe operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSYThe driver currently handles other operation.
NRFX_ERROR_INVALID_ADDRThe provided buffer is not placed in the Data RAM region or its address is not aligned to a 32-bit word.

Documentation feedback | Developer Zone | Subscribe | Updated