drivers/uio/uio_pdrv_genirq.c

   1 /*
   2  * drivers/uio/uio_pdrv_genirq.c
   3  *
   4  * Userspace I/O platform driver with generic IRQ handling code.
   5  *
   6  * Copyright (C) 2008 Magnus Damm
   7  *
   8  * Based on uio_pdrv.c by Uwe Kleine-Koenig,
   9  * Copyright (C) 2008 by Digi International Inc.
  10  * All rights reserved.
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License version 2 as published by
  14  * the Free Software Foundation.
  15  */
  16
  17 #include <linux/platform_device.h>
  18 #include <linux/uio_driver.h>
  19 #include <linux/spinlock.h>
  20 #include <linux/bitops.h>
  21 #include <linux/module.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/stringify.h>
  24 #include <linux/pm_runtime.h>
  25 #include <linux/slab.h>
  26
  27 #include <linux/of.h>
  28 #include <linux/of_platform.h>
  29 #include <linux/of_address.h>
  30
  31 #define DRIVER_NAME "uio_pdrv_genirq"
  32
  33 struct uio_pdrv_genirq_platdata {
  34         struct uio_info *uioinfo;
  35         spinlock_t lock;
  36         unsigned long flags;
  37         struct platform_device *pdev;
  38 };
  39
  40 static int uio_pdrv_genirq_open(struct uio_info *info, struct inode *inode)
  41 {
  42         struct uio_pdrv_genirq_platdata *priv = info->priv;
  43
  44         /* Wait until the Runtime PM code has woken up the device */
  45         pm_runtime_get_sync(&priv->pdev->dev);
  46         return 0;
  47 }
  48
  49 static int uio_pdrv_genirq_release(struct uio_info *info, struct inode *inode)
  50 {
  51         struct uio_pdrv_genirq_platdata *priv = info->priv;
  52
  53         /* Tell the Runtime PM code that the device has become idle */
  54         pm_runtime_put_sync(&priv->pdev->dev);
  55         return 0;
  56 }
  57
  58 static irqreturn_t uio_pdrv_genirq_handler(int irq, struct uio_info *dev_info)
  59 {
  60         struct uio_pdrv_genirq_platdata *priv = dev_info->priv;
  61
  62         /* Just disable the interrupt in the interrupt controller, and
  63          * remember the state so we can allow user space to enable it later.
  64          */
  65
  66         if (!test_and_set_bit(0, &priv->flags))
  67                 disable_irq_nosync(irq);
  68
  69         return IRQ_HANDLED;
  70 }
  71
  72 static int uio_pdrv_genirq_irqcontrol(struct uio_info *dev_info, s32 irq_on)
  73 {
  74         struct uio_pdrv_genirq_platdata *priv = dev_info->priv;
  75         unsigned long flags;
  76
  77         /* Allow user space to enable and disable the interrupt
  78          * in the interrupt controller, but keep track of the
  79          * state to prevent per-irq depth damage.
  80          *
  81          * Serialize this operation to support multiple tasks.
  82          */
  83
  84         spin_lock_irqsave(&priv->lock, flags);
  85         if (irq_on) {
  86                 if (test_and_clear_bit(0, &priv->flags))
  87                         enable_irq(dev_info->irq);
  88         } else {
  89                 if (!test_and_set_bit(0, &priv->flags))
  90                         disable_irq(dev_info->irq);
  91         }
  92         spin_unlock_irqrestore(&priv->lock, flags);
  93
  94         return 0;
  95 }
  96
  97 static int uio_pdrv_genirq_probe(struct platform_device *pdev)
  98 {
  99         struct uio_info *uioinfo = pdev->dev.platform_data;
 100         struct uio_pdrv_genirq_platdata *priv;
 101         struct uio_mem *uiomem;
 102         int ret = -EINVAL;
 103         int i;
 104
 105         if (pdev->dev.of_node) {
 106                 /* alloc uioinfo for one device */
 107                 uioinfo = kzalloc(sizeof(*uioinfo), GFP_KERNEL);
 108                 if (!uioinfo) {
 109                         ret = -ENOMEM;
 110                         dev_err(&pdev->dev, "unable to kmalloc\n");
 111                         return ret;
 112                 }
 113                 uioinfo->name = pdev->dev.of_node->name;
 114                 uioinfo->version = "devicetree";
 115                 /* Multiple IRQs are not supported */
 116         }
 117
 118         if (!uioinfo || !uioinfo->name || !uioinfo->version) {
 119                 dev_err(&pdev->dev, "missing platform_data\n");
 120                 goto bad0;
 121         }
 122
 123         if (uioinfo->handler || uioinfo->irqcontrol ||
 124             uioinfo->irq_flags & IRQF_SHARED) {
 125                 dev_err(&pdev->dev, "interrupt configuration error\n");
 126                 goto bad0;
 127         }
 128
 129         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 130         if (!priv) {
 131                 ret = -ENOMEM;
 132                 dev_err(&pdev->dev, "unable to kmalloc\n");
 133                 goto bad0;
 134         }
 135
 136         priv->uioinfo = uioinfo;
 137         spin_lock_init(&priv->lock);
 138         priv->flags = 0; /* interrupt is enabled to begin with */
 139         priv->pdev = pdev;
 140
 141         if (!uioinfo->irq) {
 142                 ret = platform_get_irq(pdev, 0);
 143                 uioinfo->irq = ret;
 144                 if (ret == -ENXIO && pdev->dev.of_node)
 145                         uioinfo->irq = UIO_IRQ_NONE;
 146                 else if (ret < 0) {
 147                         dev_err(&pdev->dev, "failed to get IRQ\n");
 148                         goto bad1;
 149                 }
 150         }
 151
 152         uiomem = &uioinfo->mem[0];
 153
 154         for (i = 0; i < pdev->num_resources; ++i) {
 155                 struct resource *r = &pdev->resource[i];
 156
 157                 if (r->flags != IORESOURCE_MEM)
 158                         continue;
 159
 160                 if (uiomem >= &uioinfo->mem[MAX_UIO_MAPS]) {
 161                         dev_warn(&pdev->dev, "device has more than "
 162                                         __stringify(MAX_UIO_MAPS)
 163                                         " I/O memory resources.\n");
 164                         break;
 165                 }
 166
 167                 uiomem->memtype = UIO_MEM_PHYS;
 168                 uiomem->addr = r->start;
 169                 uiomem->size = resource_size(r);
 170                 uiomem->name = r->name;
 171                 ++uiomem;
 172         }
 173
 174         while (uiomem < &uioinfo->mem[MAX_UIO_MAPS]) {
 175                 uiomem->size = 0;
 176                 ++uiomem;
 177         }
 178
 179         /* This driver requires no hardware specific kernel code to handle
 180          * interrupts. Instead, the interrupt handler simply disables the
 181          * interrupt in the interrupt controller. User space is responsible
 182          * for performing hardware specific acknowledge and re-enabling of
 183          * the interrupt in the interrupt controller.
 184          *
 185          * Interrupt sharing is not supported.
 186          */
 187
 188         uioinfo->handler = uio_pdrv_genirq_handler;
 189         uioinfo->irqcontrol = uio_pdrv_genirq_irqcontrol;
 190         uioinfo->open = uio_pdrv_genirq_open;
 191         uioinfo->release = uio_pdrv_genirq_release;
 192         uioinfo->priv = priv;
 193
 194         /* Enable Runtime PM for this device:
 195          * The device starts in suspended state to allow the hardware to be
 196          * turned off by default. The Runtime PM bus code should power on the
 197          * hardware and enable clocks at open().
 198          */
 199         pm_runtime_enable(&pdev->dev);
 200
 201         ret = uio_register_device(&pdev->dev, priv->uioinfo);
 202         if (ret) {
 203                 dev_err(&pdev->dev, "unable to register uio device\n");
 204                 goto bad2;
 205         }
 206
 207         platform_set_drvdata(pdev, priv);
 208         return 0;
 209  bad2:
 210         pm_runtime_disable(&pdev->dev);
 211  bad1:
 212         kfree(priv);
 213  bad0:
 214         /* kfree uioinfo for OF */
 215         if (pdev->dev.of_node)
 216                 kfree(uioinfo);
 217         return ret;
 218 }
 219
 220 static int uio_pdrv_genirq_remove(struct platform_device *pdev)
 221 {
 222         struct uio_pdrv_genirq_platdata *priv = platform_get_drvdata(pdev);
 223
 224         uio_unregister_device(priv->uioinfo);
 225         pm_runtime_disable(&pdev->dev);
 226
 227         priv->uioinfo->handler = NULL;
 228         priv->uioinfo->irqcontrol = NULL;
 229
 230         /* kfree uioinfo for OF */
 231         if (pdev->dev.of_node)
 232                 kfree(priv->uioinfo);
 233
 234         kfree(priv);
 235         return 0;
 236 }
 237
 238 static int uio_pdrv_genirq_runtime_nop(struct device *dev)
 239 {
 240         /* Runtime PM callback shared between ->runtime_suspend()
 241          * and ->runtime_resume(). Simply returns success.
 242          *
 243          * In this driver pm_runtime_get_sync() and pm_runtime_put_sync()
 244          * are used at open() and release() time. This allows the
 245          * Runtime PM code to turn off power to the device while the
 246          * device is unused, ie before open() and after release().
 247          *
 248          * This Runtime PM callback does not need to save or restore
 249          * any registers since user space is responsbile for hardware
 250          * register reinitialization after open().
 251          */
 252         return 0;
 253 }
 254
 255 static const struct dev_pm_ops uio_pdrv_genirq_dev_pm_ops = {
 256         .runtime_suspend = uio_pdrv_genirq_runtime_nop,
 257         .runtime_resume = uio_pdrv_genirq_runtime_nop,
 258 };
 259
 260 #ifdef CONFIG_OF
 261 static struct of_device_id uio_of_genirq_match[] = {
 262         { /* This is filled with module_parm */ },
 263         { /* Sentinel */ },
 264 };
 265 MODULE_DEVICE_TABLE(of, uio_of_genirq_match);
 266
 267 module_param_string(of_id, uio_of_genirq_match[0].compatible, 128, 0);
 268 MODULE_PARM_DESC(of_id, "Openfirmware id of the device to be handled by uio");
 269 #else
 270 # define uio_of_genirq_match NULL
 271 #endif
 272
 273 static struct platform_driver uio_pdrv_genirq = {
 274         .probe = uio_pdrv_genirq_probe,
 275         .remove = uio_pdrv_genirq_remove,
 276         .driver = {
 277                 .name = DRIVER_NAME,
 278                 .owner = THIS_MODULE,
 279                 .pm = &uio_pdrv_genirq_dev_pm_ops,
 280                 .of_match_table = uio_of_genirq_match,
 281         },
 282 };
 283
 284 module_platform_driver(uio_pdrv_genirq);
 285
 286 MODULE_AUTHOR("Magnus Damm");
 287 MODULE_DESCRIPTION("Userspace I/O platform driver with generic IRQ handling");
 288 MODULE_LICENSE("GPL v2");
 289 MODULE_ALIAS("platform:" DRIVER_NAME);