xref: /openbmc/linux/drivers/mfd/arizona-irq.c (revision 293d5b43)
1 /*
2  * Arizona interrupt support
3  *
4  * Copyright 2012 Wolfson Microelectronics plc
5  *
6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  */
12 
13 #include <linux/delay.h>
14 #include <linux/gpio.h>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/irqdomain.h>
18 #include <linux/module.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
22 #include <linux/slab.h>
23 
24 #include <linux/mfd/arizona/core.h>
25 #include <linux/mfd/arizona/registers.h>
26 
27 #include "arizona.h"
28 
29 static int arizona_map_irq(struct arizona *arizona, int irq)
30 {
31 	int ret;
32 
33 	if (arizona->aod_irq_chip) {
34 		ret = regmap_irq_get_virq(arizona->aod_irq_chip, irq);
35 		if (ret >= 0)
36 			return ret;
37 	}
38 
39 	return regmap_irq_get_virq(arizona->irq_chip, irq);
40 }
41 
42 int arizona_request_irq(struct arizona *arizona, int irq, char *name,
43 			   irq_handler_t handler, void *data)
44 {
45 	irq = arizona_map_irq(arizona, irq);
46 	if (irq < 0)
47 		return irq;
48 
49 	return request_threaded_irq(irq, NULL, handler, IRQF_ONESHOT,
50 				    name, data);
51 }
52 EXPORT_SYMBOL_GPL(arizona_request_irq);
53 
54 void arizona_free_irq(struct arizona *arizona, int irq, void *data)
55 {
56 	irq = arizona_map_irq(arizona, irq);
57 	if (irq < 0)
58 		return;
59 
60 	free_irq(irq, data);
61 }
62 EXPORT_SYMBOL_GPL(arizona_free_irq);
63 
64 int arizona_set_irq_wake(struct arizona *arizona, int irq, int on)
65 {
66 	irq = arizona_map_irq(arizona, irq);
67 	if (irq < 0)
68 		return irq;
69 
70 	return irq_set_irq_wake(irq, on);
71 }
72 EXPORT_SYMBOL_GPL(arizona_set_irq_wake);
73 
74 static irqreturn_t arizona_boot_done(int irq, void *data)
75 {
76 	struct arizona *arizona = data;
77 
78 	dev_dbg(arizona->dev, "Boot done\n");
79 
80 	return IRQ_HANDLED;
81 }
82 
83 static irqreturn_t arizona_ctrlif_err(int irq, void *data)
84 {
85 	struct arizona *arizona = data;
86 
87 	/*
88 	 * For pretty much all potential sources a register cache sync
89 	 * won't help, we've just got a software bug somewhere.
90 	 */
91 	dev_err(arizona->dev, "Control interface error\n");
92 
93 	return IRQ_HANDLED;
94 }
95 
96 static irqreturn_t arizona_irq_thread(int irq, void *data)
97 {
98 	struct arizona *arizona = data;
99 	bool poll;
100 	unsigned int val;
101 	int ret;
102 
103 	ret = pm_runtime_get_sync(arizona->dev);
104 	if (ret < 0) {
105 		dev_err(arizona->dev, "Failed to resume device: %d\n", ret);
106 		return IRQ_NONE;
107 	}
108 
109 	do {
110 		poll = false;
111 
112 		if (arizona->aod_irq_chip) {
113 			/*
114 			 * Check the AOD status register to determine whether
115 			 * the nested IRQ handler should be called.
116 			 */
117 			ret = regmap_read(arizona->regmap,
118 					  ARIZONA_AOD_IRQ1, &val);
119 			if (ret)
120 				dev_warn(arizona->dev,
121 					"Failed to read AOD IRQ1 %d\n", ret);
122 			else if (val)
123 				handle_nested_irq(
124 					irq_find_mapping(arizona->virq, 0));
125 		}
126 
127 		/*
128 		 * Check if one of the main interrupts is asserted and only
129 		 * check that domain if it is.
130 		 */
131 		ret = regmap_read(arizona->regmap, ARIZONA_IRQ_PIN_STATUS,
132 				  &val);
133 		if (ret == 0 && val & ARIZONA_IRQ1_STS) {
134 			handle_nested_irq(irq_find_mapping(arizona->virq, 1));
135 		} else if (ret != 0) {
136 			dev_err(arizona->dev,
137 				"Failed to read main IRQ status: %d\n", ret);
138 		}
139 
140 		/*
141 		 * Poll the IRQ pin status to see if we're really done
142 		 * if the interrupt controller can't do it for us.
143 		 */
144 		if (!arizona->pdata.irq_gpio) {
145 			break;
146 		} else if (arizona->pdata.irq_flags & IRQF_TRIGGER_RISING &&
147 			   gpio_get_value_cansleep(arizona->pdata.irq_gpio)) {
148 			poll = true;
149 		} else if (arizona->pdata.irq_flags & IRQF_TRIGGER_FALLING &&
150 			   !gpio_get_value_cansleep(arizona->pdata.irq_gpio)) {
151 			poll = true;
152 		}
153 	} while (poll);
154 
155 	pm_runtime_mark_last_busy(arizona->dev);
156 	pm_runtime_put_autosuspend(arizona->dev);
157 
158 	return IRQ_HANDLED;
159 }
160 
161 static void arizona_irq_enable(struct irq_data *data)
162 {
163 }
164 
165 static void arizona_irq_disable(struct irq_data *data)
166 {
167 }
168 
169 static int arizona_irq_set_wake(struct irq_data *data, unsigned int on)
170 {
171 	struct arizona *arizona = irq_data_get_irq_chip_data(data);
172 
173 	return irq_set_irq_wake(arizona->irq, on);
174 }
175 
176 static struct irq_chip arizona_irq_chip = {
177 	.name			= "arizona",
178 	.irq_disable		= arizona_irq_disable,
179 	.irq_enable		= arizona_irq_enable,
180 	.irq_set_wake		= arizona_irq_set_wake,
181 };
182 
183 static struct lock_class_key arizona_irq_lock_class;
184 
185 static int arizona_irq_map(struct irq_domain *h, unsigned int virq,
186 			      irq_hw_number_t hw)
187 {
188 	struct arizona *data = h->host_data;
189 
190 	irq_set_chip_data(virq, data);
191 	irq_set_lockdep_class(virq, &arizona_irq_lock_class);
192 	irq_set_chip_and_handler(virq, &arizona_irq_chip, handle_simple_irq);
193 	irq_set_nested_thread(virq, 1);
194 	irq_set_noprobe(virq);
195 
196 	return 0;
197 }
198 
199 static const struct irq_domain_ops arizona_domain_ops = {
200 	.map	= arizona_irq_map,
201 	.xlate	= irq_domain_xlate_twocell,
202 };
203 
204 int arizona_irq_init(struct arizona *arizona)
205 {
206 	int flags = IRQF_ONESHOT;
207 	int ret, i;
208 	const struct regmap_irq_chip *aod, *irq;
209 	struct irq_data *irq_data;
210 
211 	arizona->ctrlif_error = true;
212 
213 	switch (arizona->type) {
214 #ifdef CONFIG_MFD_WM5102
215 	case WM5102:
216 		aod = &wm5102_aod;
217 		irq = &wm5102_irq;
218 
219 		arizona->ctrlif_error = false;
220 		break;
221 #endif
222 #ifdef CONFIG_MFD_WM5110
223 	case WM5110:
224 	case WM8280:
225 		aod = &wm5110_aod;
226 
227 		switch (arizona->rev) {
228 		case 0 ... 2:
229 			irq = &wm5110_irq;
230 			break;
231 		default:
232 			irq = &wm5110_revd_irq;
233 			break;
234 		}
235 
236 		arizona->ctrlif_error = false;
237 		break;
238 #endif
239 #ifdef CONFIG_MFD_CS47L24
240 	case WM1831:
241 	case CS47L24:
242 		aod = NULL;
243 		irq = &cs47l24_irq;
244 
245 		arizona->ctrlif_error = false;
246 		break;
247 #endif
248 #ifdef CONFIG_MFD_WM8997
249 	case WM8997:
250 		aod = &wm8997_aod;
251 		irq = &wm8997_irq;
252 
253 		arizona->ctrlif_error = false;
254 		break;
255 #endif
256 #ifdef CONFIG_MFD_WM8998
257 	case WM8998:
258 	case WM1814:
259 		aod = &wm8998_aod;
260 		irq = &wm8998_irq;
261 
262 		arizona->ctrlif_error = false;
263 		break;
264 #endif
265 	default:
266 		BUG_ON("Unknown Arizona class device" == NULL);
267 		return -EINVAL;
268 	}
269 
270 	/* Disable all wake sources by default */
271 	regmap_write(arizona->regmap, ARIZONA_WAKE_CONTROL, 0);
272 
273 	/* Read the flags from the interrupt controller if not specified */
274 	if (!arizona->pdata.irq_flags) {
275 		irq_data = irq_get_irq_data(arizona->irq);
276 		if (!irq_data) {
277 			dev_err(arizona->dev, "Invalid IRQ: %d\n",
278 				arizona->irq);
279 			return -EINVAL;
280 		}
281 
282 		arizona->pdata.irq_flags = irqd_get_trigger_type(irq_data);
283 		switch (arizona->pdata.irq_flags) {
284 		case IRQF_TRIGGER_LOW:
285 		case IRQF_TRIGGER_HIGH:
286 		case IRQF_TRIGGER_RISING:
287 		case IRQF_TRIGGER_FALLING:
288 			break;
289 
290 		case IRQ_TYPE_NONE:
291 		default:
292 			/* Device default */
293 			arizona->pdata.irq_flags = IRQF_TRIGGER_LOW;
294 			break;
295 		}
296 	}
297 
298 	if (arizona->pdata.irq_flags & (IRQF_TRIGGER_HIGH |
299 					IRQF_TRIGGER_RISING)) {
300 		ret = regmap_update_bits(arizona->regmap, ARIZONA_IRQ_CTRL_1,
301 					 ARIZONA_IRQ_POL, 0);
302 		if (ret != 0) {
303 			dev_err(arizona->dev, "Couldn't set IRQ polarity: %d\n",
304 				ret);
305 			goto err;
306 		}
307 	}
308 
309 	flags |= arizona->pdata.irq_flags;
310 
311 	/* Allocate a virtual IRQ domain to distribute to the regmap domains */
312 	arizona->virq = irq_domain_add_linear(NULL, 2, &arizona_domain_ops,
313 					      arizona);
314 	if (!arizona->virq) {
315 		dev_err(arizona->dev, "Failed to add core IRQ domain\n");
316 		ret = -EINVAL;
317 		goto err;
318 	}
319 
320 	if (aod) {
321 		ret = regmap_add_irq_chip(arizona->regmap,
322 					  irq_create_mapping(arizona->virq, 0),
323 					  IRQF_ONESHOT, 0, aod,
324 					  &arizona->aod_irq_chip);
325 		if (ret != 0) {
326 			dev_err(arizona->dev,
327 				"Failed to add AOD IRQs: %d\n", ret);
328 			goto err;
329 		}
330 	}
331 
332 	ret = regmap_add_irq_chip(arizona->regmap,
333 				  irq_create_mapping(arizona->virq, 1),
334 				  IRQF_ONESHOT, 0, irq,
335 				  &arizona->irq_chip);
336 	if (ret != 0) {
337 		dev_err(arizona->dev, "Failed to add main IRQs: %d\n", ret);
338 		goto err_aod;
339 	}
340 
341 	/* Used to emulate edge trigger and to work around broken pinmux */
342 	if (arizona->pdata.irq_gpio) {
343 		if (gpio_to_irq(arizona->pdata.irq_gpio) != arizona->irq) {
344 			dev_warn(arizona->dev, "IRQ %d is not GPIO %d (%d)\n",
345 				 arizona->irq, arizona->pdata.irq_gpio,
346 				 gpio_to_irq(arizona->pdata.irq_gpio));
347 			arizona->irq = gpio_to_irq(arizona->pdata.irq_gpio);
348 		}
349 
350 		ret = devm_gpio_request_one(arizona->dev,
351 					    arizona->pdata.irq_gpio,
352 					    GPIOF_IN, "arizona IRQ");
353 		if (ret != 0) {
354 			dev_err(arizona->dev,
355 				"Failed to request IRQ GPIO %d:: %d\n",
356 				arizona->pdata.irq_gpio, ret);
357 			arizona->pdata.irq_gpio = 0;
358 		}
359 	}
360 
361 	ret = request_threaded_irq(arizona->irq, NULL, arizona_irq_thread,
362 				   flags, "arizona", arizona);
363 
364 	if (ret != 0) {
365 		dev_err(arizona->dev, "Failed to request primary IRQ %d: %d\n",
366 			arizona->irq, ret);
367 		goto err_main_irq;
368 	}
369 
370 	/* Make sure the boot done IRQ is unmasked for resumes */
371 	i = arizona_map_irq(arizona, ARIZONA_IRQ_BOOT_DONE);
372 	ret = request_threaded_irq(i, NULL, arizona_boot_done, IRQF_ONESHOT,
373 				   "Boot done", arizona);
374 	if (ret != 0) {
375 		dev_err(arizona->dev, "Failed to request boot done %d: %d\n",
376 			arizona->irq, ret);
377 		goto err_boot_done;
378 	}
379 
380 	/* Handle control interface errors in the core */
381 	if (arizona->ctrlif_error) {
382 		i = arizona_map_irq(arizona, ARIZONA_IRQ_CTRLIF_ERR);
383 		ret = request_threaded_irq(i, NULL, arizona_ctrlif_err,
384 					   IRQF_ONESHOT,
385 					   "Control interface error", arizona);
386 		if (ret != 0) {
387 			dev_err(arizona->dev,
388 				"Failed to request CTRLIF_ERR %d: %d\n",
389 				arizona->irq, ret);
390 			goto err_ctrlif;
391 		}
392 	}
393 
394 	return 0;
395 
396 err_ctrlif:
397 	free_irq(arizona_map_irq(arizona, ARIZONA_IRQ_BOOT_DONE), arizona);
398 err_boot_done:
399 	free_irq(arizona->irq, arizona);
400 err_main_irq:
401 	regmap_del_irq_chip(irq_create_mapping(arizona->virq, 1),
402 			    arizona->irq_chip);
403 err_aod:
404 	regmap_del_irq_chip(irq_create_mapping(arizona->virq, 0),
405 			    arizona->aod_irq_chip);
406 err:
407 	return ret;
408 }
409 
410 int arizona_irq_exit(struct arizona *arizona)
411 {
412 	if (arizona->ctrlif_error)
413 		free_irq(arizona_map_irq(arizona, ARIZONA_IRQ_CTRLIF_ERR),
414 			 arizona);
415 	free_irq(arizona_map_irq(arizona, ARIZONA_IRQ_BOOT_DONE), arizona);
416 	regmap_del_irq_chip(irq_create_mapping(arizona->virq, 1),
417 			    arizona->irq_chip);
418 	regmap_del_irq_chip(irq_create_mapping(arizona->virq, 0),
419 			    arizona->aod_irq_chip);
420 	free_irq(arizona->irq, arizona);
421 
422 	return 0;
423 }
424