Commit | Line | Data |
---|---|---|
beafc54c HK |
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> | |
318af55d | 6 | * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de> |
beafc54c HK |
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 | ||
beafc54c HK |
17 | #include <linux/fs.h> |
18 | #include <linux/interrupt.h> | |
19 | ||
de477254 | 20 | struct module; |
81e7c6a6 GKH |
21 | struct uio_map; |
22 | ||
beafc54c HK |
23 | /** |
24 | * struct uio_mem - description of a UIO memory region | |
82057791 | 25 | * @name: name of the memory region for identification |
27a90700 KJ |
26 | * @addr: address of the device's memory (phys_addr is used since |
27 | * addr can be logical, virtual, or physical & phys_addr_t | |
28 | * should always be large enough to handle any of the | |
29 | * address types) | |
beafc54c HK |
30 | * @size: size of IO |
31 | * @memtype: type of memory addr points to | |
32 | * @internal_addr: ioremap-ped version of addr, for driver internal use | |
81e7c6a6 | 33 | * @map: for use by the UIO core only. |
beafc54c HK |
34 | */ |
35 | struct uio_mem { | |
82057791 | 36 | const char *name; |
27a90700 | 37 | phys_addr_t addr; |
beafc54c HK |
38 | unsigned long size; |
39 | int memtype; | |
40 | void __iomem *internal_addr; | |
81e7c6a6 | 41 | struct uio_map *map; |
beafc54c HK |
42 | }; |
43 | ||
6d8333c2 | 44 | #define MAX_UIO_MAPS 5 |
beafc54c | 45 | |
e70c412e HK |
46 | struct uio_portio; |
47 | ||
48 | /** | |
49 | * struct uio_port - description of a UIO port region | |
82057791 | 50 | * @name: name of the port region for identification |
e70c412e HK |
51 | * @start: start of port region |
52 | * @size: size of port region | |
53 | * @porttype: type of port (see UIO_PORT_* below) | |
54 | * @portio: for use by the UIO core only. | |
55 | */ | |
56 | struct uio_port { | |
82057791 | 57 | const char *name; |
e70c412e HK |
58 | unsigned long start; |
59 | unsigned long size; | |
60 | int porttype; | |
61 | struct uio_portio *portio; | |
62 | }; | |
63 | ||
64 | #define MAX_UIO_PORT_REGIONS 5 | |
65 | ||
beafc54c HK |
66 | struct uio_device; |
67 | ||
68 | /** | |
69 | * struct uio_info - UIO device capabilities | |
70 | * @uio_dev: the UIO device this info belongs to | |
71 | * @name: device name | |
72 | * @version: device driver version | |
73 | * @mem: list of mappable memory regions, size==0 for end of list | |
e70c412e | 74 | * @port: list of port regions, size==0 for end of list |
beafc54c HK |
75 | * @irq: interrupt number or UIO_IRQ_CUSTOM |
76 | * @irq_flags: flags for request_irq() | |
77 | * @priv: optional private data | |
78 | * @handler: the device's irq handler | |
79 | * @mmap: mmap operation for this uio device | |
80 | * @open: open operation for this uio device | |
81 | * @release: release operation for this uio device | |
328a14e7 | 82 | * @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX |
beafc54c HK |
83 | */ |
84 | struct uio_info { | |
85 | struct uio_device *uio_dev; | |
b8ac9fc0 SR |
86 | const char *name; |
87 | const char *version; | |
beafc54c | 88 | struct uio_mem mem[MAX_UIO_MAPS]; |
e70c412e | 89 | struct uio_port port[MAX_UIO_PORT_REGIONS]; |
beafc54c HK |
90 | long irq; |
91 | unsigned long irq_flags; | |
92 | void *priv; | |
93 | irqreturn_t (*handler)(int irq, struct uio_info *dev_info); | |
94 | int (*mmap)(struct uio_info *info, struct vm_area_struct *vma); | |
95 | int (*open)(struct uio_info *info, struct inode *inode); | |
96 | int (*release)(struct uio_info *info, struct inode *inode); | |
328a14e7 | 97 | int (*irqcontrol)(struct uio_info *info, s32 irq_on); |
beafc54c HK |
98 | }; |
99 | ||
100 | extern int __must_check | |
101 | __uio_register_device(struct module *owner, | |
102 | struct device *parent, | |
103 | struct uio_info *info); | |
eb5589a8 PG |
104 | |
105 | /* use a define to avoid include chaining to get THIS_MODULE */ | |
106 | #define uio_register_device(parent, info) \ | |
107 | __uio_register_device(THIS_MODULE, parent, info) | |
108 | ||
beafc54c HK |
109 | extern void uio_unregister_device(struct uio_info *info); |
110 | extern void uio_event_notify(struct uio_info *info); | |
111 | ||
6d8333c2 | 112 | /* defines for uio_info->irq */ |
beafc54c | 113 | #define UIO_IRQ_CUSTOM -1 |
6427a765 | 114 | #define UIO_IRQ_NONE 0 |
beafc54c | 115 | |
6d8333c2 | 116 | /* defines for uio_mem->memtype */ |
beafc54c HK |
117 | #define UIO_MEM_NONE 0 |
118 | #define UIO_MEM_PHYS 1 | |
119 | #define UIO_MEM_LOGICAL 2 | |
120 | #define UIO_MEM_VIRTUAL 3 | |
121 | ||
e70c412e HK |
122 | /* defines for uio_port->porttype */ |
123 | #define UIO_PORT_NONE 0 | |
124 | #define UIO_PORT_X86 1 | |
125 | #define UIO_PORT_GPIO 2 | |
126 | #define UIO_PORT_OTHER 3 | |
127 | ||
beafc54c | 128 | #endif /* _LINUX_UIO_DRIVER_H_ */ |