Expanded Serial Peripheral Interface (xSPI) QSPI (r_xspi_qspi)

Functions
fsp_err_t	R_XSPI_QSPI_Open (spi_flash_ctrl_t *p_ctrl, spi_flash_cfg_t const *const p_cfg)
fsp_err_t	R_XSPI_QSPI_Close (spi_flash_ctrl_t *p_ctrl)
fsp_err_t	R_XSPI_QSPI_DirectWrite (spi_flash_ctrl_t *p_ctrl, uint8_t const *const p_src, uint32_t const bytes, bool const read_after_write)
fsp_err_t	R_XSPI_QSPI_DirectRead (spi_flash_ctrl_t *p_ctrl, uint8_t *const p_dest, uint32_t const bytes)
fsp_err_t	R_XSPI_QSPI_SpiProtocolSet (spi_flash_ctrl_t *p_ctrl, spi_flash_protocol_t spi_protocol)
fsp_err_t	R_XSPI_QSPI_XipEnter (spi_flash_ctrl_t *p_ctrl)
fsp_err_t	R_XSPI_QSPI_XipExit (spi_flash_ctrl_t *p_ctrl)
fsp_err_t	R_XSPI_QSPI_Write (spi_flash_ctrl_t *p_ctrl, uint8_t const *const p_src, uint8_t *const p_dest, uint32_t byte_count)
fsp_err_t	R_XSPI_QSPI_Erase (spi_flash_ctrl_t *p_ctrl, uint8_t *const p_device_address, uint32_t byte_count)
fsp_err_t	R_XSPI_QSPI_StatusGet (spi_flash_ctrl_t *p_ctrl, spi_flash_status_t *const p_status)
fsp_err_t	R_XSPI_QSPI_BankSet (spi_flash_ctrl_t *p_ctrl, uint32_t bank)
fsp_err_t	R_XSPI_QSPI_DirectTransfer (spi_flash_ctrl_t *p_ctrl, spi_flash_direct_transfer_t *const p_transfer, spi_flash_direct_transfer_dir_t direction)
fsp_err_t	R_XSPI_QSPI_AutoCalibrate (spi_flash_ctrl_t *p_ctrl)

Detailed Description

Driver for the xSPI peripheral on RZ microprocessor. This module implements the SPI Flash Interface.

Overview

Features

The xSPI QSPI driver has the following key features:

• Memory mapped read access to the QSPI flash
• Programming the QSPI flash device
• Erasing the QSPI flash device
• Sending device specific commands and reading back responses
• Supports each xSPI protocol
• Entering and exiting XIP mode
• 3 or 4 byte addressing
• Supports combination function during write access of memory-mapping mode
• Configurable prefetch function during read transaction in memory-mapping mode
• On-The-Fly Decryption (OTFD)
• Optional DMAC support for data transmission when used with xSPI_QSPI.

Note

1. The available chip select lines may differ between devices. A full list of selectable chip select lines is available in the User's Manual for your device.

2. When using serial flash memory without a hardware reset pin, if this LSI is reset after the serial flash protocol setting has been changed from 1S-1S-1S protocol to another protocol mode by the user program, the protocol mode of the boot program does not coincide with the protocol mode of the serial flash memory, which causes a boot error.

Configuration

Build Time Configurations for r_xspi_qspi

The following build time configurations are defined in driver/r_xspi_qspi_cfg.h:

Configuration	Options	Default	Description
Memory Mapping Address Space > Unit 0 > Chip Select 0 > Start Address	Address should be the start address of xspi unit 0 external address space	0x60000000	Start address of xSPI Unit 0 Chip Select 0 in memory mapping mode.
Memory Mapping Address Space > Unit 0 > Chip Select 0 > End Address	Address should be within xspi unit 0 external address space	0x600FFFFF	End address of xSPI Unit 0 Chip Select 1 in memory mapping mode.
Memory Mapping Address Space > Unit 0 > Chip Select 1 > Start Address	Address should be within xspi unit 0 external address space	0x64000000	Start address of xSPI Unit 0 Chip Select 1 in memory mapping mode.
Memory Mapping Address Space > Unit 0 > Chip Select 1 > End Address	Address should be within xspi unit 0 external address space	0x640FFFFF	End address of xSPI Unit 0 Chip Select 1 in memory mapping mode.
Memory Mapping Address Space > Unit 1 > Chip Select 0 > Start Address	Address should be the start address of xspi unit 1 external address space	0x68000000	Start address of xSPI Unit 1 Chip Select 0 in memory mapping mode.
Memory Mapping Address Space > Unit 1 > Chip Select 0 > End Address	Address should be within xspi unit 1 external address space	0x680FFFFF	End address of xSPI Unit 1 Chip Select 0 in memory mapping mode.
Memory Mapping Address Space > Unit 1 > Chip Select 1 > Start Address	Address should be within xspi unit 1 external address space	0x6C000000	Start address of xSPI Unit 1 Chip Select 1 in memory mapping mode.
Memory Mapping Address Space > Unit 1 > Chip Select 1 > End Address	Address should be within xspi unit 1 external address space	0x6C0FFFFF	End address of xSPI Unit 1 Chip Select 1 in memory mapping mode.
Memory Mapping Address Space > Memory Mapping Address Space Configuration Support	MCU Specific Options		Support status of Memory Mapping Address Space setting on this MCU. If Not supported, the address space set in Memory Mapping Address Space is invalid.
Parameter Checking	Default (BSP) Enabled Disabled	Default (BSP)	If selected code for parameter checking is included in the build.
Unit 0 Prefetch Function	Enable Disable	Disable	Enable prefetch function on memory-mapped reads of xSPI Unit 0.
Unit 1 Prefetch Function	Enable Disable	Disable	Enable prefetch function on memory-mapped reads of xSPI Unit 1.
Unit 0 IO voltage	MCU Specific Options		Voltage setting of xSPI Unit 0.
Unit 1 IO voltage	MCU Specific Options		Voltage setting of xSPI Unit 1.
DMAC Support	Enable Disable	Disable	Enable DMAC support for the QSPI module.
OTFD Support	MCU Specific Options		Enable OTFD support for the xSPI module.

