[mirror_ubuntu-artful-kernel.git] / include / linux / serio.h

#ifndef _SERIO_H
#define _SERIO_H

/*
 * Copyright (C) 1999-2002 Vojtech Pavlik
*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#include <linux/ioctl.h>

#define SPIOCSTYPE	_IOW('q', 0x01, unsigned long)

#ifdef __KERNEL__

#include <linux/types.h>
#include <linux/interrupt.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/device.h>
#include <linux/mod_devicetable.h>

struct serio {
	void *port_data;

	char name[32];
	char phys[32];

	bool manual_bind;

	struct serio_device_id id;

	spinlock_t lock;		/* protects critical sections from port's interrupt handler */

	int (*write)(struct serio *, unsigned char);
	int (*open)(struct serio *);
	void (*close)(struct serio *);
	int (*start)(struct serio *);
	void (*stop)(struct serio *);

	struct serio *parent;
	struct list_head child_node;	/* Entry in parent->children list */
	struct list_head children;
	unsigned int depth;		/* level of nesting in serio hierarchy */

	struct serio_driver *drv;	/* accessed from interrupt, must be protected by serio->lock and serio->sem */
	struct mutex drv_mutex;		/* protects serio->drv so attributes can pin driver */

	struct device dev;

	struct list_head node;
};
#define to_serio_port(d)	container_of(d, struct serio, dev)

struct serio_driver {
	const char *description;

	const struct serio_device_id *id_table;
	bool manual_bind;

	void (*write_wakeup)(struct serio *);
	irqreturn_t (*interrupt)(struct serio *, unsigned char, unsigned int);
	int  (*connect)(struct serio *, struct serio_driver *drv);
	int  (*reconnect)(struct serio *);
	void (*disconnect)(struct serio *);
	void (*cleanup)(struct serio *);

	struct device_driver driver;
};
#define to_serio_driver(d)	container_of(d, struct serio_driver, driver)

int serio_open(struct serio *serio, struct serio_driver *drv);
void serio_close(struct serio *serio);
void serio_rescan(struct serio *serio);
void serio_reconnect(struct serio *serio);
irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);

void __serio_register_port(struct serio *serio, struct module *owner);

/* use a define to avoid include chaining to get THIS_MODULE */
#define serio_register_port(serio) \
	__serio_register_port(serio, THIS_MODULE)

void serio_unregister_port(struct serio *serio);
void serio_unregister_child_port(struct serio *serio);

int __must_check __serio_register_driver(struct serio_driver *drv,
				struct module *owner, const char *mod_name);

/* use a define to avoid include chaining to get THIS_MODULE & friends */
#define serio_register_driver(drv) \
	__serio_register_driver(drv, THIS_MODULE, KBUILD_MODNAME)

void serio_unregister_driver(struct serio_driver *drv);

static inline int serio_write(struct serio *serio, unsigned char data)
{
	if (serio->write)
		return serio->write(serio, data);
	else
		return -1;
}

static inline void serio_drv_write_wakeup(struct serio *serio)
{
	if (serio->drv && serio->drv->write_wakeup)
		serio->drv->write_wakeup(serio);
}

/*
 * Use the following functions to manipulate serio's per-port
 * driver-specific data.
 */
static inline void *serio_get_drvdata(struct serio *serio)
{
	return dev_get_drvdata(&serio->dev);
}

static inline void serio_set_drvdata(struct serio *serio, void *data)
{
	dev_set_drvdata(&serio->dev, data);
}

/*
 * Use the following functions to protect critical sections in
 * driver code from port's interrupt handler
 */
static inline void serio_pause_rx(struct serio *serio)
{
	spin_lock_irq(&serio->lock);
}

static inline void serio_continue_rx(struct serio *serio)
{
	spin_unlock_irq(&serio->lock);
}

#endif

/*
 * bit masks for use in "interrupt" flags (3rd argument)
 */
#define SERIO_TIMEOUT	1
#define SERIO_PARITY	2
#define SERIO_FRAME	4

/*
 * Serio types
 */
#define SERIO_XT	0x00
#define SERIO_8042	0x01
#define SERIO_RS232	0x02
#define SERIO_HIL_MLC	0x03
#define SERIO_PS_PSTHRU	0x05
#define SERIO_8042_XL	0x06

/*
 * Serio protocols
 */
