kernel_samsung_a34x-permissive/drivers/input/touchscreen/FT3518/focaltech_flash.c

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2016 MediaTek Inc.
 */

#include "focaltech_flash.h"
#include "focaltech_core.h"

/*****************************************************************************
 * Static variables
 *****************************************************************************/
#define FTS_FW_REQUEST_SUPPORT 1
/* Example: focaltech_ts_fw_tianma.bin */
#define FTS_FW_NAME_PREX_WITH_REQUEST "focaltech_ts_fw_"

/*****************************************************************************
 * Global variable or extern global variabls/functions
 *****************************************************************************/
u8 fw_file[] = {
	0
};

u8 fw_file2[] = {
	0
};

u8 fw_file3[] = {
	0
};

struct upgrade_module module_list[] = {
	{FTS_MODULE_ID, FTS_MODULE_NAME, fw_file, sizeof(fw_file)},
	{FTS_MODULE2_ID, FTS_MODULE2_NAME, fw_file2, sizeof(fw_file2)},
	{FTS_MODULE3_ID, FTS_MODULE3_NAME, fw_file3, sizeof(fw_file3)},
};

struct upgrade_func *upgrade_func_list[] = {
	0
//&upgrade_func_ft5452,
};

struct fts_upgrade *fwupgrade;

/*****************************************************************************
 * Static function prototypes
 *****************************************************************************/
static bool fts_fwupg_check_state(struct fts_upgrade *upg,
				  enum FW_STATUS rstate);

/************************************************************************
 * Name: fts_fwupg_get_boot_state
 * Brief: read boot id(rom/pram/bootloader), confirm boot environment
 * Input:
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
static int fts_fwupg_get_boot_state(struct fts_upgrade *upg,
				    enum FW_STATUS *fw_sts)
{
	int ret = 0;
	u8 cmd[4] = {0};
	u32 cmd_len = 0;
	u8 val[2] = {0};
	struct ft_chip_t *ids = NULL;

	FTS_INFO("**********read boot id**********");
	if ((!upg) || (!upg->func) || (!upg->ts_data) || (!fw_sts)) {
		FTS_ERROR("upg/func/ts_data/fw_sts is null");
		return -EINVAL;
	}

	if (upg->func->hid_supported)
		fts_hid2std();

	cmd[0] = FTS_CMD_START1;
	cmd[1] = FTS_CMD_START2;
	ret = fts_write(cmd, 2);
	if (ret < 0) {
		FTS_ERROR("write 55 aa cmd fail");
		return ret;
	}

	msleep(FTS_CMD_START_DELAY);
	cmd[0] = FTS_CMD_READ_ID;
	cmd[1] = cmd[2] = cmd[3] = 0x00;
	if (fts_data->ic_info.is_incell)
		cmd_len = FTS_CMD_READ_ID_LEN_INCELL;
	else
		cmd_len = FTS_CMD_READ_ID_LEN;
	ret = fts_read(cmd, cmd_len, val, 2);
	if (ret < 0) {
		FTS_ERROR("write 90 cmd fail");
		return ret;
	}
	FTS_INFO("read boot id:0x%02x%02x", val[0], val[1]);

	ids = &upg->ts_data->ic_info.ids;
	if ((val[0] == ids->rom_idh) && (val[1] == ids->rom_idl)) {
		FTS_INFO("tp run in romboot");
		*fw_sts = FTS_RUN_IN_ROM;
	} else if ((val[0] == ids->pb_idh) && (val[1] == ids->pb_idl)) {
		FTS_INFO("tp run in pramboot");
		*fw_sts = FTS_RUN_IN_PRAM;
	} else if ((val[0] == ids->bl_idh) && (val[1] == ids->bl_idl)) {
		FTS_INFO("tp run in bootloader");
		*fw_sts = FTS_RUN_IN_BOOTLOADER;
	}

	return 0;
}

static int fts_fwupg_reset_to_boot(struct fts_upgrade *upg)
{
	int ret = 0;
	u8 reg = FTS_REG_UPGRADE;

	FTS_INFO("send 0xAA and 0x55 to FW, reset to boot environment");
	if (upg && upg->func && upg->func->is_reset_register_BC)
		reg = FTS_REG_UPGRADE2;


	ret = fts_write_reg(reg, FTS_UPGRADE_AA);
	if (ret < 0) {
		FTS_ERROR("write FC=0xAA fail");
		return ret;
	}
	msleep(FTS_DELAY_UPGRADE_AA);

	ret = fts_write_reg(reg, FTS_UPGRADE_55);
	if (ret < 0) {
		FTS_ERROR("write FC=0x55 fail");
		return ret;
	}

	msleep(FTS_DELAY_UPGRADE_RESET);
	return 0;
}

/************************************************************************
 * Name: fts_fwupg_reset_to_romboot
 * Brief: reset to romboot, to load pramboot
 * Input:
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
static int fts_fwupg_reset_to_romboot(struct fts_upgrade *upg)
{
	int ret = 0;
	int i = 0;
	u8 cmd = FTS_CMD_RESET;
	enum FW_STATUS state = FTS_RUN_IN_ERROR;

	ret = fts_write(&cmd, 1);
	if (ret < 0) {
		FTS_ERROR("pram/rom/bootloader reset cmd write fail");
		return ret;
	}
	mdelay(10);

	for (i = 0; i < FTS_UPGRADE_LOOP; i++) {
		ret = fts_fwupg_get_boot_state(upg, &state);
		if (state == FTS_RUN_IN_ROM)
			break;
		mdelay(5);
	}
	if (i >= FTS_UPGRADE_LOOP) {
		FTS_ERROR("reset to romboot fail");
		return -EIO;
	}

	return 0;
}

u16 fts_crc16_calc_host(u8 *pbuf, u16 length)
{
	u16 ecc = 0;
	u16 i = 0;
	u16 j = 0;

	for (i = 0; i < length; i += 2) {
		ecc ^= ((pbuf[i] << 8) | (pbuf[i + 1]));
		for (j = 0; j < 16; j++) {
			if (ecc & 0x01)
				ecc = (u16)((ecc >> 1) ^ AL2_FCS_COEF);
			else
				ecc >>= 1;
		}
	}

	return ecc;
}

static u16 fts_pram_ecc_calc_host(u8 *pbuf, u16 length)
{
	return fts_crc16_calc_host(pbuf, length);
}

static int fts_pram_ecc_cal_algo(struct fts_upgrade *upg, u32 start_addr,
				 u32 ecc_length)
{
	int ret = 0;
	int i = 0;
	int ecc = 0;
	u8 val[2] = {0};
	u8 tmp = 0;
	u8 cmd[FTS_ROMBOOT_CMD_ECC_NEW_LEN] = {0};

	FTS_INFO("read out pramboot checksum");
	if ((!upg) || (!upg->func)) {
		FTS_ERROR("upg/func is null");
		return -EINVAL;
	}

	cmd[0] = FTS_ROMBOOT_CMD_ECC;
	cmd[1] = BYTE_OFF_16(start_addr);
	cmd[2] = BYTE_OFF_8(start_addr);
	cmd[3] = BYTE_OFF_0(start_addr);
	cmd[4] = BYTE_OFF_16(ecc_length);
	cmd[5] = BYTE_OFF_8(ecc_length);
	cmd[6] = BYTE_OFF_0(ecc_length);
	ret = fts_write(cmd, FTS_ROMBOOT_CMD_ECC_NEW_LEN);
	if (ret < 0) {
		FTS_ERROR("write pramboot ecc cal cmd fail");
		return ret;
	}

	cmd[0] = FTS_ROMBOOT_CMD_ECC_FINISH;
	for (i = 0; i < FTS_ECC_FINISH_TIMEOUT; i++) {
		msleep(1);
		ret = fts_read(cmd, 1, val, 1);
		if (ret < 0) {
			FTS_ERROR("ecc_finish read cmd fail");
			return ret;
		}
		if (upg->func->new_return_value_from_ic)
			tmp = FTS_ROMBOOT_CMD_ECC_FINISH_OK_A5;
		else
			tmp = FTS_ROMBOOT_CMD_ECC_FINISH_OK_00;

		if (tmp == val[0])
			break;
	}
	if (i >= 100) {
		FTS_ERROR("wait ecc finish fail");
		return -EIO;
	}

	cmd[0] = FTS_ROMBOOT_CMD_ECC_READ;
	ret = fts_read(cmd, 1, val, 2);
	if (ret < 0) {
		FTS_ERROR("read pramboot ecc fail");
		return ret;
	}

	ecc = ((u16)(val[0] << 8) + val[1]) & 0x0000FFFF;
	return ecc;
}

static int fts_pram_ecc_cal_xor(void)
{
	int ret = 0;
	u8 reg_val = 0;

	FTS_INFO("read out pramboot checksum");

	ret = fts_read_reg(FTS_ROMBOOT_CMD_ECC, &reg_val);
	if (ret < 0) {
		FTS_ERROR("read pramboot ecc fail");
		return ret;
	}

	return (int)reg_val;
}

static int fts_pram_ecc_cal(struct fts_upgrade *upg, u32 saddr, u32 len)
{
	if ((!upg) || (!upg->func)) {
		FTS_ERROR("upg/func is null");
		return -EINVAL;
	}

	if (upg->func->pram_ecc_check_mode == ECC_CHECK_MODE_CRC16)
		return fts_pram_ecc_cal_algo(upg, saddr, len);
	else
		return fts_pram_ecc_cal_xor();

}

static int fts_pram_write_buf(struct fts_upgrade *upg, u8 *buf, u32 len)
{
	int ret = 0;
	u32 i = 0;
	u32 j = 0;
	u32 offset = 0;
	u32 remainder = 0;
	u32 packet_number;
	u32 packet_len = 0;
	u8 packet_buf[FTS_FLASH_PACKET_LENGTH + FTS_CMD_WRITE_LEN] = {0};
	u8 ecc_tmp = 0;
	int ecc_in_host = 0;

	FTS_INFO("write pramboot to pram");
	if ((!upg) || (!upg->func) || !buf) {
		FTS_ERROR("upg/func/buf is null");
		return -EINVAL;
	}

	FTS_INFO("pramboot len=%d", len);
	if ((len < PRAMBOOT_MIN_SIZE) || (len > PRAMBOOT_MAX_SIZE)) {
		FTS_ERROR("pramboot length(%d) fail", len);
		return -EINVAL;
	}

	packet_number = len / FTS_FLASH_PACKET_LENGTH;
	remainder = len % FTS_FLASH_PACKET_LENGTH;
	if (remainder > 0)
		packet_number++;
	packet_len = FTS_FLASH_PACKET_LENGTH;

	packet_buf[0] = FTS_ROMBOOT_CMD_WRITE;
	for (i = 0; i < packet_number; i++) {
		offset = i * FTS_FLASH_PACKET_LENGTH;
		packet_buf[1] = BYTE_OFF_16(offset);
		packet_buf[2] = BYTE_OFF_8(offset);
		packet_buf[3] = BYTE_OFF_0(offset);

		/* last packet */
		if ((i == (packet_number - 1)) && remainder)
			packet_len = remainder;

		packet_buf[4] = BYTE_OFF_8(packet_len);
		packet_buf[5] = BYTE_OFF_0(packet_len);

		for (j = 0; j < packet_len; j++) {
			packet_buf[FTS_CMD_WRITE_LEN + j] = buf[offset + j];
			if (ECC_CHECK_MODE_XOR ==
			    upg->func->pram_ecc_check_mode) {
				ecc_tmp ^= packet_buf[FTS_CMD_WRITE_LEN + j];
			}
		}

		ret = fts_write(packet_buf, packet_len + FTS_CMD_WRITE_LEN);
		if (ret < 0) {
			FTS_ERROR("pramboot write data(%d) fail", i);
			return ret;
		}
	}

	if (upg->func->pram_ecc_check_mode == ECC_CHECK_MODE_CRC16)
		ecc_in_host = (int)fts_pram_ecc_calc_host(buf, len);
	else
		ecc_in_host = (int)ecc_tmp;


	return ecc_in_host;
}