Configurations for Storage > QSPI (r_xspi_qspi)

This module can be added to the Stacks tab via New Stack > Storage > QSPI (r_xspi_qspi).

Configuration	Options	Default	Description
General > Name	Name must be a valid C symbol	g_qspi0	Module name.
General > unit	Unit should be 0 or 1	0	Specify the xSPI unit number.
General > Chip Select	Chip Select 0 Chip Select 1	Chip Select 0	Specify the XSPI chip select line to use.
General > Flash Size	MCU Specific Options		Specify the QSPI Flash size.
General > SPI Protocol	1S-1S-1S 4S-4D-4D 1S-2S-2S 2S-2S-2S 1S-4S-4S 4S-4S-4S	1S-1S-1S	Select the initial SPI protocol. SPI protocol can be changed in R_XSPI_QSPI_SpiProtocolSet().
General > Address Bytes	3 4	3	Select the number of address bytes. If 4-byte mode is selected, the application must issue the EN4B command using R_XSPI_QSPI_DirectTransfer().
General > Dummy Clocks for Read	Refer to the RZT Configuration tool for available options.	8	Select the number of dummy clocks for read operations.
Command Definitions > Page Program Command	Must be an 8-bit QSPI command	0x02	The command to program a page.
Command Definitions > Read Command	Must be an 8-bit QSPI command	0x03	The command to read.
Command Definitions > Write Enable Command	Must be an 8-bit QSPI command	0x06	The command to enable write.
Command Definitions > Status Command	Must be an 8-bit QSPI command	0x05	The command to query the status of a write or erase command.
Command Definitions > Write Status Bit	Must be an integer between 0 and 7	0	Which bit contains the write in progress status returned from the Write Status Command.
Command Definitions > Write Enable Bit	Must be an integer between 0 and 7	1	Which bit contains the write enable status returned from the Write Status Command.
Command Definitions > Sector Erase Command	Must be an 8-bit QSPI command	0x20	The command to erase a sector. Set Sector Erase Size to 0 if unused.
Command Definitions > Sector Erase Size	Must be an integer greater than or equal to 0	4096	The sector erase size. Set Sector Erase Size to 0 if Sector Erase is not supported.
Command Definitions > Block Erase Command	Must be an 8-bit QSPI command	0xD8	The command to erase a block. Set Block Erase Size to 0 if unused.
Command Definitions > Block Erase Size	Must be an integer greater than or equal to 0	65536	The block erase size. Set Block Erase Size to 0 if Block Erase is not supported.
Command Definitions > Block Erase 32KB Command	Must be an 8-bit QSPI command	0x52	The command to erase a 32KB block. Set Block Erase Size to 0 if unused.
Command Definitions > Block Erase 32KB Size	Must be an integer greater than or equal to 0	32768	The block erase 32KB size. Set Block Erase 32KB Size to 0 if Block Erase 32KB is not supported.
Command Definitions > Chip Erase Command	Must be an 8-bit QSPI command	0xC7	The command to erase the entire chip. Set Chip Erase Command to 0 if unused.
Command Definitions > XIP Enter M7-M0	Must be an 8-bit QSPI command	0x20	How to set M7-M0 to enter XIP mode.
Command Definitions > XIP Exit M7-M0	Must be an 8-bit QSPI command	0xFF	How to set M7-M0 exit XIP mode.
Bus Timing > CS minimum idle term	Refer to the RZT Configuration tool for available options.	7 CYCLES	Define the CS minimum idle term.
Bus Timing > CS asserting extension	No Extension Extend 1 cycle	No Extension	Define the CS asserting extension
Bus Timing > CS negating extension	No Extension Extend 1 cycle	No Extension	Define the CS negating extension
OTFD > OTFD Support for Unit	Enabled Disabled	Disabled	Enable OTFD support for the unit.
OTFD > Name	Name must be a valid C symbol	g_qspi0_otfd	OTFD Configuration name.
OTFD > AES Key	Name must be a valid C symbol	g_qspi0_otfd_key	Name of Key variable.
OTFD > AES IV	Name must be a valid C symbol	g_qspi0_otfd_iv	Name of IV variable.
OTFD > AES Key Length	128 256	128	Select AES key length.
OTFD > Decryption start address	Value must be an integer between 0x60000000 and 0x6FFFFFFF	0x60000000	xSPI decryption start address. Do not select mirror area.
OTFD > Decryption end address	Value must be an integer between 0x60000000 and 0x6FFFFFFF	0x60001FFF	xSPI decryption end address. Do not select mirror area.

Clock Configuration

The QSPI clock is derived from XSPI_CLKn. You can set the clock frequency using the Clocks tab of the FSP Configuration editor or by using the CGC Interface at run-time.

