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
47 #define WIIPROTO_FLAG_BUILTIN_MP 0x010000
48 #define WIIPROTO_FLAG_NO_MP 0x020000
50 #define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \
51 WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4)
52 #define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \
53 WIIPROTO_FLAG_IR_FULL)
55 /* return flag for led \num */
56 #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
73 enum wiimote_devtype {
79 WIIMOTE_DEV_BALANCE_BOARD,
80 WIIMOTE_DEV_PRO_CONTROLLER,
84 enum wiimote_exttype {
88 WIIMOTE_EXT_CLASSIC_CONTROLLER,
89 WIIMOTE_EXT_BALANCE_BOARD,
90 WIIMOTE_EXT_PRO_CONTROLLER,
91 WIIMOTE_EXT_GUITAR_HERO_DRUMS,
92 WIIMOTE_EXT_GUITAR_HERO_GUITAR,
100 WIIMOTE_MP_PASSTHROUGH_NUNCHUK,
101 WIIMOTE_MP_PASSTHROUGH_CLASSIC,
105 __u8 data[HID_MAX_BUFFER_SIZE];
109 struct wiimote_queue {
111 struct work_struct worker;
114 struct wiimote_buf outq[WIIMOTE_BUFSIZE];
117 struct wiimote_state {
126 /* synchronous cmd requests */
128 struct completion ready;
132 /* results of synchronous requests */
138 /* calibration data */
139 __u16 calib_bboard[4][3];
140 __u8 pressure_drums[7];
143 struct wiimote_data {
144 struct hid_device *hdev;
145 struct input_dev *input;
146 struct led_classdev *leds[4];
147 struct input_dev *accel;
148 struct input_dev *ir;
149 struct power_supply battery;
150 struct input_dev *mp;
151 struct timer_list timer;
152 struct wiimote_debug *debug;
155 struct input_dev *input;
158 struct wiimote_queue queue;
159 struct wiimote_state state;
160 struct work_struct init_worker;
163 /* wiimote modules */
178 WIIMOD_NULL = WIIMOD_NUM,
181 #define WIIMOD_FLAG_INPUT 0x0001
182 #define WIIMOD_FLAG_EXT8 0x0002
183 #define WIIMOD_FLAG_EXT16 0x0004
188 int (*probe) (const struct wiimod_ops *ops,
189 struct wiimote_data *wdata);
190 void (*remove) (const struct wiimod_ops *ops,
191 struct wiimote_data *wdata);
193 void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys);
194 void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel);
195 void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed,
197 void (*in_mp) (struct wiimote_data *wdata, const __u8 *mp);
198 void (*in_ext) (struct wiimote_data *wdata, const __u8 *ext);
201 extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM];
202 extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM];
203 extern const struct wiimod_ops wiimod_mp;
205 /* wiimote requests */
208 WIIPROTO_REQ_NULL = 0x0,
209 WIIPROTO_REQ_RUMBLE = 0x10,
210 WIIPROTO_REQ_LED = 0x11,
211 WIIPROTO_REQ_DRM = 0x12,
212 WIIPROTO_REQ_IR1 = 0x13,
213 WIIPROTO_REQ_SREQ = 0x15,
214 WIIPROTO_REQ_WMEM = 0x16,
215 WIIPROTO_REQ_RMEM = 0x17,
216 WIIPROTO_REQ_IR2 = 0x1a,
217 WIIPROTO_REQ_STATUS = 0x20,
218 WIIPROTO_REQ_DATA = 0x21,
219 WIIPROTO_REQ_RETURN = 0x22,
222 WIIPROTO_REQ_DRM_K = 0x30,
224 /* DRM_KA: BB*2 AA*3 */
225 WIIPROTO_REQ_DRM_KA = 0x31,
227 /* DRM_KE: BB*2 EE*8 */
228 WIIPROTO_REQ_DRM_KE = 0x32,
230 /* DRM_KAI: BB*2 AA*3 II*12 */
231 WIIPROTO_REQ_DRM_KAI = 0x33,
233 /* DRM_KEE: BB*2 EE*19 */
234 WIIPROTO_REQ_DRM_KEE = 0x34,
236 /* DRM_KAE: BB*2 AA*3 EE*16 */
237 WIIPROTO_REQ_DRM_KAE = 0x35,
239 /* DRM_KIE: BB*2 II*10 EE*9 */
240 WIIPROTO_REQ_DRM_KIE = 0x36,
242 /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
243 WIIPROTO_REQ_DRM_KAIE = 0x37,
246 WIIPROTO_REQ_DRM_E = 0x3d,
248 /* DRM_SKAI1: BB*2 AA*1 II*18 */
249 WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
251 /* DRM_SKAI2: BB*2 AA*1 II*18 */
252 WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
257 #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
260 void __wiimote_schedule(struct wiimote_data *wdata);
262 extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
263 extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble);
264 extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds);
265 extern void wiiproto_req_status(struct wiimote_data *wdata);
266 extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel);
267 extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags);
268 extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags);
269 extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
270 const __u8 *wmem, __u8 size);
271 extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
272 __u8 *rmem, __u8 size);
274 #define wiiproto_req_rreg(wdata, os, sz) \
275 wiiproto_req_rmem((wdata), false, (os), (sz))
276 #define wiiproto_req_reeprom(wdata, os, sz) \
277 wiiproto_req_rmem((wdata), true, (os), (sz))
278 extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
279 __u32 offset, __u16 size);
281 #ifdef CONFIG_DEBUG_FS
283 extern int wiidebug_init(struct wiimote_data *wdata);
284 extern void wiidebug_deinit(struct wiimote_data *wdata);
288 static inline int wiidebug_init(void *u) { return 0; }
289 static inline void wiidebug_deinit(void *u) { }
293 /* requires the state.lock spinlock to be held */
294 static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
297 return wdata->state.cmd == cmd && wdata->state.opt == opt;
300 /* requires the state.lock spinlock to be held */
301 static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
303 wdata->state.cmd = WIIPROTO_REQ_NULL;
304 complete(&wdata->state.ready);
307 /* requires the state.lock spinlock to be held */
308 static inline void wiimote_cmd_abort(struct wiimote_data *wdata)
310 /* Abort synchronous request by waking up the sleeping caller. But
311 * reset the state.cmd field to an invalid value so no further event
312 * handlers will work with it. */
313 wdata->state.cmd = WIIPROTO_REQ_MAX;
314 complete(&wdata->state.ready);
317 static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
319 return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
322 static inline void wiimote_cmd_acquire_noint(struct wiimote_data *wdata)
324 mutex_lock(&wdata->state.sync);
327 /* requires the state.lock spinlock to be held */
328 static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
331 INIT_COMPLETION(wdata->state.ready);
332 wdata->state.cmd = cmd;
333 wdata->state.opt = opt;
336 static inline void wiimote_cmd_release(struct wiimote_data *wdata)
338 mutex_unlock(&wdata->state.sync);
341 static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
345 /* The completion acts as implicit memory barrier so we can safely
346 * assume that state.cmd is set on success/failure and isn't accessed
347 * by any other thread, anymore. */
349 ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
354 else if (wdata->state.cmd != WIIPROTO_REQ_NULL)
360 static inline int wiimote_cmd_wait_noint(struct wiimote_data *wdata)
364 /* no locking needed; see wiimote_cmd_wait() */
365 ret = wait_for_completion_timeout(&wdata->state.ready, HZ);
368 else if (wdata->state.cmd != WIIPROTO_REQ_NULL)