blob: 48e68da097f6f50000b80e8dd10a82581233179b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
David Woodhouse25478bb2006-04-25 13:59:30 +010012#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <asm/io.h>
Dmitry Torokhov7e044e02009-05-09 16:08:05 -070014#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/list.h>
Arjan van de Ven286295e2006-02-19 00:22:03 -050016#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/device.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080018#include <linux/timer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
20struct gameport {
21
22 void *port_data; /* Private pointer for gameport drivers */
23 char name[32];
24 char phys[32];
25
26 int io;
27 int speed;
28 int fuzz;
29
30 void (*trigger)(struct gameport *);
31 unsigned char (*read)(struct gameport *);
32 int (*cooked_read)(struct gameport *, int *, int *);
33 int (*calibrate)(struct gameport *, int *, int *);
34 int (*open)(struct gameport *, int);
35 void (*close)(struct gameport *);
36
37 struct timer_list poll_timer;
38 unsigned int poll_interval; /* in msecs */
39 spinlock_t timer_lock;
40 unsigned int poll_cnt;
41 void (*poll_handler)(struct gameport *);
42
43 struct gameport *parent, *child;
44
45 struct gameport_driver *drv;
Arjan van de Ven286295e2006-02-19 00:22:03 -050046 struct mutex drv_mutex; /* protects serio->drv so attributes can pin driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 struct list_head node;
51};
52#define to_gameport_port(d) container_of(d, struct gameport, dev)
53
54struct 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
Dmitry Torokhov7e044e02009-05-09 16:08:05 -070065 bool ignore;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066};
67#define to_gameport_driver(d) container_of(d, struct gameport_driver, driver)
68
69int gameport_open(struct gameport *gameport, struct gameport_driver *drv, int mode);
70void gameport_close(struct gameport *gameport);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Adrian Bunk668d1e62005-05-28 02:11:12 -050072#if defined(CONFIG_GAMEPORT) || (defined(MODULE) && defined(CONFIG_GAMEPORT_MODULE))
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074void __gameport_register_port(struct gameport *gameport, struct module *owner);
75static inline void gameport_register_port(struct gameport *gameport)
76{
77 __gameport_register_port(gameport, THIS_MODULE);
78}
79
80void gameport_unregister_port(struct gameport *gameport);
81
Adrian Bunk668d1e62005-05-28 02:11:12 -050082void gameport_set_phys(struct gameport *gameport, const char *fmt, ...)
83 __attribute__ ((format (printf, 2, 3)));
84
85#else
86
87static inline void gameport_register_port(struct gameport *gameport)
88{
89 return;
90}
91
92static inline void gameport_unregister_port(struct gameport *gameport)
93{
94 return;
95}
96
97static inline void gameport_set_phys(struct gameport *gameport,
98 const char *fmt, ...)
99{
100 return;
101}
102
103#endif
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105static inline struct gameport *gameport_allocate_port(void)
106{
Robert P. J. Daycd861282006-12-13 00:34:52 -0800107 struct gameport *gameport = kzalloc(sizeof(struct gameport), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109 return gameport;
110}
111
112static inline void gameport_free_port(struct gameport *gameport)
113{
114 kfree(gameport);
115}
116
117static inline void gameport_set_name(struct gameport *gameport, const char *name)
118{
119 strlcpy(gameport->name, name, sizeof(gameport->name));
120}
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122/*
Akinobu Mita0b280022006-03-26 01:38:58 -0800123 * Use the following functions to manipulate gameport's per-port
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 * driver-specific data.
125 */
126static inline void *gameport_get_drvdata(struct gameport *gameport)
127{
128 return dev_get_drvdata(&gameport->dev);
129}
130
131static inline void gameport_set_drvdata(struct gameport *gameport, void *data)
132{
133 dev_set_drvdata(&gameport->dev, data);
134}
135
136/*
Akinobu Mita0b280022006-03-26 01:38:58 -0800137 * Use the following functions to pin gameport's driver in process context
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 */
139static inline int gameport_pin_driver(struct gameport *gameport)
140{
Arjan van de Ven286295e2006-02-19 00:22:03 -0500141 return mutex_lock_interruptible(&gameport->drv_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142}
143
144static inline void gameport_unpin_driver(struct gameport *gameport)
145{
Arjan van de Ven286295e2006-02-19 00:22:03 -0500146 mutex_unlock(&gameport->drv_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147}
148
Dmitry Torokhov6902c0b2008-06-06 01:33:22 -0400149int __gameport_register_driver(struct gameport_driver *drv,
150 struct module *owner, const char *mod_name);
Dmitry Torokhov8c4b3c22008-06-06 01:33:51 -0400151static inline int __must_check gameport_register_driver(struct gameport_driver *drv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Dmitry Torokhov6902c0b2008-06-06 01:33:22 -0400153 return __gameport_register_driver(drv, THIS_MODULE, KBUILD_MODNAME);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154}
155
156void gameport_unregister_driver(struct gameport_driver *drv);
157
David Woodhouse25478bb2006-04-25 13:59:30 +0100158#endif /* __KERNEL__ */
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#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
David Woodhouse25478bb2006-04-25 13:59:30 +0100175#ifdef __KERNEL__
176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177static 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
185static 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
193static 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
201static 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
209static inline int gameport_time(struct gameport *gameport, int time)
210{
211 return (time * gameport->speed) / 1000;
212}
213
214static inline void gameport_set_poll_handler(struct gameport *gameport, void (*handler)(struct gameport *))
215{
216 gameport->poll_handler = handler;
217}
218
219static inline void gameport_set_poll_interval(struct gameport *gameport, unsigned int msecs)
220{
221 gameport->poll_interval = msecs;
222}
223
224void gameport_start_polling(struct gameport *gameport);
225void gameport_stop_polling(struct gameport *gameport);
226
David Woodhouse25478bb2006-04-25 13:59:30 +0100227#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228#endif