2 * Library implementing the most common irq chip callback functions
4 * Copyright (C) 2011, Thomas Gleixner
8 #include <linux/slab.h>
9 #include <linux/export.h>
10 #include <linux/interrupt.h>
11 #include <linux/kernel_stat.h>
12 #include <linux/syscore_ops.h>
14 #include "internals.h"
16 static LIST_HEAD(gc_list
);
17 static DEFINE_RAW_SPINLOCK(gc_lock
);
19 static inline struct irq_chip_regs
*cur_regs(struct irq_data
*d
)
21 return &container_of(d
->chip
, struct irq_chip_type
, chip
)->regs
;
25 * irq_gc_noop - NOOP function
28 void irq_gc_noop(struct irq_data
*d
)
33 * irq_gc_mask_disable_reg - Mask chip via disable register
36 * Chip has separate enable/disable registers instead of a single mask
39 void irq_gc_mask_disable_reg(struct irq_data
*d
)
41 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
42 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
45 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->disable
);
46 gc
->mask_cache
&= ~mask
;
51 * irq_gc_mask_set_mask_bit - Mask chip via setting bit in mask register
54 * Chip has a single mask register. Values of this register are cached
55 * and protected by gc->lock
57 void irq_gc_mask_set_bit(struct irq_data
*d
)
59 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
60 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
63 gc
->mask_cache
|= mask
;
64 irq_reg_writel(gc
->mask_cache
, gc
->reg_base
+ cur_regs(d
)->mask
);
69 * irq_gc_mask_set_mask_bit - Mask chip via clearing bit in mask register
72 * Chip has a single mask register. Values of this register are cached
73 * and protected by gc->lock
75 void irq_gc_mask_clr_bit(struct irq_data
*d
)
77 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
78 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
81 gc
->mask_cache
&= ~mask
;
82 irq_reg_writel(gc
->mask_cache
, gc
->reg_base
+ cur_regs(d
)->mask
);
87 * irq_gc_unmask_enable_reg - Unmask chip via enable register
90 * Chip has separate enable/disable registers instead of a single mask
93 void irq_gc_unmask_enable_reg(struct irq_data
*d
)
95 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
96 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
99 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->enable
);
100 gc
->mask_cache
|= mask
;
105 * irq_gc_ack_set_bit - Ack pending interrupt via setting bit
108 void irq_gc_ack_set_bit(struct irq_data
*d
)
110 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
111 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
114 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->ack
);
119 * irq_gc_ack_clr_bit - Ack pending interrupt via clearing bit
122 void irq_gc_ack_clr_bit(struct irq_data
*d
)
124 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
125 u32 mask
= ~(1 << (d
->irq
- gc
->irq_base
));
128 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->ack
);
133 * irq_gc_mask_disable_reg_and_ack- Mask and ack pending interrupt
136 void irq_gc_mask_disable_reg_and_ack(struct irq_data
*d
)
138 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
139 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
142 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->mask
);
143 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->ack
);
148 * irq_gc_eoi - EOI interrupt
151 void irq_gc_eoi(struct irq_data
*d
)
153 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
154 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
157 irq_reg_writel(mask
, gc
->reg_base
+ cur_regs(d
)->eoi
);
162 * irq_gc_set_wake - Set/clr wake bit for an interrupt
165 * For chips where the wake from suspend functionality is not
166 * configured in a separate register and the wakeup active state is
167 * just stored in a bitmask.
169 int irq_gc_set_wake(struct irq_data
*d
, unsigned int on
)
171 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
172 u32 mask
= 1 << (d
->irq
- gc
->irq_base
);
174 if (!(mask
& gc
->wake_enabled
))
179 gc
->wake_active
|= mask
;
181 gc
->wake_active
&= ~mask
;
187 * irq_alloc_generic_chip - Allocate a generic chip and initialize it
188 * @name: Name of the irq chip
189 * @num_ct: Number of irq_chip_type instances associated with this
190 * @irq_base: Interrupt base nr for this chip
191 * @reg_base: Register base address (virtual)
192 * @handler: Default flow handler associated with this chip
194 * Returns an initialized irq_chip_generic structure. The chip defaults
195 * to the primary (index 0) irq_chip_type and @handler
197 struct irq_chip_generic
*
198 irq_alloc_generic_chip(const char *name
, int num_ct
, unsigned int irq_base
,
199 void __iomem
*reg_base
, irq_flow_handler_t handler
)
201 struct irq_chip_generic
*gc
;
202 unsigned long sz
= sizeof(*gc
) + num_ct
* sizeof(struct irq_chip_type
);
204 gc
= kzalloc(sz
, GFP_KERNEL
);
206 raw_spin_lock_init(&gc
->lock
);
208 gc
->irq_base
= irq_base
;
209 gc
->reg_base
= reg_base
;
210 gc
->chip_types
->chip
.name
= name
;
211 gc
->chip_types
->handler
= handler
;
215 EXPORT_SYMBOL_GPL(irq_alloc_generic_chip
);
218 * Separate lockdep class for interrupt chip which can nest irq_desc
221 static struct lock_class_key irq_nested_lock_class
;
224 * irq_setup_generic_chip - Setup a range of interrupts with a generic chip
225 * @gc: Generic irq chip holding all data
226 * @msk: Bitmask holding the irqs to initialize relative to gc->irq_base
227 * @flags: Flags for initialization
228 * @clr: IRQ_* bits to clear
229 * @set: IRQ_* bits to set
231 * Set up max. 32 interrupts starting from gc->irq_base. Note, this
232 * initializes all interrupts to the primary irq_chip_type and its
233 * associated handler.
235 void irq_setup_generic_chip(struct irq_chip_generic
*gc
, u32 msk
,
236 enum irq_gc_flags flags
, unsigned int clr
,
239 struct irq_chip_type
*ct
= gc
->chip_types
;
242 raw_spin_lock(&gc_lock
);
243 list_add_tail(&gc
->list
, &gc_list
);
244 raw_spin_unlock(&gc_lock
);
246 /* Init mask cache ? */
247 if (flags
& IRQ_GC_INIT_MASK_CACHE
)
248 gc
->mask_cache
= irq_reg_readl(gc
->reg_base
+ ct
->regs
.mask
);
250 for (i
= gc
->irq_base
; msk
; msk
>>= 1, i
++) {
254 if (flags
& IRQ_GC_INIT_NESTED_LOCK
)
255 irq_set_lockdep_class(i
, &irq_nested_lock_class
);
257 irq_set_chip_and_handler(i
, &ct
->chip
, ct
->handler
);
258 irq_set_chip_data(i
, gc
);
259 irq_modify_status(i
, clr
, set
);
261 gc
->irq_cnt
= i
- gc
->irq_base
;
263 EXPORT_SYMBOL_GPL(irq_setup_generic_chip
);
266 * irq_setup_alt_chip - Switch to alternative chip
267 * @d: irq_data for this interrupt
268 * @type Flow type to be initialized
270 * Only to be called from chip->irq_set_type() callbacks.
272 int irq_setup_alt_chip(struct irq_data
*d
, unsigned int type
)
274 struct irq_chip_generic
*gc
= irq_data_get_irq_chip_data(d
);
275 struct irq_chip_type
*ct
= gc
->chip_types
;
278 for (i
= 0; i
< gc
->num_ct
; i
++, ct
++) {
279 if (ct
->type
& type
) {
281 irq_data_to_desc(d
)->handle_irq
= ct
->handler
;
287 EXPORT_SYMBOL_GPL(irq_setup_alt_chip
);
290 * irq_remove_generic_chip - Remove a chip
291 * @gc: Generic irq chip holding all data
292 * @msk: Bitmask holding the irqs to initialize relative to gc->irq_base
293 * @clr: IRQ_* bits to clear
294 * @set: IRQ_* bits to set
296 * Remove up to 32 interrupts starting from gc->irq_base.
298 void irq_remove_generic_chip(struct irq_chip_generic
*gc
, u32 msk
,
299 unsigned int clr
, unsigned int set
)
301 unsigned int i
= gc
->irq_base
;
303 raw_spin_lock(&gc_lock
);
305 raw_spin_unlock(&gc_lock
);
307 for (; msk
; msk
>>= 1, i
++) {
311 /* Remove handler first. That will mask the irq line */
312 irq_set_handler(i
, NULL
);
313 irq_set_chip(i
, &no_irq_chip
);
314 irq_set_chip_data(i
, NULL
);
315 irq_modify_status(i
, clr
, set
);
318 EXPORT_SYMBOL_GPL(irq_remove_generic_chip
);
321 static int irq_gc_suspend(void)
323 struct irq_chip_generic
*gc
;
325 list_for_each_entry(gc
, &gc_list
, list
) {
326 struct irq_chip_type
*ct
= gc
->chip_types
;
328 if (ct
->chip
.irq_suspend
)
329 ct
->chip
.irq_suspend(irq_get_irq_data(gc
->irq_base
));
334 static void irq_gc_resume(void)
336 struct irq_chip_generic
*gc
;
338 list_for_each_entry(gc
, &gc_list
, list
) {
339 struct irq_chip_type
*ct
= gc
->chip_types
;
341 if (ct
->chip
.irq_resume
)
342 ct
->chip
.irq_resume(irq_get_irq_data(gc
->irq_base
));
346 #define irq_gc_suspend NULL
347 #define irq_gc_resume NULL
350 static void irq_gc_shutdown(void)
352 struct irq_chip_generic
*gc
;
354 list_for_each_entry(gc
, &gc_list
, list
) {
355 struct irq_chip_type
*ct
= gc
->chip_types
;
357 if (ct
->chip
.irq_pm_shutdown
)
358 ct
->chip
.irq_pm_shutdown(irq_get_irq_data(gc
->irq_base
));
362 static struct syscore_ops irq_gc_syscore_ops
= {
363 .suspend
= irq_gc_suspend
,
364 .resume
= irq_gc_resume
,
365 .shutdown
= irq_gc_shutdown
,
368 static int __init
irq_gc_init_ops(void)
370 register_syscore_ops(&irq_gc_syscore_ops
);
373 device_initcall(irq_gc_init_ops
);