static int fts_pram_start(void)
{
	u8 cmd = FTS_ROMBOOT_CMD_START_APP;
	int ret = 0;

	FTS_INFO("remap to start pramboot");

	ret = fts_write(&cmd, 1);
	if (ret < 0) {
		FTS_ERROR("write start pram cmd fail");
		return ret;
	}
	msleep(FTS_DELAY_PRAMBOOT_START);

	return 0;
}

static int fts_pram_write_remap(struct fts_upgrade *upg)
{
	int ret = 0;
	int ecc_in_host = 0;
	int ecc_in_tp = 0;
	u8 *pb_buf = NULL;
	u32 pb_len = 0;

	FTS_INFO("write pram and remap");
	if (!upg || !upg->func || !upg->func->pramboot) {
		FTS_ERROR("upg/func/pramboot is null");
		return -EINVAL;
	}

	if (upg->func->pb_length < FTS_MIN_LEN) {
		FTS_ERROR("pramboot length(%d) fail", upg->func->pb_length);
		return -EINVAL;
	}

	pb_buf = upg->func->pramboot;
	pb_len = upg->func->pb_length;

	/* write pramboot to pram */
	ecc_in_host = fts_pram_write_buf(upg, pb_buf, pb_len);
	if (ecc_in_host < 0) {
		FTS_ERROR("write pramboot fail");
		return ecc_in_host;
	}

	/* read out checksum */
	ecc_in_tp = fts_pram_ecc_cal(upg, 0, pb_len);
	if (ecc_in_tp < 0) {
		FTS_ERROR("read pramboot ecc fail");
		return ecc_in_tp;
	}

	FTS_INFO("pram ecc in tp:%x, host:%x", ecc_in_tp, ecc_in_host);
	/*  pramboot checksum != fw checksum, upgrade fail */
	if (ecc_in_host != ecc_in_tp) {
		FTS_ERROR("pramboot ecc check fail");
		return -EIO;
	}

	/*start pram*/
	ret = fts_pram_start();
	if (ret < 0) {
		FTS_ERROR("pram start fail");
		return ret;
	}

	return 0;
}

static int fts_pram_init(void)
{
	int ret = 0;
	u8 reg_val = 0;
	u8 wbuf[3] = {0};

	FTS_INFO("pramboot initialization");

	/* read flash ID */
	wbuf[0] = FTS_CMD_FLASH_TYPE;
	ret = fts_read(wbuf, 1, &reg_val, 1);
	if (ret < 0) {
		FTS_ERROR("read flash type fail");
		return ret;
	}

	/* set flash clk */
	wbuf[0] = FTS_CMD_FLASH_TYPE;
	wbuf[1] = reg_val;
	wbuf[2] = 0x00;
	ret = fts_write(wbuf, 3);
	if (ret < 0) {
		FTS_ERROR("write flash type fail");
		return ret;
	}

	return 0;
}

static int fts_pram_write_init(struct fts_upgrade *upg)
{
	int ret = 0;
	bool state = 0;
	enum FW_STATUS status = FTS_RUN_IN_ERROR;

	FTS_INFO("**********pram write and init**********");
	if ((upg == NULL) || (upg->func == NULL)) {
		FTS_ERROR("upgrade/func is null");
		return -EINVAL;
	}

	if (!upg->func->pramboot_supported) {
		FTS_ERROR("ic not support pram");
		return -EINVAL;
	}

	FTS_DEBUG("check whether tp is in romboot or not ");
	/* need reset to romboot when non-romboot state */
	ret = fts_fwupg_get_boot_state(upg, &status);
	if (status != FTS_RUN_IN_ROM) {
		if (status == FTS_RUN_IN_PRAM) {
			FTS_INFO(
				"tp is in pramboot, need send reset cmd before upgrade");
			ret = fts_pram_init();
			if (ret < 0) {
				FTS_ERROR("pramboot(before) init fail");
				return ret;
			}
		}

		FTS_INFO("tp isn't in romboot, need send reset to romboot");
		ret = fts_fwupg_reset_to_romboot(upg);
		if (ret < 0) {
			FTS_ERROR("reset to romboot fail");
			return ret;
		}
	}

	/* check the length of the pramboot */
	ret = fts_pram_write_remap(upg);
	if (ret < 0) {
		FTS_ERROR("pram write fail, ret=%d", ret);
		return ret;
	}

	FTS_DEBUG("after write pramboot, confirm run in pramboot");
	state = fts_fwupg_check_state(upg, FTS_RUN_IN_PRAM);
	if (!state) {
		FTS_ERROR("not in pramboot");
		return -EIO;
	}

	ret = fts_pram_init();
	if (ret < 0) {
		FTS_ERROR("pramboot init fail");
		return ret;
	}

	return 0;
}

