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> | |
4148b6bf | 25 | #include <linux/timer.h> |
7e274400 DH |
26 | |
27 | #define WIIMOTE_NAME "Nintendo Wii Remote" | |
28 | #define WIIMOTE_BUFSIZE 32 | |
29 | ||
30 | #define WIIPROTO_FLAG_LED1 0x01 | |
31 | #define WIIPROTO_FLAG_LED2 0x02 | |
32 | #define WIIPROTO_FLAG_LED3 0x04 | |
33 | #define WIIPROTO_FLAG_LED4 0x08 | |
34 | #define WIIPROTO_FLAG_RUMBLE 0x10 | |
35 | #define WIIPROTO_FLAG_ACCEL 0x20 | |
36 | #define WIIPROTO_FLAG_IR_BASIC 0x40 | |
37 | #define WIIPROTO_FLAG_IR_EXT 0x80 | |
38 | #define WIIPROTO_FLAG_IR_FULL 0xc0 /* IR_BASIC | IR_EXT */ | |
c57ff761 | 39 | #define WIIPROTO_FLAG_EXT_PLUGGED 0x0100 |
4148b6bf DH |
40 | #define WIIPROTO_FLAG_EXT_USED 0x0200 |
41 | #define WIIPROTO_FLAG_EXT_ACTIVE 0x0400 | |
42 | #define WIIPROTO_FLAG_MP_PLUGGED 0x0800 | |
43 | #define WIIPROTO_FLAG_MP_USED 0x1000 | |
44 | #define WIIPROTO_FLAG_MP_ACTIVE 0x2000 | |
45 | #define WIIPROTO_FLAG_EXITING 0x4000 | |
c57ff761 | 46 | |
7e274400 DH |
47 | #define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \ |
48 | WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4) | |
49 | #define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \ | |
50 | WIIPROTO_FLAG_IR_FULL) | |
51 | ||
52 | /* return flag for led \num */ | |
53 | #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1)) | |
54 | ||
20cef813 DH |
55 | enum wiiproto_keys { |
56 | WIIPROTO_KEY_LEFT, | |
57 | WIIPROTO_KEY_RIGHT, | |
58 | WIIPROTO_KEY_UP, | |
59 | WIIPROTO_KEY_DOWN, | |
60 | WIIPROTO_KEY_PLUS, | |
61 | WIIPROTO_KEY_MINUS, | |
62 | WIIPROTO_KEY_ONE, | |
63 | WIIPROTO_KEY_TWO, | |
64 | WIIPROTO_KEY_A, | |
65 | WIIPROTO_KEY_B, | |
66 | WIIPROTO_KEY_HOME, | |
67 | WIIPROTO_KEY_COUNT | |
68 | }; | |
69 | ||
c57ff761 DH |
70 | enum wiimote_devtype { |
71 | WIIMOTE_DEV_PENDING, | |
72 | WIIMOTE_DEV_UNKNOWN, | |
73 | WIIMOTE_DEV_GENERIC, | |
74 | WIIMOTE_DEV_GEN10, | |
75 | WIIMOTE_DEV_GEN20, | |
f1d4bed4 | 76 | WIIMOTE_DEV_BALANCE_BOARD, |
c57ff761 DH |
77 | WIIMOTE_DEV_NUM, |
78 | }; | |
79 | ||
80 | enum wiimote_exttype { | |
81 | WIIMOTE_EXT_NONE, | |
82 | WIIMOTE_EXT_UNKNOWN, | |
b6ee67b3 | 83 | WIIMOTE_EXT_NUNCHUK, |
9d6f9ecb | 84 | WIIMOTE_EXT_CLASSIC_CONTROLLER, |
f1d4bed4 | 85 | WIIMOTE_EXT_BALANCE_BOARD, |
c57ff761 DH |
86 | WIIMOTE_EXT_NUM, |
87 | }; | |
88 | ||
4148b6bf DH |
89 | enum wiimote_mptype { |
90 | WIIMOTE_MP_NONE, | |
91 | WIIMOTE_MP_UNKNOWN, | |
92 | WIIMOTE_MP_SINGLE, | |
93 | WIIMOTE_MP_PASSTHROUGH_NUNCHUK, | |
94 | WIIMOTE_MP_PASSTHROUGH_CLASSIC, | |
95 | }; | |
96 | ||
7e274400 DH |
97 | struct wiimote_buf { |
98 | __u8 data[HID_MAX_BUFFER_SIZE]; | |
99 | size_t size; | |
100 | }; | |
101 | ||
13938538 DH |
102 | struct wiimote_queue { |
103 | spinlock_t lock; | |
104 | struct work_struct worker; | |
105 | __u8 head; | |
106 | __u8 tail; | |
107 | struct wiimote_buf outq[WIIMOTE_BUFSIZE]; | |
108 | }; | |
109 | ||
7e274400 DH |
110 | struct wiimote_state { |
111 | spinlock_t lock; | |
c57ff761 | 112 | __u32 flags; |
7e274400 | 113 | __u8 accel_split[2]; |
43d782ae | 114 | __u8 drm; |
c57ff761 | 115 | __u8 devtype; |
4148b6bf DH |
116 | __u8 exttype; |
117 | __u8 mp; | |
7e274400 DH |
118 | |
119 | /* synchronous cmd requests */ | |
120 | struct mutex sync; | |
121 | struct completion ready; | |
122 | int cmd; | |
123 | __u32 opt; | |
124 | ||
125 | /* results of synchronous requests */ | |
126 | __u8 cmd_battery; | |
127 | __u8 cmd_err; | |
fad8c0e3 DH |
128 | __u8 *cmd_read_buf; |
129 | __u8 cmd_read_size; | |
f1d4bed4 DH |
130 | |
131 | /* calibration data */ | |
132 | __u16 calib_bboard[4][3]; | |
7e274400 DH |
133 | }; |
134 | ||
135 | struct wiimote_data { | |
136 | struct hid_device *hdev; | |
137 | struct input_dev *input; | |
138 | struct led_classdev *leds[4]; | |
139 | struct input_dev *accel; | |
140 | struct input_dev *ir; | |
141 | struct power_supply battery; | |
4148b6bf | 142 | struct timer_list timer; |
cb99221b | 143 | struct wiimote_ext *ext; |
43e5e7c6 | 144 | struct wiimote_debug *debug; |
7e274400 | 145 | |
f1d4bed4 DH |
146 | union { |
147 | struct input_dev *input; | |
148 | } extension; | |
149 | ||
13938538 | 150 | struct wiimote_queue queue; |
7e274400 | 151 | struct wiimote_state state; |
c57ff761 | 152 | struct work_struct init_worker; |
7e274400 DH |
153 | }; |
154 | ||
27f06942 DH |
155 | /* wiimote modules */ |
156 | ||
157 | enum wiimod_module { | |
20cef813 DH |
158 | WIIMOD_KEYS, |
159 | WIIMOD_RUMBLE, | |
dcf39231 | 160 | WIIMOD_BATTERY, |
6c5ae018 DH |
161 | WIIMOD_LED1, |
162 | WIIMOD_LED2, | |
163 | WIIMOD_LED3, | |
164 | WIIMOD_LED4, | |
0ea16757 | 165 | WIIMOD_ACCEL, |
3b5f03c4 | 166 | WIIMOD_IR, |
27f06942 DH |
167 | WIIMOD_NUM, |
168 | WIIMOD_NULL = WIIMOD_NUM, | |
169 | }; | |
170 | ||
171 | #define WIIMOD_FLAG_INPUT 0x0001 | |
4148b6bf DH |
172 | #define WIIMOD_FLAG_EXT8 0x0002 |
173 | #define WIIMOD_FLAG_EXT16 0x0004 | |
27f06942 DH |
174 | |
175 | struct wiimod_ops { | |
176 | __u16 flags; | |
177 | unsigned long arg; | |
178 | int (*probe) (const struct wiimod_ops *ops, | |
179 | struct wiimote_data *wdata); | |
180 | void (*remove) (const struct wiimod_ops *ops, | |
181 | struct wiimote_data *wdata); | |
182 | ||
183 | void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys); | |
184 | void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel); | |
185 | void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed, | |
186 | unsigned int id); | |
4148b6bf DH |
187 | void (*in_mp) (struct wiimote_data *wdata, const __u8 *mp); |
188 | void (*in_ext) (struct wiimote_data *wdata, const __u8 *ext); | |
27f06942 DH |
189 | }; |
190 | ||
191 | extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM]; | |
4148b6bf DH |
192 | extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM]; |
193 | extern const struct wiimod_ops wiimod_mp; | |
27f06942 DH |
194 | |
195 | /* wiimote requests */ | |
196 | ||
7e274400 DH |
197 | enum wiiproto_reqs { |
198 | WIIPROTO_REQ_NULL = 0x0, | |
199 | WIIPROTO_REQ_RUMBLE = 0x10, | |
200 | WIIPROTO_REQ_LED = 0x11, | |
201 | WIIPROTO_REQ_DRM = 0x12, | |
202 | WIIPROTO_REQ_IR1 = 0x13, | |
203 | WIIPROTO_REQ_SREQ = 0x15, | |
204 | WIIPROTO_REQ_WMEM = 0x16, | |
205 | WIIPROTO_REQ_RMEM = 0x17, | |
206 | WIIPROTO_REQ_IR2 = 0x1a, | |
207 | WIIPROTO_REQ_STATUS = 0x20, | |
208 | WIIPROTO_REQ_DATA = 0x21, | |
209 | WIIPROTO_REQ_RETURN = 0x22, | |
4148b6bf DH |
210 | |
211 | /* DRM_K: BB*2 */ | |
7e274400 | 212 | WIIPROTO_REQ_DRM_K = 0x30, |
4148b6bf DH |
213 | |
214 | /* DRM_KA: BB*2 AA*3 */ | |
7e274400 | 215 | WIIPROTO_REQ_DRM_KA = 0x31, |
4148b6bf DH |
216 | |
217 | /* DRM_KE: BB*2 EE*8 */ | |
7e274400 | 218 | WIIPROTO_REQ_DRM_KE = 0x32, |
4148b6bf DH |
219 | |
220 | /* DRM_KAI: BB*2 AA*3 II*12 */ | |
7e274400 | 221 | WIIPROTO_REQ_DRM_KAI = 0x33, |
4148b6bf DH |
222 | |
223 | /* DRM_KEE: BB*2 EE*19 */ | |
7e274400 | 224 | WIIPROTO_REQ_DRM_KEE = 0x34, |
4148b6bf DH |
225 | |
226 | /* DRM_KAE: BB*2 AA*3 EE*16 */ | |
7e274400 | 227 | WIIPROTO_REQ_DRM_KAE = 0x35, |
4148b6bf DH |
228 | |
229 | /* DRM_KIE: BB*2 II*10 EE*9 */ | |
7e274400 | 230 | WIIPROTO_REQ_DRM_KIE = 0x36, |
4148b6bf DH |
231 | |
232 | /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */ | |
7e274400 | 233 | WIIPROTO_REQ_DRM_KAIE = 0x37, |
4148b6bf DH |
234 | |
235 | /* DRM_E: EE*21 */ | |
7e274400 | 236 | WIIPROTO_REQ_DRM_E = 0x3d, |
4148b6bf DH |
237 | |
238 | /* DRM_SKAI1: BB*2 AA*1 II*18 */ | |
7e274400 | 239 | WIIPROTO_REQ_DRM_SKAI1 = 0x3e, |
4148b6bf DH |
240 | |
241 | /* DRM_SKAI2: BB*2 AA*1 II*18 */ | |
7e274400 | 242 | WIIPROTO_REQ_DRM_SKAI2 = 0x3f, |
4148b6bf | 243 | |
43d782ae | 244 | WIIPROTO_REQ_MAX |
7e274400 DH |
245 | }; |
246 | ||
247 | #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \ | |
248 | dev)) | |
249 | ||
4148b6bf DH |
250 | void __wiimote_schedule(struct wiimote_data *wdata); |
251 | ||
7e274400 | 252 | extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm); |
20cef813 | 253 | extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble); |
6c5ae018 | 254 | extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds); |
dcf39231 | 255 | extern void wiiproto_req_status(struct wiimote_data *wdata); |
0ea16757 | 256 | extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel); |
3b5f03c4 DH |
257 | extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags); |
258 | extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags); | |
7e274400 DH |
259 | extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset, |
260 | const __u8 *wmem, __u8 size); | |
fad8c0e3 DH |
261 | extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset, |
262 | __u8 *rmem, __u8 size); | |
7e274400 | 263 | |
1d3452c6 DH |
264 | #define wiiproto_req_rreg(wdata, os, sz) \ |
265 | wiiproto_req_rmem((wdata), false, (os), (sz)) | |
266 | #define wiiproto_req_reeprom(wdata, os, sz) \ | |
267 | wiiproto_req_rmem((wdata), true, (os), (sz)) | |
268 | extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom, | |
269 | __u32 offset, __u16 size); | |
270 | ||
cb99221b DH |
271 | #ifdef CONFIG_HID_WIIMOTE_EXT |
272 | ||
273 | extern int wiiext_init(struct wiimote_data *wdata); | |
274 | extern void wiiext_deinit(struct wiimote_data *wdata); | |
275 | extern void wiiext_event(struct wiimote_data *wdata, bool plugged); | |
276 | extern bool wiiext_active(struct wiimote_data *wdata); | |
0b6815d7 | 277 | extern void wiiext_handle(struct wiimote_data *wdata, const __u8 *payload); |
cb99221b DH |
278 | |
279 | #else | |
280 | ||
281 | static inline int wiiext_init(void *u) { return 0; } | |
282 | static inline void wiiext_deinit(void *u) { } | |
283 | static inline void wiiext_event(void *u, bool p) { } | |
284 | static inline bool wiiext_active(void *u) { return false; } | |
0b6815d7 | 285 | static inline void wiiext_handle(void *u, const __u8 *p) { } |
cb99221b DH |
286 | |
287 | #endif | |
288 | ||
43e5e7c6 DH |
289 | #ifdef CONFIG_DEBUG_FS |
290 | ||
291 | extern int wiidebug_init(struct wiimote_data *wdata); | |
292 | extern void wiidebug_deinit(struct wiimote_data *wdata); | |
293 | ||
294 | #else | |
295 | ||
296 | static inline int wiidebug_init(void *u) { return 0; } | |
297 | static inline void wiidebug_deinit(void *u) { } | |
298 | ||
299 | #endif | |
300 | ||
7e274400 DH |
301 | /* requires the state.lock spinlock to be held */ |
302 | static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd, | |
303 | __u32 opt) | |
304 | { | |
305 | return wdata->state.cmd == cmd && wdata->state.opt == opt; | |
306 | } | |
307 | ||
308 | /* requires the state.lock spinlock to be held */ | |
309 | static inline void wiimote_cmd_complete(struct wiimote_data *wdata) | |
310 | { | |
311 | wdata->state.cmd = WIIPROTO_REQ_NULL; | |
312 | complete(&wdata->state.ready); | |
313 | } | |
314 | ||
d758b1f0 DH |
315 | /* requires the state.lock spinlock to be held */ |
316 | static inline void wiimote_cmd_abort(struct wiimote_data *wdata) | |
317 | { | |
318 | /* Abort synchronous request by waking up the sleeping caller. But | |
319 | * reset the state.cmd field to an invalid value so no further event | |
320 | * handlers will work with it. */ | |
321 | wdata->state.cmd = WIIPROTO_REQ_MAX; | |
322 | complete(&wdata->state.ready); | |
323 | } | |
324 | ||
7e274400 DH |
325 | static inline int wiimote_cmd_acquire(struct wiimote_data *wdata) |
326 | { | |
327 | return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0; | |
328 | } | |
329 | ||
c57ff761 DH |
330 | static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata) |
331 | { | |
332 | mutex_lock(&wdata->state.sync); | |
333 | } | |
334 | ||
7e274400 DH |
335 | /* requires the state.lock spinlock to be held */ |
336 | static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd, | |
337 | __u32 opt) | |
338 | { | |
339 | INIT_COMPLETION(wdata->state.ready); | |
340 | wdata->state.cmd = cmd; | |
341 | wdata->state.opt = opt; | |
342 | } | |
343 | ||
344 | static inline void wiimote_cmd_release(struct wiimote_data *wdata) | |
345 | { | |
346 | mutex_unlock(&wdata->state.sync); | |
347 | } | |
348 | ||
349 | static inline int wiimote_cmd_wait(struct wiimote_data *wdata) | |
350 | { | |
351 | int ret; | |
352 | ||
d758b1f0 DH |
353 | /* The completion acts as implicit memory barrier so we can safely |
354 | * assume that state.cmd is set on success/failure and isn't accessed | |
355 | * by any other thread, anymore. */ | |
356 | ||
7e274400 DH |
357 | ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ); |
358 | if (ret < 0) | |
359 | return -ERESTARTSYS; | |
360 | else if (ret == 0) | |
361 | return -EIO; | |
d758b1f0 DH |
362 | else if (wdata->state.cmd != WIIPROTO_REQ_NULL) |
363 | return -EIO; | |
7e274400 DH |
364 | else |
365 | return 0; | |
366 | } | |
367 | ||
c57ff761 DH |
368 | static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata) |
369 | { | |
370 | unsigned long ret; | |
371 | ||
d758b1f0 | 372 | /* no locking needed; see wiimote_cmd_wait() */ |
c57ff761 DH |
373 | ret = wait_for_completion_timeout(&wdata->state.ready, HZ); |
374 | if (!ret) | |
375 | return -EIO; | |
d758b1f0 DH |
376 | else if (wdata->state.cmd != WIIPROTO_REQ_NULL) |
377 | return -EIO; | |
c57ff761 DH |
378 | else |
379 | return 0; | |
380 | } | |
381 | ||
7e274400 | 382 | #endif |