Merge "input: synaptics_dsx: Add support for synaptics_dsx touch"

#

# Synaptics DSX touchscreen driver configuration

#

menuconfig TOUCHSCREEN_SYNAPTICS_DSX

	bool "Synaptics DSX touchscreen"

	default y

	help

	  Say Y here if you have a Synaptics DSX touchscreen connected

	  to your system.

	  If unsure, say N.

if TOUCHSCREEN_SYNAPTICS_DSX

choice

	default TOUCHSCREEN_SYNAPTICS_DSX_I2C

	prompt "Synaptics DSX touchscreen bus interface"

config TOUCHSCREEN_SYNAPTICS_DSX_I2C

	bool "I2C"

	depends on I2C

config TOUCHSCREEN_SYNAPTICS_DSX_SPI

	bool "SPI"

	depends on SPI_MASTER

endchoice

config TOUCHSCREEN_SYNAPTICS_DSX_CORE

	tristate "Synaptics DSX core driver module"

	depends on TOUCHSCREEN_SYNAPTICS_DSX_I2C || TOUCHSCREEN_SYNAPTICS_DSX_SPI

	help

	  Say Y here to enable basic touch reporting functionalities.

	  If unsure, say N.

	  To compile this driver as a module, choose M here: the

	  module will be called synaptics_dsx_core.

config TOUCHSCREEN_SYNAPTICS_DSX_RMI_DEV

	tristate "Synaptics DSX touchscreen RMI device module"

	depends on TOUCHSCREEN_SYNAPTICS_DSX_CORE

	help

	  Say Y here to enable support for direct RMI register access.

	  If unsure, say N.

	  To compile this driver as a module, choose M here: the

	  module will be called synaptics_dsx_rmi_dev.

config TOUCHSCREEN_SYNAPTICS_DSX_FW_UPDATE

	tristate "Synaptics DSX touchscreen firmware update module"

	depends on TOUCHSCREEN_SYNAPTICS_DSX_CORE

	help

	  Say Y here to enable support for carrying out firmware update.

	  If unsure, say N.

	  To compile this driver as a module, choose M here: the

	  module will be called synaptics_dsx_fw_update.

config TOUCHSCREEN_SYNAPTICS_DSX_PROXIMITY

	tristate "Synaptics DSX touchscreen proximity module"

	depends on TOUCHSCREEN_SYNAPTICS_DSX_CORE

	help

	  Say Y here to enable support for proximity functionalities.

	  If unsure, say N.

	  To compile this driver as a module, choose M here: the

	  module will be called synaptics_dsx_proximity.

endif

#

# Makefile for the Synaptics DSX touchscreen driver.

#

# Each configuration option enables a list of files.

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_I2C) += synaptics_dsx_i2c.o

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_SPI) += synaptics_dsx_spi.o

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_CORE) += synaptics_dsx_core.o

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_RMI_DEV) += synaptics_dsx_rmi_dev.o

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_FW_UPDATE) += synaptics_dsx_fw_update.o

obj-$(CONFIG_TOUCHSCREEN_SYNAPTICS_DSX_PROXIMITY) += synaptics_dsx_proximity.o

/*

 * Synaptics DSX touchscreen driver

 *

 * Copyright (C) 2012 Synaptics Incorporated

 *

 * Copyright (C) 2012 Alexandra Chin <alexandra.chin@tw.synaptics.com>

 * Copyright (C) 2012 Scott Lin <scott.lin@tw.synaptics.com>

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 */

#ifndef _SYNAPTICS_DSX_RMI4_H_

#define _SYNAPTICS_DSX_RMI4_H_

#define SYNAPTICS_DS4 (1 << 0)

#define SYNAPTICS_DS5 (1 << 1)

#define SYNAPTICS_DSX_DRIVER_PRODUCT (SYNAPTICS_DS4 | SYNAPTICS_DS5)

#define SYNAPTICS_DSX_DRIVER_VERSION 0x2001

#include <linux/version.h>