static bool fts_fwupg_check_fw_valid(void)
{
	int ret = 0;

	ret = fts_wait_tp_to_valid();
	if (ret < 0) {
		FTS_INFO("tp fw invaild");
		return false;
	}

	FTS_INFO("tp fw valid");
	return true;
}

/************************************************************************
 * Name: fts_fwupg_check_state
 * Brief: confirm tp run in which mode: romboot/pramboot/bootloader
 * Input:
 * Output:
 * Return: return true if state is match, otherwise return false
 ***********************************************************************/
static bool fts_fwupg_check_state(struct fts_upgrade *upg,
				  enum FW_STATUS rstate)
{
	int ret = 0;
	int i = 0;
	enum FW_STATUS cstate = FTS_RUN_IN_ERROR;

	for (i = 0; i < FTS_UPGRADE_LOOP; i++) {
		ret = fts_fwupg_get_boot_state(upg, &cstate);
		/* FTS_DEBUG("fw state=%d, retries=%d", cstate, i); */
		if (cstate == rstate)
			return true;
		msleep(FTS_DELAY_READ_ID);
	}

	return false;
}

/************************************************************************
 * Name: fts_fwupg_reset_in_boot
 * Brief: RST CMD(07), reset to romboot(bootloader) in boot environment
 * Input:
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
int fts_fwupg_reset_in_boot(void)
{
	int ret = 0;
	u8 cmd = FTS_CMD_RESET;

	FTS_INFO("reset in boot environment");
	ret = fts_write(&cmd, 1);
	if (ret < 0) {
		FTS_ERROR("pram/rom/bootloader reset cmd write fail");
		return ret;
	}

	msleep(FTS_DELAY_UPGRADE_RESET);
	return 0;
}

/************************************************************************
 * Name: fts_fwupg_enter_into_boot
 * Brief: enter into boot environment, ready for upgrade
 * Input:
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
int fts_fwupg_enter_into_boot(void)
{
	int ret = 0;
	bool fwvalid = false;
	bool state = false;
	struct fts_upgrade *upg = fwupgrade;

	FTS_INFO("***********enter into pramboot/bootloader***********");
	if ((!upg) || (upg->func == NULL)) {
		FTS_ERROR("upgrade/func is null");
		return -EINVAL;
	}

	fwvalid = fts_fwupg_check_fw_valid();
	if (fwvalid) {
		ret = fts_fwupg_reset_to_boot(upg);
		if (ret < 0) {
			FTS_ERROR("enter into romboot/bootloader fail");
			return ret;
		}
	} else if (upg->func->read_boot_id_need_reset) {
		ret = fts_fwupg_reset_in_boot();
		if (ret < 0) {
			FTS_ERROR(
				"reset before read boot id when fw invalid fail");
			return ret;
		}
	}

	if (upg->func->pramboot_supported) {
		FTS_INFO("pram supported, write pramboot and init");
		/* pramboot */
		ret = fts_pram_write_init(upg);
		if (ret < 0) {
			FTS_ERROR("pram write_init fail");
			return ret;
		}
	} else {
		FTS_DEBUG("pram not supported, confirm in bootloader");
		/* bootloader */
		state = fts_fwupg_check_state(upg, FTS_RUN_IN_BOOTLOADER);
		if (!state) {
			FTS_ERROR("fw not in bootloader, fail");
			return -EIO;
		}
	}

	return 0;
}

/************************************************************************
 * Name: fts_fwupg_check_flash_status
 * Brief: read status from tp
 * Input: flash_status: correct value from tp
 *        retries: read retry times
 *        retries_delay: retry delay
 * Output:
 * Return: return true if flash status check pass, otherwise return false
 **********************************************************************/
static bool fts_fwupg_check_flash_status(u16 flash_status, int retries,
					 int retries_delay)
{
	int ret = 0;
	int i = 0;
	u8 cmd = 0;
	u8 val[FTS_CMD_FLASH_STATUS_LEN] = {0};
	u16 read_status = 0;

	for (i = 0; i < retries; i++) {
		cmd = FTS_CMD_FLASH_STATUS;
		ret = fts_read(&cmd, 1, val, FTS_CMD_FLASH_STATUS_LEN);
		read_status = (((u16)val[0]) << 8) + val[1];
		if (flash_status == read_status) {
			/* FTS_DEBUG("[UPGRADE]flash status ok"); */
			return true;
		}


		msleep(retries_delay);
	}

	return false;
}

/************************************************************************
 * Name: fts_fwupg_erase
 * Brief: erase flash area
 * Input: delay - delay after erase
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
int fts_fwupg_erase(u32 delay)
{
	int ret = 0;
	u8 cmd = 0;
	bool flag = false;

	FTS_INFO("**********erase now**********");

	/*send to erase flash*/
	cmd = FTS_CMD_ERASE_APP;
	ret = fts_write(&cmd, 1);
	if (ret < 0) {
		FTS_ERROR("erase cmd fail");
		return ret;
	}
	msleep(delay);

	/* read status 0xF0AA: success */
	flag = fts_fwupg_check_flash_status(FTS_CMD_FLASH_STATUS_ERASE_OK,
					    FTS_RETRIES_REASE,
					    FTS_RETRIES_DELAY_REASE);
	if (!flag) {
		FTS_ERROR("ecc flash status check fail");
		return -EIO;
	}

	return 0;
}

/************************************************************************
 * Name: fts_fwupg_ecc_cal
 * Brief: calculate and get ecc from tp
 * Input: saddr - start address need calculate ecc
 *        len - length need calculate ecc
 * Output:
 * Return: return data ecc of tp if success, otherwise return error code
 ***********************************************************************/
