embedded2/Middlewares/Third_Party/NimaLTD_Driver/SPIF/spif.c

/************************************************************************************************************
**************    Include Headers
************************************************************************************************************/

#include "spif.h"

#if SPIF_DEBUG == SPIF_DEBUG_DISABLE
#define dprintf(...)
#else
#include <stdio.h>
#define dprintf(...) printf(__VA_ARGS__)
#endif

#if SPIF_RTOS == SPIF_RTOS_DISABLE
#elif SPIF_RTOS == SPIF_RTOS_CMSIS_V1
#include "cmsis_os.h"
#include "freertos.h"
#elif SPIF_RTOS == SPIF_RTOS_CMSIS_V2
#include "cmsis_os2.h"
#include "freertos.h"
#elif SPIF_RTOS == SPIF_RTOS_THREADX
#include "app_threadx.h"
#endif

/************************************************************************************************************
**************    Private Definitions
************************************************************************************************************/

#define SPIF_DUMMY_BYTE 0xA5

#define SPIF_CMD_READSFDP 0x5A
#define SPIF_CMD_ID 0x90
#define SPIF_CMD_JEDECID 0x9F
#define SPIF_CMD_UNIQUEID 0x4B
#define SPIF_CMD_WRITEDISABLE 0x04
#define SPIF_CMD_READSTATUS1 0x05
#define SPIF_CMD_READSTATUS2 0x35
#define SPIF_CMD_READSTATUS3 0x15
#define SPIF_CMD_WRITESTATUSEN 0x50
#define SPIF_CMD_WRITESTATUS1 0x01
#define SPIF_CMD_WRITESTATUS2 0x31
#define SPIF_CMD_WRITESTATUS3 0x11
#define SPIF_CMD_WRITEENABLE 0x06
#define SPIF_CMD_ADDR4BYTE_EN 0xB7
#define SPIF_CMD_ADDR4BYTE_DIS 0xE9
#define SPIF_CMD_PAGEPROG3ADD 0x02
#define SPIF_CMD_PAGEPROG4ADD 0x12
#define SPIF_CMD_READDATA3ADD 0x03
#define SPIF_CMD_READDATA4ADD 0x13
#define SPIF_CMD_FASTREAD3ADD 0x0B
#define SPIF_CMD_FASTREAD4ADD 0x0C
#define SPIF_CMD_SECTORERASE3ADD 0x20
#define SPIF_CMD_SECTORERASE4ADD 0x21
#define SPIF_CMD_BLOCKERASE3ADD 0xD8
#define SPIF_CMD_BLOCKERASE4ADD 0xDC
#define SPIF_CMD_CHIPERASE1 0x60
#define SPIF_CMD_CHIPERASE2 0xC7
#define SPIF_CMD_SUSPEND 0x75
#define SPIF_CMD_RESUME 0x7A
#define SPIF_CMD_POWERDOWN 0xB9
#define SPIF_CMD_RELEASE 0xAB
#define SPIF_CMD_FRAMSERNO 0xC3

#define SPIF_STATUS1_BUSY (1 << 0)
#define SPIF_STATUS1_WEL (1 << 1)
#define SPIF_STATUS1_BP0 (1 << 2)
#define SPIF_STATUS1_BP1 (1 << 3)
#define SPIF_STATUS1_BP2 (1 << 4)
#define SPIF_STATUS1_TP (1 << 5)
#define SPIF_STATUS1_SEC (1 << 6)
#define SPIF_STATUS1_SRP0 (1 << 7)

#define SPIF_STATUS2_SRP1 (1 << 0)
#define SPIF_STATUS2_QE (1 << 1)
#define SPIF_STATUS2_RESERVE1 (1 << 2)
#define SPIF_STATUS2_LB0 (1 << 3)
#define SPIF_STATUS2_LB1 (1 << 4)
#define SPIF_STATUS2_LB2 (1 << 5)
#define SPIF_STATUS2_CMP (1 << 6)
#define SPIF_STATUS2_SUS (1 << 7)

#define SPIF_STATUS3_RESERVE1 (1 << 0)
#define SPIF_STATUS3_RESERVE2 (1 << 1)
#define SPIF_STATUS3_WPS (1 << 2)
#define SPIF_STATUS3_RESERVE3 (1 << 3)
#define SPIF_STATUS3_RESERVE4 (1 << 4)
#define SPIF_STATUS3_DRV0 (1 << 5)
#define SPIF_STATUS3_DRV1 (1 << 6)
#define SPIF_STATUS3_HOLD (1 << 7)

/************************************************************************************************************
**************    Private Functions
************************************************************************************************************/

