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