include/linux/uio_driver.h

   1 /*
   2  * include/linux/uio_driver.h
   3  *
   4  * Copyright(C) 2005, Benedikt Spranger <b.spranger@linutronix.de>
   5  * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
   6  * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
   7  * Copyright(C) 2006, Greg Kroah-Hartman <greg@kroah.com>
   8  *
   9  * Userspace IO driver.
  10  *
  11  * Licensed under the GPLv2 only.
  12  */
  13
  14 #ifndef _UIO_DRIVER_H_
  15 #define _UIO_DRIVER_H_
  16
  17 #include <linux/module.h>
  18 #include <linux/fs.h>
  19 #include <linux/interrupt.h>
  20
  21 struct uio_map;
  22
  23 /**
  24  * struct uio_mem - description of a UIO memory region
  25  * @name:               name of the memory region for identification
  26  * @addr:               address of the device's memory
  27  * @size:               size of IO
  28  * @memtype:            type of memory addr points to
  29  * @internal_addr:      ioremap-ped version of addr, for driver internal use
  30  * @map:                for use by the UIO core only.
  31  */
  32 struct uio_mem {
  33         const char              *name;
  34         unsigned long           addr;
  35         unsigned long           size;
  36         int                     memtype;
  37         void __iomem            *internal_addr;
  38         struct uio_map          *map;
  39 };
  40
  41 #define MAX_UIO_MAPS    5
  42
  43 struct uio_portio;
  44
  45 /**
  46  * struct uio_port - description of a UIO port region
  47  * @name:               name of the port region for identification
  48  * @start:              start of port region
  49  * @size:               size of port region
  50  * @porttype:           type of port (see UIO_PORT_* below)
  51  * @portio:             for use by the UIO core only.
  52  */
  53 struct uio_port {
  54         const char              *name;
  55         unsigned long           start;
  56         unsigned long           size;
  57         int                     porttype;
  58         struct uio_portio       *portio;
  59 };
  60
  61 #define MAX_UIO_PORT_REGIONS    5
  62
  63 struct uio_device;
  64
  65 /**
  66  * struct uio_info - UIO device capabilities
  67  * @uio_dev:            the UIO device this info belongs to
  68  * @name:               device name
  69  * @version:            device driver version
  70  * @mem:                list of mappable memory regions, size==0 for end of list
  71  * @port:               list of port regions, size==0 for end of list
  72  * @irq:                interrupt number or UIO_IRQ_CUSTOM
  73  * @irq_flags:          flags for request_irq()
  74  * @priv:               optional private data
  75  * @handler:            the device's irq handler
  76  * @mmap:               mmap operation for this uio device
  77  * @open:               open operation for this uio device
  78  * @release:            release operation for this uio device
  79  * @irqcontrol:         disable/enable irqs when 0/1 is written to /dev/uioX
  80  */
  81 struct uio_info {
  82         struct uio_device       *uio_dev;
  83         const char              *name;
  84         const char              *version;
  85         struct uio_mem          mem[MAX_UIO_MAPS];
  86         struct uio_port         port[MAX_UIO_PORT_REGIONS];
  87         long                    irq;
  88         unsigned long           irq_flags;
  89         void                    *priv;
  90         irqreturn_t (*handler)(int irq, struct uio_info *dev_info);
  91         int (*mmap)(struct uio_info *info, struct vm_area_struct *vma);
  92         int (*open)(struct uio_info *info, struct inode *inode);
  93         int (*release)(struct uio_info *info, struct inode *inode);
  94         int (*irqcontrol)(struct uio_info *info, s32 irq_on);
  95 };
  96
  97 extern int __must_check
  98         __uio_register_device(struct module *owner,
  99                               struct device *parent,
 100                               struct uio_info *info);
 101
 102 /* use a define to avoid include chaining to get THIS_MODULE */
 103 #define uio_register_device(parent, info) \
 104         __uio_register_device(THIS_MODULE, parent, info)
 105
 106 extern void uio_unregister_device(struct uio_info *info);
 107 extern void uio_event_notify(struct uio_info *info);
 108
 109 /* defines for uio_info->irq */
 110 #define UIO_IRQ_CUSTOM  -1
 111 #define UIO_IRQ_NONE    0
 112
 113 /* defines for uio_mem->memtype */
 114 #define UIO_MEM_NONE    0
 115 #define UIO_MEM_PHYS    1
 116 #define UIO_MEM_LOGICAL 2
 117 #define UIO_MEM_VIRTUAL 3
 118
 119 /* defines for uio_port->porttype */
 120 #define UIO_PORT_NONE   0
 121 #define UIO_PORT_X86    1
 122 #define UIO_PORT_GPIO   2
 123 #define UIO_PORT_OTHER  3
 124
 125 #endif /* _LINUX_UIO_DRIVER_H_ */