History

Rbb666 a0be4ee3e9 Add uart0-5 configure		2022-07-28 18:54:50 +08:00
..
docs	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
.gitignore	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
EULA	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
LICENSE	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
README.md	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
RELEASE.md	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
cy_serial_flash_prog.c	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
cy_serial_flash_qspi.c	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
cy_serial_flash_qspi.h	Add uart0-5 configure	2022-07-28 18:54:50 +08:00
version.xml	Add uart0-5 configure	2022-07-28 18:54:50 +08:00

README.md

Serial Flash

Overview

Provides functions for interacting with an external flash connected through its Single SPI/Dual SPI/Quad SPI/Octal SPI interface. The read operation can be performed in either blocking or non-blocking manner by calling the corresponding function while the write and erase operations are implemented as blocking functions. This library accepts the configuration generated using the QSPI Configurator tool but supports only one memory slot. Note that PSoC™ 6 supports up to 4 memory slots on the same QSPI block.

Features

Supports asynchronous (non-blocking) read operation
Implements thread-safety for use with multi-threaded RTOS environment using the abstraction-rtos library
Accepts the configuration generated by the QSPI Configurator tool
Supports Execute-in-Place (XIP) mode of operation
Provides information about the external memory to the programming tool for it to be able to program the memory, for example, when user wants to place the code into the external memory for XIP operation.
Allows for programming external memory if CY_ENABLE_XIP_PROGRAM is defined when building the application. Note: This is not compatible with the PSoC™ 64 series of devices.

Quick Start

Add #include "cy_serial_flash_qspi.h"
Add DEFINES=CY_SERIAL_FLASH_QSPI_THREAD_SAFE in the Makefile to enable thread-safety when used in a multi-threaded RTOS environment
See the PSoC™ 6 MCU: QSPI Flash Read and Write code example to learn using this library

NOTE: If you delete the contents of the GeneratedSource directory inside the BSP, you must re-generate the memory configuration files cycfg_qspi_memslot.c/.h. To do this from inside the ModusToolbox™ IDE, open the QSPI Configurator tool from the Quick Panel and press Ctrl+S or click File > Save. If you open the tool outside the IDE, you need to first open the design.cyqspi file in the tool. To do this, click File > Import and then locate the file inside the BSP under COMPONENT_BSP_DESIGN_MODUS directory.

NOTE: For devices with no internal flash (eg:CAT1B device CYW20829), user needs to disable 'config data in flash' option in QSPI Configurator.

Dependencies

abstraction-rtos library if DEFINES=CY_SERIAL_FLASH_QSPI_THREAD_SAFE is added in the Makefile