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