2 * Symbol USB barcode to serial driver
4 * Copyright (C) 2009 Greg Kroah-Hartman <gregkh@suse.de>
5 * Copyright (C) 2009 Novell Inc.
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.
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>
24 static struct usb_device_id id_table[] = {
25 { USB_DEVICE(0x05e0, 0x0600) },
28 MODULE_DEVICE_TABLE(usb, id_table);
30 /* This structure holds all of the individual device information */
31 struct symbol_private {
32 struct usb_device *udev;
33 struct usb_serial *serial;
34 struct usb_serial_port *port;
35 unsigned char *int_buffer;
40 spinlock_t lock; /* protects the following flags */
42 bool actually_throttled;
46 static void symbol_int_callback(struct urb *urb)
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;
54 int available_room = 0;
57 dbg("%s - port %d", __func__, port->number);
66 /* this urb is terminated, clean up */
67 dbg("%s - urb shutting down with status: %d",
71 dbg("%s - nonzero urb status received: %d",
76 usb_serial_debug_data(debug, &port->dev, __func__, urb->actual_length,
79 if (urb->actual_length > 1) {
80 data_length = urb->actual_length - 1;
83 * Data from the device comes with a 1 byte header:
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.
90 tty = tty_port_tty_get(&port->port);
92 available_room = tty_buffer_request_room(tty,
95 tty_insert_flip_string(tty, &data[1],
97 tty_flip_buffer_push(tty);
102 dev_dbg(&priv->udev->dev,
103 "Improper ammount of data received from the device, "
104 "%d bytes", urb->actual_length);
108 spin_lock(&priv->lock);
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,
115 priv->int_buffer, priv->buffer_size,
116 symbol_int_callback, priv, priv->bInterval);
117 result = usb_submit_urb(priv->int_urb, GFP_ATOMIC);
120 "%s - failed resubmitting read urb, error %d\n",
123 priv->actually_throttled = true;
124 spin_unlock(&priv->lock);
127 static int symbol_open(struct tty_struct *tty, struct usb_serial_port *port,
130 struct symbol_private *priv = usb_get_serial_data(port->serial);
134 dbg("%s - port %d", __func__, port->number);
136 spin_lock_irqsave(&priv->lock, flags);
137 priv->throttled = false;
138 priv->actually_throttled = false;
140 spin_unlock_irqrestore(&priv->lock, flags);
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.
148 tty->low_latency = 1;
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);
158 "%s - failed resubmitting read urb, error %d\n",
163 static void symbol_close(struct tty_struct *tty, struct usb_serial_port *port,
166 struct symbol_private *priv = usb_get_serial_data(port->serial);
168 dbg("%s - port %d", __func__, port->number);
170 /* shutdown our urbs */
171 usb_kill_urb(priv->int_urb);
174 static void symbol_throttle(struct tty_struct *tty)
176 struct usb_serial_port *port = tty->driver_data;
177 struct symbol_private *priv = usb_get_serial_data(port->serial);
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);
186 static void symbol_unthrottle(struct tty_struct *tty)
188 struct usb_serial_port *port = tty->driver_data;
189 struct symbol_private *priv = usb_get_serial_data(port->serial);
193 dbg("%s - port %d", __func__, port->number);
195 spin_lock_irqsave(&priv->lock, flags);
196 priv->throttled = false;
197 priv->actually_throttled = false;
198 spin_unlock_irqrestore(&priv->lock, flags);
200 priv->int_urb->dev = port->serial->dev;
201 result = usb_submit_urb(priv->int_urb, GFP_ATOMIC);
204 "%s - failed submitting read urb, error %d\n",
208 static int symbol_ioctl(struct tty_struct *tty, struct file *file,
209 unsigned int cmd, unsigned long arg)
211 struct usb_serial_port *port = tty->driver_data;
212 struct device *dev = &port->dev;
215 * Right now we need to figure out what commands
216 * most userspace tools want to see for this driver,
217 * so just log the things.
221 dev_info(dev, "%s: TIOCSERGETLSR\n", __func__);
225 dev_info(dev, "%s: TIOCGSERIAL\n", __func__);
229 dev_info(dev, "%s: TIOCMIWAIT\n", __func__);
233 dev_info(dev, "%s: TIOCGICOUNT\n", __func__);
236 dev_info(dev, "%s: unknown (%d)\n", __func__, cmd);
241 static int symbol_tiocmget(struct tty_struct *tty, struct file *file)
243 struct usb_serial_port *port = tty->driver_data;
244 struct device *dev = &port->dev;
247 /* probably just need to shadow whatever was sent to us here */
248 dev_info(dev, "%s\n", __func__);
252 static int symbol_tiocmset(struct tty_struct *tty, struct file *file,
253 unsigned int set, unsigned int clear)
255 struct usb_serial_port *port = tty->driver_data;
256 struct device *dev = &port->dev;
259 /* probably just need to shadow whatever was sent to us here */
260 dev_info(dev, "%s\n", __func__);
264 static int symbol_startup(struct usb_serial *serial)
266 struct symbol_private *priv;
267 struct usb_host_interface *intf;
269 int retval = -ENOMEM;
270 bool int_in_found = false;
272 /* create our private serial structure */
273 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
275 dev_err(&serial->dev->dev, "%s - Out of memory\n", __func__);
278 spin_lock_init(&priv->lock);
279 priv->serial = serial;
280 priv->port = serial->port[0];
281 priv->udev = serial->dev;
283 /* find our interrupt endpoint */
284 intf = serial->interface->altsetting;
285 for (i = 0; i < intf->desc.bNumEndpoints; ++i) {
286 struct usb_endpoint_descriptor *endpoint;
288 endpoint = &intf->endpoint[i].desc;
289 if (!usb_endpoint_is_int_in(endpoint))
292 priv->int_urb = usb_alloc_urb(0, GFP_KERNEL);
293 if (!priv->int_urb) {
294 dev_err(&priv->udev->dev, "out of memory\n");
298 priv->buffer_size = le16_to_cpu(endpoint->wMaxPacketSize) * 2;
299 priv->int_buffer = kmalloc(priv->buffer_size, GFP_KERNEL);
300 if (!priv->int_buffer) {
301 dev_err(&priv->udev->dev, "out of memory\n");
305 priv->int_address = endpoint->bEndpointAddress;
306 priv->bInterval = endpoint->bInterval;
308 /* set up our int urb */
309 usb_fill_int_urb(priv->int_urb, priv->udev,
310 usb_rcvintpipe(priv->udev,
311 endpoint->bEndpointAddress),
312 priv->int_buffer, priv->buffer_size,
313 symbol_int_callback, priv, priv->bInterval);
320 dev_err(&priv->udev->dev,
321 "Error - the proper endpoints were not found!\n");
325 usb_set_serial_data(serial, priv);
329 usb_free_urb(priv->int_urb);
330 kfree(priv->int_buffer);
335 static void symbol_shutdown(struct usb_serial *serial)
337 struct symbol_private *priv = usb_get_serial_data(serial);
341 usb_kill_urb(priv->int_urb);
342 usb_free_urb(priv->int_urb);
343 kfree(priv->int_buffer);
345 usb_set_serial_data(serial, NULL);
348 static struct usb_driver symbol_driver = {
350 .probe = usb_serial_probe,
351 .disconnect = usb_serial_disconnect,
352 .id_table = id_table,
356 static struct usb_serial_driver symbol_device = {
358 .owner = THIS_MODULE,
361 .id_table = id_table,
362 .usb_driver = &symbol_driver,
364 .attach = symbol_startup,
366 .close = symbol_close,
367 .shutdown = symbol_shutdown,
368 .throttle = symbol_throttle,
369 .unthrottle = symbol_unthrottle,
370 .ioctl = symbol_ioctl,
371 .tiocmget = symbol_tiocmget,
372 .tiocmset = symbol_tiocmset,
375 static int __init symbol_init(void)
379 retval = usb_serial_register(&symbol_device);
382 retval = usb_register(&symbol_driver);
384 usb_serial_deregister(&symbol_device);
388 static void __exit symbol_exit(void)
390 usb_deregister(&symbol_driver);
391 usb_serial_deregister(&symbol_device);
394 module_init(symbol_init);
395 module_exit(symbol_exit);
396 MODULE_LICENSE("GPL");
398 module_param(debug, bool, S_IRUGO | S_IWUSR);
399 MODULE_PARM_DESC(debug, "Debug enabled or not");