spiFlash.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef SPI_FLASH_H
#define SPI_FLASH_H

 
#include <string.h>
#include "spi/spi.h"
#include "spiFlash/spiFlash_list.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
// ToDo:
// Add spiFlash_read that handle multi-read support (Single,Dual,Quad) based on user's struct. 
// Add spiFlash_write that handle multi-write support (Single,Dual,Quad) based on user's struct.
// Add a safe guard where it set to single line mode when configure flash such as write/read status reg.

 
/* ========================================================================== */
/* SUB-GROUP : REGISTER DEFINITIONS                                           */
/* ========================================================================== */


        #define CMD_READ_JEDEC_ID           0x9F  
        #define CMD_READ_DEVICE_ID          0xAB  

        #define CMD_READ_STATUS_REG_1       0x05  
        #define CMD_READ_STATUS_REG_2       0x35  
        #define CMD_READ_STATUS_REG_3       0x15  
        #define CMD_WRITE_STATUS_REG_1      0x01  
        #define CMD_WRITE_STATUS_REG_2      0x31  
        #define CMD_WRITE_STATUS_REG_3      0x11  

        #define CMD_PAGE_PROGRAM            0x02  
        #define CMD_QUAD_PAGE_PROGRAM       0x32  
        #define CMD_WRITE_ENABLE            0x06  
        #define CMD_WRITE_DISABLE           0x04  

        #define CMD_READ_DATA               0x03 
        #define CMD_FAST_READ               0x0B 
        #define CMD_DUAL_OUTPUT_READ        0x3B 
        #define CMD_QUAD_OUTPUT_READ        0x6B 

        #define CMD_RELEASE_DEEP_POWER_DOWN 0xAB  
        #define CMD_ENABLE_RESET            0x66  
        #define CMD_RESET_DEVICE            0x99  
        #define CMD_GLOBAL_LOCK             0x7E  
        #define CMD_GLOBAL_UNLOCK           0x98  
        #define CMD_ENABLE_QPI              0x38  

        #define CMD_ENTER_4B                0xB7  
        #define CMD_EXIT_4B                 0xE9  
        #define CMD_EXIT_4B_ISSI            0x29  
        #define CMD_DUAL_OUTPUT_READ_4B     0x3C  
        #define CMD_QUAD_OUTPUT_READ_4B     0x6C  
        #define CMD_READ_4B                 0x13  
        #define CMD_PROGRAM_4B              0x12  
        #define CMD_SECTOR_ERASE            0x20  
        #define CMD_ERASE_4K_4B             0x21  
        #define CMD_ERASE_64K_4B            0xDC  

        #define QE_BIT6    0x40 
        #define QE_BIT1    0x02 
        #define WEL_BIT    0x02 
 // End of SPI_FLASH_Macros group
 
 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                     */
/* ========================================================================== */

        typedef enum {
            SPI_FLASH_OK        = 0,    
            SPI_FLASH_ERR       = 1,    
            SPI_FLASH_SKIP      = 2,    
        } spiFlash_status_t;

 // End of SPI_FLASH_ENUM group
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                   */
/* ========================================================================== */
    typedef struct{
        spi_instance_t          *inst;          
        const spiFlash_info_t   *info;          
        u32                     detected_id;    
        u8                      cs;             
 
        // Command 
        u8 cmd_rd_status;   
        u8 cmd_wr_status;   
        u8 cmd_exit_4byte;  
        u8 mask_qe;         
 
    } spiFlash_instance_t;
 // End of SPI_FLASH_Types group
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                       */
/* ========================================================================== */


        void spiFlash_wake(spiFlash_instance_t *flash);
        void spiFlash_applyConfig(spiFlash_instance_t *flash);

        #define spiFlash_register(table) \
            spiFlash_registerFlash((table), sizeof(table) / sizeof((table)[0]))
            
        void spiFlash_registerFlash(const spiFlash_info_t *table, size_t count);

        void spiFlash_initController(spiFlash_instance_t *flash);

        spiFlash_status_t spiFlash_probe(spiFlash_instance_t * flash);
        
    
        u8 spiFlash_readId(spiFlash_instance_t *flash);
        
        u32 spiFlash_readJedecId(spiFlash_instance_t *flash);

        const spiFlash_info_t * spiFlash_lookup(u32 detected_id);

        spiFlash_status_t spiFlash_verify(spiFlash_instance_t *flash);

        void spiFlash_applyQuirks(spiFlash_instance_t *flash);

        u8 spiFlash_readStatusReg(spiFlash_instance_t *flash);
        
        void spiFlash_writeStatusReg(spiFlash_instance_t *flash,u8 data);
        
        u8 spiFlash_write_single(spiFlash_instance_t *flash, u32 flashAddress, u8 *src, u32 len);
        
        void spiFlash_read_single(spiFlash_instance_t *flash, u32 flashAddress, u8 *buffer, u32 len);
        
        void spiFlash_f2m_single(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);

        void spiFlash_f2m_dual(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);

        void spiFlash_f2m_quad(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);
 


        spiFlash_status_t spiFlash_waitBusy(spiFlash_instance_t *flash);
        
        u8 spiFlash_exit4ByteAddr(spiFlash_instance_t *flash);
        
        void spiFlash_lockGlobal(spiFlash_instance_t *flash);
        
        void spiFlash_enableWrite(spiFlash_instance_t *flash);
        
        void spiFlash_unlockGlobal(spiFlash_instance_t *flash);
        
        void spiFlash_enableQuadMode(spiFlash_instance_t *flash);

        void spiFlash_enableQPI(spiFlash_instance_t *flash);
        
        void spiFlash_eraseSector(spiFlash_instance_t *flash, u32 flashAddress);
 // End of SPI_FLASHFunc
 
 
/* ========================================================================== */
/* SUB-GROUP: Internal FUNCTIONS                                              */
/* ========================================================================== */

    static void spiFlash_wake_(spiFlash_instance_t *flash);

    static u8 spiFlash_readId_(spiFlash_instance_t *flash);
    static u32 spiFlash_readJedecId_(spiFlash_instance_t *flash);

    static void spiFlash_f2m_single_(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);
    static void spiFlash_f2m_dual_(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);
    static void spiFlash_f2m_quad_(spiFlash_instance_t *flash, u32 flashAddress, uintptr_t memoryAddress, u32 size);
 
 
#ifdef __cplusplus
}
#endif
 // End of MAIN SPI_FLASH Group
 
#endif // SPI_FLASH_H