#ifdef CONFIG_HAS_EARLYSUSPEND

#include <linux/earlysuspend.h>

#endif

#if (LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 38))

#define KERNEL_ABOVE_2_6_38

#endif

#ifdef KERNEL_ABOVE_2_6_38

#define sstrtoul(...) kstrtoul(__VA_ARGS__)

#else

#define sstrtoul(...) strict_strtoul(__VA_ARGS__)

#endif

#define PDT_PROPS (0X00EF)

#define PDT_START (0x00E9)

#define PDT_END (0x00D0)

#define PDT_ENTRY_SIZE (0x0006)

#define PAGES_TO_SERVICE (10)

#define PAGE_SELECT_LEN (2)

#define ADDRESS_WORD_LEN (2)

#define SYNAPTICS_RMI4_F01 (0x01)

#define SYNAPTICS_RMI4_F11 (0x11)

#define SYNAPTICS_RMI4_F12 (0x12)

#define SYNAPTICS_RMI4_F1A (0x1a)

#define SYNAPTICS_RMI4_F34 (0x34)

#define SYNAPTICS_RMI4_F51 (0x51)

#define SYNAPTICS_RMI4_F54 (0x54)

#define SYNAPTICS_RMI4_F55 (0x55)

#define SYNAPTICS_RMI4_PRODUCT_INFO_SIZE 2

#define SYNAPTICS_RMI4_DATE_CODE_SIZE 3

#define SYNAPTICS_RMI4_PRODUCT_ID_SIZE 10

#define SYNAPTICS_RMI4_BUILD_ID_SIZE 3

#define F12_FINGERS_TO_SUPPORT 10

#define F12_NO_OBJECT_STATUS 0x00

#define F12_FINGER_STATUS 0x01

#define F12_STYLUS_STATUS 0x02

#define F12_PALM_STATUS 0x03

#define F12_HOVERING_FINGER_STATUS 0x05

#define F12_GLOVED_FINGER_STATUS 0x06

#define MAX_NUMBER_OF_BUTTONS 4

#define MAX_INTR_REGISTERS 4

#define MASK_16BIT 0xFFFF

#define MASK_8BIT 0xFF

#define MASK_7BIT 0x7F

#define MASK_6BIT 0x3F

#define MASK_5BIT 0x1F

#define MASK_4BIT 0x0F

#define MASK_3BIT 0x07

#define MASK_2BIT 0x03

#define MASK_1BIT 0x01

enum exp_fn {

	RMI_DEV = 0,

	RMI_F54,

	RMI_FW_UPDATER,

	RMI_PROXIMITY,

	RMI_ACTIVE_PEN,

	RMI_LAST,

};

struct synaptics_dsx_hw_interface {

	const struct synaptics_dsx_board_data *board_data;

	const struct synaptics_dsx_bus_access *bus_access;

};

/*

 * struct synaptics_rmi4_fn_desc - function descriptor fields in PDT

 * @query_base_addr: base address for query registers

 * @cmd_base_addr: base address for command registers

 * @ctrl_base_addr: base address for control registers

 * @data_base_addr: base address for data registers

 * @intr_src_count: number of interrupt sources

 * @fn_number: function number

 */

struct synaptics_rmi4_fn_desc {

	unsigned char query_base_addr;

	unsigned char cmd_base_addr;

	unsigned char ctrl_base_addr;

	unsigned char data_base_addr;

	unsigned char intr_src_count;

	unsigned char fn_number;

};

/*

 * synaptics_rmi4_fn_full_addr - full 16-bit base addresses

 * @query_base: 16-bit base address for query registers

 * @cmd_base: 16-bit base address for data registers

 * @ctrl_base: 16-bit base address for command registers

 * @data_base: 16-bit base address for control registers

 */

struct synaptics_rmi4_fn_full_addr {

	unsigned short query_base;

	unsigned short cmd_base;

	unsigned short ctrl_base;

	unsigned short data_base;

};

struct synaptics_rmi4_f12_extra_data {

	unsigned char data1_offset;

