Flash (Flash System Routine)

General Description

Internal flash memory programming.

The functions and other declarations used in this driver are in cy_flash.h. You can include cy_pdl.h to get access to all functions and declarations in the PDL.

Flash memory in PSoC devices provides non-volatile storage for user firmware, user configuration data, and bulk data storage.

Flash operations are implemented as system calls. System calls are executed out of SROM in the privileged mode of operation. Users have no access to read or modify the SROM code. The driver API requests the system call by acquiring the Inter-processor communication (IPC) and writing the SROM function opcode and parameters to its input registers. As a result, an NMI interrupt is invoked and the requested SROM function is executed. The operation status is returned to the driver context and a release interrupt is triggered.

Writing to flash can take up to 20 milliseconds. During this time, the device should not be reset (including XRES pin, software reset, and watchdog) or unexpected changes may be made to portions of the flash. Also, the low-voltage detect circuits should be configured to generate an interrupt instead of a reset.

A Read while Write violation occurs when a flash Read operation is initiated in the same or neighboring (neighboring restriction is applicable just for the CY8C6xx6, CY8C6xx7 devices) flash sector where the flash Write, Erase, or Program operation is working. This violation may cause a HardFault exception. To avoid the Read while Write violation, carefully split the Read and Write operation on flash sectors which are not neighboring, considering both cores in the multi-processor device. If the flash is divided into four equal sectors, you may edit the linker script to place the code into neighboring sectors. For example, use sectors number 0 and 1 for code and sectors 2 and 3 for data storage.

Configuration Considerations

Introduction:

The CAT1A devices user-programmable Flash consists of:

• Application flash memory (from 2 to 8 sectors) - 128KB/256KB each.
• EE emulation flash memory - 32KB.

The CAT1C devices user-programmable Flash consists of:

• Work flash region has 48 large sectors of 2 KB and 256 small sectors of 128 B.

Write operation may be done as Blocking or Partially Blocking, defined as follows:

Blocking:

In this case, the entire Flash block is not available for the duration of the Write (∼16ms). Therefore, no Flash accesses (from any Bus Master) can occur during that time. CPU execution can be performed from SRAM. All pre-fetching must be disabled. Code execution from Flash is blocked for the Flash Write duration for both cores.

Constraints for Blocking Flash operations:

1. During write to flash, the device should not be reset (including XRES pin, software reset, and watchdog), or unexpected changes may be made to portions of the flash.
2. The low-voltage detect circuits should be configured to generate an interrupt instead of a reset.
3. Flash write operation in CAT1A devices is allowed only in one of the following CM4 states:
   1. CM4 is Active and initialized:
      call Cy_SysEnableCM4(CY_CORTEX_M4_APPL_ADDR). Note: If desired user may put CM4 core in Deep Sleep any time after calling Cy_SysEnableCM4().
   2. CM4 is Off and disabled:
      call Cy_SysDisableCM4(). Note: In this state Debug mode is not supported.
4. Flash Write cannot be performed in Ultra Low Power (core voltage 0.9V) mode.
5. Interrupts must be enabled on both active cores. Do not enter a critical section during flash operation.
6. For the CY8C6xx6, CY8C6xx7 devices user must guarantee that system pipe interrupts (IPC interrupts 3 and 4) have the highest priority, or at least that pipe interrupts are not interrupted or in a pending state for more than 700 µs.
7. For CAT1A devices user must guarantee that during flash write operation no flash read operations are performed by bus masters other than CM0+ and CM4 (DMA and Crypto).
8. For the CY8C6xx6, CY8C6xx7 devices if you do not use the default startup, perform the following steps before any flash write/erase operations:

   
       /* 1. Allocate and initialize IPC semaphores for the system operations */
       static uint32_t ipcSemaArray[CY_IPC_SEMA_COUNT / CY_IPC_SEMA_PER_WORD];
   
       (void) Cy_IPC_Sema_Init(CY_IPC_CHAN_SEMA, CY_IPC_SEMA_COUNT, ipcSemaArray);
   
       /* 2. Create an array of endpoint structures and configure an IPC pipe infrastructure */
       static cy_stc_ipc_pipe_ep_t ipcPipeEpArray[CY_IPC_MAX_ENDPOINTS];
   
       Cy_IPC_Pipe_Config(ipcPipeEpArray);
   
       /* 3. Create an array of client callbacks and initialize a system pipe by a configuration structure */
       static cy_ipc_pipe_callback_ptr_t sysIpcPipeCbArray[CY_SYS_CYPIPE_CLIENT_CNT];
   
       static const cy_stc_ipc_pipe_config_t systemIpcPipeConfig =
       {
       /* .ep0ConfigData */
           {
               /* .ipcNotifierNumber    */  CY_IPC_INTR_CYPIPE_EP0,
               /* .ipcNotifierPriority  */  CY_SYS_INTR_CYPIPE_PRIOR_EP0,
               /* .ipcNotifierMuxNumber */  CY_SYS_INTR_CYPIPE_MUX_EP0,
               /* .epAddress            */  CY_IPC_EP_CYPIPE_CM0_ADDR,
               /* .epConfig             */  CY_SYS_CYPIPE_CONFIG_EP0
           },
       /* .ep1ConfigData */
           {
               /* .ipcNotifierNumber    */  CY_IPC_INTR_CYPIPE_EP1,
               /* .ipcNotifierPriority  */  CY_SYS_INTR_CYPIPE_PRIOR_EP1,
               /* .ipcNotifierMuxNumber */  0u,
               /* .epAddress            */  CY_IPC_EP_CYPIPE_CM4_ADDR,
               /* .epConfig             */  CY_SYS_CYPIPE_CONFIG_EP1
           },
       /* .endpointClientsCount     */  CY_SYS_CYPIPE_CLIENT_CNT,
       /* .endpointsCallbacksArray  */  sysIpcPipeCbArray,
       /* .systemPipeIsrHandler     */  &SysIpcPipeIsr
       };
   
       Cy_IPC_Pipe_Init(&systemIpcPipeConfig);
   
       /* 4. And finally initialize the flash */
       Cy_Flash_Init();
   
       /* Ensure to run these steps on all the MCU cores */
   

