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