int fts_fwupg_ecc_cal(u32 saddr, u32 len)
{
	int ret = 0;
	u32 i = 0;
	u8 wbuf[FTS_CMD_ECC_CAL_LEN] = {0};
	u8 val[FTS_CMD_FLASH_STATUS_LEN] = {0};
	int ecc = 0;
	int ecc_len = 0;
	u32 packet_num = 0;
	u32 packet_len = 0;
	u32 remainder = 0;
	u32 addr = 0;
	u32 offset = 0;
	struct fts_upgrade *upg = fwupgrade;

	FTS_INFO("**********read out checksum**********");
	if ((upg == NULL) || (upg->func == NULL)) {
		FTS_ERROR("upgrade/func is null");
		return -EINVAL;
	}

	/* check sum init */
	wbuf[0] = FTS_CMD_ECC_INIT;
	ret = fts_write(wbuf, 1);
	if (ret < 0) {
		FTS_ERROR("ecc init cmd write fail");
		return ret;
	}

	packet_num = len / FTS_MAX_LEN_ECC_CALC;
	remainder = len % FTS_MAX_LEN_ECC_CALC;
	if (remainder)
		packet_num++;
	packet_len = FTS_MAX_LEN_ECC_CALC;
	FTS_INFO("ecc calc num:%d, remainder:%d", packet_num, remainder);

	/* send commond to start checksum */
	wbuf[0] = FTS_CMD_ECC_CAL;
	for (i = 0; i < packet_num; i++) {
		offset = FTS_MAX_LEN_ECC_CALC * i;
		addr = saddr + offset;
		wbuf[1] = BYTE_OFF_16(addr);
		wbuf[2] = BYTE_OFF_8(addr);
		wbuf[3] = BYTE_OFF_0(addr);

		if ((i == (packet_num - 1)) && remainder)
			packet_len = remainder;
		wbuf[4] = BYTE_OFF_8(packet_len);
		wbuf[5] = BYTE_OFF_0(packet_len);

		FTS_DEBUG("ecc calc startaddr:0x%04x, len:%d", addr,
			  packet_len);
		ret = fts_write(wbuf, FTS_CMD_ECC_CAL_LEN);
		if (ret < 0) {
			FTS_ERROR("ecc calc cmd write fail");
			return ret;
		}

		msleep(packet_len / 256);

		/* read status if check sum is finished */
		ret = fts_fwupg_check_flash_status(FTS_CMD_FLASH_STATUS_ECC_OK,
						   FTS_RETRIES_ECC_CAL,
						   FTS_RETRIES_DELAY_ECC_CAL);
		if (ret < 0) {
			FTS_ERROR("ecc flash status read fail");
			return ret;
		}
	}

	ecc_len = 1;
	if (upg->func->fw_ecc_check_mode == ECC_CHECK_MODE_CRC16)
		ecc_len = 2;


	/* read out check sum */
	wbuf[0] = FTS_CMD_ECC_READ;
	ret = fts_read(wbuf, 1, val, ecc_len);
	if (ret < 0) {
		FTS_ERROR("ecc read cmd write fail");
		return ret;
	}

	if (upg->func->fw_ecc_check_mode == ECC_CHECK_MODE_CRC16)
		ecc = (int)((u16)(val[0] << 8) + val[1]);
	else
		ecc = (int)val[0];


	return ecc;
}

/************************************************************************
 * Name: fts_flash_write_buf
 * Brief: write buf data to flash address
 * Input: saddr - start address data write to flash
 *        buf - data buffer
 *        len - data length
 *        delay - delay after write
 * Output:
 * Return: return data ecc of host if success, otherwise return error code
 ***********************************************************************/
int fts_flash_write_buf(u32 saddr, u8 *buf, u32 len, u32 delay)
{
	int ret = 0;
	u32 i = 0;
	u32 j = 0;
	u32 packet_number = 0;
	u32 packet_len = 0;
	u32 addr = 0;
	u32 offset = 0;
	u32 remainder = 0;
	u8 packet_buf[FTS_FLASH_PACKET_LENGTH + FTS_CMD_WRITE_LEN] = {0};
	u8 ecc_tmp = 0;
	int ecc_in_host = 0;
	u8 cmd = 0;
	u8 val[FTS_CMD_FLASH_STATUS_LEN] = {0};
	u16 read_status = 0;
	u16 wr_ok = 0;
	struct fts_upgrade *upg = fwupgrade;

	FTS_INFO("**********write data to flash**********");
	if ((!upg) || (!upg->func || !buf || !len)) {
		FTS_ERROR("upgrade/func/buf/len is invalid");
		return -EINVAL;
	}

	FTS_INFO("data buf start addr=0x%x, len=0x%x", saddr, len);
	packet_number = len / FTS_FLASH_PACKET_LENGTH;
	remainder = len % FTS_FLASH_PACKET_LENGTH;
	if (remainder > 0)
		packet_number++;
	packet_len = FTS_FLASH_PACKET_LENGTH;
	FTS_INFO("write data, num:%d remainder:%d", packet_number, remainder);

	packet_buf[0] = FTS_CMD_WRITE;
	for (i = 0; i < packet_number; i++) {
		offset = i * FTS_FLASH_PACKET_LENGTH;
		addr = saddr + offset;
		packet_buf[1] = BYTE_OFF_16(addr);
		packet_buf[2] = BYTE_OFF_8(addr);
		packet_buf[3] = BYTE_OFF_0(addr);

		/* last packet */
		if ((i == (packet_number - 1)) && remainder)
			packet_len = remainder;

		packet_buf[4] = BYTE_OFF_8(packet_len);
		packet_buf[5] = BYTE_OFF_0(packet_len);

		for (j = 0; j < packet_len; j++) {
			packet_buf[FTS_CMD_WRITE_LEN + j] = buf[offset + j];
			ecc_tmp ^= packet_buf[FTS_CMD_WRITE_LEN + j];
		}

		ret = fts_write(packet_buf, packet_len + FTS_CMD_WRITE_LEN);
		if (ret < 0) {
			FTS_ERROR("app write fail");
			return ret;
		}
		mdelay(delay);

		/* read status */
		wr_ok = FTS_CMD_FLASH_STATUS_WRITE_OK + addr / packet_len;
		for (j = 0; j < FTS_RETRIES_WRITE; j++) {
			cmd = FTS_CMD_FLASH_STATUS;
			ret = fts_read(&cmd, 1, val, FTS_CMD_FLASH_STATUS_LEN);
			read_status = (((u16)val[0]) << 8) + val[1];
			/*  FTS_INFO("%x %x", wr_ok, read_status); */
			if (wr_ok == read_status)
				break;

			mdelay(FTS_RETRIES_DELAY_WRITE);
		}
	}

	ecc_in_host = (int)ecc_tmp;
	if (upg->func->fw_ecc_check_mode == ECC_CHECK_MODE_CRC16)
		ecc_in_host = (int)fts_crc16_calc_host(buf, len);


	return ecc_in_host;
}

/************************************************************************
 * Name: fts_flash_read_buf
 * Brief: read data from flash
 * Input: saddr - start address data write to flash
 *        buf - buffer to store data read from flash
 *        len - read length
 * Output:
 * Return: return 0 if success, otherwise return error code
 *
 * Warning: can't call this function directly, need call in boot environment
 ***********************************************************************/
int fts_flash_read_buf(u32 saddr, u8 *buf, u32 len)
{
	int ret = 0;
	u32 i = 0;
	u32 packet_number = 0;
	u32 packet_len = 0;
	u32 addr = 0;
	u32 offset = 0;
	u32 remainder = 0;
	u8 wbuf[FTS_CMD_READ_LEN];

	if ((buf == NULL) || (len == 0)) {
		FTS_ERROR("buf is NULL or len is 0");
		return -EINVAL;
	}

	packet_number = len / FTS_FLASH_PACKET_LENGTH;
	remainder = len % FTS_FLASH_PACKET_LENGTH;
	if (remainder > 0)
		packet_number++;

	packet_len = FTS_FLASH_PACKET_LENGTH;
	FTS_INFO("read packet_number:%d, remainder:%d", packet_number,
		 remainder);

	wbuf[0] = FTS_CMD_READ;
	for (i = 0; i < packet_number; i++) {
		offset = i * FTS_FLASH_PACKET_LENGTH;
		addr = saddr + offset;
		wbuf[1] = BYTE_OFF_16(addr);
		wbuf[2] = BYTE_OFF_8(addr);
		wbuf[3] = BYTE_OFF_0(addr);

		/* last packet */
		if ((i == (packet_number - 1)) && remainder)
			packet_len = remainder;

		ret = fts_write(wbuf, FTS_CMD_READ_LEN);
		if (ret < 0) {
			FTS_ERROR("pram/bootloader write 03 command fail");
			return ret;
		}

		msleep(FTS_CMD_READ_DELAY);
	/* must wait, otherwise read wrong data */
		ret = fts_read(NULL, 0, buf + offset, packet_len);
		if (ret < 0) {
			FTS_ERROR("pram/bootloader read 03 command fail");
			return ret;
		}
	}

	return 0;
}

