2 * regmap based irq_chip
4 * Copyright 2011 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
13 #include <linux/export.h>
14 #include <linux/device.h>
15 #include <linux/regmap.h>
16 #include <linux/irq.h>
17 #include <linux/interrupt.h>
18 #include <linux/irqdomain.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/slab.h>
24 struct regmap_irq_chip_data
{
26 struct irq_chip irq_chip
;
29 const struct regmap_irq_chip
*chip
;
32 struct irq_domain
*domain
;
38 unsigned int *status_buf
;
39 unsigned int *mask_buf
;
40 unsigned int *mask_buf_def
;
41 unsigned int *wake_buf
;
43 unsigned int irq_reg_stride
;
47 struct regmap_irq
*irq_to_regmap_irq(struct regmap_irq_chip_data
*data
,
50 return &data
->chip
->irqs
[irq
];
53 static void regmap_irq_lock(struct irq_data
*data
)
55 struct regmap_irq_chip_data
*d
= irq_data_get_irq_chip_data(data
);
60 static void regmap_irq_sync_unlock(struct irq_data
*data
)
62 struct regmap_irq_chip_data
*d
= irq_data_get_irq_chip_data(data
);
63 struct regmap
*map
= d
->map
;
67 if (d
->chip
->runtime_pm
) {
68 ret
= pm_runtime_get_sync(map
->dev
);
70 dev_err(map
->dev
, "IRQ sync failed to resume: %d\n",
75 * If there's been a change in the mask write it back to the
76 * hardware. We rely on the use of the regmap core cache to
77 * suppress pointless writes.
79 for (i
= 0; i
< d
->chip
->num_regs
; i
++) {
80 reg
= d
->chip
->mask_base
+
81 (i
* map
->reg_stride
* d
->irq_reg_stride
);
82 if (d
->chip
->mask_invert
)
83 ret
= regmap_update_bits(d
->map
, reg
,
84 d
->mask_buf_def
[i
], ~d
->mask_buf
[i
]);
86 ret
= regmap_update_bits(d
->map
, reg
,
87 d
->mask_buf_def
[i
], d
->mask_buf
[i
]);
89 dev_err(d
->map
->dev
, "Failed to sync masks in %x\n",
92 reg
= d
->chip
->wake_base
+
93 (i
* map
->reg_stride
* d
->irq_reg_stride
);
95 if (d
->chip
->wake_invert
)
96 ret
= regmap_update_bits(d
->map
, reg
,
100 ret
= regmap_update_bits(d
->map
, reg
,
105 "Failed to sync wakes in %x: %d\n",
110 if (d
->chip
->runtime_pm
)
111 pm_runtime_put(map
->dev
);
113 /* If we've changed our wakeup count propagate it to the parent */
114 if (d
->wake_count
< 0)
115 for (i
= d
->wake_count
; i
< 0; i
++)
116 irq_set_irq_wake(d
->irq
, 0);
117 else if (d
->wake_count
> 0)
118 for (i
= 0; i
< d
->wake_count
; i
++)
119 irq_set_irq_wake(d
->irq
, 1);
123 mutex_unlock(&d
->lock
);
126 static void regmap_irq_enable(struct irq_data
*data
)
128 struct regmap_irq_chip_data
*d
= irq_data_get_irq_chip_data(data
);
129 struct regmap
*map
= d
->map
;
130 const struct regmap_irq
*irq_data
= irq_to_regmap_irq(d
, data
->hwirq
);
132 d
->mask_buf
[irq_data
->reg_offset
/ map
->reg_stride
] &= ~irq_data
->mask
;
135 static void regmap_irq_disable(struct irq_data
*data
)
137 struct regmap_irq_chip_data
*d
= irq_data_get_irq_chip_data(data
);
138 struct regmap
*map
= d
->map
;
139 const struct regmap_irq
*irq_data
= irq_to_regmap_irq(d
, data
->hwirq
);
141 d
->mask_buf
[irq_data
->reg_offset
/ map
->reg_stride
] |= irq_data
->mask
;
144 static int regmap_irq_set_wake(struct irq_data
*data
, unsigned int on
)
146 struct regmap_irq_chip_data
*d
= irq_data_get_irq_chip_data(data
);
147 struct regmap
*map
= d
->map
;
148 const struct regmap_irq
*irq_data
= irq_to_regmap_irq(d
, data
->hwirq
);
152 d
->wake_buf
[irq_data
->reg_offset
/ map
->reg_stride
]
157 d
->wake_buf
[irq_data
->reg_offset
/ map
->reg_stride
]
165 static const struct irq_chip regmap_irq_chip
= {
166 .irq_bus_lock
= regmap_irq_lock
,
167 .irq_bus_sync_unlock
= regmap_irq_sync_unlock
,
168 .irq_disable
= regmap_irq_disable
,
169 .irq_enable
= regmap_irq_enable
,
170 .irq_set_wake
= regmap_irq_set_wake
,
173 static irqreturn_t
regmap_irq_thread(int irq
, void *d
)
175 struct regmap_irq_chip_data
*data
= d
;
176 const struct regmap_irq_chip
*chip
= data
->chip
;
177 struct regmap
*map
= data
->map
;
179 bool handled
= false;
182 if (chip
->runtime_pm
) {
183 ret
= pm_runtime_get_sync(map
->dev
);
185 dev_err(map
->dev
, "IRQ thread failed to resume: %d\n",
187 pm_runtime_put(map
->dev
);
193 * Read in the statuses, using a single bulk read if possible
194 * in order to reduce the I/O overheads.
196 if (!map
->use_single_rw
&& map
->reg_stride
== 1 &&
197 data
->irq_reg_stride
== 1) {
198 u8
*buf8
= data
->status_reg_buf
;
199 u16
*buf16
= data
->status_reg_buf
;
200 u32
*buf32
= data
->status_reg_buf
;
202 BUG_ON(!data
->status_reg_buf
);
204 ret
= regmap_bulk_read(map
, chip
->status_base
,
205 data
->status_reg_buf
,
208 dev_err(map
->dev
, "Failed to read IRQ status: %d\n",
213 for (i
= 0; i
< data
->chip
->num_regs
; i
++) {
214 switch (map
->format
.val_bytes
) {
216 data
->status_buf
[i
] = buf8
[i
];
219 data
->status_buf
[i
] = buf16
[i
];
222 data
->status_buf
[i
] = buf32
[i
];
231 for (i
= 0; i
< data
->chip
->num_regs
; i
++) {
232 ret
= regmap_read(map
, chip
->status_base
+
234 * data
->irq_reg_stride
),
235 &data
->status_buf
[i
]);
239 "Failed to read IRQ status: %d\n",
241 if (chip
->runtime_pm
)
242 pm_runtime_put(map
->dev
);
249 * Ignore masked IRQs and ack if we need to; we ack early so
250 * there is no race between handling and acknowleding the
251 * interrupt. We assume that typically few of the interrupts
252 * will fire simultaneously so don't worry about overhead from
253 * doing a write per register.
255 for (i
= 0; i
< data
->chip
->num_regs
; i
++) {
256 data
->status_buf
[i
] &= ~data
->mask_buf
[i
];
258 if (data
->status_buf
[i
] && chip
->ack_base
) {
259 reg
= chip
->ack_base
+
260 (i
* map
->reg_stride
* data
->irq_reg_stride
);
261 ret
= regmap_write(map
, reg
, data
->status_buf
[i
]);
263 dev_err(map
->dev
, "Failed to ack 0x%x: %d\n",
268 for (i
= 0; i
< chip
->num_irqs
; i
++) {
269 if (data
->status_buf
[chip
->irqs
[i
].reg_offset
/
270 map
->reg_stride
] & chip
->irqs
[i
].mask
) {
271 handle_nested_irq(irq_find_mapping(data
->domain
, i
));
276 if (chip
->runtime_pm
)
277 pm_runtime_put(map
->dev
);
285 static int regmap_irq_map(struct irq_domain
*h
, unsigned int virq
,
288 struct regmap_irq_chip_data
*data
= h
->host_data
;
290 irq_set_chip_data(virq
, data
);
291 irq_set_chip(virq
, &data
->irq_chip
);
292 irq_set_nested_thread(virq
, 1);
294 /* ARM needs us to explicitly flag the IRQ as valid
295 * and will set them noprobe when we do so. */
297 set_irq_flags(virq
, IRQF_VALID
);
299 irq_set_noprobe(virq
);
305 static struct irq_domain_ops regmap_domain_ops
= {
306 .map
= regmap_irq_map
,
307 .xlate
= irq_domain_xlate_twocell
,
311 * regmap_add_irq_chip(): Use standard regmap IRQ controller handling
313 * map: The regmap for the device.
314 * irq: The IRQ the device uses to signal interrupts
315 * irq_flags: The IRQF_ flags to use for the primary interrupt.
316 * chip: Configuration for the interrupt controller.
317 * data: Runtime data structure for the controller, allocated on success
319 * Returns 0 on success or an errno on failure.
321 * In order for this to be efficient the chip really should use a
322 * register cache. The chip driver is responsible for restoring the
323 * register values used by the IRQ controller over suspend and resume.
325 int regmap_add_irq_chip(struct regmap
*map
, int irq
, int irq_flags
,
326 int irq_base
, const struct regmap_irq_chip
*chip
,
327 struct regmap_irq_chip_data
**data
)
329 struct regmap_irq_chip_data
*d
;
334 for (i
= 0; i
< chip
->num_irqs
; i
++) {
335 if (chip
->irqs
[i
].reg_offset
% map
->reg_stride
)
337 if (chip
->irqs
[i
].reg_offset
/ map
->reg_stride
>=
343 irq_base
= irq_alloc_descs(irq_base
, 0, chip
->num_irqs
, 0);
345 dev_warn(map
->dev
, "Failed to allocate IRQs: %d\n",
351 d
= kzalloc(sizeof(*d
), GFP_KERNEL
);
357 d
->status_buf
= kzalloc(sizeof(unsigned int) * chip
->num_regs
,
362 d
->mask_buf
= kzalloc(sizeof(unsigned int) * chip
->num_regs
,
367 d
->mask_buf_def
= kzalloc(sizeof(unsigned int) * chip
->num_regs
,
369 if (!d
->mask_buf_def
)
372 if (chip
->wake_base
) {
373 d
->wake_buf
= kzalloc(sizeof(unsigned int) * chip
->num_regs
,
379 d
->irq_chip
= regmap_irq_chip
;
380 d
->irq_chip
.name
= chip
->name
;
384 d
->irq_base
= irq_base
;
386 if (chip
->irq_reg_stride
)
387 d
->irq_reg_stride
= chip
->irq_reg_stride
;
389 d
->irq_reg_stride
= 1;
391 if (!map
->use_single_rw
&& map
->reg_stride
== 1 &&
392 d
->irq_reg_stride
== 1) {
393 d
->status_reg_buf
= kmalloc(map
->format
.val_bytes
*
394 chip
->num_regs
, GFP_KERNEL
);
395 if (!d
->status_reg_buf
)
399 mutex_init(&d
->lock
);
401 for (i
= 0; i
< chip
->num_irqs
; i
++)
402 d
->mask_buf_def
[chip
->irqs
[i
].reg_offset
/ map
->reg_stride
]
403 |= chip
->irqs
[i
].mask
;
405 /* Mask all the interrupts by default */
406 for (i
= 0; i
< chip
->num_regs
; i
++) {
407 d
->mask_buf
[i
] = d
->mask_buf_def
[i
];
408 reg
= chip
->mask_base
+
409 (i
* map
->reg_stride
* d
->irq_reg_stride
);
410 if (chip
->mask_invert
)
411 ret
= regmap_update_bits(map
, reg
,
412 d
->mask_buf
[i
], ~d
->mask_buf
[i
]);
414 ret
= regmap_update_bits(map
, reg
,
415 d
->mask_buf
[i
], d
->mask_buf
[i
]);
417 dev_err(map
->dev
, "Failed to set masks in 0x%x: %d\n",
422 if (!chip
->init_ack_masked
)
425 /* Ack masked but set interrupts */
426 reg
= chip
->status_base
+
427 (i
* map
->reg_stride
* d
->irq_reg_stride
);
428 ret
= regmap_read(map
, reg
, &d
->status_buf
[i
]);
430 dev_err(map
->dev
, "Failed to read IRQ status: %d\n",
435 if (d
->status_buf
[i
] && chip
->ack_base
) {
436 reg
= chip
->ack_base
+
437 (i
* map
->reg_stride
* d
->irq_reg_stride
);
438 ret
= regmap_write(map
, reg
,
439 d
->status_buf
[i
] & d
->mask_buf
[i
]);
441 dev_err(map
->dev
, "Failed to ack 0x%x: %d\n",
448 /* Wake is disabled by default */
450 for (i
= 0; i
< chip
->num_regs
; i
++) {
451 d
->wake_buf
[i
] = d
->mask_buf_def
[i
];
452 reg
= chip
->wake_base
+
453 (i
* map
->reg_stride
* d
->irq_reg_stride
);
455 if (chip
->wake_invert
)
456 ret
= regmap_update_bits(map
, reg
,
460 ret
= regmap_update_bits(map
, reg
,
464 dev_err(map
->dev
, "Failed to set masks in 0x%x: %d\n",
472 d
->domain
= irq_domain_add_legacy(map
->dev
->of_node
,
473 chip
->num_irqs
, irq_base
, 0,
474 ®map_domain_ops
, d
);
476 d
->domain
= irq_domain_add_linear(map
->dev
->of_node
,
478 ®map_domain_ops
, d
);
480 dev_err(map
->dev
, "Failed to create IRQ domain\n");
485 ret
= request_threaded_irq(irq
, NULL
, regmap_irq_thread
, irq_flags
,
488 dev_err(map
->dev
, "Failed to request IRQ %d for %s: %d\n",
489 irq
, chip
->name
, ret
);
496 /* Should really dispose of the domain but... */
499 kfree(d
->mask_buf_def
);
501 kfree(d
->status_buf
);
502 kfree(d
->status_reg_buf
);
506 EXPORT_SYMBOL_GPL(regmap_add_irq_chip
);
509 * regmap_del_irq_chip(): Stop interrupt handling for a regmap IRQ chip
511 * @irq: Primary IRQ for the device
512 * @d: regmap_irq_chip_data allocated by regmap_add_irq_chip()
514 void regmap_del_irq_chip(int irq
, struct regmap_irq_chip_data
*d
)
520 /* We should unmap the domain but... */
522 kfree(d
->mask_buf_def
);
524 kfree(d
->status_reg_buf
);
525 kfree(d
->status_buf
);
528 EXPORT_SYMBOL_GPL(regmap_del_irq_chip
);
531 * regmap_irq_chip_get_base(): Retrieve interrupt base for a regmap IRQ chip
533 * Useful for drivers to request their own IRQs.
535 * @data: regmap_irq controller to operate on.
537 int regmap_irq_chip_get_base(struct regmap_irq_chip_data
*data
)
539 WARN_ON(!data
->irq_base
);
540 return data
->irq_base
;
542 EXPORT_SYMBOL_GPL(regmap_irq_chip_get_base
);
545 * regmap_irq_get_virq(): Map an interrupt on a chip to a virtual IRQ
547 * Useful for drivers to request their own IRQs.
549 * @data: regmap_irq controller to operate on.
550 * @irq: index of the interrupt requested in the chip IRQs
552 int regmap_irq_get_virq(struct regmap_irq_chip_data
*data
, int irq
)
554 /* Handle holes in the IRQ list */
555 if (!data
->chip
->irqs
[irq
].mask
)
558 return irq_create_mapping(data
->domain
, irq
);
560 EXPORT_SYMBOL_GPL(regmap_irq_get_virq
);
563 * regmap_irq_get_domain(): Retrieve the irq_domain for the chip
565 * Useful for drivers to request their own IRQs and for integration
566 * with subsystems. For ease of integration NULL is accepted as a
567 * domain, allowing devices to just call this even if no domain is
570 * @data: regmap_irq controller to operate on.
572 struct irq_domain
*regmap_irq_get_domain(struct regmap_irq_chip_data
*data
)
579 EXPORT_SYMBOL_GPL(regmap_irq_get_domain
);