xref: /openbmc/linux/drivers/hid/i2c-hid/i2c-hid-of-elan.c (revision bd3cba00dcc639311c29eee81606707ba5fd9217)
1*bd3cba00SDouglas Anderson // SPDX-License-Identifier: GPL-2.0
2*bd3cba00SDouglas Anderson /*
3*bd3cba00SDouglas Anderson  * Driver for Elan touchscreens that use the i2c-hid protocol.
4*bd3cba00SDouglas Anderson  *
5*bd3cba00SDouglas Anderson  * Copyright 2020 Google LLC
6*bd3cba00SDouglas Anderson  */
7*bd3cba00SDouglas Anderson 
8*bd3cba00SDouglas Anderson #include <linux/delay.h>
9*bd3cba00SDouglas Anderson #include <linux/device.h>
10*bd3cba00SDouglas Anderson #include <linux/gpio/consumer.h>
11*bd3cba00SDouglas Anderson #include <linux/i2c.h>
12*bd3cba00SDouglas Anderson #include <linux/kernel.h>
13*bd3cba00SDouglas Anderson #include <linux/module.h>
14*bd3cba00SDouglas Anderson #include <linux/of.h>
15*bd3cba00SDouglas Anderson #include <linux/pm.h>
16*bd3cba00SDouglas Anderson #include <linux/regulator/consumer.h>
17*bd3cba00SDouglas Anderson 
18*bd3cba00SDouglas Anderson #include "i2c-hid.h"
19*bd3cba00SDouglas Anderson 
20*bd3cba00SDouglas Anderson struct elan_i2c_hid_chip_data {
21*bd3cba00SDouglas Anderson 	unsigned int post_gpio_reset_delay_ms;
22*bd3cba00SDouglas Anderson 	unsigned int post_power_delay_ms;
23*bd3cba00SDouglas Anderson 	u16 hid_descriptor_address;
24*bd3cba00SDouglas Anderson };
25*bd3cba00SDouglas Anderson 
26*bd3cba00SDouglas Anderson struct i2c_hid_of_elan {
27*bd3cba00SDouglas Anderson 	struct i2chid_ops ops;
28*bd3cba00SDouglas Anderson 
29*bd3cba00SDouglas Anderson 	struct regulator *vcc33;
30*bd3cba00SDouglas Anderson 	struct regulator *vccio;
31*bd3cba00SDouglas Anderson 	struct gpio_desc *reset_gpio;
32*bd3cba00SDouglas Anderson 	const struct elan_i2c_hid_chip_data *chip_data;
33*bd3cba00SDouglas Anderson };
34*bd3cba00SDouglas Anderson 
35*bd3cba00SDouglas Anderson static int elan_i2c_hid_power_up(struct i2chid_ops *ops)
36*bd3cba00SDouglas Anderson {
37*bd3cba00SDouglas Anderson 	struct i2c_hid_of_elan *ihid_elan =
38*bd3cba00SDouglas Anderson 		container_of(ops, struct i2c_hid_of_elan, ops);
39*bd3cba00SDouglas Anderson 	int ret;
40*bd3cba00SDouglas Anderson 
41*bd3cba00SDouglas Anderson 	ret = regulator_enable(ihid_elan->vcc33);
42*bd3cba00SDouglas Anderson 	if (ret)
43*bd3cba00SDouglas Anderson 		return ret;
44*bd3cba00SDouglas Anderson 
45*bd3cba00SDouglas Anderson 	ret = regulator_enable(ihid_elan->vccio);
46*bd3cba00SDouglas Anderson 	if (ret) {
47*bd3cba00SDouglas Anderson 		regulator_disable(ihid_elan->vcc33);
48*bd3cba00SDouglas Anderson 		return ret;
49*bd3cba00SDouglas Anderson 	}
50*bd3cba00SDouglas Anderson 
51*bd3cba00SDouglas Anderson 	if (ihid_elan->chip_data->post_power_delay_ms)
52*bd3cba00SDouglas Anderson 		msleep(ihid_elan->chip_data->post_power_delay_ms);
53*bd3cba00SDouglas Anderson 
54*bd3cba00SDouglas Anderson 	gpiod_set_value_cansleep(ihid_elan->reset_gpio, 0);
55*bd3cba00SDouglas Anderson 	if (ihid_elan->chip_data->post_gpio_reset_delay_ms)
56*bd3cba00SDouglas Anderson 		msleep(ihid_elan->chip_data->post_gpio_reset_delay_ms);
57*bd3cba00SDouglas Anderson 
58*bd3cba00SDouglas Anderson 	return 0;
59*bd3cba00SDouglas Anderson }
60*bd3cba00SDouglas Anderson 
61*bd3cba00SDouglas Anderson static void elan_i2c_hid_power_down(struct i2chid_ops *ops)
62*bd3cba00SDouglas Anderson {
63*bd3cba00SDouglas Anderson 	struct i2c_hid_of_elan *ihid_elan =
64*bd3cba00SDouglas Anderson 		container_of(ops, struct i2c_hid_of_elan, ops);
65*bd3cba00SDouglas Anderson 
66*bd3cba00SDouglas Anderson 	gpiod_set_value_cansleep(ihid_elan->reset_gpio, 1);
67*bd3cba00SDouglas Anderson 	regulator_disable(ihid_elan->vccio);
68*bd3cba00SDouglas Anderson 	regulator_disable(ihid_elan->vcc33);
69*bd3cba00SDouglas Anderson }
70*bd3cba00SDouglas Anderson 
71*bd3cba00SDouglas Anderson static int i2c_hid_of_elan_probe(struct i2c_client *client,
72*bd3cba00SDouglas Anderson 				 const struct i2c_device_id *id)
73*bd3cba00SDouglas Anderson {
74*bd3cba00SDouglas Anderson 	struct i2c_hid_of_elan *ihid_elan;
75*bd3cba00SDouglas Anderson 
76*bd3cba00SDouglas Anderson 	ihid_elan = devm_kzalloc(&client->dev, sizeof(*ihid_elan), GFP_KERNEL);
77*bd3cba00SDouglas Anderson 	if (!ihid_elan)
78*bd3cba00SDouglas Anderson 		return -ENOMEM;
79*bd3cba00SDouglas Anderson 
80*bd3cba00SDouglas Anderson 	ihid_elan->ops.power_up = elan_i2c_hid_power_up;
81*bd3cba00SDouglas Anderson 	ihid_elan->ops.power_down = elan_i2c_hid_power_down;
82*bd3cba00SDouglas Anderson 
83*bd3cba00SDouglas Anderson 	/* Start out with reset asserted */
84*bd3cba00SDouglas Anderson 	ihid_elan->reset_gpio =
85*bd3cba00SDouglas Anderson 		devm_gpiod_get_optional(&client->dev, "reset", GPIOD_OUT_HIGH);
86*bd3cba00SDouglas Anderson 	if (IS_ERR(ihid_elan->reset_gpio))
87*bd3cba00SDouglas Anderson 		return PTR_ERR(ihid_elan->reset_gpio);
88*bd3cba00SDouglas Anderson 
89*bd3cba00SDouglas Anderson 	ihid_elan->vccio = devm_regulator_get(&client->dev, "vccio");
90*bd3cba00SDouglas Anderson 	if (IS_ERR(ihid_elan->vccio))
91*bd3cba00SDouglas Anderson 		return PTR_ERR(ihid_elan->vccio);
92*bd3cba00SDouglas Anderson 
93*bd3cba00SDouglas Anderson 	ihid_elan->vcc33 = devm_regulator_get(&client->dev, "vcc33");
94*bd3cba00SDouglas Anderson 	if (IS_ERR(ihid_elan->vcc33))
95*bd3cba00SDouglas Anderson 		return PTR_ERR(ihid_elan->vcc33);
96*bd3cba00SDouglas Anderson 
97*bd3cba00SDouglas Anderson 	ihid_elan->chip_data = device_get_match_data(&client->dev);
98*bd3cba00SDouglas Anderson 
99*bd3cba00SDouglas Anderson 	return i2c_hid_core_probe(client, &ihid_elan->ops,
100*bd3cba00SDouglas Anderson 				  ihid_elan->chip_data->hid_descriptor_address, 0);
101*bd3cba00SDouglas Anderson }
102*bd3cba00SDouglas Anderson 
103*bd3cba00SDouglas Anderson static const struct elan_i2c_hid_chip_data elan_ekth6915_chip_data = {
104*bd3cba00SDouglas Anderson 	.post_power_delay_ms = 1,
105*bd3cba00SDouglas Anderson 	.post_gpio_reset_delay_ms = 300,
106*bd3cba00SDouglas Anderson 	.hid_descriptor_address = 0x0001,
107*bd3cba00SDouglas Anderson };
108*bd3cba00SDouglas Anderson 
109*bd3cba00SDouglas Anderson static const struct of_device_id elan_i2c_hid_of_match[] = {
110*bd3cba00SDouglas Anderson 	{ .compatible = "elan,ekth6915", .data = &elan_ekth6915_chip_data },
111*bd3cba00SDouglas Anderson 	{ }
112*bd3cba00SDouglas Anderson };
113*bd3cba00SDouglas Anderson MODULE_DEVICE_TABLE(of, elan_i2c_hid_of_match);
114*bd3cba00SDouglas Anderson 
115*bd3cba00SDouglas Anderson static struct i2c_driver elan_i2c_hid_ts_driver = {
116*bd3cba00SDouglas Anderson 	.driver = {
117*bd3cba00SDouglas Anderson 		.name	= "i2c_hid_of_elan",
118*bd3cba00SDouglas Anderson 		.pm	= &i2c_hid_core_pm,
119*bd3cba00SDouglas Anderson 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
120*bd3cba00SDouglas Anderson 		.of_match_table = of_match_ptr(elan_i2c_hid_of_match),
121*bd3cba00SDouglas Anderson 	},
122*bd3cba00SDouglas Anderson 	.probe		= i2c_hid_of_elan_probe,
123*bd3cba00SDouglas Anderson 	.remove		= i2c_hid_core_remove,
124*bd3cba00SDouglas Anderson 	.shutdown	= i2c_hid_core_shutdown,
125*bd3cba00SDouglas Anderson };
126*bd3cba00SDouglas Anderson module_i2c_driver(elan_i2c_hid_ts_driver);
127*bd3cba00SDouglas Anderson 
128*bd3cba00SDouglas Anderson MODULE_AUTHOR("Douglas Anderson <dianders@chromium.org>");
129*bd3cba00SDouglas Anderson MODULE_DESCRIPTION("Elan i2c-hid touchscreen driver");
130*bd3cba00SDouglas Anderson MODULE_LICENSE("GPL");
131