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
);
134 dev_err(&port
->dev
, "%s - bad tty pointer - exiting\n",
139 if (tty
&& urb
->actual_length
) {
140 /* Loop through the data copying each byte to the tty layer. */
141 tty_insert_flip_string(tty
, data
, urb
->actual_length
);
143 /* Force the data to the tty layer. */
144 tty_flip_buffer_push(tty
);
148 /* Set any port variables. */
149 spin_lock_irqsave(&metro_priv
->lock
, flags
);
150 throttled
= metro_priv
->throttled
;
151 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
153 /* Continue trying to read if set. */
155 usb_fill_int_urb(port
->interrupt_in_urb
, port
->serial
->dev
,
156 usb_rcvintpipe(port
->serial
->dev
, port
->interrupt_in_endpointAddress
),
157 port
->interrupt_in_urb
->transfer_buffer
,
158 port
->interrupt_in_urb
->transfer_buffer_length
,
159 metrousb_read_int_callback
, port
, 1);
161 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
165 "%s - failed submitting interrupt in urb, error code=%d\n",
171 /* Try to resubmit the urb. */
172 result
= usb_submit_urb(urb
, GFP_ATOMIC
);
175 "%s - failed submitting interrupt in urb, error code=%d\n",
179 static void metrousb_write_int_callback(struct urb
*urb
)
181 struct usb_serial_port
*port
= urb
->context
;
183 dev_warn(&port
->dev
, "%s not implemented yet.\n",
187 static void metrousb_cleanup(struct usb_serial_port
*port
)
189 dev_dbg(&port
->dev
, "%s\n", __func__
);
191 if (port
->serial
->dev
) {
192 /* Shutdown any interrupt in urbs. */
193 if (port
->interrupt_in_urb
) {
194 usb_unlink_urb(port
->interrupt_in_urb
);
195 usb_kill_urb(port
->interrupt_in_urb
);
198 /* Send deactivate cmd to device */
199 metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE
, port
);
203 static int metrousb_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
205 struct usb_serial
*serial
= port
->serial
;
206 struct metrousb_private
*metro_priv
= usb_get_serial_port_data(port
);
207 unsigned long flags
= 0;
210 dev_dbg(&port
->dev
, "%s\n", __func__
);
212 /* Make sure the urb is initialized. */
213 if (!port
->interrupt_in_urb
) {
214 dev_err(&port
->dev
, "%s - interrupt urb not initialized\n",
219 /* Set the private data information for the port. */
220 spin_lock_irqsave(&metro_priv
->lock
, flags
);
221 metro_priv
->control_state
= 0;
222 metro_priv
->throttled
= 0;
223 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
226 * Force low_latency on so that our tty_push actually forces the data
227 * through, otherwise it is scheduled, and with high data rates (like
228 * with OHCI) data can get lost.
231 tty
->low_latency
= 1;
233 /* Clear the urb pipe. */
234 usb_clear_halt(serial
->dev
, port
->interrupt_in_urb
->pipe
);
236 /* Start reading from the device */
237 usb_fill_int_urb(port
->interrupt_in_urb
, serial
->dev
,
238 usb_rcvintpipe(serial
->dev
, port
->interrupt_in_endpointAddress
),
239 port
->interrupt_in_urb
->transfer_buffer
,
240 port
->interrupt_in_urb
->transfer_buffer_length
,
241 metrousb_read_int_callback
, port
, 1);
242 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
246 "%s - failed submitting interrupt in urb, error code=%d\n",
251 /* Send activate cmd to device */
252 result
= metrousb_send_unidirectional_cmd(UNI_CMD_OPEN
, port
);
255 "%s - failed to configure device for port number=%d, error code=%d\n",
256 __func__
, port
->number
, result
);
260 dev_dbg(&port
->dev
, "%s - port open\n", __func__
);
265 static int metrousb_set_modem_ctrl(struct usb_serial
*serial
, unsigned int control_state
)
268 unsigned char mcr
= METROUSB_MCR_NONE
;
270 dev_dbg(&serial
->dev
->dev
, "%s - control state = %d\n",
271 __func__
, control_state
);
273 /* Set the modem control value. */
274 if (control_state
& TIOCM_DTR
)
275 mcr
|= METROUSB_MCR_DTR
;
276 if (control_state
& TIOCM_RTS
)
277 mcr
|= METROUSB_MCR_RTS
;
279 /* Send the command to the usb port. */
280 retval
= usb_control_msg(serial
->dev
, usb_sndctrlpipe(serial
->dev
, 0),
281 METROUSB_SET_REQUEST_TYPE
, METROUSB_SET_MODEM_CTRL_REQUEST
,
282 control_state
, 0, NULL
, 0, WDR_TIMEOUT
);
284 dev_err(&serial
->dev
->dev
,
285 "%s - set modem ctrl=0x%x failed, error code=%d\n",
286 __func__
, mcr
, retval
);
291 static void metrousb_shutdown(struct usb_serial
*serial
)
295 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
297 /* Stop reading and writing on all ports. */
298 for (i
= 0; i
< serial
->num_ports
; ++i
) {
299 /* Close any open urbs. */
300 metrousb_cleanup(serial
->port
[i
]);
303 kfree(usb_get_serial_port_data(serial
->port
[i
]));
304 usb_set_serial_port_data(serial
->port
[i
], NULL
);
306 dev_dbg(&serial
->dev
->dev
, "%s - freed port number=%d\n",
307 __func__
, serial
->port
[i
]->number
);
311 static int metrousb_startup(struct usb_serial
*serial
)
313 struct metrousb_private
*metro_priv
;
314 struct usb_serial_port
*port
;
317 dev_dbg(&serial
->dev
->dev
, "%s\n", __func__
);
319 /* Loop through the serial ports setting up the private structures.
320 * Currently we only use one port. */
321 for (i
= 0; i
< serial
->num_ports
; ++i
) {
322 port
= serial
->port
[i
];
324 /* Declare memory. */
325 metro_priv
= kzalloc(sizeof(struct metrousb_private
), GFP_KERNEL
);
329 /* Initialize memory. */
330 spin_lock_init(&metro_priv
->lock
);
331 usb_set_serial_port_data(port
, metro_priv
);
333 dev_dbg(&serial
->dev
->dev
, "%s - port number=%d\n ",
334 __func__
, port
->number
);
340 static void metrousb_throttle(struct tty_struct
*tty
)
342 struct usb_serial_port
*port
= tty
->driver_data
;
343 struct metrousb_private
*metro_priv
= usb_get_serial_port_data(port
);
344 unsigned long flags
= 0;
346 dev_dbg(tty
->dev
, "%s\n", __func__
);
348 /* Set the private information for the port to stop reading data. */
349 spin_lock_irqsave(&metro_priv
->lock
, flags
);
350 metro_priv
->throttled
= 1;
351 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
354 static int metrousb_tiocmget(struct tty_struct
*tty
)
356 unsigned long control_state
= 0;
357 struct usb_serial_port
*port
= tty
->driver_data
;
358 struct metrousb_private
*metro_priv
= usb_get_serial_port_data(port
);
359 unsigned long flags
= 0;
361 dev_dbg(tty
->dev
, "%s\n", __func__
);
363 spin_lock_irqsave(&metro_priv
->lock
, flags
);
364 control_state
= metro_priv
->control_state
;
365 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
367 return control_state
;
370 static int metrousb_tiocmset(struct tty_struct
*tty
,
371 unsigned int set
, unsigned int clear
)
373 struct usb_serial_port
*port
= tty
->driver_data
;
374 struct usb_serial
*serial
= port
->serial
;
375 struct metrousb_private
*metro_priv
= usb_get_serial_port_data(port
);
376 unsigned long flags
= 0;
377 unsigned long control_state
= 0;
379 dev_dbg(tty
->dev
, "%s - set=%d, clear=%d\n", __func__
, set
, clear
);
381 spin_lock_irqsave(&metro_priv
->lock
, flags
);
382 control_state
= metro_priv
->control_state
;
384 /* Set the RTS and DTR values. */
386 control_state
|= TIOCM_RTS
;
388 control_state
|= TIOCM_DTR
;
389 if (clear
& TIOCM_RTS
)
390 control_state
&= ~TIOCM_RTS
;
391 if (clear
& TIOCM_DTR
)
392 control_state
&= ~TIOCM_DTR
;
394 metro_priv
->control_state
= control_state
;
395 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
396 return metrousb_set_modem_ctrl(serial
, control_state
);
399 static void metrousb_unthrottle(struct tty_struct
*tty
)
401 struct usb_serial_port
*port
= tty
->driver_data
;
402 struct metrousb_private
*metro_priv
= usb_get_serial_port_data(port
);
403 unsigned long flags
= 0;
406 dev_dbg(tty
->dev
, "%s\n", __func__
);
408 /* Set the private information for the port to resume reading data. */
409 spin_lock_irqsave(&metro_priv
->lock
, flags
);
410 metro_priv
->throttled
= 0;
411 spin_unlock_irqrestore(&metro_priv
->lock
, flags
);
413 /* Submit the urb to read from the port. */
414 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
415 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
418 "failed submitting interrupt in urb error code=%d\n",
422 static struct usb_serial_driver metrousb_device
= {
424 .owner
= THIS_MODULE
,
427 .description
= "Metrologic USB to Serial",
428 .id_table
= id_table
,
430 .open
= metrousb_open
,
431 .close
= metrousb_cleanup
,
432 .read_int_callback
= metrousb_read_int_callback
,
433 .write_int_callback
= metrousb_write_int_callback
,
434 .attach
= metrousb_startup
,
435 .release
= metrousb_shutdown
,
436 .throttle
= metrousb_throttle
,
437 .unthrottle
= metrousb_unthrottle
,
438 .tiocmget
= metrousb_tiocmget
,
439 .tiocmset
= metrousb_tiocmset
,
442 static struct usb_serial_driver
* const serial_drivers
[] = {
447 module_usb_serial_driver(serial_drivers
, id_table
);
449 MODULE_LICENSE("GPL");
450 MODULE_AUTHOR("Philip Nicastro");
451 MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>");
452 MODULE_DESCRIPTION(DRIVER_DESC
);
454 /* Module input parameters */
455 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
456 MODULE_PARM_DESC(debug
, "Print debug info (bool 1=on, 0=off)");