evkmimxrt1060_flexspi_nor_config.h

/*
 * Copyright 2018 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __EVKMIMXRT1060_FLEXSPI_NOR_CONFIG__
#define __EVKMIMXRT1060_FLEXSPI_NOR_CONFIG__
 
#include <stdint.h>
#include <stdbool.h>
#include <sim.h>
 
#define FSL_XIP_BOARD_DRIVER_VERSION (MAKE_VERSION(2, 0, 0))
/* FLEXSPI memory config block related defintions */
#define FLEXSPI_CFG_BLK_TAG (0x42464346UL)     // ascii "FCFB" Big Endian
#define FLEXSPI_CFG_BLK_VERSION (0x56010400UL) // V1.4.0
#define FLEXSPI_CFG_BLK_SIZE (512)
 
/* FLEXSPI Feature related definitions */
#define FLEXSPI_FEATURE_HAS_PARALLEL_MODE 1
 
/* Lookup table related defintions */
#define CMD_INDEX_READ 0
#define CMD_INDEX_READSTATUS 1
#define CMD_INDEX_WRITEENABLE 2
#define CMD_INDEX_WRITE 4
 
#define CMD_LUT_SEQ_IDX_READ 0
#define CMD_LUT_SEQ_IDX_READSTATUS 1
#define CMD_LUT_SEQ_IDX_WRITEENABLE 3
#define CMD_LUT_SEQ_IDX_WRITE 9
 
#define CMD_SDR 0x01
#define CMD_DDR 0x21
#define RADDR_SDR 0x02
#define RADDR_DDR 0x22
#define CADDR_SDR 0x03
#define CADDR_DDR 0x23
#define MODE1_SDR 0x04
#define MODE1_DDR 0x24
#define MODE2_SDR 0x05
#define MODE2_DDR 0x25
#define MODE4_SDR 0x06
#define MODE4_DDR 0x26
#define MODE8_SDR 0x07
#define MODE8_DDR 0x27
#define WRITE_SDR 0x08
#define WRITE_DDR 0x28
#define READ_SDR 0x09
#define READ_DDR 0x29
#define LEARN_SDR 0x0A
#define LEARN_DDR 0x2A
#define DATSZ_SDR 0x0B
#define DATSZ_DDR 0x2B
#define DUMMY_SDR 0x0C
#define DUMMY_DDR 0x2C
#define DUMMY_RWDS_SDR 0x0D
#define DUMMY_RWDS_DDR 0x2D
#define JMP_ON_CS 0x1F
#define STOP 0
 
#define FLEXSPI_1PAD 0
#define FLEXSPI_2PAD 1
#define FLEXSPI_4PAD 2
#define FLEXSPI_8PAD 3
 
#define FLEXSPI_LUT_SEQ(cmd0, pad0, op0, cmd1, pad1, op1)                                                              \
    (FLEXSPI_LUT_OPERAND0(op0) | FLEXSPI_LUT_NUM_PADS0(pad0) | FLEXSPI_LUT_OPCODE0(cmd0) | FLEXSPI_LUT_OPERAND1(op1) | \
     FLEXSPI_LUT_NUM_PADS1(pad1) | FLEXSPI_LUT_OPCODE1(cmd1))
 
typedef enum _FlexSpiSerialClockFreq
{
    kFlexSpiSerialClk_30MHz  = 1,
    kFlexSpiSerialClk_50MHz  = 2,
    kFlexSpiSerialClk_60MHz  = 3,
    kFlexSpiSerialClk_75MHz  = 4,
    kFlexSpiSerialClk_80MHz  = 5,
    kFlexSpiSerialClk_100MHz = 6,
    kFlexSpiSerialClk_120MHz = 7,
    kFlexSpiSerialClk_133MHz = 8,
    kFlexSpiSerialClk_166MHz = 9,
} flexspi_serial_clk_freq_t;
 
enum
{
    kFlexSpiClk_SDR, 
    kFlexSpiClk_DDR, 
};
 
typedef enum _FlashReadSampleClkSource
{
    kFlexSPIReadSampleClk_LoopbackInternally      = 0,
    kFlexSPIReadSampleClk_LoopbackFromDqsPad      = 1,
    kFlexSPIReadSampleClk_LoopbackFromSckPad      = 2,
    kFlexSPIReadSampleClk_ExternalInputFromDqsPad = 3,
} flexspi_read_sample_clk_t;
 
enum
{
    kFlexSpiMiscOffset_DiffClkEnable            = 0, 
    kFlexSpiMiscOffset_Ck2Enable                = 1, 
    kFlexSpiMiscOffset_ParallelEnable           = 2, 
    kFlexSpiMiscOffset_WordAddressableEnable    = 3, 
    kFlexSpiMiscOffset_SafeConfigFreqEnable     = 4, 
    kFlexSpiMiscOffset_PadSettingOverrideEnable = 5, 
    kFlexSpiMiscOffset_DdrModeEnable            = 6, 
};
 
enum
{
    kFlexSpiDeviceType_SerialNOR    = 1,    
    kFlexSpiDeviceType_SerialNAND   = 2,    
    kFlexSpiDeviceType_SerialRAM    = 3,    
    kFlexSpiDeviceType_MCP_NOR_NAND = 0x12, 
    kFlexSpiDeviceType_MCP_NOR_RAM  = 0x13, 
};
 
