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