1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Roccat Isku driver for Linux
5 * Copyright (c) 2011 Stefan Achatz <erazor_de@users.sourceforge.net>
12 * Roccat Isku is a gamer keyboard with macro keys that can be configured in
16 #include <linux/device.h>
17 #include <linux/input.h>
18 #include <linux/hid.h>
19 #include <linux/module.h>
20 #include <linux/slab.h>
21 #include <linux/hid-roccat.h>
23 #include "hid-roccat-common.h"
24 #include "hid-roccat-isku.h"
26 static struct class *isku_class;
28 static void isku_profile_activated(struct isku_device *isku, uint new_profile)
30 isku->actual_profile = new_profile;
33 static int isku_receive(struct usb_device *usb_dev, uint command,
36 return roccat_common2_receive(usb_dev, command, buf, size);
39 static int isku_get_actual_profile(struct usb_device *usb_dev)
41 struct isku_actual_profile buf;
44 retval = isku_receive(usb_dev, ISKU_COMMAND_ACTUAL_PROFILE,
45 &buf, sizeof(struct isku_actual_profile));
46 return retval ? retval : buf.actual_profile;
49 static int isku_set_actual_profile(struct usb_device *usb_dev, int new_profile)
51 struct isku_actual_profile buf;
53 buf.command = ISKU_COMMAND_ACTUAL_PROFILE;
54 buf.size = sizeof(struct isku_actual_profile);
55 buf.actual_profile = new_profile;
56 return roccat_common2_send_with_status(usb_dev,
57 ISKU_COMMAND_ACTUAL_PROFILE, &buf,
58 sizeof(struct isku_actual_profile));
61 static ssize_t isku_sysfs_show_actual_profile(struct device *dev,
62 struct device_attribute *attr, char *buf)
64 struct isku_device *isku =
65 hid_get_drvdata(dev_get_drvdata(dev->parent->parent));
66 return snprintf(buf, PAGE_SIZE, "%d\n", isku->actual_profile);
69 static ssize_t isku_sysfs_set_actual_profile(struct device *dev,
70 struct device_attribute *attr, char const *buf, size_t size)
72 struct isku_device *isku;
73 struct usb_device *usb_dev;
74 unsigned long profile;
76 struct isku_roccat_report roccat_report;
78 dev = dev->parent->parent;
79 isku = hid_get_drvdata(dev_get_drvdata(dev));
80 usb_dev = interface_to_usbdev(to_usb_interface(dev));
82 retval = kstrtoul(buf, 10, &profile);
89 mutex_lock(&isku->isku_lock);
91 retval = isku_set_actual_profile(usb_dev, profile);
93 mutex_unlock(&isku->isku_lock);
97 isku_profile_activated(isku, profile);
99 roccat_report.event = ISKU_REPORT_BUTTON_EVENT_PROFILE;
100 roccat_report.data1 = profile + 1;
101 roccat_report.data2 = 0;
102 roccat_report.profile = profile + 1;
103 roccat_report_event(isku->chrdev_minor, (uint8_t const *)&roccat_report);
105 mutex_unlock(&isku->isku_lock);
109 static DEVICE_ATTR(actual_profile, 0660, isku_sysfs_show_actual_profile,
110 isku_sysfs_set_actual_profile);
112 static struct attribute *isku_attrs[] = {
113 &dev_attr_actual_profile.attr,
117 static ssize_t isku_sysfs_read(struct file *fp, struct kobject *kobj,
118 char *buf, loff_t off, size_t count,
119 size_t real_size, uint command)
121 struct device *dev = kobj_to_dev(kobj)->parent->parent;
122 struct isku_device *isku = hid_get_drvdata(dev_get_drvdata(dev));
123 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
126 if (off >= real_size)
129 if (off != 0 || count > real_size)
132 mutex_lock(&isku->isku_lock);
133 retval = isku_receive(usb_dev, command, buf, count);
134 mutex_unlock(&isku->isku_lock);
136 return retval ? retval : count;
139 static ssize_t isku_sysfs_write(struct file *fp, struct kobject *kobj,
140 void const *buf, loff_t off, size_t count,
141 size_t real_size, uint command)
143 struct device *dev = kobj_to_dev(kobj)->parent->parent;
144 struct isku_device *isku = hid_get_drvdata(dev_get_drvdata(dev));
145 struct usb_device *usb_dev = interface_to_usbdev(to_usb_interface(dev));
148 if (off != 0 || count > real_size)
151 mutex_lock(&isku->isku_lock);
152 retval = roccat_common2_send_with_status(usb_dev, command,
154 mutex_unlock(&isku->isku_lock);
156 return retval ? retval : count;
159 #define ISKU_SYSFS_W(thingy, THINGY) \
160 static ssize_t isku_sysfs_write_ ## thingy(struct file *fp, struct kobject *kobj, \
161 struct bin_attribute *attr, char *buf, \
162 loff_t off, size_t count) \
164 return isku_sysfs_write(fp, kobj, buf, off, count, \
165 ISKU_SIZE_ ## THINGY, ISKU_COMMAND_ ## THINGY); \
168 #define ISKU_SYSFS_R(thingy, THINGY) \
169 static ssize_t isku_sysfs_read_ ## thingy(struct file *fp, struct kobject *kobj, \
170 struct bin_attribute *attr, char *buf, \
171 loff_t off, size_t count) \
173 return isku_sysfs_read(fp, kobj, buf, off, count, \
174 ISKU_SIZE_ ## THINGY, ISKU_COMMAND_ ## THINGY); \
177 #define ISKU_SYSFS_RW(thingy, THINGY) \
178 ISKU_SYSFS_R(thingy, THINGY) \
179 ISKU_SYSFS_W(thingy, THINGY)
181 #define ISKU_BIN_ATTR_RW(thingy, THINGY) \
182 ISKU_SYSFS_RW(thingy, THINGY); \
183 static struct bin_attribute bin_attr_##thingy = { \
184 .attr = { .name = #thingy, .mode = 0660 }, \
185 .size = ISKU_SIZE_ ## THINGY, \
186 .read = isku_sysfs_read_ ## thingy, \
187 .write = isku_sysfs_write_ ## thingy \
190 #define ISKU_BIN_ATTR_R(thingy, THINGY) \
191 ISKU_SYSFS_R(thingy, THINGY); \
192 static struct bin_attribute bin_attr_##thingy = { \
193 .attr = { .name = #thingy, .mode = 0440 }, \
194 .size = ISKU_SIZE_ ## THINGY, \
195 .read = isku_sysfs_read_ ## thingy, \
198 #define ISKU_BIN_ATTR_W(thingy, THINGY) \
199 ISKU_SYSFS_W(thingy, THINGY); \
200 static struct bin_attribute bin_attr_##thingy = { \
201 .attr = { .name = #thingy, .mode = 0220 }, \
202 .size = ISKU_SIZE_ ## THINGY, \
203 .write = isku_sysfs_write_ ## thingy \
206 ISKU_BIN_ATTR_RW(macro, MACRO);
207 ISKU_BIN_ATTR_RW(keys_function, KEYS_FUNCTION);
208 ISKU_BIN_ATTR_RW(keys_easyzone, KEYS_EASYZONE);
209 ISKU_BIN_ATTR_RW(keys_media, KEYS_MEDIA);
210 ISKU_BIN_ATTR_RW(keys_thumbster, KEYS_THUMBSTER);
211 ISKU_BIN_ATTR_RW(keys_macro, KEYS_MACRO);
212 ISKU_BIN_ATTR_RW(keys_capslock, KEYS_CAPSLOCK);
213 ISKU_BIN_ATTR_RW(light, LIGHT);
214 ISKU_BIN_ATTR_RW(key_mask, KEY_MASK);
215 ISKU_BIN_ATTR_RW(last_set, LAST_SET);
216 ISKU_BIN_ATTR_W(talk, TALK);
217 ISKU_BIN_ATTR_W(talkfx, TALKFX);
218 ISKU_BIN_ATTR_W(control, CONTROL);
219 ISKU_BIN_ATTR_W(reset, RESET);
220 ISKU_BIN_ATTR_R(info, INFO);
222 static struct bin_attribute *isku_bin_attributes[] = {
224 &bin_attr_keys_function,
225 &bin_attr_keys_easyzone,
226 &bin_attr_keys_media,
227 &bin_attr_keys_thumbster,
228 &bin_attr_keys_macro,
229 &bin_attr_keys_capslock,
241 static const struct attribute_group isku_group = {
243 .bin_attrs = isku_bin_attributes,
246 static const struct attribute_group *isku_groups[] = {
251 static int isku_init_isku_device_struct(struct usb_device *usb_dev,
252 struct isku_device *isku)
256 mutex_init(&isku->isku_lock);
258 retval = isku_get_actual_profile(usb_dev);
261 isku_profile_activated(isku, retval);
266 static int isku_init_specials(struct hid_device *hdev)
268 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
269 struct usb_device *usb_dev = interface_to_usbdev(intf);
270 struct isku_device *isku;
273 if (intf->cur_altsetting->desc.bInterfaceProtocol
274 != ISKU_USB_INTERFACE_PROTOCOL) {
275 hid_set_drvdata(hdev, NULL);
279 isku = kzalloc(sizeof(*isku), GFP_KERNEL);
281 hid_err(hdev, "can't alloc device descriptor\n");
284 hid_set_drvdata(hdev, isku);
286 retval = isku_init_isku_device_struct(usb_dev, isku);
288 hid_err(hdev, "couldn't init struct isku_device\n");
292 retval = roccat_connect(isku_class, hdev,
293 sizeof(struct isku_roccat_report));
295 hid_err(hdev, "couldn't init char dev\n");
297 isku->chrdev_minor = retval;
298 isku->roccat_claimed = 1;
307 static void isku_remove_specials(struct hid_device *hdev)
309 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
310 struct isku_device *isku;
312 if (intf->cur_altsetting->desc.bInterfaceProtocol
313 != ISKU_USB_INTERFACE_PROTOCOL)
316 isku = hid_get_drvdata(hdev);
317 if (isku->roccat_claimed)
318 roccat_disconnect(isku->chrdev_minor);
322 static int isku_probe(struct hid_device *hdev,
323 const struct hid_device_id *id)
327 if (!hid_is_usb(hdev))
330 retval = hid_parse(hdev);
332 hid_err(hdev, "parse failed\n");
336 retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
338 hid_err(hdev, "hw start failed\n");
342 retval = isku_init_specials(hdev);
344 hid_err(hdev, "couldn't install keyboard\n");
356 static void isku_remove(struct hid_device *hdev)
358 isku_remove_specials(hdev);
362 static void isku_keep_values_up_to_date(struct isku_device *isku,
365 struct isku_report_button const *button_report;
368 case ISKU_REPORT_NUMBER_BUTTON:
369 button_report = (struct isku_report_button const *)data;
370 switch (button_report->event) {
371 case ISKU_REPORT_BUTTON_EVENT_PROFILE:
372 isku_profile_activated(isku, button_report->data1 - 1);
379 static void isku_report_to_chrdev(struct isku_device const *isku,
382 struct isku_roccat_report roccat_report;
383 struct isku_report_button const *button_report;
385 if (data[0] != ISKU_REPORT_NUMBER_BUTTON)
388 button_report = (struct isku_report_button const *)data;
390 roccat_report.event = button_report->event;
391 roccat_report.data1 = button_report->data1;
392 roccat_report.data2 = button_report->data2;
393 roccat_report.profile = isku->actual_profile + 1;
394 roccat_report_event(isku->chrdev_minor,
395 (uint8_t const *)&roccat_report);
398 static int isku_raw_event(struct hid_device *hdev,
399 struct hid_report *report, u8 *data, int size)
401 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
402 struct isku_device *isku = hid_get_drvdata(hdev);
404 if (intf->cur_altsetting->desc.bInterfaceProtocol
405 != ISKU_USB_INTERFACE_PROTOCOL)
411 isku_keep_values_up_to_date(isku, data);
413 if (isku->roccat_claimed)
414 isku_report_to_chrdev(isku, data);
419 static const struct hid_device_id isku_devices[] = {
420 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ISKU) },
421 { HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_ISKUFX) },
425 MODULE_DEVICE_TABLE(hid, isku_devices);
427 static struct hid_driver isku_driver = {
429 .id_table = isku_devices,
431 .remove = isku_remove,
432 .raw_event = isku_raw_event
435 static int __init isku_init(void)
438 isku_class = class_create(THIS_MODULE, "isku");
439 if (IS_ERR(isku_class))
440 return PTR_ERR(isku_class);
441 isku_class->dev_groups = isku_groups;
443 retval = hid_register_driver(&isku_driver);
445 class_destroy(isku_class);
449 static void __exit isku_exit(void)
451 hid_unregister_driver(&isku_driver);
452 class_destroy(isku_class);
455 module_init(isku_init);
456 module_exit(isku_exit);
458 MODULE_AUTHOR("Stefan Achatz");
459 MODULE_DESCRIPTION("USB Roccat Isku/FX driver");
460 MODULE_LICENSE("GPL v2");