	unsigned char data15_offset;

	unsigned char data15_size;

	unsigned char data15_data[(F12_FINGERS_TO_SUPPORT + 7) / 8];

};

/*

 * struct synaptics_rmi4_fn - function handler data structure

 * @fn_number: function number

 * @num_of_data_sources: number of data sources

 * @num_of_data_points: maximum number of fingers supported

 * @size_of_data_register_block: data register block size

 * @intr_reg_num: index to associated interrupt register

 * @intr_mask: interrupt mask

 * @full_addr: full 16-bit base addresses of function registers

 * @link: linked list for function handlers

 * @data_size: size of private data

 * @data: pointer to private data

 */

struct synaptics_rmi4_fn {

	unsigned char fn_number;

	unsigned char num_of_data_sources;

	unsigned char num_of_data_points;

	unsigned char size_of_data_register_block;

	unsigned char intr_reg_num;

	unsigned char intr_mask;

	struct synaptics_rmi4_fn_full_addr full_addr;

	struct list_head link;

	int data_size;

	void *data;

	void *extra;

};

/*

 * struct synaptics_rmi4_device_info - device information

 * @version_major: rmi protocol major version number

 * @version_minor: rmi protocol minor version number

 * @manufacturer_id: manufacturer id

 * @product_props: product properties information

 * @product_info: product info array

 * @date_code: device manufacture date

 * @tester_id: tester id array

 * @serial_number: device serial number

 * @product_id_string: device product id

 * @support_fn_list: linked list for function handlers

 */

struct synaptics_rmi4_device_info {

	unsigned int version_major;

	unsigned int version_minor;

	unsigned char manufacturer_id;

	unsigned char product_props;

	unsigned char product_info[SYNAPTICS_RMI4_PRODUCT_INFO_SIZE];

	unsigned char date_code[SYNAPTICS_RMI4_DATE_CODE_SIZE];

	unsigned short tester_id;

	unsigned short serial_number;

	unsigned char product_id_string[SYNAPTICS_RMI4_PRODUCT_ID_SIZE + 1];

	unsigned char build_id[SYNAPTICS_RMI4_BUILD_ID_SIZE];

	struct list_head support_fn_list;

};

/*

 * struct synaptics_rmi4_data - rmi4 device instance data

 * @pdev: pointer to platform device

 * @input_dev: pointer to associated input device

 * @hw_if: pointer to hardware interface data

 * @rmi4_mod_info: device information

 * @regulator: pointer to associated regulator

 * @rmi4_io_ctrl_mutex: mutex for i2c i/o control

 * @early_suspend: instance to support early suspend power management

 * @current_page: current page in sensor to acess

 * @button_0d_enabled: flag for 0d button support

 * @full_pm_cycle: flag for full power management cycle in early suspend stage

 * @num_of_intr_regs: number of interrupt registers

 * @f01_query_base_addr: query base address for f01

 * @f01_cmd_base_addr: command base address for f01

 * @f01_ctrl_base_addr: control base address for f01

 * @f01_data_base_addr: data base address for f01

 * @irq: attention interrupt

 * @sensor_max_x: sensor maximum x value

 * @sensor_max_y: sensor maximum y value

 * @irq_enabled: flag for indicating interrupt enable status

 * @fingers_on_2d: flag to indicate presence of fingers in 2d area

 * @sensor_sleep: flag to indicate sleep state of sensor

 * @wait: wait queue for touch data polling in interrupt thread

 * @irq_enable: pointer to irq enable function

 */

struct synaptics_rmi4_data {

	struct platform_device *pdev;

	struct input_dev *input_dev;

	const struct synaptics_dsx_hw_interface *hw_if;

	struct synaptics_rmi4_device_info rmi4_mod_info;

	struct regulator *regulator;

	struct mutex rmi4_reset_mutex;

	struct mutex rmi4_io_ctrl_mutex;

#ifdef CONFIG_HAS_EARLYSUSPEND

	struct early_suspend early_suspend;

#endif

