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