/*
 * MELFAS MIP4 Touchkey
 *
 * Copyright (C) 2016 MELFAS Inc.
 *
 * mip4.h
 *
 * Version : 2016.03.15
 */

#ifndef _MIP4_H_
#define _MIP4_H_

/* Debug mode : Should be disabled for production builds */
#if 0	// 0 : disable, 1 : enable
#define DEBUG
#endif
#define OPEN_CLOSE_WORK

/* Include */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/gpio.h>
#include <linux/interrupt.h>
#include <linux/firmware.h>
#include <linux/slab.h>
#include <linux/input.h>
#include <linux/uaccess.h>
#include <linux/regulator/consumer.h>
#include <linux/cdev.h>
#include <linux/i2c.h>
#include <linux/delay.h>
#ifdef CONFIG_OF
#include <linux/of_gpio.h>
#endif
#ifdef CONFIG_HAS_EARLYSUSPEND
#include <linux/earlysuspend.h>
#endif
#include <linux/sec_sysfs.h>

/* Include platform data */
#include <linux/input/melfas_mip4_tk.h>

/* Include register map */
#include "mip4_reg.h"

#ifdef CONFIG_BATTERY_SAMSUNG
#include <linux/sec_batt.h>
#endif

/* Chip info */
#define CHIP_MHS204			002040

#ifdef CONFIG_KEYBOARD_MELFAS_MHS204
#define CHIP_NAME			"MHS204"
#define CHIP_MODEL			CHIP_MHS204
#endif

/* Config driver */
#define MIP_USE_INPUT_OPEN_CLOSE	1	// 0 (default) or 1
#define MIP_AUTOSET_EVENT_FORMAT	1	// 0 or 1 (default)
#define I2C_RETRY_COUNT			3	// 2~
#define RESET_ON_I2C_ERROR		1	// 0 or 1 (default)
#define RESET_ON_EVENT_ERROR		0	// 0 (default) or 1
#define ESD_COUNT_FOR_DISABLE		7	// 7~

/* Driver features */
#define MIP_USE_DEV			1	// 0 or 1 (default) : Optional - Required for development
#define MIP_USE_SYS			1	// 0 or 1 (default) : Optional - Required for development
#define MIP_USE_CMD			1	// 0 (default) or 1 : Optional

/* Max value */
#define MAX_KEY_NUM			4
#define MAX_LED_NUM			32

/* Firmware update */
#define FW_PATH_EXTERNAL		"/sdcard/firmware/touchkey/melfas_fw.bin"	//path of firmware in external storage

#define MIP_USE_AUTO_FW_UPDATE		1	// 0 (default) or 1
#define MIP_FW_MAX_SECT_NUM		4
#define MIP_FW_UPDATE_DEBUG		0	// 0 (default) or 1
#define MIP_FW_UPDATE_SECTION		0	// 0 (default) or 1
#define MIP_EXT_FW_FORCE_UPDATE		1	// 0 or 1 (default)

/*
 * Firmware update error code
 */
enum fw_update_errno{
	fw_err_file_read = -4,
	fw_err_file_open = -3,
	fw_err_file_type = -2,
	fw_err_download = -1,
	fw_err_none = 0,
	fw_err_uptodate = 1,
};

/*
 * Firmware file location
 */
enum fw_bin_source{
	fw_bin_source_kernel = 1,
	fw_bin_source_external = 2,
};

/* Callback functions */
#if MIP_USE_CALLBACK
extern struct mip4_tk_callbacks *mip4_tk_inform_callbacks;

struct mip4_tk_callbacks {
	void (*inform_charger) (struct mip4_tk_callbacks *, int);
	/* void (*inform_display) (struct mip4_tk_callbacks *, int);
	... */
};
#endif

/*
 * Device info structure
 */
struct mip4_tk_info {
	struct i2c_client *client;
	struct input_dev *input_dev;
	struct mip4_tk_platform_data *pdata;
	char phys[32];
	dev_t mip4_tk_dev;
	struct class *class;
	struct mutex lock;
	struct mutex device;
	int irq;

#ifdef CONFIG_HAS_EARLYSUSPEND
	struct early_suspend early_suspend;
#endif

	struct regulator *pwr_reg;
	struct regulator *bus_reg;
	struct regulator *regulator_led;

	int pwr_en_gpio;
	int bus_en_gpio;

	bool boot_on_ldo;

	struct pinctrl *pinctrl;
	struct pinctrl_state *pins_default;
	struct pinctrl_state *pins_sleep;

	bool init;
	bool enabled;
	bool irq_enabled;
	int power;

	char *fw_path_ext;
	int firmware_state;

