/*   ==================================================================

     >>>>>>>>>>>>>>>>>>>>>>> COPYRIGHT NOTICE <<<<<<<<<<<<<<<<<<<<<<<<<
     ------------------------------------------------------------------
     Copyright (c) 2019-2023 by Lattice Semiconductor Corporation
     ALL RIGHTS RESERVED
     ------------------------------------------------------------------

       IMPORTANT: THIS FILE IS USED BY OR GENERATED BY the LATTICE PROPEL™
       DEVELOPMENT SUITE, WHICH INCLUDES PROPEL BUILDER AND PROPEL SDK.

       Lattice grants permission to use this code pursuant to the
       terms of the Lattice Propel License Agreement.

     DISCLAIMER:

    LATTICE MAKES NO WARRANTIES ON THIS FILE OR ITS CONTENTS,
    WHETHER EXPRESSED, IMPLIED, STATUTORY,
    OR IN ANY PROVISION OF THE LATTICE PROPEL LICENSE AGREEMENT OR
    COMMUNICATION WITH LICENSEE,
    AND LATTICE SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
    LATTICE DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED HEREIN WILL MEET
    LICENSEE 'S REQUIREMENTS, OR THAT LICENSEE' S OPERATION OF ANY DEVICE,
    SOFTWARE OR SYSTEM USING THIS FILE OR ITS CONTENTS WILL BE
    UNINTERRUPTED OR ERROR FREE,
    OR THAT DEFECTS HEREIN WILL BE CORRECTED.
    LICENSEE ASSUMES RESPONSIBILITY FOR SELECTION OF MATERIALS TO ACHIEVE
    ITS INTENDED RESULTS, AND FOR THE PROPER INSTALLATION, USE,
    AND RESULTS OBTAINED THEREFROM.
    LICENSEE ASSUMES THE ENTIRE RISK OF THE FILE AND ITS CONTENTS PROVING
    DEFECTIVE OR FAILING TO PERFORM PROPERLY AND IN SUCH EVENT,
    LICENSEE SHALL ASSUME THE ENTIRE COST AND RISK OF ANY REPAIR, SERVICE,
    CORRECTION,
    OR ANY OTHER LIABILITIES OR DAMAGES CAUSED BY OR ASSOCIATED WITH THE
    SOFTWARE.IN NO EVENT SHALL LATTICE BE LIABLE TO ANY PARTY FOR DIRECT,
    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
    INCLUDING LOST PROFITS,
    ARISING OUT OF THE USE OF THIS FILE OR ITS CONTENTS,
    EVEN IF LATTICE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
    LATTICE 'S SOLE LIABILITY, AND LICENSEE' S SOLE REMEDY,
    IS SET FORTH ABOVE.
    LATTICE DOES NOT WARRANT OR REPRESENT THAT THIS FILE,
    ITS CONTENTS OR USE THEREOF DOES NOT INFRINGE ON THIRD PARTIES'
    INTELLECTUAL PROPERTY RIGHTS, INCLUDING ANY PATENT. IT IS THE USER' S
    RESPONSIBILITY TO VERIFY THE USER SOFTWARE DESIGN FOR CONSISTENCY AND
    FUNCTIONALITY THROUGH THE USE OF FORMAL SOFTWARE VALIDATION METHODS.
     ------------------------------------------------------------------

     ================================================================== */


#ifndef IFC_H
#define IFC_H

#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>

#define Internal_Flash_Controller_Driver_Version "v1.0.0.0"

#define MAX_CFG_NUM 3
#define MAX_UFM_NUM 3
#define MAX_USERDATA_NUM 9
#define PAGE_SIZE 256
#define BLOCK_SIZE 0x10000
#define MIN_WORDS_NUM 4
#define MIN_AEMPTY_FLAG 1
#define MIN_USERDATA_NUM 0x06
#define MAX_USERDATA_NUM 0x0e


#define CFG_SIZE_1 0
#define CFG_SIZE_2 11
#define CFG_SIZE_3 1

#define UFM_SIZE_1 0
#define UFM_SIZE_2 4

#define MAX_CFG_UFM_SIZE 15
#define MAX_USERDATA_SIZE 18


struct ifc_instance {
	uint32_t base_addr;
	uint32_t trans_addr;
	uint32_t trans_partition;

