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
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)
52 /* return flag for led \num */
53 #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
70 enum wiimote_devtype
{
76 WIIMOTE_DEV_BALANCE_BOARD
,
80 enum wiimote_exttype
{
84 WIIMOTE_EXT_CLASSIC_CONTROLLER
,
85 WIIMOTE_EXT_BALANCE_BOARD
,
93 WIIMOTE_MP_PASSTHROUGH_NUNCHUK
,
94 WIIMOTE_MP_PASSTHROUGH_CLASSIC
,
98 __u8 data
[HID_MAX_BUFFER_SIZE
];
102 struct wiimote_queue
{
104 struct work_struct worker
;
107 struct wiimote_buf outq
[WIIMOTE_BUFSIZE
];
110 struct wiimote_state
{
119 /* synchronous cmd requests */
121 struct completion ready
;
125 /* results of synchronous requests */
131 /* calibration data */
132 __u16 calib_bboard
[4][3];
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
;
142 struct timer_list timer
;
143 struct wiimote_ext
*ext
;
144 struct wiimote_debug
*debug
;
147 struct input_dev
*input
;
150 struct wiimote_queue queue
;
151 struct wiimote_state state
;
152 struct work_struct init_worker
;
155 /* wiimote modules */
168 WIIMOD_NULL
= WIIMOD_NUM
,
171 #define WIIMOD_FLAG_INPUT 0x0001
172 #define WIIMOD_FLAG_EXT8 0x0002
173 #define WIIMOD_FLAG_EXT16 0x0004
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
);
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
,
187 void (*in_mp
) (struct wiimote_data
*wdata
, const __u8
*mp
);
188 void (*in_ext
) (struct wiimote_data
*wdata
, const __u8
*ext
);
191 extern const struct wiimod_ops
*wiimod_table
[WIIMOD_NUM
];
192 extern const struct wiimod_ops
*wiimod_ext_table
[WIIMOTE_EXT_NUM
];
193 extern const struct wiimod_ops wiimod_mp
;
195 /* wiimote requests */
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,
212 WIIPROTO_REQ_DRM_K
= 0x30,
214 /* DRM_KA: BB*2 AA*3 */
215 WIIPROTO_REQ_DRM_KA
= 0x31,
217 /* DRM_KE: BB*2 EE*8 */
218 WIIPROTO_REQ_DRM_KE
= 0x32,
220 /* DRM_KAI: BB*2 AA*3 II*12 */
221 WIIPROTO_REQ_DRM_KAI
= 0x33,
223 /* DRM_KEE: BB*2 EE*19 */
224 WIIPROTO_REQ_DRM_KEE
= 0x34,
226 /* DRM_KAE: BB*2 AA*3 EE*16 */
227 WIIPROTO_REQ_DRM_KAE
= 0x35,
229 /* DRM_KIE: BB*2 II*10 EE*9 */
230 WIIPROTO_REQ_DRM_KIE
= 0x36,
232 /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
233 WIIPROTO_REQ_DRM_KAIE
= 0x37,
236 WIIPROTO_REQ_DRM_E
= 0x3d,
238 /* DRM_SKAI1: BB*2 AA*1 II*18 */
239 WIIPROTO_REQ_DRM_SKAI1
= 0x3e,
241 /* DRM_SKAI2: BB*2 AA*1 II*18 */
242 WIIPROTO_REQ_DRM_SKAI2
= 0x3f,
247 #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
250 void __wiimote_schedule(struct wiimote_data
*wdata
);
252 extern void wiiproto_req_drm(struct wiimote_data
*wdata
, __u8 drm
);
253 extern void wiiproto_req_rumble(struct wiimote_data
*wdata
, __u8 rumble
);
254 extern void wiiproto_req_leds(struct wiimote_data
*wdata
, int leds
);
255 extern void wiiproto_req_status(struct wiimote_data
*wdata
);
256 extern void wiiproto_req_accel(struct wiimote_data
*wdata
, __u8 accel
);
257 extern void wiiproto_req_ir1(struct wiimote_data
*wdata
, __u8 flags
);
258 extern void wiiproto_req_ir2(struct wiimote_data
*wdata
, __u8 flags
);
259 extern int wiimote_cmd_write(struct wiimote_data
*wdata
, __u32 offset
,
260 const __u8
*wmem
, __u8 size
);
261 extern ssize_t
wiimote_cmd_read(struct wiimote_data
*wdata
, __u32 offset
,
262 __u8
*rmem
, __u8 size
);
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
);
271 #ifdef CONFIG_HID_WIIMOTE_EXT
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
);
277 extern void wiiext_handle(struct wiimote_data
*wdata
, const __u8
*payload
);
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; }
285 static inline void wiiext_handle(void *u
, const __u8
*p
) { }
289 #ifdef CONFIG_DEBUG_FS
291 extern int wiidebug_init(struct wiimote_data
*wdata
);
292 extern void wiidebug_deinit(struct wiimote_data
*wdata
);
296 static inline int wiidebug_init(void *u
) { return 0; }
297 static inline void wiidebug_deinit(void *u
) { }
301 /* requires the state.lock spinlock to be held */
302 static inline bool wiimote_cmd_pending(struct wiimote_data
*wdata
, int cmd
,
305 return wdata
->state
.cmd
== cmd
&& wdata
->state
.opt
== opt
;
308 /* requires the state.lock spinlock to be held */
309 static inline void wiimote_cmd_complete(struct wiimote_data
*wdata
)
311 wdata
->state
.cmd
= WIIPROTO_REQ_NULL
;
312 complete(&wdata
->state
.ready
);
315 /* requires the state.lock spinlock to be held */
316 static inline void wiimote_cmd_abort(struct wiimote_data
*wdata
)
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
);
325 static inline int wiimote_cmd_acquire(struct wiimote_data
*wdata
)
327 return mutex_lock_interruptible(&wdata
->state
.sync
) ? -ERESTARTSYS
: 0;
330 static inline void wiimote_cmd_acquire_noint(struct wiimote_data
*wdata
)
332 mutex_lock(&wdata
->state
.sync
);
335 /* requires the state.lock spinlock to be held */
336 static inline void wiimote_cmd_set(struct wiimote_data
*wdata
, int cmd
,
339 INIT_COMPLETION(wdata
->state
.ready
);
340 wdata
->state
.cmd
= cmd
;
341 wdata
->state
.opt
= opt
;
344 static inline void wiimote_cmd_release(struct wiimote_data
*wdata
)
346 mutex_unlock(&wdata
->state
.sync
);
349 static inline int wiimote_cmd_wait(struct wiimote_data
*wdata
)
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. */
357 ret
= wait_for_completion_interruptible_timeout(&wdata
->state
.ready
, HZ
);
362 else if (wdata
->state
.cmd
!= WIIPROTO_REQ_NULL
)
368 static inline int wiimote_cmd_wait_noint(struct wiimote_data
*wdata
)
372 /* no locking needed; see wiimote_cmd_wait() */
373 ret
= wait_for_completion_timeout(&wdata
->state
.ready
, HZ
);
376 else if (wdata
->state
.cmd
!= WIIPROTO_REQ_NULL
)