xref: /openbmc/linux/include/linux/serio.h (revision ddf1ffbd)
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/types.h>
19 #include <linux/interrupt.h>
20 #include <linux/list.h>
21 #include <linux/spinlock.h>
22 #include <linux/mutex.h>
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 
32 	bool manual_bind;
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 
44 	struct serio *parent, *child;
45 	unsigned int depth;		/* level of nesting in serio hierarchy */
46 
47 	struct serio_driver *drv;	/* accessed from interrupt, must be protected by serio->lock and serio->sem */
48 	struct mutex drv_mutex;		/* protects serio->drv so attributes can pin driver */
49 
50 	struct device dev;
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 	bool manual_bind;
62 
63 	void (*write_wakeup)(struct serio *);
64 	irqreturn_t (*interrupt)(struct serio *, unsigned char, unsigned int);
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);
78 irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
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);
87 void serio_unregister_child_port(struct serio *serio);
88 
89 int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name);
90 static inline int __must_check serio_register_driver(struct serio_driver *drv)
91 {
92 	return __serio_register_driver(drv, THIS_MODULE, KBUILD_MODNAME);
93 }
94 void serio_unregister_driver(struct serio_driver *drv);
95 
96 static inline int serio_write(struct serio *serio, unsigned char data)
97 {
98 	if (serio->write)
99 		return serio->write(serio, data);
100 	else
101 		return -1;
102 }
103 
104 static inline void serio_drv_write_wakeup(struct serio *serio)
105 {
106 	if (serio->drv && serio->drv->write_wakeup)
107 		serio->drv->write_wakeup(serio);
108 }
109 
110 /*
111  * Use the following functions to manipulate serio's per-port
112  * driver-specific data.
113  */
114 static inline void *serio_get_drvdata(struct serio *serio)
115 {
116 	return dev_get_drvdata(&serio->dev);
117 }
118 
119 static inline void serio_set_drvdata(struct serio *serio, void *data)
120 {
121 	dev_set_drvdata(&serio->dev, data);
122 }
123 
124 /*
125  * Use the following functions to protect critical sections in
126  * driver code from port's interrupt handler
127  */
128 static inline void serio_pause_rx(struct serio *serio)
129 {
130 	spin_lock_irq(&serio->lock);
131 }
132 
133 static inline void serio_continue_rx(struct serio *serio)
134 {
135 	spin_unlock_irq(&serio->lock);
136 }
137 
138 /*
139  * Use the following functions to pin serio's driver in process context
140  */
141 static inline int serio_pin_driver(struct serio *serio)
142 {
143 	return mutex_lock_interruptible(&serio->drv_mutex);
144 }
145 
146 static inline void serio_pin_driver_uninterruptible(struct serio *serio)
147 {
148 	mutex_lock(&serio->drv_mutex);
149 }
150 
151 static inline void serio_unpin_driver(struct serio *serio)
152 {
153 	mutex_unlock(&serio->drv_mutex);
154 }
155 
156 
157 #endif
158 
159 /*
160  * bit masks for use in "interrupt" flags (3rd argument)
161  */
162 #define SERIO_TIMEOUT	1
163 #define SERIO_PARITY	2
164 #define SERIO_FRAME	4
165 
166 /*
167  * Serio types
168  */
169 #define SERIO_XT	0x00
170 #define SERIO_8042	0x01
171 #define SERIO_RS232	0x02
172 #define SERIO_HIL_MLC	0x03
173 #define SERIO_PS_PSTHRU	0x05
174 #define SERIO_8042_XL	0x06
175 
176 /*
177  * Serio protocols
178  */
179 #define SERIO_UNKNOWN	0x00
180 #define SERIO_MSC	0x01
181 #define SERIO_SUN	0x02
182 #define SERIO_MS	0x03
183 #define SERIO_MP	0x04
184 #define SERIO_MZ	0x05
185 #define SERIO_MZP	0x06
186 #define SERIO_MZPP	0x07
187 #define SERIO_VSXXXAA	0x08
188 #define SERIO_SUNKBD	0x10
189 #define SERIO_WARRIOR	0x18
190 #define SERIO_SPACEORB	0x19
191 #define SERIO_MAGELLAN	0x1a
192 #define SERIO_SPACEBALL	0x1b
193 #define SERIO_GUNZE	0x1c
194 #define SERIO_IFORCE	0x1d
195 #define SERIO_STINGER	0x1e
196 #define SERIO_NEWTON	0x1f
197 #define SERIO_STOWAWAY	0x20
198 #define SERIO_H3600	0x21
199 #define SERIO_PS2SER	0x22
200 #define SERIO_TWIDKBD	0x23
201 #define SERIO_TWIDJOY	0x24
202 #define SERIO_HIL	0x25
203 #define SERIO_SNES232	0x26
204 #define SERIO_SEMTECH	0x27
205 #define SERIO_LKKBD	0x28
206 #define SERIO_ELO	0x29
207 #define SERIO_MICROTOUCH	0x30
208 #define SERIO_PENMOUNT	0x31
209 #define SERIO_TOUCHRIGHT	0x32
210 #define SERIO_TOUCHWIN	0x33
211 #define SERIO_TAOSEVM	0x34
212 #define SERIO_FUJITSU	0x35
213 #define SERIO_ZHENHUA	0x36
214 #define SERIO_INEXIO	0x37
215 #define SERIO_TOUCHIT213	0x38
216 #define SERIO_W8001	0x39
217 #define SERIO_DYNAPRO	0x3a
218 
219 #endif
220