1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Roccat KonePure driver for Linux
4  *
5  * Copyright (c) 2012 Stefan Achatz <erazor_de@users.sourceforge.net>
6  */
7 
8 /*
9  */
10 
11 /*
12  * Roccat KonePure is a smaller version of KoneXTD with less buttons and lights.
13  */
14 
15 #include <linux/types.h>
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>
22 #include "hid-ids.h"
23 #include "hid-roccat-common.h"
24 
25 enum {
26 	KONEPURE_MOUSE_REPORT_NUMBER_BUTTON = 3,
27 };
28 
29 struct konepure_mouse_report_button {
30 	uint8_t report_number; /* always KONEPURE_MOUSE_REPORT_NUMBER_BUTTON */
31 	uint8_t zero;
32 	uint8_t type;
33 	uint8_t data1;
34 	uint8_t data2;
35 	uint8_t zero2;
36 	uint8_t unknown[2];
37 } __packed;
38 
39 static struct class *konepure_class;
40 
41 ROCCAT_COMMON2_BIN_ATTRIBUTE_W(control, 0x04, 0x03);
42 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(actual_profile, 0x05, 0x03);
43 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(profile_settings, 0x06, 0x1f);
44 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(profile_buttons, 0x07, 0x3b);
45 ROCCAT_COMMON2_BIN_ATTRIBUTE_W(macro, 0x08, 0x0822);
46 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(info, 0x09, 0x06);
47 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(tcu, 0x0c, 0x04);
48 ROCCAT_COMMON2_BIN_ATTRIBUTE_R(tcu_image, 0x0c, 0x0404);
49 ROCCAT_COMMON2_BIN_ATTRIBUTE_RW(sensor, 0x0f, 0x06);
50 ROCCAT_COMMON2_BIN_ATTRIBUTE_W(talk, 0x10, 0x10);
51 
52 static struct bin_attribute *konepure_bin_attrs[] = {
53 	&bin_attr_actual_profile,
54 	&bin_attr_control,
55 	&bin_attr_info,
56 	&bin_attr_talk,
57 	&bin_attr_macro,
58 	&bin_attr_sensor,
59 	&bin_attr_tcu,
60 	&bin_attr_tcu_image,
61 	&bin_attr_profile_settings,
62 	&bin_attr_profile_buttons,
63 	NULL,
64 };
65 
66 static const struct attribute_group konepure_group = {
67 	.bin_attrs = konepure_bin_attrs,
68 };
69 
70 static const struct attribute_group *konepure_groups[] = {
71 	&konepure_group,
72 	NULL,
73 };
74 
75 static int konepure_init_specials(struct hid_device *hdev)
76 {
77 	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
78 	struct usb_device *usb_dev = interface_to_usbdev(intf);
79 	struct roccat_common2_device *konepure;
80 	int retval;
81 
82 	if (intf->cur_altsetting->desc.bInterfaceProtocol
83 			!= USB_INTERFACE_PROTOCOL_MOUSE) {
84 		hid_set_drvdata(hdev, NULL);
85 		return 0;
86 	}
87 
88 	konepure = kzalloc(sizeof(*konepure), GFP_KERNEL);
89 	if (!konepure) {
90 		hid_err(hdev, "can't alloc device descriptor\n");
91 		return -ENOMEM;
92 	}
93 	hid_set_drvdata(hdev, konepure);
94 
95 	retval = roccat_common2_device_init_struct(usb_dev, konepure);
96 	if (retval) {
97 		hid_err(hdev, "couldn't init KonePure device\n");
98 		goto exit_free;
99 	}
100 
101 	retval = roccat_connect(konepure_class, hdev,
102 			sizeof(struct konepure_mouse_report_button));
103 	if (retval < 0) {
104 		hid_err(hdev, "couldn't init char dev\n");
105 	} else {
106 		konepure->chrdev_minor = retval;
107 		konepure->roccat_claimed = 1;
108 	}
109 
110 	return 0;
111 exit_free:
112 	kfree(konepure);
113 	return retval;
114 }
115 
116 static void konepure_remove_specials(struct hid_device *hdev)
117 {
118 	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
119 	struct roccat_common2_device *konepure;
120 
121 	if (intf->cur_altsetting->desc.bInterfaceProtocol
122 			!= USB_INTERFACE_PROTOCOL_MOUSE)
123 		return;
124 
125 	konepure = hid_get_drvdata(hdev);
126 	if (konepure->roccat_claimed)
127 		roccat_disconnect(konepure->chrdev_minor);
128 	kfree(konepure);
129 }
130 
131 static int konepure_probe(struct hid_device *hdev,
132 		const struct hid_device_id *id)
133 {
134 	int retval;
135 
136 	if (!hid_is_usb(hdev))
137 		return -EINVAL;
138 
139 	retval = hid_parse(hdev);
140 	if (retval) {
141 		hid_err(hdev, "parse failed\n");
142 		goto exit;
143 	}
144 
145 	retval = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
146 	if (retval) {
147 		hid_err(hdev, "hw start failed\n");
148 		goto exit;
149 	}
150 
151 	retval = konepure_init_specials(hdev);
152 	if (retval) {
153 		hid_err(hdev, "couldn't install mouse\n");
154 		goto exit_stop;
155 	}
156 
157 	return 0;
158 
159 exit_stop:
160 	hid_hw_stop(hdev);
161 exit:
162 	return retval;
163 }
164 
165 static void konepure_remove(struct hid_device *hdev)
166 {
167 	konepure_remove_specials(hdev);
168 	hid_hw_stop(hdev);
169 }
170 
171 static int konepure_raw_event(struct hid_device *hdev,
172 		struct hid_report *report, u8 *data, int size)
173 {
174 	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
175 	struct roccat_common2_device *konepure = hid_get_drvdata(hdev);
176 
177 	if (intf->cur_altsetting->desc.bInterfaceProtocol
178 			!= USB_INTERFACE_PROTOCOL_MOUSE)
179 		return 0;
180 
181 	if (data[0] != KONEPURE_MOUSE_REPORT_NUMBER_BUTTON)
182 		return 0;
183 
184 	if (konepure != NULL && konepure->roccat_claimed)
185 		roccat_report_event(konepure->chrdev_minor, data);
186 
187 	return 0;
188 }
189 
190 static const struct hid_device_id konepure_devices[] = {
191 	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPURE) },
192 	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONEPURE_OPTICAL) },
193 	{ }
194 };
195 
196 MODULE_DEVICE_TABLE(hid, konepure_devices);
197 
198 static struct hid_driver konepure_driver = {
199 		.name = "konepure",
200 		.id_table = konepure_devices,
201 		.probe = konepure_probe,
202 		.remove = konepure_remove,
203 		.raw_event = konepure_raw_event
204 };
205 
206 static int __init konepure_init(void)
207 {
208 	int retval;
209 
210 	konepure_class = class_create(THIS_MODULE, "konepure");
211 	if (IS_ERR(konepure_class))
212 		return PTR_ERR(konepure_class);
213 	konepure_class->dev_groups = konepure_groups;
214 
215 	retval = hid_register_driver(&konepure_driver);
216 	if (retval)
217 		class_destroy(konepure_class);
218 	return retval;
219 }
220 
221 static void __exit konepure_exit(void)
222 {
223 	hid_unregister_driver(&konepure_driver);
224 	class_destroy(konepure_class);
225 }
226 
227 module_init(konepure_init);
228 module_exit(konepure_exit);
229 
230 MODULE_AUTHOR("Stefan Achatz");
231 MODULE_DESCRIPTION("USB Roccat KonePure/Optical driver");
232 MODULE_LICENSE("GPL v2");
233