/************************************************************************
 * Name: fts_flash_read
 * Brief:
 * Input:  addr  - address of flash
 *         len   - length of read
 * Output: buf   - data read from flash
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
int fts_flash_read(u32 addr, u8 *buf, u32 len)
{
	int ret = 0;

	FTS_INFO("***********read flash***********");
	if ((buf == NULL) || (len == 0)) {
		FTS_ERROR("buf is NULL or len is 0");
		return -EINVAL;
	}

	ret = fts_fwupg_enter_into_boot();
	if (ret < 0) {
		FTS_ERROR("enter into pramboot/bootloader fail");
		goto read_flash_err;
	}

	ret = fts_flash_read_buf(addr, buf, len);
	if (ret < 0) {
		FTS_ERROR("read flash fail");
		goto read_flash_err;
	}

read_flash_err:
	/* reset to normal boot */
	ret = fts_fwupg_reset_in_boot();
	if (ret < 0)
		FTS_ERROR("reset to normal boot fail");

	return ret;
}

int fts_read_file(char *file_name, u8 **file_buf)
{
	int ret = 0;
	char file_path[FILE_NAME_LENGTH] = {0};
	struct file *filp = NULL;
	struct inode *inode;
	mm_segment_t old_fs;
	loff_t pos;
	loff_t file_len = 0;

	if ((file_name == NULL) || (file_buf == NULL)) {
		FTS_ERROR("filename/filebuf is NULL");
		return -EINVAL;
	}

	snprintf(file_path, FILE_NAME_LENGTH, "%s%s", FTS_FW_BIN_FILEPATH,
		 file_name);
	filp = filp_open(file_path, O_RDONLY, 0);
	if (IS_ERR(filp)) {
		FTS_ERROR("open %s file fail", file_path);
		return -ENOENT;
	}

	inode = filp->f_inode;

	file_len = inode->i_size;
	*file_buf = vmalloc(file_len);
	if (*file_buf == NULL) {
		FTS_ERROR("file buf malloc fail");
		filp_close(filp, NULL);
		return -ENOMEM;
	}
	old_fs = get_fs();
	set_fs(KERNEL_DS);
	pos = 0;
	ret = vfs_read(filp, *file_buf, file_len, &pos);
	if (ret < 0)
		FTS_ERROR("read file fail");
	FTS_INFO("file len:%d read len:%d pos:%d", (u32)file_len, ret,
		 (u32)pos);
	filp_close(filp, NULL);
	set_fs(old_fs);

	return ret;
}

int fts_upgrade_bin(char *fw_name, bool force)
{
	int ret = 0;
	u32 fw_file_len = 0;
	u8 *fw_file_buf = NULL;
	struct fts_upgrade *upg = fwupgrade;

	FTS_INFO("start upgrade with fw bin");
	if ((!upg) || (!upg->func) || !upg->ts_data) {
		FTS_ERROR("upgrade/func/ts_data is null");
		return -EINVAL;
	}

	upg->ts_data->fw_loading = 1;
	fts_irq_disable();
#if FTS_ESDCHECK_EN
	fts_esdcheck_switch(DISABLE);
#endif

	ret = fts_read_file(fw_name, &fw_file_buf);
	if ((ret < 0) || (ret < FTS_MIN_LEN) || (ret > FTS_MAX_LEN_FILE)) {
		FTS_ERROR("read fw bin file(sdcard) fail, len:%d", fw_file_len);
		goto err_bin;
	}

	fw_file_len = ret;
	FTS_INFO("fw bin file len:%d", fw_file_len);
	if (force) {
		if (upg->func->force_upgrade) {
			ret = upg->func->force_upgrade(fw_file_buf,
						       fw_file_len);
		} else {
			FTS_INFO("force_upgrade function is null, no upgrade");
			goto err_bin;
		}
	} else {
#if FTS_AUTO_LIC_UPGRADE_EN
		if (upg->func->lic_upgrade)
			ret = upg->func->lic_upgrade(fw_file_buf, fw_file_len);
		else
			FTS_INFO("lic_upgrade function is null, no upgrade");

#endif
		if (upg->func->upgrade)
			ret = upg->func->upgrade(fw_file_buf, fw_file_len);
		else
			FTS_INFO("upgrade function is null, no upgrade");

	}

	if (ret < 0) {
		FTS_ERROR("upgrade fw bin failed");
		fts_fwupg_reset_in_boot();
		goto err_bin;
	}

	FTS_INFO("upgrade fw bin success");
	ret = 0;

err_bin:
#if FTS_ESDCHECK_EN
	fts_esdcheck_switch(ENABLE);
#endif
	fts_irq_enable();
	upg->ts_data->fw_loading = 0;

	if (fw_file_buf) {
		vfree(fw_file_buf);
		fw_file_buf = NULL;
	}
	return ret;
}

int fts_enter_test_environment(bool test_state)
{
	return 0;
}
#if FTS_AUTO_LIC_UPGRADE_EN
static int fts_lic_get_vid_in_tp(u16 *vid)
{
	int ret = 0;
	u8 val[2] = {0};

	if (vid == NULL) {
		FTS_ERROR("vid is NULL");
		return -EINVAL;
	}

	ret = fts_read_reg(FTS_REG_VENDOR_ID, &val[0]);
	if (fts_data->ic_info.is_incell)
		ret = fts_read_reg(FTS_REG_MODULE_ID, &val[1]);
	if (ret < 0) {
		FTS_ERROR("read vid from tp fail");
		return ret;
	}

	*vid = *(u16 *)val;
	return 0;
}

static int fts_lic_get_vid_in_host(struct fts_upgrade *upg, u16 *vid)
{
	u8 val[2] = {0};
	u8 *licbuf = NULL;
	u32 conf_saddr = 0;

	if (!upg || !upg->func || !upg->lic || !vid) {
		FTS_ERROR("upgrade/func/get_hlic_ver/lic/vid is null");
		return -EINVAL;
	}

	if (upg->lic_length < FTS_MAX_LEN_SECTOR) {
		FTS_ERROR("lic length(%x) fail", upg->lic_length);
		return -EINVAL;
	}

	licbuf = upg->lic;
	conf_saddr = upg->func->fwcfgoff;
	val[0] = licbuf[conf_saddr + FTS_CONIFG_VENDORID_OFF];
	if (fts_data->ic_info.is_incell)
		val[1] = licbuf[conf_saddr + FTS_CONIFG_MODULEID_OFF];

	*vid = *(u16 *)val;
	return 0;
}

static int fts_lic_get_ver_in_tp(u8 *ver)
{
	int ret = 0;

	if (ver == NULL) {
		FTS_ERROR("ver is NULL");
		return -EINVAL;
	}

	ret = fts_read_reg(FTS_REG_LIC_VER, ver);
	if (ret < 0) {
		FTS_ERROR("read lcd initcode ver from tp fail");
		return ret;
	}

	return 0;
}

static int fts_lic_get_ver_in_host(struct fts_upgrade *upg, u8 *ver)
{
	int ret = 0;

	if (!upg || !upg->func || !upg->func->get_hlic_ver || !upg->lic) {
		FTS_ERROR("upgrade/func/get_hlic_ver/lic is null");
		return -EINVAL;
	}

	ret = upg->func->get_hlic_ver(upg->lic);
	if (ret < 0) {
		FTS_ERROR("get host lcd initial code version fail");
		return ret;
	}

	*ver = (u8)ret;
	return ret;
}

