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
,
83 enum wiimote_exttype
{
87 WIIMOTE_EXT_CLASSIC_CONTROLLER
,
88 WIIMOTE_EXT_BALANCE_BOARD
,
96 WIIMOTE_MP_PASSTHROUGH_NUNCHUK
,
97 WIIMOTE_MP_PASSTHROUGH_CLASSIC
,
101 __u8 data
[HID_MAX_BUFFER_SIZE
];
105 struct wiimote_queue
{
107 struct work_struct worker
;
110 struct wiimote_buf outq
[WIIMOTE_BUFSIZE
];
113 struct wiimote_state
{
122 /* synchronous cmd requests */
124 struct completion ready
;
128 /* results of synchronous requests */
134 /* calibration data */
135 __u16 calib_bboard
[4][3];
138 struct wiimote_data
{
139 struct hid_device
*hdev
;
140 struct input_dev
*input
;
141 struct led_classdev
*leds
[4];
142 struct input_dev
*accel
;
143 struct input_dev
*ir
;
144 struct power_supply battery
;
145 struct input_dev
*mp
;
146 struct timer_list timer
;
147 struct wiimote_debug
*debug
;
150 struct input_dev
*input
;
153 struct wiimote_queue queue
;
154 struct wiimote_state state
;
155 struct work_struct init_worker
;
158 /* wiimote modules */
173 WIIMOD_NULL
= WIIMOD_NUM
,
176 #define WIIMOD_FLAG_INPUT 0x0001
177 #define WIIMOD_FLAG_EXT8 0x0002
178 #define WIIMOD_FLAG_EXT16 0x0004
183 int (*probe
) (const struct wiimod_ops
*ops
,
184 struct wiimote_data
*wdata
);
185 void (*remove
) (const struct wiimod_ops
*ops
,
186 struct wiimote_data
*wdata
);
188 void (*in_keys
) (struct wiimote_data
*wdata
, const __u8
*keys
);
189 void (*in_accel
) (struct wiimote_data
*wdata
, const __u8
*accel
);
190 void (*in_ir
) (struct wiimote_data
*wdata
, const __u8
*ir
, bool packed
,
192 void (*in_mp
) (struct wiimote_data
*wdata
, const __u8
*mp
);
193 void (*in_ext
) (struct wiimote_data
*wdata
, const __u8
*ext
);
196 extern const struct wiimod_ops
*wiimod_table
[WIIMOD_NUM
];
197 extern const struct wiimod_ops
*wiimod_ext_table
[WIIMOTE_EXT_NUM
];
198 extern const struct wiimod_ops wiimod_mp
;
200 /* wiimote requests */
203 WIIPROTO_REQ_NULL
= 0x0,
204 WIIPROTO_REQ_RUMBLE
= 0x10,
205 WIIPROTO_REQ_LED
= 0x11,
206 WIIPROTO_REQ_DRM
= 0x12,
207 WIIPROTO_REQ_IR1
= 0x13,
208 WIIPROTO_REQ_SREQ
= 0x15,
209 WIIPROTO_REQ_WMEM
= 0x16,
210 WIIPROTO_REQ_RMEM
= 0x17,
211 WIIPROTO_REQ_IR2
= 0x1a,
212 WIIPROTO_REQ_STATUS
= 0x20,
213 WIIPROTO_REQ_DATA
= 0x21,
214 WIIPROTO_REQ_RETURN
= 0x22,
217 WIIPROTO_REQ_DRM_K
= 0x30,
219 /* DRM_KA: BB*2 AA*3 */
220 WIIPROTO_REQ_DRM_KA
= 0x31,
222 /* DRM_KE: BB*2 EE*8 */
223 WIIPROTO_REQ_DRM_KE
= 0x32,
225 /* DRM_KAI: BB*2 AA*3 II*12 */
226 WIIPROTO_REQ_DRM_KAI
= 0x33,
228 /* DRM_KEE: BB*2 EE*19 */
229 WIIPROTO_REQ_DRM_KEE
= 0x34,
231 /* DRM_KAE: BB*2 AA*3 EE*16 */
232 WIIPROTO_REQ_DRM_KAE
= 0x35,
234 /* DRM_KIE: BB*2 II*10 EE*9 */
235 WIIPROTO_REQ_DRM_KIE
= 0x36,
237 /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
238 WIIPROTO_REQ_DRM_KAIE
= 0x37,
241 WIIPROTO_REQ_DRM_E
= 0x3d,
243 /* DRM_SKAI1: BB*2 AA*1 II*18 */
244 WIIPROTO_REQ_DRM_SKAI1
= 0x3e,
246 /* DRM_SKAI2: BB*2 AA*1 II*18 */
247 WIIPROTO_REQ_DRM_SKAI2
= 0x3f,
252 #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
255 void __wiimote_schedule(struct wiimote_data
*wdata
);
257 extern void wiiproto_req_drm(struct wiimote_data
*wdata
, __u8 drm
);
258 extern void wiiproto_req_rumble(struct wiimote_data
*wdata
, __u8 rumble
);
259 extern void wiiproto_req_leds(struct wiimote_data
*wdata
, int leds
);
260 extern void wiiproto_req_status(struct wiimote_data
*wdata
);
261 extern void wiiproto_req_accel(struct wiimote_data
*wdata
, __u8 accel
);
262 extern void wiiproto_req_ir1(struct wiimote_data
*wdata
, __u8 flags
);
263 extern void wiiproto_req_ir2(struct wiimote_data
*wdata
, __u8 flags
);
264 extern int wiimote_cmd_write(struct wiimote_data
*wdata
, __u32 offset
,
265 const __u8
*wmem
, __u8 size
);
266 extern ssize_t
wiimote_cmd_read(struct wiimote_data
*wdata
, __u32 offset
,
267 __u8
*rmem
, __u8 size
);
269 #define wiiproto_req_rreg(wdata, os, sz) \
270 wiiproto_req_rmem((wdata), false, (os), (sz))
271 #define wiiproto_req_reeprom(wdata, os, sz) \
272 wiiproto_req_rmem((wdata), true, (os), (sz))
273 extern void wiiproto_req_rmem(struct wiimote_data
*wdata
, bool eeprom
,
274 __u32 offset
, __u16 size
);
276 #ifdef CONFIG_DEBUG_FS
278 extern int wiidebug_init(struct wiimote_data
*wdata
);
279 extern void wiidebug_deinit(struct wiimote_data
*wdata
);
283 static inline int wiidebug_init(void *u
) { return 0; }
284 static inline void wiidebug_deinit(void *u
) { }
288 /* requires the state.lock spinlock to be held */
289 static inline bool wiimote_cmd_pending(struct wiimote_data
*wdata
, int cmd
,
292 return wdata
->state
.cmd
== cmd
&& wdata
->state
.opt
== opt
;
295 /* requires the state.lock spinlock to be held */
296 static inline void wiimote_cmd_complete(struct wiimote_data
*wdata
)
298 wdata
->state
.cmd
= WIIPROTO_REQ_NULL
;
299 complete(&wdata
->state
.ready
);
302 /* requires the state.lock spinlock to be held */
303 static inline void wiimote_cmd_abort(struct wiimote_data
*wdata
)
305 /* Abort synchronous request by waking up the sleeping caller. But
306 * reset the state.cmd field to an invalid value so no further event
307 * handlers will work with it. */
308 wdata
->state
.cmd
= WIIPROTO_REQ_MAX
;
309 complete(&wdata
->state
.ready
);
312 static inline int wiimote_cmd_acquire(struct wiimote_data
*wdata
)
314 return mutex_lock_interruptible(&wdata
->state
.sync
) ? -ERESTARTSYS
: 0;
317 static inline void wiimote_cmd_acquire_noint(struct wiimote_data
*wdata
)
319 mutex_lock(&wdata
->state
.sync
);
322 /* requires the state.lock spinlock to be held */
323 static inline void wiimote_cmd_set(struct wiimote_data
*wdata
, int cmd
,
326 INIT_COMPLETION(wdata
->state
.ready
);
327 wdata
->state
.cmd
= cmd
;
328 wdata
->state
.opt
= opt
;
331 static inline void wiimote_cmd_release(struct wiimote_data
*wdata
)
333 mutex_unlock(&wdata
->state
.sync
);
336 static inline int wiimote_cmd_wait(struct wiimote_data
*wdata
)
340 /* The completion acts as implicit memory barrier so we can safely
341 * assume that state.cmd is set on success/failure and isn't accessed
342 * by any other thread, anymore. */
344 ret
= wait_for_completion_interruptible_timeout(&wdata
->state
.ready
, HZ
);
349 else if (wdata
->state
.cmd
!= WIIPROTO_REQ_NULL
)
355 static inline int wiimote_cmd_wait_noint(struct wiimote_data
*wdata
)
359 /* no locking needed; see wiimote_cmd_wait() */
360 ret
= wait_for_completion_timeout(&wdata
->state
.ready
, HZ
);
363 else if (wdata
->state
.cmd
!= WIIPROTO_REQ_NULL
)