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