Introduction

This page gives an overview of qspipsu driver which is available as part of the Xilinx Vivado and Vitis distribution.
Source path for the driver:

Introduction

The quad SPI (QSPI) controller can access one or two flash devices using several different methods. The controller is located with the other flash memory controllers in the PMC. The I/O
interface is routed to the PMC MIO pin bank 0 and can drive one or two devices. QSPI is commonly used as a boot device.

The controller provides multiple ways to read and write flash memory:
• SPI accesses
• Programmed I/O (PIO) protocol
• DMA indirect read using AXI master interface

Driver Sources

The source code for the driver is included with the Vitis Unified Software Platform installation, as well as being available in the Xilinx Github repository.

Driver Name	Path in Vitis	Path in Github
qspipsu	<Vitis Install Directory>/data/embedded/XilinxProcessorIPLib/drivers/qspipsu	https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/qspipsu

Info
Note: To view the sources for a particular release, use the rel-version tag in github. For example, for the 2020.1 release, the proper version of the code is: https://github.com/Xilinx/embeddedsw/tree/

master

xilinx-v2020.1/XilinxProcessorIPLib/drivers/qspipsu

Driver

The driver source code is organized into different folders.

Below diagram

The table below shows the qspipsu driver source organization.

qspipsu

Directory	Description

|

doc

-- Doc -

Provides the API and data structure details

|
- Examples - Reference application to


data	Driver .tcl and .mdd file
examples	Example applications that show how to use the driver

APIs and calling sequence
|
- Source -

features
src	Driver source files

Features Supported

The controller driver will be exclusive to GQSPI including API’s to be used for configuring the host controller and transmitting the data.

Commands Supported:

The following list of basic commands are supported by the Standalone driver:

Read Identification

Read Page

Program Page

Erase (Chip/Die/Bulk Erase)

Read Status

Lock/Unlock

Controller Features Supported:

The following features are supported in the QSPI Standalone driver.

2016.3

Added Tap delay support
Added example support for LQSPI
Added PollData and PollTimeout Support

2016.4

Update GQSPI PollData/PollTimeout for dualparallel configurations

2017.1

None

2017.2

None

2017.3

Added support for accessing upper DDR
Added CCI support

2017.4

Replaced the #ifdef COMMENTS with #if USE_FOUR_BYTE
Examples made compatible with u-boot and linux.
Resolved errors in qspipsu for ICCARM compiler
lqspi and poll data poll timeout example made compatible with u-boot and linux.

2018.1

Removed unsupported 4 byte commands.
Added support for MT25QL02G, S25FL064L and MX66U1G45G flash parts.
Removed check before writing destination address to DMA MSB.
Added a support to toggle WP pin of the flash.
Added support in EL1 NS mode.
Enable both CS in dual parallel mode, when issuing Write enable command.

2018.2

None

2018.3

Summary
- Added 64 bit dma support on 32 bit processor
- Added support for ISSI flash parts with 8/16/32/64Mb size of 3v and 1.8v variants
- Added Support for 64 bit DMA addresses for Microblaze-X
Commit

2019.1

Summary
- Added idling support in the driver.
- Added support for ISSI flash parts with 128/256/512Mb size of 3v and 1.8v variants.
- Set recommend clock and data tap delay value.
- Clear DMA_DST_ADDR_MSB register if the destination address is only 32-bit.
Commits

2019.2

Summary
- Enable IO mode for poll feature
- Fix incorrect tap values
- Add multi-die erase and multi-die read support
Commits

2020.1

Summay
- Removed LQSPI register access in Versal.
- Fixed coverity warnings in qspipsu.
- Added non-blocking DMA transfer APIs.
- Add clocking support.
Commits

2020.2

Summary

Update Makefile for parallel make execution

Commits9bfa3bb

Driver Implementation

For a full list of features supported by this IP, please refer Chapter 71: Quad SPI Controller in Versal TRM

Features

