[mirror_ubuntu-bionic-kernel.git] / include / linux / uio_driver.h

/*
 * include/linux/uio_driver.h
 *
 * Copyright(C) 2005, Benedikt Spranger <b.spranger@linutronix.de>
 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
 * Copyright(C) 2006, Hans J. Koch <hjk@hansjkoch.de>
 * Copyright(C) 2006, Greg Kroah-Hartman <greg@kroah.com>
 *
 * Userspace IO driver.
 *
 * Licensed under the GPLv2 only.
 */

#ifndef _UIO_DRIVER_H_
#define _UIO_DRIVER_H_

#include <linux/device.h>
#include <linux/fs.h>
#include <linux/interrupt.h>

struct module;
struct uio_map;

/**
 * struct uio_mem - description of a UIO memory region
 * @name:		name of the memory region for identification
 * @addr:               address of the device's memory rounded to page
 * 			size (phys_addr is used since addr can be
 * 			logical, virtual, or physical & phys_addr_t
 * 			should always be large enough to handle any of
 * 			the address types)
 * @offs:               offset of device memory within the page
 * @size:		size of IO (multiple of page size)
 * @memtype:		type of memory addr points to
 * @internal_addr:	ioremap-ped version of addr, for driver internal use
 * @map:		for use by the UIO core only.
 */
struct uio_mem {
	const char		*name;
	phys_addr_t		addr;
	unsigned long		offs;
	resource_size_t		size;
	int			memtype;
	void __iomem		*internal_addr;
	struct uio_map		*map;
};

#define MAX_UIO_MAPS	5

struct uio_portio;

/**
 * struct uio_port - description of a UIO port region
 * @name:		name of the port region for identification
 * @start:		start of port region
 * @size:		size of port region
 * @porttype:		type of port (see UIO_PORT_* below)
 * @portio:		for use by the UIO core only.
 */
struct uio_port {
	const char		*name;
	unsigned long		start;
	unsigned long		size;
	int			porttype;
	struct uio_portio	*portio;
};

#define MAX_UIO_PORT_REGIONS	5

struct uio_device {
        struct module           *owner;
	struct device		dev;
        int                     minor;
        atomic_t                event;
        struct fasync_struct    *async_queue;
        wait_queue_head_t       wait;
        struct uio_info         *info;
	struct mutex		info_lock;
        struct kobject          *map_dir;
        struct kobject          *portio_dir;
};

/**
 * struct uio_info - UIO device capabilities
 * @uio_dev:		the UIO device this info belongs to
 * @name:		device name
 * @version:		device driver version
 * @mem:		list of mappable memory regions, size==0 for end of list
 * @port:		list of port regions, size==0 for end of list
 * @irq:		interrupt number or UIO_IRQ_CUSTOM
 * @irq_flags:		flags for request_irq()
 * @priv:		optional private data
 * @handler:		the device's irq handler
 * @mmap:		mmap operation for this uio device
 * @open:		open operation for this uio device
 * @release:		release operation for this uio device
 * @irqcontrol:		disable/enable irqs when 0/1 is written to /dev/uioX
 */
struct uio_info {
	struct uio_device	*uio_dev;
	const char		*name;
	const char		*version;
	struct uio_mem		mem[MAX_UIO_MAPS];
	struct uio_port		port[MAX_UIO_PORT_REGIONS];
	long			irq;
	unsigned long		irq_flags;
	void			*priv;
	irqreturn_t (*handler)(int irq, struct uio_info *dev_info);
	int (*mmap)(struct uio_info *info, struct vm_area_struct *vma);
	int (*open)(struct uio_info *info, struct inode *inode);
	int (*release)(struct uio_info *info, struct inode *inode);
	int (*irqcontrol)(struct uio_info *info, s32 irq_on);
};

extern int __must_check
	__uio_register_device(struct module *owner,
			      struct device *parent,
			      struct uio_info *info);

/* use a define to avoid include chaining to get THIS_MODULE */
#define uio_register_device(parent, info) \
	__uio_register_device(THIS_MODULE, parent, info)