static bool fts_lic_need_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;
	u8 initcode_ver_in_tp = 0;
	u8 initcode_ver_in_host = 0;
	u16 vid_in_tp = 0;
	u16 vid_in_host = 0;
	bool fwvalid = false;

	fwvalid = fts_fwupg_check_fw_valid();
	if (!fwvalid) {
		FTS_INFO("fw is invalid, no upgrade lcd init code");
		return false;
	}

	ret = fts_lic_get_vid_in_host(upg, &vid_in_host);
	if (ret < 0) {
		FTS_ERROR("vendor id in host invalid");
		return false;
	}

	ret = fts_lic_get_vid_in_tp(&vid_in_tp);
	if (ret < 0) {
		FTS_ERROR("vendor id in tp invalid");
		return false;
	}

	FTS_DEBUG("vid in tp:0x%04x, host:0x%04x", vid_in_tp, vid_in_host);
	if (vid_in_tp != vid_in_host) {
		FTS_INFO("vendor id in tp&host are different, no upgrade lic");
		return false;
	}

	ret = fts_lic_get_ver_in_host(upg, &initcode_ver_in_host);
	if (ret < 0) {
		FTS_ERROR("init code in host invalid");
		return false;
	}

	ret = fts_lic_get_ver_in_tp(&initcode_ver_in_tp);
	if (ret < 0) {
		FTS_ERROR("read reg0xE4 fail");
		return false;
	}

	FTS_DEBUG("lcd initial code version in tp:%x, host:%x",
		  initcode_ver_in_tp, initcode_ver_in_host);
	if (initcode_ver_in_tp == 0xA5) {
		FTS_INFO("lcd init code ver is 0xA5, don't upgade init code");
		return false;
	} else if (initcode_ver_in_tp == 0xFF) {
		FTS_DEBUG(
			"lcd init code in tp is invalid, need upgrade init code");
		return true;
	} else if (initcode_ver_in_tp < initcode_ver_in_host)
		return true;
	else
		return false;
}

static int fts_lic_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;
	bool hlic_upgrade = false;
	int upgrade_count = 0;
	u8 ver = 0;

	FTS_INFO("lcd initial code auto upgrade function");
	if ((!upg) || (!upg->func) || (!upg->func->lic_upgrade)) {
		FTS_ERROR("lcd upgrade function is null");
		return -EINVAL;
	}

	hlic_upgrade = fts_lic_need_upgrade(upg);
	FTS_INFO("lcd init code upgrade flag:%d", hlic_upgrade);
	if (hlic_upgrade) {
		FTS_INFO("lcd initial code need upgrade, upgrade begin...");
		do {
			FTS_INFO("lcd initial code upgrade times:%d",
				 upgrade_count);
			upgrade_count++;

			ret = upg->func->lic_upgrade(upg->lic, upg->lic_length);
			if (ret < 0) {
				fts_fwupg_reset_in_boot();
			} else {
				fts_lic_get_ver_in_tp(&ver);
				FTS_INFO(
					"success upgrade to lcd initcode ver:%02x",
					ver);
				break;
			}
		} while (upgrade_count < 2);
	} else {
		FTS_INFO("lcd initial code don't need upgrade");
	}

	return ret;
}
#endif /* FTS_AUTO_LIC_UPGRADE_EN */

static int fts_param_get_ver_in_tp(u8 *ver)
{
	int ret = 0;

	if (ver == NULL) {
		FTS_ERROR("ver is NULL");
		return -EINVAL;
	}

	ret = fts_read_reg(FTS_REG_IDE_PARA_VER_ID, ver);
	if (ret < 0) {
		FTS_ERROR("read fw param ver from tp fail");
		return ret;
	}

	if ((*ver == 0x00) || (*ver == 0xFF)) {
		FTS_INFO("param version in tp invalid");
		return -EIO;
	}

	return 0;
}

static int fts_param_get_ver_in_host(struct fts_upgrade *upg, u8 *ver)
{
	if ((!upg) || (!upg->func) || (!upg->fw) || (!ver)) {
		FTS_ERROR("fts_data/upgrade/func/fw/ver is NULL");
		return -EINVAL;
	}

	if (upg->fw_length < upg->func->paramcfgveroff) {
		FTS_ERROR("fw len(%x) < paramcfg ver offset(%x)",
			  upg->fw_length, upg->func->paramcfgveroff);
		return -EINVAL;
	}

	FTS_INFO("fw paramcfg version offset:%x", upg->func->paramcfgveroff);
	*ver = upg->fw[upg->func->paramcfgveroff];

	if ((*ver == 0x00) || (*ver == 0xFF)) {
		FTS_INFO("param version in host invalid");
		return -EIO;
	}

	return 0;
}

/*
 * return: < 0 : error
 *         == 0: no ide
 *         == 1: ide
 */
static int fts_param_ide_in_host(struct fts_upgrade *upg)
{
	u32 off = 0;

	if ((!upg) || (!upg->func) || (!upg->fw)) {
		FTS_ERROR("fts_data/upgrade/func/fw is NULL");
		return -EINVAL;
	}

	if (upg->fw_length < upg->func->paramcfgoff + FTS_FW_IDE_SIG_LEN) {
		FTS_INFO("fw len(%x) < paramcfg offset(%x), no IDE",
			 upg->fw_length,
			 upg->func->paramcfgoff + FTS_FW_IDE_SIG_LEN);
		return 0;
	}

	off = upg->func->paramcfgoff;
	if (memcmp(&upg->fw[off], FTS_FW_IDE_SIG, FTS_FW_IDE_SIG_LEN) == 0) {
		FTS_INFO("fw in host is IDE version");
		return 1;
	}

	FTS_INFO("fw in host isn't IDE version");
	return 0;
}

/*
 * return: < 0 : error
 *         0   : no ide
 *         1   : ide
 */
static int fts_param_ide_in_tp(u8 *val)
{
	int ret = 0;

	ret = fts_read_reg(FTS_REG_IDE_PARA_STATUS, val);
	if (ret < 0) {
		FTS_ERROR("read IDE PARAM STATUS in tp fail");
		return ret;
	}

	if ((*val != 0xFF) && ((*val & 0x80) == 0x80)) {
		FTS_INFO("fw in tp is IDE version");
		return 1;
	}

	FTS_INFO("fw in tp isn't IDE version");
	return 0;
}

/************************************************************************
 * fts_param_need_upgrade - check fw paramcfg need upgrade or not
 *
 * Return:  < 0 : error if paramcfg need upgrade
 *          0   : no need upgrade
 *          1   : need upgrade app + param
 *          2   : need upgrade param
 ***********************************************************************/
static int fts_param_need_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;
	u8 val = 0;
	int ide_in_host = 0;
	int ide_in_tp = 0;
	u8 ver_in_host = 0;
	u8 ver_in_tp = 0;
	bool fwvalid = false;

	fwvalid = fts_fwupg_check_fw_valid();
	if (!fwvalid) {
		FTS_INFO("fw is invalid, upgrade app+param");
		return 1;
	}

	ide_in_host = fts_param_ide_in_host(upg);
	if (ide_in_host < 0) {
		FTS_INFO("fts_param_ide_in_host fail");
		return ide_in_host;
	}

	ide_in_tp = fts_param_ide_in_tp(&val);
	if (ide_in_tp < 0) {
		FTS_INFO("fts_param_ide_in_tp fail");
		return ide_in_tp;
	}

	if ((ide_in_host == 0) && (ide_in_tp == 0)) {
		FTS_INFO("fw in host&tp are both no ide");
		return 0;
	} else if (ide_in_host != ide_in_tp) {
		FTS_INFO("fw in host&tp not equal, need upgrade app+param");
		return 1;
	} else if ((ide_in_host == 1) && (ide_in_tp == 1)) {
		FTS_INFO("fw in host&tp are both ide");
		if ((val & 0x7F) != 0x00) {
			FTS_INFO("param invalid, need upgrade param");
			return 2;
		}

		ret = fts_param_get_ver_in_host(upg, &ver_in_host);
		if (ret < 0) {
			FTS_ERROR("param version in host invalid");
			return ret;
		}

		ret = fts_param_get_ver_in_tp(&ver_in_tp);
		if (ret < 0) {
			FTS_ERROR("get IDE param ver in tp fail");
			return ret;
		}

		FTS_INFO("fw paramcfg version in tp:%x, host:%x", ver_in_tp,
			 ver_in_host);
		if (ver_in_tp != ver_in_host)
			return 2;

	}

	return 0;
}

static int fts_fwupg_get_ver_in_tp(u8 *ver)
{
	int ret = 0;

	if (ver == NULL) {
		FTS_ERROR("ver is NULL");
		return -EINVAL;
	}

	ret = fts_read_reg(FTS_REG_FW_VER, ver);
	if (ret < 0) {
		FTS_ERROR("read fw ver from tp fail");
		return ret;
	}

	return 0;
}

