spiFlash_list.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_DEVICE_H
#define SPI_FLASH_DEVICE_H

 
#include <stdint.h>
#include <stddef.h>
#include "type.h"
#include "soc.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ========================================================================== */
/* SUB-GROUP : FLASH CAPABILITY FLAGS                                         */
/* ========================================================================== */

        #define FLAG_4BYTE_SUPPORT      (1 << 0) 

        #define FLAG_4BYTE_EXIT_ISSI    (1 << 1) 

        #define FLAG_UNLOCK_ON_PROBE    (1 << 2) 

        #define FLAG_QE_SR2_BIT1        (1 << 3) 

        #define FLAG_QE_SR1_BIT6        (1 << 4) 


        #define FLAG_DREAD_SUPPORT      (1 << 6) 

        #define FLAG_QREAD_SUPPORT      (1 << 7) 

        #define FLAG_QE_ENABLE_VIA_SR   (FLAG_QE_SR2_BIT1 | FLAG_QE_SR1_BIT6)
 // End of SPI_FLASH_DRV_F
 
/* ========================================================================== */
/* SUB-GROUP : VENDOR PROFILES                                                */
/* ========================================================================== */
        #define PROFILE_WINBOND_64      (FLAG_DREAD_SUPPORT | FLAG_QREAD_SUPPORT | FLAG_QE_SR2_BIT1) 
    
        #define PROFILE_WINBOND_128     (FLAG_DREAD_SUPPORT | FLAG_QE_SR2_BIT1) 
 
        #define PROFILE_MACRONIX_LARGE  (FLAG_DREAD_SUPPORT | FLAG_QREAD_SUPPORT| FLAG_4BYTE_SUPPORT | \
                                        FLAG_QE_SR1_BIT6 | FLAG_UNLOCK_ON_PROBE) 
 
        #define PROFILE_ISSI_LARGE      (FLAG_DREAD_SUPPORT | FLAG_QREAD_SUPPORT | FLAG_4BYTE_SUPPORT | \
                                        FLAG_QE_SR1_BIT6 | FLAG_4BYTE_EXIT_ISSI) 
 
        #define PROFILE_GIGA_LARGE      (FLAG_QREAD_SUPPORT | FLAG_4BYTE_SUPPORT ) 
 
/* ========================================================================== */
/* SUB-GROUP : JEDEC IDENTIFIERS                                              */
/* ========================================================================== */

        #define JEDEC_ID_GD25LB512MEYIGR    0xC8671A00 

        #define JEDEC_ID_W25Q128JVSIQ       0xEF401800 

        #define JEDEC_ID_W25Q64JWSSIQ       0xEF601700 

        #define JEDEC_ID_MX25U25645GZ4I00   0xC2253900 

        #define JEDEC_ID_IS25WP512M         0x9D701A00 

        #define JEDEC_ID_UNSupported            0xFFFFFFFF 
 // End of SPI_FLASH_JEDECS
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTURES                                                */
/* ========================================================================== */
    typedef int (*flash_hook)(void *flash_instance);

    typedef struct {
        const char  *part_no;         
        u32         jedec_id;         
        u32         flags;            
        flash_hook  post_init_hook;   
    } spiFlash_info_t;
 // End of SPI_FLASH_Types
 
 
/* ========================================================================== */
/* SUB-GROUP : Supported Flash Device Info                                    */
/* ========================================================================== */

    extern const spiFlash_info_t known_flash[];
 // End of FLASH_INFO group
 
#ifdef __cplusplus
}
#endif
 // End of SPI_FLASH_LIST group
 
#endif // SPI_FLASH_DEVICE_H