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