static int fts_fwupg_get_ver_in_host(struct fts_upgrade *upg, u8 *ver)
{
	if ((!upg) || (!upg->func) || (!upg->fw) || (!ver)) {
		FTS_ERROR("fts_data/upgrade/func/fw/ver is NULL");
		return -EINVAL;
	}

	if (upg->fw_length < upg->func->fwveroff) {
		FTS_ERROR("fw len(0x%0x) < fw ver offset(0x%x)", upg->fw_length,
			  upg->func->fwveroff);
		return -EINVAL;
	}

	FTS_INFO("fw version offset:0x%x", upg->func->fwveroff);
	*ver = upg->fw[upg->func->fwveroff];
	return 0;
}

static bool fts_fwupg_need_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;
	bool fwvalid = false;
	u8 fw_ver_in_host = 0;
	u8 fw_ver_in_tp = 0;

	fwvalid = fts_fwupg_check_fw_valid();
	if (fwvalid) {
		ret = fts_fwupg_get_ver_in_host(upg, &fw_ver_in_host);
		if (ret < 0) {
			FTS_ERROR("get fw ver in host fail");
			return false;
		}

		ret = fts_fwupg_get_ver_in_tp(&fw_ver_in_tp);
		if (ret < 0) {
			FTS_ERROR("get fw ver in tp fail");
			return false;
		}

		FTS_INFO("fw version in tp:%x, host:%x", fw_ver_in_tp,
			 fw_ver_in_host);
		if (fw_ver_in_tp != fw_ver_in_host)
			return true;

	} else {
		FTS_INFO("fw invalid, need upgrade fw");
		return true;
	}

	return false;
}

/************************************************************************
 * Name: fts_fw_upgrade
 * Brief: fw upgrade main entry, run in following steps
 *        1. check fw version(A6), not equal, will upgrade app(+param)
 *        2. if fw version equal, will check ide, will upgrade app(+param)
 *        in the follow situation
 *          a. host&tp IDE's type are not equal, will upgrade app+param
 *          b. host&tp are both IDE's type, and param's version are not
 *          equal, will upgrade param
 * Input:
 * Output:
 * Return: return 0 if success, otherwise return error code
 ***********************************************************************/
int fts_fwupg_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;
	bool upgrade_flag = false;
	int upgrade_count = 0;
	u8 ver = 0;

	FTS_INFO("fw auto upgrade function");
	if ((upg == NULL) || (upg->func == NULL)) {
		FTS_ERROR("upg/upg->func is null");
		return -EINVAL;
	}

	upgrade_flag = fts_fwupg_need_upgrade(upg);
	FTS_INFO("fw upgrade flag:%d", upgrade_flag);
	do {
		upgrade_count++;
		if (upgrade_flag) {
			FTS_INFO("upgrade fw app(times:%d)", upgrade_count);
			if (upg->func->upgrade) {
				ret = upg->func->upgrade(upg->fw,
							 upg->fw_length);
				if (ret < 0) {
					fts_fwupg_reset_in_boot();
				} else {
					fts_fwupg_get_ver_in_tp(&ver);
					FTS_INFO(
						"success upgrade to fw version %02x",
						ver);
					break;
				}
			} else {
				FTS_ERROR(
					"upgrade func/upgrade is null, return immediately");
				ret = -ENODATA;
				break;
			}
		} else {
			if (upg->func->param_upgrade) {
				ret = fts_param_need_upgrade(upg);
				if (ret <= 0) {
					FTS_INFO("param don't need upgrade");
					break;
				} else if (ret == 1) {
					FTS_INFO(
						"force upgrade fw app(times:%d)",
						upgrade_count);
					if (upg->func->upgrade && ret < 0) {
						ret = upg->func->upgrade(
							upg->fw,
							upg->fw_length);
						fts_fwupg_reset_in_boot();
					}
					if (upg->func->upgrade && ret >= 0)
						break;

				} else if (ret == 2) {
					FTS_INFO("upgrade param area(times:%d)",
						 upgrade_count);
					ret = upg->func->param_upgrade(
						upg->fw, upg->fw_length);
					if (ret < 0) {
						fts_fwupg_reset_in_boot();
					} else {
						fts_param_get_ver_in_tp(&ver);
						FTS_INFO(
							"success upgrade to fw param version %02x",
							ver);
						break;
					}
				} else
					break;
			} else {
				break;
			}
		}
	} while (upgrade_count < 2);

	return ret;
}

/************************************************************************
 * fts_fwupg_auto_upgrade - upgrade main entry
 ***********************************************************************/
static void fts_fwupg_auto_upgrade(struct fts_upgrade *upg)
{
	int ret = 0;

	FTS_INFO("********************FTS enter upgrade********************");
	if (!upg || !upg->ts_data) {
		FTS_ERROR("upg/ts_data is null");
		return;
	}

	ret = fts_fwupg_upgrade(upg);
	if (ret < 0)
		FTS_ERROR(
			"**********tp fw(app/param) upgrade failed**********");
	else
		FTS_INFO(
			"**********tp fw(app/param) no upgrade/upgrade success**********");

#if FTS_AUTO_LIC_UPGRADE_EN
	ret = fts_lic_upgrade(upg);
	if (ret < 0)
		FTS_ERROR("**********lcd init code upgrade failed**********");
	else
		FTS_INFO(
			"**********lcd init code no upgrade/upgrade success**********");
#endif

	FTS_INFO("********************FTS exit upgrade********************");
}

static int fts_fwupg_get_vendorid(struct fts_upgrade *upg, int *vid)
{
	int ret = 0;
	bool fwvalid = false;
	u8 vendor_id = 0;
	u8 module_id = 0;
	u32 fwcfg_addr = 0;
	u8 cfgbuf[FTS_HEADER_LEN] = {0};

	FTS_INFO("read vendor id from tp");
	if ((!upg) || (!upg->func) || (!upg->ts_data) || (!vid)) {
		FTS_ERROR("upgrade/func/ts_data/vid is null");
		return -EINVAL;
	}

	fwvalid = fts_fwupg_check_fw_valid();
	if (fwvalid) {
		ret = fts_read_reg(FTS_REG_VENDOR_ID, &vendor_id);
		if (upg->ts_data->ic_info.is_incell)
			ret = fts_read_reg(FTS_REG_MODULE_ID, &module_id);
	} else {
		fwcfg_addr = upg->func->fwcfgoff;
		ret = fts_flash_read(fwcfg_addr, cfgbuf, FTS_HEADER_LEN);
		vendor_id = cfgbuf[FTS_CONIFG_VENDORID_OFF];
		if (upg->ts_data->ic_info.is_incell) {
			if ((cfgbuf[FTS_CONIFG_MODULEID_OFF] +
			     cfgbuf[FTS_CONIFG_MODULEID_OFF + 1]) == 0xFF)
				module_id = cfgbuf[FTS_CONIFG_MODULEID_OFF];
		}
	}

	if (ret < 0) {
		FTS_ERROR("fail to get vendor id from tp");
		return ret;
	}

	*vid = (int)((module_id << 8) + vendor_id);
	return 0;
}

static int fts_fwupg_get_module_info(struct fts_upgrade *upg)
{
	int ret = 0;
	int i = 0;
	struct upgrade_module *info = &module_list[0];

	if (!upg || !upg->ts_data) {
		FTS_ERROR("upg/ts_data is null");
		return -EINVAL;
	}

	if (FTS_GET_MODULE_NUM > 1) {
		/* support multi modules, must read correct module id(vendor id)
		 */
		ret = fts_fwupg_get_vendorid(upg, &upg->module_id);
		if (ret < 0) {
			FTS_ERROR("get vendor id failed");
			return ret;
		}
		FTS_INFO("module id:%04x", upg->module_id);
		for (i = 0; i < FTS_GET_MODULE_NUM; i++) {
			info = &module_list[i];
			if (upg->module_id == info->id) {
				FTS_INFO(
					"module id match, get module info pass");
				break;
			}
		}
		if (i >= FTS_GET_MODULE_NUM) {
			FTS_ERROR("no module id match, don't get file");
			return -ENODATA;
		}
	}

	upg->module_info = info;
	return 0;
}

