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