]>
Commit | Line | Data |
---|---|---|
7e274400 DH |
1 | #ifndef __HID_WIIMOTE_H |
2 | #define __HID_WIIMOTE_H | |
3 | ||
4 | /* | |
92eda7e4 DH |
5 | * HID driver for Nintendo Wii / Wii U peripherals |
6 | * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com> | |
7e274400 DH |
7 | */ |
8 | ||
9 | /* | |
10 | * This program is free software; you can redistribute it and/or modify it | |
11 | * under the terms of the GNU General Public License as published by the Free | |
12 | * Software Foundation; either version 2 of the License, or (at your option) | |
13 | * any later version. | |
14 | */ | |
15 | ||
16 | #include <linux/completion.h> | |
17 | #include <linux/device.h> | |
18 | #include <linux/hid.h> | |
19 | #include <linux/input.h> | |
20 | #include <linux/leds.h> | |
21 | #include <linux/module.h> | |
22 | #include <linux/mutex.h> | |
23 | #include <linux/power_supply.h> | |
24 | #include <linux/spinlock.h> | |
25 | ||
26 | #define WIIMOTE_NAME "Nintendo Wii Remote" | |
27 | #define WIIMOTE_BUFSIZE 32 | |
28 | ||
29 | #define WIIPROTO_FLAG_LED1 0x01 | |
30 | #define WIIPROTO_FLAG_LED2 0x02 | |
31 | #define WIIPROTO_FLAG_LED3 0x04 | |
32 | #define WIIPROTO_FLAG_LED4 0x08 | |
33 | #define WIIPROTO_FLAG_RUMBLE 0x10 | |
34 | #define WIIPROTO_FLAG_ACCEL 0x20 | |
35 | #define WIIPROTO_FLAG_IR_BASIC 0x40 | |
36 | #define WIIPROTO_FLAG_IR_EXT 0x80 | |
37 | #define WIIPROTO_FLAG_IR_FULL 0xc0 /* IR_BASIC | IR_EXT */ | |
c57ff761 DH |
38 | #define WIIPROTO_FLAG_EXT_PLUGGED 0x0100 |
39 | ||
7e274400 DH |
40 | #define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \ |
41 | WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4) | |
42 | #define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \ | |
43 | WIIPROTO_FLAG_IR_FULL) | |
44 | ||
45 | /* return flag for led \num */ | |
46 | #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1)) | |
47 | ||
20cef813 DH |
48 | enum wiiproto_keys { |
49 | WIIPROTO_KEY_LEFT, | |
50 | WIIPROTO_KEY_RIGHT, | |
51 | WIIPROTO_KEY_UP, | |
52 | WIIPROTO_KEY_DOWN, | |
53 | WIIPROTO_KEY_PLUS, | |
54 | WIIPROTO_KEY_MINUS, | |
55 | WIIPROTO_KEY_ONE, | |
56 | WIIPROTO_KEY_TWO, | |
57 | WIIPROTO_KEY_A, | |
58 | WIIPROTO_KEY_B, | |
59 | WIIPROTO_KEY_HOME, | |
60 | WIIPROTO_KEY_COUNT | |
61 | }; | |
62 | ||
c57ff761 DH |
63 | enum wiimote_devtype { |
64 | WIIMOTE_DEV_PENDING, | |
65 | WIIMOTE_DEV_UNKNOWN, | |
66 | WIIMOTE_DEV_GENERIC, | |
67 | WIIMOTE_DEV_GEN10, | |
68 | WIIMOTE_DEV_GEN20, | |
69 | WIIMOTE_DEV_NUM, | |
70 | }; | |
71 | ||
72 | enum wiimote_exttype { | |
73 | WIIMOTE_EXT_NONE, | |
74 | WIIMOTE_EXT_UNKNOWN, | |
75 | WIIMOTE_EXT_NUM, | |
76 | }; | |
77 | ||
7e274400 DH |
78 | struct wiimote_buf { |
79 | __u8 data[HID_MAX_BUFFER_SIZE]; | |
80 | size_t size; | |
81 | }; | |
82 | ||
13938538 DH |
83 | struct wiimote_queue { |
84 | spinlock_t lock; | |
85 | struct work_struct worker; | |
86 | __u8 head; | |
87 | __u8 tail; | |
88 | struct wiimote_buf outq[WIIMOTE_BUFSIZE]; | |
89 | }; | |
90 | ||
7e274400 DH |
91 | struct wiimote_state { |
92 | spinlock_t lock; | |
c57ff761 | 93 | __u32 flags; |
7e274400 | 94 | __u8 accel_split[2]; |
43d782ae | 95 | __u8 drm; |
c57ff761 | 96 | __u8 devtype; |
7e274400 DH |
97 | |
98 | /* synchronous cmd requests */ | |
99 | struct mutex sync; | |
100 | struct completion ready; | |
101 | int cmd; | |
102 | __u32 opt; | |
103 | ||
104 | /* results of synchronous requests */ | |
105 | __u8 cmd_battery; | |
106 | __u8 cmd_err; | |
fad8c0e3 DH |
107 | __u8 *cmd_read_buf; |
108 | __u8 cmd_read_size; | |
7e274400 DH |
109 | }; |
110 | ||
111 | struct wiimote_data { | |
112 | struct hid_device *hdev; | |
113 | struct input_dev *input; | |
114 | struct led_classdev *leds[4]; | |
115 | struct input_dev *accel; | |
116 | struct input_dev *ir; | |
117 | struct power_supply battery; | |
cb99221b | 118 | struct wiimote_ext *ext; |
43e5e7c6 | 119 | struct wiimote_debug *debug; |
7e274400 | 120 | |
13938538 | 121 | struct wiimote_queue queue; |
7e274400 | 122 | struct wiimote_state state; |
c57ff761 | 123 | struct work_struct init_worker; |
7e274400 DH |
124 | }; |
125 | ||
27f06942 DH |
126 | /* wiimote modules */ |
127 | ||
128 | enum wiimod_module { | |
20cef813 DH |
129 | WIIMOD_KEYS, |
130 | WIIMOD_RUMBLE, | |
dcf39231 | 131 | WIIMOD_BATTERY, |
6c5ae018 DH |
132 | WIIMOD_LED1, |
133 | WIIMOD_LED2, | |
134 | WIIMOD_LED3, | |
135 | WIIMOD_LED4, | |
0ea16757 | 136 | WIIMOD_ACCEL, |
27f06942 DH |
137 | WIIMOD_NUM, |
138 | WIIMOD_NULL = WIIMOD_NUM, | |
139 | }; | |
140 | ||
141 | #define WIIMOD_FLAG_INPUT 0x0001 | |
142 | ||
143 | struct wiimod_ops { | |
144 | __u16 flags; | |
145 | unsigned long arg; | |
146 | int (*probe) (const struct wiimod_ops *ops, | |
147 | struct wiimote_data *wdata); | |
148 | void (*remove) (const struct wiimod_ops *ops, | |
149 | struct wiimote_data *wdata); | |
150 | ||
151 | void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys); | |
152 | void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel); | |
153 | void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed, | |
154 | unsigned int id); | |
155 | }; | |
156 | ||
157 | extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM]; | |
158 | ||
159 | /* wiimote requests */ | |
160 | ||
7e274400 DH |
161 | enum wiiproto_reqs { |
162 | WIIPROTO_REQ_NULL = 0x0, | |
163 | WIIPROTO_REQ_RUMBLE = 0x10, | |
164 | WIIPROTO_REQ_LED = 0x11, | |
165 | WIIPROTO_REQ_DRM = 0x12, | |
166 | WIIPROTO_REQ_IR1 = 0x13, | |
167 | WIIPROTO_REQ_SREQ = 0x15, | |
168 | WIIPROTO_REQ_WMEM = 0x16, | |
169 | WIIPROTO_REQ_RMEM = 0x17, | |
170 | WIIPROTO_REQ_IR2 = 0x1a, | |
171 | WIIPROTO_REQ_STATUS = 0x20, | |
172 | WIIPROTO_REQ_DATA = 0x21, | |
173 | WIIPROTO_REQ_RETURN = 0x22, | |
174 | WIIPROTO_REQ_DRM_K = 0x30, | |
175 | WIIPROTO_REQ_DRM_KA = 0x31, | |
176 | WIIPROTO_REQ_DRM_KE = 0x32, | |
177 | WIIPROTO_REQ_DRM_KAI = 0x33, | |
178 | WIIPROTO_REQ_DRM_KEE = 0x34, | |
179 | WIIPROTO_REQ_DRM_KAE = 0x35, | |
180 | WIIPROTO_REQ_DRM_KIE = 0x36, | |
181 | WIIPROTO_REQ_DRM_KAIE = 0x37, | |
182 | WIIPROTO_REQ_DRM_E = 0x3d, | |
183 | WIIPROTO_REQ_DRM_SKAI1 = 0x3e, | |
184 | WIIPROTO_REQ_DRM_SKAI2 = 0x3f, | |
43d782ae | 185 | WIIPROTO_REQ_MAX |
7e274400 DH |
186 | }; |
187 | ||
188 | #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \ | |
189 | dev)) | |
190 | ||
191 | extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm); | |
20cef813 | 192 | extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble); |
6c5ae018 | 193 | extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds); |
dcf39231 | 194 | extern void wiiproto_req_status(struct wiimote_data *wdata); |
0ea16757 | 195 | extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel); |
7e274400 DH |
196 | extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset, |
197 | const __u8 *wmem, __u8 size); | |
fad8c0e3 DH |
198 | extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset, |
199 | __u8 *rmem, __u8 size); | |
7e274400 | 200 | |
1d3452c6 DH |
201 | #define wiiproto_req_rreg(wdata, os, sz) \ |
202 | wiiproto_req_rmem((wdata), false, (os), (sz)) | |
203 | #define wiiproto_req_reeprom(wdata, os, sz) \ | |
204 | wiiproto_req_rmem((wdata), true, (os), (sz)) | |
205 | extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom, | |
206 | __u32 offset, __u16 size); | |
207 | ||
cb99221b DH |
208 | #ifdef CONFIG_HID_WIIMOTE_EXT |
209 | ||
210 | extern int wiiext_init(struct wiimote_data *wdata); | |
211 | extern void wiiext_deinit(struct wiimote_data *wdata); | |
212 | extern void wiiext_event(struct wiimote_data *wdata, bool plugged); | |
213 | extern bool wiiext_active(struct wiimote_data *wdata); | |
0b6815d7 | 214 | extern void wiiext_handle(struct wiimote_data *wdata, const __u8 *payload); |
cb99221b DH |
215 | |
216 | #else | |
217 | ||
218 | static inline int wiiext_init(void *u) { return 0; } | |
219 | static inline void wiiext_deinit(void *u) { } | |
220 | static inline void wiiext_event(void *u, bool p) { } | |
221 | static inline bool wiiext_active(void *u) { return false; } | |
0b6815d7 | 222 | static inline void wiiext_handle(void *u, const __u8 *p) { } |
cb99221b DH |
223 | |
224 | #endif | |
225 | ||
43e5e7c6 DH |
226 | #ifdef CONFIG_DEBUG_FS |
227 | ||
228 | extern int wiidebug_init(struct wiimote_data *wdata); | |
229 | extern void wiidebug_deinit(struct wiimote_data *wdata); | |
230 | ||
231 | #else | |
232 | ||
233 | static inline int wiidebug_init(void *u) { return 0; } | |
234 | static inline void wiidebug_deinit(void *u) { } | |
235 | ||
236 | #endif | |
237 | ||
7e274400 DH |
238 | /* requires the state.lock spinlock to be held */ |
239 | static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd, | |
240 | __u32 opt) | |
241 | { | |
242 | return wdata->state.cmd == cmd && wdata->state.opt == opt; | |
243 | } | |
244 | ||
245 | /* requires the state.lock spinlock to be held */ | |
246 | static inline void wiimote_cmd_complete(struct wiimote_data *wdata) | |
247 | { | |
248 | wdata->state.cmd = WIIPROTO_REQ_NULL; | |
249 | complete(&wdata->state.ready); | |
250 | } | |
251 | ||
d758b1f0 DH |
252 | /* requires the state.lock spinlock to be held */ |
253 | static inline void wiimote_cmd_abort(struct wiimote_data *wdata) | |
254 | { | |
255 | /* Abort synchronous request by waking up the sleeping caller. But | |
256 | * reset the state.cmd field to an invalid value so no further event | |
257 | * handlers will work with it. */ | |
258 | wdata->state.cmd = WIIPROTO_REQ_MAX; | |
259 | complete(&wdata->state.ready); | |
260 | } | |
261 | ||
7e274400 DH |
262 | static inline int wiimote_cmd_acquire(struct wiimote_data *wdata) |
263 | { | |
264 | return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0; | |
265 | } | |
266 | ||
c57ff761 DH |
267 | static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata) |
268 | { | |
269 | mutex_lock(&wdata->state.sync); | |
270 | } | |
271 | ||
7e274400 DH |
272 | /* requires the state.lock spinlock to be held */ |
273 | static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd, | |
274 | __u32 opt) | |
275 | { | |
276 | INIT_COMPLETION(wdata->state.ready); | |
277 | wdata->state.cmd = cmd; | |
278 | wdata->state.opt = opt; | |
279 | } | |
280 | ||
281 | static inline void wiimote_cmd_release(struct wiimote_data *wdata) | |
282 | { | |
283 | mutex_unlock(&wdata->state.sync); | |
284 | } | |
285 | ||
286 | static inline int wiimote_cmd_wait(struct wiimote_data *wdata) | |
287 | { | |
288 | int ret; | |
289 | ||
d758b1f0 DH |
290 | /* The completion acts as implicit memory barrier so we can safely |
291 | * assume that state.cmd is set on success/failure and isn't accessed | |
292 | * by any other thread, anymore. */ | |
293 | ||
7e274400 DH |
294 | ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ); |
295 | if (ret < 0) | |
296 | return -ERESTARTSYS; | |
297 | else if (ret == 0) | |
298 | return -EIO; | |
d758b1f0 DH |
299 | else if (wdata->state.cmd != WIIPROTO_REQ_NULL) |
300 | return -EIO; | |
7e274400 DH |
301 | else |
302 | return 0; | |
303 | } | |
304 | ||
c57ff761 DH |
305 | static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata) |
306 | { | |
307 | unsigned long ret; | |
308 | ||
d758b1f0 | 309 | /* no locking needed; see wiimote_cmd_wait() */ |
c57ff761 DH |
310 | ret = wait_for_completion_timeout(&wdata->state.ready, HZ); |
311 | if (!ret) | |
312 | return -EIO; | |
d758b1f0 DH |
313 | else if (wdata->state.cmd != WIIPROTO_REQ_NULL) |
314 | return -EIO; | |
c57ff761 DH |
315 | else |
316 | return 0; | |
317 | } | |
318 | ||
7e274400 | 319 | #endif |