blob: 7b6765797f81c2e33dc5ed638c7c365cdbc5cbb3 [file] [log] [blame]
David Herrmann7e274402011-11-17 14:11:59 +01001#ifndef __HID_WIIMOTE_H
2#define __HID_WIIMOTE_H
3
4/*
5 * HID driver for Nintendo Wiimote devices
6 * Copyright (c) 2011 David Herrmann
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
26#define WIIMOTE_NAME "Nintendo Wii Remote"
27#define WIIMOTE_BUFSIZE 32
28
29#define WIIPROTO_FLAG_LED1 0x01
30#define WIIPROTO_FLAG_LED2 0x02
31#define WIIPROTO_FLAG_LED3 0x04
32#define WIIPROTO_FLAG_LED4 0x08
33#define WIIPROTO_FLAG_RUMBLE 0x10
34#define WIIPROTO_FLAG_ACCEL 0x20
35#define WIIPROTO_FLAG_IR_BASIC 0x40
36#define WIIPROTO_FLAG_IR_EXT 0x80
37#define WIIPROTO_FLAG_IR_FULL 0xc0 /* IR_BASIC | IR_EXT */
38#define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \
39 WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4)
40#define WIIPROTO_FLAGS_IR (WIIPROTO_FLAG_IR_BASIC | WIIPROTO_FLAG_IR_EXT | \
41 WIIPROTO_FLAG_IR_FULL)
42
43/* return flag for led \num */
44#define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1))
45
46struct wiimote_buf {
47 __u8 data[HID_MAX_BUFFER_SIZE];
48 size_t size;
49};
50
51struct wiimote_state {
52 spinlock_t lock;
53 __u8 flags;
54 __u8 accel_split[2];
55
56 /* synchronous cmd requests */
57 struct mutex sync;
58 struct completion ready;
59 int cmd;
60 __u32 opt;
61
62 /* results of synchronous requests */
63 __u8 cmd_battery;
64 __u8 cmd_err;
David Herrmannfad8c0e2011-11-17 14:12:00 +010065 __u8 *cmd_read_buf;
66 __u8 cmd_read_size;
David Herrmann7e274402011-11-17 14:11:59 +010067};
68
69struct wiimote_data {
70 struct hid_device *hdev;
71 struct input_dev *input;
72 struct led_classdev *leds[4];
73 struct input_dev *accel;
74 struct input_dev *ir;
75 struct power_supply battery;
David Herrmanncb992212011-11-17 14:12:01 +010076 struct wiimote_ext *ext;
David Herrmann43e5e7c2011-11-17 14:12:10 +010077 struct wiimote_debug *debug;
David Herrmann7e274402011-11-17 14:11:59 +010078
79 spinlock_t qlock;
80 __u8 head;
81 __u8 tail;
82 struct wiimote_buf outq[WIIMOTE_BUFSIZE];
83 struct work_struct worker;
84
85 struct wiimote_state state;
86};
87
88enum wiiproto_reqs {
89 WIIPROTO_REQ_NULL = 0x0,
90 WIIPROTO_REQ_RUMBLE = 0x10,
91 WIIPROTO_REQ_LED = 0x11,
92 WIIPROTO_REQ_DRM = 0x12,
93 WIIPROTO_REQ_IR1 = 0x13,
94 WIIPROTO_REQ_SREQ = 0x15,
95 WIIPROTO_REQ_WMEM = 0x16,
96 WIIPROTO_REQ_RMEM = 0x17,
97 WIIPROTO_REQ_IR2 = 0x1a,
98 WIIPROTO_REQ_STATUS = 0x20,
99 WIIPROTO_REQ_DATA = 0x21,
100 WIIPROTO_REQ_RETURN = 0x22,
101 WIIPROTO_REQ_DRM_K = 0x30,
102 WIIPROTO_REQ_DRM_KA = 0x31,
103 WIIPROTO_REQ_DRM_KE = 0x32,
104 WIIPROTO_REQ_DRM_KAI = 0x33,
105 WIIPROTO_REQ_DRM_KEE = 0x34,
106 WIIPROTO_REQ_DRM_KAE = 0x35,
107 WIIPROTO_REQ_DRM_KIE = 0x36,
108 WIIPROTO_REQ_DRM_KAIE = 0x37,
109 WIIPROTO_REQ_DRM_E = 0x3d,
110 WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
111 WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
112};
113
114#define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
115 dev))
116
117extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
118extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
119 const __u8 *wmem, __u8 size);
David Herrmannfad8c0e2011-11-17 14:12:00 +0100120extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
121 __u8 *rmem, __u8 size);
David Herrmann7e274402011-11-17 14:11:59 +0100122
David Herrmann1d3452c2011-11-17 14:12:11 +0100123#define wiiproto_req_rreg(wdata, os, sz) \
124 wiiproto_req_rmem((wdata), false, (os), (sz))
125#define wiiproto_req_reeprom(wdata, os, sz) \
126 wiiproto_req_rmem((wdata), true, (os), (sz))
127extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
128 __u32 offset, __u16 size);
129
David Herrmanncb992212011-11-17 14:12:01 +0100130#ifdef CONFIG_HID_WIIMOTE_EXT
131
132extern int wiiext_init(struct wiimote_data *wdata);
133extern void wiiext_deinit(struct wiimote_data *wdata);
134extern void wiiext_event(struct wiimote_data *wdata, bool plugged);
135extern bool wiiext_active(struct wiimote_data *wdata);
David Herrmann0b6815d2011-11-17 14:12:06 +0100136extern void wiiext_handle(struct wiimote_data *wdata, const __u8 *payload);
David Herrmanncb992212011-11-17 14:12:01 +0100137
138#else
139
140static inline int wiiext_init(void *u) { return 0; }
141static inline void wiiext_deinit(void *u) { }
142static inline void wiiext_event(void *u, bool p) { }
143static inline bool wiiext_active(void *u) { return false; }
David Herrmann0b6815d2011-11-17 14:12:06 +0100144static inline void wiiext_handle(void *u, const __u8 *p) { }
David Herrmanncb992212011-11-17 14:12:01 +0100145
146#endif
147
David Herrmann43e5e7c2011-11-17 14:12:10 +0100148#ifdef CONFIG_DEBUG_FS
149
150extern int wiidebug_init(struct wiimote_data *wdata);
151extern void wiidebug_deinit(struct wiimote_data *wdata);
152
153#else
154
155static inline int wiidebug_init(void *u) { return 0; }
156static inline void wiidebug_deinit(void *u) { }
157
158#endif
159
David Herrmann7e274402011-11-17 14:11:59 +0100160/* requires the state.lock spinlock to be held */
161static inline bool wiimote_cmd_pending(struct wiimote_data *wdata, int cmd,
162 __u32 opt)
163{
164 return wdata->state.cmd == cmd && wdata->state.opt == opt;
165}
166
167/* requires the state.lock spinlock to be held */
168static inline void wiimote_cmd_complete(struct wiimote_data *wdata)
169{
170 wdata->state.cmd = WIIPROTO_REQ_NULL;
171 complete(&wdata->state.ready);
172}
173
174static inline int wiimote_cmd_acquire(struct wiimote_data *wdata)
175{
176 return mutex_lock_interruptible(&wdata->state.sync) ? -ERESTARTSYS : 0;
177}
178
179/* requires the state.lock spinlock to be held */
180static inline void wiimote_cmd_set(struct wiimote_data *wdata, int cmd,
181 __u32 opt)
182{
183 INIT_COMPLETION(wdata->state.ready);
184 wdata->state.cmd = cmd;
185 wdata->state.opt = opt;
186}
187
188static inline void wiimote_cmd_release(struct wiimote_data *wdata)
189{
190 mutex_unlock(&wdata->state.sync);
191}
192
193static inline int wiimote_cmd_wait(struct wiimote_data *wdata)
194{
195 int ret;
196
197 ret = wait_for_completion_interruptible_timeout(&wdata->state.ready, HZ);
198 if (ret < 0)
199 return -ERESTARTSYS;
200 else if (ret == 0)
201 return -EIO;
202 else
203 return 0;
204}
205
206#endif