xref: /linux/drivers/mfd/arizona-irq.c (revision ab93e0dd72c37d378dd936f031ffb83ff2bd87ce)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Arizona interrupt support
4  *
5  * Copyright 2012 Wolfson Microelectronics plc
6  *
7  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8  */
9 
10 #include <linux/delay.h>
11 #include <linux/gpio.h>
12 #include <linux/interrupt.h>
13 #include <linux/irq.h>
14 #include <linux/irqdomain.h>
15 #include <linux/module.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/regmap.h>
18 #include <linux/regulator/consumer.h>
19 #include <linux/slab.h>
20 
21 #include <linux/mfd/arizona/core.h>
22 #include <linux/mfd/arizona/registers.h>
23 
24 #include "arizona.h"
25 
26 #define ARIZONA_AOD_IRQ_INDEX 0
27 #define ARIZONA_MAIN_IRQ_INDEX 1
28 
arizona_map_irq(struct arizona * arizona,int irq)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 
arizona_request_irq(struct arizona * arizona,int irq,char * name,irq_handler_t handler,void * data)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 
arizona_free_irq(struct arizona * arizona,int irq,void * data)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 
arizona_set_irq_wake(struct arizona * arizona,int irq,int on)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 
arizona_boot_done(int irq,void * data)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 
arizona_ctrlif_err(int irq,void * data)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 
arizona_irq_thread(int irq,void * data)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_resume_and_get(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_put_autosuspend(arizona->dev);
156 
157 	return IRQ_HANDLED;
158 }
159 
arizona_irq_enable(struct irq_data * data)160 static void arizona_irq_enable(struct irq_data *data)
161 {
162 }
163 
arizona_irq_disable(struct irq_data * data)164 static void arizona_irq_disable(struct irq_data *data)
165 {
166 }
167 
arizona_irq_set_wake(struct irq_data * data,unsigned int on)168 static int arizona_irq_set_wake(struct irq_data *data, unsigned int on)
169 {
170 	struct arizona *arizona = irq_data_get_irq_chip_data(data);
171 
172 	return irq_set_irq_wake(arizona->irq, on);
173 }
174 
175 static struct irq_chip arizona_irq_chip = {
176 	.name			= "arizona",
177 	.irq_disable		= arizona_irq_disable,
178 	.irq_enable		= arizona_irq_enable,
179 	.irq_set_wake		= arizona_irq_set_wake,
180 };
181 
182 static struct lock_class_key arizona_irq_lock_class;
183 static struct lock_class_key arizona_irq_request_class;
184 
arizona_irq_map(struct irq_domain * h,unsigned int virq,irq_hw_number_t hw)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 		&arizona_irq_request_class);
193 	irq_set_chip_and_handler(virq, &arizona_irq_chip, handle_simple_irq);
194 	irq_set_nested_thread(virq, 1);
195 	irq_set_noprobe(virq);
196 
197 	return 0;
198 }
199 
200 static const struct irq_domain_ops arizona_domain_ops = {
201 	.map	= arizona_irq_map,
202 	.xlate	= irq_domain_xlate_twocell,
203 };
204 
arizona_irq_init(struct arizona * arizona)205 int arizona_irq_init(struct arizona *arizona)
206 {
207 	int flags = IRQF_ONESHOT;
208 	int ret;
209 	const struct regmap_irq_chip *aod, *irq;
210 	struct irq_data *irq_data;
211 	unsigned int virq;
212 
213 	arizona->ctrlif_error = true;
214 
215 	switch (arizona->type) {
216 #ifdef CONFIG_MFD_WM5102
217 	case WM5102:
218 		aod = &wm5102_aod;
219 		irq = &wm5102_irq;
220 
221 		arizona->ctrlif_error = false;
222 		break;
223 #endif
224 #ifdef CONFIG_MFD_WM5110
225 	case WM5110:
226 	case WM8280:
227 		aod = &wm5110_aod;
228 
229 		switch (arizona->rev) {
230 		case 0 ... 2:
231 			irq = &wm5110_irq;
232 			break;
233 		default:
234 			irq = &wm5110_revd_irq;
235 			break;
236 		}
237 
238 		arizona->ctrlif_error = false;
239 		break;
240 #endif
241 #ifdef CONFIG_MFD_CS47L24
242 	case WM1831:
243 	case CS47L24:
244 		aod = NULL;
245 		irq = &cs47l24_irq;
246 
247 		arizona->ctrlif_error = false;
248 		break;
249 #endif
250 #ifdef CONFIG_MFD_WM8997
251 	case WM8997:
252 		aod = &wm8997_aod;
253 		irq = &wm8997_irq;
254 
255 		arizona->ctrlif_error = false;
256 		break;
257 #endif
258 #ifdef CONFIG_MFD_WM8998
259 	case WM8998:
260 	case WM1814:
261 		aod = &wm8998_aod;
262 		irq = &wm8998_irq;
263 
264 		arizona->ctrlif_error = false;
265 		break;
266 #endif
267 	default:
268 		BUG_ON("Unknown Arizona class device" == NULL);
269 		return -EINVAL;
270 	}
271 
272 	/* Disable all wake sources by default */
273 	regmap_write(arizona->regmap, ARIZONA_WAKE_CONTROL, 0);
274 
275 	/* Read the flags from the interrupt controller if not specified */
276 	if (!arizona->pdata.irq_flags) {
277 		irq_data = irq_get_irq_data(arizona->irq);
278 		if (!irq_data) {
279 			dev_err(arizona->dev, "Invalid IRQ: %d\n",
280 				arizona->irq);
281 			return -EINVAL;
282 		}
283 
284 		arizona->pdata.irq_flags = irqd_get_trigger_type(irq_data);
285 		switch (arizona->pdata.irq_flags) {
286 		case IRQF_TRIGGER_LOW:
287 		case IRQF_TRIGGER_HIGH:
288 		case IRQF_TRIGGER_RISING:
289 		case IRQF_TRIGGER_FALLING:
290 			break;
291 
292 		case IRQ_TYPE_NONE:
293 		default:
294 			/* Device default */
295 			arizona->pdata.irq_flags = IRQF_TRIGGER_LOW;
296 			break;
297 		}
298 	}
299 
300 	if (arizona->pdata.irq_flags & (IRQF_TRIGGER_HIGH |
301 					IRQF_TRIGGER_RISING)) {
302 		ret = regmap_update_bits(arizona->regmap, ARIZONA_IRQ_CTRL_1,
303 					 ARIZONA_IRQ_POL, 0);
304 		if (ret != 0) {
305 			dev_err(arizona->dev, "Couldn't set IRQ polarity: %d\n",
306 				ret);
307 			goto err;
308 		}
309 	}
310 
311 	flags |= arizona->pdata.irq_flags;
312 
313 	/* Allocate a virtual IRQ domain to distribute to the regmap domains */
314 	arizona->virq = irq_domain_create_linear(NULL, 2, &arizona_domain_ops, arizona);
315 	if (!arizona->virq) {
316 		dev_err(arizona->dev, "Failed to add core IRQ domain\n");
317 		ret = -EINVAL;
318 		goto err;
319 	}
320 
321 	if (aod) {
322 		virq = irq_create_mapping(arizona->virq, ARIZONA_AOD_IRQ_INDEX);
323 		if (!virq) {
324 			dev_err(arizona->dev, "Failed to map AOD IRQs\n");
325 			ret = -EINVAL;
326 			goto err_domain;
327 		}
328 
329 		ret = regmap_add_irq_chip(arizona->regmap, virq, IRQF_ONESHOT,
330 					  0, aod, &arizona->aod_irq_chip);
331 		if (ret != 0) {
332 			dev_err(arizona->dev,
333 				"Failed to add AOD IRQs: %d\n", ret);
334 			goto err_map_aod;
335 		}
336 	}
337 
338 	virq = irq_create_mapping(arizona->virq, ARIZONA_MAIN_IRQ_INDEX);
339 	if (!virq) {
340 		dev_err(arizona->dev, "Failed to map main IRQs\n");
341 		ret = -EINVAL;
342 		goto err_aod;
343 	}
344 
345 	ret = regmap_add_irq_chip(arizona->regmap, virq, IRQF_ONESHOT,
346 				  0, irq, &arizona->irq_chip);
347 	if (ret != 0) {
348 		dev_err(arizona->dev, "Failed to add main IRQs: %d\n", ret);
349 		goto err_map_main_irq;
350 	}
351 
352 	/* Used to emulate edge trigger and to work around broken pinmux */
353 	if (arizona->pdata.irq_gpio) {
354 		if (gpio_to_irq(arizona->pdata.irq_gpio) != arizona->irq) {
355 			dev_warn(arizona->dev, "IRQ %d is not GPIO %d (%d)\n",
356 				 arizona->irq, arizona->pdata.irq_gpio,
357 				 gpio_to_irq(arizona->pdata.irq_gpio));
358 			arizona->irq = gpio_to_irq(arizona->pdata.irq_gpio);
359 		}
360 
361 		ret = devm_gpio_request_one(arizona->dev,
362 					    arizona->pdata.irq_gpio,
363 					    GPIOF_IN, "arizona IRQ");
364 		if (ret != 0) {
365 			dev_err(arizona->dev,
366 				"Failed to request IRQ GPIO %d:: %d\n",
367 				arizona->pdata.irq_gpio, ret);
368 			arizona->pdata.irq_gpio = 0;
369 		}
370 	}
371 
372 	ret = request_threaded_irq(arizona->irq, NULL, arizona_irq_thread,
373 				   flags, "arizona", arizona);
374 
375 	if (ret != 0) {
376 		dev_err(arizona->dev, "Failed to request primary IRQ %d: %d\n",
377 			arizona->irq, ret);
378 		goto err_main_irq;
379 	}
380 
381 	/* Make sure the boot done IRQ is unmasked for resumes */
382 	ret = arizona_request_irq(arizona, ARIZONA_IRQ_BOOT_DONE, "Boot done",
383 				  arizona_boot_done, arizona);
384 	if (ret != 0) {
385 		dev_err(arizona->dev, "Failed to request boot done %d: %d\n",
386 			arizona->irq, ret);
387 		goto err_boot_done;
388 	}
389 
390 	/* Handle control interface errors in the core */
391 	if (arizona->ctrlif_error) {
392 		ret = arizona_request_irq(arizona, ARIZONA_IRQ_CTRLIF_ERR,
393 					  "Control interface error",
394 					  arizona_ctrlif_err, arizona);
395 		if (ret != 0) {
396 			dev_err(arizona->dev,
397 				"Failed to request CTRLIF_ERR %d: %d\n",
398 				arizona->irq, ret);
399 			goto err_ctrlif;
400 		}
401 	}
402 
403 	return 0;
404 
405 err_ctrlif:
406 	arizona_free_irq(arizona, ARIZONA_IRQ_BOOT_DONE, arizona);
407 err_boot_done:
408 	free_irq(arizona->irq, arizona);
409 err_main_irq:
410 	regmap_del_irq_chip(irq_find_mapping(arizona->virq,
411 					     ARIZONA_MAIN_IRQ_INDEX),
412 			    arizona->irq_chip);
413 err_map_main_irq:
414 	irq_dispose_mapping(irq_find_mapping(arizona->virq,
415 					     ARIZONA_MAIN_IRQ_INDEX));
416 err_aod:
417 	regmap_del_irq_chip(irq_find_mapping(arizona->virq,
418 					     ARIZONA_AOD_IRQ_INDEX),
419 			    arizona->aod_irq_chip);
420 err_map_aod:
421 	irq_dispose_mapping(irq_find_mapping(arizona->virq,
422 					     ARIZONA_AOD_IRQ_INDEX));
423 err_domain:
424 	irq_domain_remove(arizona->virq);
425 err:
426 	return ret;
427 }
428 
arizona_irq_exit(struct arizona * arizona)429 int arizona_irq_exit(struct arizona *arizona)
430 {
431 	unsigned int virq;
432 
433 	if (arizona->ctrlif_error)
434 		arizona_free_irq(arizona, ARIZONA_IRQ_CTRLIF_ERR, arizona);
435 	arizona_free_irq(arizona, ARIZONA_IRQ_BOOT_DONE, arizona);
436 
437 	virq = irq_find_mapping(arizona->virq, ARIZONA_MAIN_IRQ_INDEX);
438 	regmap_del_irq_chip(virq, arizona->irq_chip);
439 	irq_dispose_mapping(virq);
440 
441 	virq = irq_find_mapping(arizona->virq, ARIZONA_AOD_IRQ_INDEX);
442 	regmap_del_irq_chip(virq, arizona->aod_irq_chip);
443 	irq_dispose_mapping(virq);
444 
445 	irq_domain_remove(arizona->virq);
446 
447 	free_irq(arizona->irq, arizona);
448 
449 	return 0;
450 }
451