1 #ifndef _GAMEPORT_H
2 #define _GAMEPORT_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 #ifdef __KERNEL__
13 #include <asm/io.h>
14 #include <linux/list.h>
15 #include <linux/mutex.h>
16 #include <linux/device.h>
17 #include <linux/timer.h>
18
19 struct gameport {
20
21 void *port_data; /* Private pointer for gameport drivers */
22 char name[32];
23 char phys[32];
24
25 int io;
26 int speed;
27 int fuzz;
28
29 void (*trigger)(struct gameport *);
30 unsigned char (*read)(struct gameport *);
31 int (*cooked_read)(struct gameport *, int *, int *);
32 int (*calibrate)(struct gameport *, int *, int *);
33 int (*open)(struct gameport *, int);
34 void (*close)(struct gameport *);
35
36 struct timer_list poll_timer;
37 unsigned int poll_interval; /* in msecs */
38 spinlock_t timer_lock;
39 unsigned int poll_cnt;
40 void (*poll_handler)(struct gameport *);
41
42 struct gameport *parent, *child;
43
44 struct gameport_driver *drv;
45 struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
46
47 struct device dev;
48 unsigned int registered; /* port has been fully registered with driver core */
49
50 struct list_head node;
51 };
52 #define to_gameport_port(d) container_of(d, struct gameport, dev)
53
54 struct gameport_driver {
55
56 void *private;
57 char *description;
58
59 int (*connect)(struct gameport *, struct gameport_driver *drv);
60 int (*reconnect)(struct gameport *);
61 void (*disconnect)(struct gameport *);
62
63 struct device_driver driver;
64
65 unsigned int ignore;
66 };
67 #define to_gameport_driver(d) container_of(d, struct gameport_driver, driver)
68
69 int gameport_open(struct gameport *gameport, struct gameport_driver *drv, int mode);
70 void gameport_close(struct gameport *gameport);
71
72 #if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
73
74 void __gameport_register_port(struct gameport *gameport, struct module *owner);
gameport_register_port(struct gameport * gameport)75 static inline void gameport_register_port(struct gameport *gameport)
76 {
77 __gameport_register_port(gameport, THIS_MODULE);
78 }
79
80 void gameport_unregister_port(struct gameport *gameport);
81
82 void gameport_set_phys(struct gameport *gameport, const char *fmt, ...)
83 __attribute__ ((format (printf, 2, 3)));
84
85 #else
86
gameport_register_port(struct gameport * gameport)87 static inline void gameport_register_port(struct gameport *gameport)
88 {
89 return;
90 }
91
gameport_unregister_port(struct gameport * gameport)92 static inline void gameport_unregister_port(struct gameport *gameport)
93 {
94 return;
95 }
96
gameport_set_phys(struct gameport * gameport,const char * fmt,...)97 static inline void gameport_set_phys(struct gameport *gameport,
98 const char *fmt, ...)
99 {
100 return;
101 }
102
103 #endif
104
gameport_allocate_port(void)105 static inline struct gameport *gameport_allocate_port(void)
106 {
107 struct gameport *gameport = kzalloc(sizeof(struct gameport), GFP_KERNEL);
108
109 return gameport;
110 }
111
gameport_free_port(struct gameport * gameport)112 static inline void gameport_free_port(struct gameport *gameport)
113 {
114 kfree(gameport);
115 }
116
gameport_set_name(struct gameport * gameport,const char * name)117 static inline void gameport_set_name(struct gameport *gameport, const char *name)
118 {
119 strlcpy(gameport->name, name, sizeof(gameport->name));
120 }
121
122 /*
123 * Use the following functions to manipulate gameport's per-port
124 * driver-specific data.
125 */
gameport_get_drvdata(struct gameport * gameport)126 static inline void *gameport_get_drvdata(struct gameport *gameport)
127 {
128 return dev_get_drvdata(&gameport->dev);
129 }
130
gameport_set_drvdata(struct gameport * gameport,void * data)131 static inline void gameport_set_drvdata(struct gameport *gameport, void *data)
132 {
133 dev_set_drvdata(&gameport->dev, data);
134 }
135
136 /*
137 * Use the following functions to pin gameport's driver in process context
138 */
gameport_pin_driver(struct gameport * gameport)139 static inline int gameport_pin_driver(struct gameport *gameport)
140 {
141 return mutex_lock_interruptible(&gameport->drv_mutex);
142 }
143
gameport_unpin_driver(struct gameport * gameport)144 static inline void gameport_unpin_driver(struct gameport *gameport)
145 {
146 mutex_unlock(&gameport->drv_mutex);
147 }
148
149 int __gameport_register_driver(struct gameport_driver *drv,
150 struct module *owner, const char *mod_name);
gameport_register_driver(struct gameport_driver * drv)151 static inline int __must_check gameport_register_driver(struct gameport_driver *drv)
152 {
153 return __gameport_register_driver(drv, THIS_MODULE, KBUILD_MODNAME);
154 }
155
156 void gameport_unregister_driver(struct gameport_driver *drv);
157
158 #endif /* __KERNEL__ */
159
160 #define GAMEPORT_MODE_DISABLED 0
161 #define GAMEPORT_MODE_RAW 1
162 #define GAMEPORT_MODE_COOKED 2
163
164 #define GAMEPORT_ID_VENDOR_ANALOG 0x0001
165 #define GAMEPORT_ID_VENDOR_MADCATZ 0x0002
166 #define GAMEPORT_ID_VENDOR_LOGITECH 0x0003
167 #define GAMEPORT_ID_VENDOR_CREATIVE 0x0004
168 #define GAMEPORT_ID_VENDOR_GENIUS 0x0005
169 #define GAMEPORT_ID_VENDOR_INTERACT 0x0006
170 #define GAMEPORT_ID_VENDOR_MICROSOFT 0x0007
171 #define GAMEPORT_ID_VENDOR_THRUSTMASTER 0x0008
172 #define GAMEPORT_ID_VENDOR_GRAVIS 0x0009
173 #define GAMEPORT_ID_VENDOR_GUILLEMOT 0x000a
174
175 #ifdef __KERNEL__
176
gameport_trigger(struct gameport * gameport)177 static inline void gameport_trigger(struct gameport *gameport)
178 {
179 if (gameport->trigger)
180 gameport->trigger(gameport);
181 else
182 outb(0xff, gameport->io);
183 }
184
gameport_read(struct gameport * gameport)185 static inline unsigned char gameport_read(struct gameport *gameport)
186 {
187 if (gameport->read)
188 return gameport->read(gameport);
189 else
190 return inb(gameport->io);
191 }
192
gameport_cooked_read(struct gameport * gameport,int * axes,int * buttons)193 static inline int gameport_cooked_read(struct gameport *gameport, int *axes, int *buttons)
194 {
195 if (gameport->cooked_read)
196 return gameport->cooked_read(gameport, axes, buttons);
197 else
198 return -1;
199 }
200
gameport_calibrate(struct gameport * gameport,int * axes,int * max)201 static inline int gameport_calibrate(struct gameport *gameport, int *axes, int *max)
202 {
203 if (gameport->calibrate)
204 return gameport->calibrate(gameport, axes, max);
205 else
206 return -1;
207 }
208
gameport_time(struct gameport * gameport,int time)209 static inline int gameport_time(struct gameport *gameport, int time)
210 {
211 return (time * gameport->speed) / 1000;
212 }
213
gameport_set_poll_handler(struct gameport * gameport,void (* handler)(struct gameport *))214 static inline void gameport_set_poll_handler(struct gameport *gameport, void (*handler)(struct gameport *))
215 {
216 gameport->poll_handler = handler;
217 }
218
gameport_set_poll_interval(struct gameport * gameport,unsigned int msecs)219 static inline void gameport_set_poll_interval(struct gameport *gameport, unsigned int msecs)
220 {
221 gameport->poll_interval = msecs;
222 }
223
224 void gameport_start_polling(struct gameport *gameport);
225 void gameport_stop_polling(struct gameport *gameport);
226
227 #endif /* __KERNEL__ */
228 #endif
229