drivers/usb/serial/pl2303.c

   1 /*
   2  * Prolific PL2303 USB to serial adaptor driver
   3  *
   4  * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
   5  * Copyright (C) 2003 IBM Corp.
   6  *
   7  * Original driver for 2.2.x by anonymous
   8  *
   9  *      This program is free software; you can redistribute it and/or
  10  *      modify it under the terms of the GNU General Public License version
  11  *      2 as published by the Free Software Foundation.
  12  *
  13  * See Documentation/usb/usb-serial.txt for more information on using this
  14  * driver
  15  *
  16  */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/errno.h>
  20 #include <linux/init.h>
  21 #include <linux/slab.h>
  22 #include <linux/tty.h>
  23 #include <linux/tty_driver.h>
  24 #include <linux/tty_flip.h>
  25 #include <linux/serial.h>
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/uaccess.h>
  30 #include <linux/usb.h>
  31 #include <linux/usb/serial.h>
  32 #include "pl2303.h"
  33
  34 /*
  35  * Version Information
  36  */
  37 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
  38
  39 static int debug;
  40
  41 #define PL2303_CLOSING_WAIT     (30*HZ)
  42
  43 static const struct usb_device_id id_table[] = {
  44         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
  45         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
  46         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
  47         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
  48         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
  49         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
  50         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
  51         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
  52         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
  53         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
  54         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ZTEK) },
  55         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
  56         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
  57         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
  58         { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
  59         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
  60         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
  61         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
  62         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
  63         { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
  64         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
  65         { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
  66         { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
  67         { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
  68         { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
  69         { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
  70         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
  71         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
  72         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
  73         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81) },
  74         { USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
  75         { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
  76         { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
  77         { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
  78         { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
  79         { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
  80         { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
  81         { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
  82         { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
  83         { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
  84         { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
  85         { USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
  86         { USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
  87         { USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
  88         { USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
  89         { USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
  90         { USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
  91         { USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
  92         { USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
  93         { USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
  94         { USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
  95         { USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
  96         { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
  97         { USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
  98         { }                                     /* Terminating entry */
  99 };
 100
 101 MODULE_DEVICE_TABLE(usb, id_table);
 102
 103 static struct usb_driver pl2303_driver = {
 104         .name =         "pl2303",
 105         .probe =        usb_serial_probe,
 106         .disconnect =   usb_serial_disconnect,
 107         .id_table =     id_table,
 108         .suspend =      usb_serial_suspend,
 109         .resume =       usb_serial_resume,
 110         .no_dynamic_id =        1,
 111         .supports_autosuspend = 1,
 112 };
 113
 114 #define SET_LINE_REQUEST_TYPE           0x21
 115 #define SET_LINE_REQUEST                0x20
 116
 117 #define SET_CONTROL_REQUEST_TYPE        0x21
 118 #define SET_CONTROL_REQUEST             0x22
 119 #define CONTROL_DTR                     0x01
 120 #define CONTROL_RTS                     0x02
 121
 122 #define BREAK_REQUEST_TYPE              0x21
 123 #define BREAK_REQUEST                   0x23
 124 #define BREAK_ON                        0xffff
 125 #define BREAK_OFF                       0x0000
 126
 127 #define GET_LINE_REQUEST_TYPE           0xa1
 128 #define GET_LINE_REQUEST                0x21
 129
 130 #define VENDOR_WRITE_REQUEST_TYPE       0x40
 131 #define VENDOR_WRITE_REQUEST            0x01
 132
 133 #define VENDOR_READ_REQUEST_TYPE        0xc0
 134 #define VENDOR_READ_REQUEST             0x01
 135
 136 #define UART_STATE                      0x08
 137 #define UART_STATE_TRANSIENT_MASK       0x74
 138 #define UART_DCD                        0x01
 139 #define UART_DSR                        0x02
 140 #define UART_BREAK_ERROR                0x04
 141 #define UART_RING                       0x08
 142 #define UART_FRAME_ERROR                0x10
 143 #define UART_PARITY_ERROR               0x20
 144 #define UART_OVERRUN_ERROR              0x40
 145 #define UART_CTS                        0x80
 146
 147
 148 enum pl2303_type {
 149         type_0,         /* don't know the difference between type 0 and */
 150         type_1,         /* type 1, until someone from prolific tells us... */
 151         HX,             /* HX version of the pl2303 chip */
 152 };
 153
 154 struct pl2303_private {
 155         spinlock_t lock;
 156         u8 line_control;
 157         u8 line_status;
 158         enum pl2303_type type;
 159
 160         u8 line_settings[7];
 161 };
 162
 163 static int pl2303_vendor_read(__u16 value, __u16 index,
 164                 struct usb_serial *serial, unsigned char *buf)
 165 {
 166         int res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 167                         VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
 168                         value, index, buf, 1, 100);
 169         dbg("0x%x:0x%x:0x%x:0x%x  %d - %x", VENDOR_READ_REQUEST_TYPE,
 170                         VENDOR_READ_REQUEST, value, index, res, buf[0]);
 171         return res;
 172 }
 173
 174 static int pl2303_vendor_write(__u16 value, __u16 index,
 175                 struct usb_serial *serial)
 176 {
 177         int res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 178                         VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
 179                         value, index, NULL, 0, 100);
 180         dbg("0x%x:0x%x:0x%x:0x%x  %d", VENDOR_WRITE_REQUEST_TYPE,
 181                         VENDOR_WRITE_REQUEST, value, index, res);
 182         return res;
 183 }
 184
 185 static int pl2303_startup(struct usb_serial *serial)
 186 {
 187         struct pl2303_private *priv;
 188         unsigned char num_ports = serial->num_ports;
 189         enum pl2303_type type = type_0;
 190         unsigned char *buf;
 191         int i;
 192
 193         if (serial->num_bulk_in < num_ports ||
 194                         serial->num_bulk_out < num_ports ||
 195                         serial->num_interrupt_in < num_ports) {
 196                 dev_err(&serial->interface->dev, "missing endpoints\n");
 197                 return -ENODEV;
 198         }
 199
 200         buf = kmalloc(10, GFP_KERNEL);
 201         if (buf == NULL)
 202                 return -ENOMEM;
 203
 204         if (serial->dev->descriptor.bDeviceClass == 0x02)
 205                 type = type_0;
 206         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 207                 type = HX;
 208         else if (serial->dev->descriptor.bDeviceClass == 0x00)
 209                 type = type_1;
 210         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
 211                 type = type_1;
 212         dbg("device type: %d", type);
 213
 214         for (i = 0; i < serial->num_ports; ++i) {
 215                 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
 216                 if (!priv)
 217                         goto cleanup;
 218                 spin_lock_init(&priv->lock);
 219                 priv->type = type;
 220                 usb_set_serial_port_data(serial->port[i], priv);
 221         }
 222
 223         pl2303_vendor_read(0x8484, 0, serial, buf);
 224         pl2303_vendor_write(0x0404, 0, serial);
 225         pl2303_vendor_read(0x8484, 0, serial, buf);
 226         pl2303_vendor_read(0x8383, 0, serial, buf);
 227         pl2303_vendor_read(0x8484, 0, serial, buf);
 228         pl2303_vendor_write(0x0404, 1, serial);
 229         pl2303_vendor_read(0x8484, 0, serial, buf);
 230         pl2303_vendor_read(0x8383, 0, serial, buf);
 231         pl2303_vendor_write(0, 1, serial);
 232         pl2303_vendor_write(1, 0, serial);
 233         if (type == HX)
 234                 pl2303_vendor_write(2, 0x44, serial);
 235         else
 236                 pl2303_vendor_write(2, 0x24, serial);
 237
 238         kfree(buf);
 239         return 0;
 240
 241 cleanup:
 242         kfree(buf);
 243         for (--i; i >= 0; --i) {
 244                 priv = usb_get_serial_port_data(serial->port[i]);
 245                 kfree(priv);
 246                 usb_set_serial_port_data(serial->port[i], NULL);
 247         }
 248         return -ENOMEM;
 249 }
 250
 251 static int set_control_lines(struct usb_device *dev, u8 value)
 252 {
 253         int retval;
 254
 255         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 256                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 257                                  value, 0, NULL, 0, 100);
 258         dbg("%s - value = %d, retval = %d", __func__, value, retval);
 259         return retval;
 260 }
 261
 262 static void pl2303_set_termios(struct tty_struct *tty,
 263                 struct usb_serial_port *port, struct ktermios *old_termios)
 264 {
 265         struct usb_serial *serial = port->serial;
 266         struct pl2303_private *priv = usb_get_serial_port_data(port);
 267         unsigned long flags;
 268         unsigned int cflag;
 269         unsigned char *buf;
 270         int baud;
 271         int i;
 272         u8 control;
 273         const int baud_sup[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
 274                                  4800, 7200, 9600, 14400, 19200, 28800, 38400,
 275                                  57600, 115200, 230400, 460800, 614400,
 276                                  921600, 1228800, 2457600, 3000000, 6000000 };
 277         int baud_floor, baud_ceil;
 278         int k;
 279
 280         dbg("%s -  port %d", __func__, port->number);
 281
 282         if (old_termios && !tty_termios_hw_change(tty->termios, old_termios))
 283                 return;
 284
 285         cflag = tty->termios->c_cflag;
 286
 287         buf = kzalloc(7, GFP_KERNEL);
 288         if (!buf) {
 289                 dev_err(&port->dev, "%s - out of memory.\n", __func__);
 290                 /* Report back no change occurred */
 291                 if (old_termios)
 292                         *tty->termios = *old_termios;
 293                 return;
 294         }
 295
 296         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 297                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 298                             0, 0, buf, 7, 100);
 299         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 300             buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 301
 302         switch (C_CSIZE(tty)) {
 303         case CS5:
 304                 buf[6] = 5;
 305                 break;
 306         case CS6:
 307                 buf[6] = 6;
 308                 break;
 309         case CS7:
 310                 buf[6] = 7;
 311                 break;
 312         default:
 313         case CS8:
 314                 buf[6] = 8;
 315         }
 316         dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
 317
 318         /* For reference buf[0]:buf[3] baud rate value */
 319         /* NOTE: Only the values defined in baud_sup are supported !
 320          *       => if unsupported values are set, the PL2303 seems to use
 321          *          9600 baud (at least my PL2303X always does)
 322          */
 323         baud = tty_get_baud_rate(tty);
 324         dbg("%s - baud requested = %d", __func__, baud);
 325         if (baud) {
 326                 /* Set baudrate to nearest supported value */
 327                 for (k=0; k<ARRAY_SIZE(baud_sup); k++) {
 328                         if (baud_sup[k] / baud) {
 329                                 baud_ceil = baud_sup[k];
 330                                 if (k==0) {
 331                                         baud = baud_ceil;
 332                                 } else {
 333                                         baud_floor = baud_sup[k-1];
 334                                         if ((baud_ceil % baud)
 335                                             > (baud % baud_floor))
 336                                                 baud = baud_floor;
 337                                         else
 338                                                 baud = baud_ceil;
 339                                 }
 340                                 break;
 341                         }
 342                 }
 343                 if (baud > 1228800) {
 344                         /* type_0, type_1 only support up to 1228800 baud */
 345                         if (priv->type != HX)
 346                                 baud = 1228800;
 347                         else if (baud > 6000000)
 348                                 baud = 6000000;
 349                 }
 350                 dbg("%s - baud set = %d", __func__, baud);
 351                 if (baud <= 115200) {
 352                         buf[0] = baud & 0xff;
 353                         buf[1] = (baud >> 8) & 0xff;
 354                         buf[2] = (baud >> 16) & 0xff;
 355                         buf[3] = (baud >> 24) & 0xff;
 356                 } else {
 357                         /* apparently the formula for higher speeds is:
 358                          * baudrate = 12M * 32 / (2^buf[1]) / buf[0]
 359                          */
 360                         unsigned tmp = 12*1000*1000*32 / baud;
 361                         buf[3] = 0x80;
 362                         buf[2] = 0;
 363                         buf[1] = (tmp >= 256);
 364                         while (tmp >= 256) {
 365                                 tmp >>= 2;
 366                                 buf[1] <<= 1;
 367                         }
 368                         buf[0] = tmp;
 369                 }
 370         }
 371
 372         /* For reference buf[4]=0 is 1 stop bits */
 373         /* For reference buf[4]=1 is 1.5 stop bits */
 374         /* For reference buf[4]=2 is 2 stop bits */
 375         if (cflag & CSTOPB) {
 376                 /* NOTE: Comply with "real" UARTs / RS232:
 377                  *       use 1.5 instead of 2 stop bits with 5 data bits
 378                  */
 379                 if ((cflag & CSIZE) == CS5) {
 380                         buf[4] = 1;
 381                         dbg("%s - stop bits = 1.5", __func__);
 382                 } else {
 383                         buf[4] = 2;
 384                         dbg("%s - stop bits = 2", __func__);
 385                 }
 386         } else {
 387                 buf[4] = 0;
 388                 dbg("%s - stop bits = 1", __func__);
 389         }
 390
 391         if (cflag & PARENB) {
 392                 /* For reference buf[5]=0 is none parity */
 393                 /* For reference buf[5]=1 is odd parity */
 394                 /* For reference buf[5]=2 is even parity */
 395                 /* For reference buf[5]=3 is mark parity */
 396                 /* For reference buf[5]=4 is space parity */
 397                 if (cflag & PARODD) {
 398                         if (cflag & CMSPAR) {
 399                                 buf[5] = 3;
 400                                 dbg("%s - parity = mark", __func__);
 401                         } else {
 402                                 buf[5] = 1;
 403                                 dbg("%s - parity = odd", __func__);
 404                         }
 405                 } else {
 406                         if (cflag & CMSPAR) {
 407                                 buf[5] = 4;
 408                                 dbg("%s - parity = space", __func__);
 409                         } else {
 410                                 buf[5] = 2;
 411                                 dbg("%s - parity = even", __func__);
 412                         }
 413                 }
 414         } else {
 415                 buf[5] = 0;
 416                 dbg("%s - parity = none", __func__);
 417         }
 418
 419         /*
 420          * Some PL2303 are known to lose bytes if you change serial settings
 421          * even to the same values as before. Thus we actually need to filter
 422          * in this specific case.
 423          *
 424          * Note that the tty_termios_hw_change check above is not sufficient
 425          * as a previously requested baud rate may differ from the one
 426          * actually used (and stored in old_termios).
 427          *
 428          * NOTE: No additional locking needed for line_settings as it is
 429          *       only used in set_termios, which is serialised against itself.
 430          */
 431         if (!old_termios || memcmp(buf, priv->line_settings, 7)) {
 432                 i = usb_control_msg(serial->dev,
 433                                     usb_sndctrlpipe(serial->dev, 0),
 434                                     SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 435                                     0, 0, buf, 7, 100);
 436
 437                 dbg("0x21:0x20:0:0  %d", i);
 438
 439                 if (i == 7)
 440                         memcpy(priv->line_settings, buf, 7);
 441         }
 442
 443         /* change control lines if we are switching to or from B0 */
 444         spin_lock_irqsave(&priv->lock, flags);
 445         control = priv->line_control;
 446         if ((cflag & CBAUD) == B0)
 447                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 448         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 449                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 450         if (control != priv->line_control) {
 451                 control = priv->line_control;
 452                 spin_unlock_irqrestore(&priv->lock, flags);
 453                 set_control_lines(serial->dev, control);
 454         } else {
 455                 spin_unlock_irqrestore(&priv->lock, flags);
 456         }
 457
 458         buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
 459
 460         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 461                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 462                             0, 0, buf, 7, 100);
 463         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 464              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 465
 466         if (cflag & CRTSCTS) {
 467                 if (priv->type == HX)
 468                         pl2303_vendor_write(0x0, 0x61, serial);
 469                 else
 470                         pl2303_vendor_write(0x0, 0x41, serial);
 471         } else {
 472                 pl2303_vendor_write(0x0, 0x0, serial);
 473         }
 474
 475         /* Save resulting baud rate */
 476         if (baud)
 477                 tty_encode_baud_rate(tty, baud, baud);
 478
 479         kfree(buf);
 480 }
 481
 482 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
 483 {
 484         struct pl2303_private *priv = usb_get_serial_port_data(port);
 485         unsigned long flags;
 486         u8 control;
 487
 488         spin_lock_irqsave(&priv->lock, flags);
 489         /* Change DTR and RTS */
 490         if (on)
 491                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 492         else
 493                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 494         control = priv->line_control;
 495         spin_unlock_irqrestore(&priv->lock, flags);
 496         set_control_lines(port->serial->dev, control);
 497 }
 498
 499 static void pl2303_close(struct usb_serial_port *port)
 500 {
 501         dbg("%s - port %d", __func__, port->number);
 502
 503         usb_serial_generic_close(port);
 504         usb_kill_urb(port->interrupt_in_urb);
 505 }
 506
 507 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
 508 {
 509         struct usb_serial *serial = port->serial;
 510         struct pl2303_private *priv = usb_get_serial_port_data(port);
 511         int result;
 512
 513         dbg("%s -  port %d", __func__, port->number);
 514
 515         if (priv->type != HX) {
 516                 usb_clear_halt(serial->dev, port->write_urb->pipe);
 517                 usb_clear_halt(serial->dev, port->read_urb->pipe);
 518         } else {
 519                 /* reset upstream data pipes */
 520                 pl2303_vendor_write(8, 0, serial);
 521                 pl2303_vendor_write(9, 0, serial);
 522         }
 523
 524         /* Setup termios */
 525         if (tty)
 526                 pl2303_set_termios(tty, port, NULL);
 527
 528         dbg("%s - submitting read urb", __func__);
 529         result = usb_serial_generic_submit_read_urb(port, GFP_KERNEL);
 530         if (result) {
 531                 pl2303_close(port);
 532                 return -EPROTO;
 533         }
 534
 535         dbg("%s - submitting interrupt urb", __func__);
 536         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 537         if (result) {
 538                 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
 539                         " error %d\n", __func__, result);
 540                 pl2303_close(port);
 541                 return -EPROTO;
 542         }
 543         port->port.drain_delay = 256;
 544         return 0;
 545 }
 546
 547 static int pl2303_tiocmset(struct tty_struct *tty,
 548                            unsigned int set, unsigned int clear)
 549 {
 550         struct usb_serial_port *port = tty->driver_data;
 551         struct pl2303_private *priv = usb_get_serial_port_data(port);
 552         unsigned long flags;
 553         u8 control;
 554
 555         if (!usb_get_intfdata(port->serial->interface))
 556                 return -ENODEV;
 557
 558         spin_lock_irqsave(&priv->lock, flags);
 559         if (set & TIOCM_RTS)
 560                 priv->line_control |= CONTROL_RTS;
 561         if (set & TIOCM_DTR)
 562                 priv->line_control |= CONTROL_DTR;
 563         if (clear & TIOCM_RTS)
 564                 priv->line_control &= ~CONTROL_RTS;
 565         if (clear & TIOCM_DTR)
 566                 priv->line_control &= ~CONTROL_DTR;
 567         control = priv->line_control;
 568         spin_unlock_irqrestore(&priv->lock, flags);
 569
 570         return set_control_lines(port->serial->dev, control);
 571 }
 572
 573 static int pl2303_tiocmget(struct tty_struct *tty)
 574 {
 575         struct usb_serial_port *port = tty->driver_data;
 576         struct pl2303_private *priv = usb_get_serial_port_data(port);
 577         unsigned long flags;
 578         unsigned int mcr;
 579         unsigned int status;
 580         unsigned int result;
 581
 582         dbg("%s (%d)", __func__, port->number);
 583
 584         if (!usb_get_intfdata(port->serial->interface))
 585                 return -ENODEV;
 586
 587         spin_lock_irqsave(&priv->lock, flags);
 588         mcr = priv->line_control;
 589         status = priv->line_status;
 590         spin_unlock_irqrestore(&priv->lock, flags);
 591
 592         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
 593                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
 594                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 595                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 596                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
 597                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
 598
 599         dbg("%s - result = %x", __func__, result);
 600
 601         return result;
 602 }
 603
 604 static int pl2303_carrier_raised(struct usb_serial_port *port)
 605 {
 606         struct pl2303_private *priv = usb_get_serial_port_data(port);
 607         if (priv->line_status & UART_DCD)
 608                 return 1;
 609         return 0;
 610 }
 611
 612 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
 613 {
 614         struct pl2303_private *priv = usb_get_serial_port_data(port);
 615         unsigned long flags;
 616         unsigned int prevstatus;
 617         unsigned int status;
 618         unsigned int changed;
 619
 620         spin_lock_irqsave(&priv->lock, flags);
 621         prevstatus = priv->line_status;
 622         spin_unlock_irqrestore(&priv->lock, flags);
 623
 624         while (1) {
 625                 interruptible_sleep_on(&port->delta_msr_wait);
 626                 /* see if a signal did it */
 627                 if (signal_pending(current))
 628                         return -ERESTARTSYS;
 629
 630                 if (port->serial->disconnected)
 631                         return -EIO;
 632
 633                 spin_lock_irqsave(&priv->lock, flags);
 634                 status = priv->line_status;
 635                 spin_unlock_irqrestore(&priv->lock, flags);
 636
 637                 changed = prevstatus ^ status;
 638
 639                 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
 640                     ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
 641                     ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
 642                     ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
 643                         return 0;
 644                 }
 645                 prevstatus = status;
 646         }
 647         /* NOTREACHED */
 648         return 0;
 649 }
 650
 651 static int pl2303_ioctl(struct tty_struct *tty,
 652                         unsigned int cmd, unsigned long arg)
 653 {
 654         struct serial_struct ser;
 655         struct usb_serial_port *port = tty->driver_data;
 656         dbg("%s (%d) cmd = 0x%04x", __func__, port->number, cmd);
 657
 658         switch (cmd) {
 659         case TIOCGSERIAL:
 660                 memset(&ser, 0, sizeof ser);
 661                 ser.type = PORT_16654;
 662                 ser.line = port->serial->minor;
 663                 ser.port = port->number;
 664                 ser.baud_base = 460800;
 665
 666                 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
 667                         return -EFAULT;
 668
 669                 return 0;
 670
 671         case TIOCMIWAIT:
 672                 dbg("%s (%d) TIOCMIWAIT", __func__,  port->number);
 673                 return wait_modem_info(port, arg);
 674         default:
 675                 dbg("%s not supported = 0x%04x", __func__, cmd);
 676                 break;
 677         }
 678         return -ENOIOCTLCMD;
 679 }
 680
 681 static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
 682 {
 683         struct usb_serial_port *port = tty->driver_data;
 684         struct usb_serial *serial = port->serial;
 685         u16 state;
 686         int result;
 687
 688         dbg("%s - port %d", __func__, port->number);
 689
 690         if (break_state == 0)
 691                 state = BREAK_OFF;
 692         else
 693                 state = BREAK_ON;
 694         dbg("%s - turning break %s", __func__,
 695                         state == BREAK_OFF ? "off" : "on");
 696
 697         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 698                                  BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
 699                                  0, NULL, 0, 100);
 700         if (result)
 701                 dbg("%s - error sending break = %d", __func__, result);
 702 }
 703
 704 static void pl2303_release(struct usb_serial *serial)
 705 {
 706         int i;
 707         struct pl2303_private *priv;
 708
 709         dbg("%s", __func__);
 710
 711         for (i = 0; i < serial->num_ports; ++i) {
 712                 priv = usb_get_serial_port_data(serial->port[i]);
 713                 kfree(priv);
 714         }
 715 }
 716
 717 static void pl2303_update_line_status(struct usb_serial_port *port,
 718                                       unsigned char *data,
 719                                       unsigned int actual_length)
 720 {
 721
 722         struct pl2303_private *priv = usb_get_serial_port_data(port);
 723         struct tty_struct *tty;
 724         unsigned long flags;
 725         u8 status_idx = UART_STATE;
 726         u8 length = UART_STATE + 1;
 727         u8 prev_line_status;
 728         u16 idv, idp;
 729
 730         idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
 731         idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
 732
 733
 734         if (idv == SIEMENS_VENDOR_ID) {
 735                 if (idp == SIEMENS_PRODUCT_ID_X65 ||
 736                     idp == SIEMENS_PRODUCT_ID_SX1 ||
 737                     idp == SIEMENS_PRODUCT_ID_X75) {
 738
 739                         length = 1;
 740                         status_idx = 0;
 741                 }
 742         }
 743
 744         if (actual_length < length)
 745                 return;
 746
 747         /* Save off the uart status for others to look at */
 748         spin_lock_irqsave(&priv->lock, flags);
 749         prev_line_status = priv->line_status;
 750         priv->line_status = data[status_idx];
 751         spin_unlock_irqrestore(&priv->lock, flags);
 752         if (priv->line_status & UART_BREAK_ERROR)
 753                 usb_serial_handle_break(port);
 754         wake_up_interruptible(&port->delta_msr_wait);
 755
 756         tty = tty_port_tty_get(&port->port);
 757         if (!tty)
 758                 return;
 759         if ((priv->line_status ^ prev_line_status) & UART_DCD)
 760                 usb_serial_handle_dcd_change(port, tty,
 761                                 priv->line_status & UART_DCD);
 762         tty_kref_put(tty);
 763 }
 764
 765 static void pl2303_read_int_callback(struct urb *urb)
 766 {
 767         struct usb_serial_port *port =  urb->context;
 768         unsigned char *data = urb->transfer_buffer;
 769         unsigned int actual_length = urb->actual_length;
 770         int status = urb->status;
 771         int retval;
 772
 773         dbg("%s (%d)", __func__, port->number);
 774
 775         switch (status) {
 776         case 0:
 777                 /* success */
 778                 break;
 779         case -ECONNRESET:
 780         case -ENOENT:
 781         case -ESHUTDOWN:
 782                 /* this urb is terminated, clean up */
 783                 dbg("%s - urb shutting down with status: %d", __func__,
 784                     status);
 785                 return;
 786         default:
 787                 dbg("%s - nonzero urb status received: %d", __func__,
 788                     status);
 789                 goto exit;
 790         }
 791
 792         usb_serial_debug_data(debug, &port->dev, __func__,
 793                               urb->actual_length, urb->transfer_buffer);
 794
 795         pl2303_update_line_status(port, data, actual_length);
 796
 797 exit:
 798         retval = usb_submit_urb(urb, GFP_ATOMIC);
 799         if (retval)
 800                 dev_err(&urb->dev->dev,
 801                         "%s - usb_submit_urb failed with result %d\n",
 802                         __func__, retval);
 803 }
 804
 805 static void pl2303_process_read_urb(struct urb *urb)
 806 {
 807         struct usb_serial_port *port = urb->context;
 808         struct pl2303_private *priv = usb_get_serial_port_data(port);
 809         struct tty_struct *tty;
 810         unsigned char *data = urb->transfer_buffer;
 811         char tty_flag = TTY_NORMAL;
 812         unsigned long flags;
 813         u8 line_status;
 814         int i;
 815
 816         /* update line status */
 817         spin_lock_irqsave(&priv->lock, flags);
 818         line_status = priv->line_status;
 819         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
 820         spin_unlock_irqrestore(&priv->lock, flags);
 821         wake_up_interruptible(&port->delta_msr_wait);
 822
 823         if (!urb->actual_length)
 824                 return;
 825
 826         tty = tty_port_tty_get(&port->port);
 827         if (!tty)
 828                 return;
 829
 830         /* break takes precedence over parity, */
 831         /* which takes precedence over framing errors */
 832         if (line_status & UART_BREAK_ERROR)
 833                 tty_flag = TTY_BREAK;
 834         else if (line_status & UART_PARITY_ERROR)
 835                 tty_flag = TTY_PARITY;
 836         else if (line_status & UART_FRAME_ERROR)
 837                 tty_flag = TTY_FRAME;
 838         dbg("%s - tty_flag = %d", __func__, tty_flag);
 839
 840         /* overrun is special, not associated with a char */
 841         if (line_status & UART_OVERRUN_ERROR)
 842                 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 843
 844         if (port->port.console && port->sysrq) {
 845                 for (i = 0; i < urb->actual_length; ++i)
 846                         if (!usb_serial_handle_sysrq_char(port, data[i]))
 847                                 tty_insert_flip_char(tty, data[i], tty_flag);
 848         } else {
 849                 tty_insert_flip_string_fixed_flag(tty, data, tty_flag,
 850                                                         urb->actual_length);
 851         }
 852
 853         tty_flip_buffer_push(tty);
 854         tty_kref_put(tty);
 855 }
 856
 857 /* All of the device info needed for the PL2303 SIO serial converter */
 858 static struct usb_serial_driver pl2303_device = {
 859         .driver = {
 860                 .owner =        THIS_MODULE,
 861                 .name =         "pl2303",
 862         },
 863         .id_table =             id_table,
 864         .usb_driver =           &pl2303_driver,
 865         .num_ports =            1,
 866         .bulk_in_size =         256,
 867         .bulk_out_size =        256,
 868         .open =                 pl2303_open,
 869         .close =                pl2303_close,
 870         .dtr_rts =              pl2303_dtr_rts,
 871         .carrier_raised =       pl2303_carrier_raised,
 872         .ioctl =                pl2303_ioctl,
 873         .break_ctl =            pl2303_break_ctl,
 874         .set_termios =          pl2303_set_termios,
 875         .tiocmget =             pl2303_tiocmget,
 876         .tiocmset =             pl2303_tiocmset,
 877         .process_read_urb =     pl2303_process_read_urb,
 878         .read_int_callback =    pl2303_read_int_callback,
 879         .attach =               pl2303_startup,
 880         .release =              pl2303_release,
 881 };
 882
 883 static int __init pl2303_init(void)
 884 {
 885         int retval;
 886
 887         retval = usb_serial_register(&pl2303_device);
 888         if (retval)
 889                 goto failed_usb_serial_register;
 890         retval = usb_register(&pl2303_driver);
 891         if (retval)
 892                 goto failed_usb_register;
 893         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_DESC "\n");
 894         return 0;
 895 failed_usb_register:
 896         usb_serial_deregister(&pl2303_device);
 897 failed_usb_serial_register:
 898         return retval;
 899 }
 900
 901 static void __exit pl2303_exit(void)
 902 {
 903         usb_deregister(&pl2303_driver);
 904         usb_serial_deregister(&pl2303_device);
 905 }
 906
 907 module_init(pl2303_init);
 908 module_exit(pl2303_exit);
 909
 910 MODULE_DESCRIPTION(DRIVER_DESC);
 911 MODULE_LICENSE("GPL");
 912
 913 module_param(debug, bool, S_IRUGO | S_IWUSR);
 914 MODULE_PARM_DESC(debug, "Debug enabled or not");
 915