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 work_struct do_notify
;
85 struct work_struct 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
, struct pt_regs
*regs
)
305 struct interfacekit
*kit
= urb
->context
;
306 unsigned char *buffer
= kit
->data
;
307 int i
, level
, sensor
;
310 switch (urb
->status
) {
311 case 0: /* success */
313 case -ECONNRESET
: /* unlink */
317 /* -EPIPE: should clear the halt */
323 if (kit
->ifkit
->inputs
== 16) {
324 for (i
=0; i
< 8; i
++) {
325 level
= (buffer
[0] >> i
) & 1;
326 if (kit
->inputs
[i
] != level
) {
327 kit
->inputs
[i
] = level
;
328 set_bit(i
, &kit
->input_events
);
330 level
= (buffer
[1] >> i
) & 1;
331 if (kit
->inputs
[8 + i
] != level
) {
332 kit
->inputs
[8 + i
] = level
;
333 set_bit(8 + i
, &kit
->input_events
);
337 else if (kit
->ifkit
->inputs
== 8) {
338 for (i
=0; i
< 8; i
++) {
339 level
= (buffer
[1] >> i
) & 1;
340 if (kit
->inputs
[i
] != level
) {
341 kit
->inputs
[i
] = level
;
342 set_bit(i
, &kit
->input_events
);
348 if (kit
->ifkit
->sensors
) {
349 sensor
= (buffer
[0] & 1) ? 4 : 0;
351 level
= buffer
[2] + (buffer
[3] & 0x0f) * 256;
352 if (level
!= kit
->sensors
[sensor
]) {
353 kit
->sensors
[sensor
] = level
;
354 set_bit(sensor
, &kit
->sensor_events
);
357 level
= buffer
[4] + (buffer
[3] & 0xf0) * 16;
358 if (level
!= kit
->sensors
[sensor
]) {
359 kit
->sensors
[sensor
] = level
;
360 set_bit(sensor
, &kit
->sensor_events
);
363 level
= buffer
[5] + (buffer
[6] & 0x0f) * 256;
364 if (level
!= kit
->sensors
[sensor
]) {
365 kit
->sensors
[sensor
] = level
;
366 set_bit(sensor
, &kit
->sensor_events
);
369 level
= buffer
[7] + (buffer
[6] & 0xf0) * 16;
370 if (level
!= kit
->sensors
[sensor
]) {
371 kit
->sensors
[sensor
] = level
;
372 set_bit(sensor
, &kit
->sensor_events
);
376 if (kit
->input_events
|| kit
->sensor_events
)
377 schedule_work(&kit
->do_notify
);
380 status
= usb_submit_urb(urb
, SLAB_ATOMIC
);
382 err("can't resubmit intr, %s-%s/interfacekit0, status %d",
383 kit
->udev
->bus
->bus_name
,
384 kit
->udev
->devpath
, status
);
387 static void do_notify(void *data
)
389 struct interfacekit
*kit
= data
;
393 for (i
=0; i
<kit
->ifkit
->inputs
; i
++) {
394 if (test_and_clear_bit(i
, &kit
->input_events
)) {
395 sprintf(sysfs_file
, "input%d", i
+ 1);
396 sysfs_notify(&kit
->dev
->kobj
, NULL
, sysfs_file
);
400 for (i
=0; i
<kit
->ifkit
->sensors
; i
++) {
401 if (test_and_clear_bit(i
, &kit
->sensor_events
)) {
402 sprintf(sysfs_file
, "sensor%d", i
+ 1);
403 sysfs_notify(&kit
->dev
->kobj
, NULL
, sysfs_file
);
408 static void do_resubmit(void *data
)
413 #define show_set_output(value) \
414 static ssize_t set_output##value(struct device *dev, \
415 struct device_attribute *attr, \
416 const char *buf, size_t count) \
418 struct interfacekit *kit = dev_get_drvdata(dev); \
422 if (sscanf(buf, "%d", &enable) < 1) \
426 set_bit(value - 1, &kit->outputs); \
428 clear_bit(value - 1, &kit->outputs); \
430 retval = set_outputs(kit); \
432 return retval ? retval : count; \
435 static ssize_t show_output##value(struct device *dev, \
436 struct device_attribute *attr, \
439 struct interfacekit *kit = dev_get_drvdata(dev); \
441 return sprintf(buf, "%d\n", !!test_bit(value - 1, &kit->outputs));\
444 #define output_attr(value) \
445 __ATTR(output##value, S_IWUGO | S_IRUGO, \
446 show_output##value, set_output##value)
465 static struct device_attribute dev_output_attrs
[] = {
466 output_attr(1), output_attr(2), output_attr(3), output_attr(4),
467 output_attr(5), output_attr(6), output_attr(7), output_attr(8),
468 output_attr(9), output_attr(10), output_attr(11), output_attr(12),
469 output_attr(13), output_attr(14), output_attr(15), output_attr(16)
472 #define show_input(value) \
473 static ssize_t show_input##value(struct device *dev, \
474 struct device_attribute *attr, char *buf) \
476 struct interfacekit *kit = dev_get_drvdata(dev); \
478 return sprintf(buf, "%d\n", (int)kit->inputs[value - 1]); \
481 #define input_attr(value) \
482 __ATTR(input##value, S_IRUGO, show_input##value, NULL)
501 static struct device_attribute dev_input_attrs
[] = {
502 input_attr(1), input_attr(2), input_attr(3), input_attr(4),
503 input_attr(5), input_attr(6), input_attr(7), input_attr(8),
504 input_attr(9), input_attr(10), input_attr(11), input_attr(12),
505 input_attr(13), input_attr(14), input_attr(15), input_attr(16)
508 #define show_sensor(value) \
509 static ssize_t show_sensor##value(struct device *dev, \
510 struct device_attribute *attr, \
513 struct interfacekit *kit = dev_get_drvdata(dev); \
515 return sprintf(buf, "%d\n", (int)kit->sensors[value - 1]); \
518 #define sensor_attr(value) \
519 __ATTR(sensor##value, S_IRUGO, show_sensor##value, NULL)
530 static struct device_attribute dev_sensor_attrs
[] = {
531 sensor_attr(1), sensor_attr(2), sensor_attr(3), sensor_attr(4),
532 sensor_attr(5), sensor_attr(6), sensor_attr(7), sensor_attr(8)
535 static int interfacekit_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
537 struct usb_device
*dev
= interface_to_usbdev(intf
);
538 struct usb_host_interface
*interface
;
539 struct usb_endpoint_descriptor
*endpoint
;
540 struct interfacekit
*kit
;
541 struct driver_interfacekit
*ifkit
;
542 int pipe
, maxp
, rc
= -ENOMEM
;
545 ifkit
= (struct driver_interfacekit
*)id
->driver_info
;
549 interface
= intf
->cur_altsetting
;
550 if (interface
->desc
.bNumEndpoints
!= 1)
553 endpoint
= &interface
->endpoint
[0].desc
;
554 if (!(endpoint
->bEndpointAddress
& 0x80))
559 pipe
= usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
);
560 maxp
= usb_maxpacket(dev
, pipe
, usb_pipeout(pipe
));
562 kit
= kzalloc(sizeof(*kit
), GFP_KERNEL
);
568 kit
->data
= usb_buffer_alloc(dev
, URB_INT_SIZE
, SLAB_ATOMIC
, &kit
->data_dma
);
572 kit
->irq
= usb_alloc_urb(0, GFP_KERNEL
);
576 kit
->udev
= usb_get_dev(dev
);
578 INIT_WORK(&kit
->do_notify
, do_notify
, kit
);
579 INIT_WORK(&kit
->do_resubmit
, do_resubmit
, kit
);
580 usb_fill_int_urb(kit
->irq
, kit
->udev
, pipe
, kit
->data
,
581 maxp
> URB_INT_SIZE
? URB_INT_SIZE
: maxp
,
582 interfacekit_irq
, kit
, endpoint
->bInterval
);
583 kit
->irq
->transfer_dma
= kit
->data_dma
;
584 kit
->irq
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
586 usb_set_intfdata(intf
, kit
);
589 bit
= find_first_zero_bit(&device_no
, sizeof(device_no
));
590 value
= test_and_set_bit(bit
, &device_no
);
594 kit
->dev
= device_create(phidget_class
, &kit
->udev
->dev
, 0,
595 "interfacekit%d", kit
->dev_no
);
596 if (IS_ERR(kit
->dev
)) {
597 rc
= PTR_ERR(kit
->dev
);
601 dev_set_drvdata(kit
->dev
, kit
);
603 if (usb_submit_urb(kit
->irq
, GFP_KERNEL
)) {
608 for (i
=0; i
<ifkit
->outputs
; i
++ ) {
609 rc
= device_create_file(kit
->dev
, &dev_output_attrs
[i
]);
614 for (i
=0; i
<ifkit
->inputs
; i
++ ) {
615 rc
= device_create_file(kit
->dev
, &dev_input_attrs
[i
]);
620 for (i
=0; i
<ifkit
->sensors
; i
++ ) {
621 rc
= device_create_file(kit
->dev
, &dev_sensor_attrs
[i
]);
626 if (ifkit
->has_lcd
) {
627 rc
= device_create_file(kit
->dev
, &dev_attr_lcd
);
633 dev_info(&intf
->dev
, "USB PhidgetInterfaceKit %d/%d/%d attached\n",
634 ifkit
->sensors
, ifkit
->inputs
, ifkit
->outputs
);
640 device_remove_file(kit
->dev
, &dev_sensor_attrs
[i
]);
645 device_remove_file(kit
->dev
, &dev_input_attrs
[i
]);
650 device_remove_file(kit
->dev
, &dev_output_attrs
[i
]);
654 usb_free_urb(kit
->irq
);
656 usb_buffer_free(dev
, URB_INT_SIZE
, kit
->data
, kit
->data_dma
);
658 device_unregister(kit
->dev
);
659 if (kit
->dev_no
>= 0)
660 clear_bit(kit
->dev_no
, &device_no
);
668 static void interfacekit_disconnect(struct usb_interface
*interface
)
670 struct interfacekit
*kit
;
673 kit
= usb_get_intfdata(interface
);
674 usb_set_intfdata(interface
, NULL
);
678 usb_kill_urb(kit
->irq
);
679 usb_free_urb(kit
->irq
);
680 usb_buffer_free(kit
->udev
, URB_INT_SIZE
, kit
->data
, kit
->data_dma
);
682 cancel_delayed_work(&kit
->do_notify
);
683 cancel_delayed_work(&kit
->do_resubmit
);
685 for (i
=0; i
<kit
->ifkit
->outputs
; i
++)
686 device_remove_file(kit
->dev
, &dev_output_attrs
[i
]);
688 for (i
=0; i
<kit
->ifkit
->inputs
; i
++)
689 device_remove_file(kit
->dev
, &dev_input_attrs
[i
]);
691 for (i
=0; i
<kit
->ifkit
->sensors
; i
++)
692 device_remove_file(kit
->dev
, &dev_sensor_attrs
[i
]);
694 if (kit
->ifkit
->has_lcd
) {
695 device_remove_file(kit
->dev
, &dev_attr_lcd
);
696 remove_lcd_files(kit
);
699 device_unregister(kit
->dev
);
701 dev_info(&interface
->dev
, "USB PhidgetInterfaceKit %d/%d/%d detached\n",
702 kit
->ifkit
->sensors
, kit
->ifkit
->inputs
, kit
->ifkit
->outputs
);
704 usb_put_dev(kit
->udev
);
705 clear_bit(kit
->dev_no
, &device_no
);
710 static struct usb_driver interfacekit_driver
= {
711 .name
= "phidgetkit",
712 .probe
= interfacekit_probe
,
713 .disconnect
= interfacekit_disconnect
,
717 static int __init
interfacekit_init(void)
721 retval
= usb_register(&interfacekit_driver
);
723 err("usb_register failed. Error number %d", retval
);
728 static void __exit
interfacekit_exit(void)
730 usb_deregister(&interfacekit_driver
);
733 module_init(interfacekit_init
);
734 module_exit(interfacekit_exit
);
736 MODULE_AUTHOR(DRIVER_AUTHOR
);
737 MODULE_DESCRIPTION(DRIVER_DESC
);
738 MODULE_LICENSE("GPL");