xref: /linux/drivers/input/misc/da9063_onkey.c (revision 4dd10fbbeb9c33709edc89916e19c03c780a0751)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * OnKey device driver for DA9063, DA9062 and DA9061 PMICs
4  * Copyright (C) 2015  Dialog Semiconductor Ltd.
5  */
6 
7 #include <linux/devm-helpers.h>
8 #include <linux/module.h>
9 #include <linux/errno.h>
10 #include <linux/input.h>
11 #include <linux/interrupt.h>
12 #include <linux/platform_device.h>
13 #include <linux/pm_wakeirq.h>
14 #include <linux/property.h>
15 #include <linux/workqueue.h>
16 #include <linux/regmap.h>
17 #include <linux/mfd/da9063/core.h>
18 #include <linux/mfd/da9063/registers.h>
19 #include <linux/mfd/da9062/core.h>
20 #include <linux/mfd/da9062/registers.h>
21 
22 struct da906x_chip_config {
23 	/* REGS */
24 	int onkey_status;
25 	int onkey_pwr_signalling;
26 	int onkey_fault_log;
27 	int onkey_shutdown;
28 	/* MASKS */
29 	int onkey_nonkey_mask;
30 	int onkey_nonkey_lock_mask;
31 	int onkey_key_reset_mask;
32 	int onkey_shutdown_mask;
33 	/* NAMES */
34 	const char *name;
35 };
36 
37 struct da9063_onkey {
38 	struct delayed_work work;
39 	struct input_dev *input;
40 	struct device *dev;
41 	struct regmap *regmap;
42 	const struct da906x_chip_config *config;
43 	char phys[32];
44 	bool key_power;
45 };
46 
47 static const struct da906x_chip_config da9063_regs = {
48 	/* REGS */
49 	.onkey_status = DA9063_REG_STATUS_A,
50 	.onkey_pwr_signalling = DA9063_REG_CONTROL_B,
51 	.onkey_fault_log = DA9063_REG_FAULT_LOG,
52 	.onkey_shutdown = DA9063_REG_CONTROL_F,
53 	/* MASKS */
54 	.onkey_nonkey_mask = DA9063_NONKEY,
55 	.onkey_nonkey_lock_mask = DA9063_NONKEY_LOCK,
56 	.onkey_key_reset_mask = DA9063_KEY_RESET,
57 	.onkey_shutdown_mask = DA9063_SHUTDOWN,
58 	/* NAMES */
59 	.name = DA9063_DRVNAME_ONKEY,
60 };
61 
62 static const struct da906x_chip_config da9062_regs = {
63 	/* REGS */
64 	.onkey_status = DA9062AA_STATUS_A,
65 	.onkey_pwr_signalling = DA9062AA_CONTROL_B,
66 	.onkey_fault_log = DA9062AA_FAULT_LOG,
67 	.onkey_shutdown = DA9062AA_CONTROL_F,
68 	/* MASKS */
69 	.onkey_nonkey_mask = DA9062AA_NONKEY_MASK,
70 	.onkey_nonkey_lock_mask = DA9062AA_NONKEY_LOCK_MASK,
71 	.onkey_key_reset_mask = DA9062AA_KEY_RESET_MASK,
72 	.onkey_shutdown_mask = DA9062AA_SHUTDOWN_MASK,
73 	/* NAMES */
74 	.name = "da9062-onkey",
75 };
76 
77 static void da9063_poll_on(struct work_struct *work)
78 {
79 	struct da9063_onkey *onkey = container_of(work,
80 						struct da9063_onkey,
81 						work.work);
82 	const struct da906x_chip_config *config = onkey->config;
83 	unsigned int val;
84 	int fault_log = 0;
85 	bool poll = true;
86 	int error;
87 
88 	/* Poll to see when the pin is released */
89 	error = regmap_read(onkey->regmap,
90 			    config->onkey_status,
91 			    &val);
92 	if (error) {
93 		dev_err(onkey->dev,
94 			"Failed to read ON status: %d\n", error);
95 		goto err_poll;
96 	}
97 
98 	if (!(val & config->onkey_nonkey_mask)) {
99 		error = regmap_update_bits(onkey->regmap,
100 					   config->onkey_pwr_signalling,
101 					   config->onkey_nonkey_lock_mask,
102 					   0);
103 		if (error) {
104 			dev_err(onkey->dev,
105 				"Failed to reset the Key Delay %d\n", error);
106 			goto err_poll;
107 		}
108 
109 		input_report_key(onkey->input, KEY_POWER, 0);
110 		input_sync(onkey->input);
111 
112 		poll = false;
113 	}
114 
115 	/*
116 	 * If the fault log KEY_RESET is detected, then clear it
117 	 * and shut down the system.
118 	 */
119 	error = regmap_read(onkey->regmap,
120 			    config->onkey_fault_log,
121 			    &fault_log);
122 	if (error) {
123 		dev_warn(&onkey->input->dev,
124 			 "Cannot read FAULT_LOG: %d\n", error);
125 	} else if (fault_log & config->onkey_key_reset_mask) {
126 		error = regmap_write(onkey->regmap,
127 				     config->onkey_fault_log,
128 				     config->onkey_key_reset_mask);
129 		if (error) {
130 			dev_warn(&onkey->input->dev,
131 				 "Cannot reset KEY_RESET fault log: %d\n",
132 				 error);
133 		} else {
134 			/* at this point we do any S/W housekeeping
135 			 * and then send shutdown command
136 			 */
137 			dev_dbg(&onkey->input->dev,
138 				"Sending SHUTDOWN to PMIC ...\n");
139 			error = regmap_write(onkey->regmap,
140 					     config->onkey_shutdown,
141 					     config->onkey_shutdown_mask);
142 			if (error)
143 				dev_err(&onkey->input->dev,
144 					"Cannot SHUTDOWN PMIC: %d\n",
145 					error);
146 		}
147 	}
148 
149 err_poll:
150 	if (poll)
151 		schedule_delayed_work(&onkey->work, msecs_to_jiffies(50));
152 }
153 
154 static irqreturn_t da9063_onkey_irq_handler(int irq, void *data)
155 {
156 	struct da9063_onkey *onkey = data;
157 	const struct da906x_chip_config *config = onkey->config;
158 	unsigned int val;
159 	int error;
160 
161 	error = regmap_read(onkey->regmap,
162 			    config->onkey_status,
163 			    &val);
164 	if (onkey->key_power && !error && (val & config->onkey_nonkey_mask)) {
165 		input_report_key(onkey->input, KEY_POWER, 1);
166 		input_sync(onkey->input);
167 		schedule_delayed_work(&onkey->work, 0);
168 		dev_dbg(onkey->dev, "KEY_POWER long press.\n");
169 	} else {
170 		input_report_key(onkey->input, KEY_POWER, 1);
171 		input_sync(onkey->input);
172 		input_report_key(onkey->input, KEY_POWER, 0);
173 		input_sync(onkey->input);
174 		dev_dbg(onkey->dev, "KEY_POWER short press.\n");
175 	}
176 
177 	return IRQ_HANDLED;
178 }
179 
180 static int da9063_onkey_probe(struct platform_device *pdev)
181 {
182 	struct da9063_onkey *onkey;
183 	int error;
184 	int irq;
185 
186 	onkey = devm_kzalloc_obj(&pdev->dev, struct da9063_onkey);
187 	if (!onkey)
188 		return -ENOMEM;
189 
190 	onkey->config = device_get_match_data(&pdev->dev);
191 	if (!onkey->config)
192 		return -ENXIO;
193 
194 	onkey->dev = &pdev->dev;
195 
196 	onkey->regmap = dev_get_regmap(pdev->dev.parent, NULL);
197 	if (!onkey->regmap)
198 		return dev_err_probe(&pdev->dev, -ENXIO,
199 				     "Parent regmap unavailable.\n");
200 
201 	onkey->key_power = !device_property_read_bool(&pdev->dev,
202 						      "dlg,disable-key-power");
203 
204 	onkey->input = devm_input_allocate_device(&pdev->dev);
205 	if (!onkey->input)
206 		return -ENOMEM;
207 
208 	onkey->input->name = onkey->config->name;
209 	snprintf(onkey->phys, sizeof(onkey->phys), "%s/input0",
210 		 onkey->config->name);
211 	onkey->input->phys = onkey->phys;
212 
213 	input_set_capability(onkey->input, EV_KEY, KEY_POWER);
214 
215 	error = devm_delayed_work_autocancel(&pdev->dev, &onkey->work,
216 					     da9063_poll_on);
217 	if (error)
218 		return error;
219 
220 	irq = platform_get_irq_byname(pdev, "ONKEY");
221 	if (irq < 0)
222 		return irq;
223 
224 	error = devm_request_threaded_irq(&pdev->dev, irq,
225 					  NULL, da9063_onkey_irq_handler,
226 					  IRQF_TRIGGER_LOW | IRQF_ONESHOT,
227 					  "ONKEY", onkey);
228 	if (error)
229 		return dev_err_probe(&pdev->dev, error,
230 				     "Failed to allocate onkey IRQ\n");
231 
232 	error = dev_pm_set_wake_irq(&pdev->dev, irq);
233 	if (error)
234 		dev_warn(&pdev->dev,
235 			 "Failed to set IRQ %d as a wake IRQ: %d\n",
236 			 irq, error);
237 	else
238 		device_init_wakeup(&pdev->dev, true);
239 
240 	error = input_register_device(onkey->input);
241 	if (error)
242 		return error;
243 
244 	return 0;
245 }
246 
247 static const struct of_device_id da9063_compatible_reg_id_table[] = {
248 	{ .compatible = "dlg,da9063-onkey", .data = &da9063_regs },
249 	{ .compatible = "dlg,da9062-onkey", .data = &da9062_regs },
250 	{ }
251 };
252 MODULE_DEVICE_TABLE(of, da9063_compatible_reg_id_table);
253 
254 static struct platform_driver da9063_onkey_driver = {
255 	.probe	= da9063_onkey_probe,
256 	.driver	= {
257 		.name	= DA9063_DRVNAME_ONKEY,
258 		.of_match_table = da9063_compatible_reg_id_table,
259 	},
260 };
261 module_platform_driver(da9063_onkey_driver);
262 
263 MODULE_AUTHOR("S Twiss <stwiss.opensource@diasemi.com>");
264 MODULE_DESCRIPTION("Onkey device driver for Dialog DA9063, DA9062 and DA9061");
265 MODULE_LICENSE("GPL");
266 MODULE_ALIAS("platform:" DA9063_DRVNAME_ONKEY);
267