Pin Configuration

The following pins are available to connect to an external QSPI device:

• XSPIn_CKP: QSPI clock output
• XSPIn_CS0, XSPIn_CS1: QSPI slave select
• XSPIn_IO0: Data 0 I/O
• XSPIn_IO1: Data 1 I/O
• XSPIn_IO2: Data 2 I/O
• XSPIn_IO3: Data 3 I/O

Note

It is recommended to configure the pins with IOPORT_CFG_DRIVE_HIGH.

Usage Notes

xSPI_QSPI Memory Mapped Access

After R_XSPI_QSPI_Open() completes successfully, the QSPI Flash device contents are mapped to External Address Space xSPIn or their mirror spaces and can be read like on-chip flash. Please refer to xSPI "Overview" section in your device's manual on address map details.

In the configurator properties, 'Memory Mapping Address Space Configuration Support' is set to either 'Supported' or 'Not Supported' depending on your device. The method of memory mapped access address configuration depends on the value of 'Memory Mapping Address Space Configuration Support'.

Example Configurations for the Device 'Memory Mapping Address Space Configuration Support' is 'Supported'

If 'Memory Mapping Address Space Configuration Support' is 'Supported', 'Memory Mapping Address Space' should be set appropriately for your device. The table below shows an example of 'Memory Mapping Address Space' configurations when 64MB flash is used as a slave device in each Chip Select.

Properties	RZ/T2ME	RZ/T2H
Memory Mapping Address Space > Unit 0 > Chip Select 0 > Start Address	0x60000000 (Fixed)	0x40000000 (Fixed)
Memory Mapping Address Space > Unit 0 > Chip Select 0 > End Address	0x63FFFFFF	0x43FFFFFF
Memory Mapping Address Space > Unit 0 > Chip Select 1 > Start Address	0x64000000	0x48000000
Memory Mapping Address Space > Unit 0 > Chip Select 1 > End Address	0x67FFFFFF	0x4BFFFFFF
Memory Mapping Address Space > Unit 1 > Chip Select 0 > Start Address	0x68000000 (Fixed)	0x50000000 (Fixed)
Memory Mapping Address Space > Unit 1 > Chip Select 0 > End Address	0x6BFFFFFF	0x53FFFFFF
Memory Mapping Address Space > Unit 1 > Chip Select 1 > Start Address	0x6C000000	0x58000000
Memory Mapping Address Space > Unit 1 > Chip Select 1 > End Address	0x6FFFFFFF	0x5BFFFFFF
Memory Mapping Address Space > Memory Mapping Address Space Configuration Support	Supported	Supported

The address space of each chip select set by the above configuration is as follows.

Address Space of Each Chip Select	RZ/T2ME	RZ/T2H
Unit 0 Chip Select 0 Start Address	0x60000000 (Fixed)	0x40000000 (Fixed)
Unit 0 Chip Select 0 End Address	0x63FFFFFF	0x43FFFFFF
Unit 0 Chip Select 1 Start Address	0x64000000	0x48000000
Unit 0 Chip Select 1 End Address	0x67FFFFFF	0x4BFFFFFF
Unit 1 Chip Select 0 Start Address	0x68000000 (Fixed)	0x50000000 (Fixed)
Unit 1 Chip Select 0 End Address	0x6BFFFFFF	0x53FFFFFF
Unit 1 Chip Select 1 Start Address	0x6C000000	0x58000000
Unit 1 Chip Select 1 End Address	0x6FFFFFFF	0x5BFFFFFF

Example Configurations for the Device 'Memory Mapping Address Space Configuration Support' is 'Not Supported'

If 'Memory Mapping Address Space Configuration Support' is 'Not Supported' for your device, 'Memory Mapping Address Space' configurations are invalid. In this case, the start address of each chip select is fixed by device, and only the size of the address space is configured in 'Flash Size' property. The table below shows an example of the address space configuration when 64MB flash is used as a slave device in Unit 0 Chip Select 0.

Properties	RZ/T2M	RZ/T2L
Memory Mapping Address Space > Memory Mapping Address Space Configuration Support	Not Supported	Not Supported
General > Unit	0	0
General > Chip Select	0	0
General > Flash Size	64MB	64MB

The address space of each chip select set by the above configuration is as follows.

Address Space of Each Chip Select	RZ/T2M	RZ/T2L
Unit 0 Chip Select 0 Start Address	0x60000000 (Fixed)	0x60000000 (Fixed)
Unit 0 Chip Select 0 End Address	0x63FFFFFF (64MB Size)	0x63FFFFFF (64MB Size)
Unit 0 Chip Select 1 Start Address	0x64000000 (Fixed)	0x64000000 (Fixed)
Unit 0 Chip Select 1 End Address	0x640FFFFF (default)	0x640FFFFF (default)
Unit 1 Chip Select 0 Start Address	0x68000000 (Fixed)	0x68000000 (Fixed)
Unit 1 Chip Select 0 End Address	0x680FFFFF (default)	0x680FFFFF (default)
Unit 1 Chip Select 1 Start Address	0x6C000000 (Fixed)	0x6C000000 (Fixed)
Unit 1 Chip Select 1 End Address	0x6C0FFFFF (default)	0x6C0FFFFF (default)

Limitations