Partially Blocking:

This method has a much shorter time window during which Flash accesses are not allowed. Application code execution from Flash is blocked for only a part of Flash Write duration, for both cores. Blocking duration depends upon the API sequence used.

For CAT1A Devices API sequence Cy_Flash_StartEraseRow() + Cy_Flash_StartProgram() there are four block-out regions during which Read is blocked. See Figure 1.

For CAT1C devices Flash memory controller has the dual bank mode feature. When using dual bank mode, flash memory region is split into two half banks. One is called Logical Bank 0 and the other is called Logical Bank 1 User will be able to read from a different logical bank while writing to one logical bank.

For CAT1C devices Erase ROW is not supported. User has to erase the entire sector before writing to the sector.

CM7 cores in CAT1C devices support Data Cache. Data Cache line is 32 bytes. User needs to make sure that the pointer passed to the following functions points to 32 byte aligned data. Cy_Flash_StartWrite, Cy_Flash_ProgramRow, Cy_Flash_Program and Cy_Flash_Program_WorkFlash. User can use CY_ALIGN(32) macro for 32 byte alignment.

CAT1B devices run on single core and hence IPC is not used for erase and write operations on flash memory.

Table 1 - Block-out periods (timing values are valid just for the CY8C6xx6, CY8C6xx7 devices)

Block-out	Phase	Duration
A	The beginning of the Erase operation	2ms + 9500 SlowClk cycles
B	The end of the Erase operation	0.13ms + 1000 SlowClk cycles
C	The beginning of the Program operation	0.8ms + 6000 SlowClk cycles
D	The end of the Program operation	0.13ms + 1000 SlowClk cycles

This allows both cores to execute for about 80% of Flash Write operation - see Figure 1. This capability is important for communication protocols that rely on fast response.

Figure 1 - Blocking Intervals in Flash Write operation

For the Cy_Flash_StartWrite() function, the block-out period is different for the two cores. The core that initiates Cy_Flash_StartWrite() is blocked for two periods:

• From start of Erase operation (start of A on Figure 1) till the start of Program operation (end of C on Figure 1).
• During D period on Figure 1.

The core that performs read/execute is blocked identically to the previous scenario - see Figure 1.

This allows the core that initiates Cy_Flash_StartWrite() to execute for about 20% of Flash Write operation. The other core executes for about 80% of Flash Write operation.

In CAT1B devices with flash IP CY_IP_MXS40FLASHC When refresh is enabled, for each row an extra 16 bytes is used for storing refresh related data. User need to make sure that this data is not corrupted while writing and erasing the row data. When refresh is enabled row size has to be considered as CY_FLASH_SIZEOF_ROW + 16Bytes

Some constraints must be planned for in the Partially Blocking mode which are described in detail below.

Constraints for Partially Blocking Flash operations:

