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