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         for (i = 0; i < serial->num_ports; ++i)
 163                 kfree(usb_get_serial_port_data(serial->port[i]));
 164 }
 165
 166 static int belkin_sa_open(struct tty_struct *tty,
 167                                         struct usb_serial_port *port)
 168 {
 169         int retval;
 170
 171         retval = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 172         if (retval) {
 173                 dev_err(&port->dev, "usb_submit_urb(read int) failed\n");
 174                 return retval;
 175         }
 176
 177         retval = usb_serial_generic_open(tty, port);
 178         if (retval)
 179                 usb_kill_urb(port->interrupt_in_urb);
 180
 181         return retval;
 182 }
 183
 184 static void belkin_sa_close(struct usb_serial_port *port)
 185 {
 186         usb_serial_generic_close(port);
 187         usb_kill_urb(port->interrupt_in_urb);
 188 }
 189
 190 static void belkin_sa_read_int_callback(struct urb *urb)
 191 {
 192         struct usb_serial_port *port = urb->context;
 193         struct belkin_sa_private *priv;
 194         unsigned char *data = urb->transfer_buffer;
 195         int retval;
 196         int status = urb->status;
 197         unsigned long flags;
 198
 199         switch (status) {
 200         case 0:
 201                 /* success */
 202                 break;
 203         case -ECONNRESET:
 204         case -ENOENT:
 205         case -ESHUTDOWN:
 206                 /* this urb is terminated, clean up */
 207                 dbg("%s - urb shutting down with status: %d",
 208                     __func__, status);
 209                 return;
 210         default:
 211                 dbg("%s - nonzero urb status received: %d",
 212                     __func__, status);
 213                 goto exit;
 214         }
 215
 216         usb_serial_debug_data(debug, &port->dev, __func__,
 217                                         urb->actual_length, data);
 218
 219         /* Handle known interrupt data */
 220         /* ignore data[0] and data[1] */
 221
 222         priv = usb_get_serial_port_data(port);
 223         spin_lock_irqsave(&priv->lock, flags);
 224         priv->last_msr = data[BELKIN_SA_MSR_INDEX];
 225
 226         /* Record Control Line states */
 227         if (priv->last_msr & BELKIN_SA_MSR_DSR)
 228                 priv->control_state |= TIOCM_DSR;
 229         else
 230                 priv->control_state &= ~TIOCM_DSR;
 231
 232         if (priv->last_msr & BELKIN_SA_MSR_CTS)
 233                 priv->control_state |= TIOCM_CTS;
 234         else
 235                 priv->control_state &= ~TIOCM_CTS;
 236
 237         if (priv->last_msr & BELKIN_SA_MSR_RI)
 238                 priv->control_state |= TIOCM_RI;
 239         else
 240                 priv->control_state &= ~TIOCM_RI;
 241
 242         if (priv->last_msr & BELKIN_SA_MSR_CD)
 243                 priv->control_state |= TIOCM_CD;
 244         else
 245                 priv->control_state &= ~TIOCM_CD;
 246
 247         priv->last_lsr = data[BELKIN_SA_LSR_INDEX];
 248         spin_unlock_irqrestore(&priv->lock, flags);
 249 exit:
 250         retval = usb_submit_urb(urb, GFP_ATOMIC);
 251         if (retval)
 252                 dev_err(&port->dev, "%s - usb_submit_urb failed with "
 253                         "result %d\n", __func__, retval);
 254 }
 255
 256 static void belkin_sa_process_read_urb(struct urb *urb)
 257 {
 258         struct usb_serial_port *port = urb->context;
 259         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 260         struct tty_struct *tty;
 261         unsigned char *data = urb->transfer_buffer;
 262         unsigned long flags;
 263         unsigned char status;
 264         char tty_flag;
 265
 266         /* Update line status */
 267         tty_flag = TTY_NORMAL;
 268
 269         spin_lock_irqsave(&priv->lock, flags);
 270         status = priv->last_lsr;
 271         priv->last_lsr &= ~BELKIN_SA_LSR_ERR;
 272         spin_unlock_irqrestore(&priv->lock, flags);
 273
 274         if (!urb->actual_length)
 275                 return;
 276
 277         tty = tty_port_tty_get(&port->port);
 278         if (!tty)
 279                 return;
 280
 281         if (status & BELKIN_SA_LSR_ERR) {
 282                 /* Break takes precedence over parity, which takes precedence
 283                  * over framing errors. */
 284                 if (status & BELKIN_SA_LSR_BI)
 285                         tty_flag = TTY_BREAK;
 286                 else if (status & BELKIN_SA_LSR_PE)
 287                         tty_flag = TTY_PARITY;
 288                 else if (status & BELKIN_SA_LSR_FE)
 289                         tty_flag = TTY_FRAME;
 290                 dev_dbg(&port->dev, "tty_flag = %d\n", tty_flag);
 291
 292                 /* Overrun is special, not associated with a char. */
 293                 if (status & BELKIN_SA_LSR_OE)
 294                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 295         }
 296
 297         tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
 298                                                         urb->actual_length);
 299         tty_flip_buffer_push(tty);
 300         tty_kref_put(tty);
 301 }
 302
 303 static void belkin_sa_set_termios(struct tty_struct *tty,
 304                 struct usb_serial_port *port, struct ktermios *old_termios)
 305 {
 306         struct usb_serial *serial = port->serial;
 307         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 308         unsigned int iflag;
 309         unsigned int cflag;
 310         unsigned int old_iflag = 0;
 311         unsigned int old_cflag = 0;
 312         __u16 urb_value = 0; /* Will hold the new flags */
 313         unsigned long flags;
 314         unsigned long control_state;
 315         int bad_flow_control;
 316         speed_t baud;
 317         struct ktermios *termios = tty->termios;
 318
 319         iflag = termios->c_iflag;
 320         cflag = termios->c_cflag;
 321
 322         termios->c_cflag &= ~CMSPAR;
 323
 324         /* get a local copy of the current port settings */
 325         spin_lock_irqsave(&priv->lock, flags);
 326         control_state = priv->control_state;
 327         bad_flow_control = priv->bad_flow_control;
 328         spin_unlock_irqrestore(&priv->lock, flags);
 329
 330         old_iflag = old_termios->c_iflag;
 331         old_cflag = old_termios->c_cflag;
 332
 333         /* Set the baud rate */
 334         if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
 335                 /* reassert DTR and (maybe) RTS on transition from B0 */
 336                 if ((old_cflag & CBAUD) == B0) {
 337                         control_state |= (TIOCM_DTR|TIOCM_RTS);
 338                         if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 1) < 0)
 339                                 dev_err(&port->dev, "Set DTR error\n");
 340                         /* don't set RTS if using hardware flow control */
 341                         if (!(old_cflag & CRTSCTS))
 342                                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST
 343                                                                 , 1) < 0)
 344                                         dev_err(&port->dev, "Set RTS error\n");
 345                 }
 346         }
 347
 348         baud = tty_get_baud_rate(tty);
 349         if (baud) {
 350                 urb_value = BELKIN_SA_BAUD(baud);
 351                 /* Clip to maximum speed */
 352                 if (urb_value == 0)
 353                         urb_value = 1;
 354                 /* Turn it back into a resulting real baud rate */
 355                 baud = BELKIN_SA_BAUD(urb_value);
 356
 357                 /* Report the actual baud rate back to the caller */
 358                 tty_encode_baud_rate(tty, baud, baud);
 359                 if (BSA_USB_CMD(BELKIN_SA_SET_BAUDRATE_REQUEST, urb_value) < 0)
 360                         dev_err(&port->dev, "Set baudrate error\n");
 361         } else {
 362                 /* Disable flow control */
 363                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST,
 364                                                 BELKIN_SA_FLOW_NONE) < 0)
 365                         dev_err(&port->dev, "Disable flowcontrol error\n");
 366                 /* Drop RTS and DTR */
 367                 control_state &= ~(TIOCM_DTR | TIOCM_RTS);
 368                 if (BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, 0) < 0)
 369                         dev_err(&port->dev, "DTR LOW error\n");
 370                 if (BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, 0) < 0)
 371                         dev_err(&port->dev, "RTS LOW error\n");
 372         }
 373
 374         /* set the parity */
 375         if ((cflag ^ old_cflag) & (PARENB | PARODD)) {
 376                 if (cflag & PARENB)
 377                         urb_value = (cflag & PARODD) ?  BELKIN_SA_PARITY_ODD
 378                                                 : BELKIN_SA_PARITY_EVEN;
 379                 else
 380                         urb_value = BELKIN_SA_PARITY_NONE;
 381                 if (BSA_USB_CMD(BELKIN_SA_SET_PARITY_REQUEST, urb_value) < 0)
 382                         dev_err(&port->dev, "Set parity error\n");
 383         }
 384
 385         /* set the number of data bits */
 386         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
 387                 switch (cflag & CSIZE) {
 388                 case CS5:
 389                         urb_value = BELKIN_SA_DATA_BITS(5);
 390                         break;
 391                 case CS6:
 392                         urb_value = BELKIN_SA_DATA_BITS(6);
 393                         break;
 394                 case CS7:
 395                         urb_value = BELKIN_SA_DATA_BITS(7);
 396                         break;
 397                 case CS8:
 398                         urb_value = BELKIN_SA_DATA_BITS(8);
 399                         break;
 400                 default:
 401                         dbg("CSIZE was not CS5-CS8, using default of 8");
 402                         urb_value = BELKIN_SA_DATA_BITS(8);
 403                         break;
 404                 }
 405                 if (BSA_USB_CMD(BELKIN_SA_SET_DATA_BITS_REQUEST, urb_value) < 0)
 406                         dev_err(&port->dev, "Set data bits error\n");
 407         }
 408
 409         /* set the number of stop bits */
 410         if ((cflag & CSTOPB) != (old_cflag & CSTOPB)) {
 411                 urb_value = (cflag & CSTOPB) ? BELKIN_SA_STOP_BITS(2)
 412                                                 : BELKIN_SA_STOP_BITS(1);
 413                 if (BSA_USB_CMD(BELKIN_SA_SET_STOP_BITS_REQUEST,
 414                                                         urb_value) < 0)
 415                         dev_err(&port->dev, "Set stop bits error\n");
 416         }
 417
 418         /* Set flow control */
 419         if (((iflag ^ old_iflag) & (IXOFF | IXON)) ||
 420                 ((cflag ^ old_cflag) & CRTSCTS)) {
 421                 urb_value = 0;
 422                 if ((iflag & IXOFF) || (iflag & IXON))
 423                         urb_value |= (BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
 424                 else
 425                         urb_value &= ~(BELKIN_SA_FLOW_OXON | BELKIN_SA_FLOW_IXON);
 426
 427                 if (cflag & CRTSCTS)
 428                         urb_value |=  (BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
 429                 else
 430                         urb_value &= ~(BELKIN_SA_FLOW_OCTS | BELKIN_SA_FLOW_IRTS);
 431
 432                 if (bad_flow_control)
 433                         urb_value &= ~(BELKIN_SA_FLOW_IRTS);
 434
 435                 if (BSA_USB_CMD(BELKIN_SA_SET_FLOW_CTRL_REQUEST, urb_value) < 0)
 436                         dev_err(&port->dev, "Set flow control error\n");
 437         }
 438
 439         /* save off the modified port settings */
 440         spin_lock_irqsave(&priv->lock, flags);
 441         priv->control_state = control_state;
 442         spin_unlock_irqrestore(&priv->lock, flags);
 443 }
 444
 445 static void belkin_sa_break_ctl(struct tty_struct *tty, int break_state)
 446 {
 447         struct usb_serial_port *port = tty->driver_data;
 448         struct usb_serial *serial = port->serial;
 449
 450         if (BSA_USB_CMD(BELKIN_SA_SET_BREAK_REQUEST, break_state ? 1 : 0) < 0)
 451                 dev_err(&port->dev, "Set break_ctl %d\n", break_state);
 452 }
 453
 454 static int belkin_sa_tiocmget(struct tty_struct *tty)
 455 {
 456         struct usb_serial_port *port = tty->driver_data;
 457         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 458         unsigned long control_state;
 459         unsigned long flags;
 460
 461         spin_lock_irqsave(&priv->lock, flags);
 462         control_state = priv->control_state;
 463         spin_unlock_irqrestore(&priv->lock, flags);
 464
 465         return control_state;
 466 }
 467
 468 static int belkin_sa_tiocmset(struct tty_struct *tty,
 469                                unsigned int set, unsigned int clear)
 470 {
 471         struct usb_serial_port *port = tty->driver_data;
 472         struct usb_serial *serial = port->serial;
 473         struct belkin_sa_private *priv = usb_get_serial_port_data(port);
 474         unsigned long control_state;
 475         unsigned long flags;
 476         int retval;
 477         int rts = 0;
 478         int dtr = 0;
 479
 480         spin_lock_irqsave(&priv->lock, flags);
 481         control_state = priv->control_state;
 482
 483         if (set & TIOCM_RTS) {
 484                 control_state |= TIOCM_RTS;
 485                 rts = 1;
 486         }
 487         if (set & TIOCM_DTR) {
 488                 control_state |= TIOCM_DTR;
 489                 dtr = 1;
 490         }
 491         if (clear & TIOCM_RTS) {
 492                 control_state &= ~TIOCM_RTS;
 493                 rts = 0;
 494         }
 495         if (clear & TIOCM_DTR) {
 496                 control_state &= ~TIOCM_DTR;
 497                 dtr = 0;
 498         }
 499
 500         priv->control_state = control_state;
 501         spin_unlock_irqrestore(&priv->lock, flags);
 502
 503         retval = BSA_USB_CMD(BELKIN_SA_SET_RTS_REQUEST, rts);
 504         if (retval < 0) {
 505                 dev_err(&port->dev, "Set RTS error %d\n", retval);
 506                 goto exit;
 507         }
 508
 509         retval = BSA_USB_CMD(BELKIN_SA_SET_DTR_REQUEST, dtr);
 510         if (retval < 0) {
 511                 dev_err(&port->dev, "Set DTR error %d\n", retval);
 512                 goto exit;
 513         }
 514 exit:
 515         return retval;
 516 }
 517
 518 module_usb_serial_driver(belkin_driver, serial_drivers);
 519
 520 MODULE_AUTHOR(DRIVER_AUTHOR);
 521 MODULE_DESCRIPTION(DRIVER_DESC);
 522 MODULE_VERSION(DRIVER_VERSION);
 523 MODULE_LICENSE("GPL");
 524
 525 module_param(debug, bool, S_IRUGO | S_IWUSR);
 526 MODULE_PARM_DESC(debug, "Debug enabled or not");