	uint32_t cfg_size[MAX_CFG_NUM];//block size(0/11/15)
	uint32_t ufm_size[MAX_UFM_NUM];//block size(0/4) if cfg0 is set to 15 ,ufm0 is automaticallyset to 0
	uint32_t userdata_size[MAX_USERDATA_NUM];//if a partition is set to 0 the succeeding partitions cannot be used

	uint8_t  wr_fifo_depth;
	uint8_t  wr_fifo_aempty_flag;

	uint8_t status;
};

//err code
typedef enum {
  /* basic errors */
	SUCCESS    	         = 0,  /**< No error condition. */
	PTR_ERROR     	     = 1,  /**<  PTR is NULL. */

  /* Boundary Check Errors */
	CFG_ERROR 	         = 2,  /**< CFG initialization boundary error. */
	UFM_ERROR   			 = 3,  /**< UFM initialization boundary error. */
	USERDATA_ERROR		 = 4,  /**< USERDATA initialization boundary error. */
	CFG_UFM_ERROR			 = 5,  /**< UFM+CFG initialization boundary error. */
	CFG_ACCESS_FAILED		 = 6,  /**< CFG access out of bounds. */
	UFM_ACCESS_FAILED		 = 7,  /**< UFM access out of bounds. */
	USERDATA_ACCESS_FAILED = 8,   /**< USERDATA access out of bounds. */
	STATUS_ERROR = 9,	/**<IFC INSTANCE is not ready for operation.*/
	PAGE_WRITE_ERROR = 10,	/**<Number of bytes for page write are too many.*/
	PAGE_READ_ERROR = 11,   /**<Number of bytes for page read are too many.*/
	PAGE_NUM_ERROR = 12,    /**<page access out of bounds.  */
	FIFO_ERROR = 13     /**<FIFO setting error  */
} IFC_ErrorCode;


//REG

#define UFM_CTRL_REG		0x00

#define TRANSACTION_ADDR	(0x04*4)
	#define CFG0 0x00
	#define UFM0 0x01
	#define CFG1 0x02
	#define UFM1 0x03
	#define CFG2 0x04
	#define UFM2 0x05
	#define USERDATA0 0x06
	#define USERDATA1 0x07
	#define USERDATA2 0x08
	#define USERDATA3 0x09
	#define USERDATA4 0x0A
	#define USERDATA5 0x0B
	#define USERDATA6 0x0C
	#define USERDATA7 0x0D
	#define USERDATA8 0x0E

#define WR_FIFO_DATA		(0x08*4)
#define RD_FIFO_DATA		(0x0c*4)
#define TRANSACTION_CTRL    (0x10*4)
#define START_TRANSACTION 0x80000000
#define READ_ACCESS 0x01
#define WRITE_ACCESS 0x00
#define ERASE_ACCESS 0x10

#define FIFO_STATUS			(0x14*4)
	#define RD_FIFO_EMPTY 0x01
	#define RD_FIFO_AEMPTY 0x02
	#define RD_FIFO_AFULL 0x04
	#define RD_FIFO_FULL 0x08
	#define WR_FIFO_EMPTY 0x10
	#define WR_FIFO_AEMPTY 0x20
	#define WR_FIFO_AFULL 0x40
	#define WR_FIFO_FULL 0x80
	#define TRANS_DONE 0x80000000
#define INT_STATUS 			(0x1c*4)
#define INT_ENABLE          (0x20*4)

#define FIFO_CTRL 			(0x18*4)
	#define RD_FIFO_FLUSH 0x01
	#define WR_FIFO_FLUSH 0x02

typedef enum
{
	FIFO_DEPTH_4=4,
	FIFO_DEPTH_8=8,
	FIFO_DEPTH_16=16,
	FIFO_DEPTH_32=32,
	FIFO_DEPTH_64=64
}IFC_FIFO_DEPTH;

enum{
	IFC_IDLE=0,
	IFC_BUSY,
	IFC_READY,
	IFC_ERROR,
	IFC_WRITE,
	IFC_READ
};

//API LIST

/*************************************************************************/
//internal flash controller related api

