Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
26struct 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;
45 struct list_head child_node; /* Entry in parent->children list */
46 struct list_head children;
47 unsigned int depth; /* level of nesting in serio hierarchy */
48
49 struct serio_driver *drv; /* accessed from interrupt, must be protected by serio->lock and serio->sem */
50 struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
51
52 struct device dev;
53
54 struct list_head node;
55};
56#define to_serio_port(d) container_of(d, struct serio, dev)
57
58struct serio_driver {
59 const char *description;
60
61 const struct serio_device_id *id_table;
62 bool manual_bind;
63
64 void (*write_wakeup)(struct serio *);
65 irqreturn_t (*interrupt)(struct serio *, unsigned char, unsigned int);
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
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);
79irqreturn_t serio_interrupt(struct serio *serio, unsigned char data, unsigned int flags);
80
81void __serio_register_port(struct serio *serio, struct module *owner);
82static inline void serio_register_port(struct serio *serio)
83{
84 __serio_register_port(serio, THIS_MODULE);
85}
86
87void serio_unregister_port(struct serio *serio);
88void serio_unregister_child_port(struct serio *serio);
89
90int __serio_register_driver(struct serio_driver *drv, struct module *owner, const char *mod_name);
91static inline int __must_check serio_register_driver(struct serio_driver *drv)
92{
93 return __serio_register_driver(drv, THIS_MODULE, KBUILD_MODNAME);
94}
95void serio_unregister_driver(struct serio_driver *drv);
96
97static inline int serio_write(struct serio *serio, unsigned char data)
98{
99 if (serio->write)
100 return serio->write(serio, data);
101 else
102 return -1;
103}
104
105static inline void serio_drv_write_wakeup(struct serio *serio)
106{
107 if (serio->drv && serio->drv->write_wakeup)
108 serio->drv->write_wakeup(serio);
109}
110
111/*
112 * Use the following functions to manipulate serio's per-port
113 * driver-specific data.
114 */
115static inline void *serio_get_drvdata(struct serio *serio)
116{
117 return dev_get_drvdata(&serio->dev);
118}
119
120static inline void serio_set_drvdata(struct serio *serio, void *data)
121{
122 dev_set_drvdata(&serio->dev, data);
123}
124
125/*
126 * Use the following functions to protect critical sections in
127 * driver code from port's interrupt handler
128 */
129static inline void serio_pause_rx(struct serio *serio)
130{
131 spin_lock_irq(&serio->lock);
132}
133
134static inline void serio_continue_rx(struct serio *serio)
135{
136 spin_unlock_irq(&serio->lock);
137}
138
139#endif
140
141/*
142 * bit masks for use in "interrupt" flags (3rd argument)
143 */
144#define SERIO_TIMEOUT 1
145#define SERIO_PARITY 2
146#define SERIO_FRAME 4
147
148/*
149 * Serio types
150 */
151#define SERIO_XT 0x00
152#define SERIO_8042 0x01
153#define SERIO_RS232 0x02
154#define SERIO_HIL_MLC 0x03
155#define SERIO_PS_PSTHRU 0x05
156#define SERIO_8042_XL 0x06
157
158/*
159 * Serio protocols
160 */
161#define SERIO_UNKNOWN 0x00
162#define SERIO_MSC 0x01
163#define SERIO_SUN 0x02
164#define SERIO_MS 0x03
165#define SERIO_MP 0x04
166#define SERIO_MZ 0x05
167#define SERIO_MZP 0x06
168#define SERIO_MZPP 0x07
169#define SERIO_VSXXXAA 0x08
170#define SERIO_SUNKBD 0x10
171#define SERIO_WARRIOR 0x18
172#define SERIO_SPACEORB 0x19
173#define SERIO_MAGELLAN 0x1a
174#define SERIO_SPACEBALL 0x1b
175#define SERIO_GUNZE 0x1c
176#define SERIO_IFORCE 0x1d
177#define SERIO_STINGER 0x1e
178#define SERIO_NEWTON 0x1f
179#define SERIO_STOWAWAY 0x20
180#define SERIO_H3600 0x21
181#define SERIO_PS2SER 0x22
182#define SERIO_TWIDKBD 0x23
183#define SERIO_TWIDJOY 0x24
184#define SERIO_HIL 0x25
185#define SERIO_SNES232 0x26
186#define SERIO_SEMTECH 0x27
187#define SERIO_LKKBD 0x28
188#define SERIO_ELO 0x29
189#define SERIO_MICROTOUCH 0x30
190#define SERIO_PENMOUNT 0x31
191#define SERIO_TOUCHRIGHT 0x32
192#define SERIO_TOUCHWIN 0x33
193#define SERIO_TAOSEVM 0x34
194#define SERIO_FUJITSU 0x35
195#define SERIO_ZHENHUA 0x36
196#define SERIO_INEXIO 0x37
197#define SERIO_TOUCHIT213 0x38
198#define SERIO_W8001 0x39
199#define SERIO_DYNAPRO 0x3a
200#define SERIO_HAMPSHIRE 0x3b
201#define SERIO_PS2MULT 0x3c
202
203#endif