2 Some of this code is credited to Linux USB open source files that are
3 distributed with Linux.
5 Copyright: 2007 Metrologic Instruments. All rights reserved.
6 Copyright: 2011 Azimut Ltd. <http://azimutrzn.ru/>
9 #include <linux/kernel.h>
10 #include <linux/init.h>
11 #include <linux/tty.h>
12 #include <linux/module.h>
13 #include <linux/usb.h>
14 #include <linux/errno.h>
15 #include <linux/slab.h>
16 #include <linux/tty_driver.h>
17 #include <linux/tty_flip.h>
18 #include <linux/moduleparam.h>
19 #include <linux/spinlock.h>
20 #include <linux/uaccess.h>
21 #include <linux/usb/serial.h>
23 /* Version Information */
24 #define DRIVER_VERSION "v1.2.0.0"
25 #define DRIVER_DESC "Metrologic Instruments Inc. - USB-POS driver"
27 /* Product information. */
28 #define FOCUS_VENDOR_ID 0x0C2E
29 #define FOCUS_PRODUCT_ID_BI 0x0720
30 #define FOCUS_PRODUCT_ID_UNI 0x0700
32 #define METROUSB_SET_REQUEST_TYPE 0x40
33 #define METROUSB_SET_MODEM_CTRL_REQUEST 10
34 #define METROUSB_SET_BREAK_REQUEST 0x40
35 #define METROUSB_MCR_NONE 0x08 /* Deactivate DTR and RTS. */
36 #define METROUSB_MCR_RTS 0x0a /* Activate RTS. */
37 #define METROUSB_MCR_DTR 0x09 /* Activate DTR. */
38 #define WDR_TIMEOUT 5000 /* default urb timeout. */
40 /* Private data structure. */
41 struct metrousb_private {
44 unsigned long control_state;
47 /* Device table list. */
48 static struct usb_device_id id_table[] = {
49 { USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_BI) },
50 { USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_UNI) },
51 { }, /* Terminating entry. */
53 MODULE_DEVICE_TABLE(usb, id_table);
55 /* UNI-Directional mode commands for device configure */
56 #define UNI_CMD_OPEN 0x80
57 #define UNI_CMD_CLOSE 0xFF
59 inline int metrousb_is_unidirectional_mode(struct usb_serial_port *port)
61 __u16 product_id = le16_to_cpu(
62 port->serial->dev->descriptor.idProduct);
64 return product_id == FOCUS_PRODUCT_ID_UNI;
67 static int metrousb_send_unidirectional_cmd(u8 cmd, struct usb_serial_port *port)
71 u8 *buffer_cmd = NULL;
73 if (!metrousb_is_unidirectional_mode(port))
76 buffer_cmd = kzalloc(sizeof(cmd), GFP_KERNEL);
82 ret = usb_interrupt_msg(port->serial->dev,
83 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
84 buffer_cmd, sizeof(cmd),
85 &actual_len, USB_CTRL_SET_TIMEOUT);
91 else if (actual_len != sizeof(cmd))
96 static void metrousb_read_int_callback(struct urb *urb)
98 struct usb_serial_port *port = urb->context;
99 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
100 struct tty_struct *tty;
101 unsigned char *data = urb->transfer_buffer;
104 unsigned long flags = 0;
106 dev_dbg(&port->dev, "%s\n", __func__);
108 switch (urb->status) {
110 /* Success status, read from the port. */
115 /* urb has been terminated. */
117 "%s - urb shutting down, error code=%d\n",
118 __func__, urb->status);
122 "%s - non-zero urb received, error code=%d\n",
123 __func__, urb->status);
128 /* Set the data read from the usb port into the serial port buffer. */
129 tty = tty_port_tty_get(&port->port);
130 if (tty && urb->actual_length) {
131 /* Loop through the data copying each byte to the tty layer. */
132 tty_insert_flip_string(tty, data, urb->actual_length);
134 /* Force the data to the tty layer. */
135 tty_flip_buffer_push(tty);
139 /* Set any port variables. */
140 spin_lock_irqsave(&metro_priv->lock, flags);
141 throttled = metro_priv->throttled;
142 spin_unlock_irqrestore(&metro_priv->lock, flags);
144 /* Continue trying to read if set. */
146 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
147 usb_rcvintpipe(port->serial->dev, port->interrupt_in_endpointAddress),
148 port->interrupt_in_urb->transfer_buffer,
149 port->interrupt_in_urb->transfer_buffer_length,
150 metrousb_read_int_callback, port, 1);
152 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
156 "%s - failed submitting interrupt in urb, error code=%d\n",
162 /* Try to resubmit the urb. */
163 result = usb_submit_urb(urb, GFP_ATOMIC);
166 "%s - failed submitting interrupt in urb, error code=%d\n",
170 static void metrousb_write_int_callback(struct urb *urb)
172 struct usb_serial_port *port = urb->context;
174 dev_warn(&port->dev, "%s not implemented yet.\n",
178 static void metrousb_cleanup(struct usb_serial_port *port)
180 dev_dbg(&port->dev, "%s\n", __func__);
182 if (port->serial->dev) {
183 /* Shutdown any interrupt in urbs. */
184 if (port->interrupt_in_urb) {
185 usb_unlink_urb(port->interrupt_in_urb);
186 usb_kill_urb(port->interrupt_in_urb);
189 /* Send deactivate cmd to device */
190 metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE, port);
194 static int metrousb_open(struct tty_struct *tty, struct usb_serial_port *port)
196 struct usb_serial *serial = port->serial;
197 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
198 unsigned long flags = 0;
201 dev_dbg(&port->dev, "%s\n", __func__);
203 /* Make sure the urb is initialized. */
204 if (!port->interrupt_in_urb) {
205 dev_err(&port->dev, "%s - interrupt urb not initialized\n",
210 /* Set the private data information for the port. */
211 spin_lock_irqsave(&metro_priv->lock, flags);
212 metro_priv->control_state = 0;
213 metro_priv->throttled = 0;
214 spin_unlock_irqrestore(&metro_priv->lock, flags);
216 /* Clear the urb pipe. */
217 usb_clear_halt(serial->dev, port->interrupt_in_urb->pipe);
219 /* Start reading from the device */
220 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
221 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
222 port->interrupt_in_urb->transfer_buffer,
223 port->interrupt_in_urb->transfer_buffer_length,
224 metrousb_read_int_callback, port, 1);
225 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
229 "%s - failed submitting interrupt in urb, error code=%d\n",
234 /* Send activate cmd to device */
235 result = metrousb_send_unidirectional_cmd(UNI_CMD_OPEN, port);
238 "%s - failed to configure device for port number=%d, error code=%d\n",
239 __func__, port->number, result);
243 dev_dbg(&port->dev, "%s - port open\n", __func__);
248 static int metrousb_set_modem_ctrl(struct usb_serial *serial, unsigned int control_state)
251 unsigned char mcr = METROUSB_MCR_NONE;
253 dev_dbg(&serial->dev->dev, "%s - control state = %d\n",
254 __func__, control_state);
256 /* Set the modem control value. */
257 if (control_state & TIOCM_DTR)
258 mcr |= METROUSB_MCR_DTR;
259 if (control_state & TIOCM_RTS)
260 mcr |= METROUSB_MCR_RTS;
262 /* Send the command to the usb port. */
263 retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
264 METROUSB_SET_REQUEST_TYPE, METROUSB_SET_MODEM_CTRL_REQUEST,
265 control_state, 0, NULL, 0, WDR_TIMEOUT);
267 dev_err(&serial->dev->dev,
268 "%s - set modem ctrl=0x%x failed, error code=%d\n",
269 __func__, mcr, retval);
274 static void metrousb_shutdown(struct usb_serial *serial)
278 dev_dbg(&serial->dev->dev, "%s\n", __func__);
280 /* Stop reading and writing on all ports. */
281 for (i = 0; i < serial->num_ports; ++i) {
282 /* Close any open urbs. */
283 metrousb_cleanup(serial->port[i]);
286 kfree(usb_get_serial_port_data(serial->port[i]));
287 usb_set_serial_port_data(serial->port[i], NULL);
289 dev_dbg(&serial->dev->dev, "%s - freed port number=%d\n",
290 __func__, serial->port[i]->number);
294 static int metrousb_startup(struct usb_serial *serial)
296 struct metrousb_private *metro_priv;
297 struct usb_serial_port *port;
300 dev_dbg(&serial->dev->dev, "%s\n", __func__);
302 /* Loop through the serial ports setting up the private structures.
303 * Currently we only use one port. */
304 for (i = 0; i < serial->num_ports; ++i) {
305 port = serial->port[i];
307 /* Declare memory. */
308 metro_priv = kzalloc(sizeof(struct metrousb_private), GFP_KERNEL);
312 /* Initialize memory. */
313 spin_lock_init(&metro_priv->lock);
314 usb_set_serial_port_data(port, metro_priv);
316 dev_dbg(&serial->dev->dev, "%s - port number=%d\n ",
317 __func__, port->number);
323 static void metrousb_throttle(struct tty_struct *tty)
325 struct usb_serial_port *port = tty->driver_data;
326 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
327 unsigned long flags = 0;
329 dev_dbg(tty->dev, "%s\n", __func__);
331 /* Set the private information for the port to stop reading data. */
332 spin_lock_irqsave(&metro_priv->lock, flags);
333 metro_priv->throttled = 1;
334 spin_unlock_irqrestore(&metro_priv->lock, flags);
337 static int metrousb_tiocmget(struct tty_struct *tty)
339 unsigned long control_state = 0;
340 struct usb_serial_port *port = tty->driver_data;
341 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
342 unsigned long flags = 0;
344 dev_dbg(tty->dev, "%s\n", __func__);
346 spin_lock_irqsave(&metro_priv->lock, flags);
347 control_state = metro_priv->control_state;
348 spin_unlock_irqrestore(&metro_priv->lock, flags);
350 return control_state;
353 static int metrousb_tiocmset(struct tty_struct *tty,
354 unsigned int set, unsigned int clear)
356 struct usb_serial_port *port = tty->driver_data;
357 struct usb_serial *serial = port->serial;
358 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
359 unsigned long flags = 0;
360 unsigned long control_state = 0;
362 dev_dbg(tty->dev, "%s - set=%d, clear=%d\n", __func__, set, clear);
364 spin_lock_irqsave(&metro_priv->lock, flags);
365 control_state = metro_priv->control_state;
367 /* Set the RTS and DTR values. */
369 control_state |= TIOCM_RTS;
371 control_state |= TIOCM_DTR;
372 if (clear & TIOCM_RTS)
373 control_state &= ~TIOCM_RTS;
374 if (clear & TIOCM_DTR)
375 control_state &= ~TIOCM_DTR;
377 metro_priv->control_state = control_state;
378 spin_unlock_irqrestore(&metro_priv->lock, flags);
379 return metrousb_set_modem_ctrl(serial, control_state);
382 static void metrousb_unthrottle(struct tty_struct *tty)
384 struct usb_serial_port *port = tty->driver_data;
385 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
386 unsigned long flags = 0;
389 dev_dbg(tty->dev, "%s\n", __func__);
391 /* Set the private information for the port to resume reading data. */
392 spin_lock_irqsave(&metro_priv->lock, flags);
393 metro_priv->throttled = 0;
394 spin_unlock_irqrestore(&metro_priv->lock, flags);
396 /* Submit the urb to read from the port. */
397 port->interrupt_in_urb->dev = port->serial->dev;
398 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
401 "failed submitting interrupt in urb error code=%d\n",
405 static struct usb_serial_driver metrousb_device = {
407 .owner = THIS_MODULE,
410 .description = "Metrologic USB to Serial",
411 .id_table = id_table,
413 .open = metrousb_open,
414 .close = metrousb_cleanup,
415 .read_int_callback = metrousb_read_int_callback,
416 .write_int_callback = metrousb_write_int_callback,
417 .attach = metrousb_startup,
418 .release = metrousb_shutdown,
419 .throttle = metrousb_throttle,
420 .unthrottle = metrousb_unthrottle,
421 .tiocmget = metrousb_tiocmget,
422 .tiocmset = metrousb_tiocmset,
425 static struct usb_serial_driver * const serial_drivers[] = {
430 module_usb_serial_driver(serial_drivers, id_table);
432 MODULE_LICENSE("GPL");
433 MODULE_AUTHOR("Philip Nicastro");
434 MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>");
435 MODULE_DESCRIPTION(DRIVER_DESC);