DMA access (aligned address only)
IO access
Control of two chip selects/bus
Configurable clock
Configurable bus width
Byte Mirror/Stripe operations
Interrupts – will be chosen and enabled internally

Example Applications:

Generic register read/write operations
3 byte and 4 byte addressing
Flash configurations illustrated in examples – Single, Dual Stacked, Dual Parallel

Known issues and Limitations

The standalone driver supports GenericQSPI(GQSPI) not Linear QSPI(LQSPI)

Test cases

Sample output of test cases that are taken from examples folder specified above

QSPIPSU FLASH Interrupt Example Test
Successfully ran QSPIPSU FLASH Interrupt Example Test

QSPIPSU FLASH Polling Example Test
Successfully ran QSPIPSU FLASH Polling Example Test

Performance Details

Single

Qspipsu write throughput is 1326 KBPS
Qspipsu read throughput is 28339 KBPS

Dual-Parallel

Qspipsu write throughput is 2438 KBPS
Qspipsu read throughput is 54245 KBPS

Change Log

SPI NAND flash devices

Known Issues and Limitations

Supported Flash vendors

Micron
ISSI
Spansion
Macronix

Example Applications

Refer to the driver examples directory for various example applications that exercise the different features of the driver. Each application is linked in the table below. The following sections describe the usage and expected output of the various applications. These example applications can be imported into the Vitis IDE from the Board Support Package settings tab.

Links to Examples

Examples Path:

https://github.com/Xilinx/embeddedsw/tree/master/XilinxProcessorIPLib/drivers/qspipsu/examples

Test Name	Example source	Description
Generic QSPI Interrupt Mode Example	xqspipsu_generic_flash_interrupt_example.c xqspipsu_flash_config.h	This examples does basic read and write test from the SPI-NOR flash device in Interrupt mode.
Generic QSPI Polled Mode Example	xqspipsu_generic_flash_polled_example.c xqspipsu_flash_config.h	This examples does basic read and write test from the SPI-NOR flash device in Polled mode.
Generic QSPI Non-blocking read example	xqspipsu_generic_flash_non_blocking_read_example.c xqspipsu_flash_config.h	This examples does read in non blocking polled mode from the SPI-NOR flash device.
Generic QSPI NAND Interrupt Mode Example	xqspipsu_generic_nand_flash_interrupt_example.c xqspipsu_flash_config.h	This examples does basic read and write test from the SPI-NAND flash device in Interrupt mode.
Generic QSPI NAND Polled Mode Example	xqspipsu_generic_nand_flash_polled_example.c xqspipsu_flash_config.h	This examples does basic read and write test from the SPI-NAND flash device in Polled mode.
Generic QSPI 64 Bit DMA Mode Example	xqspipsu_generic_flash_polled_64bit_dma_r5_example.c xqspipsu_flash_config.h	This example does read in polled mode with 64bit DMA from SPI-NOR flash device.
Generic QSPI Write Protection Example	xqspipsu_write_protect_example.c xqspipsu_flash_config.h	This example tests the write protection feature of the SPI-NOR flash device
Generic QSPI Polldata Mode Example	xqspipsu_polldata_polltimeout_interrupt_example.c xqspipsu_flash_config.h	This example illustrates, the use of polldata feature of the controller
Linear QSPI Example	xqspipsu_generic_flash_lqspi_example.c xqspipsu_flash_config.h	This example writes in GQSPI mode & reads in linear mode.

Example Application Usage

Generic QSPI Interrupt Mode Example

This examples does basic read and write test from the flash device in Interrupt mode.

Expected Output

QSPIPSU Generic Flash Interrupt Example Test 

Cfg Init done, Baseaddress: 0xF1030100

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0x6B, WriteCmd: 0x2,StatusCmd: 0x70, FSRFlag: 1

Successfully ran QSPIPSU Generic Interrupt Example

Generic QSPI Polled Mode Example

This examples does basic read and write test from the flash device in Polled mode.

