Qspips Standalone driver

Introduction

The Quad-SPI flash controller is part of the input/output peripherals (IOP) located within the PS. It is used to access multi-bit serial flash memory devices for high throughput and low pin count applications
The controller operates in one of three modes:
 - I/O mode
 - Linear addressing mode
 - Legacy SPI mode
In I/O mode, software interacts closely with the flash device protocol. The software writes the flash
commands and data to the controller using the four TXD registers. Software reads the RXD register that contains the data received from the flash device.

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

qspips

<Vitis Install Directory>/data/embedded/XilinxProcessorIPLib/drivers/qspips

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

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/xilinx-v2020.1/XilinxProcessorIPLib/drivers/qspips

The driver source code is organized into different folders.  The table below shows the qspips driver source organization.

Directory
Description

doc

Provides the API and data structure details

data

Driver .tcl and .mdd file

examples

Example applications that show how to use the driver features

src

Driver source files

Driver Implementation

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


Features

  1. IO access
  2. Legacy SPI mode
  3. Linear addressing mode
  4. Control of two chip selects/bus
  5. Configurable clock
  6. Configurable bus width
  7. Interrupts – will be chosen and enabled internally

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/xilinx-v2020.1/XilinxProcessorIPLib/drivers/qspips/examples

Test Name Example sourceDescription
QSPIPS Interrupt Mode Examplexqspips_flash_intr_example.cThis examples does basic read and write test from the SPI-NOR flash device in Interrupt mode
QSPIPS Polled Mode Examplexqspips_flash_polled_example.cThis examples does basic read and write test from the SPI-NOR flash device in Polled mode
QSPIPS G128 Examplexqspips_g128_flash_example.cThis examples does basic read and write test from the SPI-NOR flash device greater than 128MB
QSPIPS Self Test Examplexqspips_selftest_example.cThis examples does basic hardware connection check
Linear QSPIPS Examplexqspips_flash_lqspi_example.cThis example does linear read operation from SPI-NOR flash device in single mode
Linear QSPIPS Stacked mode Examplexqspips_dual_flash_stack_lqspi_example.cThis example does linear read operation from SPI-NOR flash device in stacked mode
Linear QSPIPS Dual mode Examplexqspips_dual_flash_lqspi_example.cThis example does linear read operation from SPI-NOR flash device in dual parallel mode

Example Application Usage

QSPIPS Interrupt Mode Example

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

QSPI FLASH Interrupt Example Test 

FlashID=0x20 0xBB 0x18

Successfully ran QSPI FLASH Interrupt Example Test

QSPIPS Polled Mode Example

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

QSPI FLASH Polled Example Test 

FlashID=0x20 0xBB 0x18

Successfully ran QSPI FLASH Polled Example Test

QSPIPS G128 Example

This examples does basic read and write test from the SPI-NOR flash device greater than 128MB

SPI Greater than 128Mb Flash Example Test 

FlashID=0x20 0xBB 0x18

Successfully ran QSPI Greater than 128Mb Flash Ex Test

Linear QSPIPS Example

This example does linear read operation from SPI-NOR flash device in single mode

Linear QSPI FLASH Example Test 

FlashID=0x20 0xBB 0x18

Successfully ran Linear QSPI FLASH Example Test

Example Design Architecture

NA

Performance

Single

Qspips write throughput is 362 KBPS
Qspips read throughput is 27675 KBPS

Dual-Parallel

Qspips write throughput is 644 KBPS
Qspips read throughput is 33573 KBPS

Change Log

2021.2

None

2021.1

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

2020.2

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

2020.1

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

2019.2

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

2019.1

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