void     SPIF_Delay(uint32_t Delay);
void     SPIF_Lock(SPIF_HandleTypeDef *Handle);
void     SPIF_UnLock(SPIF_HandleTypeDef *Handle);
void     SPIF_CsPin(SPIF_HandleTypeDef *Handle, bool Select);
bool     SPIF_TransmitReceive(SPIF_HandleTypeDef *Handle, uint8_t *Tx, uint8_t *Rx, size_t Size, uint32_t Timeout);
bool     SPIF_Transmit(SPIF_HandleTypeDef *Handle, uint8_t *Tx, size_t Size, uint32_t Timeout);
bool     SPIF_Receive(SPIF_HandleTypeDef *Handle, uint8_t *Rx, size_t Size, uint32_t Timeout);
bool     SPIF_WriteEnable(SPIF_HandleTypeDef *Handle);
bool     SPIF_WriteDisable(SPIF_HandleTypeDef *Handle);
uint8_t  SPIF_ReadReg1(SPIF_HandleTypeDef *Handle);
uint8_t  SPIF_ReadReg2(SPIF_HandleTypeDef *Handle);
uint8_t  SPIF_ReadReg3(SPIF_HandleTypeDef *Handle);
bool     SPIF_WriteReg1(SPIF_HandleTypeDef *Handle, uint8_t Data);
bool     SPIF_WriteReg2(SPIF_HandleTypeDef *Handle, uint8_t Data);
bool     SPIF_WriteReg3(SPIF_HandleTypeDef *Handle, uint8_t Data);
bool     SPIF_WaitForWriting(SPIF_HandleTypeDef *Handle, uint32_t Timeout);
bool     SPIF_FindChip(SPIF_HandleTypeDef *Handle);
bool     SPIF_WriteFn(SPIF_HandleTypeDef *Handle, uint32_t PageNumber, uint8_t *Data, uint32_t Size, uint32_t Offset);
bool     SPIF_ReadFn(SPIF_HandleTypeDef *Handle, uint32_t Address, uint8_t *Data, uint32_t Size);

/***********************************************************************************************************/

void SPIF_Delay(uint32_t Delay)
{
#if SPIF_RTOS == SPIF_RTOS_DISABLE
  HAL_Delay(Delay);
#elif (SPIF_RTOS == SPIF_RTOS_CMSIS_V1) || (SPIF_RTOS == SPIF_RTOS_CMSIS_V2)
  uint32_t d = (configTICK_RATE_HZ * Delay) / 1000;
  if (d == 0)
      d = 1;
  osDelay(d);
#elif SPIF_RTOS == SPIF_RTOS_THREADX
  uint32_t d = (TX_TIMER_TICKS_PER_SECOND * Delay) / 1000;
  if (d == 0)
    d = 1;
  tx_thread_sleep(d);
#endif
}

/***********************************************************************************************************/

void SPIF_Lock(SPIF_HandleTypeDef *Handle)
{
  while (Handle->Lock)
  {
    SPIF_Delay(1);
  }
  Handle->Lock = 1;
}

/***********************************************************************************************************/

void SPIF_UnLock(SPIF_HandleTypeDef *Handle)
{
  Handle->Lock = 0;
}

/***********************************************************************************************************/

void SPIF_CsPin(SPIF_HandleTypeDef *Handle, bool Select)
{
  HAL_GPIO_WritePin(Handle->Gpio, Handle->Pin, (GPIO_PinState)Select);
  for (int i = 0; i < 10; i++);
}

/***********************************************************************************************************/

