w25q_mem.h

Go to the documentation of this file.

 
#ifndef W25Q_QSPI_W25Q_MEM_H_
#define W25Q_QSPI_W25Q_MEM_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "libs.h"
 
// YOUR CHIP'S SETTINGS
#define MEM_FLASH_SIZE 256U     // 256 MB-bit
#define MEM_BLOCK_SIZE 64U      // 64 KB: 256 pages
#define MEM_SBLOCK_SIZE 32U     // 32 KB: 128 pages
#define MEM_SECTOR_SIZE 4U      // 4 KB : 16 pages
#define MEM_PAGE_SIZE  256U     // 256 byte : 1 page
#define BLOCK_COUNT (MEM_FLASH_SIZE * 2) // 512 blocks
#define SECTOR_COUNT (BLOCK_COUNT * 16)  // 8192 sectors
#define PAGE_COUNT (SECTOR_COUNT * 16)   // 131'072 pages
 
typedef enum{
    W25Q_OK = 0,        
    W25Q_BUSY = 1,      
    W25Q_PARAM_ERR = 2, 
    W25Q_CHIP_ERR = 3,  
    W25Q_SPI_ERR = 4,   
    W25Q_CHIP_IGNORE = 5, 
}W25Q_STATE;
typedef struct{
    bool BUSY;  
    bool WEL;   
    bool QE;    
    bool SUS;   
    bool ADS;   
    bool ADP;   
    bool SLEEP; 
}W25Q_STATUS_REG;
W25Q_STATE W25Q_Init(void);     
 
W25Q_STATE W25Q_EnableVolatileSR(void);                      
W25Q_STATE W25Q_ReadStatusReg(u8_t *reg_data, u8_t reg_num); 
W25Q_STATE W25Q_WriteStatusReg(u8_t reg_data, u8_t reg_num);
W25Q_STATE W25Q_ReadStatusStruct(W25Q_STATUS_REG *status);   
W25Q_STATE W25Q_IsBusy(void);   
 
W25Q_STATE W25Q_ReadSByte(i8_t *buf, u8_t pageShift, u32_t pageNum);            
W25Q_STATE W25Q_ReadByte(u8_t *buf, u8_t pageShift, u32_t pageNum);             
W25Q_STATE W25Q_ReadSWord(i16_t *buf, u8_t pageShift, u32_t pageNum);           
W25Q_STATE W25Q_ReadWord(u16_t *buf, u8_t pageShift, u32_t pageNum);            
W25Q_STATE W25Q_ReadSLong(i32_t *buf, u8_t pageShift, u32_t pageNum);           
W25Q_STATE W25Q_ReadLong(u32_t *buf, u8_t pageShift, u32_t pageNum);            
W25Q_STATE W25Q_ReadData(u8_t *buf, u16_t len, u8_t pageShift, u32_t pageNum);  
W25Q_STATE W25Q_ReadRaw(u8_t *buf, u16_t data_len, u32_t rawAddr);              
W25Q_STATE W25Q_SingleRead(u8_t *buf, u32_t len, u32_t Addr);                   
 
W25Q_STATE W25Q_EraseSector(u32_t SectAddr);            
W25Q_STATE W25Q_EraseBlock(u32_t BlockAddr, u8_t size); 
W25Q_STATE W25Q_EraseChip(void);                        
 
W25Q_STATE W25Q_ProgramSByte(i8_t buf, u8_t pageShift, u32_t pageNum);           
W25Q_STATE W25Q_ProgramByte(u8_t buf, u8_t pageShift, u32_t pageNum);            
W25Q_STATE W25Q_ProgramSWord(i16_t buf, u8_t pageShift, u32_t pageNum);          
W25Q_STATE W25Q_ProgramWord(u16_t buf, u8_t pageShift, u32_t pageNum);           
W25Q_STATE W25Q_ProgramSLong(i32_t buf, u8_t pageShift, u32_t pageNum);          
W25Q_STATE W25Q_ProgramLong(u32_t buf, u8_t pageShift, u32_t pageNum);           
W25Q_STATE W25Q_ProgramData(u8_t *buf, u16_t len, u8_t pageShift, u32_t pageNum); 
W25Q_STATE W25Q_ProgramRaw(u8_t *buf, u16_t data_len, u32_t rawAddr);                    
 
W25Q_STATE W25Q_SetBurstWrap(u8_t WrapSize);        
 
W25Q_STATE W25Q_ProgSuspend(void);  
W25Q_STATE W25Q_ProgResume(void);   
 
W25Q_STATE W25Q_Sleep(void);    
W25Q_STATE W25Q_WakeUP(void);   
 