extern void uio_unregister_device(struct uio_info *info);
extern void uio_event_notify(struct uio_info *info);

/* defines for uio_info->irq */
#define UIO_IRQ_CUSTOM	-1
#define UIO_IRQ_NONE	0

/* defines for uio_mem->memtype */
#define UIO_MEM_NONE	0
#define UIO_MEM_PHYS	1
#define UIO_MEM_LOGICAL	2
#define UIO_MEM_VIRTUAL 3

/* defines for uio_port->porttype */
#define UIO_PORT_NONE	0
#define UIO_PORT_X86	1
#define UIO_PORT_GPIO	2
#define UIO_PORT_OTHER	3

#endif /* _LINUX_UIO_DRIVER_H_ */
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
19566f95	17	#include <linux/device.h>
beafc54c HK	18	#include <linux/fs.h>
	19	#include <linux/interrupt.h>
	20
de477254	21	struct module;
81e7c6a6 GKH	22	struct uio_map;
81e7c6a6 GKH	23
beafc54c HK	24	/**
beafc54c HK	25	* struct uio_mem - description of a UIO memory region
82057791	26	* @name: name of the memory region for identification
171058fb MS	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)
beafc54c HK	34	* @memtype: type of memory addr points to
beafc54c HK	35	* @internal_addr: ioremap-ped version of addr, for driver internal use
81e7c6a6	36	* @map: for use by the UIO core only.
beafc54c HK	37	*/
beafc54c HK	38	struct uio_mem {
82057791	39	const char *name;
27a90700	40	phys_addr_t addr;
171058fb	41	unsigned long offs;
e0f1147c	42	resource_size_t size;
beafc54c HK	43	int memtype;
beafc54c HK	44	void __iomem *internal_addr;
81e7c6a6	45	struct uio_map *map;
beafc54c HK	46	};
beafc54c HK	47
6d8333c2	48	#define MAX_UIO_MAPS 5
beafc54c	49
e70c412e HK	50	struct uio_portio;
	51
	52	/**
	53	* struct uio_port - description of a UIO port region
82057791	54	* @name: name of the port region for identification
e70c412e HK	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 {
82057791	61	const char *name;
e70c412e HK	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
f14bb039 AG	70	struct uio_device {
f14bb039 AG	71	struct module *owner;
19566f95	72	struct device dev;
f14bb039 AG	73	int minor;
	74	atomic_t event;
	75	struct fasync_struct *async_queue;
	76	wait_queue_head_t wait;
	77	struct uio_info *info;
ef5081f2	78	struct mutex info_lock;
f14bb039 AG	79	struct kobject *map_dir;
	80	struct kobject *portio_dir;
	81	};
beafc54c HK	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
e70c412e	89	* @port: list of port regions, size==0 for end of list
beafc54c HK	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
328a14e7	97	* @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX
beafc54c HK	98	*/
	99	struct uio_info {
	100	struct uio_device *uio_dev;
b8ac9fc0 SR	101	const char *name;
b8ac9fc0 SR	102	const char *version;
beafc54c	103	struct uio_mem mem[MAX_UIO_MAPS];
e70c412e	104	struct uio_port port[MAX_UIO_PORT_REGIONS];
beafc54c HK	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);
328a14e7	112	int (irqcontrol)(struct uio_info info, s32 irq_on);
beafc54c HK	113	};
	114
	115	extern int __must_check
	116	__uio_register_device(struct module *owner,
	117	struct device *parent,
	118	struct uio_info *info);
eb5589a8 PG	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
beafc54c HK	124	extern void uio_unregister_device(struct uio_info *info);
	125	extern void uio_event_notify(struct uio_info *info);
	126
6d8333c2	127	/* defines for uio_info->irq */
beafc54c	128	#define UIO_IRQ_CUSTOM -1
6427a765	129	#define UIO_IRQ_NONE 0
beafc54c	130
6d8333c2	131	/* defines for uio_mem->memtype */
beafc54c HK	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
e70c412e HK	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
beafc54c	143	#endif /* _LINUX_UIO_DRIVER_H_ */