1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HID driver for Nintendo Wii / Wii U peripherals
4 * Copyright (c) 2011-2013 David Herrmann <dh.herrmann@gmail.com>
10 #include <linux/completion.h>
11 #include <linux/device.h>
12 #include <linux/hid.h>
13 #include <linux/input.h>
14 #include <linux/module.h>
15 #include <linux/mutex.h>
16 #include <linux/spinlock.h>
18 #include "hid-wiimote.h"
20 /* output queue handling */
22 static int wiimote_hid_send(struct hid_device *hdev, __u8 *buffer,
28 if (!hdev->ll_driver->output_report)
31 buf = kmemdup(buffer, count, GFP_KERNEL);
35 ret = hid_hw_output_report(hdev, buf, count);
41 static void wiimote_queue_worker(struct work_struct *work)
43 struct wiimote_queue *queue = container_of(work, struct wiimote_queue,
45 struct wiimote_data *wdata = container_of(queue, struct wiimote_data,
50 spin_lock_irqsave(&wdata->queue.lock, flags);
52 while (wdata->queue.head != wdata->queue.tail) {
53 spin_unlock_irqrestore(&wdata->queue.lock, flags);
54 ret = wiimote_hid_send(wdata->hdev,
55 wdata->queue.outq[wdata->queue.tail].data,
56 wdata->queue.outq[wdata->queue.tail].size);
58 spin_lock_irqsave(&wdata->state.lock, flags);
59 wiimote_cmd_abort(wdata);
60 spin_unlock_irqrestore(&wdata->state.lock, flags);
62 spin_lock_irqsave(&wdata->queue.lock, flags);
64 wdata->queue.tail = (wdata->queue.tail + 1) % WIIMOTE_BUFSIZE;
67 spin_unlock_irqrestore(&wdata->queue.lock, flags);
70 static void wiimote_queue(struct wiimote_data *wdata, const __u8 *buffer,
76 if (count > HID_MAX_BUFFER_SIZE) {
77 hid_warn(wdata->hdev, "Sending too large output report\n");
79 spin_lock_irqsave(&wdata->queue.lock, flags);
84 * Copy new request into our output queue and check whether the
85 * queue is full. If it is full, discard this request.
86 * If it is empty we need to start a new worker that will
87 * send out the buffer to the hid device.
88 * If the queue is not empty, then there must be a worker
89 * that is currently sending out our buffer and this worker
90 * will reschedule itself until the queue is empty.
93 spin_lock_irqsave(&wdata->queue.lock, flags);
95 memcpy(wdata->queue.outq[wdata->queue.head].data, buffer, count);
96 wdata->queue.outq[wdata->queue.head].size = count;
97 newhead = (wdata->queue.head + 1) % WIIMOTE_BUFSIZE;
99 if (wdata->queue.head == wdata->queue.tail) {
100 wdata->queue.head = newhead;
101 schedule_work(&wdata->queue.worker);
102 } else if (newhead != wdata->queue.tail) {
103 wdata->queue.head = newhead;
105 hid_warn(wdata->hdev, "Output queue is full");
112 wiimote_cmd_abort(wdata);
114 spin_unlock_irqrestore(&wdata->queue.lock, flags);
118 * This sets the rumble bit on the given output report if rumble is
120 * \cmd1 must point to the second byte in the output report => &cmd[1]
121 * This must be called on nearly every output report before passing it
122 * into the output queue!
124 static inline void wiiproto_keep_rumble(struct wiimote_data *wdata, __u8 *cmd1)
126 if (wdata->state.flags & WIIPROTO_FLAG_RUMBLE)
130 void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble)
135 if (rumble == !!(wdata->state.flags & WIIPROTO_FLAG_RUMBLE))
139 wdata->state.flags |= WIIPROTO_FLAG_RUMBLE;
141 wdata->state.flags &= ~WIIPROTO_FLAG_RUMBLE;
143 cmd[0] = WIIPROTO_REQ_RUMBLE;
146 wiiproto_keep_rumble(wdata, &cmd[1]);
147 wiimote_queue(wdata, cmd, sizeof(cmd));
150 void wiiproto_req_leds(struct wiimote_data *wdata, int leds)
154 leds &= WIIPROTO_FLAGS_LEDS;
155 if ((wdata->state.flags & WIIPROTO_FLAGS_LEDS) == leds)
157 wdata->state.flags = (wdata->state.flags & ~WIIPROTO_FLAGS_LEDS) | leds;
159 cmd[0] = WIIPROTO_REQ_LED;
162 if (leds & WIIPROTO_FLAG_LED1)
164 if (leds & WIIPROTO_FLAG_LED2)
166 if (leds & WIIPROTO_FLAG_LED3)
168 if (leds & WIIPROTO_FLAG_LED4)
171 wiiproto_keep_rumble(wdata, &cmd[1]);
172 wiimote_queue(wdata, cmd, sizeof(cmd));
176 * Check what peripherals of the wiimote are currently
177 * active and select a proper DRM that supports all of
178 * the requested data inputs.
180 * Not all combinations are actually supported. The following
181 * combinations work only with limitations:
182 * - IR cam in extended or full mode disables any data transmission
183 * of extension controllers. There is no DRM mode that supports
184 * extension bytes plus extended/full IR.
185 * - IR cam with accelerometer and extension *_EXT8 is not supported.
186 * However, all extensions that need *_EXT8 are devices that don't
187 * support IR cameras. Hence, this shouldn't happen under normal
189 * - *_EXT16 is only supported in combination with buttons and
190 * accelerometer. No IR or similar can be active simultaneously. As
191 * above, all modules that require it are mutually exclusive with
192 * IR/etc. so this doesn't matter.
194 static __u8 select_drm(struct wiimote_data *wdata)
196 __u8 ir = wdata->state.flags & WIIPROTO_FLAGS_IR;
199 ext = (wdata->state.flags & WIIPROTO_FLAG_EXT_USED) ||
200 (wdata->state.flags & WIIPROTO_FLAG_MP_USED);
202 /* some 3rd-party balance-boards are hard-coded to KEE, *sigh* */
203 if (wdata->state.devtype == WIIMOTE_DEV_BALANCE_BOARD) {
205 return WIIPROTO_REQ_DRM_KEE;
207 return WIIPROTO_REQ_DRM_K;
210 if (ir == WIIPROTO_FLAG_IR_BASIC) {
211 if (wdata->state.flags & WIIPROTO_FLAG_ACCEL) {
212 /* GEN10 and ealier devices bind IR formats to DRMs.
213 * Hence, we cannot use DRM_KAI here as it might be
214 * bound to IR_EXT. Use DRM_KAIE unconditionally so we
215 * work with all devices and our parsers can use the
216 * fixed formats, too. */
217 return WIIPROTO_REQ_DRM_KAIE;
219 return WIIPROTO_REQ_DRM_KIE;
221 } else if (ir == WIIPROTO_FLAG_IR_EXT) {
222 return WIIPROTO_REQ_DRM_KAI;
223 } else if (ir == WIIPROTO_FLAG_IR_FULL) {
224 return WIIPROTO_REQ_DRM_SKAI1;
226 if (wdata->state.flags & WIIPROTO_FLAG_ACCEL) {
228 return WIIPROTO_REQ_DRM_KAE;
230 return WIIPROTO_REQ_DRM_KA;
233 return WIIPROTO_REQ_DRM_KEE;
235 return WIIPROTO_REQ_DRM_K;
240 void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm)
244 if (wdata->state.flags & WIIPROTO_FLAG_DRM_LOCKED)
245 drm = wdata->state.drm;
246 else if (drm == WIIPROTO_REQ_NULL)
247 drm = select_drm(wdata);
249 cmd[0] = WIIPROTO_REQ_DRM;
253 wdata->state.drm = drm;
254 wiiproto_keep_rumble(wdata, &cmd[1]);
255 wiimote_queue(wdata, cmd, sizeof(cmd));
258 void wiiproto_req_status(struct wiimote_data *wdata)
262 cmd[0] = WIIPROTO_REQ_SREQ;
265 wiiproto_keep_rumble(wdata, &cmd[1]);
266 wiimote_queue(wdata, cmd, sizeof(cmd));
269 void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel)
272 if (accel == !!(wdata->state.flags & WIIPROTO_FLAG_ACCEL))
276 wdata->state.flags |= WIIPROTO_FLAG_ACCEL;
278 wdata->state.flags &= ~WIIPROTO_FLAG_ACCEL;
280 wiiproto_req_drm(wdata, WIIPROTO_REQ_NULL);
283 void wiiproto_req_ir1(struct wiimote_data *wdata, __u8 flags)
287 cmd[0] = WIIPROTO_REQ_IR1;
290 wiiproto_keep_rumble(wdata, &cmd[1]);
291 wiimote_queue(wdata, cmd, sizeof(cmd));
294 void wiiproto_req_ir2(struct wiimote_data *wdata, __u8 flags)
298 cmd[0] = WIIPROTO_REQ_IR2;
301 wiiproto_keep_rumble(wdata, &cmd[1]);
302 wiimote_queue(wdata, cmd, sizeof(cmd));
305 #define wiiproto_req_wreg(wdata, os, buf, sz) \
306 wiiproto_req_wmem((wdata), false, (os), (buf), (sz))
308 #define wiiproto_req_weeprom(wdata, os, buf, sz) \
309 wiiproto_req_wmem((wdata), true, (os), (buf), (sz))
311 static void wiiproto_req_wmem(struct wiimote_data *wdata, bool eeprom,
312 __u32 offset, const __u8 *buf, __u8 size)
316 if (size > 16 || size == 0) {
317 hid_warn(wdata->hdev, "Invalid length %d wmem request\n", size);
321 memset(cmd, 0, sizeof(cmd));
322 cmd[0] = WIIPROTO_REQ_WMEM;
323 cmd[2] = (offset >> 16) & 0xff;
324 cmd[3] = (offset >> 8) & 0xff;
325 cmd[4] = offset & 0xff;
327 memcpy(&cmd[6], buf, size);
332 wiiproto_keep_rumble(wdata, &cmd[1]);
333 wiimote_queue(wdata, cmd, sizeof(cmd));
336 void wiiproto_req_rmem(struct wiimote_data *wdata, bool eeprom, __u32 offset,
342 hid_warn(wdata->hdev, "Invalid length %d rmem request\n", size);
346 cmd[0] = WIIPROTO_REQ_RMEM;
348 cmd[2] = (offset >> 16) & 0xff;
349 cmd[3] = (offset >> 8) & 0xff;
350 cmd[4] = offset & 0xff;
351 cmd[5] = (size >> 8) & 0xff;
352 cmd[6] = size & 0xff;
357 wiiproto_keep_rumble(wdata, &cmd[1]);
358 wiimote_queue(wdata, cmd, sizeof(cmd));
361 /* requries the cmd-mutex to be held */
362 int wiimote_cmd_write(struct wiimote_data *wdata, __u32 offset,
363 const __u8 *wmem, __u8 size)
368 spin_lock_irqsave(&wdata->state.lock, flags);
369 wiimote_cmd_set(wdata, WIIPROTO_REQ_WMEM, 0);
370 wiiproto_req_wreg(wdata, offset, wmem, size);
371 spin_unlock_irqrestore(&wdata->state.lock, flags);
373 ret = wiimote_cmd_wait(wdata);
374 if (!ret && wdata->state.cmd_err)
380 /* requries the cmd-mutex to be held */
381 ssize_t wiimote_cmd_read(struct wiimote_data *wdata, __u32 offset, __u8 *rmem,
387 spin_lock_irqsave(&wdata->state.lock, flags);
388 wdata->state.cmd_read_size = size;
389 wdata->state.cmd_read_buf = rmem;
390 wiimote_cmd_set(wdata, WIIPROTO_REQ_RMEM, offset & 0xffff);
391 wiiproto_req_rreg(wdata, offset, size);
392 spin_unlock_irqrestore(&wdata->state.lock, flags);
394 ret = wiimote_cmd_wait(wdata);
396 spin_lock_irqsave(&wdata->state.lock, flags);
397 wdata->state.cmd_read_buf = NULL;
398 spin_unlock_irqrestore(&wdata->state.lock, flags);
401 if (wdata->state.cmd_read_size == 0)
404 ret = wdata->state.cmd_read_size;
410 /* requires the cmd-mutex to be held */
411 static int wiimote_cmd_init_ext(struct wiimote_data *wdata)
416 /* initialize extension */
418 ret = wiimote_cmd_write(wdata, 0xa400f0, &wmem, sizeof(wmem));
422 /* disable default encryption */
424 ret = wiimote_cmd_write(wdata, 0xa400fb, &wmem, sizeof(wmem));
431 /* requires the cmd-mutex to be held */
432 static __u8 wiimote_cmd_read_ext(struct wiimote_data *wdata, __u8 *rmem)
436 /* read extension ID */
437 ret = wiimote_cmd_read(wdata, 0xa400fa, rmem, 6);
439 return WIIMOTE_EXT_NONE;
441 hid_dbg(wdata->hdev, "extension ID: %6phC\n", rmem);
443 if (rmem[0] == 0xff && rmem[1] == 0xff && rmem[2] == 0xff &&
444 rmem[3] == 0xff && rmem[4] == 0xff && rmem[5] == 0xff)
445 return WIIMOTE_EXT_NONE;
447 if (rmem[4] == 0x00 && rmem[5] == 0x00)
448 return WIIMOTE_EXT_NUNCHUK;
449 if (rmem[4] == 0x01 && rmem[5] == 0x01)
450 return WIIMOTE_EXT_CLASSIC_CONTROLLER;
451 if (rmem[4] == 0x04 && rmem[5] == 0x02)
452 return WIIMOTE_EXT_BALANCE_BOARD;
453 if (rmem[4] == 0x01 && rmem[5] == 0x20)
454 return WIIMOTE_EXT_PRO_CONTROLLER;
455 if (rmem[0] == 0x01 && rmem[1] == 0x00 &&
456 rmem[4] == 0x01 && rmem[5] == 0x03)
457 return WIIMOTE_EXT_DRUMS;
458 if (rmem[0] == 0x00 && rmem[1] == 0x00 &&
459 rmem[4] == 0x01 && rmem[5] == 0x03)
460 return WIIMOTE_EXT_GUITAR;
461 if (rmem[0] == 0x03 && rmem[1] == 0x00 &&
462 rmem[4] == 0x01 && rmem[5] == 0x03)
463 return WIIMOTE_EXT_TURNTABLE;
465 return WIIMOTE_EXT_UNKNOWN;
468 /* requires the cmd-mutex to be held */
469 static int wiimote_cmd_init_mp(struct wiimote_data *wdata)
476 ret = wiimote_cmd_write(wdata, 0xa600f0, &wmem, sizeof(wmem));
480 /* disable default encryption */
482 ret = wiimote_cmd_write(wdata, 0xa600fb, &wmem, sizeof(wmem));
489 /* requires the cmd-mutex to be held */
490 static bool wiimote_cmd_map_mp(struct wiimote_data *wdata, __u8 exttype)
494 /* map MP with correct pass-through mode */
496 case WIIMOTE_EXT_CLASSIC_CONTROLLER:
497 case WIIMOTE_EXT_DRUMS:
498 case WIIMOTE_EXT_GUITAR:
501 case WIIMOTE_EXT_TURNTABLE:
502 case WIIMOTE_EXT_NUNCHUK:
510 return wiimote_cmd_write(wdata, 0xa600fe, &wmem, sizeof(wmem));
513 /* requires the cmd-mutex to be held */
514 static bool wiimote_cmd_read_mp(struct wiimote_data *wdata, __u8 *rmem)
518 /* read motion plus ID */
519 ret = wiimote_cmd_read(wdata, 0xa600fa, rmem, 6);
523 hid_dbg(wdata->hdev, "motion plus ID: %6phC\n", rmem);
528 hid_info(wdata->hdev, "unknown motion plus ID: %6phC\n", rmem);
533 /* requires the cmd-mutex to be held */
534 static __u8 wiimote_cmd_read_mp_mapped(struct wiimote_data *wdata)
539 /* read motion plus ID */
540 ret = wiimote_cmd_read(wdata, 0xa400fa, rmem, 6);
542 return WIIMOTE_MP_NONE;
544 hid_dbg(wdata->hdev, "mapped motion plus ID: %6phC\n", rmem);
546 if (rmem[0] == 0xff && rmem[1] == 0xff && rmem[2] == 0xff &&
547 rmem[3] == 0xff && rmem[4] == 0xff && rmem[5] == 0xff)
548 return WIIMOTE_MP_NONE;
550 if (rmem[4] == 0x04 && rmem[5] == 0x05)
551 return WIIMOTE_MP_SINGLE;
552 else if (rmem[4] == 0x05 && rmem[5] == 0x05)
553 return WIIMOTE_MP_PASSTHROUGH_NUNCHUK;
554 else if (rmem[4] == 0x07 && rmem[5] == 0x05)
555 return WIIMOTE_MP_PASSTHROUGH_CLASSIC;
557 return WIIMOTE_MP_UNKNOWN;
560 /* device module handling */
562 static const __u8 * const wiimote_devtype_mods[WIIMOTE_DEV_NUM] = {
563 [WIIMOTE_DEV_PENDING] = (const __u8[]){
566 [WIIMOTE_DEV_UNKNOWN] = (const __u8[]){
570 [WIIMOTE_DEV_GENERIC] = (const __u8[]){
582 [WIIMOTE_DEV_GEN10] = (const __u8[]){
594 [WIIMOTE_DEV_GEN20] = (const __u8[]){
607 [WIIMOTE_DEV_BALANCE_BOARD] = (const __u8[]) {
613 [WIIMOTE_DEV_PRO_CONTROLLER] = (const __u8[]) {
624 static void wiimote_modules_load(struct wiimote_data *wdata,
625 unsigned int devtype)
627 bool need_input = false;
628 const __u8 *mods, *iter;
629 const struct wiimod_ops *ops;
632 mods = wiimote_devtype_mods[devtype];
634 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
635 if (wiimod_table[*iter]->flags & WIIMOD_FLAG_INPUT) {
642 wdata->input = input_allocate_device();
646 input_set_drvdata(wdata->input, wdata);
647 wdata->input->dev.parent = &wdata->hdev->dev;
648 wdata->input->id.bustype = wdata->hdev->bus;
649 wdata->input->id.vendor = wdata->hdev->vendor;
650 wdata->input->id.product = wdata->hdev->product;
651 wdata->input->id.version = wdata->hdev->version;
652 wdata->input->name = WIIMOTE_NAME;
655 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
656 ops = wiimod_table[*iter];
660 ret = ops->probe(ops, wdata);
666 ret = input_register_device(wdata->input);
671 spin_lock_irq(&wdata->state.lock);
672 wdata->state.devtype = devtype;
673 spin_unlock_irq(&wdata->state.lock);
677 for ( ; iter-- != mods; ) {
678 ops = wiimod_table[*iter];
680 ops->remove(ops, wdata);
684 input_free_device(wdata->input);
689 static void wiimote_modules_unload(struct wiimote_data *wdata)
691 const __u8 *mods, *iter;
692 const struct wiimod_ops *ops;
695 mods = wiimote_devtype_mods[wdata->state.devtype];
697 spin_lock_irqsave(&wdata->state.lock, flags);
698 wdata->state.devtype = WIIMOTE_DEV_UNKNOWN;
699 spin_unlock_irqrestore(&wdata->state.lock, flags);
701 /* find end of list */
702 for (iter = mods; *iter != WIIMOD_NULL; ++iter)
706 input_get_device(wdata->input);
707 input_unregister_device(wdata->input);
710 for ( ; iter-- != mods; ) {
711 ops = wiimod_table[*iter];
713 ops->remove(ops, wdata);
717 input_put_device(wdata->input);
722 /* device extension handling */
724 static void wiimote_ext_load(struct wiimote_data *wdata, unsigned int ext)
727 const struct wiimod_ops *ops;
730 ops = wiimod_ext_table[ext];
733 ret = ops->probe(ops, wdata);
735 ext = WIIMOTE_EXT_UNKNOWN;
738 spin_lock_irqsave(&wdata->state.lock, flags);
739 wdata->state.exttype = ext;
740 spin_unlock_irqrestore(&wdata->state.lock, flags);
743 static void wiimote_ext_unload(struct wiimote_data *wdata)
746 const struct wiimod_ops *ops;
748 ops = wiimod_ext_table[wdata->state.exttype];
750 spin_lock_irqsave(&wdata->state.lock, flags);
751 wdata->state.exttype = WIIMOTE_EXT_UNKNOWN;
752 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_USED;
753 spin_unlock_irqrestore(&wdata->state.lock, flags);
756 ops->remove(ops, wdata);
759 static void wiimote_mp_load(struct wiimote_data *wdata)
762 const struct wiimod_ops *ops;
768 ret = ops->probe(ops, wdata);
773 spin_lock_irqsave(&wdata->state.lock, flags);
774 wdata->state.mp = mode;
775 spin_unlock_irqrestore(&wdata->state.lock, flags);
778 static void wiimote_mp_unload(struct wiimote_data *wdata)
781 const struct wiimod_ops *ops;
783 if (wdata->state.mp < 2)
788 spin_lock_irqsave(&wdata->state.lock, flags);
790 wdata->state.flags &= ~WIIPROTO_FLAG_MP_USED;
791 spin_unlock_irqrestore(&wdata->state.lock, flags);
794 ops->remove(ops, wdata);
797 /* device (re-)initialization and detection */
799 static const char *wiimote_devtype_names[WIIMOTE_DEV_NUM] = {
800 [WIIMOTE_DEV_PENDING] = "Pending",
801 [WIIMOTE_DEV_UNKNOWN] = "Unknown",
802 [WIIMOTE_DEV_GENERIC] = "Generic",
803 [WIIMOTE_DEV_GEN10] = "Nintendo Wii Remote (Gen 1)",
804 [WIIMOTE_DEV_GEN20] = "Nintendo Wii Remote Plus (Gen 2)",
805 [WIIMOTE_DEV_BALANCE_BOARD] = "Nintendo Wii Balance Board",
806 [WIIMOTE_DEV_PRO_CONTROLLER] = "Nintendo Wii U Pro Controller",
809 /* Try to guess the device type based on all collected information. We
810 * first try to detect by static extension types, then VID/PID and the
811 * device name. If we cannot detect the device, we use
812 * WIIMOTE_DEV_GENERIC so all modules will get probed on the device. */
813 static void wiimote_init_set_type(struct wiimote_data *wdata,
816 __u8 devtype = WIIMOTE_DEV_GENERIC;
817 __u16 vendor, product;
820 vendor = wdata->hdev->vendor;
821 product = wdata->hdev->product;
822 name = wdata->hdev->name;
824 if (exttype == WIIMOTE_EXT_BALANCE_BOARD) {
825 devtype = WIIMOTE_DEV_BALANCE_BOARD;
827 } else if (exttype == WIIMOTE_EXT_PRO_CONTROLLER) {
828 devtype = WIIMOTE_DEV_PRO_CONTROLLER;
832 if (!strcmp(name, "Nintendo RVL-CNT-01")) {
833 devtype = WIIMOTE_DEV_GEN10;
835 } else if (!strcmp(name, "Nintendo RVL-CNT-01-TR")) {
836 devtype = WIIMOTE_DEV_GEN20;
838 } else if (!strcmp(name, "Nintendo RVL-WBC-01")) {
839 devtype = WIIMOTE_DEV_BALANCE_BOARD;
841 } else if (!strcmp(name, "Nintendo RVL-CNT-01-UC")) {
842 devtype = WIIMOTE_DEV_PRO_CONTROLLER;
846 if (vendor == USB_VENDOR_ID_NINTENDO) {
847 if (product == USB_DEVICE_ID_NINTENDO_WIIMOTE) {
848 devtype = WIIMOTE_DEV_GEN10;
850 } else if (product == USB_DEVICE_ID_NINTENDO_WIIMOTE2) {
851 devtype = WIIMOTE_DEV_GEN20;
857 if (devtype == WIIMOTE_DEV_GENERIC)
858 hid_info(wdata->hdev, "cannot detect device; NAME: %s VID: %04x PID: %04x EXT: %04x\n",
859 name, vendor, product, exttype);
861 hid_info(wdata->hdev, "detected device: %s\n",
862 wiimote_devtype_names[devtype]);
864 wiimote_modules_load(wdata, devtype);
867 static void wiimote_init_detect(struct wiimote_data *wdata)
869 __u8 exttype = WIIMOTE_EXT_NONE, extdata[6];
873 wiimote_cmd_acquire_noint(wdata);
875 spin_lock_irq(&wdata->state.lock);
876 wdata->state.devtype = WIIMOTE_DEV_UNKNOWN;
877 wiimote_cmd_set(wdata, WIIPROTO_REQ_SREQ, 0);
878 wiiproto_req_status(wdata);
879 spin_unlock_irq(&wdata->state.lock);
881 ret = wiimote_cmd_wait_noint(wdata);
885 spin_lock_irq(&wdata->state.lock);
886 ext = wdata->state.flags & WIIPROTO_FLAG_EXT_PLUGGED;
887 spin_unlock_irq(&wdata->state.lock);
892 wiimote_cmd_init_ext(wdata);
893 exttype = wiimote_cmd_read_ext(wdata, extdata);
896 wiimote_cmd_release(wdata);
897 wiimote_init_set_type(wdata, exttype);
899 /* schedule MP timer */
900 spin_lock_irq(&wdata->state.lock);
901 if (!(wdata->state.flags & WIIPROTO_FLAG_BUILTIN_MP) &&
902 !(wdata->state.flags & WIIPROTO_FLAG_NO_MP))
903 mod_timer(&wdata->timer, jiffies + HZ * 4);
904 spin_unlock_irq(&wdata->state.lock);
908 * MP hotplug events are not generated by the wiimote. Therefore, we need
909 * polling to detect it. We use a 4s interval for polling MP registers. This
910 * seems reasonable considering applications can trigger it manually via
913 static void wiimote_init_poll_mp(struct wiimote_data *wdata)
918 wiimote_cmd_acquire_noint(wdata);
919 wiimote_cmd_init_mp(wdata);
920 mp = wiimote_cmd_read_mp(wdata, mpdata);
921 wiimote_cmd_release(wdata);
923 /* load/unload MP module if it changed */
925 if (!wdata->state.mp) {
926 hid_info(wdata->hdev, "detected extension: Nintendo Wii Motion Plus\n");
927 wiimote_mp_load(wdata);
929 } else if (wdata->state.mp) {
930 wiimote_mp_unload(wdata);
933 mod_timer(&wdata->timer, jiffies + HZ * 4);
937 * Check whether the wiimote is in the expected state. The extension registers
938 * may change during hotplug and initialization so we might get hotplug events
939 * that we caused by remapping some memory.
940 * We use some heuristics here to check known states. If the wiimote is in the
941 * expected state, we can ignore the hotplug event.
943 * Returns "true" if the device is in expected state, "false" if we should
944 * redo hotplug handling and extension initialization.
946 static bool wiimote_init_check(struct wiimote_data *wdata)
952 spin_lock_irq(&wdata->state.lock);
953 flags = wdata->state.flags;
954 spin_unlock_irq(&wdata->state.lock);
956 wiimote_cmd_acquire_noint(wdata);
958 /* If MP is used and active, but the extension is not, we expect:
959 * read_mp_mapped() == WIIMOTE_MP_SINGLE
960 * state.flags == !EXT_ACTIVE && !MP_PLUGGED && MP_ACTIVE
961 * We do not check EXT_PLUGGED because it might change during
962 * initialization of MP without extensions.
963 * - If MP is unplugged/replugged, read_mp_mapped() fails
964 * - If EXT is plugged, MP_PLUGGED will get set */
965 if (wdata->state.exttype == WIIMOTE_EXT_NONE &&
966 wdata->state.mp > 0 && (flags & WIIPROTO_FLAG_MP_USED)) {
967 type = wiimote_cmd_read_mp_mapped(wdata);
968 ret = type == WIIMOTE_MP_SINGLE;
970 spin_lock_irq(&wdata->state.lock);
971 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_EXT_ACTIVE);
972 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_MP_PLUGGED);
973 ret = ret && (wdata->state.flags & WIIPROTO_FLAG_MP_ACTIVE);
974 spin_unlock_irq(&wdata->state.lock);
977 hid_dbg(wdata->hdev, "state left: !EXT && MP\n");
979 /* while MP is mapped, we get EXT_PLUGGED events */
985 /* If MP is unused, but the extension port is used, we expect:
986 * read_ext == state.exttype
987 * state.flags == !MP_ACTIVE && EXT_ACTIVE
988 * - If MP is plugged/unplugged, our timer detects it
989 * - If EXT is unplugged/replugged, EXT_ACTIVE will become unset */
990 if (!(flags & WIIPROTO_FLAG_MP_USED) &&
991 wdata->state.exttype != WIIMOTE_EXT_NONE) {
992 type = wiimote_cmd_read_ext(wdata, data);
993 ret = type == wdata->state.exttype;
995 spin_lock_irq(&wdata->state.lock);
996 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_MP_ACTIVE);
997 ret = ret && (wdata->state.flags & WIIPROTO_FLAG_EXT_ACTIVE);
998 spin_unlock_irq(&wdata->state.lock);
1001 hid_dbg(wdata->hdev, "state left: EXT && !MP\n");
1003 /* poll MP for hotplug events */
1009 /* If neither MP nor an extension are used, we expect:
1010 * read_ext() == WIIMOTE_EXT_NONE
1011 * state.flags == !MP_ACTIVE && !EXT_ACTIVE && !EXT_PLUGGED
1012 * No need to perform any action in this case as everything is
1014 * - If MP is plugged/unplugged, our timer detects it
1015 * - If EXT is plugged, EXT_PLUGGED will be set */
1016 if (!(flags & WIIPROTO_FLAG_MP_USED) &&
1017 wdata->state.exttype == WIIMOTE_EXT_NONE) {
1018 type = wiimote_cmd_read_ext(wdata, data);
1019 ret = type == wdata->state.exttype;
1021 spin_lock_irq(&wdata->state.lock);
1022 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_EXT_ACTIVE);
1023 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_MP_ACTIVE);
1024 ret = ret && !(wdata->state.flags & WIIPROTO_FLAG_EXT_PLUGGED);
1025 spin_unlock_irq(&wdata->state.lock);
1028 hid_dbg(wdata->hdev, "state left: !EXT && !MP\n");
1030 /* poll MP for hotplug events */
1036 /* The trickiest part is if both EXT and MP are active. We cannot read
1037 * the EXT ID, anymore, because MP is mapped over it. However, we use
1038 * a handy trick here:
1039 * - EXT_ACTIVE is unset whenever !MP_PLUGGED is sent
1040 * MP_PLUGGED might be re-sent again before we are scheduled, but
1041 * EXT_ACTIVE will stay unset.
1042 * So it is enough to check for mp_mapped() and MP_ACTIVE and
1043 * EXT_ACTIVE. EXT_PLUGGED is a sanity check. */
1044 if (wdata->state.exttype != WIIMOTE_EXT_NONE &&
1045 wdata->state.mp > 0 && (flags & WIIPROTO_FLAG_MP_USED)) {
1046 type = wiimote_cmd_read_mp_mapped(wdata);
1047 ret = type != WIIMOTE_MP_NONE;
1048 ret = ret && type != WIIMOTE_MP_UNKNOWN;
1049 ret = ret && type != WIIMOTE_MP_SINGLE;
1051 spin_lock_irq(&wdata->state.lock);
1052 ret = ret && (wdata->state.flags & WIIPROTO_FLAG_EXT_PLUGGED);
1053 ret = ret && (wdata->state.flags & WIIPROTO_FLAG_EXT_ACTIVE);
1054 ret = ret && (wdata->state.flags & WIIPROTO_FLAG_MP_ACTIVE);
1055 spin_unlock_irq(&wdata->state.lock);
1058 hid_dbg(wdata->hdev, "state left: EXT && MP\n");
1060 /* while MP is mapped, we get EXT_PLUGGED events */
1070 wiimote_cmd_release(wdata);
1072 /* only poll for MP if requested and if state didn't change */
1073 if (ret && poll_mp && !(flags & WIIPROTO_FLAG_BUILTIN_MP) &&
1074 !(flags & WIIPROTO_FLAG_NO_MP))
1075 wiimote_init_poll_mp(wdata);
1080 static const char *wiimote_exttype_names[WIIMOTE_EXT_NUM] = {
1081 [WIIMOTE_EXT_NONE] = "None",
1082 [WIIMOTE_EXT_UNKNOWN] = "Unknown",
1083 [WIIMOTE_EXT_NUNCHUK] = "Nintendo Wii Nunchuk",
1084 [WIIMOTE_EXT_CLASSIC_CONTROLLER] = "Nintendo Wii Classic Controller",
1085 [WIIMOTE_EXT_BALANCE_BOARD] = "Nintendo Wii Balance Board",
1086 [WIIMOTE_EXT_PRO_CONTROLLER] = "Nintendo Wii U Pro Controller",
1087 [WIIMOTE_EXT_DRUMS] = "Nintendo Wii Drums",
1088 [WIIMOTE_EXT_GUITAR] = "Nintendo Wii Guitar",
1089 [WIIMOTE_EXT_TURNTABLE] = "Nintendo Wii Turntable"
1093 * Handle hotplug events
1094 * If we receive an hotplug event and the device-check failed, we deinitialize
1095 * the extension ports, re-read all extension IDs and set the device into
1096 * the desired state. This involves mapping MP into the main extension
1097 * registers, setting up extension passthrough modes and initializing the
1098 * requested extensions.
1100 static void wiimote_init_hotplug(struct wiimote_data *wdata)
1102 __u8 exttype, extdata[6], mpdata[6];
1106 hid_dbg(wdata->hdev, "detect extensions..\n");
1108 wiimote_cmd_acquire_noint(wdata);
1110 spin_lock_irq(&wdata->state.lock);
1112 /* get state snapshot that we will then work on */
1113 flags = wdata->state.flags;
1115 /* disable event forwarding temporarily */
1116 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_ACTIVE;
1117 wdata->state.flags &= ~WIIPROTO_FLAG_MP_ACTIVE;
1119 spin_unlock_irq(&wdata->state.lock);
1121 /* init extension and MP (deactivates current extension or MP) */
1122 wiimote_cmd_init_ext(wdata);
1123 if (flags & WIIPROTO_FLAG_NO_MP) {
1126 wiimote_cmd_init_mp(wdata);
1127 mp = wiimote_cmd_read_mp(wdata, mpdata);
1129 exttype = wiimote_cmd_read_ext(wdata, extdata);
1131 wiimote_cmd_release(wdata);
1133 /* load/unload extension module if it changed */
1134 if (exttype != wdata->state.exttype) {
1135 /* unload previous extension */
1136 wiimote_ext_unload(wdata);
1138 if (exttype == WIIMOTE_EXT_UNKNOWN) {
1139 hid_info(wdata->hdev, "cannot detect extension; %6phC\n",
1141 } else if (exttype == WIIMOTE_EXT_NONE) {
1142 spin_lock_irq(&wdata->state.lock);
1143 wdata->state.exttype = WIIMOTE_EXT_NONE;
1144 spin_unlock_irq(&wdata->state.lock);
1146 hid_info(wdata->hdev, "detected extension: %s\n",
1147 wiimote_exttype_names[exttype]);
1148 /* try loading new extension */
1149 wiimote_ext_load(wdata, exttype);
1153 /* load/unload MP module if it changed */
1155 if (!wdata->state.mp) {
1156 hid_info(wdata->hdev, "detected extension: Nintendo Wii Motion Plus\n");
1157 wiimote_mp_load(wdata);
1159 } else if (wdata->state.mp) {
1160 wiimote_mp_unload(wdata);
1163 /* if MP is not used, do not map or activate it */
1164 if (!(flags & WIIPROTO_FLAG_MP_USED))
1167 /* map MP into main extension registers if used */
1169 wiimote_cmd_acquire_noint(wdata);
1170 wiimote_cmd_map_mp(wdata, exttype);
1171 wiimote_cmd_release(wdata);
1173 /* delete MP hotplug timer */
1174 del_timer_sync(&wdata->timer);
1176 /* reschedule MP hotplug timer */
1177 if (!(flags & WIIPROTO_FLAG_BUILTIN_MP) &&
1178 !(flags & WIIPROTO_FLAG_NO_MP))
1179 mod_timer(&wdata->timer, jiffies + HZ * 4);
1182 spin_lock_irq(&wdata->state.lock);
1184 /* enable data forwarding again and set expected hotplug state */
1186 wdata->state.flags |= WIIPROTO_FLAG_MP_ACTIVE;
1187 if (wdata->state.exttype == WIIMOTE_EXT_NONE) {
1188 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_PLUGGED;
1189 wdata->state.flags &= ~WIIPROTO_FLAG_MP_PLUGGED;
1191 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_PLUGGED;
1192 wdata->state.flags |= WIIPROTO_FLAG_MP_PLUGGED;
1193 wdata->state.flags |= WIIPROTO_FLAG_EXT_ACTIVE;
1195 } else if (wdata->state.exttype != WIIMOTE_EXT_NONE) {
1196 wdata->state.flags |= WIIPROTO_FLAG_EXT_ACTIVE;
1199 /* request status report for hotplug state updates */
1200 wiiproto_req_status(wdata);
1202 spin_unlock_irq(&wdata->state.lock);
1204 hid_dbg(wdata->hdev, "detected extensions: MP: %d EXT: %d\n",
1205 wdata->state.mp, wdata->state.exttype);
1208 static void wiimote_init_worker(struct work_struct *work)
1210 struct wiimote_data *wdata = container_of(work, struct wiimote_data,
1212 bool changed = false;
1214 if (wdata->state.devtype == WIIMOTE_DEV_PENDING) {
1215 wiimote_init_detect(wdata);
1219 if (changed || !wiimote_init_check(wdata))
1220 wiimote_init_hotplug(wdata);
1223 kobject_uevent(&wdata->hdev->dev.kobj, KOBJ_CHANGE);
1226 void __wiimote_schedule(struct wiimote_data *wdata)
1228 if (!(wdata->state.flags & WIIPROTO_FLAG_EXITING))
1229 schedule_work(&wdata->init_worker);
1232 static void wiimote_schedule(struct wiimote_data *wdata)
1234 unsigned long flags;
1236 spin_lock_irqsave(&wdata->state.lock, flags);
1237 __wiimote_schedule(wdata);
1238 spin_unlock_irqrestore(&wdata->state.lock, flags);
1241 static void wiimote_init_timeout(struct timer_list *t)
1243 struct wiimote_data *wdata = from_timer(wdata, t, timer);
1245 wiimote_schedule(wdata);
1248 /* protocol handlers */
1250 static void handler_keys(struct wiimote_data *wdata, const __u8 *payload)
1252 const __u8 *iter, *mods;
1253 const struct wiimod_ops *ops;
1255 ops = wiimod_ext_table[wdata->state.exttype];
1257 ops->in_keys(wdata, payload);
1261 mods = wiimote_devtype_mods[wdata->state.devtype];
1262 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
1263 ops = wiimod_table[*iter];
1265 ops->in_keys(wdata, payload);
1271 static void handler_accel(struct wiimote_data *wdata, const __u8 *payload)
1273 const __u8 *iter, *mods;
1274 const struct wiimod_ops *ops;
1276 ops = wiimod_ext_table[wdata->state.exttype];
1277 if (ops->in_accel) {
1278 ops->in_accel(wdata, payload);
1282 mods = wiimote_devtype_mods[wdata->state.devtype];
1283 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
1284 ops = wiimod_table[*iter];
1285 if (ops->in_accel) {
1286 ops->in_accel(wdata, payload);
1292 static bool valid_ext_handler(const struct wiimod_ops *ops, size_t len)
1296 if ((ops->flags & WIIMOD_FLAG_EXT8) && len < 8)
1298 if ((ops->flags & WIIMOD_FLAG_EXT16) && len < 16)
1304 static void handler_ext(struct wiimote_data *wdata, const __u8 *payload,
1307 static const __u8 invalid[21] = { 0xff, 0xff, 0xff, 0xff,
1308 0xff, 0xff, 0xff, 0xff,
1309 0xff, 0xff, 0xff, 0xff,
1310 0xff, 0xff, 0xff, 0xff,
1311 0xff, 0xff, 0xff, 0xff,
1313 const __u8 *iter, *mods;
1314 const struct wiimod_ops *ops;
1319 if (len < 6 || !memcmp(payload, invalid, len))
1322 /* if MP is active, track MP slot hotplugging */
1323 if (wdata->state.flags & WIIPROTO_FLAG_MP_ACTIVE) {
1324 /* this bit is set for invalid events (eg. during hotplug) */
1325 if (payload[5] & 0x01)
1328 if (payload[4] & 0x01) {
1329 if (!(wdata->state.flags & WIIPROTO_FLAG_MP_PLUGGED)) {
1330 hid_dbg(wdata->hdev, "MP hotplug: 1\n");
1331 wdata->state.flags |= WIIPROTO_FLAG_MP_PLUGGED;
1332 __wiimote_schedule(wdata);
1335 if (wdata->state.flags & WIIPROTO_FLAG_MP_PLUGGED) {
1336 hid_dbg(wdata->hdev, "MP hotplug: 0\n");
1337 wdata->state.flags &= ~WIIPROTO_FLAG_MP_PLUGGED;
1338 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_ACTIVE;
1339 __wiimote_schedule(wdata);
1343 /* detect MP data that is sent interleaved with EXT data */
1344 is_mp = payload[5] & 0x02;
1349 /* ignore EXT events if no extension is active */
1350 if (!(wdata->state.flags & WIIPROTO_FLAG_EXT_ACTIVE) && !is_mp)
1353 /* try forwarding to extension handler, first */
1354 ops = wiimod_ext_table[wdata->state.exttype];
1355 if (is_mp && ops->in_mp) {
1356 ops->in_mp(wdata, payload);
1358 } else if (!is_mp && valid_ext_handler(ops, len)) {
1359 ops->in_ext(wdata, payload);
1363 /* try forwarding to MP handler */
1365 if (is_mp && ops->in_mp) {
1366 ops->in_mp(wdata, payload);
1368 } else if (!is_mp && valid_ext_handler(ops, len)) {
1369 ops->in_ext(wdata, payload);
1373 /* try forwarding to loaded modules */
1374 mods = wiimote_devtype_mods[wdata->state.devtype];
1375 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
1376 ops = wiimod_table[*iter];
1377 if (is_mp && ops->in_mp) {
1378 ops->in_mp(wdata, payload);
1380 } else if (!is_mp && valid_ext_handler(ops, len)) {
1381 ops->in_ext(wdata, payload);
1387 #define ir_to_input0(wdata, ir, packed) handler_ir((wdata), (ir), (packed), 0)
1388 #define ir_to_input1(wdata, ir, packed) handler_ir((wdata), (ir), (packed), 1)
1389 #define ir_to_input2(wdata, ir, packed) handler_ir((wdata), (ir), (packed), 2)
1390 #define ir_to_input3(wdata, ir, packed) handler_ir((wdata), (ir), (packed), 3)
1392 static void handler_ir(struct wiimote_data *wdata, const __u8 *payload,
1393 bool packed, unsigned int id)
1395 const __u8 *iter, *mods;
1396 const struct wiimod_ops *ops;
1398 ops = wiimod_ext_table[wdata->state.exttype];
1400 ops->in_ir(wdata, payload, packed, id);
1404 mods = wiimote_devtype_mods[wdata->state.devtype];
1405 for (iter = mods; *iter != WIIMOD_NULL; ++iter) {
1406 ops = wiimod_table[*iter];
1408 ops->in_ir(wdata, payload, packed, id);
1414 /* reduced status report with "BB BB" key data only */
1415 static void handler_status_K(struct wiimote_data *wdata,
1416 const __u8 *payload)
1418 handler_keys(wdata, payload);
1420 /* on status reports the drm is reset so we need to resend the drm */
1421 wiiproto_req_drm(wdata, WIIPROTO_REQ_NULL);
1424 /* extended status report with "BB BB LF 00 00 VV" data */
1425 static void handler_status(struct wiimote_data *wdata, const __u8 *payload)
1427 handler_status_K(wdata, payload);
1429 /* update extension status */
1430 if (payload[2] & 0x02) {
1431 if (!(wdata->state.flags & WIIPROTO_FLAG_EXT_PLUGGED)) {
1432 hid_dbg(wdata->hdev, "EXT hotplug: 1\n");
1433 wdata->state.flags |= WIIPROTO_FLAG_EXT_PLUGGED;
1434 __wiimote_schedule(wdata);
1437 if (wdata->state.flags & WIIPROTO_FLAG_EXT_PLUGGED) {
1438 hid_dbg(wdata->hdev, "EXT hotplug: 0\n");
1439 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_PLUGGED;
1440 wdata->state.flags &= ~WIIPROTO_FLAG_MP_PLUGGED;
1441 wdata->state.flags &= ~WIIPROTO_FLAG_EXT_ACTIVE;
1442 wdata->state.flags &= ~WIIPROTO_FLAG_MP_ACTIVE;
1443 __wiimote_schedule(wdata);
1447 wdata->state.cmd_battery = payload[5];
1448 if (wiimote_cmd_pending(wdata, WIIPROTO_REQ_SREQ, 0))
1449 wiimote_cmd_complete(wdata);
1452 /* reduced generic report with "BB BB" key data only */
1453 static void handler_generic_K(struct wiimote_data *wdata, const __u8 *payload)
1455 handler_keys(wdata, payload);
1458 static void handler_data(struct wiimote_data *wdata, const __u8 *payload)
1460 __u16 offset = payload[3] << 8 | payload[4];
1461 __u8 size = (payload[2] >> 4) + 1;
1462 __u8 err = payload[2] & 0x0f;
1464 handler_keys(wdata, payload);
1466 if (wiimote_cmd_pending(wdata, WIIPROTO_REQ_RMEM, offset)) {
1469 else if (size > wdata->state.cmd_read_size)
1470 size = wdata->state.cmd_read_size;
1472 wdata->state.cmd_read_size = size;
1473 if (wdata->state.cmd_read_buf)
1474 memcpy(wdata->state.cmd_read_buf, &payload[5], size);
1475 wiimote_cmd_complete(wdata);
1479 static void handler_return(struct wiimote_data *wdata, const __u8 *payload)
1481 __u8 err = payload[3];
1482 __u8 cmd = payload[2];
1484 handler_keys(wdata, payload);
1486 if (wiimote_cmd_pending(wdata, cmd, 0)) {
1487 wdata->state.cmd_err = err;
1488 wiimote_cmd_complete(wdata);
1490 hid_warn(wdata->hdev, "Remote error %u on req %u\n", err,
1495 static void handler_drm_KA(struct wiimote_data *wdata, const __u8 *payload)
1497 handler_keys(wdata, payload);
1498 handler_accel(wdata, payload);
1501 static void handler_drm_KE(struct wiimote_data *wdata, const __u8 *payload)
1503 handler_keys(wdata, payload);
1504 handler_ext(wdata, &payload[2], 8);
1507 static void handler_drm_KAI(struct wiimote_data *wdata, const __u8 *payload)
1509 handler_keys(wdata, payload);
1510 handler_accel(wdata, payload);
1511 ir_to_input0(wdata, &payload[5], false);
1512 ir_to_input1(wdata, &payload[8], false);
1513 ir_to_input2(wdata, &payload[11], false);
1514 ir_to_input3(wdata, &payload[14], false);
1517 static void handler_drm_KEE(struct wiimote_data *wdata, const __u8 *payload)
1519 handler_keys(wdata, payload);
1520 handler_ext(wdata, &payload[2], 19);
1523 static void handler_drm_KIE(struct wiimote_data *wdata, const __u8 *payload)
1525 handler_keys(wdata, payload);
1526 ir_to_input0(wdata, &payload[2], false);
1527 ir_to_input1(wdata, &payload[4], true);
1528 ir_to_input2(wdata, &payload[7], false);
1529 ir_to_input3(wdata, &payload[9], true);
1530 handler_ext(wdata, &payload[12], 9);
1533 static void handler_drm_KAE(struct wiimote_data *wdata, const __u8 *payload)
1535 handler_keys(wdata, payload);
1536 handler_accel(wdata, payload);
1537 handler_ext(wdata, &payload[5], 16);
1540 static void handler_drm_KAIE(struct wiimote_data *wdata, const __u8 *payload)
1542 handler_keys(wdata, payload);
1543 handler_accel(wdata, payload);
1544 ir_to_input0(wdata, &payload[5], false);
1545 ir_to_input1(wdata, &payload[7], true);
1546 ir_to_input2(wdata, &payload[10], false);
1547 ir_to_input3(wdata, &payload[12], true);
1548 handler_ext(wdata, &payload[15], 6);
1551 static void handler_drm_E(struct wiimote_data *wdata, const __u8 *payload)
1553 handler_ext(wdata, payload, 21);
1556 static void handler_drm_SKAI1(struct wiimote_data *wdata, const __u8 *payload)
1558 handler_keys(wdata, payload);
1560 wdata->state.accel_split[0] = payload[2];
1561 wdata->state.accel_split[1] = (payload[0] >> 1) & (0x10 | 0x20);
1562 wdata->state.accel_split[1] |= (payload[1] << 1) & (0x40 | 0x80);
1564 ir_to_input0(wdata, &payload[3], false);
1565 ir_to_input1(wdata, &payload[12], false);
1568 static void handler_drm_SKAI2(struct wiimote_data *wdata, const __u8 *payload)
1572 handler_keys(wdata, payload);
1574 wdata->state.accel_split[1] |= (payload[0] >> 5) & (0x01 | 0x02);
1575 wdata->state.accel_split[1] |= (payload[1] >> 3) & (0x04 | 0x08);
1579 buf[2] = wdata->state.accel_split[0];
1580 buf[3] = payload[2];
1581 buf[4] = wdata->state.accel_split[1];
1582 handler_accel(wdata, buf);
1584 ir_to_input2(wdata, &payload[3], false);
1585 ir_to_input3(wdata, &payload[12], false);
1588 struct wiiproto_handler {
1591 void (*func)(struct wiimote_data *wdata, const __u8 *payload);
1594 static const struct wiiproto_handler handlers[] = {
1595 { .id = WIIPROTO_REQ_STATUS, .size = 6, .func = handler_status },
1596 { .id = WIIPROTO_REQ_STATUS, .size = 2, .func = handler_status_K },
1597 { .id = WIIPROTO_REQ_DATA, .size = 21, .func = handler_data },
1598 { .id = WIIPROTO_REQ_DATA, .size = 2, .func = handler_generic_K },
1599 { .id = WIIPROTO_REQ_RETURN, .size = 4, .func = handler_return },
1600 { .id = WIIPROTO_REQ_RETURN, .size = 2, .func = handler_generic_K },
1601 { .id = WIIPROTO_REQ_DRM_K, .size = 2, .func = handler_keys },
1602 { .id = WIIPROTO_REQ_DRM_KA, .size = 5, .func = handler_drm_KA },
1603 { .id = WIIPROTO_REQ_DRM_KA, .size = 2, .func = handler_generic_K },
1604 { .id = WIIPROTO_REQ_DRM_KE, .size = 10, .func = handler_drm_KE },
1605 { .id = WIIPROTO_REQ_DRM_KE, .size = 2, .func = handler_generic_K },
1606 { .id = WIIPROTO_REQ_DRM_KAI, .size = 17, .func = handler_drm_KAI },
1607 { .id = WIIPROTO_REQ_DRM_KAI, .size = 2, .func = handler_generic_K },
1608 { .id = WIIPROTO_REQ_DRM_KEE, .size = 21, .func = handler_drm_KEE },
1609 { .id = WIIPROTO_REQ_DRM_KEE, .size = 2, .func = handler_generic_K },
1610 { .id = WIIPROTO_REQ_DRM_KAE, .size = 21, .func = handler_drm_KAE },
1611 { .id = WIIPROTO_REQ_DRM_KAE, .size = 2, .func = handler_generic_K },
1612 { .id = WIIPROTO_REQ_DRM_KIE, .size = 21, .func = handler_drm_KIE },
1613 { .id = WIIPROTO_REQ_DRM_KIE, .size = 2, .func = handler_generic_K },
1614 { .id = WIIPROTO_REQ_DRM_KAIE, .size = 21, .func = handler_drm_KAIE },
1615 { .id = WIIPROTO_REQ_DRM_KAIE, .size = 2, .func = handler_generic_K },
1616 { .id = WIIPROTO_REQ_DRM_E, .size = 21, .func = handler_drm_E },
1617 { .id = WIIPROTO_REQ_DRM_SKAI1, .size = 21, .func = handler_drm_SKAI1 },
1618 { .id = WIIPROTO_REQ_DRM_SKAI2, .size = 21, .func = handler_drm_SKAI2 },
1622 static int wiimote_hid_event(struct hid_device *hdev, struct hid_report *report,
1623 u8 *raw_data, int size)
1625 struct wiimote_data *wdata = hid_get_drvdata(hdev);
1626 const struct wiiproto_handler *h;
1628 unsigned long flags;
1633 for (i = 0; handlers[i].id; ++i) {
1635 if (h->id == raw_data[0] && h->size < size) {
1636 spin_lock_irqsave(&wdata->state.lock, flags);
1637 h->func(wdata, &raw_data[1]);
1638 spin_unlock_irqrestore(&wdata->state.lock, flags);
1643 if (!handlers[i].id)
1644 hid_warn(hdev, "Unhandled report %hhu size %d\n", raw_data[0],
1650 static ssize_t wiimote_ext_show(struct device *dev,
1651 struct device_attribute *attr,
1654 struct wiimote_data *wdata = dev_to_wii(dev);
1656 unsigned long flags;
1658 spin_lock_irqsave(&wdata->state.lock, flags);
1659 type = wdata->state.exttype;
1660 spin_unlock_irqrestore(&wdata->state.lock, flags);
1663 case WIIMOTE_EXT_NONE:
1664 return sprintf(buf, "none\n");
1665 case WIIMOTE_EXT_NUNCHUK:
1666 return sprintf(buf, "nunchuk\n");
1667 case WIIMOTE_EXT_CLASSIC_CONTROLLER:
1668 return sprintf(buf, "classic\n");
1669 case WIIMOTE_EXT_BALANCE_BOARD:
1670 return sprintf(buf, "balanceboard\n");
1671 case WIIMOTE_EXT_PRO_CONTROLLER:
1672 return sprintf(buf, "procontroller\n");
1673 case WIIMOTE_EXT_DRUMS:
1674 return sprintf(buf, "drums\n");
1675 case WIIMOTE_EXT_GUITAR:
1676 return sprintf(buf, "guitar\n");
1677 case WIIMOTE_EXT_TURNTABLE:
1678 return sprintf(buf, "turntable\n");
1679 case WIIMOTE_EXT_UNKNOWN:
1681 return sprintf(buf, "unknown\n");
1685 static ssize_t wiimote_ext_store(struct device *dev,
1686 struct device_attribute *attr,
1687 const char *buf, size_t count)
1689 struct wiimote_data *wdata = dev_to_wii(dev);
1691 if (!strcmp(buf, "scan")) {
1692 wiimote_schedule(wdata);
1697 return strnlen(buf, PAGE_SIZE);
1700 static DEVICE_ATTR(extension, S_IRUGO | S_IWUSR | S_IWGRP, wiimote_ext_show,
1703 static ssize_t wiimote_dev_show(struct device *dev,
1704 struct device_attribute *attr,
1707 struct wiimote_data *wdata = dev_to_wii(dev);
1709 unsigned long flags;
1711 spin_lock_irqsave(&wdata->state.lock, flags);
1712 type = wdata->state.devtype;
1713 spin_unlock_irqrestore(&wdata->state.lock, flags);
1716 case WIIMOTE_DEV_GENERIC:
1717 return sprintf(buf, "generic\n");
1718 case WIIMOTE_DEV_GEN10:
1719 return sprintf(buf, "gen10\n");
1720 case WIIMOTE_DEV_GEN20:
1721 return sprintf(buf, "gen20\n");
1722 case WIIMOTE_DEV_BALANCE_BOARD:
1723 return sprintf(buf, "balanceboard\n");
1724 case WIIMOTE_DEV_PRO_CONTROLLER:
1725 return sprintf(buf, "procontroller\n");
1726 case WIIMOTE_DEV_PENDING:
1727 return sprintf(buf, "pending\n");
1728 case WIIMOTE_DEV_UNKNOWN:
1730 return sprintf(buf, "unknown\n");
1734 static DEVICE_ATTR(devtype, S_IRUGO, wiimote_dev_show, NULL);
1736 static struct wiimote_data *wiimote_create(struct hid_device *hdev)
1738 struct wiimote_data *wdata;
1740 wdata = kzalloc(sizeof(*wdata), GFP_KERNEL);
1745 hid_set_drvdata(hdev, wdata);
1747 spin_lock_init(&wdata->queue.lock);
1748 INIT_WORK(&wdata->queue.worker, wiimote_queue_worker);
1750 spin_lock_init(&wdata->state.lock);
1751 init_completion(&wdata->state.ready);
1752 mutex_init(&wdata->state.sync);
1753 wdata->state.drm = WIIPROTO_REQ_DRM_K;
1754 wdata->state.cmd_battery = 0xff;
1756 INIT_WORK(&wdata->init_worker, wiimote_init_worker);
1757 timer_setup(&wdata->timer, wiimote_init_timeout, 0);
1762 static void wiimote_destroy(struct wiimote_data *wdata)
1764 unsigned long flags;
1766 wiidebug_deinit(wdata);
1768 /* prevent init_worker from being scheduled again */
1769 spin_lock_irqsave(&wdata->state.lock, flags);
1770 wdata->state.flags |= WIIPROTO_FLAG_EXITING;
1771 spin_unlock_irqrestore(&wdata->state.lock, flags);
1773 cancel_work_sync(&wdata->init_worker);
1774 del_timer_sync(&wdata->timer);
1776 device_remove_file(&wdata->hdev->dev, &dev_attr_devtype);
1777 device_remove_file(&wdata->hdev->dev, &dev_attr_extension);
1779 wiimote_mp_unload(wdata);
1780 wiimote_ext_unload(wdata);
1781 wiimote_modules_unload(wdata);
1782 cancel_work_sync(&wdata->queue.worker);
1783 hid_hw_close(wdata->hdev);
1784 hid_hw_stop(wdata->hdev);
1789 static int wiimote_hid_probe(struct hid_device *hdev,
1790 const struct hid_device_id *id)
1792 struct wiimote_data *wdata;
1795 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
1797 wdata = wiimote_create(hdev);
1799 hid_err(hdev, "Can't alloc device\n");
1803 ret = hid_parse(hdev);
1805 hid_err(hdev, "HID parse failed\n");
1809 ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
1811 hid_err(hdev, "HW start failed\n");
1815 ret = hid_hw_open(hdev);
1817 hid_err(hdev, "cannot start hardware I/O\n");
1821 ret = device_create_file(&hdev->dev, &dev_attr_extension);
1823 hid_err(hdev, "cannot create sysfs attribute\n");
1827 ret = device_create_file(&hdev->dev, &dev_attr_devtype);
1829 hid_err(hdev, "cannot create sysfs attribute\n");
1833 ret = wiidebug_init(wdata);
1837 hid_info(hdev, "New device registered\n");
1839 /* schedule device detection */
1840 wiimote_schedule(wdata);
1845 wiimote_destroy(wdata);
1849 device_remove_file(&wdata->hdev->dev, &dev_attr_extension);
1855 input_free_device(wdata->ir);
1856 input_free_device(wdata->accel);
1861 static void wiimote_hid_remove(struct hid_device *hdev)
1863 struct wiimote_data *wdata = hid_get_drvdata(hdev);
1865 hid_info(hdev, "Device removed\n");
1866 wiimote_destroy(wdata);
1869 static const struct hid_device_id wiimote_hid_devices[] = {
1870 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
1871 USB_DEVICE_ID_NINTENDO_WIIMOTE) },
1872 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO,
1873 USB_DEVICE_ID_NINTENDO_WIIMOTE2) },
1877 bool wiimote_dpad_as_analog = false;
1878 module_param_named(dpad_as_analog, wiimote_dpad_as_analog, bool, 0644);
1879 MODULE_PARM_DESC(dpad_as_analog, "Use D-Pad as main analog input");
1881 MODULE_DEVICE_TABLE(hid, wiimote_hid_devices);
1883 static struct hid_driver wiimote_hid_driver = {
1885 .id_table = wiimote_hid_devices,
1886 .probe = wiimote_hid_probe,
1887 .remove = wiimote_hid_remove,
1888 .raw_event = wiimote_hid_event,
1890 module_hid_driver(wiimote_hid_driver);
1892 MODULE_LICENSE("GPL");
1893 MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
1894 MODULE_DESCRIPTION("Driver for Nintendo Wii / Wii U peripherals");