1. During write to flash, the device should not be reset (including XRES pin, software reset, and watchdog) or unexpected changes may be made to portions of the flash.
2. The low-voltage detect circuits should be configured to generate an interrupt instead of a reset.
3. During write to flash, application code should not change the clock settings. Use Cy_Flash_IsOperationComplete() to ensure flash write operation is finished.
4. During write to flash, application code should not start the clock measurements (should not call Cy_SysClk_StartClkMeasurementCounters()).
5. For CAT1A devices Flash write operation is allowed only in one of the following CM4 states:
   1. CM4 is Active and initialized:
      call Cy_SysEnableCM4(CY_CORTEX_M4_APPL_ADDR). Note: If desired user may put CM4 core in Deep Sleep any time after calling Cy_SysEnableCM4().
   2. CM4 is Off and disabled:
      call Cy_SysDisableCM4(). Note: In this state Debug mode is not supported.
6. For CAT1C devices flash write operation is only allowed after the sector in erased.
7. For CAT1A devices use the following rules for split by sectors. (In this context, read means read of any bus master: CM0+, CM4, DMA, Crypto, etc.)
   1. Do not write to and read/execute from the same flash sector at the same time. This is true for all sectors.

   2. Writing rules in application flash (this restriction is applicable just for CY8C6xx6, CY8C6xx7 devices):

      1. Any bus master can read/execute from UFLASH S0 and/or S1, during flash write to UFLASH S2 or S3.
      2. Any bus master can read/execute from UFLASH S2 and/or S3, during flash write to UFLASH S0 or S1.

      Suggestion: in case of bootloading, it is recommended to place code for CM4 in either S0 or S1. CM0+ code resides in S0. Write data to S2 and S3 sections.

8. Flash Write cannot be performed in Ultra Low Power mode (core voltage 0.9V).
9. Interrupts must be enabled on both active cores. Do not enter a critical section during flash operation.
10. For the CY8C6xx6, CY8C6xx7 devices user must guarantee that system pipe interrupts (IPC interrupts 3 and 4) have the highest priority, or at least that pipe interrupts are not interrupted or in a pending state for more than 700 µs.
11. For the CY8C6xx6, CY8C6xx7 devices if you do not use the default startup, perform the following steps before any flash write/erase operations:

    
        /* 1. Allocate and initialize IPC semaphores for the system operations */
        static uint32_t ipcSemaArray[CY_IPC_SEMA_COUNT / CY_IPC_SEMA_PER_WORD];
    
        (void) Cy_IPC_Sema_Init(CY_IPC_CHAN_SEMA, CY_IPC_SEMA_COUNT, ipcSemaArray);
    
        /* 2. Create an array of endpoint structures and configure an IPC pipe infrastructure */
        static cy_stc_ipc_pipe_ep_t ipcPipeEpArray[CY_IPC_MAX_ENDPOINTS];
    
        Cy_IPC_Pipe_Config(ipcPipeEpArray);
    
        /* 3. Create an array of client callbacks and initialize a system pipe by a configuration structure */
        static cy_ipc_pipe_callback_ptr_t sysIpcPipeCbArray[CY_SYS_CYPIPE_CLIENT_CNT];
    
        static const cy_stc_ipc_pipe_config_t systemIpcPipeConfig =
        {
        /* .ep0ConfigData */
            {
                /* .ipcNotifierNumber    */  CY_IPC_INTR_CYPIPE_EP0,
                /* .ipcNotifierPriority  */  CY_SYS_INTR_CYPIPE_PRIOR_EP0,
                /* .ipcNotifierMuxNumber */  CY_SYS_INTR_CYPIPE_MUX_EP0,
                /* .epAddress            */  CY_IPC_EP_CYPIPE_CM0_ADDR,
                /* .epConfig             */  CY_SYS_CYPIPE_CONFIG_EP0
            },
        /* .ep1ConfigData */
            {
                /* .ipcNotifierNumber    */  CY_IPC_INTR_CYPIPE_EP1,
                /* .ipcNotifierPriority  */  CY_SYS_INTR_CYPIPE_PRIOR_EP1,
                /* .ipcNotifierMuxNumber */  0u,
                /* .epAddress            */  CY_IPC_EP_CYPIPE_CM4_ADDR,
                /* .epConfig             */  CY_SYS_CYPIPE_CONFIG_EP1
            },
        /* .endpointClientsCount     */  CY_SYS_CYPIPE_CLIENT_CNT,
        /* .endpointsCallbacksArray  */  sysIpcPipeCbArray,
        /* .systemPipeIsrHandler     */  &SysIpcPipeIsr
        };
    
        Cy_IPC_Pipe_Init(&systemIpcPipeConfig);
    
        /* 4. And finally initialize the flash */
        Cy_Flash_Init();
    
        /* Ensure to run these steps on all the MCU cores */
    

EEPROM section use:

If you plan to use "cy_em_eeprom" section for different purposes for both of device cores or use Em_EEPROM Middleware together with flash driver write operations you must modify the linker scripts.
For more information, refer to the Middleware/Cypress Em_EEPROM Middleware Library section of the PDL documentation.

