aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/usb/serial
diff options
context:
space:
mode:
authorGreg Kroah-Hartman <gregkh@suse.de>2009-02-13 20:25:46 -0500
committerGreg Kroah-Hartman <gregkh@suse.de>2009-03-24 19:20:32 -0400
commit68b44eaed5def7b6490c23c3e88c6f2ccec57beb (patch)
tree202bd8e581a237ff490ccb18dfc593b36bc9a272 /drivers/usb/serial
parentf7e7aa5850839faa5eb7c7c177da5fd6bca8949b (diff)
USB: serial: add symbol serial driver
This is for the Symbol 6608 barcode scanner in a fake "HID" mode. Thanks to Dalibor Grgec for working with me to get this to start to work properly. Cc: Dalibor Grgec <dalibor.grgec@zemris.fer.hr> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'drivers/usb/serial')
-rw-r--r--drivers/usb/serial/Kconfig9
-rw-r--r--drivers/usb/serial/Makefile1
-rw-r--r--drivers/usb/serial/symbolserial.c340
3 files changed, 350 insertions, 0 deletions
diff --git a/drivers/usb/serial/Kconfig b/drivers/usb/serial/Kconfig
index b361f05cafac..dbc0781a4163 100644
--- a/drivers/usb/serial/Kconfig
+++ b/drivers/usb/serial/Kconfig
@@ -515,6 +515,15 @@ config USB_SERIAL_SIERRAWIRELESS
515 To compile this driver as a module, choose M here: the 515 To compile this driver as a module, choose M here: the
516 module will be called sierra. 516 module will be called sierra.
517 517
518config USB_SERIAL_SYMBOL
519 tristate "USB Symbol Barcode driver (serial mode)"
520 help
521 Say Y here if you want to use a Symbol USB Barcode device
522 in serial emulation mode.
523
524 To compile this driver as a module, choose M here: the
525 module will be called symbolserial.
526
518config USB_SERIAL_TI 527config USB_SERIAL_TI
519 tristate "USB TI 3410/5052 Serial Driver" 528 tristate "USB TI 3410/5052 Serial Driver"
520 help 529 help
diff --git a/drivers/usb/serial/Makefile b/drivers/usb/serial/Makefile
index b75be91eb8f1..222939739ffe 100644
--- a/drivers/usb/serial/Makefile
+++ b/drivers/usb/serial/Makefile
@@ -49,6 +49,7 @@ obj-$(CONFIG_USB_SERIAL_SAFE) += safe_serial.o
49obj-$(CONFIG_USB_SERIAL_SIEMENS_MPI) += siemens_mpi.o 49obj-$(CONFIG_USB_SERIAL_SIEMENS_MPI) += siemens_mpi.o
50obj-$(CONFIG_USB_SERIAL_SIERRAWIRELESS) += sierra.o 50obj-$(CONFIG_USB_SERIAL_SIERRAWIRELESS) += sierra.o
51obj-$(CONFIG_USB_SERIAL_SPCP8X5) += spcp8x5.o 51obj-$(CONFIG_USB_SERIAL_SPCP8X5) += spcp8x5.o
52obj-$(CONFIG_USB_SERIAL_SYMBOL) += symbolserial.o
52obj-$(CONFIG_USB_SERIAL_TI) += ti_usb_3410_5052.o 53obj-$(CONFIG_USB_SERIAL_TI) += ti_usb_3410_5052.o
53obj-$(CONFIG_USB_SERIAL_VISOR) += visor.o 54obj-$(CONFIG_USB_SERIAL_VISOR) += visor.o
54obj-$(CONFIG_USB_SERIAL_WHITEHEAT) += whiteheat.o 55obj-$(CONFIG_USB_SERIAL_WHITEHEAT) += whiteheat.o
diff --git a/drivers/usb/serial/symbolserial.c b/drivers/usb/serial/symbolserial.c
new file mode 100644
index 000000000000..c5990fd88e2c
--- /dev/null
+++ b/drivers/usb/serial/symbolserial.c
@@ -0,0 +1,340 @@
1/*
2 * Symbol USB barcode to serial driver
3 *
4 * Copyright (C) 2009 Greg Kroah-Hartman <gregkh@suse.de>
5 * Copyright (C) 2009 Novell Inc.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
10 */
11
12#include <linux/kernel.h>
13#include <linux/init.h>
14#include <linux/tty.h>
15#include <linux/tty_driver.h>
16#include <linux/tty_flip.h>
17#include <linux/module.h>
18#include <linux/usb.h>
19#include <linux/usb/serial.h>
20#include <linux/uaccess.h>
21
22static int debug;
23
24static struct usb_device_id id_table[] = {
25 { USB_DEVICE(0x05e0, 0x0600) },
26 { },
27};
28MODULE_DEVICE_TABLE(usb, id_table);
29
30/* This structure holds all of the individual device information */
31struct symbol_private {
32 struct usb_device *udev;
33 struct usb_serial *serial;
34 struct usb_serial_port *port;
35 unsigned char *int_buffer;
36 struct urb *int_urb;
37 int buffer_size;
38 u8 bInterval;
39 u8 int_address;
40 spinlock_t lock; /* protects the following flags */
41 bool throttled;
42 bool actually_throttled;
43 bool rts;
44};
45
46static void symbol_int_callback(struct urb *urb)
47{
48 struct symbol_private *priv = urb->context;
49 unsigned char *data = urb->transfer_buffer;
50 struct usb_serial_port *port = priv->port;
51 int status = urb->status;
52 struct tty_struct *tty;
53 int result;
54 int available_room = 0;
55 int data_length;
56
57 dbg("%s - port %d", __func__, port->number);
58
59 switch (status) {
60 case 0:
61 /* success */
62 break;
63 case -ECONNRESET:
64 case -ENOENT:
65 case -ESHUTDOWN:
66 /* this urb is terminated, clean up */
67 dbg("%s - urb shutting down with status: %d",
68 __func__, status);
69 return;
70 default:
71 dbg("%s - nonzero urb status received: %d",
72 __func__, status);
73 goto exit;
74 }
75
76 usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length,
77 data);
78
79 if (urb->actual_length > 1) {
80 data_length = urb->actual_length - 1;
81
82 /*
83 * Data from the device comes with a 1 byte header:
84 *
85 * <size of data>data...
86 * This is real data to be sent to the tty layer
87 * we pretty much just ignore the size and send everything
88 * else to the tty layer.
89 */
90 tty = tty_port_tty_get(&port->port);
91 if (tty) {
92 available_room = tty_buffer_request_room(tty,
93 data_length);
94 if (available_room) {
95 tty_insert_flip_string(tty, &data[1],
96 available_room);
97 tty_flip_buffer_push(tty);
98 }
99 tty_kref_put(tty);
100 }
101 } else {
102 dev_dbg(&priv->udev->dev,
103 "Improper ammount of data received from the device, "
104 "%d bytes", urb->actual_length);
105 }
106
107exit:
108 spin_lock(&priv->lock);
109
110 /* Continue trying to always read if we should */
111 if (!priv->throttled) {
112 usb_fill_int_urb(priv->int_urb, priv->udev,
113 usb_rcvintpipe(priv->udev,
114 priv->int_address),
115 priv->int_buffer, priv->buffer_size,
116 symbol_int_callback, priv, priv->bInterval);
117 result = usb_submit_urb(priv->int_urb, GFP_ATOMIC);
118 if (result)
119 dev_err(&port->dev,
120 "%s - failed resubmitting read urb, error %d\n",
121 __func__, result);
122 } else
123 priv->actually_throttled = true;
124 spin_unlock(&priv->lock);
125}
126
127static int symbol_open(struct tty_struct *tty, struct usb_serial_port *port,
128 struct file *filp)
129{
130 struct symbol_private *priv = usb_get_serial_data(port->serial);
131 unsigned long flags;
132 int result = 0;
133
134 dbg("%s - port %d", __func__, port->number);
135
136 spin_lock_irqsave(&priv->lock, flags);
137 priv->throttled = false;
138 priv->actually_throttled = false;
139 priv->port = port;
140 spin_unlock_irqrestore(&priv->lock, flags);
141
142 /*
143 * Force low_latency on so that our tty_push actually forces the data
144 * through, otherwise it is scheduled, and with high data rates (like
145 * with OHCI) data can get lost.
146 */
147 if (tty)
148 tty->low_latency = 1;
149
150 /* Start reading from the device */
151 usb_fill_int_urb(priv->int_urb, priv->udev,
152 usb_rcvintpipe(priv->udev, priv->int_address),
153 priv->int_buffer, priv->buffer_size,
154 symbol_int_callback, priv, priv->bInterval);
155 result = usb_submit_urb(priv->int_urb, GFP_KERNEL);
156 if (result)
157 dev_err(&port->dev,
158 "%s - failed resubmitting read urb, error %d\n",
159 __func__, result);
160 return result;
161}
162
163static void symbol_close(struct tty_struct *tty, struct usb_serial_port *port,
164 struct file *filp)
165{
166 struct symbol_private *priv = usb_get_serial_data(port->serial);
167
168 dbg("%s - port %d", __func__, port->number);
169
170 /* shutdown our urbs */
171 usb_kill_urb(priv->int_urb);
172}
173
174static void symbol_throttle(struct tty_struct *tty)
175{
176 struct usb_serial_port *port = tty->driver_data;
177 struct symbol_private *priv = usb_get_serial_data(port->serial);
178 unsigned long flags;
179
180 dbg("%s - port %d", __func__, port->number);
181 spin_lock_irqsave(&priv->lock, flags);
182 priv->throttled = true;
183 spin_unlock_irqrestore(&priv->lock, flags);
184}
185
186static void symbol_unthrottle(struct tty_struct *tty)
187{
188 struct usb_serial_port *port = tty->driver_data;
189 struct symbol_private *priv = usb_get_serial_data(port->serial);
190 unsigned long flags;
191 int result;
192
193 dbg("%s - port %d", __func__, port->number);
194
195 spin_lock_irqsave(&priv->lock, flags);
196 priv->throttled = false;
197 priv->actually_throttled = false;
198 spin_unlock_irqrestore(&priv->lock, flags);
199
200 priv->int_urb->dev = port->serial->dev;
201 result = usb_submit_urb(priv->int_urb, GFP_ATOMIC);
202 if (result)
203 dev_err(&port->dev,
204 "%s - failed submitting read urb, error %d\n",
205 __func__, result);
206}
207
208static int symbol_startup(struct usb_serial *serial)
209{
210 struct symbol_private *priv;
211 struct usb_host_interface *intf;
212 int i;
213 int retval = -ENOMEM;
214 bool int_in_found = false;
215
216 /* create our private serial structure */
217 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
218 if (priv == NULL) {
219 dev_err(&serial->dev->dev, "%s - Out of memory\n", __func__);
220 return -ENOMEM;
221 }
222 spin_lock_init(&priv->lock);
223 priv->serial = serial;
224 priv->port = serial->port[0];
225 priv->udev = serial->dev;
226
227 /* find our interrupt endpoint */
228 intf = serial->interface->altsetting;
229 for (i = 0; i < intf->desc.bNumEndpoints; ++i) {
230 struct usb_endpoint_descriptor *endpoint;
231
232 endpoint = &intf->endpoint[i].desc;
233 if (!usb_endpoint_is_int_in(endpoint))
234 continue;
235
236 priv->int_urb = usb_alloc_urb(0, GFP_KERNEL);
237 if (!priv->int_urb) {
238 dev_err(&priv->udev->dev, "out of memory\n");
239 goto error;
240 }
241
242 priv->buffer_size = le16_to_cpu(endpoint->wMaxPacketSize) * 2;
243 priv->int_buffer = kmalloc(priv->buffer_size, GFP_KERNEL);
244 if (!priv->int_buffer) {
245 dev_err(&priv->udev->dev, "out of memory\n");
246 goto error;
247 }
248
249 priv->int_address = endpoint->bEndpointAddress;
250 priv->bInterval = endpoint->bInterval;
251
252 /* set up our int urb */
253 usb_fill_int_urb(priv->int_urb, priv->udev,
254 usb_rcvintpipe(priv->udev,
255 endpoint->bEndpointAddress),
256 priv->int_buffer, priv->buffer_size,
257 symbol_int_callback, priv, priv->bInterval);
258
259 int_in_found = true;
260 break;
261 }
262
263 if (!int_in_found) {
264 dev_err(&priv->udev->dev,
265 "Error - the proper endpoints were not found!\n");
266 goto error;
267 }
268
269 usb_set_serial_data(serial, priv);
270 return 0;
271
272error:
273 usb_free_urb(priv->int_urb);
274 kfree(priv->int_buffer);
275 kfree(priv);
276 return retval;
277}
278
279static void symbol_shutdown(struct usb_serial *serial)
280{
281 struct symbol_private *priv = usb_get_serial_data(serial);
282
283 dbg("%s", __func__);
284
285 usb_kill_urb(priv->int_urb);
286 usb_free_urb(priv->int_urb);
287 kfree(priv->int_buffer);
288 kfree(priv);
289 usb_set_serial_data(serial, NULL);
290}
291
292static struct usb_driver symbol_driver = {
293 .name = "symbol",
294 .probe = usb_serial_probe,
295 .disconnect = usb_serial_disconnect,
296 .id_table = id_table,
297 .no_dynamic_id = 1,
298};
299
300static struct usb_serial_driver symbol_device = {
301 .driver = {
302 .owner = THIS_MODULE,
303 .name = "symbol",
304 },
305 .id_table = id_table,
306 .usb_driver = &symbol_driver,
307 .num_ports = 1,
308 .attach = symbol_startup,
309 .open = symbol_open,
310 .close = symbol_close,
311 .shutdown = symbol_shutdown,
312 .throttle = symbol_throttle,
313 .unthrottle = symbol_unthrottle,
314};
315
316static int __init symbol_init(void)
317{
318 int retval;
319
320 retval = usb_serial_register(&symbol_device);
321 if (retval)
322 return retval;
323 retval = usb_register(&symbol_driver);
324 if (retval)
325 usb_serial_deregister(&symbol_device);
326 return retval;
327}
328
329static void __exit symbol_exit(void)
330{
331 usb_deregister(&symbol_driver);
332 usb_serial_deregister(&symbol_device);
333}
334
335module_init(symbol_init);
336module_exit(symbol_exit);
337MODULE_LICENSE("GPL");
338
339module_param(debug, bool, S_IRUGO | S_IWUSR);
340MODULE_PARM_DESC(debug, "Debug enabled or not");