1 /* -------------------------------------------------------------------------
2 * Copyright (C) 2014-2015, Intel Corporation
6 * Copyright (C) 2010-2015, Shanghai Sileadinc Co.Ltd
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 * -------------------------------------------------------------------------
20 #include <linux/i2c.h>
21 #include <linux/module.h>
22 #include <linux/acpi.h>
23 #include <linux/interrupt.h>
24 #include <linux/gpio/consumer.h>
25 #include <linux/delay.h>
26 #include <linux/firmware.h>
27 #include <linux/input.h>
28 #include <linux/input/mt.h>
29 #include <linux/input/touchscreen.h>
31 #include <linux/irq.h>
33 #include <asm/unaligned.h>
35 #define SILEAD_TS_NAME "silead_ts"
37 #define SILEAD_REG_RESET 0xE0
38 #define SILEAD_REG_DATA 0x80
39 #define SILEAD_REG_TOUCH_NR 0x80
40 #define SILEAD_REG_POWER 0xBC
41 #define SILEAD_REG_CLOCK 0xE4
42 #define SILEAD_REG_STATUS 0xB0
43 #define SILEAD_REG_ID 0xFC
44 #define SILEAD_REG_MEM_CHECK 0xB0
46 #define SILEAD_STATUS_OK 0x5A5A5A5A
47 #define SILEAD_TS_DATA_LEN 44
48 #define SILEAD_CLOCK 0x04
50 #define SILEAD_CMD_RESET 0x88
51 #define SILEAD_CMD_START 0x00
53 #define SILEAD_POINT_DATA_LEN 0x04
54 #define SILEAD_POINT_Y_OFF 0x00
55 #define SILEAD_POINT_Y_MSB_OFF 0x01
56 #define SILEAD_POINT_X_OFF 0x02
57 #define SILEAD_POINT_X_MSB_OFF 0x03
58 #define SILEAD_TOUCH_ID_MASK 0xF0
60 #define SILEAD_CMD_SLEEP_MIN 10000
61 #define SILEAD_CMD_SLEEP_MAX 20000
62 #define SILEAD_POWER_SLEEP 20
63 #define SILEAD_STARTUP_SLEEP 30
65 #define SILEAD_MAX_FINGERS 10
67 enum silead_ts_power
{
72 struct silead_ts_data
{
73 struct i2c_client
*client
;
74 struct gpio_desc
*gpio_power
;
75 struct input_dev
*input
;
77 struct touchscreen_properties prop
;
80 struct input_mt_pos pos
[SILEAD_MAX_FINGERS
];
81 int slots
[SILEAD_MAX_FINGERS
];
82 int id
[SILEAD_MAX_FINGERS
];
85 struct silead_fw_data
{
90 static int silead_ts_request_input_dev(struct silead_ts_data
*data
)
92 struct device
*dev
= &data
->client
->dev
;
95 data
->input
= devm_input_allocate_device(dev
);
98 "Failed to allocate input device\n");
102 input_set_abs_params(data
->input
, ABS_MT_POSITION_X
, 0, 4095, 0, 0);
103 input_set_abs_params(data
->input
, ABS_MT_POSITION_Y
, 0, 4095, 0, 0);
104 touchscreen_parse_properties(data
->input
, true, &data
->prop
);
106 input_mt_init_slots(data
->input
, data
->max_fingers
,
107 INPUT_MT_DIRECT
| INPUT_MT_DROP_UNUSED
|
110 data
->input
->name
= SILEAD_TS_NAME
;
111 data
->input
->phys
= "input/ts";
112 data
->input
->id
.bustype
= BUS_I2C
;
114 error
= input_register_device(data
->input
);
116 dev_err(dev
, "Failed to register input device: %d\n", error
);
123 static void silead_ts_set_power(struct i2c_client
*client
,
124 enum silead_ts_power state
)
126 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
128 if (data
->gpio_power
) {
129 gpiod_set_value_cansleep(data
->gpio_power
, state
);
130 msleep(SILEAD_POWER_SLEEP
);
134 static void silead_ts_read_data(struct i2c_client
*client
)
136 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
137 struct input_dev
*input
= data
->input
;
138 struct device
*dev
= &client
->dev
;
139 u8
*bufp
, buf
[SILEAD_TS_DATA_LEN
];
140 int touch_nr
, error
, i
;
142 error
= i2c_smbus_read_i2c_block_data(client
, SILEAD_REG_DATA
,
143 SILEAD_TS_DATA_LEN
, buf
);
145 dev_err(dev
, "Data read error %d\n", error
);
153 if (touch_nr
> data
->max_fingers
) {
154 dev_warn(dev
, "More touches reported then supported %d > %d\n",
155 touch_nr
, data
->max_fingers
);
156 touch_nr
= data
->max_fingers
;
159 bufp
= buf
+ SILEAD_POINT_DATA_LEN
;
160 for (i
= 0; i
< touch_nr
; i
++, bufp
+= SILEAD_POINT_DATA_LEN
) {
161 /* Bits 4-7 are the touch id */
162 data
->id
[i
] = (bufp
[SILEAD_POINT_X_MSB_OFF
] &
163 SILEAD_TOUCH_ID_MASK
) >> 4;
164 touchscreen_set_mt_pos(&data
->pos
[i
], &data
->prop
,
165 get_unaligned_le16(&bufp
[SILEAD_POINT_X_OFF
]) & 0xfff,
166 get_unaligned_le16(&bufp
[SILEAD_POINT_Y_OFF
]) & 0xfff);
169 input_mt_assign_slots(input
, data
->slots
, data
->pos
, touch_nr
, 0);
171 for (i
= 0; i
< touch_nr
; i
++) {
172 input_mt_slot(input
, data
->slots
[i
]);
173 input_mt_report_slot_state(input
, MT_TOOL_FINGER
, true);
174 input_report_abs(input
, ABS_MT_POSITION_X
, data
->pos
[i
].x
);
175 input_report_abs(input
, ABS_MT_POSITION_Y
, data
->pos
[i
].y
);
177 dev_dbg(dev
, "x=%d y=%d hw_id=%d sw_id=%d\n", data
->pos
[i
].x
,
178 data
->pos
[i
].y
, data
->id
[i
], data
->slots
[i
]);
181 input_mt_sync_frame(input
);
185 static int silead_ts_init(struct i2c_client
*client
)
187 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
190 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_RESET
,
194 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
196 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_TOUCH_NR
,
200 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
202 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_CLOCK
,
206 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
208 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_RESET
,
212 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
217 dev_err(&client
->dev
, "Registers clear error %d\n", error
);
221 static int silead_ts_reset(struct i2c_client
*client
)
225 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_RESET
,
229 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
231 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_CLOCK
,
235 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
237 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_POWER
,
241 usleep_range(SILEAD_CMD_SLEEP_MIN
, SILEAD_CMD_SLEEP_MAX
);
246 dev_err(&client
->dev
, "Chip reset error %d\n", error
);
250 static int silead_ts_startup(struct i2c_client
*client
)
254 error
= i2c_smbus_write_byte_data(client
, SILEAD_REG_RESET
, 0x00);
256 dev_err(&client
->dev
, "Startup error %d\n", error
);
260 msleep(SILEAD_STARTUP_SLEEP
);
265 static int silead_ts_load_fw(struct i2c_client
*client
)
267 struct device
*dev
= &client
->dev
;
268 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
269 unsigned int fw_size
, i
;
270 const struct firmware
*fw
;
271 struct silead_fw_data
*fw_data
;
274 dev_dbg(dev
, "Firmware file name: %s", data
->fw_name
);
276 error
= request_firmware(&fw
, data
->fw_name
, dev
);
278 dev_err(dev
, "Firmware request error %d\n", error
);
282 fw_size
= fw
->size
/ sizeof(*fw_data
);
283 fw_data
= (struct silead_fw_data
*)fw
->data
;
285 for (i
= 0; i
< fw_size
; i
++) {
286 error
= i2c_smbus_write_i2c_block_data(client
,
289 (u8
*)&fw_data
[i
].val
);
291 dev_err(dev
, "Firmware load error %d\n", error
);
296 release_firmware(fw
);
300 static u32
silead_ts_get_status(struct i2c_client
*client
)
305 error
= i2c_smbus_read_i2c_block_data(client
, SILEAD_REG_STATUS
,
306 sizeof(status
), (u8
*)&status
);
308 dev_err(&client
->dev
, "Status read error %d\n", error
);
312 return le32_to_cpu(status
);
315 static int silead_ts_get_id(struct i2c_client
*client
)
317 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
321 error
= i2c_smbus_read_i2c_block_data(client
, SILEAD_REG_ID
,
322 sizeof(chip_id
), (u8
*)&chip_id
);
324 dev_err(&client
->dev
, "Chip ID read error %d\n", error
);
328 data
->chip_id
= le32_to_cpu(chip_id
);
329 dev_info(&client
->dev
, "Silead chip ID: 0x%8X", data
->chip_id
);
334 static int silead_ts_setup(struct i2c_client
*client
)
339 silead_ts_set_power(client
, SILEAD_POWER_OFF
);
340 silead_ts_set_power(client
, SILEAD_POWER_ON
);
342 error
= silead_ts_get_id(client
);
346 error
= silead_ts_init(client
);
350 error
= silead_ts_reset(client
);
354 error
= silead_ts_load_fw(client
);
358 error
= silead_ts_startup(client
);
362 status
= silead_ts_get_status(client
);
363 if (status
!= SILEAD_STATUS_OK
) {
364 dev_err(&client
->dev
,
365 "Initialization error, status: 0x%X\n", status
);
372 static irqreturn_t
silead_ts_threaded_irq_handler(int irq
, void *id
)
374 struct silead_ts_data
*data
= id
;
375 struct i2c_client
*client
= data
->client
;
377 silead_ts_read_data(client
);
382 static void silead_ts_read_props(struct i2c_client
*client
)
384 struct silead_ts_data
*data
= i2c_get_clientdata(client
);
385 struct device
*dev
= &client
->dev
;
389 error
= device_property_read_u32(dev
, "silead,max-fingers",
392 dev_dbg(dev
, "Max fingers read error %d\n", error
);
393 data
->max_fingers
= 5; /* Most devices handle up-to 5 fingers */
396 error
= device_property_read_string(dev
, "touchscreen-fw-name", &str
);
398 snprintf(data
->fw_name
, sizeof(data
->fw_name
), "%s", str
);
400 dev_dbg(dev
, "Firmware file name read error. Using default.");
404 static int silead_ts_set_default_fw_name(struct silead_ts_data
*data
,
405 const struct i2c_device_id
*id
)
407 const struct acpi_device_id
*acpi_id
;
408 struct device
*dev
= &data
->client
->dev
;
411 if (ACPI_HANDLE(dev
)) {
412 acpi_id
= acpi_match_device(dev
->driver
->acpi_match_table
, dev
);
416 snprintf(data
->fw_name
, sizeof(data
->fw_name
), "%s.fw",
419 for (i
= 0; i
< strlen(data
->fw_name
); i
++)
420 data
->fw_name
[i
] = tolower(data
->fw_name
[i
]);
422 snprintf(data
->fw_name
, sizeof(data
->fw_name
), "%s.fw",
429 static int silead_ts_set_default_fw_name(struct silead_ts_data
*data
,
430 const struct i2c_device_id
*id
)
432 snprintf(data
->fw_name
, sizeof(data
->fw_name
), "%s.fw", id
->name
);
437 static int silead_ts_probe(struct i2c_client
*client
,
438 const struct i2c_device_id
*id
)
440 struct silead_ts_data
*data
;
441 struct device
*dev
= &client
->dev
;
444 if (!i2c_check_functionality(client
->adapter
,
446 I2C_FUNC_SMBUS_READ_I2C_BLOCK
|
447 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK
)) {
448 dev_err(dev
, "I2C functionality check failed\n");
452 data
= devm_kzalloc(dev
, sizeof(*data
), GFP_KERNEL
);
456 i2c_set_clientdata(client
, data
);
457 data
->client
= client
;
459 error
= silead_ts_set_default_fw_name(data
, id
);
463 silead_ts_read_props(client
);
465 /* We must have the IRQ provided by DT or ACPI subsytem */
466 if (client
->irq
<= 0)
470 data
->gpio_power
= gpiod_get_optional(dev
, "power", GPIOD_OUT_LOW
);
471 if (IS_ERR(data
->gpio_power
)) {
472 if (PTR_ERR(data
->gpio_power
) != -EPROBE_DEFER
)
473 dev_err(dev
, "Shutdown GPIO request failed\n");
474 return PTR_ERR(data
->gpio_power
);
477 error
= silead_ts_setup(client
);
481 error
= silead_ts_request_input_dev(data
);
485 error
= devm_request_threaded_irq(dev
, client
->irq
,
486 NULL
, silead_ts_threaded_irq_handler
,
487 IRQF_ONESHOT
, client
->name
, data
);
489 if (error
!= -EPROBE_DEFER
)
490 dev_err(dev
, "IRQ request failed %d\n", error
);
497 static int __maybe_unused
silead_ts_suspend(struct device
*dev
)
499 struct i2c_client
*client
= to_i2c_client(dev
);
501 silead_ts_set_power(client
, SILEAD_POWER_OFF
);
505 static int __maybe_unused
silead_ts_resume(struct device
*dev
)
507 struct i2c_client
*client
= to_i2c_client(dev
);
510 silead_ts_set_power(client
, SILEAD_POWER_ON
);
512 error
= silead_ts_reset(client
);
516 error
= silead_ts_startup(client
);
520 status
= silead_ts_get_status(client
);
521 if (status
!= SILEAD_STATUS_OK
) {
522 dev_err(dev
, "Resume error, status: 0x%02x\n", status
);
529 static SIMPLE_DEV_PM_OPS(silead_ts_pm
, silead_ts_suspend
, silead_ts_resume
);
531 static const struct i2c_device_id silead_ts_id
[] = {
540 MODULE_DEVICE_TABLE(i2c
, silead_ts_id
);
543 static const struct acpi_device_id silead_ts_acpi_match
[] = {
552 MODULE_DEVICE_TABLE(acpi
, silead_ts_acpi_match
);
555 static struct i2c_driver silead_ts_driver
= {
556 .probe
= silead_ts_probe
,
557 .id_table
= silead_ts_id
,
559 .name
= SILEAD_TS_NAME
,
560 .acpi_match_table
= ACPI_PTR(silead_ts_acpi_match
),
564 module_i2c_driver(silead_ts_driver
);
566 MODULE_AUTHOR("Robert Dolca <robert.dolca@intel.com>");
567 MODULE_DESCRIPTION("Silead I2C touchscreen driver");
568 MODULE_LICENSE("GPL");