	unsigned char current_page;

	unsigned char button_0d_enabled;

	unsigned char full_pm_cycle;

	unsigned char num_of_rx;

	unsigned char num_of_tx;

	unsigned char num_of_fingers;

	unsigned char max_touch_width;

	unsigned char report_enable;

	unsigned char no_sleep_setting;

	unsigned char intr_mask[MAX_INTR_REGISTERS];

	unsigned char *button_txrx_mapping;

	unsigned short num_of_intr_regs;

	unsigned short f01_query_base_addr;

	unsigned short f01_cmd_base_addr;

	unsigned short f01_ctrl_base_addr;

	unsigned short f01_data_base_addr;

	unsigned int firmware_id;

	int irq;

	int sensor_max_x;

	int sensor_max_y;

	bool flash_prog_mode;

	bool irq_enabled;

	bool touch_stopped;

	bool fingers_on_2d;

	bool sensor_sleep;

	bool stay_awake;

	bool staying_awake;

	int (*irq_enable)(struct synaptics_rmi4_data *rmi4_data, bool enable);

	int (*reset_device)(struct synaptics_rmi4_data *rmi4_data);

};

struct synaptics_dsx_bus_access {

	unsigned char type;

	int (*read)(struct synaptics_rmi4_data *rmi4_data, unsigned short addr,

		unsigned char *data, unsigned short length);

	int (*write)(struct synaptics_rmi4_data *rmi4_data, unsigned short addr,

		unsigned char *data, unsigned short length);

};

struct synaptics_rmi4_exp_fn {

	enum exp_fn fn_type;

	int (*init)(struct synaptics_rmi4_data *rmi4_data);

	void (*remove)(struct synaptics_rmi4_data *rmi4_data);

	void (*reset)(struct synaptics_rmi4_data *rmi4_data);

	void (*reinit)(struct synaptics_rmi4_data *rmi4_data);

	void (*early_suspend)(struct synaptics_rmi4_data *rmi4_data);

	void (*suspend)(struct synaptics_rmi4_data *rmi4_data);

	void (*resume)(struct synaptics_rmi4_data *rmi4_data);

	void (*late_resume)(struct synaptics_rmi4_data *rmi4_data);

	void (*attn)(struct synaptics_rmi4_data *rmi4_data,

			unsigned char intr_mask);

};

int synaptics_rmi4_bus_init(void);

void synaptics_rmi4_bus_exit(void);

void synaptics_rmi4_new_function(struct synaptics_rmi4_exp_fn *exp_fn_module,

		bool insert);

int synaptics_fw_updater(unsigned char *fw_data);

static inline int synaptics_rmi4_reg_read(

		struct synaptics_rmi4_data *rmi4_data,

		unsigned short addr,

		unsigned char *data,

		unsigned short len)

{

	return rmi4_data->hw_if->bus_access->read(rmi4_data, addr, data, len);

}

static inline int synaptics_rmi4_reg_write(

		struct synaptics_rmi4_data *rmi4_data,

		unsigned short addr,

		unsigned char *data,

		unsigned short len)

{

	return rmi4_data->hw_if->bus_access->write(rmi4_data, addr, data, len);

}

static inline ssize_t synaptics_rmi4_show_error(struct device *dev,

		struct device_attribute *attr, char *buf)

{

	dev_warn(dev, "%s Attempted to read from write-only attribute %s\n",

			__func__, attr->attr.name);

	return -EPERM;

}

static inline ssize_t synaptics_rmi4_store_error(struct device *dev,

		struct device_attribute *attr, const char *buf, size_t count)

{

	dev_warn(dev, "%s Attempted to write to read-only attribute %s\n",

			__func__, attr->attr.name);

	return -EPERM;

}

static inline void batohs(unsigned short *dest, unsigned char *src)

{

	*dest = src[1] * 0x100 + src[0];

}

static inline void hstoba(unsigned char *dest, unsigned short src)

{

	dest[0] = src % 0x100;

	dest[1] = src / 0x100;

}

#endif