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