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 const 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
;
56 dbg("%s - port %d", __func__
, port
->number
);
65 /* this urb is terminated, clean up */
66 dbg("%s - urb shutting down with status: %d",
70 dbg("%s - nonzero urb status received: %d",
75 usb_serial_debug_data(debug
, &port
->dev
, __func__
, urb
->actual_length
,
78 if (urb
->actual_length
> 1) {
79 data_length
= urb
->actual_length
- 1;
82 * Data from the device comes with a 1 byte header:
84 * <size of data>data...
85 * This is real data to be sent to the tty layer
86 * we pretty much just ignore the size and send everything
87 * else to the tty layer.
89 tty
= tty_port_tty_get(&port
->port
);
91 tty_insert_flip_string(tty
, &data
[1], data_length
);
92 tty_flip_buffer_push(tty
);
96 dev_dbg(&priv
->udev
->dev
,
97 "Improper amount of data received from the device, "
98 "%d bytes", urb
->actual_length
);
102 spin_lock(&priv
->lock
);
104 /* Continue trying to always read if we should */
105 if (!priv
->throttled
) {
106 usb_fill_int_urb(priv
->int_urb
, priv
->udev
,
107 usb_rcvintpipe(priv
->udev
,
109 priv
->int_buffer
, priv
->buffer_size
,
110 symbol_int_callback
, priv
, priv
->bInterval
);
111 result
= usb_submit_urb(priv
->int_urb
, GFP_ATOMIC
);
114 "%s - failed resubmitting read urb, error %d\n",
117 priv
->actually_throttled
= true;
118 spin_unlock(&priv
->lock
);
121 static int symbol_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
123 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
127 dbg("%s - port %d", __func__
, port
->number
);
129 spin_lock_irqsave(&priv
->lock
, flags
);
130 priv
->throttled
= false;
131 priv
->actually_throttled
= false;
133 spin_unlock_irqrestore(&priv
->lock
, flags
);
135 /* Start reading from the device */
136 usb_fill_int_urb(priv
->int_urb
, priv
->udev
,
137 usb_rcvintpipe(priv
->udev
, priv
->int_address
),
138 priv
->int_buffer
, priv
->buffer_size
,
139 symbol_int_callback
, priv
, priv
->bInterval
);
140 result
= usb_submit_urb(priv
->int_urb
, GFP_KERNEL
);
143 "%s - failed resubmitting read urb, error %d\n",
148 static void symbol_close(struct usb_serial_port
*port
)
150 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
152 dbg("%s - port %d", __func__
, port
->number
);
154 /* shutdown our urbs */
155 usb_kill_urb(priv
->int_urb
);
158 static void symbol_throttle(struct tty_struct
*tty
)
160 struct usb_serial_port
*port
= tty
->driver_data
;
161 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
163 dbg("%s - port %d", __func__
, port
->number
);
164 spin_lock_irq(&priv
->lock
);
165 priv
->throttled
= true;
166 spin_unlock_irq(&priv
->lock
);
169 static void symbol_unthrottle(struct tty_struct
*tty
)
171 struct usb_serial_port
*port
= tty
->driver_data
;
172 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
176 dbg("%s - port %d", __func__
, port
->number
);
178 spin_lock_irq(&priv
->lock
);
179 priv
->throttled
= false;
180 was_throttled
= priv
->actually_throttled
;
181 priv
->actually_throttled
= false;
182 spin_unlock_irq(&priv
->lock
);
184 priv
->int_urb
->dev
= port
->serial
->dev
;
186 result
= usb_submit_urb(priv
->int_urb
, GFP_KERNEL
);
189 "%s - failed submitting read urb, error %d\n",
194 static int symbol_startup(struct usb_serial
*serial
)
196 struct symbol_private
*priv
;
197 struct usb_host_interface
*intf
;
199 int retval
= -ENOMEM
;
200 bool int_in_found
= false;
202 /* create our private serial structure */
203 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
205 dev_err(&serial
->dev
->dev
, "%s - Out of memory\n", __func__
);
208 spin_lock_init(&priv
->lock
);
209 priv
->serial
= serial
;
210 priv
->port
= serial
->port
[0];
211 priv
->udev
= serial
->dev
;
213 /* find our interrupt endpoint */
214 intf
= serial
->interface
->altsetting
;
215 for (i
= 0; i
< intf
->desc
.bNumEndpoints
; ++i
) {
216 struct usb_endpoint_descriptor
*endpoint
;
218 endpoint
= &intf
->endpoint
[i
].desc
;
219 if (!usb_endpoint_is_int_in(endpoint
))
222 priv
->int_urb
= usb_alloc_urb(0, GFP_KERNEL
);
223 if (!priv
->int_urb
) {
224 dev_err(&priv
->udev
->dev
, "out of memory\n");
228 priv
->buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
) * 2;
229 priv
->int_buffer
= kmalloc(priv
->buffer_size
, GFP_KERNEL
);
230 if (!priv
->int_buffer
) {
231 dev_err(&priv
->udev
->dev
, "out of memory\n");
235 priv
->int_address
= endpoint
->bEndpointAddress
;
236 priv
->bInterval
= endpoint
->bInterval
;
238 /* set up our int urb */
239 usb_fill_int_urb(priv
->int_urb
, priv
->udev
,
240 usb_rcvintpipe(priv
->udev
,
241 endpoint
->bEndpointAddress
),
242 priv
->int_buffer
, priv
->buffer_size
,
243 symbol_int_callback
, priv
, priv
->bInterval
);
250 dev_err(&priv
->udev
->dev
,
251 "Error - the proper endpoints were not found!\n");
255 usb_set_serial_data(serial
, priv
);
259 usb_free_urb(priv
->int_urb
);
260 kfree(priv
->int_buffer
);
265 static void symbol_disconnect(struct usb_serial
*serial
)
267 struct symbol_private
*priv
= usb_get_serial_data(serial
);
271 usb_kill_urb(priv
->int_urb
);
272 usb_free_urb(priv
->int_urb
);
275 static void symbol_release(struct usb_serial
*serial
)
277 struct symbol_private
*priv
= usb_get_serial_data(serial
);
281 kfree(priv
->int_buffer
);
285 static struct usb_driver symbol_driver
= {
287 .probe
= usb_serial_probe
,
288 .disconnect
= usb_serial_disconnect
,
289 .id_table
= id_table
,
293 static struct usb_serial_driver symbol_device
= {
295 .owner
= THIS_MODULE
,
298 .id_table
= id_table
,
299 .usb_driver
= &symbol_driver
,
301 .attach
= symbol_startup
,
303 .close
= symbol_close
,
304 .disconnect
= symbol_disconnect
,
305 .release
= symbol_release
,
306 .throttle
= symbol_throttle
,
307 .unthrottle
= symbol_unthrottle
,
310 static int __init
symbol_init(void)
314 retval
= usb_serial_register(&symbol_device
);
317 retval
= usb_register(&symbol_driver
);
319 usb_serial_deregister(&symbol_device
);
323 static void __exit
symbol_exit(void)
325 usb_deregister(&symbol_driver
);
326 usb_serial_deregister(&symbol_device
);
329 module_init(symbol_init
);
330 module_exit(symbol_exit
);
331 MODULE_LICENSE("GPL");
333 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
334 MODULE_PARM_DESC(debug
, "Debug enabled or not");