enum
{
    kSerialFlash_1Pad  = 1,
    kSerialFlash_2Pads = 2,
    kSerialFlash_4Pads = 4,
    kSerialFlash_8Pads = 8,
};
 
typedef struct _lut_sequence
{
    uint8_t seqNum; 
    uint8_t seqId;  
    uint16_t reserved;
} flexspi_lut_seq_t;
 
enum
{
    kDeviceConfigCmdType_Generic,    
    kDeviceConfigCmdType_QuadEnable, 
    kDeviceConfigCmdType_Spi2Xpi,    
    kDeviceConfigCmdType_Xpi2Spi,    
    kDeviceConfigCmdType_Spi2NoCmd,  
    kDeviceConfigCmdType_Reset,      
};
 
typedef struct _FlexSPIConfig
{
    uint32_t tag;               
    uint32_t version;           
    uint32_t reserved0;         
    uint8_t readSampleClkSrc;   
    uint8_t csHoldTime;         
    uint8_t csSetupTime;        
    uint8_t columnAddressWidth; 
    uint8_t deviceModeCfgEnable; 
    uint8_t deviceModeType; 
    uint16_t waitTimeCfgCommands; 
    flexspi_lut_seq_t deviceModeSeq; 
    uint32_t deviceModeArg;    
    uint8_t configCmdEnable;   
    uint8_t configModeType[3]; 
    flexspi_lut_seq_t
        configCmdSeqs[3]; 
    uint32_t reserved1;   
    uint32_t configCmdArgs[3];     
    uint32_t reserved2;            
    uint32_t controllerMiscOption; 
    uint8_t deviceType;    
    uint8_t sflashPadType; 
    uint8_t serialClkFreq; 
    uint8_t lutCustomSeqEnable; 
    uint32_t reserved3[2];           
    uint32_t sflashA1Size;           
    uint32_t sflashA2Size;           
    uint32_t sflashB1Size;           
    uint32_t sflashB2Size;           
    uint32_t csPadSettingOverride;   
    uint32_t sclkPadSettingOverride; 
    uint32_t dataPadSettingOverride; 
    uint32_t dqsPadSettingOverride;  
    uint32_t timeoutInMs;            
    uint32_t commandInterval;        
    uint16_t dataValidTime[2]; 
    uint16_t busyOffset;       
    uint16_t busyBitPolarity;  
    uint32_t lookupTable[64];           
    flexspi_lut_seq_t lutCustomSeq[12]; 
    uint32_t reserved4[4];              
} flexspi_mem_config_t;
 
/*  */
#define NOR_CMD_INDEX_READ CMD_INDEX_READ               
#define NOR_CMD_INDEX_READSTATUS CMD_INDEX_READSTATUS   
#define NOR_CMD_INDEX_WRITEENABLE CMD_INDEX_WRITEENABLE 
#define NOR_CMD_INDEX_ERASESECTOR 3                     
#define NOR_CMD_INDEX_PAGEPROGRAM CMD_INDEX_WRITE       
#define NOR_CMD_INDEX_CHIPERASE 5                       
#define NOR_CMD_INDEX_DUMMY 6                           
#define NOR_CMD_INDEX_ERASEBLOCK 7                      
 
#define NOR_CMD_LUT_SEQ_IDX_READ CMD_LUT_SEQ_IDX_READ 
#define NOR_CMD_LUT_SEQ_IDX_READSTATUS \
    CMD_LUT_SEQ_IDX_READSTATUS 
#define NOR_CMD_LUT_SEQ_IDX_READSTATUS_XPI \
    2 
#define NOR_CMD_LUT_SEQ_IDX_WRITEENABLE \
    CMD_LUT_SEQ_IDX_WRITEENABLE 
#define NOR_CMD_LUT_SEQ_IDX_WRITEENABLE_XPI \
    4 
#define NOR_CMD_LUT_SEQ_IDX_ERASESECTOR 5 
#define NOR_CMD_LUT_SEQ_IDX_ERASEBLOCK 8  
#define NOR_CMD_LUT_SEQ_IDX_PAGEPROGRAM \
    CMD_LUT_SEQ_IDX_WRITE                
#define NOR_CMD_LUT_SEQ_IDX_CHIPERASE 11 
#define NOR_CMD_LUT_SEQ_IDX_READ_SFDP 13 
#define NOR_CMD_LUT_SEQ_IDX_RESTORE_NOCMD \
    14 
#define NOR_CMD_LUT_SEQ_IDX_EXIT_NOCMD \
    15 
 
/*
 *  Serial NOR configuration block
 */
typedef struct _flexspi_nor_config
{
    flexspi_mem_config_t memConfig; 
    uint32_t pageSize;              
    uint32_t sectorSize;            
    uint8_t ipcmdSerialClkFreq;     
    uint8_t isUniformBlockSize;     
    uint8_t reserved0[2];           
    uint8_t serialNorType;          
    uint8_t needExitNoCmdMode;      
    uint8_t halfClkForNonReadCmd;   
    uint8_t needRestoreNoCmdMode;   
    uint32_t blockSize;             
    uint32_t reserve2[11];          
} flexspi_nor_config_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __cplusplus
}
#endif
#endif /* __EVKMIMXRT1060_FLEXSPI_NOR_CONFIG__ */