[GitHub/mt8127/android_kernel_alcatel_ttab.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@linutronix.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/module.h>
#include <linux/fs.h>
#include <linux/interrupt.h>

struct uio_map;

/**
 * struct uio_mem - description of a UIO memory region
 * @addr:		address of the device's memory
 * @size:		size of IO
 * @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 {
	unsigned long		addr;
	unsigned long		size;
	int			memtype;
	void __iomem		*internal_addr;
	struct uio_map		*map;
};

#define MAX_UIO_MAPS	5

struct uio_device;

/**
 * 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
 * @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;
	char			*name;
	char			*version;
	struct uio_mem		mem[MAX_UIO_MAPS];
	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);
static inline int __must_check
	uio_register_device(struct device *parent, struct uio_info *info)
{
	return __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	-2

/* 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

#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>
	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
81e7c6a6 GKH	21	struct uio_map;
81e7c6a6 GKH	22
beafc54c HK	23	/**
beafc54c HK	24	* struct uio_mem - description of a UIO memory region
beafc54c HK	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
81e7c6a6	29	* @map: for use by the UIO core only.
beafc54c HK	30	*/
beafc54c HK	31	struct uio_mem {
beafc54c HK	32	unsigned long addr;
	33	unsigned long size;
	34	int memtype;
	35	void __iomem *internal_addr;
81e7c6a6	36	struct uio_map *map;
beafc54c HK	37	};
beafc54c HK	38
6d8333c2	39	#define MAX_UIO_MAPS 5
beafc54c HK	40
	41	struct 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
328a14e7	56	* @irqcontrol: disable/enable irqs when 0/1 is written to /dev/uioX
beafc54c HK	57	*/
	58	struct 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);
328a14e7	70	int (irqcontrol)(struct uio_info info, s32 irq_on);
beafc54c HK	71	};
	72
	73	extern int __must_check
	74	__uio_register_device(struct module *owner,
	75	struct device *parent,
	76	struct uio_info *info);
	77	static 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	}
	82	extern void uio_unregister_device(struct uio_info *info);
	83	extern void uio_event_notify(struct uio_info *info);
	84
6d8333c2	85	/* defines for uio_info->irq */
beafc54c HK	86	#define UIO_IRQ_CUSTOM -1
	87	#define UIO_IRQ_NONE -2
	88
6d8333c2	89	/* defines for uio_mem->memtype */
beafc54c HK	90	#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_ */