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/irqdomain.h>
  19 #include <linux/slab.h>
  20
  21 #include "internal.h"
  22
  23 struct regmap_irq_chip_data {
  24         struct mutex lock;
  25         struct irq_chip irq_chip;
  26
  27         struct regmap *map;
  28         const struct regmap_irq_chip *chip;
  29
  30         int irq_base;
  31         struct irq_domain *domain;
  32
  33         int irq;
  34         int wake_count;
  35
  36         unsigned int *status_buf;
  37         unsigned int *mask_buf;
  38         unsigned int *mask_buf_def;
  39         unsigned int *wake_buf;
  40
  41         unsigned int irq_reg_stride;
  42 };
  43
  44 static inline const
  45 struct regmap_irq *irq_to_regmap_irq(struct regmap_irq_chip_data *data,
  46                                      int irq)
  47 {
  48         return &data->chip->irqs[irq];
  49 }
  50
  51 static void regmap_irq_lock(struct irq_data *data)
  52 {
  53         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
  54
  55         mutex_lock(&d->lock);
  56 }
  57
  58 static void regmap_irq_sync_unlock(struct irq_data *data)
  59 {
  60         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
  61         struct regmap *map = d->map;
  62         int i, ret;
  63         u32 reg;
  64
  65         /*
  66          * If there's been a change in the mask write it back to the
  67          * hardware.  We rely on the use of the regmap core cache to
  68          * suppress pointless writes.
  69          */
  70         for (i = 0; i < d->chip->num_regs; i++) {
  71                 reg = d->chip->mask_base +
  72                         (i * map->reg_stride * d->irq_reg_stride);
  73                 ret = regmap_update_bits(d->map, reg,
  74                                          d->mask_buf_def[i], d->mask_buf[i]);
  75                 if (ret != 0)
  76                         dev_err(d->map->dev, "Failed to sync masks in %x\n",
  77                                 reg);
  78         }
  79
  80         /* If we've changed our wakeup count propagate it to the parent */
  81         if (d->wake_count < 0)
  82                 for (i = d->wake_count; i < 0; i++)
  83                         irq_set_irq_wake(d->irq, 0);
  84         else if (d->wake_count > 0)
  85                 for (i = 0; i < d->wake_count; i++)
  86                         irq_set_irq_wake(d->irq, 1);
  87
  88         d->wake_count = 0;
  89
  90         mutex_unlock(&d->lock);
  91 }
  92
  93 static void regmap_irq_enable(struct irq_data *data)
  94 {
  95         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
  96         struct regmap *map = d->map;
  97         const struct regmap_irq *irq_data = irq_to_regmap_irq(d, data->hwirq);
  98
  99         d->mask_buf[irq_data->reg_offset / map->reg_stride] &= ~irq_data->mask;
 100 }
 101
 102 static void regmap_irq_disable(struct irq_data *data)
 103 {
 104         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
 105         struct regmap *map = d->map;
 106         const struct regmap_irq *irq_data = irq_to_regmap_irq(d, data->hwirq);
 107
 108         d->mask_buf[irq_data->reg_offset / map->reg_stride] |= irq_data->mask;
 109 }
 110
 111 static int regmap_irq_set_wake(struct irq_data *data, unsigned int on)
 112 {
 113         struct regmap_irq_chip_data *d = irq_data_get_irq_chip_data(data);
 114         struct regmap *map = d->map;
 115         const struct regmap_irq *irq_data = irq_to_regmap_irq(d, data->hwirq);
 116
 117         if (!d->chip->wake_base)
 118                 return -EINVAL;
 119
 120         if (on) {
 121                 d->wake_buf[irq_data->reg_offset / map->reg_stride]
 122                         &= ~irq_data->mask;
 123                 d->wake_count++;
 124         } else {
 125                 d->wake_buf[irq_data->reg_offset / map->reg_stride]
 126                         |= irq_data->mask;
 127                 d->wake_count--;
 128         }
 129
 130         return 0;
 131 }
 132
 133 static const struct irq_chip regmap_irq_chip = {
 134         .irq_bus_lock           = regmap_irq_lock,
 135         .irq_bus_sync_unlock    = regmap_irq_sync_unlock,
 136         .irq_disable            = regmap_irq_disable,
 137         .irq_enable             = regmap_irq_enable,
 138         .irq_set_wake           = regmap_irq_set_wake,
 139 };
 140
 141 static irqreturn_t regmap_irq_thread(int irq, void *d)
 142 {
 143         struct regmap_irq_chip_data *data = d;
 144         const struct regmap_irq_chip *chip = data->chip;
 145         struct regmap *map = data->map;
 146         int ret, i;
 147         bool handled = false;
 148         u32 reg;
 149
 150         /*
 151          * Ignore masked IRQs and ack if we need to; we ack early so
 152          * there is no race between handling and acknowleding the
 153          * interrupt.  We assume that typically few of the interrupts
 154          * will fire simultaneously so don't worry about overhead from
 155          * doing a write per register.
 156          */
 157         for (i = 0; i < data->chip->num_regs; i++) {
 158                 ret = regmap_read(map, chip->status_base + (i * map->reg_stride
 159                                    * data->irq_reg_stride),
 160                                    &data->status_buf[i]);
 161
 162                 if (ret != 0) {
 163                         dev_err(map->dev, "Failed to read IRQ status: %d\n",
 164                                         ret);
 165                         return IRQ_NONE;
 166                 }
 167
 168                 data->status_buf[i] &= ~data->mask_buf[i];
 169
 170                 if (data->status_buf[i] && chip->ack_base) {
 171                         reg = chip->ack_base +
 172                                 (i * map->reg_stride * data->irq_reg_stride);
 173                         ret = regmap_write(map, reg, data->status_buf[i]);
 174                         if (ret != 0)
 175                                 dev_err(map->dev, "Failed to ack 0x%x: %d\n",
 176                                         reg, ret);
 177                 }
 178         }
 179
 180         for (i = 0; i < chip->num_irqs; i++) {
 181                 if (data->status_buf[chip->irqs[i].reg_offset /
 182                                      map->reg_stride] & chip->irqs[i].mask) {
 183                         handle_nested_irq(irq_find_mapping(data->domain, i));
 184                         handled = true;
 185                 }
 186         }
 187
 188         if (handled)
 189                 return IRQ_HANDLED;
 190         else
 191                 return IRQ_NONE;
 192 }
 193
 194 static int regmap_irq_map(struct irq_domain *h, unsigned int virq,
 195                           irq_hw_number_t hw)
 196 {
 197         struct regmap_irq_chip_data *data = h->host_data;
 198
 199         irq_set_chip_data(virq, data);
 200         irq_set_chip_and_handler(virq, &data->irq_chip, handle_edge_irq);
 201         irq_set_nested_thread(virq, 1);
 202
 203         /* ARM needs us to explicitly flag the IRQ as valid
 204          * and will set them noprobe when we do so. */
 205 #ifdef CONFIG_ARM
 206         set_irq_flags(virq, IRQF_VALID);
 207 #else
 208         irq_set_noprobe(virq);
 209 #endif
 210
 211         return 0;
 212 }
 213
 214 static struct irq_domain_ops regmap_domain_ops = {
 215         .map    = regmap_irq_map,
 216         .xlate  = irq_domain_xlate_twocell,
 217 };
 218
 219 /**
 220  * regmap_add_irq_chip(): Use standard regmap IRQ controller handling
 221  *
 222  * map:       The regmap for the device.
 223  * irq:       The IRQ the device uses to signal interrupts
 224  * irq_flags: The IRQF_ flags to use for the primary interrupt.
 225  * chip:      Configuration for the interrupt controller.
 226  * data:      Runtime data structure for the controller, allocated on success
 227  *
 228  * Returns 0 on success or an errno on failure.
 229  *
 230  * In order for this to be efficient the chip really should use a
 231  * register cache.  The chip driver is responsible for restoring the
 232  * register values used by the IRQ controller over suspend and resume.
 233  */
 234 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
 235                         int irq_base, const struct regmap_irq_chip *chip,
 236                         struct regmap_irq_chip_data **data)
 237 {
 238         struct regmap_irq_chip_data *d;
 239         int i;
 240         int ret = -ENOMEM;
 241         u32 reg;
 242
 243         for (i = 0; i < chip->num_irqs; i++) {
 244                 if (chip->irqs[i].reg_offset % map->reg_stride)
 245                         return -EINVAL;
 246                 if (chip->irqs[i].reg_offset / map->reg_stride >=
 247                     chip->num_regs)
 248                         return -EINVAL;
 249         }
 250
 251         if (irq_base) {
 252                 irq_base = irq_alloc_descs(irq_base, 0, chip->num_irqs, 0);
 253                 if (irq_base < 0) {
 254                         dev_warn(map->dev, "Failed to allocate IRQs: %d\n",
 255                                  irq_base);
 256                         return irq_base;
 257                 }
 258         }
 259
 260         d = kzalloc(sizeof(*d), GFP_KERNEL);
 261         if (!d)
 262                 return -ENOMEM;
 263
 264         *data = d;
 265
 266         d->status_buf = kzalloc(sizeof(unsigned int) * chip->num_regs,
 267                                 GFP_KERNEL);
 268         if (!d->status_buf)
 269                 goto err_alloc;
 270
 271         d->mask_buf = kzalloc(sizeof(unsigned int) * chip->num_regs,
 272                               GFP_KERNEL);
 273         if (!d->mask_buf)
 274                 goto err_alloc;
 275
 276         d->mask_buf_def = kzalloc(sizeof(unsigned int) * chip->num_regs,
 277                                   GFP_KERNEL);
 278         if (!d->mask_buf_def)
 279                 goto err_alloc;
 280
 281         if (chip->wake_base) {
 282                 d->wake_buf = kzalloc(sizeof(unsigned int) * chip->num_regs,
 283                                       GFP_KERNEL);
 284                 if (!d->wake_buf)
 285                         goto err_alloc;
 286         }
 287
 288         d->irq_chip = regmap_irq_chip;
 289         d->irq_chip.name = chip->name;
 290         d->irq = irq;
 291         d->map = map;
 292         d->chip = chip;
 293         d->irq_base = irq_base;
 294
 295         if (chip->irq_reg_stride)
 296                 d->irq_reg_stride = chip->irq_reg_stride;
 297         else
 298                 d->irq_reg_stride = 1;
 299
 300         mutex_init(&d->lock);
 301
 302         for (i = 0; i < chip->num_irqs; i++)
 303                 d->mask_buf_def[chip->irqs[i].reg_offset / map->reg_stride]
 304                         |= chip->irqs[i].mask;
 305
 306         /* Mask all the interrupts by default */
 307         for (i = 0; i < chip->num_regs; i++) {
 308                 d->mask_buf[i] = d->mask_buf_def[i];
 309                 reg = chip->mask_base +
 310                         (i * map->reg_stride * d->irq_reg_stride);
 311                 ret = regmap_update_bits(map, reg,
 312                                          d->mask_buf[i], d->mask_buf[i]);
 313                 if (ret != 0) {
 314                         dev_err(map->dev, "Failed to set masks in 0x%x: %d\n",
 315                                 reg, ret);
 316                         goto err_alloc;
 317                 }
 318         }
 319
 320         if (irq_base)
 321                 d->domain = irq_domain_add_legacy(map->dev->of_node,
 322                                                   chip->num_irqs, irq_base, 0,
 323                                                   &regmap_domain_ops, d);
 324         else
 325                 d->domain = irq_domain_add_linear(map->dev->of_node,
 326                                                   chip->num_irqs,
 327                                                   &regmap_domain_ops, d);
 328         if (!d->domain) {
 329                 dev_err(map->dev, "Failed to create IRQ domain\n");
 330                 ret = -ENOMEM;
 331                 goto err_alloc;
 332         }
 333
 334         ret = request_threaded_irq(irq, NULL, regmap_irq_thread, irq_flags,
 335                                    chip->name, d);
 336         if (ret != 0) {
 337                 dev_err(map->dev, "Failed to request IRQ %d: %d\n", irq, ret);
 338                 goto err_domain;
 339         }
 340
 341         return 0;
 342
 343 err_domain:
 344         /* Should really dispose of the domain but... */
 345 err_alloc:
 346         kfree(d->wake_buf);
 347         kfree(d->mask_buf_def);
 348         kfree(d->mask_buf);
 349         kfree(d->status_buf);
 350         kfree(d);
 351         return ret;
 352 }
 353 EXPORT_SYMBOL_GPL(regmap_add_irq_chip);
 354
 355 /**
 356  * regmap_del_irq_chip(): Stop interrupt handling for a regmap IRQ chip
 357  *
 358  * @irq: Primary IRQ for the device
 359  * @d:   regmap_irq_chip_data allocated by regmap_add_irq_chip()
 360  */
 361 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *d)
 362 {
 363         if (!d)
 364                 return;
 365
 366         free_irq(irq, d);
 367         /* We should unmap the domain but... */
 368         kfree(d->wake_buf);
 369         kfree(d->mask_buf_def);
 370         kfree(d->mask_buf);
 371         kfree(d->status_buf);
 372         kfree(d);
 373 }
 374 EXPORT_SYMBOL_GPL(regmap_del_irq_chip);
 375
 376 /**
 377  * regmap_irq_chip_get_base(): Retrieve interrupt base for a regmap IRQ chip
 378  *
 379  * Useful for drivers to request their own IRQs.
 380  *
 381  * @data: regmap_irq controller to operate on.
 382  */
 383 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data)
 384 {
 385         WARN_ON(!data->irq_base);
 386         return data->irq_base;
 387 }
 388 EXPORT_SYMBOL_GPL(regmap_irq_chip_get_base);
 389
 390 /**
 391  * regmap_irq_get_virq(): Map an interrupt on a chip to a virtual IRQ
 392  *
 393  * Useful for drivers to request their own IRQs.
 394  *
 395  * @data: regmap_irq controller to operate on.
 396  * @irq: index of the interrupt requested in the chip IRQs
 397  */
 398 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq)
 399 {
 400         /* Handle holes in the IRQ list */
 401         if (!data->chip->irqs[irq].mask)
 402                 return -EINVAL;
 403
 404         return irq_create_mapping(data->domain, irq);
 405 }
 406 EXPORT_SYMBOL_GPL(regmap_irq_get_virq);