1 /* 2 Some of this code is credited to Linux USB open source files that are 3 distributed with Linux. 4 5 Copyright: 2007 Metrologic Instruments. All rights reserved. 6 Copyright: 2011 Azimut Ltd. <http://azimutrzn.ru/> 7 */ 8 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> 22 23 #define DRIVER_DESC "Metrologic Instruments Inc. - USB-POS driver" 24 25 /* Product information. */ 26 #define FOCUS_VENDOR_ID 0x0C2E 27 #define FOCUS_PRODUCT_ID_BI 0x0720 28 #define FOCUS_PRODUCT_ID_UNI 0x0700 29 30 #define METROUSB_SET_REQUEST_TYPE 0x40 31 #define METROUSB_SET_MODEM_CTRL_REQUEST 10 32 #define METROUSB_SET_BREAK_REQUEST 0x40 33 #define METROUSB_MCR_NONE 0x08 /* Deactivate DTR and RTS. */ 34 #define METROUSB_MCR_RTS 0x0a /* Activate RTS. */ 35 #define METROUSB_MCR_DTR 0x09 /* Activate DTR. */ 36 #define WDR_TIMEOUT 5000 /* default urb timeout. */ 37 38 /* Private data structure. */ 39 struct metrousb_private { 40 spinlock_t lock; 41 int throttled; 42 unsigned long control_state; 43 }; 44 45 /* Device table list. */ 46 static struct usb_device_id id_table[] = { 47 { USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_BI) }, 48 { USB_DEVICE(FOCUS_VENDOR_ID, FOCUS_PRODUCT_ID_UNI) }, 49 { }, /* Terminating entry. */ 50 }; 51 MODULE_DEVICE_TABLE(usb, id_table); 52 53 /* UNI-Directional mode commands for device configure */ 54 #define UNI_CMD_OPEN 0x80 55 #define UNI_CMD_CLOSE 0xFF 56 57 inline int metrousb_is_unidirectional_mode(struct usb_serial_port *port) 58 { 59 __u16 product_id = le16_to_cpu( 60 port->serial->dev->descriptor.idProduct); 61 62 return product_id == FOCUS_PRODUCT_ID_UNI; 63 } 64 65 static int metrousb_send_unidirectional_cmd(u8 cmd, struct usb_serial_port *port) 66 { 67 int ret; 68 int actual_len; 69 u8 *buffer_cmd = NULL; 70 71 if (!metrousb_is_unidirectional_mode(port)) 72 return 0; 73 74 buffer_cmd = kzalloc(sizeof(cmd), GFP_KERNEL); 75 if (!buffer_cmd) 76 return -ENOMEM; 77 78 *buffer_cmd = cmd; 79 80 ret = usb_interrupt_msg(port->serial->dev, 81 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress), 82 buffer_cmd, sizeof(cmd), 83 &actual_len, USB_CTRL_SET_TIMEOUT); 84 85 kfree(buffer_cmd); 86 87 if (ret < 0) 88 return ret; 89 else if (actual_len != sizeof(cmd)) 90 return -EIO; 91 return 0; 92 } 93 94 static void metrousb_read_int_callback(struct urb *urb) 95 { 96 struct usb_serial_port *port = urb->context; 97 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 98 unsigned char *data = urb->transfer_buffer; 99 int throttled = 0; 100 int result = 0; 101 unsigned long flags = 0; 102 103 dev_dbg(&port->dev, "%s\n", __func__); 104 105 switch (urb->status) { 106 case 0: 107 /* Success status, read from the port. */ 108 break; 109 case -ECONNRESET: 110 case -ENOENT: 111 case -ESHUTDOWN: 112 /* urb has been terminated. */ 113 dev_dbg(&port->dev, 114 "%s - urb shutting down, error code=%d\n", 115 __func__, urb->status); 116 return; 117 default: 118 dev_dbg(&port->dev, 119 "%s - non-zero urb received, error code=%d\n", 120 __func__, urb->status); 121 goto exit; 122 } 123 124 125 /* Set the data read from the usb port into the serial port buffer. */ 126 if (urb->actual_length) { 127 /* Loop through the data copying each byte to the tty layer. */ 128 tty_insert_flip_string(&port->port, data, urb->actual_length); 129 130 /* Force the data to the tty layer. */ 131 tty_flip_buffer_push(&port->port); 132 } 133 134 /* Set any port variables. */ 135 spin_lock_irqsave(&metro_priv->lock, flags); 136 throttled = metro_priv->throttled; 137 spin_unlock_irqrestore(&metro_priv->lock, flags); 138 139 /* Continue trying to read if set. */ 140 if (!throttled) { 141 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev, 142 usb_rcvintpipe(port->serial->dev, port->interrupt_in_endpointAddress), 143 port->interrupt_in_urb->transfer_buffer, 144 port->interrupt_in_urb->transfer_buffer_length, 145 metrousb_read_int_callback, port, 1); 146 147 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 148 149 if (result) 150 dev_err(&port->dev, 151 "%s - failed submitting interrupt in urb, error code=%d\n", 152 __func__, result); 153 } 154 return; 155 156 exit: 157 /* Try to resubmit the urb. */ 158 result = usb_submit_urb(urb, GFP_ATOMIC); 159 if (result) 160 dev_err(&port->dev, 161 "%s - failed submitting interrupt in urb, error code=%d\n", 162 __func__, result); 163 } 164 165 static void metrousb_write_int_callback(struct urb *urb) 166 { 167 struct usb_serial_port *port = urb->context; 168 169 dev_warn(&port->dev, "%s not implemented yet.\n", 170 __func__); 171 } 172 173 static void metrousb_cleanup(struct usb_serial_port *port) 174 { 175 dev_dbg(&port->dev, "%s\n", __func__); 176 177 usb_unlink_urb(port->interrupt_in_urb); 178 usb_kill_urb(port->interrupt_in_urb); 179 180 mutex_lock(&port->serial->disc_mutex); 181 if (!port->serial->disconnected) 182 metrousb_send_unidirectional_cmd(UNI_CMD_CLOSE, port); 183 mutex_unlock(&port->serial->disc_mutex); 184 } 185 186 static int metrousb_open(struct tty_struct *tty, struct usb_serial_port *port) 187 { 188 struct usb_serial *serial = port->serial; 189 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 190 unsigned long flags = 0; 191 int result = 0; 192 193 dev_dbg(&port->dev, "%s\n", __func__); 194 195 /* Make sure the urb is initialized. */ 196 if (!port->interrupt_in_urb) { 197 dev_err(&port->dev, "%s - interrupt urb not initialized\n", 198 __func__); 199 return -ENODEV; 200 } 201 202 /* Set the private data information for the port. */ 203 spin_lock_irqsave(&metro_priv->lock, flags); 204 metro_priv->control_state = 0; 205 metro_priv->throttled = 0; 206 spin_unlock_irqrestore(&metro_priv->lock, flags); 207 208 /* Clear the urb pipe. */ 209 usb_clear_halt(serial->dev, port->interrupt_in_urb->pipe); 210 211 /* Start reading from the device */ 212 usb_fill_int_urb(port->interrupt_in_urb, serial->dev, 213 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress), 214 port->interrupt_in_urb->transfer_buffer, 215 port->interrupt_in_urb->transfer_buffer_length, 216 metrousb_read_int_callback, port, 1); 217 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); 218 219 if (result) { 220 dev_err(&port->dev, 221 "%s - failed submitting interrupt in urb, error code=%d\n", 222 __func__, result); 223 goto exit; 224 } 225 226 /* Send activate cmd to device */ 227 result = metrousb_send_unidirectional_cmd(UNI_CMD_OPEN, port); 228 if (result) { 229 dev_err(&port->dev, 230 "%s - failed to configure device for port number=%d, error code=%d\n", 231 __func__, port->number, result); 232 goto exit; 233 } 234 235 dev_dbg(&port->dev, "%s - port open\n", __func__); 236 exit: 237 return result; 238 } 239 240 static int metrousb_set_modem_ctrl(struct usb_serial *serial, unsigned int control_state) 241 { 242 int retval = 0; 243 unsigned char mcr = METROUSB_MCR_NONE; 244 245 dev_dbg(&serial->dev->dev, "%s - control state = %d\n", 246 __func__, control_state); 247 248 /* Set the modem control value. */ 249 if (control_state & TIOCM_DTR) 250 mcr |= METROUSB_MCR_DTR; 251 if (control_state & TIOCM_RTS) 252 mcr |= METROUSB_MCR_RTS; 253 254 /* Send the command to the usb port. */ 255 retval = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), 256 METROUSB_SET_REQUEST_TYPE, METROUSB_SET_MODEM_CTRL_REQUEST, 257 control_state, 0, NULL, 0, WDR_TIMEOUT); 258 if (retval < 0) 259 dev_err(&serial->dev->dev, 260 "%s - set modem ctrl=0x%x failed, error code=%d\n", 261 __func__, mcr, retval); 262 263 return retval; 264 } 265 266 static int metrousb_port_probe(struct usb_serial_port *port) 267 { 268 struct metrousb_private *metro_priv; 269 270 metro_priv = kzalloc(sizeof(*metro_priv), GFP_KERNEL); 271 if (!metro_priv) 272 return -ENOMEM; 273 274 spin_lock_init(&metro_priv->lock); 275 276 usb_set_serial_port_data(port, metro_priv); 277 278 return 0; 279 } 280 281 static int metrousb_port_remove(struct usb_serial_port *port) 282 { 283 struct metrousb_private *metro_priv; 284 285 metro_priv = usb_get_serial_port_data(port); 286 kfree(metro_priv); 287 288 return 0; 289 } 290 291 static void metrousb_throttle(struct tty_struct *tty) 292 { 293 struct usb_serial_port *port = tty->driver_data; 294 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 295 unsigned long flags = 0; 296 297 dev_dbg(tty->dev, "%s\n", __func__); 298 299 /* Set the private information for the port to stop reading data. */ 300 spin_lock_irqsave(&metro_priv->lock, flags); 301 metro_priv->throttled = 1; 302 spin_unlock_irqrestore(&metro_priv->lock, flags); 303 } 304 305 static int metrousb_tiocmget(struct tty_struct *tty) 306 { 307 unsigned long control_state = 0; 308 struct usb_serial_port *port = tty->driver_data; 309 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 310 unsigned long flags = 0; 311 312 dev_dbg(tty->dev, "%s\n", __func__); 313 314 spin_lock_irqsave(&metro_priv->lock, flags); 315 control_state = metro_priv->control_state; 316 spin_unlock_irqrestore(&metro_priv->lock, flags); 317 318 return control_state; 319 } 320 321 static int metrousb_tiocmset(struct tty_struct *tty, 322 unsigned int set, unsigned int clear) 323 { 324 struct usb_serial_port *port = tty->driver_data; 325 struct usb_serial *serial = port->serial; 326 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 327 unsigned long flags = 0; 328 unsigned long control_state = 0; 329 330 dev_dbg(tty->dev, "%s - set=%d, clear=%d\n", __func__, set, clear); 331 332 spin_lock_irqsave(&metro_priv->lock, flags); 333 control_state = metro_priv->control_state; 334 335 /* Set the RTS and DTR values. */ 336 if (set & TIOCM_RTS) 337 control_state |= TIOCM_RTS; 338 if (set & TIOCM_DTR) 339 control_state |= TIOCM_DTR; 340 if (clear & TIOCM_RTS) 341 control_state &= ~TIOCM_RTS; 342 if (clear & TIOCM_DTR) 343 control_state &= ~TIOCM_DTR; 344 345 metro_priv->control_state = control_state; 346 spin_unlock_irqrestore(&metro_priv->lock, flags); 347 return metrousb_set_modem_ctrl(serial, control_state); 348 } 349 350 static void metrousb_unthrottle(struct tty_struct *tty) 351 { 352 struct usb_serial_port *port = tty->driver_data; 353 struct metrousb_private *metro_priv = usb_get_serial_port_data(port); 354 unsigned long flags = 0; 355 int result = 0; 356 357 dev_dbg(tty->dev, "%s\n", __func__); 358 359 /* Set the private information for the port to resume reading data. */ 360 spin_lock_irqsave(&metro_priv->lock, flags); 361 metro_priv->throttled = 0; 362 spin_unlock_irqrestore(&metro_priv->lock, flags); 363 364 /* Submit the urb to read from the port. */ 365 port->interrupt_in_urb->dev = port->serial->dev; 366 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC); 367 if (result) 368 dev_err(tty->dev, 369 "failed submitting interrupt in urb error code=%d\n", 370 result); 371 } 372 373 static struct usb_serial_driver metrousb_device = { 374 .driver = { 375 .owner = THIS_MODULE, 376 .name = "metro-usb", 377 }, 378 .description = "Metrologic USB to Serial", 379 .id_table = id_table, 380 .num_ports = 1, 381 .open = metrousb_open, 382 .close = metrousb_cleanup, 383 .read_int_callback = metrousb_read_int_callback, 384 .write_int_callback = metrousb_write_int_callback, 385 .port_probe = metrousb_port_probe, 386 .port_remove = metrousb_port_remove, 387 .throttle = metrousb_throttle, 388 .unthrottle = metrousb_unthrottle, 389 .tiocmget = metrousb_tiocmget, 390 .tiocmset = metrousb_tiocmset, 391 }; 392 393 static struct usb_serial_driver * const serial_drivers[] = { 394 &metrousb_device, 395 NULL, 396 }; 397 398 module_usb_serial_driver(serial_drivers, id_table); 399 400 MODULE_LICENSE("GPL"); 401 MODULE_AUTHOR("Philip Nicastro"); 402 MODULE_AUTHOR("Aleksey Babahin <tamerlan311@gmail.com>"); 403 MODULE_DESCRIPTION(DRIVER_DESC); 404