More Information

See the technical reference manual (TRM) for more information about the Flash architecture.

Changelog

Version	Changes	Reason for Change
3.100	Added support for PSoC C3 (CAT1B). Added flash refresh feature. Added inject ecc disable and corrected address in inject ecc.	Added support for new devices, added new feature and code enhancement.
3.90	Added support for TRAVEO™ II Body Entry devices. Updated pre-processor check to only include code if ECT flash is not used. In cy_flash_srom, changed pre-processor checks from using CM7 availability to using MXFLASHC ver. to determine flash hardware availability. In cy_flash_srom, added interrupt compatibility for CM4 devices.	Code enhancement and support for new devices.
3.80	Dual bank support added for CAT1A devices.	Newly added APIs Cy_Flashc_SetMain_Flash_Mapping , Cy_Flashc_SetWork_Flash_Mapping for CAT1A and CAT1C devices.
3.70	Fixed MISRA 2012 violations and Documentation Update.	MISRA 2012 compliance.
3.60	Added API's to support new product family. Enhancement for support of eCT flash.	eCT flash's contains Code flash and Work flash. New API's to program/erase both work flash and code flash are added.
3.50.1	Updated documentation to limit devices with the restrictions.	User experience enhancement.
3.50	Updated attribute usage for the linker section placement.	Enhancement based on usability feedback.
	Fixed/documented MISRA 2012 violations.	MISRA 2012 compliance.
3.40	Updated Cy_Flash_OperationStatus() to access protected registers.	Added PSoC 64 device support.
3.30.4	Improved documentation.	User experience enhancement.
3.30.3	Updated documentation to limit devices with the restrictions. Improved calculation of the CY_FLASH_DELAY_CORRECTIVE macro.	User experience enhancement.
3.30.2	Updated documentation to limit devices with the neighboring restriction.	User experience enhancement.
3.30.1	Used the CY_RAMFUNC_BEGIN and CY_RAMFUNC_END macros that allocate the function in RAM instead of using the CY_SECTION(".cy_ramfunc") macros.	Removed the code duplication.
3.30	Moved ipcWaitMessageStc structure to the RAM section called ".cy_sharedmem".	Support Secure Boot devices.
	Renamed Function Cy_Flash_StartErase() to Cy_Flash_StartEraseRow().	The driver improvements based on the usability feedback.
	Added new API functions Cy_Flash_EraseSector, Cy_Flash_StartEraseSector, Cy_Flash_EraseSubsector, Cy_Flash_StartEraseSubsector	The driver improvements based on the usability feedback.
3.20	Flattened the organization of the driver source code into the single source directory and the single include directory.	Driver library directory-structure simplification.
	Added new API function Cy_Flash_InitExt	The driver improvements based on the usability feedback
	Added register access layer. Use register access macros instead of direct register access using dereferenced pointers.	Makes register access device-independent, so that the PDL does not need to be recompiled for each supported part number.
3.11	Updated driver functionality to correctly use the SysClk measurement counters while partially blocking flash operations	Added arbiter mechanism for correct usage of the SysClk measurement counters
3.10	Updated Cy_Flash_SendCmd() code to support single core devices.	Support new devices
3.0	New function - Cy_Flash_ProgramRow(); Updated Cy_Flash_RowChecksum(): changed input parameter to take the row address (rowAddr) instead of the row number (rowNum); Renamed macro for disabling RWW support in driver to CY_FLASH_RWW_DRV_SUPPORT_DISABLED. Updated Configuration Considerations documentation section with flash usage constraints.	Improvements made based on usability feedback to use a common interface
2.0	Added non-blocking erase function - Cy_Flash_StartErase(). Removed the clear cache function call.	The clear cache operation is removed from the blocking Write/Erase function because in this case it is performed by the hardware. Otherwise it is documented that it is the user's responsibility to clear the cache after executing the non-blocking Write/Erase flash operation.
	Added new Cy_Flash_IsOperationComplete() function to check completeness. Obsoleted Cy_Flash_IsWriteComplete(), Cy_Flash_IsProgramComplete(), and Cy_Flash_IsEraseComplete() functions. Added Cy_Flash_GetExternalStatus() function to get unparsed status where flash driver will be used in security applications with other modules as SecureImage. Added Cy_Flash_Init() function to initialize all needed prerequisites for Erase/Write operations.	Updated driver design to improve user experience.
	Updated driver implementation to remove MISRA rules deviations.	Driver implementation quality improvement.
1.0	Initial version

API Reference
	Macros
	Functions
	Enumerated Types
	Structures