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