• Prefetch function support for memory-mapping access is applied to all slave devices connected xSPI0 or xSPI1. When using different types of xSPI modules (for example, xSPI_QSPI and xSPI_OSPI) to same xSPI unit, make sure that the prefetch function settings in the configurator properties are the same.
• In the configurator properties, when 'Memory Mapping Address Space Configuration Support' is 'Supported', memory mapping address space settings are applied to all slave devices connected xSPI0 or xSPI1. When using different types of xSPI modules (for example, xSPI_QSPI and xSPI_OSPI), make sure that 'Memory Mapping Address Space' settings are the same for all xSPI modules.
• Take care to restrict concurrent accesses of the xSPI address space. Collisions on the bus can occur if other bus masters attempt to write to the xSPI address space while another master is reading the xSPI address space.

Examples

Basic Example

This is a basic example of minimal use of the QSPI in an application. When using the section definition in the example below, the user must define it separately in the linker configuration file.

Note

In CA55 flash boot environment, when placing functions in a section allocated in xSPI space, edit linker script and put 64 bytes align between _mtext and _mdata in .flash_contents section.

#define QSPI_EXAMPLE_DATA_LENGTH    (1024)

uint8_t g_dest[QSPI_EXAMPLE_DATA_LENGTH];

/* Place data in the .qspi_flash section to flash it during programming. */
const uint8_t g_src[QSPI_EXAMPLE_DATA_LENGTH] BSP_PLACE_IN_SECTION(".qspi_flash") = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";

/* Place code in the .code_in_qspi section to flash it during programming. */
void r_qspi_example_function(void) BSP_PLACE_IN_SECTION(".code_in_qspi") __attribute__((noinline));

void r_qspi_example_function (void)
{
    /* Add code here. */
}

void r_qspi_basic_example (void)
{

    /* Open the QSPI instance. */
    fsp_err_t err = R_XSPI_QSPI_Open(&g_qspi0_ctrl, &g_qspi0_cfg);
    handle_error(err);


    /* (Optional) Send device specific initialization commands. */
    r_qspi_example_init();

    /* After R_XSPI_QSPI_Open() and any required device specific initialization, data can be read directly from the QSPI flash. */
    memcpy(&g_dest[0], &g_src[0], QSPI_EXAMPLE_DATA_LENGTH);

    /* After R_XSPI_QSPI_Open() and any required device specific initialization, functions in the QSPI flash can be called. */
    r_qspi_example_function();
}

Initialization Command Structure Example

This is an example of the types of commands that can be used to initialize the QSPI.

#define QSPI_COMMAND_WRITE_ENABLE                (0x06U)
#define QSPI_COMMAND_WRITE_STATUS_REGISTER       (0x01U)
#define QSPI_COMMAND_ENTER_QPI_MODE              (0x35U)
#define QSPI_COMMAND_PAGE_PROGRAM                (0x02U)
#define QSPI_COMMAND_WRITE_ENABLE                (0x06U)
#define QSPI_COMMAND_READ_STATUS                 (0x05U)

#define QSPI_EXAMPLE_STATUS_REGISTER             (0x40)
#define QSPI_EXAMPLE_CONFIGURATION_REGISTER      (0x00)
#define QSPI_WEN_BIT_MASK                        (0x02U)

#define QSPI_EXAMPLE_DESTINATION_CHIP_ADDRESS    (0x00000000U)
#define QSPI_FLASH_PAGE_BYTES                    (256U)

static void r_qspi_example_init (void)
{
    spi_flash_direct_transfer_t qspi_direct_transfer =
    {
        .command        = QSPI_COMMAND_WRITE_ENABLE,
        .address        = 0U,
        .data           = 0U,
        .command_length = 1U,
        .address_length = 0U,
        .data_length    = 0U,
        .dummy_cycles   = 0U
    };


    /* Send the Write Enable (WREN) command to enable writing to the status register */
    fsp_err_t err =
        R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_WRITE);
    handle_error(err);


    /* Send the Write Status Register (WRSR) command. Values for status register and configuration register are set in
     * the data field. In the status register, set QE to 1 and other bits to their default setting.
     */
    qspi_direct_transfer.command     = QSPI_COMMAND_WRITE_STATUS_REGISTER;
    qspi_direct_transfer.data        = QSPI_EXAMPLE_CONFIGURATION_REGISTER << 8 | QSPI_EXAMPLE_STATUS_REGISTER;
    qspi_direct_transfer.data_length = 2U;
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_WRITE);
    handle_error(err);

    /* Wait for status register to update. */
    spi_flash_status_t status;
    do
    {
        (void) R_XSPI_QSPI_StatusGet(&g_qspi0_ctrl, &status);
    } while (true == status.write_in_progress);

    /* Execute the Enable QPI (EQPI) command to enter QSPI mode. After entering QPI mode on the device, change the SPI
     * protocol to QPI mode on the MCU peripheral. */
    qspi_direct_transfer.command     = QSPI_COMMAND_ENTER_QPI_MODE;
    qspi_direct_transfer.data        = 0U;
    qspi_direct_transfer.data_length = 0U;
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_WRITE);
    handle_error(err);


    (void) R_XSPI_QSPI_SpiProtocolSet(&g_qspi0_ctrl, SPI_FLASH_PROTOCOL_4S_4S_4S);

}

Reading Status Register Example (R_XSPI_QSPI_DirectTransfer)

This is an example of using R_XSPI_QSPI_DirectTransfer to send the read status register command and read back the status register from the device.

#define QSPI_COMMAND_READ_STATUS_REGISTER    (0x05U)

