regmap: Fix typo in IRQ register striding
[linux-2.6.git] / drivers / base / regmap / regmap-irq.c
1 /*
2  * regmap based irq_chip
3  *
4  * Copyright 2011 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/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/slab.h>
19
20 #include "internal.h"
21
22 struct regmap_irq_chip_data {
23         struct mutex lock;
24
25         struct regmap *map;
26         struct regmap_irq_chip *chip;
27
28         int irq_base;
29
30         unsigned int *status_buf;
31         unsigned int *mask_buf;
32         unsigned int *mask_buf_def;
33
34         unsigned int irq_reg_stride;
35 };
36
37 static inline const
38 struct regmap_irq *irq_to_regmap_irq(struct regmap_irq_chip_data *data,
39                                      int irq)
40 {
41         return &data->chip->irqs[irq - data->irq_base];
42 }
43
44 static void regmap_irq_lock(struct irq_data *data)
45 {
46         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
47
48         mutex_lock(&d->lock);
49 }
50
51 static void regmap_irq_sync_unlock(struct irq_data *data)
52 {
53         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
54         struct regmap *map = d->map;
55         int i, ret;
56
57         /*
58          * If there's been a change in the mask write it back to the
59          * hardware.  We rely on the use of the regmap core cache to
60          * suppress pointless writes.
61          */
62         for (i = 0; i < d->chip->num_regs; i++) {
63                 ret = regmap_update_bits(d->map, d->chip->mask_base +
64                                                 (i * map->reg_stride *
65                                                 d->irq_reg_stride),
66                                          d->mask_buf_def[i], d->mask_buf[i]);
67                 if (ret != 0)
68                         dev_err(d->map->dev, "Failed to sync masks in %x\n",
69                                 d->chip->mask_base + (i * map->reg_stride));
70         }
71
72         mutex_unlock(&d->lock);
73 }
74
75 static void regmap_irq_enable(struct irq_data *data)
76 {
77         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
78         struct regmap *map = d->map;
79         const struct regmap_irq *irq_data = irq_to_regmap_irq(d, data->irq);
80
81         d->mask_buf[irq_data->reg_offset / map->reg_stride] &= ~irq_data->mask;
82 }
83
84 static void regmap_irq_disable(struct irq_data *data)
85 {
86         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
87         struct regmap *map = d->map;
88         const struct regmap_irq *irq_data = irq_to_regmap_irq(d, data->irq);
89
90         d->mask_buf[irq_data->reg_offset / map->reg_stride] |= irq_data->mask;
91 }
92
93 static struct irq_chip regmap_irq_chip = {
94         .name                   = "regmap",
95         .irq_bus_lock           = regmap_irq_lock,
96         .irq_bus_sync_unlock    = regmap_irq_sync_unlock,
97         .irq_disable            = regmap_irq_disable,
98         .irq_enable             = regmap_irq_enable,
99 };
100
101 static irqreturn_t regmap_irq_thread(int irq, void *d)
102 {
103         struct regmap_irq_chip_data *data = d;
104         struct regmap_irq_chip *chip = data->chip;
105         struct regmap *map = data->map;
106         int ret, i;
107         bool handled = false;
108
109         /*
110          * Ignore masked IRQs and ack if we need to; we ack early so
111          * there is no race between handling and acknowleding the
112          * interrupt.  We assume that typically few of the interrupts
113          * will fire simultaneously so don't worry about overhead from
114          * doing a write per register.
115          */
116         for (i = 0; i < data->chip->num_regs; i++) {
117                 ret = regmap_read(map, chip->status_base + (i * map->reg_stride
118                                    * data->irq_reg_stride),
119                                    &data->status_buf[i]);
120
121                 if (ret != 0) {
122                         dev_err(map->dev, "Failed to read IRQ status: %d\n",
123                                         ret);
124                         return IRQ_NONE;
125                 }
126
127                 data->status_buf[i] &= ~data->mask_buf[i];
128
129                 if (data->status_buf[i] && chip->ack_base) {
130                         ret = regmap_write(map, chip->ack_base +
131                                                 (i * map->reg_stride *
132                                                 data->irq_reg_stride),
133                                            data->status_buf[i]);
134                         if (ret != 0)
135                                 dev_err(map->dev, "Failed to ack 0x%x: %d\n",
136                                         chip->ack_base + (i * map->reg_stride),
137                                         ret);
138                 }
139         }
140
141         for (i = 0; i < chip->num_irqs; i++) {
142                 if (data->status_buf[chip->irqs[i].reg_offset /
143                                      map->reg_stride] & chip->irqs[i].mask) {
144                         handle_nested_irq(data->irq_base + i);
145                         handled = true;
146                 }
147         }
148
149         if (handled)
150                 return IRQ_HANDLED;
151         else
152                 return IRQ_NONE;
153 }
154
155 /**
156  * regmap_add_irq_chip(): Use standard regmap IRQ controller handling
157  *
158  * map:       The regmap for the device.
159  * irq:       The IRQ the device uses to signal interrupts
160  * irq_flags: The IRQF_ flags to use for the primary interrupt.
161  * chip:      Configuration for the interrupt controller.
162  * data:      Runtime data structure for the controller, allocated on success
163  *
164  * Returns 0 on success or an errno on failure.
165  *
166  * In order for this to be efficient the chip really should use a
167  * register cache.  The chip driver is responsible for restoring the
168  * register values used by the IRQ controller over suspend and resume.
169  */
170 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
171                         int irq_base, struct regmap_irq_chip *chip,
172                         struct regmap_irq_chip_data **data)
173 {
174         struct regmap_irq_chip_data *d;
175         int cur_irq, i;
176         int ret = -ENOMEM;
177
178         for (i = 0; i < chip->num_irqs; i++) {
179                 if (chip->irqs[i].reg_offset % map->reg_stride)
180                         return -EINVAL;
181                 if (chip->irqs[i].reg_offset / map->reg_stride >=
182                     chip->num_regs)
183                         return -EINVAL;
184         }
185
186         irq_base = irq_alloc_descs(irq_base, 0, chip->num_irqs, 0);
187         if (irq_base < 0) {
188                 dev_warn(map->dev, "Failed to allocate IRQs: %d\n",
189                          irq_base);
190                 return irq_base;
191         }
192
193         d = kzalloc(sizeof(*d), GFP_KERNEL);
194         if (!d)
195                 return -ENOMEM;
196
197         *data = d;
198
199         d->status_buf = kzalloc(sizeof(unsigned int) * chip->num_regs,
200                                 GFP_KERNEL);
201         if (!d->status_buf)
202                 goto err_alloc;
203
204         d->mask_buf = kzalloc(sizeof(unsigned int) * chip->num_regs,
205                               GFP_KERNEL);
206         if (!d->mask_buf)
207                 goto err_alloc;
208
209         d->mask_buf_def = kzalloc(sizeof(unsigned int) * chip->num_regs,
210                                   GFP_KERNEL);
211         if (!d->mask_buf_def)
212                 goto err_alloc;
213
214         d->map = map;
215         d->chip = chip;
216         d->irq_base = irq_base;
217
218         if (chip->irq_reg_stride)
219                 d->irq_reg_stride = chip->irq_reg_stride;
220         else
221                 d->irq_reg_stride = 1;
222
223         mutex_init(&d->lock);
224
225         for (i = 0; i < chip->num_irqs; i++)
226                 d->mask_buf_def[chip->irqs[i].reg_offset / map->reg_stride]
227                         |= chip->irqs[i].mask;
228
229         /* Mask all the interrupts by default */
230         for (i = 0; i < chip->num_regs; i++) {
231                 d->mask_buf[i] = d->mask_buf_def[i];
232                 ret = regmap_write(map, chip->mask_base + (i * map->reg_stride
233                                    * d->irq_reg_stride),
234                                    d->mask_buf[i]);
235                 if (ret != 0) {
236                         dev_err(map->dev, "Failed to set masks in 0x%x: %d\n",
237                                 chip->mask_base + (i * map->reg_stride), ret);
238                         goto err_alloc;
239                 }
240         }
241
242         /* Register them with genirq */
243         for (cur_irq = irq_base;
244              cur_irq < chip->num_irqs + irq_base;
245              cur_irq++) {
246                 irq_set_chip_data(cur_irq, d);
247                 irq_set_chip_and_handler(cur_irq, &regmap_irq_chip,
248                                          handle_edge_irq);
249                 irq_set_nested_thread(cur_irq, 1);
250
251                 /* ARM needs us to explicitly flag the IRQ as valid
252                  * and will set them noprobe when we do so. */
253 #ifdef CONFIG_ARM
254                 set_irq_flags(cur_irq, IRQF_VALID);
255 #else
256                 irq_set_noprobe(cur_irq);
257 #endif
258         }
259
260         ret = request_threaded_irq(irq, NULL, regmap_irq_thread, irq_flags,
261                                    chip->name, d);
262         if (ret != 0) {
263                 dev_err(map->dev, "Failed to request IRQ %d: %d\n", irq, ret);
264                 goto err_alloc;
265         }
266
267         return 0;
268
269 err_alloc:
270         kfree(d->mask_buf_def);
271         kfree(d->mask_buf);
272         kfree(d->status_buf);
273         kfree(d);
274         return ret;
275 }
276 EXPORT_SYMBOL_GPL(regmap_add_irq_chip);
277
278 /**
279  * regmap_del_irq_chip(): Stop interrupt handling for a regmap IRQ chip
280  *
281  * @irq: Primary IRQ for the device
282  * @d:   regmap_irq_chip_data allocated by regmap_add_irq_chip()
283  */
284 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *d)
285 {
286         if (!d)
287                 return;
288
289         free_irq(irq, d);
290         kfree(d->mask_buf_def);
291         kfree(d->mask_buf);
292         kfree(d->status_buf);
293         kfree(d);
294 }
295 EXPORT_SYMBOL_GPL(regmap_del_irq_chip);
296
297 /**
298  * regmap_irq_chip_get_base(): Retrieve interrupt base for a regmap IRQ chip
299  *
300  * Useful for drivers to request their own IRQs.
301  *
302  * @data: regmap_irq controller to operate on.
303  */
304 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data)
305 {
306         return data->irq_base;
307 }
308 EXPORT_SYMBOL_GPL(regmap_irq_chip_get_base);