touch/ftm5/fts_lib/ftsFlash.h

/*
  *
  **************************************************************************
  **                        STMicroelectronics                            **
  **************************************************************************
  **                        marco.cali@st.com                             **
  **************************************************************************
  *                                                                        *
  *                       FTS API for Flashing the IC                      *
  *                                                                        *
  **************************************************************************
  **************************************************************************
  *
  */

/*!
  * \file ftsFlash.h
  * \brief Contains all the definitions and structs to handle the FW update
  *process
  */

#ifndef FTS_FLASH_H
#define FTS_FLASH_H

#include "ftsSoftware.h"

/* Flash possible status */
#define FLASH_READY		0	/* /< value to indicate that the flash
					 * is ready */
#define FLASH_BUSY		1	/* /< value to indicate that the flash
					 * is busy */
#define FLASH_UNKNOWN		-1	/* /< value to indicate an unknown
					 * status of the flash */

#define FLASH_STATUS_BYTES	1	/* /< number of bytes to check for read
					 * the flash status */



/* Flash timing parameters */
#define FLASH_RETRY_COUNT	200	/* /< number of attempts to read the
					 * flash status */
#define FLASH_WAIT_BEFORE_RETRY 50	/* /< time to wait in ms between status
					 * readings */


#ifdef FW_H_FILE
#define PATH_FILE_FW		"NULL"
#else
#define PATH_FILE_FW		"ftm5_fw.ftb"	/* new FW bin file name */
#endif

#ifdef ALIX
#define FLASH_CHUNK		(32 * 1024)	/* /< Max number of bytes that
						 * the
						  * DMA can burn on flash in
						  *one shot in FTI */
#else
#define FLASH_CHUNK		(64 * 1024)	/* /< Max number of bytes that
						 * the
						  * DMA can burn on flash in
						  *one shot in FTI */
#endif

#define DMA_CHUNK		32	/* /< Max number of bytes that can be
					 * written in I2C to the DMA */

#define FLASH_ORG_INFO_INDEX	280

#define FLASH_PAGE_SIZE		(4 * 1024) //page size of 4KB

/**
  * Define which kind of erase page by page should be performed
  */
typedef enum {
	ERASE_ALL		= 0,	/* /< erase all the pages */
	SKIP_PANEL_INIT		= 1,	/* /< skip erase Panel Init Pages */
	SKIP_PANEL_CX_INIT	= 2 /* /< skip erase Panel Init and CX Pages */
} ErasePage;

/** @addtogroup fw_file
  * @{
  */

/**
  * Struct which contains information and data of the FW that should be burnt
  *into the IC
  */
typedef struct {
	u8 *data;	/* /< pointer to an array of bytes which represent the
			 * FW data */
	u16 fw_ver;	/* /< FW version of the FW file */
	u16 config_ver;	/* Config version of the FW file */
	u16 cx_ver;	/* /< Cx version of the FW file */
	u8 cfg_afe_ver;	/* /< Cx afe version of the FW file */
	u8 cx_afe_ver;	/* /< Cfg afe version of the FW file */
	u8 externalRelease[EXTERNAL_RELEASE_INFO_SIZE];	/* /< External Release
							 * Info of the FW file
							 * */
	int data_size;	/* /< dimension of data (the actual data to be burnt) */
	u32 sec0_size;	/* /< dimension of section 0 (FW) in .ftb file */
	u32 sec1_size;	/* /< dimension of section 1 (Config) in .ftb file */
	u32 sec2_size;	/* /< dimension of section 2 (Cx) in .ftb file */
	u32 sec3_size;	/* /< dimension of section 3 (TBD) in .ftb file */
	u8 fw_code_size; /* /< size of fw code in pages in
			.ftb file */
	u8 panel_config_size;/* /< size of panel area in pages in
			.ftb file */
	u8 cx_area_size;/* /< size of cx area in pages in
			 .ftb file */
	u8 fw_config_size;/* /< size of fw config in pages in
			.ftb file */
	u32 code_start_addr;  /* start addr for fw code */
	u32 cx_start_addr; /* start addr for cx area */
	u32 config_start_addr; /* start addr for config area */
} Firmware;

/** @}*/

/** @addtogroup flash_command
  * @{
  */

int wait_for_flash_ready(struct fts_ts_info *info, u8 type);
int hold_m3(struct fts_ts_info *info);
int flash_erase_unlock(struct fts_ts_info *info);
int flash_full_erase(struct fts_ts_info *info);
int flash_erase_page_by_page(struct fts_ts_info *info, ErasePage keep_cx,
			     Firmware *fw);
int start_flash_dma(struct fts_ts_info *info);
int fillFlash(struct fts_ts_info *info, u32 address, u8 *data, int size);

int flash_unlock(struct fts_ts_info *info);
int getFWdata(struct fts_ts_info *info, const char *pathToFile, u8 **data,
	      int *size);
int parseBinFile(struct fts_ts_info *info, u8 *fw_data, int fw_size,
		 Firmware *fw, int keep_cx);
int readFwFile(struct fts_ts_info *info, const char *path, Firmware *fw,
	       int keep_cx);
int flash_burn(struct fts_ts_info *info, Firmware fw, int force_burn,
	       int keep_cx);
int flashProcedure(struct fts_ts_info *info, const char *path, int force,
		   int keep_cx);
int flash_enable_uvlo_autopowerdown(struct fts_ts_info *info);

#endif

/** @}*/