	u8 product_name[16];
	u8 node_key;
	u8 fw_version[8];

	u8 event_size;
	int event_format;

	unsigned int key_num;
	int key_code[MAX_KEY_NUM];
	bool key_code_loaded;

	unsigned int led_num;
	unsigned int led_max_brightness;

	u8 glove_mode;
	u8 charger_mode;

	u8 esd_cnt;
	bool disable_esd;

	u8 *print_buf;
	int *image_buf;

	bool test_busy;
	bool cmd_busy;
	bool dev_busy;

#if MIP_USE_CMD
	struct device *key_dev;
#endif

#if MIP_USE_DEV
	struct cdev cdev;
	u8 *dev_fs_buf;
#endif

#if MIP_USE_CALLBACK
	void (*register_callback)(void *);
	struct mip4_tk_callbacks callbacks;
#endif
#ifdef OPEN_CLOSE_WORK
	struct delayed_work resume_work;
#endif
};

/*
 * Function declarations
 */
void mip4_tk_reboot(struct mip4_tk_info *info);
int mip4_tk_i2c_read(struct mip4_tk_info *info, char *write_buf, unsigned int write_len, char *read_buf, unsigned int read_len);
int mip4_tk_i2c_read_next(struct mip4_tk_info *info, char *write_buf, unsigned int write_len, char *read_buf, int start_idx, unsigned int read_len);
int mip4_tk_i2c_write(struct mip4_tk_info *info, char *write_buf, unsigned int write_len);
int mip4_tk_enable(struct mip4_tk_info *info);
int mip4_tk_disable(struct mip4_tk_info *info);
int mip4_tk_get_ready_status(struct mip4_tk_info *info);
int mip4_tk_get_fw_version(struct mip4_tk_info *info, u8 *ver_buf);
int mip4_tk_get_fw_version_u16(struct mip4_tk_info *info, u16 *ver_buf_u16);
int mip4_tk_get_fw_version_from_bin(struct mip4_tk_info *info, u8 *ver_buf);
int mip4_tk_set_power_state(struct mip4_tk_info *info, u8 mode);
int mip4_tk_disable_esd_alert(struct mip4_tk_info *info);
int mip4_tk_fw_update_from_kernel(struct mip4_tk_info *info, bool force);
int mip4_tk_fw_update_from_storage(struct mip4_tk_info *info, char *path, bool force);
int mip4_tk_init_config(struct mip4_tk_info *info);
int mip4_tk_suspend(struct device *dev);
int mip4_tk_resume(struct device *dev);
#ifdef CONFIG_HAS_EARLYSUSPEND
void mip4_tk_early_suspend(struct early_suspend *h);
void mip4_tk_late_resume(struct early_suspend *h);
#endif

/* mod */
int mip4_tk_regulator_control(struct mip4_tk_info *info, int enable);
int mip4_tk_power_on(struct mip4_tk_info *info);
int mip4_tk_power_off(struct mip4_tk_info *info);
void mip4_tk_clear_input(struct mip4_tk_info *info);
void mip4_tk_input_event_handler(struct mip4_tk_info *info, u8 sz, u8 *buf);
#ifdef CONFIG_OF
int mip4_tk_parse_devicetree(struct device *dev, struct mip4_tk_info *info);
#endif
void mip4_tk_config_input(struct mip4_tk_info *info);
#if MIP_USE_CALLBACK
void mip4_tk_config_callback(struct mip4_tk_info *info);
#endif

/* firmware */
int mip4_tk_flash_fw(struct mip4_tk_info *info, const u8 *fw_data, size_t fw_size, bool force, bool section);
int mip4_tk_bin_fw_version(struct mip4_tk_info *info, const u8 *fw_data, size_t fw_size, u8 *ver_buf);

/* debug */
#if MIP_USE_DEV
int mip4_tk_dev_create(struct mip4_tk_info *info);
#endif
#if MIP_USE_SYS || MIP_USE_CMD
int mip4_tk_run_test(struct mip4_tk_info *info, u8 test_type);
int mip4_tk_get_image(struct mip4_tk_info *info, u8 image_type);
#endif
#if MIP_USE_SYS
int mip4_tk_sysfs_create(struct mip4_tk_info *info);
void mip4_tk_sysfs_remove(struct mip4_tk_info *info);
static const struct attribute_group mip4_tk_test_attr_group;
#endif

/* cmd */
#if MIP_USE_CMD
int mip4_tk_sysfs_cmd_create(struct mip4_tk_info *info);
void mip4_tk_sysfs_cmd_remove(struct mip4_tk_info *info);
static const struct attribute_group mip4_tk_cmd_attr_group;
#endif

#endif