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
);
142 /* Start reading from the device */
143 usb_fill_int_urb(priv
->int_urb
, priv
->udev
,
144 usb_rcvintpipe(priv
->udev
, priv
->int_address
),
145 priv
->int_buffer
, priv
->buffer_size
,
146 symbol_int_callback
, priv
, priv
->bInterval
);
147 result
= usb_submit_urb(priv
->int_urb
, GFP_KERNEL
);
150 "%s - failed resubmitting read urb, error %d\n",
155 static void symbol_close(struct tty_struct
*tty
, struct usb_serial_port
*port
,
158 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
160 dbg("%s - port %d", __func__
, port
->number
);
162 /* shutdown our urbs */
163 usb_kill_urb(priv
->int_urb
);
166 static void symbol_throttle(struct tty_struct
*tty
)
168 struct usb_serial_port
*port
= tty
->driver_data
;
169 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
172 dbg("%s - port %d", __func__
, port
->number
);
173 spin_lock_irqsave(&priv
->lock
, flags
);
174 priv
->throttled
= true;
175 spin_unlock_irqrestore(&priv
->lock
, flags
);
178 static void symbol_unthrottle(struct tty_struct
*tty
)
180 struct usb_serial_port
*port
= tty
->driver_data
;
181 struct symbol_private
*priv
= usb_get_serial_data(port
->serial
);
185 dbg("%s - port %d", __func__
, port
->number
);
187 spin_lock_irqsave(&priv
->lock
, flags
);
188 priv
->throttled
= false;
189 priv
->actually_throttled
= false;
190 spin_unlock_irqrestore(&priv
->lock
, flags
);
192 priv
->int_urb
->dev
= port
->serial
->dev
;
193 result
= usb_submit_urb(priv
->int_urb
, GFP_ATOMIC
);
196 "%s - failed submitting read urb, error %d\n",
200 static int symbol_startup(struct usb_serial
*serial
)
202 struct symbol_private
*priv
;
203 struct usb_host_interface
*intf
;
205 int retval
= -ENOMEM
;
206 bool int_in_found
= false;
208 /* create our private serial structure */
209 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
211 dev_err(&serial
->dev
->dev
, "%s - Out of memory\n", __func__
);
214 spin_lock_init(&priv
->lock
);
215 priv
->serial
= serial
;
216 priv
->port
= serial
->port
[0];
217 priv
->udev
= serial
->dev
;
219 /* find our interrupt endpoint */
220 intf
= serial
->interface
->altsetting
;
221 for (i
= 0; i
< intf
->desc
.bNumEndpoints
; ++i
) {
222 struct usb_endpoint_descriptor
*endpoint
;
224 endpoint
= &intf
->endpoint
[i
].desc
;
225 if (!usb_endpoint_is_int_in(endpoint
))
228 priv
->int_urb
= usb_alloc_urb(0, GFP_KERNEL
);
229 if (!priv
->int_urb
) {
230 dev_err(&priv
->udev
->dev
, "out of memory\n");
234 priv
->buffer_size
= le16_to_cpu(endpoint
->wMaxPacketSize
) * 2;
235 priv
->int_buffer
= kmalloc(priv
->buffer_size
, GFP_KERNEL
);
236 if (!priv
->int_buffer
) {
237 dev_err(&priv
->udev
->dev
, "out of memory\n");
241 priv
->int_address
= endpoint
->bEndpointAddress
;
242 priv
->bInterval
= endpoint
->bInterval
;
244 /* set up our int urb */
245 usb_fill_int_urb(priv
->int_urb
, priv
->udev
,
246 usb_rcvintpipe(priv
->udev
,
247 endpoint
->bEndpointAddress
),
248 priv
->int_buffer
, priv
->buffer_size
,
249 symbol_int_callback
, priv
, priv
->bInterval
);
256 dev_err(&priv
->udev
->dev
,
257 "Error - the proper endpoints were not found!\n");
261 usb_set_serial_data(serial
, priv
);
265 usb_free_urb(priv
->int_urb
);
266 kfree(priv
->int_buffer
);
271 static void symbol_shutdown(struct usb_serial
*serial
)
273 struct symbol_private
*priv
= usb_get_serial_data(serial
);
277 usb_kill_urb(priv
->int_urb
);
278 usb_free_urb(priv
->int_urb
);
279 kfree(priv
->int_buffer
);
281 usb_set_serial_data(serial
, NULL
);
284 static struct usb_driver symbol_driver
= {
286 .probe
= usb_serial_probe
,
287 .disconnect
= usb_serial_disconnect
,
288 .id_table
= id_table
,
292 static struct usb_serial_driver symbol_device
= {
294 .owner
= THIS_MODULE
,
297 .id_table
= id_table
,
298 .usb_driver
= &symbol_driver
,
300 .attach
= symbol_startup
,
302 .close
= symbol_close
,
303 .shutdown
= symbol_shutdown
,
304 .throttle
= symbol_throttle
,
305 .unthrottle
= symbol_unthrottle
,
308 static int __init
symbol_init(void)
312 retval
= usb_serial_register(&symbol_device
);
315 retval
= usb_register(&symbol_driver
);
317 usb_serial_deregister(&symbol_device
);
321 static void __exit
symbol_exit(void)
323 usb_deregister(&symbol_driver
);
324 usb_serial_deregister(&symbol_device
);
327 module_init(symbol_init
);
328 module_exit(symbol_exit
);
329 MODULE_LICENSE("GPL");
331 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
332 MODULE_PARM_DESC(debug
, "Debug enabled or not");