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