W25Q_STATE W25Q_ReadID(u8_t *buf);              
W25Q_STATE W25Q_ReadFullID(u8_t *buf);          
W25Q_STATE W25Q_ReadUID(u8_t *buf);             
W25Q_STATE W25Q_ReadJEDECID(u8_t *buf);         
W25Q_STATE W25Q_ReadSFDPRegister(u8_t *buf);    
 
W25Q_STATE W25Q_EraseSecurityRegisters(u8_t numReg);                            
W25Q_STATE W25Q_ProgSecurityRegisters(u8_t *buf, u8_t numReg, u8_t byteAddr);   
W25Q_STATE W25Q_ReadSecurityRegisters(u8_t *buf, u8_t numReg, u8_t byteAddr);   
 
W25Q_STATE W25Q_BlockReadOnly(u32_t Addr, bool enable);         
W25Q_STATE W25Q_BlockReadOnlyCheck(bool *state, u32_t Addr);    
W25Q_STATE W25Q_GlobalReadOnly(bool enable);        
 
W25Q_STATE W25Q_SwReset(bool force);    
 
 
#define W25Q_WRITE_ENABLE 0x06U         
#define W25Q_WRITE_DISABLE 0x04U        
#define W25Q_ENABLE_VOLATILE_SR 0x50U   
#define W25Q_READ_SR1 0x05U             
#define W25Q_READ_SR2 0x35U             
#define W25Q_READ_SR3 0x15U             
#define W25Q_WRITE_SR1 0x01U            
#define W25Q_WRITE_SR2 0x31U            
#define W25Q_WRITE_SR3 0x11U            
#define W25Q_READ_EXT_ADDR_REG 0xC8U    
#define W25Q_WRITE_EXT_ADDR_REG 0xC8U   
#define W25Q_ENABLE_4B_MODE 0xB7U           
#define W25Q_DISABLE_4B_MODE 0xE9U          
#define W25Q_READ_DATA 0x03U                
#define W25Q_READ_DATA_4B 0x13U             
#define W25Q_FAST_READ 0x0BU                
#define W25Q_FAST_READ_4B 0x0CU             
#define W25Q_FAST_READ_DUAL_OUT 0x3BU       
#define W25Q_FAST_READ_DUAL_OUT_4B 0x3CU    
#define W25Q_FAST_READ_QUAD_OUT 0x6BU       
#define W25Q_FAST_READ_QUAD_OUT_4B 0x6CU    
#define W25Q_FAST_READ_DUAL_IO 0xBBU        
#define W25Q_FAST_READ_DUAL_IO_4B 0xBCU     
#define W25Q_FAST_READ_QUAD_IO 0xEBU        
#define W25Q_FAST_READ_QUAD_IO_4B 0xECU     
#define W25Q_SET_BURST_WRAP 0x77U           
#define W25Q_PAGE_PROGRAM 0x02U             
#define W25Q_PAGE_PROGRAM_4B 0x12U          
#define W25Q_PAGE_PROGRAM_QUAD_INP 0x32U    
#define W25Q_PAGE_PROGRAM_QUAD_INP_4B 0x34U 
#define W25Q_SECTOR_ERASE 0x20U             
#define W25Q_SECTOR_ERASE_4B 0x21U          
#define W25Q_32KB_BLOCK_ERASE 0x52U         
#define W25Q_64KB_BLOCK_ERASE 0xD8U         
#define W25Q_64KB_BLOCK_ERASE_4B 0xDCU      
#define W25Q_CHIP_ERASE 0xC7U               
//#define W25Q_CHIP_ERASE 0x60U             ///< another way to erase chip
#define W25Q_ERASEPROG_SUSPEND 0x75U        
#define W25Q_ERASEPROG_RESUME 0x7AU         
#define W25Q_POWERDOWN 0xB9U                
#define W25Q_POWERUP 0xABU                  
#define W25Q_DEVID 0xABU                    
#define W25Q_FULLID 0x90U                   
#define W25Q_FULLID_DUAL_IO 0x92U           
#define W25Q_FULLID_QUAD_IO 0x94U           
#define W25Q_READ_UID 0x4BU                 
#define W25Q_READ_JEDEC_ID 0x9FU            
#define W25Q_READ_SFDP 0x5AU                
#define W25Q_ERASE_SECURITY_REG 0x44U       
#define W25Q_PROG_SECURITY_REG 0x42U        
#define W25Q_READ_SECURITY_REG 0x48U        
#define W25Q_IND_BLOCK_LOCK 0x36U           
#define W25Q_IND_BLOCK_UNLOCK 0x39U         
#define W25Q_READ_BLOCK_LOCK 0x3DU          
#define W25Q_GLOBAL_LOCK 0x7EU              
#define W25Q_GLOBAL_UNLOCK 0x98U            
#define W25Q_ENABLE_RST 0x66U               
#define W25Q_RESET 0x99U                    
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* W25Q_QSPI_W25Q_MEM_H_ */