void r_qspi_direct_example (void)
{
    spi_flash_direct_transfer_t qspi_direct_transfer =
    {
        .command        = QSPI_COMMAND_READ_STATUS_REGISTER,
        .address        = 0U,
        .data           = 0U,
        .command_length = 1U,
        .address_length = 0U,
        .data_length    = 1U,
        .dummy_cycles   = 0U
    };

    /* Open the QSPI instance. */
    fsp_err_t err = R_XSPI_QSPI_Open(&g_qspi0_ctrl, &g_qspi0_cfg);
    handle_error(err);

    /* Read the Status Register */
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_READ);
    handle_error(err);

    /* Status register contents are available in variable 'qspi_direct_transfer.data'. */
}

Querying Device Size Example (R_XSPI_QSPI_DirectTransfer)

This is an example of using R_XSPI_QSPI_DirectTransfer to query the device size.

#define QSPI_EXAMPLE_COMMAND_READ_ID      (0x9F)
#define QSPI_EXAMPLE_COMMAND_READ_SFDP    (0x5A)

void r_qspi_size_example (void)
{
    /* Many QSPI devices support more than one way to query the device size. Consult the datasheet for your
     * QSPI device to determine which of these methods are supported (if any). */
    uint32_t  device_size_bytes;
    fsp_err_t err;

#ifdef QSPI_EXAMPLE_COMMAND_READ_ID
    spi_flash_direct_transfer_t qspi_rdid_direct_transfer =
    {
        .command        = QSPI_EXAMPLE_COMMAND_READ_ID,
        .address        = 0U,
        .data           = 0U,
        .command_length = 1U,
        .address_length = 0U,
        .data_length    = 3U,
        .dummy_cycles   = 0U
    };

    /* This example shows how to get the device size by reading the manufacturer ID. */
    /* Read 3 bytes. The third byte often represents the size of the QSPI, where the size of the QSPI = 2 ^ N. */
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_rdid_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_READ);
    handle_error(err);

    device_size_bytes = 1U << (qspi_rdid_direct_transfer.data >> 16);
    FSP_PARAMETER_NOT_USED(device_size_bytes);
#endif

#ifdef QSPI_EXAMPLE_COMMAND_READ_SFDP
    spi_flash_direct_transfer_t qspi_rdsfdp_direct_transfer =
    {
        .command        = QSPI_EXAMPLE_COMMAND_READ_SFDP,
        .address        = 0x00000CU,
        .data           = 0U,
        .command_length = 1U,
        .address_length = 3U,
        .data_length    = 3U,
        .dummy_cycles   = 8U
    };

    /* Read the Parameter Table Pointer (PTP) of 1st Parameter header to locate the JEDEC flash parameters table.
     * Reference JESD216 "Serial Flash Discoverable Parameters (SFDP)". */

    /* Send the standard 0x5A command followed by 3 address bytes (1st Parameter header's PTP is at address 0xC).
     * 3 byte address of JEDEC flash parameters are read back and stored in qspi_rdsfdp_direct_transfer.data */
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_rdsfdp_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_READ);
    handle_error(err);

    /* Read the JEDEC flash parameters' memory density. */

    /* Send the standard 0x5A command followed by 3 address bytes of Flash memory density (offset 0x04 from JEDEC
     * flash parameters address). Read 4 bytes. */
    qspi_rdsfdp_direct_transfer.command        = QSPI_EXAMPLE_COMMAND_READ_SFDP;
    qspi_rdsfdp_direct_transfer.address        = qspi_rdsfdp_direct_transfer.data + 0x04;
    qspi_rdsfdp_direct_transfer.data           = 0U;
    qspi_rdsfdp_direct_transfer.command_length = 1U;
    qspi_rdsfdp_direct_transfer.address_length = 3U;
    qspi_rdsfdp_direct_transfer.data_length    = 4U;
    qspi_rdsfdp_direct_transfer.dummy_cycles   = 8U;
    err = R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_rdsfdp_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_READ);
    handle_error(err);

    /* Calculate device size based on memory density */
    uint32_t memory_density = qspi_rdsfdp_direct_transfer.data;
    if ((1U << 31) & memory_density)
    {
        /* For densities 4 gigabits and above, bit-31 is set to 1b.  The field 30:0 defines 'N' where the density is
         * computed as 2^N bits (N must be >= 32). This code subtracts 3 from N to divide by 8 to get the size in
         * bytes instead of bits. */
        device_size_bytes = 1U << ((memory_density & ~(1U << 31)) - 3U);
    }
    else
    {
        /* For densities 2 gigabits or less, bit-31 is set to 0b.  The field 30:0 defines the size in bits. This
         * code divides the memory density by 8 to get the size in bytes instead of bits. */
        device_size_bytes = (memory_density / 8) + 1;
    }
    FSP_PARAMETER_NOT_USED(device_size_bytes);
#endif
}

Memory Write Example for RZ/T2M and RZ/T2L (R_XSPI_QSPI_Write)

This is an example of using R_XSPI_QSPI_Write() to write a page of data to memory space for RZ/T2M and RZ/T2L. In these MCU environments, R_XSPI_QSPI_Write() attempts memory mapping accesses. (In other MCU environments, attempts manual command access.) In this case, the memory access attribute of the External Address Space xSPIn should be device-nGnRnE, because write access to flash memory needs to be in the right order. Therefore, R_BSP_MpuRegionDynamicConfig() and R_BSP_MpuRegionRestoreConfig() are used to temporarily change the memory access attribute.

