/*
 * Copyright 2020-2024 Yuntu Microelectronics co.,ltd
 * All rights reserved.
 *
 * YUNTU Confidential. This software is owned or controlled by YUNTU and may
 * only be used strictly in accordance with the applicable license terms. By expressly
 * accepting such terms or by downloading, installing, activating and/or otherwise
 * using the software, you are agreeing that you have read, and that you agree to
 * comply with and are bound by, such license terms. If you do not agree to be
 * bound by the applicable license terms, then you may not retain, install,
 * activate or otherwise use the software. The production use license in
 * Section 2.3 is expressly granted for this software.
 */
/*!
 * @file fls_drv_bin.h
 *
 */
#ifndef FLS_DRV_BIN_H
#define FLS_DRV_BIN_H

#include "stdint.h"
#include "status.h"

#define TEST_BY_ARRAY  /* Comment this line if download bin file to SRAM */

#ifdef TEST_BY_ARRAY
#include "fls_drv_bin_data.h"
#define FLS_DRV_BASE_ADDR ((uint32_t)bin_data)
#else
#define FLS_DRV_BASE_ADDR ((uint32_t)0x20000000)    /* Base address of the flash driver bin which download to SRAM */
#endif /* TEST_BY_ARRAY */

/*!
 * @brief Flash driver init function.
 */
typedef status_t (*FLASH_Init_t)(void);

/*!
 * @brief Flash driver deinit function.
 */
typedef status_t (*FLASH_Deinit_t)(void);

/*!
 * @brief Flash erase sector synchronously.
 */
typedef status_t (*FLASH_EraseSector_t)(uint32_t dest, uint32_t size);

/*!
 * @brief Flash program synchronously.
 */
typedef status_t (*FLASH_Program_t)(uint32_t dest, uint32_t size, const void * pData);

/*!
 * @brief Flash driver boot swap function.
 */
typedef status_t (*FLASH_BootSwap_t)(void);

/*!
 * @brief Flash driver erase block.
 */
typedef status_t (*FLASH_EraseBlock_t)(uint32_t dest);

/*!
 * @brief Flash driver erase NVR.
 */
typedef status_t (*FLASH_EraseNVR_t)(uint32_t dest);

/*!
 * @brief Flash driver program NVR.
 */
typedef status_t (*FLASH_ProgramNVR_t)(uint32_t dest, uint32_t size, const void *pData);

/*!
 * @brief Flash driver read NVR.
 */
typedef status_t (*FLASH_ReadNVR_t)(uint32_t address, uint32_t size, void *dest);

typedef struct{
    uint32_t version;
    FLASH_Init_t init;
    FLASH_Deinit_t deinit;
    FLASH_EraseSector_t eraseSector;
    FLASH_Program_t program;    
    FLASH_BootSwap_t bootSwap;   /* Optional by chip */
    FLASH_EraseBlock_t EraseBlock;
    FLASH_EraseNVR_t eraseNVR;
    FLASH_ProgramNVR_t programNVR;
    FLASH_ReadNVR_t readNVR;
}fls_drv_tbl_t;

/* FLASH driver API */
#define FLASH_DRV_GetVersion()                 ((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->version))

/* Init to enble the CMD_VERIFY_EN, which determines whether to do verify read after erase or program operation during executing a command.
 * It would be okay, if not call the FLASH_DRV_Init() function. */
#define FLASH_DRV_Init()                       ((FLASH_Init_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->init) + FLS_DRV_BASE_ADDR))()

/* Deinit do nothing, just return success. */
#define FLASH_DRV_Deinit()                     ((FLASH_Deinit_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->deinit) + FLS_DRV_BASE_ADDR))()

#define FLASH_DRV_EraseSector(dest, size)      ((FLASH_EraseSector_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->eraseSector) + FLS_DRV_BASE_ADDR))(dest, size)

#define FLASH_DRV_Program(dest, size, pData)   ((FLASH_Program_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->program) + FLS_DRV_BASE_ADDR))(dest, size, pData)

/* Not all chip suppoert bootswap */
#define FLASH_DRV_BootSwap()                   ((FLASH_BootSwap_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->bootSwap) + FLS_DRV_BASE_ADDR))()

#define FLASH_DRV_EraseBlock()                 ((FLASH_EraseBlock_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->EraseBlock) + FLS_DRV_BASE_ADDR))(dest)

#define FLASH_DRV_EraseNVR(dest)                   ((FLASH_EraseNVR_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->eraseNVR) + FLS_DRV_BASE_ADDR))(dest)

#define FLASH_DRV_ProgramNVR(dest, size, pData)((FLASH_ProgramNVR_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->programNVR) + FLS_DRV_BASE_ADDR))(dest, size, pData)

#define FLASH_DRV_ReadNVR(address, size, dest)   ((FLASH_ReadNVR_t)((uint32_t)(((fls_drv_tbl_t*)(FLS_DRV_BASE_ADDR))->readNVR) + FLS_DRV_BASE_ADDR))(address, size, dest)
#endif /* FLS_DRV_BIN_H */