QSPI driver

group nrfx_qspi

Quad Serial Peripheral Interface (QSPI) peripheral driver.

Defines

NRFX_QSPI_DEFAULT_CONFIG(_pin_sck, _pin_csn, _pin_io0, _pin_io1, _pin_io2, _pin_io3)

QSPI instance default configuration.

This configuration sets up QSPI with the following options:

no offset for address in the external memory for Execute in Place operation
single data line
FAST_READ opcode for reading
PP opcode for writing
24 bit addressing mode
Deep Power-down disabled
clock frequency: 2 MHz for nRF52 Series, 6 MHz for nRF53 Series
SCK delay 5 clock ticks
500 milliseconds operation timeout
mode 0 (data captured on the clock rising edge and transmitted on a falling edge. Clock base level is ‘0’)

Parameters:

_pin_sck – [in] Pin for clock signal.
_pin_csn – [in] Pin for chip select signal.
_pin_io0 – [in] Pin 0 for I/O data.
_pin_io1 – [in] Pin 1 for I/O data.
_pin_io2 – [in] Pin 2 for I/O data.
_pin_io3 – [in] Pin 3 for I/O data.

NRFX_QSPI_DEFAULT_CINSTR(opc, len): QSPI custom instruction helper with the default configuration.

Typedefs

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

Enums

enum nrfx_qspi_evt_t

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

Values:

enumerator NRFX_QSPI_EVENT_DONE: Transfer done.

enum nrfx_qspi_evt_ext_type_t

QSPI master driver extended event types, obtained using nrfx_qspi_event_extended_get() function.

Values:

enumerator NRFX_QSPI_EVENT_NONE: No event occurence.

enumerator NRFX_QSPI_EVENT_WRITE_DONE: Write done.

enumerator NRFX_QSPI_EVENT_READ_DONE: Read done.

enumerator NRFX_QSPI_EVENT_ERASE_DONE: Erase done.

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.

This function configures the peripheral and its interrupts.

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.

Note

The function does not activate the peripheral instance. The activation is done during the first transfer after initialization or when calling nrfx_qspi_activate function. The activation process starts the internal clocks, and the QSPI peripheral tries to read the status byte to check the busy bit. Reading the status byte is done in a simple poll and wait mechanism. If the busy bit is set, this indicates issues with the external memory device. As a result, transfer functions return NRFX_ERROR_TIMEOUT.

Warning

On nRF5340, only the dedicated pins with NRF_GPIO_PIN_SEL_PERIPHERAL configuration are supported. See the chapter Pin assignments in the Product Specification.

Parameters:

p_config – [in] Pointer to the structure with the initial configuration.
handler – [in] Event handler provided by the user. If NULL, transfers will be performed in blocking mode.
p_context – [in] Pointer to context. Use in the interrupt handler.

Return values:

NRFX_SUCCESS – Initialization was successful.
NRFX_ERROR_ALREADY – The driver is already initialized.
NRFX_ERROR_INVALID_STATE – The driver is already initialized. Deprecated - use NRFX_ERROR_ALREADY instead.
NRFX_ERROR_INVALID_PARAM – The pin configuration was incorrect.

nrfx_err_t nrfx_qspi_reconfigure(nrfx_qspi_config_t const *p_config)

Function for reconfiguring the QSPI driver instance.

Warning

The function deactivates the peripheral instance. The activation is done during the first transfer after reconfiguration or when calling nrfx_qspi_activate function.

Parameters:

p_config – [in] Pointer to the structure with the configuration.

Return values:

NRFX_SUCCESS – Reconfiguration was successful.
NRFX_ERROR_BUSY – The driver is during transaction.
NRFX_ERROR_TIMEOUT – External memory is busy or there are connection issues.
NRFX_ERROR_INVALID_STATE – The driver is uninitialized.
NRFX_ERROR_INVALID_PARAM – The pin configuration was incorrect.

void nrfx_qspi_uninit(void): Function for uninitializing the QSPI driver instance.

Note

If a custom instruction long transfer is ongoing when the function is called, the transfer will be interrupted.

nrfx_err_t nrfx_qspi_activate(bool wait)

Function for activating the QSPI driver instance.

Parameters:

wait – [in] True if activation is to be in blocking mode, false otherwise.

Return values:

NRFX_SUCCESS – The driver instance has been activated.
NRFX_ERROR_ALREADY – The driver is already activated.
NRFX_ERROR_TIMEOUT – External memory is busy, or there are connection issues.

nrfx_err_t nrfx_qspi_deactivate(void)

Function for deactivating the QSPI driver instance.

Note

If a custom instruction long transfer is ongoing when the function is called, the transfer will be interrupted.

Return values:

