sfc.h

浏览该文件的文档.

 
#ifndef SFC_H
#define SFC_H
 
#include <stdint.h>
#include <errcode.h>
#include <common_def.h>
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#define NULL_FLASH   0
 
typedef enum sfc_read_if {
    STANDARD_READ = 0x0,               
    FAST_READ = 0x1,                   
    FAST_READ_DUAL_OUTPUT = 0x2,       
    FAST_READ_DUAL_IO = 0x3,           
    FAST_READ_QUAD_OUTPUT = 0x4,       
    FAST_READ_QUAD_IO = 0x5            
} sfc_read_if_t;
 
typedef enum sfc_write_if {
    WRITE_DISABLE = 0x0,               
    PAGE_PROGRAM = 0x1,                
    DUAL_INPUT_PAGE_PROGRAM = 0x2,     
    DUAL_IO_PAGE_PROGRAM = 0x3,        
    QUAD_INPUT_PAGE_PROGRAM = 0x4,     
    QUAD_IO_PAGE_PROGRAM = 0x5         
} sfc_write_if_t;
 
typedef enum sfc_flash_op {
    READ_TYPE = 0x0,                   
    WRITE_TYPE = 0x1                   
} sfc_flash_op_t;
 
typedef struct sfc_flash_config {
    sfc_read_if_t read_type;           
    sfc_write_if_t write_type;         
    uint32_t mapping_addr;             
    uint32_t mapping_size;             
} sfc_flash_config_t;
 
errcode_t uapi_sfc_init(sfc_flash_config_t *config);
 
errcode_t uapi_sfc_init_rom(sfc_flash_config_t *config);
 
void uapi_sfc_deinit(void);
 
errcode_t uapi_sfc_reg_read(uint32_t flash_addr, uint8_t *read_buffer, uint32_t read_size);
 
errcode_t uapi_sfc_reg_write(uint32_t flash_addr, uint8_t *write_data, uint32_t write_size);
 
errcode_t uapi_sfc_reg_erase(uint32_t flash_addr, uint32_t erase_size);
 
errcode_t uapi_sfc_reg_erase_chip(void);
 
errcode_t uapi_sfc_reg_other_flash_opt(sfc_flash_op_t cmd_type, uint8_t cmd, uint8_t *buffer, uint32_t length);
 
#if defined(CONFIG_SFC_SUPPORT_DMA)
errcode_t uapi_sfc_dma_read(uint32_t flash_addr, uint8_t *read_buffer, uint32_t read_size);
 
errcode_t uapi_sfc_dma_write(uint32_t flash_addr, uint8_t *write_buffer, uint32_t write_size);
 
#endif /* CONFIG_SFC_SUPPORT_DMA */
 
#if defined(CONFIG_SFC_SUPPORT_LPM)
errcode_t uapi_sfc_suspend(uintptr_t arg);
 
errcode_t uapi_sfc_resume(uintptr_t arg);
#endif  /* CONFIG_SFC_SUPPORT_LPM */
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif