pan_fmc.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Panchip Technology Corp. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0 
 */
 
#ifndef __PAN_FMC_H__
#define __PAN_FMC_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
#define CMD_ERASE_PAGE      (0X81)      
#define CMD_ERASE_SECTOR    (0X20)      
#define CMD_ERASE_32K       (0X52)          
#define CMD_ERASE_64K       (0Xd8)          
#define CMD_ERASE_CHIP      (0xc7)      
#define CMD_READ_STATUS_L   (0x05)  
#define CMD_READ_STATUS_H   (0x35)  
#define CMD_WRITE_STATUS    (0x01)  
#define OPS_WR_STU_REG_NOR  (0x00)  
#define OPS_WR_STU_REG_ALL  (0x01)  
#define CMD_FAST_READ       (0x0b)              
#define CMD_NORM_READ       (0x03)              
#define CMD_DREAD           (0x3B)      
#define CMD_2READ           (0xBB)      
#define CMD_QREAD           (0x6B)      
#define CMD_4READ           (0xEB)      
#define CMD_BURST_READ      (0x77)          
#define BURST_READ_MODE_8   (0x00)          
#define BURST_READ_MODE_16  (0x01)      
#define BURST_READ_MODE_32  (0x02)      
#define BURST_READ_MODE_64  (0x03)      
#define CMD_TRIG            (0x01)                  
#define CMD_WRITE_ENABLE    (0x06)          
#define FLASH_X1_MODE       0               
#define FLASH_X2_MODE       1               
#define FLASH_X4_MODE       2               
#define  QUAD_ENABLE_Pos                               (9)          
#define  QUAD_ENABLE_Msk                               (0x1ul << QUAD_ENABLE_Pos)   
#define  Write_Enable_Latch_Pos                        (1)          
#define  Write_Enable_Latch_Msk                        (0x1ul << Write_Enable_Latch_Pos)    
#define  Write_In_Process_Pos                          (0)          
#define  Write_In_Process_Msk                          (0x1ul << Write_In_Process_Pos)  
#define  Long_Time_Op_Pos                              (17)         
#define PAGE_SIZE           (256)                   
#define SECTOR_SIZE         (4096)  
/* #pragma anon_unions */
typedef struct _flash_ids {
    uint8_t manufacturer_id;
    union {
        uint8_t d[2];
        struct {
            uint8_t memory_type_id;
            uint8_t memory_density_id;
        };
    };
    uint8_t uid[16];
} FLASH_IDS_T;
 
__STATIC_FORCEINLINE void FMC_EnterDeepPowerDownMode(FLCTL_T *fmc)
{
    // enter flash dp mode
    fmc->X_FL_CTL = (0<<8) | (0x01<<0);
    fmc->X_FL_WD[0] = 0xB9;
    fmc->X_FL_TRIG = CMD_TRIG;
    while(fmc->X_FL_TRIG){};
}
 
__STATIC_FORCEINLINE void FMC_ExitDeepPowerDownMode(FLCTL_T *fmc)
{
    // exit flash dp mode
    fmc->X_FL_CTL = (0<<8) | (0x01<<0);
    fmc->X_FL_WD[0] = 0xAB;
    fmc->X_FL_TRIG = CMD_TRIG;
    while(fmc->X_FL_TRIG){};
}
 
extern void FMC_GetFlashUniqueId(FLCTL_T *fmc);
 
extern void FMC_GetFlashJedecId(FLCTL_T *fmc);
 
extern uint32_t FMC_GetFlashCodeAreaSize(FLCTL_T *fmc);
 
extern int FMC_EraseSector(FLCTL_T *fmc,unsigned long adr);
extern int FMC_EraseBlock32k(FLCTL_T *fmc,unsigned long addr);
extern int FMC_EraseBlock64k(FLCTL_T *fmc,unsigned long addr);
extern int FMC_EraseChip(FLCTL_T *fmc);
extern int FMC_EraseCodeArea(FLCTL_T *fmc, uint32_t addr, uint32_t len);
 
extern void InitIcache(FLCTL_T *fmc,uint32_t mode);
 
extern int32_t FMC_GetCrc32Sum(FLCTL_T *fmc,uint32_t addr, uint32_t count, uint32_t *chksum);
 
extern int BlankCheck (FLCTL_T *fmc,unsigned long adr, unsigned long sz);
 
extern unsigned long Verify(FLCTL_T *fmc, unsigned long adr, unsigned long sz, unsigned char *buf);
 
extern int ProgramPage (FLCTL_T *fmc, unsigned long adr, unsigned long sz, unsigned char *buf);
 
extern unsigned char FMC_ReadStatusReg(FLCTL_T *fmc,unsigned char cmd);
 
extern unsigned char FMC_WriteEnable(FLCTL_T *fmc);
 
extern void FMC_WriteStatusReg(FLCTL_T *fmc, unsigned char ops, unsigned int buf);
 
extern unsigned char FMC_ReadByte(FLCTL_T *fmc, unsigned int Addr, unsigned char cmd);
 
extern void FMC_WriteByte(FLCTL_T *fmc, unsigned int addr, unsigned char data);
 
extern void FMC_WriteHalfWord(FLCTL_T *fmc, unsigned int addr, unsigned short data);
 
extern unsigned int FMC_ReadWord(FLCTL_T *fmc,unsigned int Addr, unsigned char cmd);
 
extern unsigned char *FMC_ReadPage(FLCTL_T *fmc,unsigned int Addr,unsigned char cmd);
 
extern int FMC_ReadStream(FLCTL_T *fmc, unsigned int Addr, unsigned char cmd, unsigned char *buf, unsigned int len);
 
extern int FMC_WriteStream(FLCTL_T *fmc, unsigned int Addr, unsigned char *buf, unsigned int len);
extern int FMC_ReadInfoArea(FLCTL_T *fmc, unsigned int Addr, unsigned char cmd, unsigned char *buf, unsigned int len);
extern int FMC_WriteInfoArea(FLCTL_T *fmc, unsigned int Addr, unsigned char *buf, unsigned int len);
extern int FMC_EraseInfoArea(FLCTL_T *fmc);
 
extern void FMC_SetFlashMode(FLCTL_T *fmc, uint32_t mode, bool enhance);
 
extern void FMC_ExitEnhanceMode(FLCTL_T *fmc);
 
extern void FMC_EnterEnhanceMode(FLCTL_T *fmc, uint32_t mode);
 
extern void FMC_EnableAutoDp(FLCTL_T *fmc);
 
extern void FMC_DisableAutoDp(FLCTL_T *fmc);
 
extern void FMC_SetRdpWaitCount(FLCTL_T *fmc, uint32_t cnt);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PAN_FMC_H__ */