NRFX_SUCCESS – The driver instance has been activated.
NRFX_ERROR_BUSY – The driver is during transaction.

bool nrfx_qspi_init_check(void)

Function for checking if the QSPI driver is initialized.

Return values:

true – Driver is already initialized.
false – Driver is not initialized.

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. In interrupt mode read operations can be double-buffered by calling the function again. To utilize double-buffering feature, NRF_QSPI_TASK_READSTART needs to be triggered on NRF_QSPI_EVENT_READY externally (for example by using the PPI/DPPI).

Note

If that is the first operation after activation of driver initialization has been triggered, the activation process starts the internal clocks and the QSPI peripheral tries to read the status byte to check the busy bit. Reading the status byte is done in a simple poll and wait mechanism. If the busy bit is set, this indicates that the memory may not be ready yet. As a result, the function returns NRFX_ERROR_TIMEOUT.

Parameters:

p_rx_buffer – [out] Pointer to the receive buffer.
rx_buffer_length – [in] Size of the data to read.
src_address – [in] Address in memory to read from.

Return values:

NRFX_SUCCESS – The operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSY – The driver currently handles another operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_INVALID_ADDR – The provided buffer is not placed in the Data RAM region or its address is not aligned to a 32-bit word.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

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 peripheral before the write operation checked if memory was busy. In interrupt mode write operations can be double-buffered by calling the function again. To utilize double-buffering feature, NRF_QSPI_TASK_WRITESTART needs to be triggered on NRF_QSPI_EVENT_READY externally (for example by using the PPI/DPPI).

Note

Refer to the note for nrfx_qspi_read.

Parameters:

p_tx_buffer – [in] Pointer to the writing buffer.
tx_buffer_length – [in] Size of the data to write.
dst_address – [in] Address in memory to write to.

Return values:

NRFX_SUCCESS – The operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSY – The driver currently handles other operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_INVALID_ADDR – The provided buffer is not placed in the Data RAM region or its address is not aligned to a 32-bit word.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

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.

Note

Refer to the note for nrfx_qspi_read.

Parameters:

length – [in] Size of data to erase. See nrf_qspi_erase_len_t.
start_address – [in] Memory address to start erasing. If chip erase is performed, address field is ommited.

Return values:

NRFX_SUCCESS – The operation was successful (blocking mode) or operation was commissioned (handler mode).
NRFX_ERROR_BUSY – The driver currently handles another operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_INVALID_ADDR – The provided start address is not aligned to a 32-bit word.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

nrfx_err_t nrfx_qspi_chip_erase(void)

Function for starting an erase operation of the whole chip.

Note

Refer to the note for nrfx_qspi_read.

Return values:

NRFX_SUCCESS – The operation was successful (blocking mode) or commissioned (handler mode).
NRFX_ERROR_BUSY – The driver currently is handling another operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

nrfx_qspi_evt_ext_t const *nrfx_qspi_event_extended_get(void)

Function for getting the extended event associated with finished operation.

Returns:: Pointer to the extended event associated with finished operation.

bool nrfx_qspi_xfer_buffered_check(void)

Function for checking whether any write or read data transfer is buffered.

Returns:: True if there is a transfer buffered, false otherwise.

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_SUCCESS – The driver and memory are ready to handle a new operation.
NRFX_ERROR_BUSY – The driver currently is handling another operation.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

void nrfx_qspi_timeout_signal(void)

Function for signaling premature operation timeout.

The function provides a mechanism that can cause premature timeout when the driver is waiting for the READY event. This allows to use external source of the timeout. If the driver is initialized with a handler, it will not process the event generated for the transfer.

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.

Note

Refer to the note for nrfx_qspi_read.

Note

Please note that the NRFX_QSPI_DEFAULT_CINSTR macro provides default values for the io2_level and io3_level fields that cause the IO2 and IO3 lines to be kept low during the custom instruction transfer. Such configuration may not be suitable in certain circumstances and memory devices can interpret such levels of those lines as active WP# and HOLD#/RESET# signals, respectively. Hence, it is safer to use a configuration that will keep the lines high during the transfer.

Parameters:

p_config – [in] Pointer to the structure with opcode and transfer configuration.
p_tx_buffer – [in] Pointer to the array with data to send. Can be NULL if only opcode is transmitted.
p_rx_buffer – [out] Pointer to the array for data to receive. Can be NULL if there is nothing to receive.

Return values:

NRFX_SUCCESS – The operation was successful.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_BUSY – The driver currently handles other operation.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

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.

Note

Refer to the note for nrfx_qspi_read.

Parameters:

opcode – [in] Operation code. Sending first.
length – [in] Length of the data to send and opcode. See nrf_qspi_cinstr_len_t.
p_tx_buffer – [in] Pointer to input data array.

