/* * HID driver for Nintendo Wiimote devices * Copyright (c) 2011 David Herrmann */ /* * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free * Software Foundation; either version 2 of the License, or (at your option) * any later version. */ #include #include #include #include #include #include #include "hid-ids.h" #define WIIMOTE_VERSION "0.1" #define WIIMOTE_NAME "Nintendo Wii Remote" #define WIIMOTE_BUFSIZE 32 struct wiimote_buf { __u8 data[HID_MAX_BUFFER_SIZE]; size_t size; }; struct wiimote_state { spinlock_t lock; __u8 flags; __u8 accel_split[2]; }; struct wiimote_data { struct hid_device *hdev; struct input_dev *input; struct led_classdev *leds[4]; struct input_dev *accel; spinlock_t qlock; __u8 head; __u8 tail; struct wiimote_buf outq[WIIMOTE_BUFSIZE]; struct work_struct worker; struct wiimote_state state; }; #define WIIPROTO_FLAG_LED1 0x01 #define WIIPROTO_FLAG_LED2 0x02 #define WIIPROTO_FLAG_LED3 0x04 #define WIIPROTO_FLAG_LED4 0x08 #define WIIPROTO_FLAG_RUMBLE 0x10 #define WIIPROTO_FLAG_ACCEL 0x20 #define WIIPROTO_FLAGS_LEDS (WIIPROTO_FLAG_LED1 | WIIPROTO_FLAG_LED2 | \ WIIPROTO_FLAG_LED3 | WIIPROTO_FLAG_LED4) /* return flag for led \num */ #define WIIPROTO_FLAG_LED(num) (WIIPROTO_FLAG_LED1 << (num - 1)) enum wiiproto_reqs { WIIPROTO_REQ_NULL = 0x0, WIIPROTO_REQ_RUMBLE = 0x10, WIIPROTO_REQ_LED = 0x11, WIIPROTO_REQ_DRM = 0x12, WIIPROTO_REQ_STATUS = 0x20, WIIPROTO_REQ_RETURN = 0x22, WIIPROTO_REQ_DRM_K = 0x30, WIIPROTO_REQ_DRM_KA = 0x31, WIIPROTO_REQ_DRM_KAI = 0x33, WIIPROTO_REQ_DRM_KAE = 0x35, WIIPROTO_REQ_DRM_KAIE = 0x37, WIIPROTO_REQ_DRM_SKAI1 = 0x3e, WIIPROTO_REQ_DRM_SKAI2 = 0x3f, }; enum wiiproto_keys { WIIPROTO_KEY_LEFT, WIIPROTO_KEY_RIGHT, WIIPROTO_KEY_UP, WIIPROTO_KEY_DOWN, WIIPROTO_KEY_PLUS, WIIPROTO_KEY_MINUS, WIIPROTO_KEY_ONE, WIIPROTO_KEY_TWO, WIIPROTO_KEY_A, WIIPROTO_KEY_B, WIIPROTO_KEY_HOME, WIIPROTO_KEY_COUNT }; static __u16 wiiproto_keymap[] = { KEY_LEFT, /* WIIPROTO_KEY_LEFT */ KEY_RIGHT, /* WIIPROTO_KEY_RIGHT */ KEY_UP, /* WIIPROTO_KEY_UP */ KEY_DOWN, /* WIIPROTO_KEY_DOWN */ KEY_NEXT, /* WIIPROTO_KEY_PLUS */ KEY_PREVIOUS, /* WIIPROTO_KEY_MINUS */ BTN_1, /* WIIPROTO_KEY_ONE */ BTN_2, /* WIIPROTO_KEY_TWO */ BTN_A, /* WIIPROTO_KEY_A */ BTN_B, /* WIIPROTO_KEY_B */ BTN_MODE, /* WIIPROTO_KEY_HOME */ }; static ssize_t wiimote_hid_send(struct hid_device *hdev, __u8 *buffer, size_t count) { __u8 *buf; ssize_t ret; if (!hdev->hid_output_raw_report) return -ENODEV; buf = kmemdup(buffer, count, GFP_KERNEL); if (!buf) return -ENOMEM; ret = hdev->hid_output_raw_report(hdev, buf, count, HID_OUTPUT_REPORT); kfree(buf); return ret; } static void wiimote_worker(struct work_struct *work) { struct wiimote_data *wdata = container_of(work, struct wiimote_data, worker); unsigned long flags; spin_lock_irqsave(&wdata->qlock, flags); while (wdata->head != wdata->tail) { spin_unlock_irqrestore(&wdata->qlock, flags); wiimote_hid_send(wdata->hdev, wdata->outq[wdata->tail].data, wdata->outq[wdata->tail].size); spin_lock_irqsave(&wdata->qlock, flags); wdata->tail = (wdata->tail + 1) % WIIMOTE_BUFSIZE; } spin_unlock_irqrestore(&wdata->qlock, flags); } static void wiimote_queue(struct wiimote_data *wdata, const __u8 *buffer, size_t count) { unsigned long flags; __u8 newhead; if (count > HID_MAX_BUFFER_SIZE) { hid_warn(wdata->hdev, "Sending too large output report\n"); return; } /* * Copy new request into our output queue and check whether the * queue is full. If it is full, discard this request. * If it is empty we need to start a new worker that will * send out the buffer to the hid device. * If the queue is not empty, then there must be a worker * that is currently sending out our buffer and this worker * will reschedule itself until the queue is empty. */ spin_lock_irqsave(&wdata->qlock, flags); memcpy(wdata->outq[wdata->head].data, buffer, count); wdata->outq[wdata->head].size = count; newhead = (wdata->head + 1) % WIIMOTE_BUFSIZE; if (wdata->head == wdata->tail) { wdata->head = newhead; schedule_work(&wdata->worker); } else if (newhead != wdata->tail) { wdata->head = newhead; } else { hid_warn(wdata->hdev, "Output queue is full"); } spin_unlock_irqrestore(&wdata->qlock, flags); } /* * This sets the rumble bit on the given output report if rumble is * currently enabled. * \cmd1 must point to the second byte in the output report => &cmd[1] * This must be called on nearly every output report before passing it * into the output queue! */ static inline void wiiproto_keep_rumble(struct wiimote_data *wdata, __u8 *cmd1) { if (wdata->state.flags & WIIPROTO_FLAG_RUMBLE) *cmd1 |= 0x01; } static void wiiproto_req_rumble(struct wiimote_data *wdata, __u8 rumble) { __u8 cmd[2]; rumble = !!rumble; if (rumble == !!(wdata->state.flags & WIIPROTO_FLAG_RUMBLE)) return; if (rumble) wdata->state.flags |= WIIPROTO_FLAG_RUMBLE; else wdata->state.flags &= ~WIIPROTO_FLAG_RUMBLE; cmd[0] = WIIPROTO_REQ_RUMBLE; cmd[1] = 0; wiiproto_keep_rumble(wdata, &cmd[1]); wiimote_queue(wdata, cmd, sizeof(cmd)); } static void wiiproto_req_leds(struct wiimote_data *wdata, int leds) { __u8 cmd[2]; leds &= WIIPROTO_FLAGS_LEDS; if ((wdata->state.flags & WIIPROTO_FLAGS_LEDS) == leds) return; wdata->state.flags = (wdata->state.flags & ~WIIPROTO_FLAGS_LEDS) | leds; cmd[0] = WIIPROTO_REQ_LED; cmd[1] = 0; if (leds & WIIPROTO_FLAG_LED1) cmd[1] |= 0x10; if (leds & WIIPROTO_FLAG_LED2) cmd[1] |= 0x20; if (leds & WIIPROTO_FLAG_LED3) cmd[1] |= 0x40; if (leds & WIIPROTO_FLAG_LED4) cmd[1] |= 0x80; wiiproto_keep_rumble(wdata, &cmd[1]); wiimote_queue(wdata, cmd, sizeof(cmd)); } /* * Check what peripherals of the wiimote are currently * active and select a proper DRM that supports all of * the requested data inputs. */ static __u8 select_drm(struct wiimote_data *wdata) { if (wdata->state.flags & WIIPROTO_FLAG_ACCEL) return WIIPROTO_REQ_DRM_KA; else return WIIPROTO_REQ_DRM_K; } static void wiiproto_req_drm(struct wiimote_data *wdata, __u8 drm) { __u8 cmd[3]; if (drm == WIIPROTO_REQ_NULL) drm = select_drm(wdata); cmd[0] = WIIPROTO_REQ_DRM; cmd[1] = 0; cmd[2] = drm; wiiproto_keep_rumble(wdata, &cmd[1]); wiimote_queue(wdata, cmd, sizeof(cmd)); } static void wiiproto_req_accel(struct wiimote_data *wdata, __u8 accel) { accel = !!accel; if (accel == !!(wdata->state.flags & WIIPROTO_FLAG_ACCEL)) return; if (accel) wdata->state.flags |= WIIPROTO_FLAG_ACCEL; else wdata->state.flags &= ~WIIPROTO_FLAG_ACCEL; wiiproto_req_drm(wdata, WIIPROTO_REQ_NULL); } static enum led_brightness wiimote_leds_get(struct led_classdev *led_dev) { struct wiimote_data *wdata; struct device *dev = led_dev->dev->parent; int i; unsigned long flags; bool value = false; wdata = hid_get_drvdata(container_of(dev, struct hid_device, dev)); for (i = 0; i < 4; ++i) { if (wdata->leds[i] == led_dev) { spin_lock_irqsave(&wdata->state.lock, flags); value = wdata->state.flags & WIIPROTO_FLAG_LED(i + 1); spin_unlock_irqrestore(&wdata->state.lock, flags); break; } } return value ? LED_FULL : LED_OFF; } static void wiimote_leds_set(struct led_classdev *led_dev, enum led_brightness value) { struct wiimote_data *wdata; struct device *dev = led_dev->dev->parent; int i; unsigned long flags; __u8 state, flag; wdata = hid_get_drvdata(container_of(dev, struct hid_device, dev)); for (i = 0; i < 4; ++i) { if (wdata->leds[i] == led_dev) { flag = WIIPROTO_FLAG_LED(i + 1); spin_lock_irqsave(&wdata->state.lock, flags); state = wdata->state.flags; if (value == LED_OFF) wiiproto_req_leds(wdata, state & ~flag); else wiiproto_req_leds(wdata, state | flag); spin_unlock_irqrestore(&wdata->state.lock, flags); break; } } } static int wiimote_ff_play(struct input_dev *dev, void *data, struct ff_effect *eff) { struct wiimote_data *wdata = input_get_drvdata(dev); __u8 value; unsigned long flags; /* * The wiimote supports only a single rumble motor so if any magnitude * is set to non-zero then we start the rumble motor. If both are set to * zero, we stop the rumble motor. */ if (eff->u.rumble.strong_magnitude || eff->u.rumble.weak_magnitude) value = 1; else value = 0; spin_lock_irqsave(&wdata->state.lock, flags); wiiproto_req_rumble(wdata, value); spin_unlock_irqrestore(&wdata->state.lock, flags); return 0; } static int wiimote_input_open(struct input_dev *dev) { struct wiimote_data *wdata = input_get_drvdata(dev); return hid_hw_open(wdata->hdev); } static void wiimote_input_close(struct input_dev *dev) { struct wiimote_data *wdata = input_get_drvdata(dev); hid_hw_close(wdata->hdev); } static int wiimote_accel_open(struct input_dev *dev) { struct wiimote_data *wdata = input_get_drvdata(dev); int ret; unsigned long flags; ret = hid_hw_open(wdata->hdev); if (ret) return ret; spin_lock_irqsave(&wdata->state.lock, flags); wiiproto_req_accel(wdata, true); spin_unlock_irqrestore(&wdata->state.lock, flags); return 0; } static void wiimote_accel_close(struct input_dev *dev) { struct wiimote_data *wdata = input_get_drvdata(dev); unsigned long flags; spin_lock_irqsave(&wdata->state.lock, flags); wiiproto_req_accel(wdata, false); spin_unlock_irqrestore(&wdata->state.lock, flags); hid_hw_close(wdata->hdev); } static void handler_keys(struct wiimote_data *wdata, const __u8 *payload) { input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_LEFT], !!(payload[0] & 0x01)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_RIGHT], !!(payload[0] & 0x02)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_DOWN], !!(payload[0] & 0x04)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_UP], !!(payload[0] & 0x08)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_PLUS], !!(payload[0] & 0x10)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_TWO], !!(payload[1] & 0x01)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_ONE], !!(payload[1] & 0x02)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_B], !!(payload[1] & 0x04)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_A], !!(payload[1] & 0x08)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_MINUS], !!(payload[1] & 0x10)); input_report_key(wdata->input, wiiproto_keymap[WIIPROTO_KEY_HOME], !!(payload[1] & 0x80)); input_sync(wdata->input); } static void handler_accel(struct wiimote_data *wdata, const __u8 *payload) { __u16 x, y, z; if (!(wdata->state.flags & WIIPROTO_FLAG_ACCEL)) return; /* * payload is: BB BB XX YY ZZ * Accelerometer data is encoded into 3 10bit values. XX, YY and ZZ * contain the upper 8 bits of each value. The lower 2 bits are * contained in the buttons data BB BB. * Bits 6 and 7 of the first buttons byte BB is the lower 2 bits of the * X accel value. Bit 5 of the second buttons byte is the 2nd bit of Y * accel value and bit 6 is the second bit of the Z value. * The first bit of Y and Z values is not available and always set to 0. * 0x200 is returned on no movement. */ x = payload[2] << 2; y = payload[3] << 2; z = payload[4] << 2; x |= (payload[0] >> 5) & 0x3; y |= (payload[1] >> 4) & 0x2; z |= (payload[1] >> 5) & 0x2; input_report_abs(wdata->accel, ABS_RX, x - 0x200); input_report_abs(wdata->accel, ABS_RY, y - 0x200); input_report_abs(wdata->accel, ABS_RZ, z - 0x200); input_sync(wdata->accel); } static void handler_status(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); /* on status reports the drm is reset so we need to resend the drm */ wiiproto_req_drm(wdata, WIIPROTO_REQ_NULL); } static void handler_return(struct wiimote_data *wdata, const __u8 *payload) { __u8 err = payload[3]; __u8 cmd = payload[2]; handler_keys(wdata, payload); if (err) hid_warn(wdata->hdev, "Remote error %hhu on req %hhu\n", err, cmd); } static void handler_drm_KA(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); handler_accel(wdata, payload); } static void handler_drm_KAI(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); handler_accel(wdata, payload); } static void handler_drm_KAE(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); handler_accel(wdata, payload); } static void handler_drm_KAIE(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); handler_accel(wdata, payload); } static void handler_drm_SKAI1(struct wiimote_data *wdata, const __u8 *payload) { handler_keys(wdata, payload); wdata->state.accel_split[0] = payload[2]; wdata->state.accel_split[1] = (payload[0] >> 1) & (0x10 | 0x20); wdata->state.accel_split[1] |= (payload[1] << 1) & (0x40 | 0x80); } static void handler_drm_SKAI2(struct wiimote_data *wdata, const __u8 *payload) { __u8 buf[5]; handler_keys(wdata, payload); wdata->state.accel_split[1] |= (payload[0] >> 5) & (0x01 | 0x02); wdata->state.accel_split[1] |= (payload[1] >> 3) & (0x04 | 0x08); buf[0] = 0; buf[1] = 0; buf[2] = wdata->state.accel_split[0]; buf[3] = payload[2]; buf[4] = wdata->state.accel_split[1]; handler_accel(wdata, buf); } struct wiiproto_handler { __u8 id; size_t size; void (*func)(struct wiimote_data *wdata, const __u8 *payload); }; static struct wiiproto_handler handlers[] = { { .id = WIIPROTO_REQ_STATUS, .size = 6, .func = handler_status }, { .id = WIIPROTO_REQ_RETURN, .size = 4, .func = handler_return }, { .id = WIIPROTO_REQ_DRM_K, .size = 2, .func = handler_keys }, { .id = WIIPROTO_REQ_DRM_KA, .size = 5, .func = handler_drm_KA }, { .id = WIIPROTO_REQ_DRM_KAI, .size = 17, .func = handler_drm_KAI }, { .id = WIIPROTO_REQ_DRM_KAE, .size = 21, .func = handler_drm_KAE }, { .id = WIIPROTO_REQ_DRM_KAIE, .size = 21, .func = handler_drm_KAIE }, { .id = WIIPROTO_REQ_DRM_SKAI1, .size = 21, .func = handler_drm_SKAI1 }, { .id = WIIPROTO_REQ_DRM_SKAI2, .size = 21, .func = handler_drm_SKAI2 }, { .id = 0 } }; static int wiimote_hid_event(struct hid_device *hdev, struct hid_report *report, u8 *raw_data, int size) { struct wiimote_data *wdata = hid_get_drvdata(hdev); struct wiiproto_handler *h; int i; unsigned long flags; if (size < 1) return -EINVAL; spin_lock_irqsave(&wdata->state.lock, flags); for (i = 0; handlers[i].id; ++i) { h = &handlers[i]; if (h->id == raw_data[0] && h->size < size) h->func(wdata, &raw_data[1]); } spin_unlock_irqrestore(&wdata->state.lock, flags); return 0; } static void wiimote_leds_destroy(struct wiimote_data *wdata) { int i; struct led_classdev *led; for (i = 0; i < 4; ++i) { if (wdata->leds[i]) { led = wdata->leds[i]; wdata->leds[i] = NULL; led_classdev_unregister(led); kfree(led); } } } static int wiimote_leds_create(struct wiimote_data *wdata) { int i, ret; struct device *dev = &wdata->hdev->dev; size_t namesz = strlen(dev_name(dev)) + 9; struct led_classdev *led; char *name; for (i = 0; i < 4; ++i) { led = kzalloc(sizeof(struct led_classdev) + namesz, GFP_KERNEL); if (!led) { ret = -ENOMEM; goto err; } name = (void*)&led[1]; snprintf(name, namesz, "%s:blue:p%d", dev_name(dev), i); led->name = name; led->brightness = 0; led->max_brightness = 1; led->brightness_get = wiimote_leds_get; led->brightness_set = wiimote_leds_set; ret = led_classdev_register(dev, led); if (ret) { kfree(led); goto err; } wdata->leds[i] = led; } return 0; err: wiimote_leds_destroy(wdata); return ret; } static struct wiimote_data *wiimote_create(struct hid_device *hdev) { struct wiimote_data *wdata; int i; wdata = kzalloc(sizeof(*wdata), GFP_KERNEL); if (!wdata) return NULL; wdata->input = input_allocate_device(); if (!wdata->input) goto err; wdata->hdev = hdev; hid_set_drvdata(hdev, wdata); input_set_drvdata(wdata->input, wdata); wdata->input->open = wiimote_input_open; wdata->input->close = wiimote_input_close; wdata->input->dev.parent = &wdata->hdev->dev; wdata->input->id.bustype = wdata->hdev->bus; wdata->input->id.vendor = wdata->hdev->vendor; wdata->input->id.product = wdata->hdev->product; wdata->input->id.version = wdata->hdev->version; wdata->input->name = WIIMOTE_NAME; set_bit(EV_KEY, wdata->input->evbit); for (i = 0; i < WIIPROTO_KEY_COUNT; ++i) set_bit(wiiproto_keymap[i], wdata->input->keybit); set_bit(FF_RUMBLE, wdata->input->ffbit); if (input_ff_create_memless(wdata->input, NULL, wiimote_ff_play)) goto err_input; wdata->accel = input_allocate_device(); if (!wdata->accel) goto err_input; input_set_drvdata(wdata->accel, wdata); wdata->accel->open = wiimote_accel_open; wdata->accel->close = wiimote_accel_close; wdata->accel->dev.parent = &wdata->hdev->dev; wdata->accel->id.bustype = wdata->hdev->bus; wdata->accel->id.vendor = wdata->hdev->vendor; wdata->accel->id.product = wdata->hdev->product; wdata->accel->id.version = wdata->hdev->version; wdata->accel->name = WIIMOTE_NAME " Accelerometer"; set_bit(EV_ABS, wdata->accel->evbit); set_bit(ABS_RX, wdata->accel->absbit); set_bit(ABS_RY, wdata->accel->absbit); set_bit(ABS_RZ, wdata->accel->absbit); input_set_abs_params(wdata->accel, ABS_RX, -500, 500, 2, 4); input_set_abs_params(wdata->accel, ABS_RY, -500, 500, 2, 4); input_set_abs_params(wdata->accel, ABS_RZ, -500, 500, 2, 4); spin_lock_init(&wdata->qlock); INIT_WORK(&wdata->worker, wiimote_worker); spin_lock_init(&wdata->state.lock); return wdata; err_input: input_free_device(wdata->input); err: kfree(wdata); return NULL; } static void wiimote_destroy(struct wiimote_data *wdata) { wiimote_leds_destroy(wdata); input_unregister_device(wdata->accel); input_unregister_device(wdata->input); cancel_work_sync(&wdata->worker); hid_hw_stop(wdata->hdev); kfree(wdata); } static int wiimote_hid_probe(struct hid_device *hdev, const struct hid_device_id *id) { struct wiimote_data *wdata; int ret; wdata = wiimote_create(hdev); if (!wdata) { hid_err(hdev, "Can't alloc device\n"); return -ENOMEM; } ret = hid_parse(hdev); if (ret) { hid_err(hdev, "HID parse failed\n"); goto err; } ret = hid_hw_start(hdev, HID_CONNECT_HIDRAW); if (ret) { hid_err(hdev, "HW start failed\n"); goto err; } ret = input_register_device(wdata->accel); if (ret) { hid_err(hdev, "Cannot register input device\n"); goto err_stop; } ret = input_register_device(wdata->input); if (ret) { hid_err(hdev, "Cannot register input device\n"); goto err_input; } ret = wiimote_leds_create(wdata); if (ret) goto err_free; hid_info(hdev, "New device registered\n"); /* by default set led1 after device initialization */ spin_lock_irq(&wdata->state.lock); wiiproto_req_leds(wdata, WIIPROTO_FLAG_LED1); spin_unlock_irq(&wdata->state.lock); return 0; err_free: wiimote_destroy(wdata); return ret; err_input: input_unregister_device(wdata->accel); wdata->accel = NULL; err_stop: hid_hw_stop(hdev); err: input_free_device(wdata->accel); input_free_device(wdata->input); kfree(wdata); return ret; } static void wiimote_hid_remove(struct hid_device *hdev) { struct wiimote_data *wdata = hid_get_drvdata(hdev); hid_info(hdev, "Device removed\n"); wiimote_destroy(wdata); } static const struct hid_device_id wiimote_hid_devices[] = { { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_NINTENDO, USB_DEVICE_ID_NINTENDO_WIIMOTE) }, { } }; MODULE_DEVICE_TABLE(hid, wiimote_hid_devices); static struct hid_driver wiimote_hid_driver = { .name = "wiimote", .id_table = wiimote_hid_devices, .probe = wiimote_hid_probe, .remove = wiimote_hid_remove, .raw_event = wiimote_hid_event, }; static int __init wiimote_init(void) { int ret; ret = hid_register_driver(&wiimote_hid_driver); if (ret) pr_err("Can't register wiimote hid driver\n"); return ret; } static void __exit wiimote_exit(void) { hid_unregister_driver(&wiimote_hid_driver); } module_init(wiimote_init); module_exit(wiimote_exit); MODULE_LICENSE("GPL"); MODULE_AUTHOR("David Herrmann "); MODULE_DESCRIPTION(WIIMOTE_NAME " Device Driver"); MODULE_VERSION(WIIMOTE_VERSION);