#define QSPI_EXAMPLE_DEST_ADDRESS       (0x60000000)
#define QSPI_WRITE_FUNCTION_MAX_SIZE    (64U)

void r_qspi_example_write_page (void)
{
    /* Prepare a page of write data. */
    uint8_t write_data[QSPI_FLASH_PAGE_BYTES];
    for (uint32_t bytes = 0; bytes < QSPI_FLASH_PAGE_BYTES; bytes++)
    {
        write_data[bytes] = (uint8_t) bytes;
    }

    /* Open the QSPI instance. */
    fsp_err_t err = R_XSPI_QSPI_Open(&g_qspi0_ctrl, &g_qspi0_cfg);
    handle_error(err);

    /* Prepare MPU configuration for access address space. */
    bsp_mpu_dynamic_cfg_t write_region_cfg =
    {
        .base      = QSPI_EXAMPLE_DEST_ADDRESS,
        .size      = QSPI_FLASH_PAGE_BYTES,
        .attribute =
        {
            BSP_ATTRINDEX4,
            BSP_OUTER_SHAREABLE,
            BSP_EL1RW_EL0RW,
            BSP_EXECUTE_ENABLE,
        },
    };

    /* MPU configuration and temporarily change attribute to device-nGnRnE. */
    R_BSP_MpuRegionDynamicConfig(&write_region_cfg);

    /* Repeat R_XSPI_QSPI_Write until a page of data is written. */
    for (uint32_t bytes = 0; bytes < QSPI_FLASH_PAGE_BYTES; bytes += QSPI_WRITE_FUNCTION_MAX_SIZE)
    {
        uint8_t * dest_address = (uint8_t *) (QSPI_EXAMPLE_DEST_ADDRESS + bytes);
        R_XSPI_QSPI_Write(&g_qspi0_ctrl, &write_data[bytes], dest_address, QSPI_WRITE_FUNCTION_MAX_SIZE);

        qspi_example_wait_until_wip();
    }

    /* Restore MPU configuration */
    R_BSP_MpuRegionRestoreConfig();
}

Direct Transfer Memory Write Example (R_XSPI_QSPI_DirectTransfer)

This is an example of using R_XSPI_QSPI_DirectTransfer() to write a page of data to memory space. If two memories are connected on the same unit's xSPI bus, memory mapping write may not be possible due to bus collisions caused by simultaneous accesses to the xSPI area. In this case, it is recommended to write data using R_XSPI_QSPI_DirectTransfer() instead of R_XSPI_QSPI_Write().

#define DIRECT_TRANSFER_MAX_DATA_BYTES    (8U)

void r_qspi_example_write_page_with_direct_transfer (void)
{
    spi_flash_direct_transfer_t qspi_test_direct_transfer =
    {
        .command        = QSPI_COMMAND_PAGE_PROGRAM,
        .address        = 0U,
        .data_u64       = 0U,
        .command_length = 1U,
        .address_length = 3U,
        .data_length    = DIRECT_TRANSFER_MAX_DATA_BYTES,
        .dummy_cycles   = 0U
    };

    /* Prepare a page of write data. */
    uint8_t write_data[QSPI_FLASH_PAGE_BYTES];
    for (uint32_t bytes = 0; bytes < QSPI_FLASH_PAGE_BYTES; bytes++)
    {
        write_data[bytes] = (uint8_t) bytes;
    }

    /* Open the QSPI instance. */
    fsp_err_t err = R_XSPI_QSPI_Open(&g_qspi0_ctrl, &g_qspi0_cfg);
    handle_error(err);

    /* Repeat R_XSPI_QSPI_DirectTransfer until a page of data is written. */
    for (uint32_t trans = 0; trans < QSPI_FLASH_PAGE_BYTES / DIRECT_TRANSFER_MAX_DATA_BYTES; trans++)
    {
        /* Write Enable */
        qspi_write_enable_and_verify();

        /* Write memory with R_XSPI_QSPI_DirectTransfer */
        qspi_test_direct_transfer.data_u64 = *((uint64_t *) &write_data[trans * DIRECT_TRANSFER_MAX_DATA_BYTES]);
        qspi_test_direct_transfer.address  = QSPI_EXAMPLE_DESTINATION_CHIP_ADDRESS + trans *
                                             DIRECT_TRANSFER_MAX_DATA_BYTES;


        err =
            R_XSPI_QSPI_DirectTransfer(&g_qspi0_ctrl, &qspi_test_direct_transfer, SPI_FLASH_DIRECT_TRANSFER_DIR_WRITE);


        handle_error(err);

        /* Wait until write has been completed */
        qspi_example_wait_until_wip();
    }
}

Data Structures
struct	xspi_qspi_instance_ctrl_t

Enumerations
enum	xspi_qspi_chip_select_t
enum	xspi_qspi_memory_size_t
enum	xspi_qspi_command_interval_clocks_t
enum	xspi_qspi_cs_pullup_clocks_t
enum	xspi_qspi_cs_pulldown_clocks_t
enum	xspi_qspi_prefetch_function_t
enum	xspi_qspi_io_voltage_t

---

Data Structure Documentation

xspi_qspi_instance_ctrl_t

struct xspi_qspi_instance_ctrl_t

Instance control block. DO NOT INITIALIZE. Initialization occurs when spi_flash_api_t::open is called

Enumeration Type Documentation

xspi_qspi_chip_select_t

