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