drivers/usb/serial/belkin_sa.c

   1 /*
   2  * Belkin USB Serial Adapter Driver
   3  *
   4  *  Copyright (C) 2000          William Greathouse (wgreathouse@smva.com)
   5  *  Copyright (C) 2000-2001     Greg Kroah-Hartman (greg@kroah.com)
   6  *  Copyright (C) 2010          Johan Hovold (jhovold@gmail.com)
   7  *
   8  *  This program is largely derived from work by the linux-usb group
   9  *  and associated source files.  Please see the usb/serial files for
  10  *  individual credits and copyrights.
  11  *
  12  *      This program is free software; you can redistribute it and/or modify
  13  *      it under the terms of the GNU General Public License as published by
  14  *      the Free Software Foundation; either version 2 of the License, or
  15  *      (at your option) any later version.
  16  *
  17  * See Documentation/usb/usb-serial.txt for more information on using this
  18  * driver
  19  *
  20  * TODO:
  21  * -- Add true modem contol line query capability.  Currently we track the
  22  *    states reported by the interrupt and the states we request.
  23  * -- Add support for flush commands
  24  */
  25
  26 #include <linux/kernel.h>
  27 #include <linux/errno.h>
  28 #include <linux/init.h>
  29 #include <linux/slab.h>
  30 #include <linux/tty.h>
  31 #include <linux/tty_driver.h>
  32 #include <linux/tty_flip.h>
  33 #include <linux/module.h>
  34 #include <linux/spinlock.h>
  35 #include <linux/uaccess.h>
  36 #include <linux/usb.h>
  37 #include <linux/usb/serial.h>
  38 #include "belkin_sa.h"
  39
  40 /*
  41  * Version Information
  42  */
  43 #define DRIVER_VERSION "v1.3"
  44 #define DRIVER_AUTHOR "William Greathouse <wgreathouse@smva.com>"
  45 #define DRIVER_DESC "USB Belkin Serial converter driver"
  46
  47 /* function prototypes for a Belkin USB Serial Adapter F5U103 */
  48 static int  belkin_sa_startup(struct usb_serial *serial);
  49 static void belkin_sa_release(struct usb_serial *serial);
  50 static int  belkin_sa_open(struct tty_struct *tty,
  51                         struct usb_serial_port *port);
  52 static void belkin_sa_close(struct usb_serial_port *port);
  53 static void belkin_sa_read_int_callback(struct urb *urb);
  54 static void belkin_sa_process_read_urb(struct urb *urb);
  55 static void belkin_sa_set_termios(struct tty_struct *tty,
  56                         struct usb_serial_port *port, struct ktermios * old);
  57 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state);
  58 static int  belkin_sa_tiocmget(struct tty_struct *tty);
  59 static int  belkin_sa_tiocmset(struct tty_struct *tty,
  60                                         unsigned int set, unsigned int clear);
  61
  62
  63 static const struct usb_device_id id_table[] = {
  64         { USB_DEVICE(BELKIN_SA_VID, BELKIN_SA_PID) },
  65         { USB_DEVICE(BELKIN_OLD_VID, BELKIN_OLD_PID) },
  66         { USB_DEVICE(PERACOM_VID, PERACOM_PID) },
  67         { USB_DEVICE(GOHUBS_VID, GOHUBS_PID) },
  68         { USB_DEVICE(GOHUBS_VID, HANDYLINK_PID) },
  69         { USB_DEVICE(BELKIN_DOCKSTATION_VID, BELKIN_DOCKSTATION_PID) },
  70         { }     /* Terminating entry */
  71 };
  72 MODULE_DEVICE_TABLE(usb, id_table);
  73
  74 /* All of the device info needed for the serial converters */
  75 static struct usb_serial_driver belkin_device = {
  76         .driver = {
  77                 .owner =        THIS_MODULE,
  78                 .name =         "belkin",
  79         },
  80         .description =          "Belkin / Peracom / GoHubs USB Serial Adapter",
  81         .id_table =             id_table,
  82         .num_ports =            1,
  83         .open =                 belkin_sa_open,
  84         .close =                belkin_sa_close,
  85         .read_int_callback =    belkin_sa_read_int_callback,
  86         .process_read_urb =     belkin_sa_process_read_urb,
  87         .set_termios =          belkin_sa_set_termios,
  88         .break_ctl =            belkin_sa_break_ctl,
  89         .tiocmget =             belkin_sa_tiocmget,
  90         .tiocmset =             belkin_sa_tiocmset,
  91         .attach =               belkin_sa_startup,
  92         .release =              belkin_sa_release,
  93 };
  94
  95 static struct usb_serial_driver * const serial_drivers[] = {
  96         &belkin_device, NULL
  97 };
  98
  99 struct belkin_sa_private {
 100         spinlock_t              lock;
 101         unsigned long           control_state;
 102         unsigned char           last_lsr;
 103         unsigned char           last_msr;
 104         int                     bad_flow_control;
 105 };
 106
 107
 108 /*
 109  * ***************************************************************************
 110  * Belkin USB Serial Adapter F5U103 specific driver functions
 111  * ***************************************************************************
 112  */
 113
 114 #define WDR_TIMEOUT 5000 /* default urb timeout */
 115
 116 /* assumes that struct usb_serial *serial is available */
 117 #define BSA_USB_CMD(c, v) usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), \
 118                                             (c), BELKIN_SA_SET_REQUEST_TYPE, \
 119                                             (v), 0, NULL, 0, WDR_TIMEOUT)
 120
 121 /* do some startup allocations not currently performed by usb_serial_probe() */
 122 static int belkin_sa_startup(struct usb_serial *serial)
 123 {
 124         struct usb_device *dev = serial->dev;
 125         struct belkin_sa_private *priv;
 126
 127         /* allocate the private data structure */
 128         priv = kmalloc(sizeof(struct belkin_sa_private), GFP_KERNEL);
 129         if (!priv)
 130                 return -1; /* error */
 131         /* set initial values for control structures */
 132         spin_lock_init(&priv->lock);
 133         priv->control_state = 0;
 134         priv->last_lsr = 0;
 135         priv->last_msr = 0;
 136         /* see comments at top of file */
 137         priv->bad_flow_control =
 138                 (le16_to_cpu(dev->descriptor.bcdDevice) <= 0x0206) ? 1 : 0;
 139         dev_info(&dev->dev, "bcdDevice: %04x, bfc: %d\n",
 140                                         le16_to_cpu(dev->descriptor.bcdDevice),
 141                                         priv->bad_flow_control);
 142
 143         init_waitqueue_head(&serial->port[0]->write_wait);
 144         usb_set_serial_port_data(serial->port[0], priv);
 145
 146         return 0;
 147 }
 148
 149 static void belkin_sa_release(struct usb_serial *serial)
 150 {
 151         int i;
 152
 153         for (i = 0; i < serial->num_ports; ++i)
 154                 kfree(usb_get_serial_port_data(serial->port[i]));
 155 }
 156
 157 static int belkin_sa_open(struct tty_struct *tty,
 158                                         struct usb_serial_port *port)
 159 {
 160         int retval;
 161
 162         retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 163         if (retval) {
 164                 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
 165                 return retval;
 166         }
 167
 168         retval = usb_serial_generic_open(tty, port);
 169         if (retval)
 170                 usb_kill_urb(port->interrupt_in_urb);
 171
 172         return retval;
 173 }
 174
 175 static void belkin_sa_close(struct usb_serial_port *port)
 176 {
 177         usb_serial_generic_close(port);
 178         usb_kill_urb(port->interrupt_in_urb);
 179 }
 180
 181 static void belkin_sa_read_int_callback(struct urb *urb)
 182 {
 183         struct usb_serial_port *port = urb->context;
 184         struct belkin_sa_private *priv;
 185         unsigned char *data = urb->transfer_buffer;
 186         int retval;
 187         int status = urb->status;
 188         unsigned long flags;
 189
 190         switch (status) {
 191         case 0:
 192                 /* success */
 193                 break;
 194         case -ECONNRESET:
 195         case -ENOENT:
 196         case -ESHUTDOWN:
 197                 /* this urb is terminated, clean up */
 198                 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
 199                         __func__, status);
 200                 return;
 201         default:
 202                 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
 203                         __func__, status);
 204                 goto exit;
 205         }
 206
 207         usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
 208
 209         /* Handle known interrupt data */
 210         /* ignore data[0] and data[1] */
 211
 212         priv = usb_get_serial_port_data(port);
 213         spin_lock_irqsave(&priv->lock, flags);
 214         priv->last_msr = data[BELKIN_SA_MSR_INDEX];
 215
 216         /* Record Control Line states */
 217         if (priv->last_msr & BELKIN_SA_MSR_DSR)
 218                 priv->control_state |= TIOCM_DSR;
 219         else
 220                 priv->control_state &= ~TIOCM_DSR;
 221
 222         if (priv->last_msr & BELKIN_SA_MSR_CTS)
 223                 priv->control_state |= TIOCM_CTS;
 224         else
 225                 priv->control_state &= ~TIOCM_CTS;
 226
 227         if (priv->last_msr & BELKIN_SA_MSR_RI)
 228                 priv->control_state |= TIOCM_RI;
 229         else
 230                 priv->control_state &= ~TIOCM_RI;
 231
 232         if (priv->last_msr & BELKIN_SA_MSR_CD)
 233                 priv->control_state |= TIOCM_CD;
 234         else
 235                 priv->control_state &= ~TIOCM_CD;
 236
 237         priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
 238         spin_unlock_irqrestore(&priv->lock, flags);
 239 exit:
 240         retval = usb_submit_urb(urb, GFP_ATOMIC);
 241         if (retval)
 242                 dev_err(&port->dev, "%s - usb_submit_urb failed with "
 243                         "result %d\n", __func__, retval);
 244 }
 245
 246 static void belkin_sa_process_read_urb(struct urb *urb)
 247 {
 248         struct usb_serial_port *port = urb->context;
 249         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 250         struct tty_struct *tty;
 251         unsigned char *data = urb->transfer_buffer;
 252         unsigned long flags;
 253         unsigned char status;
 254         char tty_flag;
 255
 256         /* Update line status */
 257         tty_flag = TTY_NORMAL;
 258
 259         spin_lock_irqsave(&priv->lock, flags);
 260         status = priv->last_lsr;
 261         priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
 262         spin_unlock_irqrestore(&priv->lock, flags);
 263
 264         if (!urb->actual_length)
 265                 return;
 266
 267         tty = tty_port_tty_get(&port->port);
 268         if (!tty)
 269                 return;
 270
 271         if (status & BELKIN_SA_LSR_ERR) {
 272                 /* Break takes precedence over parity, which takes precedence
 273                  * over framing errors. */
 274                 if (status & BELKIN_SA_LSR_BI)
 275                         tty_flag = TTY_BREAK;
 276                 else if (status & BELKIN_SA_LSR_PE)
 277                         tty_flag = TTY_PARITY;
 278                 else if (status & BELKIN_SA_LSR_FE)
 279                         tty_flag = TTY_FRAME;
 280                 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
 281
 282                 /* Overrun is special, not associated with a char. */
 283                 if (status & BELKIN_SA_LSR_OE)
 284                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 285         }
 286
 287         tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
 288                                                         urb->actual_length);
 289         tty_flip_buffer_push(tty);
 290         tty_kref_put(tty);
 291 }
 292
 293 static void belkin_sa_set_termios(struct tty_struct *tty,
 294                 struct usb_serial_port *port, struct ktermios *old_termios)
 295 {
 296         struct usb_serial *serial = port->serial;
 297         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 298         unsigned int iflag;
 299         unsigned int cflag;
 300         unsigned int old_iflag = 0;
 301         unsigned int old_cflag = 0;
 302         __u16 urb_value = 0; /* Will hold the new flags */
 303         unsigned long flags;
 304         unsigned long control_state;
 305         int bad_flow_control;
 306         speed_t baud;
 307         struct ktermios *termios = &tty->termios;
 308
 309         iflag = termios->c_iflag;
 310         cflag = termios->c_cflag;
 311
 312         termios->c_cflag &= ~CMSPAR;
 313
 314         /* get a local copy of the current port settings */
 315         spin_lock_irqsave(&priv->lock, flags);
 316         control_state = priv->control_state;
 317         bad_flow_control = priv->bad_flow_control;
 318         spin_unlock_irqrestore(&priv->lock, flags);
 319
 320         old_iflag = old_termios->c_iflag;
 321         old_cflag = old_termios->c_cflag;
 322
 323         /* Set the baud rate */
 324         if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
 325                 /* reassert DTR and (maybe) RTS on transition from B0 */
 326                 if ((old_cflag & CBAUD) == B0) {
 327                         control_state |= (TIOCM_DTR|TIOCM_RTS);
 328                         if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
 329                                 dev_err(&port->dev, "Set DTR error\n");
 330                         /* don't set RTS if using hardware flow control */
 331                         if (!(old_cflag & CRTSCTS))
 332                                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
 333                                                                 , 1) < 0)
 334                                         dev_err(&port->dev, "Set RTS error\n");
 335                 }
 336         }
 337
 338         baud = tty_get_baud_rate(tty);
 339         if (baud) {
 340                 urb_value = BELKIN_SA_BAUD(baud);
 341                 /* Clip to maximum speed */
 342                 if (urb_value == 0)
 343                         urb_value = 1;
 344                 /* Turn it back into a resulting real baud rate */
 345                 baud = BELKIN_SA_BAUD(urb_value);
 346
 347                 /* Report the actual baud rate back to the caller */
 348                 tty_encode_baud_rate(tty, baud, baud);
 349                 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
 350                         dev_err(&port->dev, "Set baudrate error\n");
 351         } else {
 352                 /* Disable flow control */
 353                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
 354                                                 BELKIN_SA_FLOW_NONE) < 0)
 355                         dev_err(&port->dev, "Disable flowcontrol error\n");
 356                 /* Drop RTS and DTR */
 357                 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 358                 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
 359                         dev_err(&port->dev, "DTR LOW error\n");
 360                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
 361                         dev_err(&port->dev, "RTS LOW error\n");
 362         }
 363
 364         /* set the parity */
 365         if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
 366                 if (cflag & PARENB)
 367                         urb_value = (cflag & PARODD) ?  BELKIN_SA_PARITY_ODD
 368                                                 : BELKIN_SA_PARITY_EVEN;
 369                 else
 370                         urb_value = BELKIN_SA_PARITY_NONE;
 371                 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
 372                         dev_err(&port->dev, "Set parity error\n");
 373         }
 374
 375         /* set the number of data bits */
 376         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 377                 switch (cflag & CSIZE) {
 378                 case CS5:
 379                         urb_value = BELKIN_SA_DATA_BITS(5);
 380                         break;
 381                 case CS6:
 382                         urb_value = BELKIN_SA_DATA_BITS(6);
 383                         break;
 384                 case CS7:
 385                         urb_value = BELKIN_SA_DATA_BITS(7);
 386                         break;
 387                 case CS8:
 388                         urb_value = BELKIN_SA_DATA_BITS(8);
 389                         break;
 390                 default:
 391                         dev_dbg(&port->dev,
 392                                 "CSIZE was not CS5-CS8, using default of 8\n");
 393                         urb_value = BELKIN_SA_DATA_BITS(8);
 394                         break;
 395                 }
 396                 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
 397                         dev_err(&port->dev, "Set data bits error\n");
 398         }
 399
 400         /* set the number of stop bits */
 401         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 402                 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
 403                                                 : BELKIN_SA_STOP_BITS(1);
 404                 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
 405                                                         urb_value) < 0)
 406                         dev_err(&port->dev, "Set stop bits error\n");
 407         }
 408
 409         /* Set flow control */
 410         if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
 411                 ((cflag ^ old_cflag) & CRTSCTS)) {
 412                 urb_value = 0;
 413                 if ((iflag & IXOFF) || (iflag & IXON))
 414                         urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
 415                 else
 416                         urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
 417
 418                 if (cflag & CRTSCTS)
 419                         urb_value |=  (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
 420                 else
 421                         urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
 422
 423                 if (bad_flow_control)
 424                         urb_value &= ~(BELKIN_SA_FLOW_IRTS);
 425
 426                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
 427                         dev_err(&port->dev, "Set flow control error\n");
 428         }
 429
 430         /* save off the modified port settings */
 431         spin_lock_irqsave(&priv->lock, flags);
 432         priv->control_state = control_state;
 433         spin_unlock_irqrestore(&priv->lock, flags);
 434 }
 435
 436 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
 437 {
 438         struct usb_serial_port *port = tty->driver_data;
 439         struct usb_serial *serial = port->serial;
 440
 441         if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
 442                 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
 443 }
 444
 445 static int belkin_sa_tiocmget(struct tty_struct *tty)
 446 {
 447         struct usb_serial_port *port = tty->driver_data;
 448         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 449         unsigned long control_state;
 450         unsigned long flags;
 451
 452         spin_lock_irqsave(&priv->lock, flags);
 453         control_state = priv->control_state;
 454         spin_unlock_irqrestore(&priv->lock, flags);
 455
 456         return control_state;
 457 }
 458
 459 static int belkin_sa_tiocmset(struct tty_struct *tty,
 460                                unsigned int set, unsigned int clear)
 461 {
 462         struct usb_serial_port *port = tty->driver_data;
 463         struct usb_serial *serial = port->serial;
 464         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 465         unsigned long control_state;
 466         unsigned long flags;
 467         int retval;
 468         int rts = 0;
 469         int dtr = 0;
 470
 471         spin_lock_irqsave(&priv->lock, flags);
 472         control_state = priv->control_state;
 473
 474         if (set & TIOCM_RTS) {
 475                 control_state |= TIOCM_RTS;
 476                 rts = 1;
 477         }
 478         if (set & TIOCM_DTR) {
 479                 control_state |= TIOCM_DTR;
 480                 dtr = 1;
 481         }
 482         if (clear & TIOCM_RTS) {
 483                 control_state &= ~TIOCM_RTS;
 484                 rts = 0;
 485         }
 486         if (clear & TIOCM_DTR) {
 487                 control_state &= ~TIOCM_DTR;
 488                 dtr = 0;
 489         }
 490
 491         priv->control_state = control_state;
 492         spin_unlock_irqrestore(&priv->lock, flags);
 493
 494         retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
 495         if (retval < 0) {
 496                 dev_err(&port->dev, "Set RTS error %d\n", retval);
 497                 goto exit;
 498         }
 499
 500         retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
 501         if (retval < 0) {
 502                 dev_err(&port->dev, "Set DTR error %d\n", retval);
 503                 goto exit;
 504         }
 505 exit:
 506         return retval;
 507 }
 508
 509 module_usb_serial_driver(serial_drivers, id_table);
 510
 511 MODULE_AUTHOR(DRIVER_AUTHOR);
 512 MODULE_DESCRIPTION(DRIVER_DESC);
 513 MODULE_VERSION(DRIVER_VERSION);
 514 MODULE_LICENSE("GPL");