enum xspi_qspi_chip_select_t

Enumerator
XSPI_QSPI_CHIP_SELECT_0	Device connected to Chip-Select 0.
XSPI_QSPI_CHIP_SELECT_1	Device connected to Chip-Select 1.

xspi_qspi_memory_size_t

enum xspi_qspi_memory_size_t

Enumerator
XSPI_QSPI_MEMORY_SIZE_1MB	Memory size 1MB.
XSPI_QSPI_MEMORY_SIZE_2MB	Memory size 2MB.
XSPI_QSPI_MEMORY_SIZE_4MB	Memory size 4MB.
XSPI_QSPI_MEMORY_SIZE_8MB	Memory size 8MB.
XSPI_QSPI_MEMORY_SIZE_16MB	Memory size 16MB.
XSPI_QSPI_MEMORY_SIZE_32MB	Memory size 32MB.
XSPI_QSPI_MEMORY_SIZE_64MB	Memory size 64MB.

xspi_qspi_command_interval_clocks_t

enum xspi_qspi_command_interval_clocks_t

Enumerator
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_1	1 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_2	2 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_3	3 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_4	4 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_5	5 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_6	6 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_7	7 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_8	8 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_9	9 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_10	10 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_11	11 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_12	12 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_13	13 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_14	14 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_15	15 interval clocks
XSPI_QSPI_COMMAND_INTERVAL_CLOCKS_16	16 interval clocks

xspi_qspi_cs_pullup_clocks_t

enum xspi_qspi_cs_pullup_clocks_t

Enumerator
XSPI_QSPI_CS_PULLUP_CLOCKS_NO_EXTENSION	CS asserting No extension.
XSPI_QSPI_CS_PULLUP_CLOCKS_1	CS asserting Extend 1 cycle.

xspi_qspi_cs_pulldown_clocks_t

enum xspi_qspi_cs_pulldown_clocks_t

Enumerator
XSPI_QSPI_CS_PULLDOWN_CLOCKS_NO_EXTENSION	CS negating No extension.
XSPI_QSPI_CS_PULLDOWN_CLOCKS_1	CS negating Extend 1 cycle.

xspi_qspi_prefetch_function_t

enum xspi_qspi_prefetch_function_t

Enumerator
XSPI_QSPI_PREFETCH_FUNCTION_DISABLE	Prefetch function disable.
XSPI_QSPI_PREFETCH_FUNCTION_ENABLE	Prefetch function enable.

xspi_qspi_io_voltage_t

enum xspi_qspi_io_voltage_t

Enumerator
XSPI_QSPI_IO_VOLTAGE_1_8V	IO voltage 1.8V.
XSPI_QSPI_IO_VOLTAGE_3_3V	IO voltage 3.3V.

Function Documentation

R_XSPI_QSPI_Open()

fsp_err_t R_XSPI_QSPI_Open	(	spi_flash_ctrl_t *	p_ctrl,
		spi_flash_cfg_t const *const	p_cfg
	)

Open the QSPI driver module. After the driver is open, the QSPI can be accessed like internal flash memory.

Implements spi_flash_api_t::open.

Return values

FSP_SUCCESS	Configuration was successful.
FSP_ERR_ASSERTION	The parameter p_instance_ctrl or p_cfg is NULL.
FSP_ERR_ALREADY_OPEN	Driver has already been opened with the same p_instance_ctrl.
FSP_ERR_IP_CHANNEL_NOT_PRESENT	The requested channel does not exist on this MCU.

R_XSPI_QSPI_Close()

fsp_err_t R_XSPI_QSPI_Close

(

spi_flash_ctrl_t *

p_ctrl

)

Close the QSPI driver module.

Implements spi_flash_api_t::close.

Return values

FSP_SUCCESS	Configuration was successful.
FSP_ERR_ASSERTION	p_instance_ctrl is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.

Note

If another chip select of the same unit is used by other drivers, the other chip select operation will also stop when this function is executed.

R_XSPI_QSPI_DirectWrite()

fsp_err_t R_XSPI_QSPI_DirectWrite	(	spi_flash_ctrl_t *	p_ctrl,
		uint8_t const *const	p_src,
		uint32_t const	bytes,
		bool const	read_after_write
	)

Writes raw data directly to the QSPI.

Implements spi_flash_api_t::directWrite.

Return values

FSP_ERR_UNSUPPORTED

API not supported.

R_XSPI_QSPI_DirectRead()

fsp_err_t R_XSPI_QSPI_DirectRead	(	spi_flash_ctrl_t *	p_ctrl,
		uint8_t *const	p_dest,
		uint32_t const	bytes
	)

Reads raw data directly from the QSPI.

Implements spi_flash_api_t::directRead.

Return values

FSP_ERR_UNSUPPORTED

API not supported.

R_XSPI_QSPI_SpiProtocolSet()

fsp_err_t R_XSPI_QSPI_SpiProtocolSet	(	spi_flash_ctrl_t *	p_ctrl,
		spi_flash_protocol_t	spi_protocol
	)

Sets the SPI protocol.

Implements spi_flash_api_t::spiProtocolSet.

Return values

FSP_SUCCESS	SPI protocol updated on MCU peripheral.
FSP_ERR_ASSERTION	A required pointer is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.
FSP_ERR_INVALID_ARGUMENT	Invalid SPI protocol requested.

R_XSPI_QSPI_XipEnter()

fsp_err_t R_XSPI_QSPI_XipEnter

