flash.h

Go to the documentation of this file.

 
#ifndef _FLASH_H
#define _FLASH_H
 
// Dependencies
#include "compiler_port.h"
#include "error.h"
#include "memory/memory.h"
 
#include <stdint.h>
#include <stdlib.h>
 
// Flash Driver Major version
#define FLASH_DRIVER_VERSION_MAJOR 0x01
// Flash Driver Minor version
#define FLASH_DRIVER_VERSION_MINOR 0x01
// Flash Driver Revision version
#define FLASH_DRIVER_VERSION_PATCH 0x00
// Flash Driver version
#define FLASH_DRIVER_VERSION                                                                       \
        (uint32_t)(((FLASH_DRIVER_VERSION_MAJOR & 0xFF) << 16) |                                       \
        ((FLASH_DRIVER_VERSION_MINOR & 0xFF) << 8) | (FLASH_DRIVER_VERSION_PATCH & 0xFF))
 
// Flash Info flags definition
#define FLASH_FLAGS_LATER_SWAP 0x1
 
typedef enum
{
   FLASH_TYPE_INTERNAL,           // Internal memory
   FLASH_TYPE_EXTERNAL_PARALLEL,  // External parallel memory
   FLASH_TYPE_EXTERNAL_SPI,       // External SPI memory
   FLASH_TYPE_EXTERNAL_QSPI,      // External QSPI memory
   FLASH_TYPE_EXTERNAL_OSPI       // External OSPI (octal-SPI) memory
} FlashType;
 
#if 0
typedef enum
{
   //MEM_CLASS_FLASH,  //Flash memory
   MEM_CLASS_RAM,    //RAM memory
   MEM_CLASS_EEPROM  //EEPROM memory
} FlashClass;
#endif
 
typedef struct
{
   uint32_t version;     
   char *flashName;      
   FlashType flashType;  
   uint32_t flashAddr;   
   size_t flashSize;     
   size_t writeSize;     
   size_t readSize;      
   uint8_t dualBank;     
   size_t bankSize;      
   uint32_t bank1Addr;   
   uint32_t bank2Addr;   
   uint32_t flags;       
} FlashInfo;
 
typedef enum
{
   FLASH_STATUS_OK = 0,
   FLASH_STATUS_BUSY,
   FLASH_STATUS_ERR
} FlashStatus;
 
typedef error_t (*FlashInit)(void);
 
typedef error_t (*FlashDeInit)(void);
 
typedef error_t (*FlashGetInfo)(const FlashInfo **info);
 
typedef error_t (*FlashGetStatus)(FlashStatus *status);
 
typedef error_t (*FlashWrite)(uint32_t address, uint8_t *data, size_t length);
 
typedef error_t (*FlashRead)(uint32_t address, uint8_t *data, size_t length);
 
typedef error_t (*FlashErase)(uint32_t address, size_t length);
 
typedef error_t (*FlashSwapBanks)(void);
 
typedef error_t (*FlashGetNextSector)(uint32_t address, uint32_t *sectorAddr);
 
typedef bool_t (*FlashIsSectorAddr)(uint32_t address);
 
typedef error_t (*FlashActivateXiPMode)(bool_t activateXipMode);
 
typedef struct
{
   FlashInit init;                              
   FlashDeInit deInit;                          
   FlashGetInfo getInfo;                        
   FlashGetStatus getStatus;                    
   FlashWrite write;                            
   FlashRead read;                              
   FlashErase erase;                            
   FlashSwapBanks swapBanks;                    
   FlashGetNextSector getNextSectorAddr;        
   FlashIsSectorAddr isSectorAddr;              
   FlashActivateXiPMode flashActivateXiPMode;  
} FlashDriver;
 
// Shared flash range-check helpers. topAddress is EXCLUSIVE (base + size): the last valid
// byte/word ends exactly at topAddress and MUST be accepted. Overflow-safe (no address+length
// or address+4 that could wrap at 32-bit width on the target). Pure, host-unit-testable.
 
// True if a byte access [address, address+length) fits within [base, topAddress).
static inline bool_t flashRangeInBounds(uint32_t address, size_t length, uint32_t base,
   uint32_t topAddress)
{
   return address >= base && address < topAddress &&
          length <= (size_t) (topAddress - address);
}
 
// True if an aligned 32-bit word program at `address` fits within [.., topAddress).
static inline bool_t flashWordProgramInBounds(uint32_t address, uint32_t topAddress)
{
   return (address % sizeof(uint32_t)) == 0 && address < topAddress &&
          sizeof(uint32_t) <= (topAddress - address);
}
 
#endif