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 /* Input parameter constants. */
58 /* UNI-Directional mode commands for device configure */
59 #define UNI_CMD_OPEN 0x80
60 #define UNI_CMD_CLOSE 0xFF
62 inline int metrousb_is_unidirectional_mode(struct usb_serial_port *port)
64 __u16 product_id = le16_to_cpu(
65 port->serial->dev->descriptor.idProduct);
67 return product_id == FOCUS_PRODUCT_ID_UNI;
70 static int metrousb_send_unidirectional_cmd(u8 cmd, struct usb_serial_port *port)
74 u8 *buffer_cmd = NULL;
76 if (!metrousb_is_unidirectional_mode(port))
79 buffer_cmd = kzalloc(sizeof(cmd), GFP_KERNEL);
85 ret = usb_interrupt_msg(port->serial->dev,
86 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
87 buffer_cmd, sizeof(cmd),
88 &actual_len, USB_CTRL_SET_TIMEOUT);
94 else if (actual_len != sizeof(cmd))
99 static void metrousb_read_int_callback(struct urb *urb)
101 struct usb_serial_port *port = urb->context;
102 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
103 struct tty_struct *tty;
104 unsigned char *data = urb->transfer_buffer;
107 unsigned long flags = 0;
109 dev_dbg(&port->dev, "%s\n", __func__);
111 switch (urb->status) {
113 /* Success status, read from the port. */
118 /* urb has been terminated. */
120 "%s - urb shutting down, error code=%d\n",
121 __func__, urb->status);
125 "%s - non-zero urb received, error code=%d\n",
126 __func__, urb->status);
131 /* Set the data read from the usb port into the serial port buffer. */
132 tty = tty_port_tty_get(&port->port);
133 if (tty && urb->actual_length) {
134 /* Loop through the data copying each byte to the tty layer. */
135 tty_insert_flip_string(tty, data, urb->actual_length);
137 /* Force the data to the tty layer. */
138 tty_flip_buffer_push(tty);
142 /* Set any port variables. */
143 spin_lock_irqsave(&metro_priv->lock, flags);
144 throttled = metro_priv->throttled;
145 spin_unlock_irqrestore(&metro_priv->lock, flags);
147 /* Continue trying to read if set. */
149 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
150 usb_rcvintpipe(port->serial->dev, port->interrupt_in_endpointAddress),
151 port->interrupt_in_urb->transfer_buffer,
152 port->interrupt_in_urb->transfer_buffer_length,
153 metrousb_read_int_callback, port, 1);
155 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
159 "%s - failed submitting interrupt in urb, error code=%d\n",
165 /* Try to resubmit the urb. */
166 result = usb_submit_urb(urb, GFP_ATOMIC);
169 "%s - failed submitting interrupt in urb, error code=%d\n",
173 static void metrousb_write_int_callback(struct urb *urb)
175 struct usb_serial_port *port = urb->context;
177 dev_warn(&port->dev, "%s not implemented yet.\n",
181 static void metrousb_cleanup(struct usb_serial_port *port)
183 dev_dbg(&port->dev, "%s\n", __func__);
185 if (port->serial->dev) {
186 /* Shutdown any interrupt in urbs. */
187 if (port->interrupt_in_urb) {
188 usb_unlink_urb(port->interrupt_in_urb);
189 usb_kill_urb(port->interrupt_in_urb);
192 /* Send deactivate cmd to device */
193 metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE, port);
197 static int metrousb_open(struct tty_struct *tty, struct usb_serial_port *port)
199 struct usb_serial *serial = port->serial;
200 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
201 unsigned long flags = 0;
204 dev_dbg(&port->dev, "%s\n", __func__);
206 /* Make sure the urb is initialized. */
207 if (!port->interrupt_in_urb) {
208 dev_err(&port->dev, "%s - interrupt urb not initialized\n",
213 /* Set the private data information for the port. */
214 spin_lock_irqsave(&metro_priv->lock, flags);
215 metro_priv->control_state = 0;
216 metro_priv->throttled = 0;
217 spin_unlock_irqrestore(&metro_priv->lock, flags);
219 /* Clear the urb pipe. */
220 usb_clear_halt(serial->dev, port->interrupt_in_urb->pipe);
222 /* Start reading from the device */
223 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
224 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
225 port->interrupt_in_urb->transfer_buffer,
226 port->interrupt_in_urb->transfer_buffer_length,
227 metrousb_read_int_callback, port, 1);
228 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
232 "%s - failed submitting interrupt in urb, error code=%d\n",
237 /* Send activate cmd to device */
238 result = metrousb_send_unidirectional_cmd(UNI_CMD_OPEN, port);
241 "%s - failed to configure device for port number=%d, error code=%d\n",
242 __func__, port->number, result);
246 dev_dbg(&port->dev, "%s - port open\n", __func__);
251 static int metrousb_set_modem_ctrl(struct usb_serial *serial, unsigned int control_state)
254 unsigned char mcr = METROUSB_MCR_NONE;
256 dev_dbg(&serial->dev->dev, "%s - control state = %d\n",
257 __func__, control_state);
259 /* Set the modem control value. */
260 if (control_state & TIOCM_DTR)
261 mcr |= METROUSB_MCR_DTR;
262 if (control_state & TIOCM_RTS)
263 mcr |= METROUSB_MCR_RTS;
265 /* Send the command to the usb port. */
266 retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
267 METROUSB_SET_REQUEST_TYPE, METROUSB_SET_MODEM_CTRL_REQUEST,
268 control_state, 0, NULL, 0, WDR_TIMEOUT);
270 dev_err(&serial->dev->dev,
271 "%s - set modem ctrl=0x%x failed, error code=%d\n",
272 __func__, mcr, retval);
277 static void metrousb_shutdown(struct usb_serial *serial)
281 dev_dbg(&serial->dev->dev, "%s\n", __func__);
283 /* Stop reading and writing on all ports. */
284 for (i = 0; i < serial->num_ports; ++i) {
285 /* Close any open urbs. */
286 metrousb_cleanup(serial->port[i]);
289 kfree(usb_get_serial_port_data(serial->port[i]));
290 usb_set_serial_port_data(serial->port[i], NULL);
292 dev_dbg(&serial->dev->dev, "%s - freed port number=%d\n",
293 __func__, serial->port[i]->number);
297 static int metrousb_startup(struct usb_serial *serial)
299 struct metrousb_private *metro_priv;
300 struct usb_serial_port *port;
303 dev_dbg(&serial->dev->dev, "%s\n", __func__);
305 /* Loop through the serial ports setting up the private structures.
306 * Currently we only use one port. */
307 for (i = 0; i < serial->num_ports; ++i) {
308 port = serial->port[i];
310 /* Declare memory. */
311 metro_priv = kzalloc(sizeof(struct metrousb_private), GFP_KERNEL);
315 /* Initialize memory. */
316 spin_lock_init(&metro_priv->lock);
317 usb_set_serial_port_data(port, metro_priv);
319 dev_dbg(&serial->dev->dev, "%s - port number=%d\n ",
320 __func__, port->number);
326 static void metrousb_throttle(struct tty_struct *tty)
328 struct usb_serial_port *port = tty->driver_data;
329 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
330 unsigned long flags = 0;
332 dev_dbg(tty->dev, "%s\n", __func__);
334 /* Set the private information for the port to stop reading data. */
335 spin_lock_irqsave(&metro_priv->lock, flags);
336 metro_priv->throttled = 1;
337 spin_unlock_irqrestore(&metro_priv->lock, flags);
340 static int metrousb_tiocmget(struct tty_struct *tty)
342 unsigned long control_state = 0;
343 struct usb_serial_port *port = tty->driver_data;
344 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
345 unsigned long flags = 0;
347 dev_dbg(tty->dev, "%s\n", __func__);
349 spin_lock_irqsave(&metro_priv->lock, flags);
350 control_state = metro_priv->control_state;
351 spin_unlock_irqrestore(&metro_priv->lock, flags);
353 return control_state;
356 static int metrousb_tiocmset(struct tty_struct *tty,
357 unsigned int set, unsigned int clear)
359 struct usb_serial_port *port = tty->driver_data;
360 struct usb_serial *serial = port->serial;
361 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
362 unsigned long flags = 0;
363 unsigned long control_state = 0;
365 dev_dbg(tty->dev, "%s - set=%d, clear=%d\n", __func__, set, clear);
367 spin_lock_irqsave(&metro_priv->lock, flags);
368 control_state = metro_priv->control_state;
370 /* Set the RTS and DTR values. */
372 control_state |= TIOCM_RTS;
374 control_state |= TIOCM_DTR;
375 if (clear & TIOCM_RTS)
376 control_state &= ~TIOCM_RTS;
377 if (clear & TIOCM_DTR)
378 control_state &= ~TIOCM_DTR;
380 metro_priv->control_state = control_state;
381 spin_unlock_irqrestore(&metro_priv->lock, flags);
382 return metrousb_set_modem_ctrl(serial, control_state);
385 static void metrousb_unthrottle(struct tty_struct *tty)
387 struct usb_serial_port *port = tty->driver_data;
388 struct metrousb_private *metro_priv = usb_get_serial_port_data(port);
389 unsigned long flags = 0;
392 dev_dbg(tty->dev, "%s\n", __func__);
394 /* Set the private information for the port to resume reading data. */
395 spin_lock_irqsave(&metro_priv->lock, flags);
396 metro_priv->throttled = 0;
397 spin_unlock_irqrestore(&metro_priv->lock, flags);
399 /* Submit the urb to read from the port. */
400 port->interrupt_in_urb->dev = port->serial->dev;
401 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
404 "failed submitting interrupt in urb error code=%d\n",
408 static struct usb_serial_driver metrousb_device = {
410 .owner = THIS_MODULE,
413 .description = "Metrologic USB to Serial",
414 .id_table = id_table,
416 .open = metrousb_open,
417 .close = metrousb_cleanup,
418 .read_int_callback = metrousb_read_int_callback,
419 .write_int_callback = metrousb_write_int_callback,
420 .attach = metrousb_startup,
421 .release = metrousb_shutdown,
422 .throttle = metrousb_throttle,
423 .unthrottle = metrousb_unthrottle,
424 .tiocmget = metrousb_tiocmget,
425 .tiocmset = metrousb_tiocmset,
428 static struct usb_serial_driver * const serial_drivers[] = {
433 module_usb_serial_driver(serial_drivers, id_table);
435 MODULE_LICENSE("GPL");
436 MODULE_AUTHOR("Philip Nicastro");
437 MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>");
438 MODULE_DESCRIPTION(DRIVER_DESC);
440 /* Module input parameters */
441 module_param(debug, bool, S_IRUGO | S_IWUSR);
442 MODULE_PARM_DESC(debug, "Print debug info (bool 1=on, 0=off)");