#define SERIO_UNKNOWN	0x00
#define SERIO_MSC	0x01
#define SERIO_SUN	0x02
#define SERIO_MS	0x03
#define SERIO_MP	0x04
#define SERIO_MZ	0x05
#define SERIO_MZP	0x06
#define SERIO_MZPP	0x07
#define SERIO_VSXXXAA	0x08
#define SERIO_SUNKBD	0x10
#define SERIO_WARRIOR	0x18
#define SERIO_SPACEORB	0x19
#define SERIO_MAGELLAN	0x1a
#define SERIO_SPACEBALL	0x1b
#define SERIO_GUNZE	0x1c
#define SERIO_IFORCE	0x1d
#define SERIO_STINGER	0x1e
#define SERIO_NEWTON	0x1f
#define SERIO_STOWAWAY	0x20
#define SERIO_H3600	0x21
#define SERIO_PS2SER	0x22
#define SERIO_TWIDKBD	0x23
#define SERIO_TWIDJOY	0x24
#define SERIO_HIL	0x25
#define SERIO_SNES232	0x26
#define SERIO_SEMTECH	0x27
#define SERIO_LKKBD	0x28
#define SERIO_ELO	0x29
#define SERIO_MICROTOUCH	0x30
#define SERIO_PENMOUNT	0x31
#define SERIO_TOUCHRIGHT	0x32
#define SERIO_TOUCHWIN	0x33
#define SERIO_TAOSEVM	0x34
#define SERIO_FUJITSU	0x35
#define SERIO_ZHENHUA	0x36
#define SERIO_INEXIO	0x37
#define SERIO_TOUCHIT213	0x38
#define SERIO_W8001	0x39
#define SERIO_DYNAPRO	0x3a
#define SERIO_HAMPSHIRE	0x3b
#define SERIO_PS2MULT	0x3c
#define SERIO_TSC40	0x3d

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _SERIO_H
	2	#define _SERIO_H
	3
	4	/*
	5	* Copyright (C) 1999-2002 Vojtech Pavlik
	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License version 2 as published by
	9	* the Free Software Foundation.
	10	*/
	11
	12	#include <linux/ioctl.h>
	13
	14	#define SPIOCSTYPE _IOW('q', 0x01, unsigned long)
	15
	16	#ifdef __KERNEL__
	17
7e044e05	18	#include <linux/types.h>
1da177e4 LT	19	#include <linux/interrupt.h>
	20	#include <linux/list.h>
	21	#include <linux/spinlock.h>
c4e32e9f	22	#include <linux/mutex.h>
1da177e4 LT	23	#include <linux/device.h>
	24	#include <linux/mod_devicetable.h>
	25
	26	struct serio {
	27	void *port_data;
	28
	29	char name[32];
	30	char phys[32];
	31
7e044e05	32	bool manual_bind;
1da177e4 LT	33
	34	struct serio_device_id id;
	35
	36	spinlock_t lock; /* protects critical sections from port's interrupt handler */
	37
	38	int (write)(struct serio , unsigned char);
	39	int (open)(struct serio );
	40	void (close)(struct serio );
	41	int (start)(struct serio );
	42	void (stop)(struct serio );
	43
09822582 DES	44	struct serio *parent;
	45	struct list_head child_node; /* Entry in parent->children list */
	46	struct list_head children;
88aa0103	47	unsigned int depth; /* level of nesting in serio hierarchy */
1da177e4 LT	48
1da177e4 LT	49	struct serio_driver drv; / accessed from interrupt, must be protected by serio->lock and serio->sem */
c4e32e9f	50	struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
1da177e4 LT	51
1da177e4 LT	52	struct device dev;
1da177e4 LT	53
	54	struct list_head node;
	55	};
	56	#define to_serio_port(d) container_of(d, struct serio, dev)
	57
	58	struct serio_driver {
ceee4271	59	const char *description;
1da177e4	60
ceee4271	61	const struct serio_device_id *id_table;
7e044e05	62	bool manual_bind;
1da177e4 LT	63
1da177e4 LT	64	void (write_wakeup)(struct serio );
7d12e780	65	irqreturn_t (interrupt)(struct serio , unsigned char, unsigned int);
1da177e4 LT	66	int (connect)(struct serio , struct serio_driver *drv);
	67	int (reconnect)(struct serio );
	68	void (disconnect)(struct serio );
	69	void (cleanup)(struct serio );
	70
	71	struct device_driver driver;
	72	};
	73	#define to_serio_driver(d) container_of(d, struct serio_driver, driver)
	74
	75	int serio_open(struct serio serio, struct serio_driver drv);
	76	void serio_close(struct serio *serio);
	77	void serio_rescan(struct serio *serio);
	78	void serio_reconnect(struct serio *serio);
7d12e780	79	irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
1da177e4 LT	80
1da177e4 LT	81	void __serio_register_port(struct serio serio, struct module owner);
eb5589a8 PG	82
	83	/* use a define to avoid include chaining to get THIS_MODULE */
	84	#define serio_register_port(serio) \
	85	__serio_register_port(serio, THIS_MODULE)
1da177e4 LT	86
1da177e4 LT	87	void serio_unregister_port(struct serio *serio);
dbf4ccd6	88	void serio_unregister_child_port(struct serio *serio);
1da177e4	89
eb5589a8 PG	90	int __must_check __serio_register_driver(struct serio_driver *drv,
	91	struct module owner, const char mod_name);
	92
	93	/* use a define to avoid include chaining to get THIS_MODULE & friends */
	94	#define serio_register_driver(drv) \
	95	__serio_register_driver(drv, THIS_MODULE, KBUILD_MODNAME)
	96
