flash.h

Go to the documentation of this file.

 
#ifndef _FLASH_H
#define _FLASH_H
 
/* Includes ------------------------------------------------------------------*/
#include <STM32FreeRTOS.h>
#include "ticks.hpp"
#include "thread.hpp"
#include "stm32l4xx_hal.h"
#include "FreeRTOS.h"
#include "AT25SF161.h"
 
using namespace cpp_freertos;
 
#define FLASH_MEMORYMAP_BASE    0x90000000
 
// Security Check W->R Data
#define CHECK_FLASH_WRITE
 
#define FLASH_FW_POSITION   (0ul)
#define FLASH_FW_BACKUP     (262144ul)  // 000 - 256 KBytes For Program Flash
#define FLASH_FILE_POSITION (524288ul)  // 256 - 512 KBytes For Program Flash (Backup)
#define FLASH_FREE_ACCESS   (1048756ul) // 512 - 1024 KBytes For Extra File (... -> Free)
#define FLASH_BUFFER_SIZE   (256)
#define FLASH_INFO_SIZE_LEN (256)
#define FLASH_FILE_SIZE_LEN (128)
#define FLASH_SIZE_ADDR(X)  (X + FLASH_FILE_SIZE_LEN + 1)
#define FLASH_INFO_SIZE_U64 (8)
 
class Flash {
 
  public:
 
    /* QSPI Error codes */
    typedef enum
    {
      QSPI_KO_INIT              = -1,
      QSPI_OK                   = HAL_OK,
      QSPI_ERROR                = HAL_ERROR,
      QSPI_BUSY                 = HAL_BUSY,
      QSPI_TIMEOUT              = HAL_TIMEOUT,
      QSPI_NOT_SUPPORTED,
      QSPI_SUSPENDED,
      QSPI_READY,
      QSPI_RESET
    } QSPI_StatusTypeDef;
 
    /* QSPI IT EventFlag */
    typedef union {
      struct {
        uint8_t flag_TE : 1;      
        uint8_t flag_TC : 1;      
        uint8_t flag_SM : 1;      
        uint8_t match_TE : 1;     
        uint8_t match_TC : 1;     
        uint8_t match_SM : 1;     
      } flagBit;
      uint8_t flag;
    } QSPI_IT_EventFlag;
 
    /* QSPI Info */
    typedef struct
    {
      uint32_t FlashSize;           
      uint32_t EraseBlockSize;      
      uint32_t EraseBlockNumber;        
      uint32_t ProgPageSize;        
      uint32_t ProgPagesNumber;     
      uint32_t StatusRegister;          
      __IO QSPI_StatusTypeDef State;   
    } QSPI_Info;
 
    Flash();
    Flash(QSPI_HandleTypeDef *hqspi);
    QSPI_StatusTypeDef BSP_QSPI_Init(void);
    QSPI_StatusTypeDef BSP_QSPI_DeInit(void);
    QSPI_StatusTypeDef BSP_QSPI_Read(uint8_t *pData, uint32_t ReadAddr, uint32_t Size);
    QSPI_StatusTypeDef BSP_QSPI_Write(uint8_t *pData, uint32_t WriteAddr, uint32_t Size);
    QSPI_StatusTypeDef BSP_QSPI_Erase_Block(uint32_t BlockAddress);
    QSPI_StatusTypeDef BSP_QSPI_Erase_Sector(uint32_t Sector);
    QSPI_StatusTypeDef BSP_QSPI_Erase_Chip(void);
    QSPI_StatusTypeDef BSP_QSPI_ReadStatus(uint32_t *Reg);
    QSPI_StatusTypeDef BSP_QSPI_WriteStatus(uint32_t Reg);
    QSPI_StatusTypeDef BSP_QSPI_GetStatus(void);
    QSPI_StatusTypeDef BSP_QSPI_GetInfo(QSPI_Info *pInfo);
    QSPI_StatusTypeDef BSP_QSPI_EnableMemoryMappedMode(void);
    QSPI_StatusTypeDef BSP_QSPI_DisableMemoryMappedMode(void);
    uint8_t BSP_QSPI_SuspendErase(void);
    uint8_t BSP_QSPI_ResumeErase(void);
 
protected:
private:
 
    QSPI_StatusTypeDef BSP_QSPI_Receive(uint8_t *pData, uint32_t Timeout);
    QSPI_StatusTypeDef BSP_QSPI_Transmit(uint8_t *pData, uint32_t Timeout);
    QSPI_StatusTypeDef BSP_QSPI_AutoPolling(QSPI_CommandTypeDef *cmd, QSPI_AutoPollingTypeDef *cfg, uint32_t Timeout);
    QSPI_StatusTypeDef BSP_QSPI_WaitingForEvent(uint32_t Timeout);
    QSPI_StatusTypeDef QSPI_SetDeepPowerDown(void);
    QSPI_StatusTypeDef QSPI_ExitDeepPowerDown(void);
    QSPI_StatusTypeDef QSPI_ResetMemory(void);
    QSPI_StatusTypeDef QSPI_DummyCyclesCfg(void);
    QSPI_StatusTypeDef QSPI_WriteEnableVolat(void);
    QSPI_StatusTypeDef QSPI_WriteEnable(void);
    QSPI_StatusTypeDef QSPI_WriteDisable(void);
    QSPI_StatusTypeDef QSPI_DisableContinuousMode(void);
    QSPI_StatusTypeDef QSPI_AutoPollingMemReady(uint32_t Timeout);
 
    QSPI_HandleTypeDef *_hqspi;
    inline static QSPI_Info _FlashInfo;
    inline static QSPI_IT_EventFlag *_evtFlag;
};
 
#endif /* __ETH452_QSPI_H */