USB: HID: Steelseries SRW-S1 Add support for LEDs
[deliverable/linux.git] / drivers / hid / hid-steelseries-srws1.c
CommitLineData
75dbb953
SW
1/*
2 * HID driver for Steelseries SRW-S1
3 *
4 * Copyright (c) 2013 Simon Wood
5 */
6
7/*
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the Free
10 * Software Foundation; either version 2 of the License, or (at your option)
11 * any later version.
12 */
13
14#include <linux/device.h>
2e2daff3 15#include <linux/usb.h>
75dbb953
SW
16#include <linux/hid.h>
17#include <linux/module.h>
18
2e2daff3 19#include "usbhid/usbhid.h"
75dbb953
SW
20#include "hid-ids.h"
21
2e2daff3
SW
22#if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
23#define SRWS1_NUMBER_LEDS 15
24struct steelseries_srws1_data {
25 __u16 led_state;
26 struct led_classdev *led[SRWS1_NUMBER_LEDS];
27};
28#endif
29
5492606d
SW
30/* Fixed report descriptor for Steelseries SRW-S1 wheel controller
31 *
32 * The original descriptor hides the sensitivity and assists dials
33 * a custom vendor usage page. This inserts a patch to make them
34 * appear in the 'Generic Desktop' usage.
35 */
36
37static __u8 steelseries_srws1_rdesc_fixed[] = {
380x05, 0x01, /* Usage Page (Desktop) */
390x09, 0x08, /* Usage (MultiAxis), Changed */
400xA1, 0x01, /* Collection (Application), */
410xA1, 0x02, /* Collection (Logical), */
420x95, 0x01, /* Report Count (1), */
430x05, 0x01, /* Changed Usage Page (Desktop), */
440x09, 0x30, /* Changed Usage (X), */
450x16, 0xF8, 0xF8, /* Logical Minimum (-1800), */
460x26, 0x08, 0x07, /* Logical Maximum (1800), */
470x65, 0x14, /* Unit (Degrees), */
480x55, 0x0F, /* Unit Exponent (15), */
490x75, 0x10, /* Report Size (16), */
500x81, 0x02, /* Input (Variable), */
510x09, 0x31, /* Changed Usage (Y), */
520x15, 0x00, /* Logical Minimum (0), */
530x26, 0xFF, 0x03, /* Logical Maximum (1023), */
540x75, 0x0C, /* Report Size (12), */
550x81, 0x02, /* Input (Variable), */
560x09, 0x32, /* Changed Usage (Z), */
570x15, 0x00, /* Logical Minimum (0), */
580x26, 0xFF, 0x03, /* Logical Maximum (1023), */
590x75, 0x0C, /* Report Size (12), */
600x81, 0x02, /* Input (Variable), */
610x05, 0x01, /* Usage Page (Desktop), */
620x09, 0x39, /* Usage (Hat Switch), */
630x25, 0x07, /* Logical Maximum (7), */
640x35, 0x00, /* Physical Minimum (0), */
650x46, 0x3B, 0x01, /* Physical Maximum (315), */
660x65, 0x14, /* Unit (Degrees), */
670x75, 0x04, /* Report Size (4), */
680x95, 0x01, /* Report Count (1), */
690x81, 0x02, /* Input (Variable), */
700x25, 0x01, /* Logical Maximum (1), */
710x45, 0x01, /* Physical Maximum (1), */
720x65, 0x00, /* Unit, */
730x75, 0x01, /* Report Size (1), */
740x95, 0x03, /* Report Count (3), */
750x81, 0x01, /* Input (Constant), */
760x05, 0x09, /* Usage Page (Button), */
770x19, 0x01, /* Usage Minimum (01h), */
780x29, 0x11, /* Usage Maximum (11h), */
790x95, 0x11, /* Report Count (17), */
800x81, 0x02, /* Input (Variable), */
81 /* ---- Dial patch starts here ---- */
820x05, 0x01, /* Usage Page (Desktop), */
830x09, 0x33, /* Usage (RX), */
840x75, 0x04, /* Report Size (4), */
850x95, 0x02, /* Report Count (2), */
860x15, 0x00, /* Logical Minimum (0), */
870x25, 0x0b, /* Logical Maximum (b), */
880x81, 0x02, /* Input (Variable), */
890x09, 0x35, /* Usage (RZ), */
900x75, 0x04, /* Report Size (4), */
910x95, 0x01, /* Report Count (1), */
920x25, 0x03, /* Logical Maximum (3), */
930x81, 0x02, /* Input (Variable), */
94 /* ---- Dial patch ends here ---- */
950x06, 0x00, 0xFF, /* Usage Page (FF00h), */
960x09, 0x01, /* Usage (01h), */
970x75, 0x04, /* Changed Report Size (4), */
980x95, 0x0D, /* Changed Report Count (13), */
990x81, 0x02, /* Input (Variable), */
1000xC0, /* End Collection, */
1010xA1, 0x02, /* Collection (Logical), */
1020x09, 0x02, /* Usage (02h), */
1030x75, 0x08, /* Report Size (8), */
1040x95, 0x10, /* Report Count (16), */
1050x91, 0x02, /* Output (Variable), */
1060xC0, /* End Collection, */
1070xC0 /* End Collection */
108};
109
2e2daff3
SW
110#if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
111static void steelseries_srws1_set_leds(struct hid_device *hdev, __u16 leds)
112{
113 struct list_head *report_list = &hdev->report_enum[HID_OUTPUT_REPORT].report_list;
114 struct hid_report *report = list_entry(report_list->next, struct hid_report, list);
115 __s32 *value = report->field[0]->value;
116
117 value[0] = 0x40;
118 value[1] = leds & 0xFF;
119 value[2] = leds >> 8;
120 value[3] = 0x00;
121 value[4] = 0x00;
122 value[5] = 0x00;
123 value[6] = 0x00;
124 value[7] = 0x00;
125 value[8] = 0x00;
126 value[9] = 0x00;
127 value[10] = 0x00;
128 value[11] = 0x00;
129 value[12] = 0x00;
130 value[13] = 0x00;
131 value[14] = 0x00;
132 value[15] = 0x00;
133
134 usbhid_submit_report(hdev, report, USB_DIR_OUT);
135
136 /* Note: LED change does not show on device until the device is read/polled */
137}
138
139static void steelseries_srws1_led_set_brightness(struct led_classdev *led_cdev,
140 enum led_brightness value)
141{
142 struct device *dev = led_cdev->dev->parent;
143 struct hid_device *hid = container_of(dev, struct hid_device, dev);
144 struct steelseries_srws1_data *drv_data = hid_get_drvdata(hid);
145 int i, state = 0;
146
147 if (!drv_data) {
148 hid_err(hid, "Device data not found.");
149 return;
150 }
151
152 for (i = 0; i < SRWS1_NUMBER_LEDS; i++) {
153 if (led_cdev != drv_data->led[i])
154 continue;
155
156 state = (drv_data->led_state >> i) & 1;
157 if (value == LED_OFF && state) {
158 drv_data->led_state &= ~(1 << i);
159 steelseries_srws1_set_leds(hid, drv_data->led_state);
160 } else if (value != LED_OFF && !state) {
161 drv_data->led_state |= 1 << i;
162 steelseries_srws1_set_leds(hid, drv_data->led_state);
163 }
164 break;
165 }
166}
167
168static enum led_brightness steelseries_srws1_led_get_brightness(struct led_classdev *led_cdev)
169{
170 struct device *dev = led_cdev->dev->parent;
171 struct hid_device *hid = container_of(dev, struct hid_device, dev);
172 struct steelseries_srws1_data *drv_data;
173 int i, value = 0;
174
175 drv_data = hid_get_drvdata(hid);
176
177 if (!drv_data) {
178 hid_err(hid, "Device data not found.");
179 return LED_OFF;
180 }
181
182 for (i = 0; i < SRWS1_NUMBER_LEDS; i++)
183 if (led_cdev == drv_data->led[i]) {
184 value = (drv_data->led_state >> i) & 1;
185 break;
186 }
187
188 return value ? LED_FULL : LED_OFF;
189}
190
191static int steelseries_srws1_probe(struct hid_device *hdev,
192 const struct hid_device_id *id)
193{
194 int ret, i;
195 struct led_classdev *led;
196 size_t name_sz;
197 char *name;
198
199 struct steelseries_srws1_data *drv_data = kzalloc(sizeof(*drv_data), GFP_KERNEL);
200
201 if (drv_data == NULL) {
202 hid_err(hdev, "can't alloc SRW-S1 memory\n");
203 return -ENOMEM;
204 }
205
206 hid_set_drvdata(hdev, drv_data);
207
208 ret = hid_parse(hdev);
209 if (ret) {
210 hid_err(hdev, "parse failed\n");
211 goto err_free;
212 }
213
214 ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
215 if (ret) {
216 hid_err(hdev, "hw start failed\n");
217 goto err_free;
218 }
219
220 /* register led subsystem */
221 drv_data->led_state = 0;
222 for (i = 0; i < SRWS1_NUMBER_LEDS; i++)
223 drv_data->led[i] = NULL;
224
225 steelseries_srws1_set_leds(hdev, 0);
226
227 name_sz = strlen(hdev->uniq) + 15;
228
229 for (i = 0; i < SRWS1_NUMBER_LEDS; i++) {
230 led = kzalloc(sizeof(struct led_classdev)+name_sz, GFP_KERNEL);
231 if (!led) {
232 hid_err(hdev, "can't allocate memory for LED %d\n", i);
233 goto err_led;
234 }
235
236 name = (void *)(&led[1]);
237 snprintf(name, name_sz, "SRWS1::%s::RPM%d", hdev->uniq, i+1);
238 led->name = name;
239 led->brightness = 0;
240 led->max_brightness = 1;
241 led->brightness_get = steelseries_srws1_led_get_brightness;
242 led->brightness_set = steelseries_srws1_led_set_brightness;
243
244 drv_data->led[i] = led;
245 ret = led_classdev_register(&hdev->dev, led);
246
247 if (ret) {
248 hid_err(hdev, "failed to register LED %d. Aborting.\n", i);
249err_led:
250 /* Deregister all LEDs (if any) */
251 for (i = 0; i < SRWS1_NUMBER_LEDS; i++) {
252 led = drv_data->led[i];
253 drv_data->led[i] = NULL;
254 if (!led)
255 continue;
256 led_classdev_unregister(led);
257 kfree(led);
258 }
259 goto out; /* but let the driver continue without LEDs */
260 }
261 }
262out:
263 return 0;
264err_free:
265 kfree(drv_data);
266 return ret;
267}
268
269static void steelseries_srws1_remove(struct hid_device *hdev)
270{
271 int i;
272 struct led_classdev *led;
273
274 struct steelseries_srws1_data *drv_data = hid_get_drvdata(hdev);
275
276 if (drv_data) {
277 /* Deregister LEDs (if any) */
278 for (i = 0; i < SRWS1_NUMBER_LEDS; i++) {
279 led = drv_data->led[i];
280 drv_data->led[i] = NULL;
281 if (!led)
282 continue;
283 led_classdev_unregister(led);
284 kfree(led);
285 }
286
287 }
288
289 hid_hw_stop(hdev);
290 kfree(drv_data);
291 return;
292}
293#endif
294
75dbb953
SW
295static __u8 *steelseries_srws1_report_fixup(struct hid_device *hdev, __u8 *rdesc,
296 unsigned int *rsize)
297{
298 if (*rsize >= 115 && rdesc[11] == 0x02 && rdesc[13] == 0xc8
299 && rdesc[29] == 0xbb && rdesc[40] == 0xc5) {
300 hid_info(hdev, "Fixing up Steelseries SRW-S1 report descriptor\n");
5492606d
SW
301 rdesc = steelseries_srws1_rdesc_fixed;
302 *rsize = sizeof(steelseries_srws1_rdesc_fixed);
75dbb953
SW
303 }
304 return rdesc;
305}
306
307static const struct hid_device_id steelseries_srws1_devices[] = {
308 { HID_USB_DEVICE(USB_VENDOR_ID_STEELSERIES, USB_DEVICE_ID_STEELSERIES_SRWS1) },
309 { }
310};
311MODULE_DEVICE_TABLE(hid, steelseries_srws1_devices);
312
313static struct hid_driver steelseries_srws1_driver = {
314 .name = "steelseries_srws1",
315 .id_table = steelseries_srws1_devices,
2e2daff3
SW
316#if defined(CONFIG_LEDS_CLASS) || defined(CONFIG_LEDS_CLASS_MODULE)
317 .probe = steelseries_srws1_probe,
318 .remove = steelseries_srws1_remove,
319#endif
75dbb953
SW
320 .report_fixup = steelseries_srws1_report_fixup
321};
322
323static int __init steelseries_srws1_init(void)
324{
325 return hid_register_driver(&steelseries_srws1_driver);
326}
327
328static void __exit steelseries_srws1_exit(void)
329{
330 hid_unregister_driver(&steelseries_srws1_driver);
331}
332
333module_init(steelseries_srws1_init);
334module_exit(steelseries_srws1_exit);
335MODULE_LICENSE("GPL");
This page took 0.036062 seconds and 5 git commands to generate.