^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Roccat Savu driver for Linux
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (c) 2012 Stefan Achatz <erazor_de@users.sourceforge.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) /* Roccat Savu is a gamer mouse with macro keys that can be configured in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * 5 profiles.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/input.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <linux/hid.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #include <linux/hid-roccat.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #include "hid-ids.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #include "hid-roccat-common.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #include "hid-roccat-savu.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) static struct class *savu_class;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) ROCCAT_COMMON2_BIN_ATTRIBUTE_W(control, 0x4, 0x03);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(profile, 0x5, 0x03);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(general, 0x6, 0x10);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(buttons, 0x7, 0x2f);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(macro, 0x8, 0x0823);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(info, 0x9, 0x08);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(sensor, 0xc, 0x04);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) static struct bin_attribute *savu_bin_attrs[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) &bin_attr_control,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) &bin_attr_profile,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) &bin_attr_general,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) &bin_attr_buttons,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) &bin_attr_macro,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) &bin_attr_info,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) &bin_attr_sensor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) static const struct attribute_group savu_group = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) .bin_attrs = savu_bin_attrs,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) static const struct attribute_group *savu_groups[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) &savu_group,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) NULL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) static int savu_init_specials(struct hid_device *hdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) struct usb_device *usb_dev = interface_to_usbdev(intf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) struct roccat_common2_device *savu;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) int retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) if (intf->cur_altsetting->desc.bInterfaceProtocol
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) != USB_INTERFACE_PROTOCOL_MOUSE) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) hid_set_drvdata(hdev, NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) savu = kzalloc(sizeof(*savu), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) if (!savu) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) hid_err(hdev, "can't alloc device descriptor\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) hid_set_drvdata(hdev, savu);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) retval = roccat_common2_device_init_struct(usb_dev, savu);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) if (retval) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) hid_err(hdev, "couldn't init Savu device\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) goto exit_free;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) retval = roccat_connect(savu_class, hdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) sizeof(struct savu_roccat_report));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) if (retval < 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) hid_err(hdev, "couldn't init char dev\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) savu->chrdev_minor = retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) savu->roccat_claimed = 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) exit_free:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) kfree(savu);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) return retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) static void savu_remove_specials(struct hid_device *hdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) struct roccat_common2_device *savu;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) if (intf->cur_altsetting->desc.bInterfaceProtocol
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) != USB_INTERFACE_PROTOCOL_MOUSE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) return;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) savu = hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) if (savu->roccat_claimed)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) roccat_disconnect(savu->chrdev_minor);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) kfree(savu);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) static int savu_probe(struct hid_device *hdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) const struct hid_device_id *id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) int retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) if (!hid_is_usb(hdev))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) retval = hid_parse(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) if (retval) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) hid_err(hdev, "parse failed\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) goto exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) if (retval) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) hid_err(hdev, "hw start failed\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) goto exit;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) retval = savu_init_specials(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) if (retval) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) hid_err(hdev, "couldn't install mouse\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) goto exit_stop;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) exit_stop:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) hid_hw_stop(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) exit:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) return retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) static void savu_remove(struct hid_device *hdev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) savu_remove_specials(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) hid_hw_stop(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) static void savu_report_to_chrdev(struct roccat_common2_device const *savu,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) u8 const *data)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) struct savu_roccat_report roccat_report;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) struct savu_mouse_report_special const *special_report;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) if (data[0] != SAVU_MOUSE_REPORT_NUMBER_SPECIAL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) return;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) special_report = (struct savu_mouse_report_special const *)data;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) roccat_report.type = special_report->type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) roccat_report.data[0] = special_report->data[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) roccat_report.data[1] = special_report->data[1];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) roccat_report_event(savu->chrdev_minor,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) (uint8_t const *)&roccat_report);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) static int savu_raw_event(struct hid_device *hdev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) struct hid_report *report, u8 *data, int size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) struct roccat_common2_device *savu = hid_get_drvdata(hdev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) if (intf->cur_altsetting->desc.bInterfaceProtocol
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) != USB_INTERFACE_PROTOCOL_MOUSE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) if (savu == NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) if (savu->roccat_claimed)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) savu_report_to_chrdev(savu, data);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) static const struct hid_device_id savu_devices[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_SAVU) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) { }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) MODULE_DEVICE_TABLE(hid, savu_devices);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) static struct hid_driver savu_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) .name = "savu",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) .id_table = savu_devices,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) .probe = savu_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) .remove = savu_remove,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) .raw_event = savu_raw_event
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) static int __init savu_init(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) int retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) savu_class = class_create(THIS_MODULE, "savu");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) if (IS_ERR(savu_class))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) return PTR_ERR(savu_class);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) savu_class->dev_groups = savu_groups;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) retval = hid_register_driver(&savu_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) if (retval)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) class_destroy(savu_class);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) return retval;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) static void __exit savu_exit(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) hid_unregister_driver(&savu_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) class_destroy(savu_class);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) module_init(savu_init);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) module_exit(savu_exit);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) MODULE_AUTHOR("Stefan Achatz");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) MODULE_DESCRIPTION("USB Roccat Savu driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) MODULE_LICENSE("GPL v2");