2 * USB PhidgetInterfaceKit driver 1.0
4 * Copyright (C) 2004, 2006 Sean Young <sean@mess.org>
5 * Copyright (C) 2005 Daniel Saakes <daniel@saakes.net>
6 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This is a driver for the USB PhidgetInterfaceKit.
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/init.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21 #include <linux/usb.h>
25 #define DRIVER_AUTHOR "Sean Young <sean@mess.org>"
26 #define DRIVER_DESC "USB PhidgetInterfaceKit Driver"
28 #define USB_VENDOR_ID_GLAB 0x06c2
29 #define USB_DEVICE_ID_INTERFACEKIT004 0x0040
30 #define USB_DEVICE_ID_INTERFACEKIT01616 0x0044
31 #define USB_DEVICE_ID_INTERFACEKIT888 0x0045
32 #define USB_DEVICE_ID_INTERFACEKIT047 0x0051
33 #define USB_DEVICE_ID_INTERFACEKIT088 0x0053
35 #define USB_VENDOR_ID_WISEGROUP 0x0925
36 #define USB_DEVICE_ID_INTERFACEKIT884 0x8201
38 #define MAX_INTERFACES 16
40 #define URB_INT_SIZE 8
42 struct driver_interfacekit {
50 #define ifkit(_sensors, _inputs, _outputs, _lcd, _amnesiac) \
52 .sensors = _sensors, \
54 .outputs = _outputs, \
56 .amnesiac = _amnesiac \
59 static const struct driver_interfacekit ph_004 = ifkit(0, 0, 4, 0, 0);
60 static const struct driver_interfacekit ph_888n = ifkit(8, 8, 8, 0, 1);
61 static const struct driver_interfacekit ph_888o = ifkit(8, 8, 8, 0, 0);
62 static const struct driver_interfacekit ph_047 = ifkit(0, 4, 7, 1, 0);
63 static const struct driver_interfacekit ph_884 = ifkit(8, 8, 4, 0, 0);
64 static const struct driver_interfacekit ph_088 = ifkit(0, 8, 8, 1, 0);
65 static const struct driver_interfacekit ph_01616 = ifkit(0, 16, 16, 0, 0);
67 static unsigned long device_no;
70 struct usb_device *udev;
71 struct usb_interface *intf;
72 struct driver_interfacekit *ifkit;
74 unsigned long outputs;
76 u8 inputs[MAX_INTERFACES];
77 u16 sensors[MAX_INTERFACES];
84 struct delayed_work do_notify;
85 struct delayed_work do_resubmit;
86 unsigned long input_events;
87 unsigned long sensor_events;
90 static struct usb_device_id id_table[] = {
91 {USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT004),
92 .driver_info = (kernel_ulong_t)&ph_004},
93 {USB_DEVICE_VER(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT888, 0, 0x814),
94 .driver_info = (kernel_ulong_t)&ph_888o},
95 {USB_DEVICE_VER(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT888, 0x0815, 0xffff),
96 .driver_info = (kernel_ulong_t)&ph_888n},
97 {USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT047),
98 .driver_info = (kernel_ulong_t)&ph_047},
99 {USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT088),
100 .driver_info = (kernel_ulong_t)&ph_088},
101 {USB_DEVICE(USB_VENDOR_ID_GLAB, USB_DEVICE_ID_INTERFACEKIT01616),
102 .driver_info = (kernel_ulong_t)&ph_01616},
103 {USB_DEVICE(USB_VENDOR_ID_WISEGROUP, USB_DEVICE_ID_INTERFACEKIT884),
104 .driver_info = (kernel_ulong_t)&ph_884},
107 MODULE_DEVICE_TABLE(usb, id_table);
109 static int set_outputs(struct interfacekit *kit)
114 buffer = kzalloc(4, GFP_KERNEL);
116 dev_err(&kit->udev->dev, "%s - out of memory\n", __FUNCTION__);
119 buffer[0] = (u8)kit->outputs;
120 buffer[1] = (u8)(kit->outputs >> 8);
122 dev_dbg(&kit->udev->dev, "sending data: 0x%04x\n", (u16)kit->outputs);
124 retval = usb_control_msg(kit->udev,
125 usb_sndctrlpipe(kit->udev, 0),
126 0x09, 0x21, 0x0200, 0x0000, buffer, 4, 2000);
129 dev_err(&kit->udev->dev, "usb_control_msg returned %d\n",
133 if (kit->ifkit->amnesiac)
134 schedule_delayed_work(&kit->do_resubmit, HZ / 2);
136 return retval < 0 ? retval : 0;
139 static int change_string(struct interfacekit *kit, const char *display, unsigned char row)
141 unsigned char *buffer;
142 unsigned char *form_buffer;
143 int retval = -ENOMEM;
144 int i,j, len, buf_ptr;
146 buffer = kmalloc(8, GFP_KERNEL);
147 form_buffer = kmalloc(30, GFP_KERNEL);
148 if ((!buffer) || (!form_buffer)) {
149 dev_err(&kit->udev->dev, "%s - out of memory\n", __FUNCTION__);
153 len = strlen(display);
157 dev_dbg(&kit->udev->dev, "Setting LCD line %d to %s\n", row, display);
159 form_buffer[0] = row * 0x40 + 0x80;
160 form_buffer[1] = 0x02;
162 for (i = 0; i<len; i++)
163 form_buffer[buf_ptr++] = display[i];
165 for (i = 0; i < (20 - len); i++)
166 form_buffer[buf_ptr++] = 0x20;
167 form_buffer[buf_ptr++] = 0x01;
168 form_buffer[buf_ptr++] = row * 0x40 + 0x80 + strlen(display);
170 for (i = 0; i < buf_ptr; i += 7) {
171 if ((buf_ptr - i) > 7)
175 for (j = 0; j < len; j++)
176 buffer[j] = form_buffer[i + j];
179 retval = usb_control_msg(kit->udev,
180 usb_sndctrlpipe(kit->udev, 0),
181 0x09, 0x21, 0x0200, 0x0000, buffer, 8, 2000);
194 #define set_lcd_line(number) \
195 static ssize_t lcd_line_##number(struct device *dev, \
196 struct device_attribute *attr, \
197 const char *buf, size_t count) \
199 struct interfacekit *kit = dev_get_drvdata(dev); \
200 change_string(kit, buf, number - 1); \
204 #define lcd_line_attr(number) \
205 __ATTR(lcd_line_##number, S_IWUGO, NULL, lcd_line_##number)
210 static ssize_t set_backlight(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
212 struct interfacekit *kit = dev_get_drvdata(dev);
214 unsigned char *buffer;
215 int retval = -ENOMEM;
217 buffer = kzalloc(8, GFP_KERNEL);
219 dev_err(&kit->udev->dev, "%s - out of memory\n", __FUNCTION__);
223 if (sscanf(buf, "%d", &enabled) < 1) {
231 dev_dbg(&kit->udev->dev, "Setting backlight to %s\n", enabled ? "on" : "off");
233 retval = usb_control_msg(kit->udev,
234 usb_sndctrlpipe(kit->udev, 0),
235 0x09, 0x21, 0x0200, 0x0000, buffer, 8, 2000);
245 static struct device_attribute dev_lcd_line_attrs[] = {
248 __ATTR(backlight, S_IWUGO, NULL, set_backlight)
251 static void remove_lcd_files(struct interfacekit *kit)
255 if (kit->lcd_files_on) {
256 dev_dbg(&kit->udev->dev, "Removing lcd files\n");
258 for (i=0; i<ARRAY_SIZE(dev_lcd_line_attrs); i++)
259 device_remove_file(kit->dev, &dev_lcd_line_attrs[i]);
263 static ssize_t enable_lcd_files(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
265 struct interfacekit *kit = dev_get_drvdata(dev);
269 if (kit->ifkit->has_lcd == 0)
272 if (sscanf(buf, "%d", &enable) < 1)
276 if (!kit->lcd_files_on) {
277 dev_dbg(&kit->udev->dev, "Adding lcd files\n");
278 for (i=0; i<ARRAY_SIZE(dev_lcd_line_attrs); i++) {
279 rc = device_create_file(kit->dev,
280 &dev_lcd_line_attrs[i]);
284 kit->lcd_files_on = 1;
287 if (kit->lcd_files_on) {
288 remove_lcd_files(kit);
289 kit->lcd_files_on = 0;
296 device_remove_file(kit->dev, &dev_lcd_line_attrs[i]);
301 static DEVICE_ATTR(lcd, S_IWUGO, NULL, enable_lcd_files);
303 static void interfacekit_irq(struct urb *urb)
305 struct interfacekit *kit = urb->context;
306 unsigned char *buffer = kit->data;
307 int i, level, sensor;
309 int status = urb->status;
312 case 0: /* success */
314 case -ECONNRESET: /* unlink */
318 /* -EPIPE: should clear the halt */
324 if (kit->ifkit->inputs == 16) {
325 for (i=0; i < 8; i++) {
326 level = (buffer[0] >> i) & 1;
327 if (kit->inputs[i] != level) {
328 kit->inputs[i] = level;
329 set_bit(i, &kit->input_events);
331 level = (buffer[1] >> i) & 1;
332 if (kit->inputs[8 + i] != level) {
333 kit->inputs[8 + i] = level;
334 set_bit(8 + i, &kit->input_events);
338 else if (kit->ifkit->inputs == 8) {
339 for (i=0; i < 8; i++) {
340 level = (buffer[1] >> i) & 1;
341 if (kit->inputs[i] != level) {
342 kit->inputs[i] = level;
343 set_bit(i, &kit->input_events);
349 if (kit->ifkit->sensors) {
350 sensor = (buffer[0] & 1) ? 4 : 0;
352 level = buffer[2] + (buffer[3] & 0x0f) * 256;
353 if (level != kit->sensors[sensor]) {
354 kit->sensors[sensor] = level;
355 set_bit(sensor, &kit->sensor_events);
358 level = buffer[4] + (buffer[3] & 0xf0) * 16;
359 if (level != kit->sensors[sensor]) {
360 kit->sensors[sensor] = level;
361 set_bit(sensor, &kit->sensor_events);
364 level = buffer[5] + (buffer[6] & 0x0f) * 256;
365 if (level != kit->sensors[sensor]) {
366 kit->sensors[sensor] = level;
367 set_bit(sensor, &kit->sensor_events);
370 level = buffer[7] + (buffer[6] & 0xf0) * 16;
371 if (level != kit->sensors[sensor]) {
372 kit->sensors[sensor] = level;
373 set_bit(sensor, &kit->sensor_events);
377 if (kit->input_events || kit->sensor_events)
378 schedule_delayed_work(&kit->do_notify, 0);
381 retval = usb_submit_urb(urb, GFP_ATOMIC);
383 err("can't resubmit intr, %s-%s/interfacekit0, retval %d",
384 kit->udev->bus->bus_name,
385 kit->udev->devpath, retval);
388 static void do_notify(struct work_struct *work)
390 struct interfacekit *kit =
391 container_of(work, struct interfacekit, do_notify.work);
395 for (i=0; i<kit->ifkit->inputs; i++) {
396 if (test_and_clear_bit(i, &kit->input_events)) {
397 sprintf(sysfs_file, "input%d", i + 1);
398 sysfs_notify(&kit->dev->kobj, NULL, sysfs_file);
402 for (i=0; i<kit->ifkit->sensors; i++) {
403 if (test_and_clear_bit(i, &kit->sensor_events)) {
404 sprintf(sysfs_file, "sensor%d", i + 1);
405 sysfs_notify(&kit->dev->kobj, NULL, sysfs_file);
410 static void do_resubmit(struct work_struct *work)
412 struct interfacekit *kit =
413 container_of(work, struct interfacekit, do_resubmit.work);
417 #define show_set_output(value) \
418 static ssize_t set_output##value(struct device *dev, \
419 struct device_attribute *attr, \
420 const char *buf, size_t count) \
422 struct interfacekit *kit = dev_get_drvdata(dev); \
426 if (sscanf(buf, "%d", &enable) < 1) \
430 set_bit(value - 1, &kit->outputs); \
432 clear_bit(value - 1, &kit->outputs); \
434 retval = set_outputs(kit); \
436 return retval ? retval : count; \
439 static ssize_t show_output##value(struct device *dev, \
440 struct device_attribute *attr, \
443 struct interfacekit *kit = dev_get_drvdata(dev); \
445 return sprintf(buf, "%d\n", !!test_bit(value - 1, &kit->outputs));\
448 #define output_attr(value) \
449 __ATTR(output##value, S_IWUGO | S_IRUGO, \
450 show_output##value, set_output##value)
469 static struct device_attribute dev_output_attrs[] = {
470 output_attr(1), output_attr(2), output_attr(3), output_attr(4),
471 output_attr(5), output_attr(6), output_attr(7), output_attr(8),
472 output_attr(9), output_attr(10), output_attr(11), output_attr(12),
473 output_attr(13), output_attr(14), output_attr(15), output_attr(16)
476 #define show_input(value) \
477 static ssize_t show_input##value(struct device *dev, \
478 struct device_attribute *attr, char *buf) \
480 struct interfacekit *kit = dev_get_drvdata(dev); \
482 return sprintf(buf, "%d\n", (int)kit->inputs[value - 1]); \
485 #define input_attr(value) \
486 __ATTR(input##value, S_IRUGO, show_input##value, NULL)
505 static struct device_attribute dev_input_attrs[] = {
506 input_attr(1), input_attr(2), input_attr(3), input_attr(4),
507 input_attr(5), input_attr(6), input_attr(7), input_attr(8),
508 input_attr(9), input_attr(10), input_attr(11), input_attr(12),
509 input_attr(13), input_attr(14), input_attr(15), input_attr(16)
512 #define show_sensor(value) \
513 static ssize_t show_sensor##value(struct device *dev, \
514 struct device_attribute *attr, \
517 struct interfacekit *kit = dev_get_drvdata(dev); \
519 return sprintf(buf, "%d\n", (int)kit->sensors[value - 1]); \
522 #define sensor_attr(value) \
523 __ATTR(sensor##value, S_IRUGO, show_sensor##value, NULL)
534 static struct device_attribute dev_sensor_attrs[] = {
535 sensor_attr(1), sensor_attr(2), sensor_attr(3), sensor_attr(4),
536 sensor_attr(5), sensor_attr(6), sensor_attr(7), sensor_attr(8)
539 static int interfacekit_probe(struct usb_interface *intf, const struct usb_device_id *id)
541 struct usb_device *dev = interface_to_usbdev(intf);
542 struct usb_host_interface *interface;
543 struct usb_endpoint_descriptor *endpoint;
544 struct interfacekit *kit;
545 struct driver_interfacekit *ifkit;
546 int pipe, maxp, rc = -ENOMEM;
549 ifkit = (struct driver_interfacekit *)id->driver_info;
553 interface = intf->cur_altsetting;
554 if (interface->desc.bNumEndpoints != 1)
557 endpoint = &interface->endpoint[0].desc;
558 if (!usb_endpoint_dir_in(endpoint))
563 pipe = usb_rcvintpipe(dev, endpoint->bEndpointAddress);
564 maxp = usb_maxpacket(dev, pipe, usb_pipeout(pipe));
566 kit = kzalloc(sizeof(*kit), GFP_KERNEL);
572 kit->data = usb_buffer_alloc(dev, URB_INT_SIZE, GFP_ATOMIC, &kit->data_dma);
576 kit->irq = usb_alloc_urb(0, GFP_KERNEL);
580 kit->udev = usb_get_dev(dev);
582 INIT_DELAYED_WORK(&kit->do_notify, do_notify);
583 INIT_DELAYED_WORK(&kit->do_resubmit, do_resubmit);
584 usb_fill_int_urb(kit->irq, kit->udev, pipe, kit->data,
585 maxp > URB_INT_SIZE ? URB_INT_SIZE : maxp,
586 interfacekit_irq, kit, endpoint->bInterval);
587 kit->irq->transfer_dma = kit->data_dma;
588 kit->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
590 usb_set_intfdata(intf, kit);
593 bit = find_first_zero_bit(&device_no, sizeof(device_no));
594 value = test_and_set_bit(bit, &device_no);
598 kit->dev = device_create(phidget_class, &kit->udev->dev, 0,
599 "interfacekit%d", kit->dev_no);
600 if (IS_ERR(kit->dev)) {
601 rc = PTR_ERR(kit->dev);
605 dev_set_drvdata(kit->dev, kit);
607 if (usb_submit_urb(kit->irq, GFP_KERNEL)) {
612 for (i=0; i<ifkit->outputs; i++ ) {
613 rc = device_create_file(kit->dev, &dev_output_attrs[i]);
618 for (i=0; i<ifkit->inputs; i++ ) {
619 rc = device_create_file(kit->dev, &dev_input_attrs[i]);
624 for (i=0; i<ifkit->sensors; i++ ) {
625 rc = device_create_file(kit->dev, &dev_sensor_attrs[i]);
630 if (ifkit->has_lcd) {
631 rc = device_create_file(kit->dev, &dev_attr_lcd);
637 dev_info(&intf->dev, "USB PhidgetInterfaceKit %d/%d/%d attached\n",
638 ifkit->sensors, ifkit->inputs, ifkit->outputs);
644 device_remove_file(kit->dev, &dev_sensor_attrs[i]);
649 device_remove_file(kit->dev, &dev_input_attrs[i]);
654 device_remove_file(kit->dev, &dev_output_attrs[i]);
657 usb_free_urb(kit->irq);
659 usb_buffer_free(dev, URB_INT_SIZE, kit->data, kit->data_dma);
661 device_unregister(kit->dev);
662 if (kit->dev_no >= 0)
663 clear_bit(kit->dev_no, &device_no);
671 static void interfacekit_disconnect(struct usb_interface *interface)
673 struct interfacekit *kit;
676 kit = usb_get_intfdata(interface);
677 usb_set_intfdata(interface, NULL);
681 usb_kill_urb(kit->irq);
682 usb_free_urb(kit->irq);
683 usb_buffer_free(kit->udev, URB_INT_SIZE, kit->data, kit->data_dma);
685 cancel_delayed_work(&kit->do_notify);
686 cancel_delayed_work(&kit->do_resubmit);
688 for (i=0; i<kit->ifkit->outputs; i++)
689 device_remove_file(kit->dev, &dev_output_attrs[i]);
691 for (i=0; i<kit->ifkit->inputs; i++)
692 device_remove_file(kit->dev, &dev_input_attrs[i]);
694 for (i=0; i<kit->ifkit->sensors; i++)
695 device_remove_file(kit->dev, &dev_sensor_attrs[i]);
697 if (kit->ifkit->has_lcd) {
698 device_remove_file(kit->dev, &dev_attr_lcd);
699 remove_lcd_files(kit);
702 device_unregister(kit->dev);
704 dev_info(&interface->dev, "USB PhidgetInterfaceKit %d/%d/%d detached\n",
705 kit->ifkit->sensors, kit->ifkit->inputs, kit->ifkit->outputs);
707 usb_put_dev(kit->udev);
708 clear_bit(kit->dev_no, &device_no);
713 static struct usb_driver interfacekit_driver = {
714 .name = "phidgetkit",
715 .probe = interfacekit_probe,
716 .disconnect = interfacekit_disconnect,
720 static int __init interfacekit_init(void)
724 retval = usb_register(&interfacekit_driver);
726 err("usb_register failed. Error number %d", retval);
731 static void __exit interfacekit_exit(void)
733 usb_deregister(&interfacekit_driver);
736 module_init(interfacekit_init);
737 module_exit(interfacekit_exit);
739 MODULE_AUTHOR(DRIVER_AUTHOR);
740 MODULE_DESCRIPTION(DRIVER_DESC);
741 MODULE_LICENSE("GPL");