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