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_NUM,
  77 };
  78
  79 enum wiimote_exttype {
  80         WIIMOTE_EXT_NONE,
  81         WIIMOTE_EXT_UNKNOWN,
  82         WIIMOTE_EXT_NUM,
  83 };
  84
  85 enum wiimote_mptype {
  86         WIIMOTE_MP_NONE,
  87         WIIMOTE_MP_UNKNOWN,
  88         WIIMOTE_MP_SINGLE,
  89         WIIMOTE_MP_PASSTHROUGH_NUNCHUK,
  90         WIIMOTE_MP_PASSTHROUGH_CLASSIC,
  91 };
  92
  93 struct wiimote_buf {
  94         __u8 data[HID_MAX_BUFFER_SIZE];
  95         size_t size;
  96 };
  97
  98 struct wiimote_queue {
  99         spinlock_t lock;
 100         struct work_struct worker;
 101         __u8 head;
 102         __u8 tail;
 103         struct wiimote_buf outq[WIIMOTE_BUFSIZE];
 104 };
 105
 106 struct wiimote_state {
 107         spinlock_t lock;
 108         __u32 flags;
 109         __u8 accel_split[2];
 110         __u8 drm;
 111         __u8 devtype;
 112         __u8 exttype;
 113         __u8 mp;
 114
 115         /* synchronous cmd requests */
 116         struct mutex sync;
 117         struct completion ready;
 118         int cmd;
 119         __u32 opt;
 120
 121         /* results of synchronous requests */
 122         __u8 cmd_battery;
 123         __u8 cmd_err;
 124         __u8 *cmd_read_buf;
 125         __u8 cmd_read_size;
 126 };
 127
 128 struct wiimote_data {
 129         struct hid_device *hdev;
 130         struct input_dev *input;
 131         struct led_classdev *leds[4];
 132         struct input_dev *accel;
 133         struct input_dev *ir;
 134         struct power_supply battery;
 135         struct timer_list timer;
 136         struct wiimote_ext *ext;
 137         struct wiimote_debug *debug;
 138
 139         struct wiimote_queue queue;
 140         struct wiimote_state state;
 141         struct work_struct init_worker;
 142 };
 143
 144 /* wiimote modules */
 145
 146 enum wiimod_module {
 147         WIIMOD_KEYS,
 148         WIIMOD_RUMBLE,
 149         WIIMOD_BATTERY,
 150         WIIMOD_LED1,
 151         WIIMOD_LED2,
 152         WIIMOD_LED3,
 153         WIIMOD_LED4,
 154         WIIMOD_ACCEL,
 155         WIIMOD_IR,
 156         WIIMOD_NUM,
 157         WIIMOD_NULL = WIIMOD_NUM,
 158 };
 159
 160 #define WIIMOD_FLAG_INPUT               0x0001
 161 #define WIIMOD_FLAG_EXT8                0x0002
 162 #define WIIMOD_FLAG_EXT16               0x0004
 163
 164 struct wiimod_ops {
 165         __u16 flags;
 166         unsigned long arg;
 167         int (*probe) (const struct wiimod_ops *ops,
 168                       struct wiimote_data *wdata);
 169         void (*remove) (const struct wiimod_ops *ops,
 170                         struct wiimote_data *wdata);
 171
 172         void (*in_keys) (struct wiimote_data *wdata, const __u8 *keys);
 173         void (*in_accel) (struct wiimote_data *wdata, const __u8 *accel);
 174         void (*in_ir) (struct wiimote_data *wdata, const __u8 *ir, bool packed,
 175                        unsigned int id);
 176         void (*in_mp) (struct wiimote_data *wdata, const __u8 *mp);
 177         void (*in_ext) (struct wiimote_data *wdata, const __u8 *ext);
 178 };
 179
 180 extern const struct wiimod_ops *wiimod_table[WIIMOD_NUM];
 181 extern const struct wiimod_ops *wiimod_ext_table[WIIMOTE_EXT_NUM];
 182 extern const struct wiimod_ops wiimod_mp;
 183
 184 /* wiimote requests */
 185
 186 enum wiiproto_reqs {
 187         WIIPROTO_REQ_NULL = 0x0,
 188         WIIPROTO_REQ_RUMBLE = 0x10,
 189         WIIPROTO_REQ_LED = 0x11,
 190         WIIPROTO_REQ_DRM = 0x12,
 191         WIIPROTO_REQ_IR1 = 0x13,
 192         WIIPROTO_REQ_SREQ = 0x15,
 193         WIIPROTO_REQ_WMEM = 0x16,
 194         WIIPROTO_REQ_RMEM = 0x17,
 195         WIIPROTO_REQ_IR2 = 0x1a,
 196         WIIPROTO_REQ_STATUS = 0x20,
 197         WIIPROTO_REQ_DATA = 0x21,
 198         WIIPROTO_REQ_RETURN = 0x22,
 199
 200         /* DRM_K: BB*2 */
 201         WIIPROTO_REQ_DRM_K = 0x30,
 202
 203         /* DRM_KA: BB*2 AA*3 */
 204         WIIPROTO_REQ_DRM_KA = 0x31,
 205
 206         /* DRM_KE: BB*2 EE*8 */
 207         WIIPROTO_REQ_DRM_KE = 0x32,
 208
 209         /* DRM_KAI: BB*2 AA*3 II*12 */
 210         WIIPROTO_REQ_DRM_KAI = 0x33,
 211
 212         /* DRM_KEE: BB*2 EE*19 */
 213         WIIPROTO_REQ_DRM_KEE = 0x34,
 214
 215         /* DRM_KAE: BB*2 AA*3 EE*16 */
 216         WIIPROTO_REQ_DRM_KAE = 0x35,
 217
 218         /* DRM_KIE: BB*2 II*10 EE*9 */
 219         WIIPROTO_REQ_DRM_KIE = 0x36,
 220
 221         /* DRM_KAIE: BB*2 AA*3 II*10 EE*6 */
 222         WIIPROTO_REQ_DRM_KAIE = 0x37,
 223
 224         /* DRM_E: EE*21 */
 225         WIIPROTO_REQ_DRM_E = 0x3d,
 226
 227         /* DRM_SKAI1: BB*2 AA*1 II*18 */
 228         WIIPROTO_REQ_DRM_SKAI1 = 0x3e,
 229
 230         /* DRM_SKAI2: BB*2 AA*1 II*18 */
 231         WIIPROTO_REQ_DRM_SKAI2 = 0x3f,
 232
 233         WIIPROTO_REQ_MAX
 234 };
 235
 236 #define dev_to_wii(pdev) hid_get_drvdata(container_of(pdev, struct hid_device, \
 237                                                                         dev))
 238
 239 void __wiimote_schedule(struct wiimote_data *wdata);
 240
 241 extern void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm);
 242 extern void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble);
 243 extern void wiiproto_req_leds(struct wiimote_data *wdata, int leds);
 244 extern void wiiproto_req_status(struct wiimote_data *wdata);
 245 extern void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel);
 246 extern void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags);
 247 extern void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags);
 248 extern int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
 249                                                 const __u8 *wmem, __u8 size);
 250 extern ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset,
 251                                                         __u8 *rmem, __u8 size);
 252
 253 #define wiiproto_req_rreg(wdata, os, sz) \
 254                                 wiiproto_req_rmem((wdata), false, (os), (sz))
 255 #define wiiproto_req_reeprom(wdata, os, sz) \
 256                                 wiiproto_req_rmem((wdata), true, (os), (sz))
 257 extern void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom,
 258                                                 __u32 offset, __u16 size);
 259
 260 #ifdef CONFIG_HID_WIIMOTE_EXT
 261
 262 extern int wiiext_init(struct wiimote_data *wdata);
 263 extern void wiiext_deinit(struct wiimote_data *wdata);
 264 extern void wiiext_event(struct wiimote_data *wdata, bool plugged);
 265 extern bool wiiext_active(struct wiimote_data *wdata);
 266 extern void wiiext_handle(struct wiimote_data *wdata, const __u8 *payload);
 267
 268 #else
 269
 270 static inline int wiiext_init(void *u) { return 0; }
 271 static inline void wiiext_deinit(void *u) { }
 272 static inline void wiiext_event(void *u, bool p) { }
 273 static inline bool wiiext_active(void *u) { return false; }
 274 static inline void wiiext_handle(void *u, const __u8 *p) { }
 275
 276 #endif
 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