Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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@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
21struct uio_map;
22
23/**
24 * struct uio_mem - description of a UIO memory region
25 * @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
29 * @map: for use by the UIO core only.
30 */
31struct uio_mem {
32 unsigned long addr;
33 unsigned long size;
34 int memtype;
35 void __iomem *internal_addr;
36 struct uio_map *map;
37};
38
39#define MAX_UIO_MAPS 5
40
41struct uio_portio;
42
43/**
44 * struct uio_port - description of a UIO port region
45 * @start: start of port region
46 * @size: size of port region
47 * @porttype: type of port (see UIO_PORT_* below)
48 * @portio: for use by the UIO core only.
49 */
50struct uio_port {
51 unsigned long start;
52 unsigned long size;
53 int porttype;
54 struct uio_portio *portio;
55};
56
57#define MAX_UIO_PORT_REGIONS 5
58
59struct uio_device;
60
61/**
62 * struct uio_info - UIO device capabilities
63 * @uio_dev: the UIO device this info belongs to
64 * @name: device name
65 * @version: device driver version
66 * @mem: list of mappable memory regions, size==0 for end of list
67 * @port: list of port regions, size==0 for end of list
68 * @irq: interrupt number or UIO_IRQ_CUSTOM
69 * @irq_flags: flags for request_irq()
70 * @priv: optional private data
71 * @handler: the device's irq handler
72 * @mmap: mmap operation for this uio device
73 * @open: open operation for this uio device
74 * @release: release operation for this uio device
75 * @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX
76 */
77struct uio_info {
78 struct uio_device *uio_dev;
79 const char *name;
80 const char *version;
81 struct uio_mem mem[MAX_UIO_MAPS];
82 struct uio_port port[MAX_UIO_PORT_REGIONS];
83 long irq;
84 unsigned long irq_flags;
85 void *priv;
86 irqreturn_t (*handler)(int irq, struct uio_info *dev_info);
87 int (*mmap)(struct uio_info *info, struct vm_area_struct *vma);
88 int (*open)(struct uio_info *info, struct inode *inode);
89 int (*release)(struct uio_info *info, struct inode *inode);
90 int (*irqcontrol)(struct uio_info *info, s32 irq_on);
91};
92
93extern int __must_check
94 __uio_register_device(struct module *owner,
95 struct device *parent,
96 struct uio_info *info);
97static inline int __must_check
98 uio_register_device(struct device *parent, struct uio_info *info)
99{
100 return __uio_register_device(THIS_MODULE, parent, info);
101}
102extern void uio_unregister_device(struct uio_info *info);
103extern void uio_event_notify(struct uio_info *info);
104
105/* defines for uio_info->irq */
106#define UIO_IRQ_CUSTOM -1
107#define UIO_IRQ_NONE -2
108
109/* defines for uio_mem->memtype */
110#define UIO_MEM_NONE 0
111#define UIO_MEM_PHYS 1
112#define UIO_MEM_LOGICAL 2
113#define UIO_MEM_VIRTUAL 3
114
115/* defines for uio_port->porttype */
116#define UIO_PORT_NONE 0
117#define UIO_PORT_X86 1
118#define UIO_PORT_GPIO 2
119#define UIO_PORT_OTHER 3
120
121#endif /* _LINUX_UIO_DRIVER_H_ */