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