blob: cdf338d94b7f450b42fbb1a12779cdbc7c920248 [file] [log] [blame]
Hans J. Kochbeafc542006-12-07 10:58:29 +01001/*
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@linutronix.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
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000021struct uio_map;
22
Hans J. Kochbeafc542006-12-07 10:58:29 +010023/**
24 * struct uio_mem - description of a UIO memory region
Hans J. Kochbeafc542006-12-07 10:58:29 +010025 * @addr: address of the device's memory
26 * @size: size of IO
27 * @memtype: type of memory addr points to
28 * @internal_addr: ioremap-ped version of addr, for driver internal use
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000029 * @map: for use by the UIO core only.
Hans J. Kochbeafc542006-12-07 10:58:29 +010030 */
31struct uio_mem {
Hans J. Kochbeafc542006-12-07 10:58:29 +010032 unsigned long addr;
33 unsigned long size;
34 int memtype;
35 void __iomem *internal_addr;
Greg Kroah-Hartman81e7c6a2007-12-04 22:41:54 +000036 struct uio_map *map;
Hans J. Kochbeafc542006-12-07 10:58:29 +010037};
38
Uwe Kleine-König6d8333c2008-06-10 09:14:48 +020039#define MAX_UIO_MAPS 5
Hans J. Kochbeafc542006-12-07 10:58:29 +010040
41struct uio_device;
42
43/**
44 * struct uio_info - UIO device capabilities
45 * @uio_dev: the UIO device this info belongs to
46 * @name: device name
47 * @version: device driver version
48 * @mem: list of mappable memory regions, size==0 for end of list
49 * @irq: interrupt number or UIO_IRQ_CUSTOM
50 * @irq_flags: flags for request_irq()
51 * @priv: optional private data
52 * @handler: the device's irq handler
53 * @mmap: mmap operation for this uio device
54 * @open: open operation for this uio device
55 * @release: release operation for this uio device
Hans J. Koch328a14e2008-05-23 13:50:14 +020056 * @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX
Hans J. Kochbeafc542006-12-07 10:58:29 +010057 */
58struct uio_info {
59 struct uio_device *uio_dev;
60 char *name;
61 char *version;
62 struct uio_mem mem[MAX_UIO_MAPS];
63 long irq;
64 unsigned long irq_flags;
65 void *priv;
66 irqreturn_t (*handler)(int irq, struct uio_info *dev_info);
67 int (*mmap)(struct uio_info *info, struct vm_area_struct *vma);
68 int (*open)(struct uio_info *info, struct inode *inode);
69 int (*release)(struct uio_info *info, struct inode *inode);
Hans J. Koch328a14e2008-05-23 13:50:14 +020070 int (*irqcontrol)(struct uio_info *info, s32 irq_on);
Hans J. Kochbeafc542006-12-07 10:58:29 +010071};
72
73extern int __must_check
74 __uio_register_device(struct module *owner,
75 struct device *parent,
76 struct uio_info *info);
77static inline int __must_check
78 uio_register_device(struct device *parent, struct uio_info *info)
79{
80 return __uio_register_device(THIS_MODULE, parent, info);
81}
82extern void uio_unregister_device(struct uio_info *info);
83extern void uio_event_notify(struct uio_info *info);
84
Uwe Kleine-König6d8333c2008-06-10 09:14:48 +020085/* defines for uio_info->irq */
Hans J. Kochbeafc542006-12-07 10:58:29 +010086#define UIO_IRQ_CUSTOM -1
87#define UIO_IRQ_NONE -2
88
Uwe Kleine-König6d8333c2008-06-10 09:14:48 +020089/* defines for uio_mem->memtype */
Hans J. Kochbeafc542006-12-07 10:58:29 +010090#define UIO_MEM_NONE 0
91#define UIO_MEM_PHYS 1
92#define UIO_MEM_LOGICAL 2
93#define UIO_MEM_VIRTUAL 3
94
95#endif /* _LINUX_UIO_DRIVER_H_ */