[mirror_ubuntu-zesty-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/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];

	unsigned int 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, *child;
	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;
	unsigned int registered;	/* port has been fully registered with driver core */

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

struct serio_driver {
	void *private;
	char *description;

	struct serio_device_id *id_table;
	unsigned int 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);
static inline void serio_register_port(struct serio *serio)
{
	__serio_register_port(serio, THIS_MODULE);
}

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

int serio_register_driver(struct serio_driver *drv);
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);
}

static inline void serio_cleanup(struct serio *serio)
{
	if (serio->drv && serio->drv->cleanup)
		serio->drv->cleanup(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);
}

/*
 * Use the following functions to pin serio's driver in process context
 */
static inline int serio_pin_driver(struct serio *serio)
{
	return mutex_lock_interruptible(&serio->drv_mutex);
}

static inline void serio_pin_driver_uninterruptible(struct serio *serio)
{
	mutex_lock(&serio->drv_mutex);
}

static inline void serio_unpin_driver(struct serio *serio)
{
	mutex_unlock(&serio->drv_mutex);
}


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

#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
	18	#include <linux/interrupt.h>
	19	#include <linux/list.h>
	20	#include <linux/spinlock.h>
c4e32e9f	21	#include <linux/mutex.h>
1da177e4 LT	22	#include <linux/device.h>
	23	#include <linux/mod_devicetable.h>
	24
	25	struct serio {
	26	void *port_data;
	27
	28	char name[32];
	29	char phys[32];
	30
	31	unsigned int manual_bind;
	32
	33	struct serio_device_id id;
	34
	35	spinlock_t lock; /* protects critical sections from port's interrupt handler */
	36
	37	int (write)(struct serio , unsigned char);
	38	int (open)(struct serio );
	39	void (close)(struct serio );
	40	int (start)(struct serio );
	41	void (stop)(struct serio );
	42
	43	struct serio parent, child;
88aa0103	44	unsigned int depth; /* level of nesting in serio hierarchy */
1da177e4 LT	45
1da177e4 LT	46	struct serio_driver drv; / accessed from interrupt, must be protected by serio->lock and serio->sem */
c4e32e9f	47	struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
1da177e4 LT	48
	49	struct device dev;
	50	unsigned int registered; /* port has been fully registered with driver core */
	51
	52	struct list_head node;
	53	};
	54	#define to_serio_port(d) container_of(d, struct serio, dev)
	55
	56	struct serio_driver {
	57	void *private;
	58	char *description;
	59
	60	struct serio_device_id *id_table;
	61	unsigned int manual_bind;
	62
	63	void (write_wakeup)(struct serio );
7d12e780	64	irqreturn_t (interrupt)(struct serio , unsigned char, unsigned int);
1da177e4 LT	65	int (connect)(struct serio , struct serio_driver *drv);
	66	int (reconnect)(struct serio );
	67	void (disconnect)(struct serio );
	68	void (cleanup)(struct serio );
	69
	70	struct device_driver driver;
	71	};
	72	#define to_serio_driver(d) container_of(d, struct serio_driver, driver)
	73
	74	int serio_open(struct serio serio, struct serio_driver drv);
	75	void serio_close(struct serio *serio);
	76	void serio_rescan(struct serio *serio);
	77	void serio_reconnect(struct serio *serio);
7d12e780	78	irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
1da177e4 LT	79
	80	void __serio_register_port(struct serio serio, struct module owner);
	81	static inline void serio_register_port(struct serio *serio)
	82	{
	83	__serio_register_port(serio, THIS_MODULE);
	84	}
	85
	86	void serio_unregister_port(struct serio *serio);
