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         unsigned char *buf;
 181
 182         spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
 183         if (!spriv)
 184                 return -ENOMEM;
 185
 186         buf = kmalloc(10, GFP_KERNEL);
 187         if (!buf) {
 188                 kfree(spriv);
 189                 return -ENOMEM;
 190         }
 191
 192         if (serial->dev->descriptor.bDeviceClass == 0x02)
 193                 type = type_0;
 194         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 195                 type = HX;
 196         else if (serial->dev->descriptor.bDeviceClass == 0x00
 197                  || 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         port->port.drain_delay = 256;
 244
 245         return 0;
 246 }
 247
 248 static int pl2303_port_remove(struct usb_serial_port *port)
 249 {
 250         struct pl2303_private *priv;
 251
 252         priv = usb_get_serial_port_data(port);
 253         kfree(priv);
 254
 255         return 0;
 256 }
 257
 258 static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
 259 {
 260         struct usb_device *dev = port->serial->dev;
 261         int retval;
 262
 263         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 264                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 265                                  value, 0, NULL, 0, 100);
 266         dev_dbg(&port->dev, "%s - value = %d, retval = %d\n", __func__,
 267                 value, retval);
 268         return retval;
 269 }
 270
 271 static int pl2303_baudrate_encode_direct(int baud, enum pl2303_type type,
 272                                                                       u8 buf[4])
 273 {
 274         /*
 275          * NOTE: Only the values defined in baud_sup are supported !
 276          *       => if unsupported values are set, the PL2303 seems to
 277          *          use 9600 baud (at least my PL2303X always does)
 278          */
 279         const int baud_sup[] = { 75, 150, 300, 600, 1200, 1800, 2400, 3600,
 280                                  4800, 7200, 9600, 14400, 19200, 28800, 38400,
 281                                  57600, 115200, 230400, 460800, 614400, 921600,
 282                                  1228800, 2457600, 3000000, 6000000 };
 283         /*
 284          * NOTE: The PL2303HX (tested with rev. 3A) also supports the following
 285          * baud rates: 128000, 134400, 161280, 201600, 268800, 403200, 806400.
 286          * As long as we are not using this encoding method for them, there is
 287          * no point in complicating the code to support them.
 288          */
 289         int i;
 290
 291         /* Set baudrate to nearest supported value */
 292         for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
 293                 if (baud_sup[i] > baud)
 294                         break;
 295         }
 296         if (i == ARRAY_SIZE(baud_sup))
 297                 baud = baud_sup[i - 1];
 298         else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
 299                 baud = baud_sup[i - 1];
 300         else
 301                 baud = baud_sup[i];
 302         /* type_0, type_1 only support up to 1228800 baud */
 303         if (type != HX)
 304                 baud = min_t(int, baud, 1228800);
 305         /* Direct (standard) baud rate encoding method */
 306         put_unaligned_le32(baud, buf);
 307
 308         return baud;
 309 }
 310
 311 static int pl2303_baudrate_encode_divisor(int baud, enum pl2303_type type,
 312                                                                       u8 buf[4])
 313 {
 314         /*
 315          * Divisor based baud rate encoding method
 316          *
 317          * NOTE: it's not clear if the type_0/1 chips support this method
 318          *
 319          * divisor = 12MHz * 32 / baudrate = 2^A * B
 320          *
 321          * with
 322          *
 323          * A = buf[1] & 0x0e
 324          * B = buf[0]  +  (buf[1] & 0x01) << 8
 325          *
 326          * Special cases:
 327          * => 8 < B < 16: device seems to work not properly
 328          * => B <= 8: device uses the max. value B = 512 instead
 329          */
 330         unsigned int A, B;
 331
 332         /*
 333          * NOTE: The Windows driver allows maximum baud rates of 110% of the
 334          * specified maximium value.
 335          * Quick tests with early (2004) HX (rev. A) chips suggest, that even
 336          * higher baud rates (up to the maximum of 24M baud !) are working fine,
 337          * but that should really be tested carefully in "real life" scenarios
 338          * before removing the upper limit completely.
 339          * Baud rates smaller than the specified 75 baud are definitely working
 340          * fine.
 341          */
 342         if (type == HX)
 343                 baud = min_t(int, baud, 6000000 * 1.1);
 344         else
 345                 baud = min_t(int, baud, 1228800 * 1.1);
 346         /* Determine factors A and B */
 347         A = 0;
 348         B = 12000000 * 32 / baud;  /* 12MHz */
 349         B <<= 1; /* Add one bit for rounding */
 350         while (B > (512 << 1) && A <= 14) {
 351                 A += 2;
 352                 B >>= 2;
 353         }
 354         if (A > 14) { /* max. divisor = min. baudrate reached */
 355                 A = 14;
 356                 B = 512;
 357                 /* => ~45.78 baud */
 358         } else {
 359                 B = (B + 1) >> 1; /* Round the last bit */
 360         }
 361         /* Handle special cases */
 362         if (B == 512)
 363                 B = 0; /* also: 1 to 8 */
 364         else if (B < 16)
 365                 /*
 366                  * NOTE: With the current algorithm this happens
 367                  * only for A=0 and means that the min. divisor
 368                  * (respectively: the max. baudrate) is reached.
 369                  */
 370                 B = 16;         /* => 24 MBaud */
 371         /* Encode the baud rate */
 372         buf[3] = 0x80;     /* Select divisor encoding method */
 373         buf[2] = 0;
 374         buf[1] = (A & 0x0e);            /* A */
 375         buf[1] |= ((B & 0x100) >> 8);   /* MSB of B */
 376         buf[0] = B & 0xff;              /* 8 LSBs of B */
 377         /* Calculate the actual/resulting baud rate */
 378         if (B <= 8)
 379                 B = 512;
 380         baud = 12000000 * 32 / ((1 << A) * B);
 381
 382         return baud;
 383 }
 384
 385 static void pl2303_encode_baudrate(struct tty_struct *tty,
 386                                         struct usb_serial_port *port,
 387                                         enum pl2303_type type,
 388                                         u8 buf[4])
 389 {
 390         int baud;
 391
 392         baud = tty_get_baud_rate(tty);
 393         dev_dbg(&port->dev, "baud requested = %d\n", baud);
 394         if (!baud)
 395                 return;
 396         /*
 397          * There are two methods for setting/encoding the baud rate
 398          * 1) Direct method: encodes the baud rate value directly
 399          *    => supported by all chip types
 400          * 2) Divisor based method: encodes a divisor to a base value (12MHz*32)
 401          *    => supported by HX chips (and likely not by type_0/1 chips)
 402          *
 403          * NOTE: Although the divisor based baud rate encoding method is much
 404          * more flexible, some of the standard baud rate values can not be
 405          * realized exactly. But the difference is very small (max. 0.2%) and
 406          * the device likely uses the same baud rate generator for both methods
 407          * so that there is likley no difference.
 408          */
 409         if (type != HX)
 410                 baud = pl2303_baudrate_encode_direct(baud, type, buf);
 411         else
 412                 baud = pl2303_baudrate_encode_divisor(baud, type, buf);
 413         /* Save resulting baud rate */
 414         tty_encode_baud_rate(tty, baud, baud);
 415         dev_dbg(&port->dev, "baud set = %d\n", baud);
 416 }
 417
 418 static void pl2303_set_termios(struct tty_struct *tty,
 419                 struct usb_serial_port *port, struct ktermios *old_termios)
 420 {
 421         struct usb_serial *serial = port->serial;
 422         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 423         struct pl2303_private *priv = usb_get_serial_port_data(port);
 424         unsigned long flags;
 425         unsigned char *buf;
 426         int i;
 427         u8 control;
 428
 429         /*
 430          * The PL2303 is reported to lose bytes if you change serial settings
 431          * even to the same values as before. Thus we actually need to filter
 432          * in this specific case.
 433          */
 434         if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
 435                 return;
 436
 437         buf = kzalloc(7, GFP_KERNEL);
 438         if (!buf) {
 439                 dev_err(&port->dev, "%s - out of memory.\n", __func__);
 440                 /* Report back no change occurred */
 441                 if (old_termios)
 442                         tty->termios = *old_termios;
 443                 return;
 444         }
 445
 446         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 447                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 448                             0, 0, buf, 7, 100);
 449         dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);
 450
 451         if (C_CSIZE(tty)) {
 452                 switch (C_CSIZE(tty)) {
 453                 case CS5:
 454                         buf[6] = 5;
 455                         break;
 456                 case CS6:
 457                         buf[6] = 6;
 458                         break;
 459                 case CS7:
 460                         buf[6] = 7;
 461                         break;
 462                 default:
 463                 case CS8:
 464                         buf[6] = 8;
 465                 }
 466                 dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
 467         }
 468
 469         /* For reference:   buf[0]:buf[3] baud rate value */
 470         pl2303_encode_baudrate(tty, port, spriv->type, buf);
 471
 472         /* For reference buf[4]=0 is 1 stop bits */
 473         /* For reference buf[4]=1 is 1.5 stop bits */
 474         /* For reference buf[4]=2 is 2 stop bits */
 475         if (C_CSTOPB(tty)) {
 476                 /*
 477                  * NOTE: Comply with "real" UARTs / RS232:
 478                  *       use 1.5 instead of 2 stop bits with 5 data bits
 479                  */
 480                 if (C_CSIZE(tty) == CS5) {
 481                         buf[4] = 1;
 482                         dev_dbg(&port->dev, "stop bits = 1.5\n");
 483                 } else {
 484                         buf[4] = 2;
 485                         dev_dbg(&port->dev, "stop bits = 2\n");
 486                 }
 487         } else {
 488                 buf[4] = 0;
 489                 dev_dbg(&port->dev, "stop bits = 1\n");
 490         }
 491
 492         if (C_PARENB(tty)) {
 493                 /* For reference buf[5]=0 is none parity */
 494                 /* For reference buf[5]=1 is odd parity */
 495                 /* For reference buf[5]=2 is even parity */
 496                 /* For reference buf[5]=3 is mark parity */
 497                 /* For reference buf[5]=4 is space parity */
 498                 if (C_PARODD(tty)) {
 499                         if (tty->termios.c_cflag & CMSPAR) {
 500                                 buf[5] = 3;
 501                                 dev_dbg(&port->dev, "parity = mark\n");
 502                         } else {
 503                                 buf[5] = 1;
 504                                 dev_dbg(&port->dev, "parity = odd\n");
 505                         }
 506                 } else {
 507                         if (tty->termios.c_cflag & CMSPAR) {
 508                                 buf[5] = 4;
 509                                 dev_dbg(&port->dev, "parity = space\n");
 510                         } else {
 511                                 buf[5] = 2;
 512                                 dev_dbg(&port->dev, "parity = even\n");
 513                         }
 514                 }
 515         } else {
 516                 buf[5] = 0;
 517                 dev_dbg(&port->dev, "parity = none\n");
 518         }
 519
 520         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 521                             SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 522                             0, 0, buf, 7, 100);
 523         dev_dbg(&port->dev, "0x21:0x20:0:0  %d\n", i);
 524
 525         /* change control lines if we are switching to or from B0 */
 526         spin_lock_irqsave(&priv->lock, flags);
 527         control = priv->line_control;
 528         if (C_BAUD(tty) == B0)
 529                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 530         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 531                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 532         if (control != priv->line_control) {
 533                 control = priv->line_control;
 534                 spin_unlock_irqrestore(&priv->lock, flags);
 535                 pl2303_set_control_lines(port, control);
 536         } else {
 537                 spin_unlock_irqrestore(&priv->lock, flags);
 538         }
 539
 540         memset(buf, 0, 7);
 541         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 542                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 543                             0, 0, buf, 7, 100);
 544         dev_dbg(&port->dev, "0xa1:0x21:0:0  %d - %7ph\n", i, buf);
 545
 546         if (C_CRTSCTS(tty)) {
 547                 if (spriv->type == HX)
 548                         pl2303_vendor_write(0x0, 0x61, serial);
 549                 else
 550                         pl2303_vendor_write(0x0, 0x41, serial);
 551         } else {
 552                 pl2303_vendor_write(0x0, 0x0, serial);
 553         }
 554
 555         kfree(buf);
 556 }
 557
 558 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
 559 {
 560         struct pl2303_private *priv = usb_get_serial_port_data(port);
 561         unsigned long flags;
 562         u8 control;
 563
 564         spin_lock_irqsave(&priv->lock, flags);
 565         /* Change DTR and RTS */
 566         if (on)
 567                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 568         else
 569                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 570         control = priv->line_control;
 571         spin_unlock_irqrestore(&priv->lock, flags);
 572         pl2303_set_control_lines(port, control);
 573 }
 574
 575 static void pl2303_close(struct usb_serial_port *port)
 576 {
 577         usb_serial_generic_close(port);
 578         usb_kill_urb(port->interrupt_in_urb);
 579 }
 580
 581 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
 582 {
 583         struct usb_serial *serial = port->serial;
 584         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 585         int result;
 586
 587         if (spriv->type != HX) {
 588                 usb_clear_halt(serial->dev, port->write_urb->pipe);
 589                 usb_clear_halt(serial->dev, port->read_urb->pipe);
 590         } else {
 591                 /* reset upstream data pipes */
 592                 pl2303_vendor_write(8, 0, serial);
 593                 pl2303_vendor_write(9, 0, serial);
 594         }
 595
 596         /* Setup termios */
 597         if (tty)
 598                 pl2303_set_termios(tty, port, NULL);
 599
 600         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 601         if (result) {
 602                 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
 603                         " error %d\n", __func__, result);
 604                 return result;
 605         }
 606
 607         result = usb_serial_generic_open(tty, port);
 608         if (result) {
 609                 usb_kill_urb(port->interrupt_in_urb);
 610                 return result;
 611         }
 612
 613         return 0;
 614 }
 615
 616 static int pl2303_tiocmset(struct tty_struct *tty,
 617                            unsigned int set, unsigned int clear)
 618 {
 619         struct usb_serial_port *port = tty->driver_data;
 620         struct pl2303_private *priv = usb_get_serial_port_data(port);
 621         unsigned long flags;
 622         u8 control;
 623         int ret;
 624
 625         spin_lock_irqsave(&priv->lock, flags);
 626         if (set & TIOCM_RTS)
 627                 priv->line_control |= CONTROL_RTS;
 628         if (set & TIOCM_DTR)
 629                 priv->line_control |= CONTROL_DTR;
 630         if (clear & TIOCM_RTS)
 631                 priv->line_control &= ~CONTROL_RTS;
 632         if (clear & TIOCM_DTR)
 633                 priv->line_control &= ~CONTROL_DTR;
 634         control = priv->line_control;
 635         spin_unlock_irqrestore(&priv->lock, flags);
 636
 637         ret = pl2303_set_control_lines(port, control);
 638         if (ret)
 639                 return usb_translate_errors(ret);
 640
 641         return 0;
 642 }
 643
 644 static int pl2303_tiocmget(struct tty_struct *tty)
 645 {
 646         struct usb_serial_port *port = tty->driver_data;
 647         struct pl2303_private *priv = usb_get_serial_port_data(port);
 648         unsigned long flags;
 649         unsigned int mcr;
 650         unsigned int status;
 651         unsigned int result;
 652
 653         spin_lock_irqsave(&priv->lock, flags);
 654         mcr = priv->line_control;
 655         status = priv->line_status;
 656         spin_unlock_irqrestore(&priv->lock, flags);
 657
 658         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
 659                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
 660                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 661                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 662                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
 663                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
 664
 665         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
 666
 667         return result;
 668 }
 669
 670 static int pl2303_carrier_raised(struct usb_serial_port *port)
 671 {
 672         struct pl2303_private *priv = usb_get_serial_port_data(port);
 673         if (priv->line_status & UART_DCD)
 674                 return 1;
 675         return 0;
 676 }
 677
 678 static int pl2303_tiocmiwait(struct tty_struct *tty, unsigned long arg)
 679 {
 680         struct usb_serial_port *port = tty->driver_data;
 681         struct pl2303_private *priv = usb_get_serial_port_data(port);
 682         unsigned long flags;
 683         unsigned int prevstatus;
 684         unsigned int status;
 685         unsigned int changed;
 686
 687         spin_lock_irqsave(&priv->lock, flags);
 688         prevstatus = priv->line_status;
 689         spin_unlock_irqrestore(&priv->lock, flags);
 690
 691         while (1) {
 692                 interruptible_sleep_on(&port->port.delta_msr_wait);
 693                 /* see if a signal did it */
 694                 if (signal_pending(current))
 695                         return -ERESTARTSYS;
 696
 697                 if (port->serial->disconnected)
 698                         return -EIO;
 699
 700                 spin_lock_irqsave(&priv->lock, flags);
 701                 status = priv->line_status;
 702                 spin_unlock_irqrestore(&priv->lock, flags);
 703
 704                 changed = prevstatus ^ status;
 705
 706                 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
 707                     ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
 708                     ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
 709                     ((arg & TIOCM_CTS) && (changed & UART_CTS))) {
 710                         return 0;
 711                 }
 712                 prevstatus = status;
 713         }
 714         /* NOTREACHED */
 715         return 0;
 716 }
 717
 718 static int pl2303_ioctl(struct tty_struct *tty,
 719                         unsigned int cmd, unsigned long arg)
 720 {
 721         struct serial_struct ser;
 722         struct usb_serial_port *port = tty->driver_data;
 723
 724         dev_dbg(&port->dev, "%s cmd = 0x%04x\n", __func__, cmd);
 725
 726         switch (cmd) {
 727         case TIOCGSERIAL:
 728                 memset(&ser, 0, sizeof ser);
 729                 ser.type = PORT_16654;
 730                 ser.line = port->minor;
 731                 ser.port = port->port_number;
 732                 ser.baud_base = 460800;
 733
 734                 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
 735                         return -EFAULT;
 736
 737                 return 0;
 738         default:
 739                 dev_dbg(&port->dev, "%s not supported = 0x%04x\n", __func__, cmd);
 740                 break;
 741         }
 742         return -ENOIOCTLCMD;
 743 }
 744
 745 static void pl2303_break_ctl(struct tty_struct *tty, int break_state)
 746 {
 747         struct usb_serial_port *port = tty->driver_data;
 748         struct usb_serial *serial = port->serial;
 749         u16 state;
 750         int result;
 751
 752         if (break_state == 0)
 753                 state = BREAK_OFF;
 754         else
 755                 state = BREAK_ON;
 756         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
 757                         state == BREAK_OFF ? "off" : "on");
 758
 759         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 760                                  BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
 761                                  0, NULL, 0, 100);
 762         if (result)
 763                 dev_err(&port->dev, "error sending break = %d\n", result);
 764 }
 765
 766 static void pl2303_update_line_status(struct usb_serial_port *port,
 767                                       unsigned char *data,
 768                                       unsigned int actual_length)
 769 {
 770
 771         struct pl2303_private *priv = usb_get_serial_port_data(port);
 772         struct tty_struct *tty;
 773         unsigned long flags;
 774         u8 status_idx = UART_STATE;
 775         u8 length = UART_STATE + 1;
 776         u8 prev_line_status;
 777         u16 idv, idp;
 778
 779         idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
 780         idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
 781
 782
 783         if (idv == SIEMENS_VENDOR_ID) {
 784                 if (idp == SIEMENS_PRODUCT_ID_X65 ||
 785                     idp == SIEMENS_PRODUCT_ID_SX1 ||
 786                     idp == SIEMENS_PRODUCT_ID_X75) {
 787
 788                         length = 1;
 789                         status_idx = 0;
 790                 }
 791         }
 792
 793         if (actual_length < length)
 794                 return;
 795
 796         /* Save off the uart status for others to look at */
 797         spin_lock_irqsave(&priv->lock, flags);
 798         prev_line_status = priv->line_status;
 799         priv->line_status = data[status_idx];
 800         spin_unlock_irqrestore(&priv->lock, flags);
 801         if (priv->line_status & UART_BREAK_ERROR)
 802                 usb_serial_handle_break(port);
 803         wake_up_interruptible(&port->port.delta_msr_wait);
 804
 805         tty = tty_port_tty_get(&port->port);
 806         if (!tty)
 807                 return;
 808         if ((priv->line_status ^ prev_line_status) & UART_DCD)
 809                 usb_serial_handle_dcd_change(port, tty,
 810                                 priv->line_status & UART_DCD);
 811         tty_kref_put(tty);
 812 }
 813
 814 static void pl2303_read_int_callback(struct urb *urb)
 815 {
 816         struct usb_serial_port *port =  urb->context;
 817         unsigned char *data = urb->transfer_buffer;
 818         unsigned int actual_length = urb->actual_length;
 819         int status = urb->status;
 820         int retval;
 821
 822         switch (status) {
 823         case 0:
 824                 /* success */
 825                 break;
 826         case -ECONNRESET:
 827         case -ENOENT:
 828         case -ESHUTDOWN:
 829                 /* this urb is terminated, clean up */
 830                 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
 831                         __func__, status);
 832                 return;
 833         default:
 834                 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
 835                         __func__, status);
 836                 goto exit;
 837         }
 838
 839         usb_serial_debug_data(&port->dev, __func__,
 840                               urb->actual_length, urb->transfer_buffer);
 841
 842         pl2303_update_line_status(port, data, actual_length);
 843
 844 exit:
 845         retval = usb_submit_urb(urb, GFP_ATOMIC);
 846         if (retval)
 847                 dev_err(&port->dev,
 848                         "%s - usb_submit_urb failed with result %d\n",
 849                         __func__, retval);
 850 }
 851
 852 static void pl2303_process_read_urb(struct urb *urb)
 853 {
 854         struct usb_serial_port *port = urb->context;
 855         struct pl2303_private *priv = usb_get_serial_port_data(port);
 856         unsigned char *data = urb->transfer_buffer;
 857         char tty_flag = TTY_NORMAL;
 858         unsigned long flags;
 859         u8 line_status;
 860         int i;
 861
 862         /* update line status */
 863         spin_lock_irqsave(&priv->lock, flags);
 864         line_status = priv->line_status;
 865         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
 866         spin_unlock_irqrestore(&priv->lock, flags);
 867         wake_up_interruptible(&port->port.delta_msr_wait);
 868
 869         if (!urb->actual_length)
 870                 return;
 871
 872         /* break takes precedence over parity, */
 873         /* which takes precedence over framing errors */
 874         if (line_status & UART_BREAK_ERROR)
 875                 tty_flag = TTY_BREAK;
 876         else if (line_status & UART_PARITY_ERROR)
 877                 tty_flag = TTY_PARITY;
 878         else if (line_status & UART_FRAME_ERROR)
 879                 tty_flag = TTY_FRAME;
 880
 881         if (tty_flag != TTY_NORMAL)
 882                 dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
 883                                                                 tty_flag);
 884         /* overrun is special, not associated with a char */
 885         if (line_status & UART_OVERRUN_ERROR)
 886                 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
 887
 888         if (port->port.console && port->sysrq) {
 889                 for (i = 0; i < urb->actual_length; ++i)
 890                         if (!usb_serial_handle_sysrq_char(port, data[i]))
 891                                 tty_insert_flip_char(&port->port, data[i],
 892                                                 tty_flag);
 893         } else {
 894                 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
 895                                                         urb->actual_length);
 896         }
 897
 898         tty_flip_buffer_push(&port->port);
 899 }
 900
 901 /* All of the device info needed for the PL2303 SIO serial converter */
 902 static struct usb_serial_driver pl2303_device = {
 903         .driver = {
 904                 .owner =        THIS_MODULE,
 905                 .name =         "pl2303",
 906         },
 907         .id_table =             id_table,
 908         .num_ports =            1,
 909         .bulk_in_size =         256,
 910         .bulk_out_size =        256,
 911         .open =                 pl2303_open,
 912         .close =                pl2303_close,
 913         .dtr_rts =              pl2303_dtr_rts,
 914         .carrier_raised =       pl2303_carrier_raised,
 915         .ioctl =                pl2303_ioctl,
 916         .break_ctl =            pl2303_break_ctl,
 917         .set_termios =          pl2303_set_termios,
 918         .tiocmget =             pl2303_tiocmget,
 919         .tiocmset =             pl2303_tiocmset,
 920         .tiocmiwait =           pl2303_tiocmiwait,
 921         .process_read_urb =     pl2303_process_read_urb,
 922         .read_int_callback =    pl2303_read_int_callback,
 923         .attach =               pl2303_startup,
 924         .release =              pl2303_release,
 925         .port_probe =           pl2303_port_probe,
 926         .port_remove =          pl2303_port_remove,
 927 };
 928
 929 static struct usb_serial_driver * const serial_drivers[] = {
 930         &pl2303_device, NULL
 931 };
 932
 933 module_usb_serial_driver(serial_drivers, id_table);
 934
 935 MODULE_DESCRIPTION(DRIVER_DESC);
 936 MODULE_LICENSE("GPL");