[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / exm_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 _EXM_DRIVER_H_
#define _EXM_DRIVER_H_

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

struct module;
struct exm_map;

/**
 * struct exm_mem - description of a EXM memory region
 * @name:		name of the memory region for identification
 * @addr:		address of the device's memory (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)
 * @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 EXM core only.
 */
struct exm_mem {
	const char *name;
	phys_addr_t addr;
	unsigned long size;
	int memtype;
	void __iomem *internal_addr;
	struct exm_map *map;
};

#define MAX_EXM_MAPS	5

struct exm_portio;

/**
 * struct exm_port - description of a EXM 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 EXM_PORT_* below)
 * @portio:		for use by the EXM core only.
 */
struct exm_port {
	const char *name;
	unsigned long start;
	unsigned long size;
	int porttype;
	struct exm_portio *portio;
};

#define MAX_EXM_PORT_REGIONS	5

struct exm_device;

/**
 * struct exm_info - EXM device capabilities
 * @exm_dev:		the EXM 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 EXM_IRQ_CUSTOM
 * @irq_flags:		flags for request_irq()
 * @priv:		optional private data
 * @handler:		the device's irq handler
 * @mmap:		mmap operation for this exm device
 * @open:		open operation for this exm device
 * @release:		release operation for this exm device
 * @irqcontrol:		disable/enable irqs when 0/1 is written to /dev/exmX
 */
struct exm_info {
	struct exm_device *exm_dev;
	const char *name;
	const char *version;
	struct exm_mem mem[MAX_EXM_MAPS];
	struct exm_port port[MAX_EXM_PORT_REGIONS];
	long irq;
	unsigned long irq_flags;
	void *priv;
	 irqreturn_t(*handler) (int irq, struct exm_info *dev_info);
	int (*mmap) (struct exm_info *info, struct vm_area_struct *vma);
	int (*open) (struct exm_info *info, struct inode *inode);
	int (*release) (struct exm_info *info, struct inode *inode);
	int (*irqcontrol) (struct exm_info *info, s32 irq_on);
};

extern int __must_check
__exm_register_device(struct module *owner, struct device *parent, struct exm_info *info);

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

extern void exm_unregister_device(struct exm_info *info);
extern void exm_event_notify(struct exm_info *info);

/* defines for exm_info->irq */
#define EXM_IRQ_CUSTOM	-1
#define EXM_IRQ_NONE	0

/* defines for exm_mem->memtype */
#define EXM_MEM_NONE	0
#define EXM_MEM_PHYS	1
#define EXM_MEM_LOGICAL	2
#define EXM_MEM_VIRTUAL 3

/* defines for exm_port->porttype */
#define EXM_PORT_NONE	0
#define EXM_PORT_X86	1
#define EXM_PORT_GPIO	2
#define EXM_PORT_OTHER	3

#endif				/* _LINUX_EXM_DRIVER_H_ */
Commit	Line	Data
6fa3eb70 S	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@hansjkoch.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 _EXM_DRIVER_H_
	15	#define _EXM_DRIVER_H_
	16
	17	#include <linux/fs.h>
	18	#include <linux/interrupt.h>
	19
	20	struct module;
	21	struct exm_map;
	22
	23	/**
	24	* struct exm_mem - description of a EXM memory region
	25	* @name: name of the memory region for identification
	26	* @addr: address of the device's memory (phys_addr is used since
	27	* addr can be logical, virtual, or physical & phys_addr_t
	28	* should always be large enough to handle any of the
	29	* address types)
	30	* @size: size of IO
	31	* @memtype: type of memory addr points to
	32	* @internal_addr: ioremap-ped version of addr, for driver internal use
	33	* @map: for use by the EXM core only.
	34	*/
	35	struct exm_mem {
	36	const char *name;
	37	phys_addr_t addr;
	38	unsigned long size;
	39	int memtype;
	40	void __iomem *internal_addr;
	41	struct exm_map *map;
	42	};
	43
	44	#define MAX_EXM_MAPS 5
	45
	46	struct exm_portio;
	47
	48	/**
	49	* struct exm_port - description of a EXM port region
	50	* @name: name of the port region for identification
	51	* @start: start of port region
	52	* @size: size of port region
	53	* @porttype: type of port (see EXM_PORT_* below)
	54	* @portio: for use by the EXM core only.
	55	*/
	56	struct exm_port {
	57	const char *name;
	58	unsigned long start;
	59	unsigned long size;
	60	int porttype;
	61	struct exm_portio *portio;
	62	};
	63
	64	#define MAX_EXM_PORT_REGIONS 5
65
66	struct exm_device;
67
68	/**
69	* struct exm_info - EXM device capabilities
70	* @exm_dev: the EXM device this info belongs to
71	* @name: device name
72	* @version: device driver version
73	* @mem: list of mappable memory regions, size==0 for end of list
74	* @port: list of port regions, size==0 for end of list
75	* @irq: interrupt number or EXM_IRQ_CUSTOM
76	* @irq_flags: flags for request_irq()
77	* @priv: optional private data
78	* @handler: the device's irq handler
79	* @mmap: mmap operation for this exm device
80	* @open: open operation for this exm device
81	* @release: release operation for this exm device
82	* @irqcontrol: disable/enable irqs when 0/1 is written to /dev/exmX
83	*/
84	struct exm_info {
85	struct exm_device *exm_dev;
86	const char *name;
87	const char *version;
88	struct exm_mem mem[MAX_EXM_MAPS];
89	struct exm_port port[MAX_EXM_PORT_REGIONS];
90	long irq;
91	unsigned long irq_flags;
92	void *priv;
93	irqreturn_t(handler) (int irq, struct exm_info dev_info);
94	int (mmap) (struct exm_info info, struct vm_area_struct *vma);
95	int (open) (struct exm_info info, struct inode *inode);
96	int (release) (struct exm_info info, struct inode *inode);
97	int (irqcontrol) (struct exm_info info, s32 irq_on);
98	};
99
100	extern int __must_check
101	__exm_register_device(struct module owner, struct device parent, struct exm_info *info);
102
103	/* use a define to avoid include chaining to get THIS_MODULE */
104	#define exm_register_device(parent, info) \
105	__exm_register_device(THIS_MODULE, parent, info)
106
107	extern void exm_unregister_device(struct exm_info *info);
108	extern void exm_event_notify(struct exm_info *info);
109
110	/* defines for exm_info->irq */
111	#define EXM_IRQ_CUSTOM -1
112	#define EXM_IRQ_NONE 0
113
114	/* defines for exm_mem->memtype */
115	#define EXM_MEM_NONE 0
116	#define EXM_MEM_PHYS 1
117	#define EXM_MEM_LOGICAL 2
118	#define EXM_MEM_VIRTUAL 3
119
120	/* defines for exm_port->porttype */
121	#define EXM_PORT_NONE 0
122	#define EXM_PORT_X86 1
123	#define EXM_PORT_GPIO 2
124	#define EXM_PORT_OTHER 3
125
126	#endif /* _LINUX_EXM_DRIVER_H_ */