(

spi_flash_ctrl_t *

p_ctrl

)

Enters XIP (execute in place) mode.

Note

If the xSPI address space is cache-enabled, cache should be invalidated before executing XipEnter. Otherwise, it is not guaranteed that the slave device will be in XiP mode immediately after XipEnter is executed.

Implements spi_flash_api_t::xipEnter.

Return values

FSP_SUCCESS	The flash was programmed successfully.
FSP_ERR_ASSERTION	A required pointer is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.

R_XSPI_QSPI_XipExit()

fsp_err_t R_XSPI_QSPI_XipExit

(

spi_flash_ctrl_t *

p_ctrl

)

Exits XIP (execute in place) mode.

Note

If the xSPI address space is cache-enabled, cache should be invalidated before executing XipExit. Otherwise, it is not guaranteed that the slave device will exit XiP mode immediately after XipEnter is executed.

Implements spi_flash_api_t::xipExit.

Return values

FSP_SUCCESS	The flash was programmed successfully.
FSP_ERR_ASSERTION	A required pointer is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.

R_XSPI_QSPI_Write()

fsp_err_t R_XSPI_QSPI_Write	(	spi_flash_ctrl_t *	p_ctrl,
		uint8_t const *const	p_src,
		uint8_t *const	p_dest,
		uint32_t	byte_count
	)

Program a page of data to the flash.

Implements spi_flash_api_t::write.

Return values

FSP_SUCCESS	The flash was programmed successfully.
FSP_ERR_ASSERTION	p_instance_ctrl, p_dest or p_src is NULL, or byte_count crosses a page boundary.
FSP_ERR_NOT_OPEN	Driver is not opened.
FSP_ERR_INVALID_MODE	This function can't be called when XIP mode is enabled.
FSP_ERR_DEVICE_BUSY	The device is busy.
FSP_ERR_WRITE_FAILED	Write operation failed.

Note

In this API, data can be written up to 64 bytes at a time if DMAC support is enabled. Otherwise, the number of bytes that can be written at one time depends on the MCU : 64bytes for RZ/T2M and RZ/T2L, 8bytes for RZ/T2ME and RZ/T2H.

This API performs page program operations to the device. Writing across pages is not supported. Please set the write address and write size according to the page size of your device.

R_XSPI_QSPI_Erase()

fsp_err_t R_XSPI_QSPI_Erase	(	spi_flash_ctrl_t *	p_ctrl,
		uint8_t *const	p_device_address,
		uint32_t	byte_count
	)

Erase a block or sector of flash. The byte_count must exactly match one of the erase sizes defined in spi_flash_cfg_t. For chip erase, byte_count must be SPI_FLASH_ERASE_SIZE_CHIP_ERASE.

Implements spi_flash_api_t::erase.

Return values

FSP_SUCCESS	The command to erase the flash was executed successfully.
FSP_ERR_ASSERTION	p_instance_ctrl or p_device_address is NULL, or byte_count doesn't match an erase size defined in spi_flash_cfg_t, or device is in XIP mode.
FSP_ERR_NOT_OPEN	Driver is not opened.
FSP_ERR_INVALID_MODE	This function can't be called when XIP mode is enabled.
FSP_ERR_DEVICE_BUSY	The device is busy.
FSP_ERR_WRITE_FAILED	Write operation failed.

R_XSPI_QSPI_StatusGet()

fsp_err_t R_XSPI_QSPI_StatusGet	(	spi_flash_ctrl_t *	p_ctrl,
		spi_flash_status_t *const	p_status
	)

Gets the write or erase status of the flash.

Implements spi_flash_api_t::statusGet.

Return values

FSP_SUCCESS	The write status is in p_status.
FSP_ERR_ASSERTION	p_instance_ctrl or p_status is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.
FSP_ERR_INVALID_MODE	This function can't be called when XIP mode is enabled.

R_XSPI_QSPI_BankSet()

fsp_err_t R_XSPI_QSPI_BankSet	(	spi_flash_ctrl_t *	p_ctrl,
		uint32_t	bank
	)

Selects the bank to access.

Implements spi_flash_api_t::bankSet.

Return values

FSP_ERR_UNSUPPORTED

API not supported.

R_XSPI_QSPI_DirectTransfer()

fsp_err_t R_XSPI_QSPI_DirectTransfer	(	spi_flash_ctrl_t *	p_ctrl,
		spi_flash_direct_transfer_t *const	p_transfer,
		spi_flash_direct_transfer_dir_t	direction
	)

Read/Write raw data directly with the SerialFlash.

Implements spi_flash_api_t::directTransfer.

Return values

FSP_SUCCESS	The flash was programmed successfully.
FSP_ERR_ASSERTION	A required pointer is NULL.
FSP_ERR_NOT_OPEN	Driver is not opened.
FSP_ERR_INVALID_MODE	This function must be called after R_XSPI_QSPI_DirectWrite with read_after_write set to true.
FSP_ERR_DEVICE_BUSY	The device is busy.

R_XSPI_QSPI_AutoCalibrate()

fsp_err_t R_XSPI_QSPI_AutoCalibrate

(

spi_flash_ctrl_t *

p_ctrl

)

Auto-calibrate the OctaRAM device using the preamble pattern. Unsupported by XSPI_QSPI. Implements spi_flash_api_t::autoCalibrate.

Return values

FSP_ERR_UNSUPPORTED

API not supported by XSPI_QSPI