static int fts_get_fw_file_via_request_firmware(struct fts_upgrade *upg)
{
	int ret = 0;
	const struct firmware *fw = NULL;
	u8 *tmpbuf = NULL;
	char fwname[FILE_NAME_LENGTH] = {0};

	if (!upg || !upg->ts_data || !upg->ts_data->dev) {
		FTS_ERROR("upg/ts_data/dev is null");
		return -EINVAL;
	}

	snprintf(fwname, FILE_NAME_LENGTH, "%s%s.bin",
		 FTS_FW_NAME_PREX_WITH_REQUEST, upg->module_info->vendor_name);

	ret = request_firmware(&fw, fwname, upg->ts_data->dev);
	if (ret == 0) {
		FTS_INFO("firmware(%s) request successfully", fwname);
		tmpbuf = vmalloc(fw->size);
		if (tmpbuf == NULL) {
			FTS_ERROR("fw buffer vmalloc fail");
			ret = -ENOMEM;
		} else {
			memcpy(tmpbuf, fw->data, fw->size);
			upg->fw = tmpbuf;
			upg->fw_length = fw->size;
			upg->fw_from_request = 1;
		}
	} else {
		FTS_INFO("firmware(%s) request fail,ret=%d", fwname, ret);
	}

	if (fw != NULL) {
		release_firmware(fw);
		fw = NULL;
	}

	return ret;
}

static int fts_get_fw_file_via_i(struct fts_upgrade *upg)
{
	upg->fw = upg->module_info->fw_file;
	upg->fw_length = upg->module_info->fw_len;
	upg->fw_from_request = 0;

	return 0;
}

/*****************************************************************************
 *  Name: fts_fwupg_get_fw_file
 *  Brief: get fw image/file,
 *         If support muitl modules, please set FTS_GET_MODULE_NUM, and FTS_-
 *         MODULE_ID/FTS_MODULE_NAME;
 *         If get fw via .i file, please set FTS_FW_REQUEST_SUPPORT=0, and F-
 *         TS_MODULE_ID; will use module id to distingwish different modules;
 *         If get fw via reques_firmware(), please set FTS_FW_REQUEST_SUPPORT
 *         =1, and FTS_MODULE_NAME; fw file name will be composed of "focalt-
 *         ech_ts_fw_" & FTS_VENDOR_NAME;
 *
 *         If have flash, module_id=vendor_id, If non-flash,module_id need
 *         transfer from LCD driver(gpio or lcm_id or ...);
 *  Input:
 *  Output:
 *  Return: return 0 if success, otherwise return error code
 *****************************************************************************/
static int fts_fwupg_get_fw_file(struct fts_upgrade *upg)
{
	int ret = 0;
	bool get_fw_i_flag = false;

	FTS_DEBUG("get upgrade fw file");
	if (!upg || !upg->ts_data) {
		FTS_ERROR("upg/ts_data is null");
		return -EINVAL;
	}

	ret = fts_fwupg_get_module_info(upg);
	if ((ret < 0) || (!upg->module_info)) {
		FTS_ERROR("get module info fail");
		return ret;
	}

	if (FTS_FW_REQUEST_SUPPORT) {
		ret = fts_get_fw_file_via_request_firmware(upg);
		if (ret != 0)
			get_fw_i_flag = true;

	} else {
		get_fw_i_flag = true;
	}

	if (get_fw_i_flag)
		ret = fts_get_fw_file_via_i(upg);


	upg->lic = upg->fw;
	upg->lic_length = upg->fw_length;

	FTS_INFO("upgrade fw file len:%d", upg->fw_length);
	if ((upg->fw_length < FTS_MIN_LEN) ||
	    (upg->fw_length > FTS_MAX_LEN_FILE)) {
		FTS_ERROR("fw file len(%d) fail", upg->fw_length);
		return -ENODATA;
	}

	return ret;
}

static void fts_fwupg_init_ic_detail(struct fts_upgrade *upg)
{
	if (upg && upg->func && upg->func->init)
		upg->func->init(upg->fw, upg->fw_length);

}

/*****************************************************************************
 *  Name: fts_fwupg_work
 *  Brief: 1. get fw image/file
 *         2. ic init if have
 *         3. call upgrade main function(fts_fwupg_auto_upgrade)
 *  Input:
 *  Output:
 *  Return:
 *****************************************************************************/
static void fts_fwupg_work(struct work_struct *work)
{
	int ret = 0;
	struct fts_upgrade *upg = fwupgrade;

#if !FTS_AUTO_UPGRADE_EN
	FTS_INFO("FTS_AUTO_UPGRADE_EN is disabled, not upgrade when power on");
	return;
#endif

	FTS_INFO("fw upgrade work function");
	if (!upg || !upg->ts_data) {
		FTS_ERROR("upg/ts_data is null");
		return;
	}

	upg->ts_data->fw_loading = 1;
	fts_irq_disable();
#if FTS_ESDCHECK_EN
	fts_esdcheck_switch(DISABLE);
#endif

	/* get fw */
	ret = fts_fwupg_get_fw_file(upg);
	if (ret < 0) {
		FTS_ERROR("get file fail, can't upgrade");
	} else {
		/* ic init if have */
		fts_fwupg_init_ic_detail(upg);
		/* run auto upgrade */
		fts_fwupg_auto_upgrade(upg);
	}

#if FTS_ESDCHECK_EN
	fts_esdcheck_switch(ENABLE);
#endif
	fts_irq_enable();
	upg->ts_data->fw_loading = 0;
}

int fts_fwupg_init(struct fts_ts_data *ts_data)
{
	int i = 0;
	int j = 0;
	int ic_stype = 0;
	struct upgrade_func *func = upgrade_func_list[0];
	int func_count =
		ARRAY_SIZE(upgrade_func_list);

	FTS_INFO("fw upgrade init function");

	if (!ts_data || !ts_data->ts_workqueue) {
		FTS_ERROR(
			"ts_data/workqueue is NULL, can't run upgrade function");
		return -EINVAL;
	}

	if (func_count == 0) {
		FTS_ERROR("no upgrade function in tp driver");
		return -ENODATA;
	}

	fwupgrade =
		kzalloc(sizeof(*fwupgrade), GFP_KERNEL);
	if (fwupgrade == NULL) {
		FTS_ERROR("malloc memory for upgrade fail");
		return -ENOMEM;
	}

	ic_stype = ts_data->ic_info.ids.type;
	if (func_count == 1) {
		fwupgrade->func = func;
	} else {
		for (i = 0; i < func_count; i++) {
			func = upgrade_func_list[i];
			for (j = 0; j < FTX_MAX_COMPATIBLE_TYPE; j++) {
				if (func->ctype[j] == 0)
					break;
				else if (func->ctype[j] == ic_stype) {
					FTS_INFO(
						"match upgrade function,type:%x",
						(int)func->ctype[j]);
					fwupgrade->func = func;
				}
			}
		}
	}

	if (fwupgrade->func == NULL) {
		FTS_ERROR("no upgrade function match, can't upgrade");
		return -ENODATA;
	}

	fwupgrade->ts_data = ts_data;
	INIT_WORK(&ts_data->fwupg_work, fts_fwupg_work);
	queue_work(ts_data->ts_workqueue, &ts_data->fwupg_work);

	return 0;
}

int fts_fwupg_exit(struct fts_ts_data *ts_data)
{
	FTS_FUNC_ENTER();
	if (fwupgrade) {
		if (fwupgrade->fw_from_request) {
			vfree(fwupgrade->fw);
			fwupgrade->fw = NULL;
		}

		kfree(fwupgrade);
		fwupgrade = NULL;
	}
	FTS_FUNC_EXIT();
	return 0;
}