dbf4ccd6	87	void serio_unregister_child_port(struct serio *serio);
1da177e4	88
ed7b1f6d	89	int serio_register_driver(struct serio_driver *drv);
1da177e4 LT	90	void serio_unregister_driver(struct serio_driver *drv);
	91
	92	static inline int serio_write(struct serio *serio, unsigned char data)
	93	{
	94	if (serio->write)
	95	return serio->write(serio, data);
	96	else
	97	return -1;
	98	}
	99
	100	static inline void serio_drv_write_wakeup(struct serio *serio)
	101	{
	102	if (serio->drv && serio->drv->write_wakeup)
	103	serio->drv->write_wakeup(serio);
	104	}
	105
	106	static inline void serio_cleanup(struct serio *serio)
	107	{
	108	if (serio->drv && serio->drv->cleanup)
	109	serio->drv->cleanup(serio);
	110	}
	111
	112	/*
0b28002f	113	* Use the following functions to manipulate serio's per-port
1da177e4 LT	114	* driver-specific data.
	115	*/
	116	static inline void serio_get_drvdata(struct serio serio)
	117	{
	118	return dev_get_drvdata(&serio->dev);
	119	}
	120
	121	static inline void serio_set_drvdata(struct serio serio, void data)
	122	{
	123	dev_set_drvdata(&serio->dev, data);
	124	}
	125
	126	/*
0b28002f	127	* Use the following functions to protect critical sections in
1da177e4 LT	128	* driver code from port's interrupt handler
	129	*/
	130	static inline void serio_pause_rx(struct serio *serio)
	131	{
	132	spin_lock_irq(&serio->lock);
	133	}
	134
	135	static inline void serio_continue_rx(struct serio *serio)
	136	{
	137	spin_unlock_irq(&serio->lock);
	138	}
	139
	140	/*
0b28002f	141	* Use the following functions to pin serio's driver in process context
1da177e4 LT	142	*/
	143	static inline int serio_pin_driver(struct serio *serio)
	144	{
c4e32e9f	145	return mutex_lock_interruptible(&serio->drv_mutex);
1da177e4 LT	146	}
1da177e4 LT	147
dbf4ccd6 DT	148	static inline void serio_pin_driver_uninterruptible(struct serio *serio)
dbf4ccd6 DT	149	{
c4e32e9f	150	mutex_lock(&serio->drv_mutex);
dbf4ccd6 DT	151	}
dbf4ccd6 DT	152
1da177e4 LT	153	static inline void serio_unpin_driver(struct serio *serio)
1da177e4 LT	154	{
c4e32e9f	155	mutex_unlock(&serio->drv_mutex);
1da177e4 LT	156	}
	157
	158
	159	#endif
	160
	161	/*
	162	* bit masks for use in "interrupt" flags (3rd argument)
	163	*/
	164	#define SERIO_TIMEOUT 1
	165	#define SERIO_PARITY 2
	166	#define SERIO_FRAME 4
	167
	168	/*
	169	* Serio types
	170	*/
	171	#define SERIO_XT 0x00
	172	#define SERIO_8042 0x01
	173	#define SERIO_RS232 0x02
	174	#define SERIO_HIL_MLC 0x03
	175	#define SERIO_PS_PSTHRU 0x05
	176	#define SERIO_8042_XL 0x06
	177
	178	/*
	179	* Serio types
	180	*/
	181	#define SERIO_UNKNOWN 0x00
	182	#define SERIO_MSC 0x01
	183	#define SERIO_SUN 0x02
	184	#define SERIO_MS 0x03
	185	#define SERIO_MP 0x04
	186	#define SERIO_MZ 0x05
	187	#define SERIO_MZP 0x06
	188	#define SERIO_MZPP 0x07
	189	#define SERIO_VSXXXAA 0x08
	190	#define SERIO_SUNKBD 0x10
	191	#define SERIO_WARRIOR 0x18
	192	#define SERIO_SPACEORB 0x19
	193	#define SERIO_MAGELLAN 0x1a
	194	#define SERIO_SPACEBALL 0x1b
	195	#define SERIO_GUNZE 0x1c
	196	#define SERIO_IFORCE 0x1d
	197	#define SERIO_STINGER 0x1e
	198	#define SERIO_NEWTON 0x1f
	199	#define SERIO_STOWAWAY 0x20
	200	#define SERIO_H3600 0x21
	201	#define SERIO_PS2SER 0x22
	202	#define SERIO_TWIDKBD 0x23
	203	#define SERIO_TWIDJOY 0x24
	204	#define SERIO_HIL 0x25
	205	#define SERIO_SNES232 0x26
	206	#define SERIO_SEMTECH 0x27
	207	#define SERIO_LKKBD 0x28
	208	#define SERIO_ELO 0x29
	209	#define SERIO_MICROTOUCH 0x30
ee479999	210	#define SERIO_PENMOUNT 0x31
4003dff4	211	#define SERIO_TOUCHRIGHT 0x32
11ea3173	212	#define SERIO_TOUCHWIN 0x33
1da177e4 LT	213
1da177e4 LT	214	#endif