/* initialize the internal flash controller ip
 *
 * this_ifc :  		  	pointer to the ifc instance
 * base_address: 	  	base address of the ifc instance
 * memory_map:		  	memory settings of the bulider input,the order of the array data is cfg0 ufm0
 * 					  	cfg1 ufm1 cfg2 ufm2 userdata0 userdata1...userdata8
 * fifo_depth          	fifo depth value.
 * wr_fifo_aempty_flag   write fifo almost empty flag value
 */
uint8_t ifc_init(struct ifc_instance *this_ifc, uint32_t base_address, uint32_t *memory_map ,IFC_FIFO_DEPTH fifo_depth ,uint8_t wr_fifo_aempty_flag);

/* config the ifc , flushes the FIFOs and restores all registers to their default settings
 *
 * this_ifc :  		pointer to the ifc instance
 *
 */
uint8_t ifc_config(struct ifc_instance *this_ifc,uint8_t int_enable);


/* interrupt service routine of the internal flash controller
 *
 * this_ifc :  		pointer to the ifc instance
 *
 */
void ifc_isr(struct ifc_instance *this_ifc);


/* Write data to a page of CFG
 *
 * this_ifc :  		pointer to the ifc instance
 * cfg_num: 		which cfg to be written
 * wr_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be written
 *
 */
uint8_t ifc_cfg_page_write(struct ifc_instance *this_ifc, uint8_t cfg_num, uint32_t *wr_buf, uint32_t length, uint32_t page);


/* Read data from a page of CFG
 *
 * this_ifc :  		pointer to the ifc instance
 * cfg_num: 		which cfg to be read
 * rd_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be read
 *
 */
uint8_t ifc_cfg_page_read(struct ifc_instance *this_ifc, uint8_t cfg_num, uint32_t *rd_buf, uint32_t length, uint32_t page);


/* Erase the data of a block
 *
 * this_ifc :  		pointer to the ifc instance
 * cfg_num: 		which cfg to be erased
 * block: 			which blocks to be erased
 *
 */
uint8_t ifc_cfg_block_erase(struct ifc_instance *this_ifc, uint8_t cfg_num, uint32_t block);


/* Write data to a page of UFM
 *
 * this_ifc :  		pointer to the ifc instance
 * ufm_num: 		which ufm to be written
 * wr_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be written
 *
 */
uint8_t ifc_ufm_page_write(struct ifc_instance *this_ifc, uint8_t ufm_num, uint32_t *wr_buf, uint32_t length, uint32_t page);


/* Read data from a page of UFM
 *
 * this_ifc :  		pointer to the ifc instance
 * ufm_num: 		which ufm to be read
 * wr_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be read
 *
 */
uint8_t ifc_ufm_page_read(struct ifc_instance *this_ifc, uint8_t ufm_num, uint32_t *rd_buf, uint32_t length, uint32_t page);


/* Erase the data of a block
 *
 * this_ifc :  		pointer to the ifc instance
 * ufm_num: 		which ufm to be erased
 * block: 			which blocks to be erased
 *
 */
uint8_t ifc_ufm_block_erase(struct ifc_instance *this_ifc, uint8_t ufm_num, uint32_t block);


/* Write data to a page of USERDATA
 *
 * this_ifc :  		pointer to the ifc instance
 * usr_num:		 	which userdata to be written
 * wr_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be written
 *
 */
uint8_t ifc_userdata_page_write(struct ifc_instance *this_ifc, uint8_t userdata_num, uint32_t *wr_buf, uint32_t length, uint32_t page);


/* Read data from a page of USERDATA
 *
 * this_ifc :  		pointer to the ifc instance
 * usr_num: 		which userdata to be read
 * wr_buf:			pointer to data buffer
 * length:			the length of data
 * page: 			which pages to be read
 *
 */
uint8_t ifc_userdata_page_read(struct ifc_instance *this_ifc, uint8_t userdata_num, uint32_t *rd_buf, uint32_t length, uint32_t page);


/* Erase the data of a block
 *
 * this_ifc :  		pointer to the ifc instance
 * usr_num: 		which uesrdata to be erased
 * block: 			which blocks to be erased
 *
 */
uint8_t ifc_userdata_block_erase(struct ifc_instance *this_ifc, uint8_t userdata_num, uint32_t block);


#endif