drivers/hid/hid-wiimote.h

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