| Andrew Scull | b4b6d4a | 2019-01-02 15:54:55 +0000 | [diff] [blame] | 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/device.h> |
| 18 | #include <linux/fs.h> |
| 19 | #include <linux/interrupt.h> |
| 20 | |
| 21 | struct module; |
| 22 | struct uio_map; |
| 23 | |
| 24 | /** |
| 25 | * struct uio_mem - description of a UIO memory region |
| 26 | * @name: name of the memory region for identification |
| 27 | * @addr: address of the device's memory rounded to page |
| 28 | * size (phys_addr is used since addr can be |
| 29 | * logical, virtual, or physical & phys_addr_t |
| 30 | * should always be large enough to handle any of |
| 31 | * the address types) |
| 32 | * @offs: offset of device memory within the page |
| 33 | * @size: size of IO (multiple of page size) |
| 34 | * @memtype: type of memory addr points to |
| 35 | * @internal_addr: ioremap-ped version of addr, for driver internal use |
| 36 | * @map: for use by the UIO core only. |
| 37 | */ |
| 38 | struct uio_mem { |
| 39 | const char *name; |
| 40 | phys_addr_t addr; |
| 41 | unsigned long offs; |
| 42 | resource_size_t size; |
| 43 | int memtype; |
| 44 | void __iomem *internal_addr; |
| 45 | struct uio_map *map; |
| 46 | }; |
| 47 | |
| 48 | #define MAX_UIO_MAPS 5 |
| 49 | |
| 50 | struct uio_portio; |
| 51 | |
| 52 | /** |
| 53 | * struct uio_port - description of a UIO port region |
| 54 | * @name: name of the port region for identification |
| 55 | * @start: start of port region |
| 56 | * @size: size of port region |
| 57 | * @porttype: type of port (see UIO_PORT_* below) |
| 58 | * @portio: for use by the UIO core only. |
| 59 | */ |
| 60 | struct uio_port { |
| 61 | const char *name; |
| 62 | unsigned long start; |
| 63 | unsigned long size; |
| 64 | int porttype; |
| 65 | struct uio_portio *portio; |
| 66 | }; |
| 67 | |
| 68 | #define MAX_UIO_PORT_REGIONS 5 |
| 69 | |
| 70 | struct uio_device { |
| 71 | struct module *owner; |
| 72 | struct device dev; |
| 73 | int minor; |
| 74 | atomic_t event; |
| 75 | struct fasync_struct *async_queue; |
| 76 | wait_queue_head_t wait; |
| 77 | struct uio_info *info; |
| 78 | struct mutex info_lock; |
| 79 | struct kobject *map_dir; |
| 80 | struct kobject *portio_dir; |
| 81 | }; |
| 82 | |
| 83 | /** |
| 84 | * struct uio_info - UIO device capabilities |
| 85 | * @uio_dev: the UIO device this info belongs to |
| 86 | * @name: device name |
| 87 | * @version: device driver version |
| 88 | * @mem: list of mappable memory regions, size==0 for end of list |
| 89 | * @port: list of port regions, size==0 for end of list |
| 90 | * @irq: interrupt number or UIO_IRQ_CUSTOM |
| 91 | * @irq_flags: flags for request_irq() |
| 92 | * @priv: optional private data |
| 93 | * @handler: the device's irq handler |
| 94 | * @mmap: mmap operation for this uio device |
| 95 | * @open: open operation for this uio device |
| 96 | * @release: release operation for this uio device |
| 97 | * @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX |
| 98 | */ |
| 99 | struct uio_info { |
| 100 | struct uio_device *uio_dev; |
| 101 | const char *name; |
| 102 | const char *version; |
| 103 | struct uio_mem mem[MAX_UIO_MAPS]; |
| 104 | struct uio_port port[MAX_UIO_PORT_REGIONS]; |
| 105 | long irq; |
| 106 | unsigned long irq_flags; |
| 107 | void *priv; |
| 108 | irqreturn_t (*handler)(int irq, struct uio_info *dev_info); |
| 109 | int (*mmap)(struct uio_info *info, struct vm_area_struct *vma); |
| 110 | int (*open)(struct uio_info *info, struct inode *inode); |
| 111 | int (*release)(struct uio_info *info, struct inode *inode); |
| 112 | int (*irqcontrol)(struct uio_info *info, s32 irq_on); |
| 113 | }; |
| 114 | |
| 115 | extern int __must_check |
| 116 | __uio_register_device(struct module *owner, |
| 117 | struct device *parent, |
| 118 | struct uio_info *info); |
| 119 | |
| 120 | /* use a define to avoid include chaining to get THIS_MODULE */ |
| 121 | #define uio_register_device(parent, info) \ |
| 122 | __uio_register_device(THIS_MODULE, parent, info) |
| 123 | |
| 124 | extern void uio_unregister_device(struct uio_info *info); |
| 125 | extern void uio_event_notify(struct uio_info *info); |
| 126 | |
| 127 | /* defines for uio_info->irq */ |
| 128 | #define UIO_IRQ_CUSTOM -1 |
| 129 | #define UIO_IRQ_NONE 0 |
| 130 | |
| 131 | /* defines for uio_mem->memtype */ |
| 132 | #define UIO_MEM_NONE 0 |
| 133 | #define UIO_MEM_PHYS 1 |
| 134 | #define UIO_MEM_LOGICAL 2 |
| 135 | #define UIO_MEM_VIRTUAL 3 |
| 136 | |
| 137 | /* defines for uio_port->porttype */ |
| 138 | #define UIO_PORT_NONE 0 |
| 139 | #define UIO_PORT_X86 1 |
| 140 | #define UIO_PORT_GPIO 2 |
| 141 | #define UIO_PORT_OTHER 3 |
| 142 | |
| 143 | #endif /* _LINUX_UIO_DRIVER_H_ */ |