1da177e4 LT	97	void serio_unregister_driver(struct serio_driver *drv);
	98
	99	static inline int serio_write(struct serio *serio, unsigned char data)
	100	{
	101	if (serio->write)
	102	return serio->write(serio, data);
	103	else
	104	return -1;
	105	}
	106
	107	static inline void serio_drv_write_wakeup(struct serio *serio)
	108	{
	109	if (serio->drv && serio->drv->write_wakeup)
	110	serio->drv->write_wakeup(serio);
	111	}
	112
1da177e4	113	/*
0b28002f	114	* Use the following functions to manipulate serio's per-port
1da177e4 LT	115	* driver-specific data.
	116	*/
	117	static inline void serio_get_drvdata(struct serio serio)
	118	{
	119	return dev_get_drvdata(&serio->dev);
	120	}
	121
	122	static inline void serio_set_drvdata(struct serio serio, void data)
	123	{
	124	dev_set_drvdata(&serio->dev, data);
	125	}
	126
	127	/*
0b28002f	128	* Use the following functions to protect critical sections in
1da177e4 LT	129	* driver code from port's interrupt handler
	130	*/
	131	static inline void serio_pause_rx(struct serio *serio)
	132	{
	133	spin_lock_irq(&serio->lock);
	134	}
	135
	136	static inline void serio_continue_rx(struct serio *serio)
	137	{
	138	spin_unlock_irq(&serio->lock);
	139	}
	140
1da177e4 LT	141	#endif
	142
	143	/*
	144	* bit masks for use in "interrupt" flags (3rd argument)
	145	*/
	146	#define SERIO_TIMEOUT 1
	147	#define SERIO_PARITY 2
	148	#define SERIO_FRAME 4
	149
	150	/*
	151	* Serio types
	152	*/
	153	#define SERIO_XT 0x00
	154	#define SERIO_8042 0x01
	155	#define SERIO_RS232 0x02
	156	#define SERIO_HIL_MLC 0x03
	157	#define SERIO_PS_PSTHRU 0x05
	158	#define SERIO_8042_XL 0x06
	159
	160	/*
f3d1eb19	161	* Serio protocols
1da177e4 LT	162	*/
	163	#define SERIO_UNKNOWN 0x00
	164	#define SERIO_MSC 0x01
	165	#define SERIO_SUN 0x02
	166	#define SERIO_MS 0x03
	167	#define SERIO_MP 0x04
	168	#define SERIO_MZ 0x05
	169	#define SERIO_MZP 0x06
	170	#define SERIO_MZPP 0x07
	171	#define SERIO_VSXXXAA 0x08
	172	#define SERIO_SUNKBD 0x10
	173	#define SERIO_WARRIOR 0x18
	174	#define SERIO_SPACEORB 0x19
	175	#define SERIO_MAGELLAN 0x1a
	176	#define SERIO_SPACEBALL 0x1b
	177	#define SERIO_GUNZE 0x1c
	178	#define SERIO_IFORCE 0x1d
	179	#define SERIO_STINGER 0x1e
	180	#define SERIO_NEWTON 0x1f
	181	#define SERIO_STOWAWAY 0x20
	182	#define SERIO_H3600 0x21
	183	#define SERIO_PS2SER 0x22
	184	#define SERIO_TWIDKBD 0x23
	185	#define SERIO_TWIDJOY 0x24
	186	#define SERIO_HIL 0x25
	187	#define SERIO_SNES232 0x26
	188	#define SERIO_SEMTECH 0x27
	189	#define SERIO_LKKBD 0x28
	190	#define SERIO_ELO 0x29
	191	#define SERIO_MICROTOUCH 0x30
ee479999	192	#define SERIO_PENMOUNT 0x31
4003dff4	193	#define SERIO_TOUCHRIGHT 0x32
11ea3173	194	#define SERIO_TOUCHWIN 0x33
b9cdad74	195	#define SERIO_TAOSEVM 0x34
85f202d5	196	#define SERIO_FUJITSU 0x35
3e24e2b5	197	#define SERIO_ZHENHUA 0x36
3cadd2d9	198	#define SERIO_INEXIO 0x37
ab96ddec	199	#define SERIO_TOUCHIT213 0x38
3eb1aa43	200	#define SERIO_W8001 0x39
a5f523bc	201	#define SERIO_DYNAPRO 0x3a
422dee56	202	#define SERIO_HAMPSHIRE 0x3b
fc58d12b	203	#define SERIO_PS2MULT 0x3c
f01536e3	204	#define SERIO_TSC40 0x3d
1da177e4 LT	205
1da177e4 LT	206	#endif