1 #ifndef __HID_WIIMOTE_H
2 #define __HID_WIIMOTE_H
5 * HID driver for Nintendo Wii / Wii U peripherals
6 * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
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)
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 #include <linux/timer.h>
27 #define WIIMOTE_NAME "Nintendo Wii Remote"
28 #define WIIMOTE_BUFSIZE 32
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 */
39 #define WIIPROTO_FLAG_EXT_PLUGGED 0x0100
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
46 #define WIIPROTO_FLAG_DRM_LOCKED 0x8000
48 #define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \
49 WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4)
50 #define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \
51 WIIPROTO_FLAG_IR_FULL)
53 /* return flag for led \num */
54 #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
71 enum wiimote_devtype {
77 WIIMOTE_DEV_BALANCE_BOARD,
81 enum wiimote_exttype {
85 WIIMOTE_EXT_CLASSIC_CONTROLLER,
86 WIIMOTE_EXT_BALANCE_BOARD,
94 WIIMOTE_MP_PASSTHROUGH_NUNCHUK,
95 WIIMOTE_MP_PASSTHROUGH_CLASSIC,
99 __u8 data[HID_MAX_BUFFER_SIZE];
103 struct wiimote_queue {
105 struct work_struct worker;
108 struct wiimote_buf outq[WIIMOTE_BUFSIZE];
111 struct wiimote_state {
120 /* synchronous cmd requests */
122 struct completion ready;
126 /* results of synchronous requests */
132 /* calibration data */
133 __u16 calib_bboard[4][3];
136 struct wiimote_data {
137 struct hid_device *hdev;
138 struct input_dev *input;
139 struct led_classdev *leds[4];
140 struct input_dev *accel;
141 struct input_dev *ir;
142 struct power_supply battery;
143 struct input_dev *mp;
144 struct timer_list timer;
145 struct wiimote_ext *ext;
146 struct wiimote_debug *debug;
149 struct input_dev *input;
152 struct wiimote_queue queue;
153 struct wiimote_state state;
154 struct work_struct init_worker;
157 /* wiimote modules */
170 WIIMOD_NULL = WIIMOD_NUM,
173 #define WIIMOD_FLAG_INPUT 0x0001
174 #define WIIMOD_FLAG_EXT8 0x0002
175 #define WIIMOD_FLAG_EXT16 0x0004
180 int (*probe) (const struct wiimod_ops *ops,
181 struct wiimote_data *wdata);
182 void (*remove) (const struct wiimod_ops *ops,
183 struct wiimote_data *wdata);
185 void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys);
186 void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel);
187 void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed,
189 void (*in_mp) (struct wiimote_data *wdata, const __u8 *mp);
190 void (*in_ext) (struct wiimote_data *wdata, const __u8 *ext);
193 extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM];
194 extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM];
195 extern const struct wiimod_ops wiimod_mp;
197 /* wiimote requests */
200 WIIPROTO_REQ_NULL = 0x0,
201 WIIPROTO_REQ_RUMBLE = 0x10,
202 WIIPROTO_REQ_LED = 0x11,
203 WIIPROTO_REQ_DRM = 0x12,
204 WIIPROTO_REQ_IR1 = 0x13,
205 WIIPROTO_REQ_SREQ = 0x15,
206 WIIPROTO_REQ_WMEM = 0x16,
207 WIIPROTO_REQ_RMEM = 0x17,
208 WIIPROTO_REQ_IR2 = 0x1a,
209 WIIPROTO_REQ_STATUS = 0x20,
210 WIIPROTO_REQ_DATA = 0x21,
211 WIIPROTO_REQ_RETURN = 0x22,
214 WIIPROTO_REQ_DRM_K = 0x30,
216 /* DRM_KA: BB*2 AA*3 */
217 WIIPROTO_REQ_DRM_KA = 0x31,
219 /* DRM_KE: BB*2 EE*8 */
220 WIIPROTO_REQ_DRM_KE = 0x32,
222 /* DRM_KAI: BB*2 AA*3 II*12 */
223 WIIPROTO_REQ_DRM_KAI = 0x33,
225 /* DRM_KEE: BB*2 EE*19 */
226 WIIPROTO_REQ_DRM_KEE = 0x34,
228 /* DRM_KAE: BB*2 AA*3 EE*16 */
229 WIIPROTO_REQ_DRM_KAE = 0x35,
231 /* DRM_KIE: BB*2 II*10 EE*9 */
232 WIIPROTO_REQ_DRM_KIE = 0x36,
234 /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
235 WIIPROTO_REQ_DRM_KAIE = 0x37,
238 WIIPROTO_REQ_DRM_E = 0x3d,
240 /* DRM_SKAI1: BB*2 AA*1 II*18 */
241 WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
243 /* DRM_SKAI2: BB*2 AA*1 II*18 */
244 WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
249 #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
252 void __wiimote_schedule(struct wiimote_data *wdata);
254 extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
255 extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble);
256 extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds);
257 extern void wiiproto_req_status(struct wiimote_data *wdata);
258 extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel);
259 extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags);
260 extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags);
261 extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
262 const __u8 *wmem, __u8 size);
263 extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
264 __u8 *rmem, __u8 size);
266 #define wiiproto_req_rreg(wdata, os, sz) \
267 wiiproto_req_rmem((wdata), false, (os), (sz))
268 #define wiiproto_req_reeprom(wdata, os, sz) \
269 wiiproto_req_rmem((wdata), true, (os), (sz))
270 extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
271 __u32 offset, __u16 size);
273 #ifdef CONFIG_HID_WIIMOTE_EXT
275 extern int wiiext_init(struct wiimote_data *wdata);
276 extern void wiiext_deinit(struct wiimote_data *wdata);
277 extern void wiiext_event(struct wiimote_data *wdata, bool plugged);
278 extern bool wiiext_active(struct wiimote_data *wdata);
279 extern void wiiext_handle(struct wiimote_data *wdata, const __u8 *payload);
283 static inline int wiiext_init(void *u) { return 0; }
284 static inline void wiiext_deinit(void *u) { }
285 static inline void wiiext_event(void *u, bool p) { }
286 static inline bool wiiext_active(void *u) { return false; }
287 static inline void wiiext_handle(void *u, const __u8 *p) { }
291 #ifdef CONFIG_DEBUG_FS
293 extern int wiidebug_init(struct wiimote_data *wdata);
294 extern void wiidebug_deinit(struct wiimote_data *wdata);
298 static inline int wiidebug_init(void *u) { return 0; }
299 static inline void wiidebug_deinit(void *u) { }
303 /* requires the state.lock spinlock to be held */
304 static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
307 return wdata->state.cmd == cmd && wdata->state.opt == opt;
310 /* requires the state.lock spinlock to be held */
311 static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
313 wdata->state.cmd = WIIPROTO_REQ_NULL;
314 complete(&wdata->state.ready);
317 /* requires the state.lock spinlock to be held */
318 static inline void wiimote_cmd_abort(struct wiimote_data *wdata)
320 /* Abort synchronous request by waking up the sleeping caller. But
321 * reset the state.cmd field to an invalid value so no further event
322 * handlers will work with it. */
323 wdata->state.cmd = WIIPROTO_REQ_MAX;
324 complete(&wdata->state.ready);
327 static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
329 return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
332 static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata)
334 mutex_lock(&wdata->state.sync);
337 /* requires the state.lock spinlock to be held */
338 static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
341 INIT_COMPLETION(wdata->state.ready);
342 wdata->state.cmd = cmd;
343 wdata->state.opt = opt;
346 static inline void wiimote_cmd_release(struct wiimote_data *wdata)
348 mutex_unlock(&wdata->state.sync);
351 static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
355 /* The completion acts as implicit memory barrier so we can safely
356 * assume that state.cmd is set on success/failure and isn't accessed
357 * by any other thread, anymore. */
359 ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
364 else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
370 static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata)
374 /* no locking needed; see wiimote_cmd_wait() */
375 ret = wait_for_completion_timeout(&wdata->state.ready, HZ);
378 else if (wdata->state.cmd != WIIPROTO_REQ_NULL)