bool SPIF_TransmitReceive(SPIF_HandleTypeDef *Handle, uint8_t *Tx, uint8_t *Rx, size_t Size, uint32_t Timeout)
{
  bool retVal = false;
#if (SPIF_PLATFORM == SPIF_PLATFORM_HAL)
  if (HAL_SPI_TransmitReceive(Handle->HSpi, Tx, Rx, Size, Timeout) == HAL_OK)
  {
    retVal = true;
  }
  else
  {
    dprintf("SPIF TIMEOUT\r\n");
  }
#elif (SPIF_PLATFORM == SPIF_PLATFORM_HAL_DMA)
  uint32_t startTime = HAL_GetTick();
  if (HAL_SPI_TransmitReceive_DMA(Handle->HSpi, Tx, Rx, Size) != HAL_OK)
  {
    dprintf("SPIF TRANSFER ERROR\r\n");
  }
  else
  {
    while (1)
    {
      SPIF_Delay(1);
      if (HAL_GetTick() - startTime >= Timeout)
      {
        dprintf("SPIF TIMEOUT\r\n");
        HAL_SPI_DMAStop(Handle->HSpi);
        break;
      }
      if (HAL_SPI_GetState(Handle->HSpi) == HAL_SPI_STATE_READY)
      {
        retVal = true;
        break;
      }
    }
  }
#endif
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_Transmit(SPIF_HandleTypeDef *Handle, uint8_t *Tx, size_t Size, uint32_t Timeout)
{
  bool retVal = false;
#if (SPIF_PLATFORM == SPIF_PLATFORM_HAL)
  if (HAL_SPI_Transmit(Handle->HSpi, Tx, Size, Timeout) == HAL_OK)
  {
    retVal = true;
  }
  else
  {
    dprintf("SPIF TIMEOUT\r\n");
  }
#elif (SPIF_PLATFORM == SPIF_PLATFORM_HAL_DMA)
  uint32_t startTime = HAL_GetTick();
  if (HAL_SPI_Transmit_DMA(Handle->HSpi, Tx, Size) != HAL_OK)
  {
    dprintf("SPIF TRANSFER ERROR\r\n");
  }
  else
  {
    while (1)
    {
      SPIF_Delay(1);
      if (HAL_GetTick() - startTime >= Timeout)
      {
        dprintf("SPIF TIMEOUT\r\n");
        HAL_SPI_DMAStop(Handle->HSpi);
        break;
      }
      if (HAL_SPI_GetState(Handle->HSpi) == HAL_SPI_STATE_READY)
      {
        retVal = true;
        break;
      }
    }
  }
#endif
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_Receive(SPIF_HandleTypeDef *Handle, uint8_t *Rx, size_t Size, uint32_t Timeout)
{
  bool retVal = false;
#if (SPIF_PLATFORM == SPIF_PLATFORM_HAL)
  if (HAL_SPI_Receive(Handle->HSpi, Rx, Size, Timeout) == HAL_OK)
  {
    retVal = true;
  }
  else
  {
    dprintf("SPIF TIMEOUT\r\n");
  }
#elif (SPIF_PLATFORM == SPIF_PLATFORM_HAL_DMA)
  uint32_t startTime = HAL_GetTick();
  if (HAL_SPI_Receive_DMA(Handle->HSpi, Rx, Size) != HAL_OK)
  {
    dprintf("SPIF TRANSFER ERROR\r\n");
  }
  else
  {
    while (1)
    {
      SPIF_Delay(1);
      if (HAL_GetTick() - startTime >= Timeout)
      {
        dprintf("SPIF TIMEOUT\r\n");
        HAL_SPI_DMAStop(Handle->HSpi);
        break;
      }
      if (HAL_SPI_GetState(Handle->HSpi) == HAL_SPI_STATE_READY)
      {
        retVal = true;
        break;
      }
    }
  }
#endif
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteEnable(SPIF_HandleTypeDef *Handle)
{
  bool retVal = true;
  uint8_t tx[1] = {SPIF_CMD_WRITEENABLE};
  SPIF_CsPin(Handle, 0);
  if (SPIF_Transmit(Handle, tx, 1, 100) == false)
  {
    retVal = false;
    dprintf("SPIF_WriteEnable() Error\r\n");
  }
  SPIF_CsPin(Handle, 1);
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteDisable(SPIF_HandleTypeDef *Handle)
{
  bool retVal = true;
  uint8_t tx[1] = {SPIF_CMD_WRITEDISABLE};
  SPIF_CsPin(Handle, 0);
  if (SPIF_Transmit(Handle, tx, 1, 100) == false)
  {
    retVal = false;
    dprintf("SPIF_WriteDisable() Error\r\n");
  }
  SPIF_CsPin(Handle, 1);
  return retVal;
}

/***********************************************************************************************************/

uint8_t SPIF_ReadReg1(SPIF_HandleTypeDef *Handle)
{
  uint8_t retVal = 0;
  uint8_t tx[2] = {SPIF_CMD_READSTATUS1, SPIF_DUMMY_BYTE};
  uint8_t rx[2];
  SPIF_CsPin(Handle, 0);
  if (SPIF_TransmitReceive(Handle, tx, rx, 2, 100) == true)
  {
    retVal = rx[1];
  }
  SPIF_CsPin(Handle, 1);
  return retVal;
}

/***********************************************************************************************************/

uint8_t SPIF_ReadReg2(SPIF_HandleTypeDef *Handle)
{
  uint8_t retVal = 0;
  uint8_t tx[2] = {SPIF_CMD_READSTATUS2, SPIF_DUMMY_BYTE};
  uint8_t rx[2];
  SPIF_CsPin(Handle, 0);
  if (SPIF_TransmitReceive(Handle, tx, rx, 2, 100) == true)
  {
    retVal = rx[1];
  }
  SPIF_CsPin(Handle, 1);
  return retVal;
}

/***********************************************************************************************************/

uint8_t SPIF_ReadReg3(SPIF_HandleTypeDef *Handle)
{
  uint8_t retVal = 0;
  uint8_t tx[2] = {SPIF_CMD_READSTATUS3, SPIF_DUMMY_BYTE};
  uint8_t rx[2];
  SPIF_CsPin(Handle, 0);
  if (SPIF_TransmitReceive(Handle, tx, rx, 2, 100) == true)
  {
    retVal = rx[1];
  }
  SPIF_CsPin(Handle, 1);
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteReg1(SPIF_HandleTypeDef *Handle, uint8_t Data)
{
  bool retVal = true;
  uint8_t tx[2] = {SPIF_CMD_WRITESTATUS1, Data};
  uint8_t cmd = SPIF_CMD_WRITESTATUSEN;
  do
  {
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, &cmd, 1, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, tx, 2, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
  } while (0);

  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteReg2(SPIF_HandleTypeDef *Handle, uint8_t Data)
{
  bool retVal = true;
  uint8_t tx[2] = {SPIF_CMD_WRITESTATUS2, Data};
  uint8_t cmd = SPIF_CMD_WRITESTATUSEN;
  do
  {
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, &cmd, 1, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, tx, 2, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
  } while (0);

  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteReg3(SPIF_HandleTypeDef *Handle, uint8_t Data)
{
  bool retVal = true;
  uint8_t tx[2] = {SPIF_CMD_WRITESTATUS3, Data};
  uint8_t cmd = SPIF_CMD_WRITESTATUSEN;
  do
  {
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, &cmd, 1, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, tx, 2, 100) == false)
    {
      retVal = false;
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
  } while (0);

  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WaitForWriting(SPIF_HandleTypeDef *Handle, uint32_t Timeout)
{
  bool retVal = false;
  uint32_t startTime = HAL_GetTick();
  while (1)
  {
    SPIF_Delay(1);
    if (HAL_GetTick() - startTime >= Timeout)
    {
      dprintf("SPIF_WaitForWriting() TIMEOUT\r\n");
      break;
    }
    if ((SPIF_ReadReg1(Handle) & SPIF_STATUS1_BUSY) == 0)
    {
      retVal = true;
      break;
    }
  }
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_FindChip(SPIF_HandleTypeDef *Handle)
{
  uint8_t tx[4] = {SPIF_CMD_JEDECID, 0xFF, 0xFF, 0xFF};
  uint8_t rx[4];
  bool retVal = false;
  do
  {
    dprintf("SPIF_FindChip()\r\n");
    SPIF_CsPin(Handle, 0);
    if (SPIF_TransmitReceive(Handle, tx, rx, 4, 100) == false)
    {
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    dprintf("CHIP ID: 0x%02X%02X%02X\r\n", rx[1], rx[2], rx[3]);
    Handle->Manufactor = rx[1];
    Handle->MemType = rx[2];
    Handle->Size = rx[3];

    dprintf("SPIF MANUFACTURE: ");
    switch (Handle->Manufactor)
    {
    case SPIF_MANUFACTOR_WINBOND:
      dprintf("WINBOND");
      break;
    case SPIF_MANUFACTOR_SPANSION:
      dprintf("SPANSION");
      break;
    case SPIF_MANUFACTOR_MICRON:
      dprintf("MICRON");
      break;
    case SPIF_MANUFACTOR_MACRONIX:
      dprintf("MACRONIX");
      break;
    case SPIF_MANUFACTOR_ISSI:
      dprintf("ISSI");
      break;
    case SPIF_MANUFACTOR_GIGADEVICE:
      dprintf("GIGADEVICE");
      break;
    case SPIF_MANUFACTOR_AMIC:
      dprintf("AMIC");
      break;
    case SPIF_MANUFACTOR_SST:
      dprintf("SST");
      break;
    case SPIF_MANUFACTOR_HYUNDAI:
      dprintf("HYUNDAI");
      break;
    case SPIF_MANUFACTOR_FUDAN:
      dprintf("FUDAN");
      break;
    case SPIF_MANUFACTOR_ESMT:
      dprintf("ESMT");
      break;
    case SPIF_MANUFACTOR_INTEL:
      dprintf("INTEL");
      break;
    case SPIF_MANUFACTOR_SANYO:
      dprintf("SANYO");
      break;
    case SPIF_MANUFACTOR_FUJITSU:
      dprintf("FUJITSU");
      break;
    case SPIF_MANUFACTOR_EON:
      dprintf("EON");
      break;
    case SPIF_MANUFACTOR_PUYA:
      dprintf("PUYA");
      break;
    default:
      Handle->Manufactor = SPIF_MANUFACTOR_ERROR;
      dprintf("ERROR");
      break;
    }
    dprintf(" - MEMTYPE: 0x%02X", Handle->MemType);
    dprintf(" - SIZE: ");
    switch (Handle->Size)
    {
    case SPIF_SIZE_1MBIT:
      Handle->BlockCnt = 2;
      dprintf("1 MBIT\r\n");
      break;
    case SPIF_SIZE_2MBIT:
      Handle->BlockCnt = 4;
      dprintf("2 MBIT\r\n");
      break;
    case SPIF_SIZE_4MBIT:
      Handle->BlockCnt = 8;
      dprintf("4 MBIT\r\n");
      break;
    case SPIF_SIZE_8MBIT:
      Handle->BlockCnt = 16;
      dprintf("8 MBIT\r\n");
      break;
    case SPIF_SIZE_16MBIT:
      Handle->BlockCnt = 32;
      dprintf("16 MBIT\r\n");
      break;
    case SPIF_SIZE_32MBIT:
      Handle->BlockCnt = 64;
      dprintf("32 MBIT\r\n");
      break;
    case SPIF_SIZE_64MBIT:
      Handle->BlockCnt = 128;
      dprintf("64 MBIT\r\n");
      break;
    case SPIF_SIZE_128MBIT:
      Handle->BlockCnt = 256;
      dprintf("128 MBIT\r\n");
      break;
    case SPIF_SIZE_256MBIT:
      Handle->BlockCnt = 512;
      dprintf("256 MBIT\r\n");
      break;
    case SPIF_SIZE_512MBIT:
      Handle->BlockCnt = 1024;
      dprintf("512 MBIT\r\n");
      break;
    default:
      Handle->Size = SPIF_SIZE_ERROR;
      dprintf("ERROR\r\n");
      break;
    }

    Handle->SectorCnt = Handle->BlockCnt * 16;
    Handle->PageCnt = (Handle->SectorCnt * SPIF_SECTOR_SIZE) / SPIF_PAGE_SIZE;
    dprintf("SPIF BLOCK CNT: %ld\r\n", Handle->BlockCnt);
    dprintf("SPIF SECTOR CNT: %ld\r\n", Handle->SectorCnt);
    dprintf("SPIF PAGE CNT: %ld\r\n", Handle->PageCnt);
    dprintf("SPIF STATUS1: 0x%02X\r\n", SPIF_ReadReg1(Handle));
    dprintf("SPIF STATUS2: 0x%02X\r\n", SPIF_ReadReg2(Handle));
    dprintf("SPIF STATUS3: 0x%02X\r\n", SPIF_ReadReg3(Handle));
    retVal = true;

  } while (0);

  return retVal;
}

/***********************************************************************************************************/

bool SPIF_WriteFn(SPIF_HandleTypeDef *Handle, uint32_t PageNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  bool retVal = false;
  uint32_t address = 0, maximum = SPIF_PAGE_SIZE - Offset;
  uint8_t tx[5];
  do
  {
#if SPIF_DEBUG != SPIF_DEBUG_DISABLE
    uint32_t dbgTime = HAL_GetTick();
#endif
    dprintf("SPIF_WritePage() START PAGE %ld\r\n", PageNumber);
    if (PageNumber >= Handle->PageCnt)
    {
      dprintf("SPIF_WritePage() ERROR PageNumber\r\n");
      break;
    }
    if (Offset >= SPIF_PAGE_SIZE)
    {
      dprintf("SPIF_WritePage() ERROR Offset\r\n");
      break;
    }
    if (Size > maximum)
    {
      Size = maximum;
    }
    address = SPIF_PageToAddress(PageNumber) + Offset;
#if SPIF_DEBUG == SPIF_DEBUG_FULL
      dprintf("SPIF WRITING {\r\n0x%02X", Data[0]);
      for (int i = 1; i < Size; i++)
      {
        if (i % 8 == 0)
        {
          dprintf("\r\n");
        }
        dprintf(", 0x%02X", Data[i]);
      }
      dprintf("\r\n}\r\n");
#endif
    if (SPIF_WriteEnable(Handle) == false)
    {
      break;
    }
    SPIF_CsPin(Handle, 0);
    if (Handle->BlockCnt >= 512)
    {
      tx[0] = SPIF_CMD_PAGEPROG4ADD;
      tx[1] = (address & 0xFF000000) >> 24;
      tx[2] = (address & 0x00FF0000) >> 16;
      tx[3] = (address & 0x0000FF00) >> 8;
      tx[4] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 5, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    else
    {
      tx[0] = SPIF_CMD_PAGEPROG3ADD;
      tx[1] = (address & 0x00FF0000) >> 16;
      tx[2] = (address & 0x0000FF00) >> 8;
      tx[3] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 4, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    if (SPIF_Transmit(Handle, Data, Size, 1000) == false)
    {
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    if (SPIF_WaitForWriting(Handle, 100))
    {
      dprintf("SPIF_WritePage() %d BYTES WITERN DONE AFTER %ld ms\r\n", (uint16_t)Size, HAL_GetTick() - dbgTime);
      retVal = true;
    }

  } while (0);

  SPIF_WriteDisable(Handle);
  return retVal;
}

/***********************************************************************************************************/

bool SPIF_ReadFn(SPIF_HandleTypeDef *Handle, uint32_t Address, uint8_t *Data, uint32_t Size)
{
  bool retVal = false;
  uint8_t tx[5];
  do
  {
#if SPIF_DEBUG != SPIF_DEBUG_DISABLE
    uint32_t dbgTime = HAL_GetTick();
#endif
    dprintf("SPIF_ReadAddress() START ADDRESS %ld\r\n", Address);
    SPIF_CsPin(Handle, 0);
    if (Handle->BlockCnt >= 512)
    {
      tx[0] = SPIF_CMD_READDATA4ADD;
      tx[1] = (Address & 0xFF000000) >> 24;
      tx[2] = (Address & 0x00FF0000) >> 16;
      tx[3] = (Address & 0x0000FF00) >> 8;
      tx[4] = (Address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 5, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    else
    {
      tx[0] = SPIF_CMD_READDATA3ADD;
      tx[1] = (Address & 0x00FF0000) >> 16;
      tx[2] = (Address & 0x0000FF00) >> 8;
      tx[3] = (Address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 4, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    if (SPIF_Receive(Handle, Data, Size, 2000) == false)
    {
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    dprintf("SPIF_ReadAddress() %d BYTES READ DONE AFTER %ld ms\r\n", (uint16_t)Size, HAL_GetTick() - dbgTime);
#if SPIF_DEBUG == SPIF_DEBUG_FULL
    dprintf("{\r\n0x%02X", Data[0]);
    for (int i = 1; i < Size; i++)
    {
      if (i % 8 == 0)
      {
        dprintf("\r\n");
      }
      dprintf(", 0x%02X", Data[i]);
    }
    dprintf("\r\n}\r\n");
#endif
    retVal = true;

  } while (0);

  return retVal;
}

/************************************************************************************************************
**************    Public Functions
************************************************************************************************************/

/**
  * @brief  Initialize the SPIF.
  * @note   Enable and configure the SPI and Set GPIO as output for CS pin on the CubeMX
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  *HSpi: Pointer to a SPI_HandleTypeDef structure
  * @param  *Gpio: Pointer to a GPIO_TypeDef structure for CS
  * @param  Pin: Pin of CS
  *
  * @retval bool: true or false
  */
bool SPIF_Init(SPIF_HandleTypeDef *Handle, SPI_HandleTypeDef *HSpi, GPIO_TypeDef *Gpio, uint16_t Pin)
{
  bool retVal = false;
  do
  {
    if ((Handle == NULL) || (HSpi == NULL) || (Gpio == NULL) || (Handle->Inited == 1))
    {
      dprintf("SPIF_Init() Error, Wrong Parameter\r\n");
      break;
    }
    memset(Handle, 0, sizeof(SPIF_HandleTypeDef));
    Handle->HSpi = HSpi;
    Handle->Gpio = Gpio;
    Handle->Pin = Pin;
    SPIF_CsPin(Handle, 1);
    /* wait for stable VCC */
    while (HAL_GetTick() < 20)
    {
      SPIF_Delay(1);
    }
    if (SPIF_WriteDisable(Handle) == false)
    {
      break;
    }
    retVal = SPIF_FindChip(Handle);
    if (retVal)
    {
      Handle->Inited = 1;
      dprintf("SPIF_Init() Done\r\n");
    }

  } while (0);

  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Full Erase chip.
  * @note   Send the Full-Erase-chip command and wait for completion
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  *
  * @retval bool: true or false
  */
bool SPIF_EraseChip(SPIF_HandleTypeDef *Handle)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint8_t tx[1] = {SPIF_CMD_CHIPERASE1};
  do
  {
#if SPIF_DEBUG != SPIF_DEBUG_DISABLE
    uint32_t dbgTime = HAL_GetTick();
#endif
    dprintf("SPIF_EraseChip() START\r\n");
    if (SPIF_WriteEnable(Handle) == false)
    {
      break;
    }
    SPIF_CsPin(Handle, 0);
    if (SPIF_Transmit(Handle, tx, 1, 100) == false)
    {
      SPIF_CsPin(Handle, 1);
      break;
    }
    SPIF_CsPin(Handle, 1);
    if (SPIF_WaitForWriting(Handle, Handle->BlockCnt * 1000))
    {
      dprintf("SPIF_EraseChip() DONE AFTER %ld ms\r\n", HAL_GetTick() - dbgTime);
      retVal = true;
    }

  } while (0);

  SPIF_WriteDisable(Handle);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Erase Sector.
  * @note   Send the Erase-Sector command and wait for completion
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  Sector: Selected Sector
  *
  * @retval bool: true or false
  */
bool SPIF_EraseSector(SPIF_HandleTypeDef *Handle, uint32_t Sector)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t address = Sector * SPIF_SECTOR_SIZE;
  uint8_t tx[5];
  do
  {
#if SPIF_DEBUG != SPIF_DEBUG_DISABLE
    uint32_t dbgTime = HAL_GetTick();
#endif
    dprintf("SPIF_EraseSector() START SECTOR %ld\r\n", Sector);
    if (Sector >= Handle->SectorCnt)
    {
      dprintf("SPIF_EraseSector() ERROR Sector NUMBER\r\n");
      break;
    }
    if (SPIF_WriteEnable(Handle) == false)
    {
      break;
    }
    SPIF_CsPin(Handle, 0);
    if (Handle->BlockCnt >= 512)
    {
      tx[0] = SPIF_CMD_SECTORERASE4ADD;
      tx[1] = (address & 0xFF000000) >> 24;
      tx[2] = (address & 0x00FF0000) >> 16;
      tx[3] = (address & 0x0000FF00) >> 8;
      tx[4] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 5, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    else
    {
      tx[0] = SPIF_CMD_SECTORERASE3ADD;
      tx[1] = (address & 0x00FF0000) >> 16;
      tx[2] = (address & 0x0000FF00) >> 8;
      tx[3] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 4, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    SPIF_CsPin(Handle, 1);
    if (SPIF_WaitForWriting(Handle, 1000))
    {
      dprintf("SPIF_EraseSector() DONE AFTER %ld ms\r\n", HAL_GetTick() - dbgTime);
      retVal = true;
    }

  } while (0);

  SPIF_WriteDisable(Handle);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Erase Block.
  * @note   Send the Erase-Block command and wait for completion
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  Sector: Selected Block
  *
  * @retval bool: true or false
  */
bool SPIF_EraseBlock(SPIF_HandleTypeDef *Handle, uint32_t Block)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t address = Block * SPIF_BLOCK_SIZE;
  uint8_t tx[5];
  do
  {
#if SPIF_DEBUG != SPIF_DEBUG_DISABLE
    uint32_t dbgTime = HAL_GetTick();
#endif
    dprintf("SPIF_EraseBlock() START PAGE %ld\r\n", Block);
    if (Block >= Handle->BlockCnt)
    {
      dprintf("SPIF_EraseBlock() ERROR Block NUMBER\r\n");
      break;
    }
    if (SPIF_WriteEnable(Handle) == false)
    {
      break;
    }
    SPIF_CsPin(Handle, 0);
    if (Handle->BlockCnt >= 512)
    {
      tx[0] = SPIF_CMD_BLOCKERASE4ADD;
      tx[1] = (address & 0xFF000000) >> 24;
      tx[2] = (address & 0x00FF0000) >> 16;
      tx[3] = (address & 0x0000FF00) >> 8;
      tx[4] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 5, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    else
    {
      tx[0] = SPIF_CMD_BLOCKERASE3ADD;
      tx[1] = (address & 0x00FF0000) >> 16;
      tx[2] = (address & 0x0000FF00) >> 8;
      tx[3] = (address & 0x000000FF);
      if (SPIF_Transmit(Handle, tx, 4, 100) == false)
      {
        SPIF_CsPin(Handle, 1);
        break;
      }
    }
    SPIF_CsPin(Handle, 1);
    if (SPIF_WaitForWriting(Handle, 3000))
    {
      dprintf("SPIF_EraseBlock() DONE AFTER %ld ms\r\n", HAL_GetTick() - dbgTime);
      retVal = true;
    }

  } while (0);

  SPIF_WriteDisable(Handle);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Write data array to an Address
  * @note   Write a data array with specified size.
  * @note   All pages should be erased before write
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  Address: Start Address
  * @param  *Data: Pointer to Data
  * @param  Size: The length of data should be written. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_WriteAddress(SPIF_HandleTypeDef *Handle, uint32_t Address, uint8_t *Data, uint32_t Size)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t page, add, offset, remaining, length, maximum, index = 0;
  add = Address;
  remaining = Size;
  do
  {
    page = SPIF_AddressToPage(add);
    offset = add % SPIF_PAGE_SIZE;
    maximum = SPIF_PAGE_SIZE - offset;
    if (remaining <= maximum)
    {
      length = remaining;
    }
    else
    {
      length = maximum;
    }
    if (SPIF_WriteFn(Handle, page, &Data[index], length, offset) == false)
    {
      break;
    }
    add += length;
    index += length;
    remaining -= length;
    if (remaining == 0)
    {
      retVal = true;
      break;
    }

  } while (remaining > 0);

  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Write data array to a Page
  * @note   Write a data array with specified size.
  * @note   The Page should be erased before write
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  PageNumber: Page Number
  * @param  *Data: Pointer to Data
  * @param  Size: The length of data should be written. (in byte)
  * @param  Offset: The start point for writing data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_WritePage(SPIF_HandleTypeDef *Handle, uint32_t PageNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  retVal = SPIF_WriteFn(Handle, PageNumber, Data, Size, Offset);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Write data array to a Sector
  * @note   Write a data array with specified size.
  * @note   The Sector should be erased before write
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  SectorNumber: Sector Number
  * @param  *Data: Pointer to Data
  * @param  Size: The length of data should be written. (in byte)
  * @param  Offset: The start point for writing data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_WriteSector(SPIF_HandleTypeDef *Handle, uint32_t SectorNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = true;
  do
  {
    if (Offset >= SPIF_SECTOR_SIZE)
    {
      retVal = false;
      break;
    }
    if (Size > (SPIF_SECTOR_SIZE - Offset))
    {
      Size = SPIF_SECTOR_SIZE - Offset;
    }
    uint32_t bytesWritten = 0;
    uint32_t pageNumber = SectorNumber * (SPIF_SECTOR_SIZE / SPIF_PAGE_SIZE);
    pageNumber += Offset / SPIF_PAGE_SIZE;
    uint32_t remainingBytes = Size;
    uint32_t pageOffset = Offset % SPIF_PAGE_SIZE;
    while (remainingBytes > 0 && pageNumber < ((SectorNumber + 1) * (SPIF_SECTOR_SIZE / SPIF_PAGE_SIZE)))
    {
      uint32_t bytesToWrite = (remainingBytes > (SPIF_PAGE_SIZE - pageOffset)) ? (SPIF_PAGE_SIZE - pageOffset) : remainingBytes;
      if (SPIF_WriteFn(Handle, pageNumber, Data + bytesWritten, bytesToWrite, pageOffset) == false)
      {
        retVal = false;
        break;
      }
      bytesWritten += bytesToWrite;
      remainingBytes -= bytesToWrite;
      pageNumber++;
      pageOffset = 0;
    }
  } while (0);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Write data array to a Block
  * @note   Write a data array with specified size.
  * @note   The Block should be erased before write
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  SectorNumber: Block Number
  * @param  *Data: Pointer to Data
  * @param  Size: The length of data should be written. (in byte)
  * @param  Offset: The start point for writing data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_WriteBlock(SPIF_HandleTypeDef *Handle, uint32_t BlockNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = true;
  do
  {
    if (Offset >= SPIF_BLOCK_SIZE)
    {
      retVal = false;
      break;
    }
    if (Size > (SPIF_BLOCK_SIZE - Offset))
    {
      Size = SPIF_BLOCK_SIZE - Offset;
    }
    uint32_t bytesWritten = 0;
    uint32_t pageNumber = BlockNumber * (SPIF_BLOCK_SIZE / SPIF_PAGE_SIZE);
    pageNumber += Offset / SPIF_PAGE_SIZE;
    uint32_t remainingBytes = Size;
    uint32_t pageOffset = Offset % SPIF_PAGE_SIZE;
    while (remainingBytes > 0 && pageNumber < ((BlockNumber + 1) * (SPIF_BLOCK_SIZE / SPIF_PAGE_SIZE)))
    {
      uint32_t bytesToWrite = (remainingBytes > (SPIF_PAGE_SIZE - pageOffset)) ? (SPIF_PAGE_SIZE - pageOffset) : remainingBytes;
      if (SPIF_WriteFn(Handle, pageNumber, Data + bytesWritten, bytesToWrite, pageOffset) == false)
      {
        retVal = false;
        break;
      }
      bytesWritten += bytesToWrite;
      remainingBytes -= bytesToWrite;
      pageNumber++;
      pageOffset = 0;
    }

  } while (0);

  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Read From Address
  * @note   Read data from memory and copy to array
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  Address: Start Address
  * @param  *Data: Pointer to Data (output)
  * @param  Size: The length of data should be written. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_ReadAddress(SPIF_HandleTypeDef *Handle, uint32_t Address, uint8_t *Data, uint32_t Size)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  retVal = SPIF_ReadFn(Handle, Address, Data, Size);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Read a Page
  * @note   Read a page and copy to array
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  PageNumber: Page Number
  * @param  *Data: Pointer to Data (output)
  * @param  Size: The length of data should be read. (in byte)
  * @param  Offset: The start point for Reading data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_ReadPage(SPIF_HandleTypeDef *Handle, uint32_t PageNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t address = SPIF_PageToAddress(PageNumber) + Offset;
  uint32_t maximum = SPIF_PAGE_SIZE - Offset;
  if (Size > maximum)
  {
    Size = maximum;
  }
  retVal = SPIF_ReadFn(Handle, address, Data, Size);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Read a Sector
  * @note   Read a Sector and copy to array
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  SectorNumber: Sector Number
  * @param  *Data: Pointer to Data (output)
  * @param  Size: The length of data should be read. (in byte)
  * @param  Offset: The start point for Reading data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_ReadSector(SPIF_HandleTypeDef *Handle, uint32_t SectorNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t address = SPIF_SectorToAddress(SectorNumber) + Offset;
  uint32_t maximum = SPIF_SECTOR_SIZE - Offset;
  if (Size > maximum)
  {
    Size = maximum;
  }
  retVal = SPIF_ReadFn(Handle, address, Data, Size);
  SPIF_UnLock(Handle);
  return retVal;
}

/***********************************************************************************************************/

/**
  * @brief  Read a Block
  * @note   Read a Block and copy to array
  *
  * @param  *Handle: Pointer to SPIF_HandleTypeDef structure
  * @param  BlockNumber: Block Number
  * @param  *Data: Pointer to Data (output)
  * @param  Size: The length of data should be read. (in byte)
  * @param  Offset: The start point for Reading data. (in byte)
  *
  * @retval bool: true or false
  */
bool SPIF_ReadBlock(SPIF_HandleTypeDef *Handle, uint32_t BlockNumber, uint8_t *Data, uint32_t Size, uint32_t Offset)
{
  SPIF_Lock(Handle);
  bool retVal = false;
  uint32_t address = SPIF_BlockToAddress(BlockNumber) + Offset;
  uint32_t maximum = SPIF_BLOCK_SIZE - Offset;
  if (Size > maximum)
  {
    Size = maximum;
  }
  retVal = SPIF_ReadFn(Handle, address, Data, Size);
  SPIF_UnLock(Handle);
  return retVal;
}