Return values:

NRFX_SUCCESS – The operation was successful.
NRFX_ERROR_BUSY – The driver currently handles another operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

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.

Note

Refer to the note for nrfx_qspi_read.

Note

Please note that the NRFX_QSPI_DEFAULT_CINSTR macro provides default values for the io2_level and io3_level fields that cause the IO2 and IO3 lines to be kept low during the custom instruction transfer. Such configuration may not be suitable in certain circumstances and memory devices can interpret such levels of those lines as active WP# and HOLD#/RESET# signals, respectively. Hence, it is safer to use a configuration that will keep the lines high during the transfer.

Parameters:

p_config – [in] Pointer to the structure with custom instruction opcode and transfer configuration. Transfer length must be set to NRF_QSPI_CINSTR_LEN_1B.

Return values:

NRFX_SUCCESS – Operation was successful.
NRFX_ERROR_BUSY – Driver currently handles other operation.
NRFX_ERROR_TIMEOUT – The external memory is busy, or there are connection issues.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

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.

Note

Refer to the note for nrfx_qspi_read.

Parameters:

p_tx_buffer – [in] Pointer to the array with data to send. Can be NULL if there is nothing to send.
p_rx_buffer – [out] Pointer to the array for receiving data. Can be NULL if there is nothing to receive.
transfer_length – [in] Number of bytes to send and receive.
finalize – [in] True if custom instruction long frame mode is to be finalized after this transfer.

Return values:

NRFX_SUCCESS – Operation was successful.
NRFX_ERROR_TIMEOUT – External memory is busy or there are connection issues. Long frame mode becomes deactivated.
NRFX_ERROR_FORBIDDEN – The operation could trigger nRF5340 anomaly 159 due to the current configuration of clocks. Refer to the errata document for more information.

nrfx_err_t nrfx_qspi_xip_encrypt(nrf_qspi_encryption_t const *p_config)

Function for setting the XIP encryption.

Parameters:

p_config – [in] XIP encryption configuration structure. To disable encryption, pass NULL pointer as argument.

Return values:

NRFX_SUCCESS – Operation was successful.
NRFX_ERROR_BUSY – Driver currently handles other operation.

nrfx_err_t nrfx_qspi_dma_encrypt(nrf_qspi_encryption_t const *p_config)

Function for setting the EasyDMA encryption.

Parameters:

p_config – [in] DMA encryption configuration structure. To disable encryption, pass NULL pointer as argument.

Return values:

NRFX_SUCCESS – Operation was successful.
NRFX_ERROR_BUSY – Driver currently handles other operation.

struct nrfx_qspi_config_t

#include <nrfx_qspi.h>

QSPI driver instance configuration structure.

Public Members

uint32_t xip_offset: Address offset into the external memory for Execute in Place operation.

nrf_qspi_pins_t pins: Pin configuration structure.

nrf_qspi_prot_conf_t prot_if: Protocol layer interface configuration structure.

nrf_qspi_phy_conf_t phy_if: Physical layer interface configuration structure.

uint32_t timeout: Time in milliseconds used in timeout counter.

uint8_t irq_priority: Interrupt priority.

bool skip_gpio_cfg

Skip GPIO configuration of pins.

When set to true, the driver does not modify any GPIO parameters of the used pins. Those parameters are supposed to be configured externally before the driver is initialized.

bool skip_psel_cfg

Skip pin selection configuration.

When set to true, the driver does not modify pin select registers in the peripheral. Those registers are supposed to be set up externally before the driver is initialized.

Note

When both GPIO configuration and pin selection are to be skipped, the structure fields that specify pins can be omitted, as they are ignored anyway.

struct nrfx_qspi_evt_ext_erase_t

#include <nrfx_qspi.h>

QSPI driver erase event data.

Public Members

uint32_t addr: Erase start address.

nrf_qspi_erase_len_t len: Erase length.

struct nrfx_qspi_evt_ext_xfer_t

#include <nrfx_qspi.h>

QSPI driver transfer event data.

Public Members

void *p_buffer: Pointer to the data buffer associated with transfer.

size_t size: Data buffer size.

uint32_t addr: Transfer start address.

struct nrfx_qspi_evt_ext_t

#include <nrfx_qspi.h>

QSPI driver extended event structure.

Public Members

nrfx_qspi_evt_ext_type_t type: Extended event type.

nrfx_qspi_evt_ext_xfer_t xfer: Data for write or read transfer event.

nrfx_qspi_evt_ext_erase_t erase: Data for erase event.

union nrfx_qspi_evt_ext_t.[anonymous] data: Union to store event data.