drivers/usb/serial/metro-usb.c

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