blob: ca82861b0e461d6798e6a05a977352dca24335e5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
Dmitry Torokhov7e044e02009-05-09 16:08:05 -070018#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/interrupt.h>
20#include <linux/list.h>
21#include <linux/spinlock.h>
Arjan van de Venc4e32e92006-02-19 00:21:55 -050022#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/device.h>
24#include <linux/mod_devicetable.h>
25
26struct serio {
27 void *port_data;
28
29 char name[32];
30 char phys[32];
31
Dmitry Torokhov7e044e02009-05-09 16:08:05 -070032 bool manual_bind;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
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
Dmitry Eremin-Solenikov09822582010-10-04 21:46:10 -070044 struct serio *parent;
45 struct list_head child_node; /* Entry in parent->children list */
46 struct list_head children;
Jiri Kosina88aa0102006-10-11 01:45:31 -040047 unsigned int depth; /* level of nesting in serio hierarchy */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49 struct serio_driver *drv; /* accessed from interrupt, must be protected by serio->lock and serio->sem */
Arjan van de Venc4e32e92006-02-19 00:21:55 -050050 struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54 struct list_head node;
55};
56#define to_serio_port(d) container_of(d, struct serio, dev)
57
58struct serio_driver {
Dmitry Torokhovceee4272010-09-13 23:53:55 -070059 const char *description;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Dmitry Torokhovceee4272010-09-13 23:53:55 -070061 const struct serio_device_id *id_table;
Dmitry Torokhov7e044e02009-05-09 16:08:05 -070062 bool manual_bind;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 void (*write_wakeup)(struct serio *);
David Howells7d12e782006-10-05 14:55:46 +010065 irqreturn_t (*interrupt)(struct serio *, unsigned char, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 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
75int serio_open(struct serio *serio, struct serio_driver *drv);
76void serio_close(struct serio *serio);
77void serio_rescan(struct serio *serio);
78void serio_reconnect(struct serio *serio);
David Howells7d12e782006-10-05 14:55:46 +010079irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81void __serio_register_port(struct serio *serio, struct module *owner);
Paul Gortmakereb5589a2011-05-27 09:02:11 -040082
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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87void serio_unregister_port(struct serio *serio);
Dmitry Torokhovdbf4ccd2005-06-01 02:40:01 -050088void serio_unregister_child_port(struct serio *serio);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Paul Gortmakereb5589a2011-05-27 09:02:11 -040090int __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
Linus Torvalds1da177e2005-04-16 15:20:36 -070097void serio_unregister_driver(struct serio_driver *drv);
98
99static 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
107static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113/*
Akinobu Mita0b280022006-03-26 01:38:58 -0800114 * Use the following functions to manipulate serio's per-port
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * driver-specific data.
116 */
117static inline void *serio_get_drvdata(struct serio *serio)
118{
119 return dev_get_drvdata(&serio->dev);
120}
121
122static inline void serio_set_drvdata(struct serio *serio, void *data)
123{
124 dev_set_drvdata(&serio->dev, data);
125}
126
127/*
Akinobu Mita0b280022006-03-26 01:38:58 -0800128 * Use the following functions to protect critical sections in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 * driver code from port's interrupt handler
130 */
131static inline void serio_pause_rx(struct serio *serio)
132{
133 spin_lock_irq(&serio->lock);
134}
135
136static inline void serio_continue_rx(struct serio *serio)
137{
138 spin_unlock_irq(&serio->lock);
139}
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#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/*
Niels de Vosf3d1eb12008-07-08 10:30:27 -0400161 * Serio protocols
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 */
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
Rick Kochee479992006-08-05 00:32:18 -0400192#define SERIO_PENMOUNT 0x31
Rick Koch4003dff2006-08-05 00:32:24 -0400193#define SERIO_TOUCHRIGHT 0x32
Rick Koch11ea3172006-08-05 00:32:30 -0400194#define SERIO_TOUCHWIN 0x33
Jean Delvareb9cdad72007-07-12 14:12:31 +0200195#define SERIO_TAOSEVM 0x34
Dmitry Torokhov85f202d2007-07-18 00:37:01 -0400196#define SERIO_FUJITSU 0x35
Martin Kebert3e24e2b2008-03-10 13:40:36 +0100197#define SERIO_ZHENHUA 0x36
Richard Lemon3cadd2d2008-06-26 10:10:41 -0400198#define SERIO_INEXIO 0x37
Dmitry Torokhovab96dde2009-03-07 13:39:22 -0800199#define SERIO_TOUCHIT213 0x38
Jaya Kumar3eb1aa42008-11-19 16:58:50 -0500200#define SERIO_W8001 0x39
Tias Gunsa5f523b2009-10-25 12:13:58 -0700201#define SERIO_DYNAPRO 0x3a
Adam Bennett422dee52010-04-12 19:54:38 -0700202#define SERIO_HAMPSHIRE 0x3b
Dmitry Eremin-Solenikovfc58d122010-10-18 09:18:13 -0700203#define SERIO_PS2MULT 0x3c
Sebastian Andrzej Siewiorf01536e2011-09-28 10:04:21 -0700204#define SERIO_TSC40 0x3d
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206#endif