Expected Output

QSPIPSU Generic Flash Polled Example Test 

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0x6B, WriteCmd: 0x2, StatusCmd: 0x70, FSRFlag: 1

Successfully ran QSPIPSU Generic Flash Polled Example

Generic QSPI 64 Bit DMA Mode Example

This example does read in polled mode with 64bit DMA.

Expected Output

QSPIPSU Generic Flash Polled Example 64bit dma for r5Test 

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0x6B, WriteCmd: 0x2, StatusCmd: 0x70,FSRFlag: 1

Successfully ran Generic Flash Polled 64 bit dma r5 Example

Generic QSPI Polldata Mode Example

This example illustrates, the use of polldata feature of the controller

Expected Output

QSPIPSU Flash PollData and PollTimeout Example Test

Cfg Init done, Baseaddress: 0xF1030100

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0x6B, WriteCmd: 0x2, StatusCmd: 0x70, FSRFlag: 1

Successfully ran QSPIPSU PollData and PollTimeout Example

Generic QSPI Non-blocking read Example

This examples does read in non blocking polled mode from the SPI-NOR flash device.

Expected Output

QSPIPSU Generic Flash Non Blocking Read Example Test 

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0x6B, WriteCmd: 0x2, StatusCmd: 0x70, FSRFlag: 1

Successfully ran QSPIPSU Generic Flash Non Blocking Read Example

Generic QSPI Write Protection Example

This example tests the write protection feature of the SPI-NOR flash device

Expected Output

QSPIPSU Write Protect Example Test 

Cfg Init done, Baseaddress: 0xF1030100

FlashID=0x20 0xBB 0x21

Flash connection mode : 2

where 0 - Single; 1 - Stacked; 2 - Parallel

FCTIndex: 10

ReadCmd: 0xB, WriteCmd: 0x2, StatusCmd: 0x70, FSRFlag: 1

Successfully ran QSPIPSU Write Protect Example

Example Design Architecture

NA

Performance

Single

Qspipsu write throughput is 1326 KBPS
Qspipsu read throughput is 28339 KBPS

Dual-Parallel

Qspipsu write throughput is 2438 KBPS
Qspipsu read throughput is 54245 KBPS

Change Log

2021.1

https://github.com/Xilinx/embeddedsw/blob/xilinx_v2021.1/doc/ChangeLog#L374

2020.2

https://github.com/Xilinx/embeddedsw/blob/xilinx-v2020.2/doc/ChangeLog#L653

2020.1

https://github.com/Xilinx/embeddedsw/blob/xilinx-v2020.1/doc/ChangeLog#L95

2019.2

https://github.com/Xilinx/embeddedsw/blob/xilinx-v2019.2/doc/ChangeLog#L70

2019.1

https://github.com/Xilinx/embeddedsw/blob/xilinx-v2019.1/doc/ChangeLog#L132

Page Comparison

Versions Compared

Old Version 14

New Version 15

Key

Table of Contents

Introduction

Table of Contents

Introduction

Driver Sources

Features Supported

Commands Supported:

Controller Features Supported:

2016.3

2016.4

2017.1

2017.2

2017.3

2017.4

2018.1

2018.2

2018.3

2019.1

2019.2

2020.1

2020.2

Driver Implementation

Features

Example Applications:

Known issues and Limitations

Test cases

Performance Details

Single

Dual-Parallel

Change Log

Known Issues and Limitations

Supported Flash vendors

Example Applications

Links to Examples

Example Application Usage

Generic QSPI Interrupt Mode Example

Generic QSPI Polled Mode Example

Generic QSPI 64 Bit DMA Mode Example

Generic QSPI Polldata Mode Example

Generic QSPI Non-blocking read Example

Generic QSPI Write Protection Example

Example Design Architecture

Performance

Single

Dual-Parallel

Change Log

2021.1

2020.2

2020.1

2019.2

2019.1

Related Links