drivers/usb/serial/pl2303.c

   1 /*
   2  * Prolific PL2303 USB to serial adaptor driver
   3  *
   4  * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
   5  * Copyright (C) 2003 IBM Corp.
   6  *
   7  * Original driver for 2.2.x by anonymous
   8  *
   9  *      This program is free software; you can redistribute it and/or modify
  10  *      it under the terms of the GNU General Public License as published by
  11  *      the Free Software Foundation; either version 2 of the License.
  12  *
  13  * See Documentation/usb/usb-serial.txt for more information on using this driver
  14  *
  15  */
  16
  17 #include <linux/kernel.h>
  18 #include <linux/errno.h>
  19 #include <linux/init.h>
  20 #include <linux/slab.h>
  21 #include <linux/tty.h>
  22 #include <linux/tty_driver.h>
  23 #include <linux/tty_flip.h>
  24 #include <linux/serial.h>
  25 #include <linux/module.h>
  26 #include <linux/moduleparam.h>
  27 #include <linux/spinlock.h>
  28 #include <asm/uaccess.h>
  29 #include <linux/usb.h>
  30 #include <linux/usb/serial.h>
  31 #include "pl2303.h"
  32
  33 /*
  34  * Version Information
  35  */
  36 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
  37
  38 static int debug;
  39
  40 #define PL2303_CLOSING_WAIT     (30*HZ)
  41
  42 #define PL2303_BUF_SIZE         1024
  43 #define PL2303_TMP_BUF_SIZE     1024
  44
  45 struct pl2303_buf {
  46         unsigned int    buf_size;
  47         char            *buf_buf;
  48         char            *buf_get;
  49         char            *buf_put;
  50 };
  51
  52 static struct usb_device_id id_table [] = {
  53         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
  54         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
  55         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
  56         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
  57         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
  58         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
  59         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
  60         { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
  61         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
  62         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
  63         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
  64         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
  65         { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
  66         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
  67         { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
  68         { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
  69         { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
  70         { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
  71         { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
  72         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
  73         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) },
  74         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
  75         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) },
  76         { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
  77         { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
  78         { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
  79         { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
  80         { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
  81         { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
  82         { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
  83         { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
  84         { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) },
  85         { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_ID) },
  86         { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
  87         { }                                     /* Terminating entry */
  88 };
  89
  90 MODULE_DEVICE_TABLE(usb, id_table);
  91
  92 static struct usb_driver pl2303_driver = {
  93         .name =         "pl2303",
  94         .probe =        usb_serial_probe,
  95         .disconnect =   usb_serial_disconnect,
  96         .id_table =     id_table,
  97         .no_dynamic_id =        1,
  98 };
  99
 100 #define SET_LINE_REQUEST_TYPE           0x21
 101 #define SET_LINE_REQUEST                0x20
 102
 103 #define SET_CONTROL_REQUEST_TYPE        0x21
 104 #define SET_CONTROL_REQUEST             0x22
 105 #define CONTROL_DTR                     0x01
 106 #define CONTROL_RTS                     0x02
 107
 108 #define BREAK_REQUEST_TYPE              0x21
 109 #define BREAK_REQUEST                   0x23
 110 #define BREAK_ON                        0xffff
 111 #define BREAK_OFF                       0x0000
 112
 113 #define GET_LINE_REQUEST_TYPE           0xa1
 114 #define GET_LINE_REQUEST                0x21
 115
 116 #define VENDOR_WRITE_REQUEST_TYPE       0x40
 117 #define VENDOR_WRITE_REQUEST            0x01
 118
 119 #define VENDOR_READ_REQUEST_TYPE        0xc0
 120 #define VENDOR_READ_REQUEST             0x01
 121
 122 #define UART_STATE                      0x08
 123 #define UART_STATE_TRANSIENT_MASK       0x74
 124 #define UART_DCD                        0x01
 125 #define UART_DSR                        0x02
 126 #define UART_BREAK_ERROR                0x04
 127 #define UART_RING                       0x08
 128 #define UART_FRAME_ERROR                0x10
 129 #define UART_PARITY_ERROR               0x20
 130 #define UART_OVERRUN_ERROR              0x40
 131 #define UART_CTS                        0x80
 132
 133
 134 enum pl2303_type {
 135         type_0,         /* don't know the difference between type 0 and */
 136         type_1,         /* type 1, until someone from prolific tells us... */
 137         HX,             /* HX version of the pl2303 chip */
 138 };
 139
 140 struct pl2303_private {
 141         spinlock_t lock;
 142         struct pl2303_buf *buf;
 143         int write_urb_in_use;
 144         wait_queue_head_t delta_msr_wait;
 145         u8 line_control;
 146         u8 line_status;
 147         u8 termios_initialized;
 148         enum pl2303_type type;
 149 };
 150
 151 /*
 152  * pl2303_buf_alloc
 153  *
 154  * Allocate a circular buffer and all associated memory.
 155  */
 156 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
 157 {
 158         struct pl2303_buf *pb;
 159
 160         if (size == 0)
 161                 return NULL;
 162
 163         pb = kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
 164         if (pb == NULL)
 165                 return NULL;
 166
 167         pb->buf_buf = kmalloc(size, GFP_KERNEL);
 168         if (pb->buf_buf == NULL) {
 169                 kfree(pb);
 170                 return NULL;
 171         }
 172
 173         pb->buf_size = size;
 174         pb->buf_get = pb->buf_put = pb->buf_buf;
 175
 176         return pb;
 177 }
 178
 179 /*
 180  * pl2303_buf_free
 181  *
 182  * Free the buffer and all associated memory.
 183  */
 184 static void pl2303_buf_free(struct pl2303_buf *pb)
 185 {
 186         if (pb) {
 187                 kfree(pb->buf_buf);
 188                 kfree(pb);
 189         }
 190 }
 191
 192 /*
 193  * pl2303_buf_clear
 194  *
 195  * Clear out all data in the circular buffer.
 196  */
 197 static void pl2303_buf_clear(struct pl2303_buf *pb)
 198 {
 199         if (pb != NULL)
 200                 pb->buf_get = pb->buf_put;
 201                 /* equivalent to a get of all data available */
 202 }
 203
 204 /*
 205  * pl2303_buf_data_avail
 206  *
 207  * Return the number of bytes of data available in the circular
 208  * buffer.
 209  */
 210 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
 211 {
 212         if (pb == NULL)
 213                 return 0;
 214
 215         return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
 216 }
 217
 218 /*
 219  * pl2303_buf_space_avail
 220  *
 221  * Return the number of bytes of space available in the circular
 222  * buffer.
 223  */
 224 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
 225 {
 226         if (pb == NULL)
 227                 return 0;
 228
 229         return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
 230 }
 231
 232 /*
 233  * pl2303_buf_put
 234  *
 235  * Copy data data from a user buffer and put it into the circular buffer.
 236  * Restrict to the amount of space available.
 237  *
 238  * Return the number of bytes copied.
 239  */
 240 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
 241                                    unsigned int count)
 242 {
 243         unsigned int len;
 244
 245         if (pb == NULL)
 246                 return 0;
 247
 248         len  = pl2303_buf_space_avail(pb);
 249         if (count > len)
 250                 count = len;
 251
 252         if (count == 0)
 253                 return 0;
 254
 255         len = pb->buf_buf + pb->buf_size - pb->buf_put;
 256         if (count > len) {
 257                 memcpy(pb->buf_put, buf, len);
 258                 memcpy(pb->buf_buf, buf+len, count - len);
 259                 pb->buf_put = pb->buf_buf + count - len;
 260         } else {
 261                 memcpy(pb->buf_put, buf, count);
 262                 if (count < len)
 263                         pb->buf_put += count;
 264                 else /* count == len */
 265                         pb->buf_put = pb->buf_buf;
 266         }
 267
 268         return count;
 269 }
 270
 271 /*
 272  * pl2303_buf_get
 273  *
 274  * Get data from the circular buffer and copy to the given buffer.
 275  * Restrict to the amount of data available.
 276  *
 277  * Return the number of bytes copied.
 278  */
 279 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
 280                                    unsigned int count)
 281 {
 282         unsigned int len;
 283
 284         if (pb == NULL)
 285                 return 0;
 286
 287         len = pl2303_buf_data_avail(pb);
 288         if (count > len)
 289                 count = len;
 290
 291         if (count == 0)
 292                 return 0;
 293
 294         len = pb->buf_buf + pb->buf_size - pb->buf_get;
 295         if (count > len) {
 296                 memcpy(buf, pb->buf_get, len);
 297                 memcpy(buf+len, pb->buf_buf, count - len);
 298                 pb->buf_get = pb->buf_buf + count - len;
 299         } else {
 300                 memcpy(buf, pb->buf_get, count);
 301                 if (count < len)
 302                         pb->buf_get += count;
 303                 else /* count == len */
 304                         pb->buf_get = pb->buf_buf;
 305         }
 306
 307         return count;
 308 }
 309
 310 static int pl2303_startup(struct usb_serial *serial)
 311 {
 312         struct pl2303_private *priv;
 313         enum pl2303_type type = type_0;
 314         int i;
 315
 316         if (serial->dev->descriptor.bDeviceClass == 0x02)
 317                 type = type_0;
 318         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 319                 type = HX;
 320         else if (serial->dev->descriptor.bDeviceClass == 0x00)
 321                 type = type_1;
 322         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
 323                 type = type_1;
 324         dbg("device type: %d", type);
 325
 326         for (i = 0; i < serial->num_ports; ++i) {
 327                 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
 328                 if (!priv)
 329                         goto cleanup;
 330                 spin_lock_init(&priv->lock);
 331                 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
 332                 if (priv->buf == NULL) {
 333                         kfree(priv);
 334                         goto cleanup;
 335                 }
 336                 init_waitqueue_head(&priv->delta_msr_wait);
 337                 priv->type = type;
 338                 usb_set_serial_port_data(serial->port[i], priv);
 339         }
 340         return 0;
 341
 342 cleanup:
 343         for (--i; i>=0; --i) {
 344                 priv = usb_get_serial_port_data(serial->port[i]);
 345                 pl2303_buf_free(priv->buf);
 346                 kfree(priv);
 347                 usb_set_serial_port_data(serial->port[i], NULL);
 348         }
 349         return -ENOMEM;
 350 }
 351
 352 static int set_control_lines(struct usb_device *dev, u8 value)
 353 {
 354         int retval;
 355
 356         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 357                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 358                                  value, 0, NULL, 0, 100);
 359         dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
 360         return retval;
 361 }
 362
 363 static void pl2303_send(struct usb_serial_port *port)
 364 {
 365         int count, result;
 366         struct pl2303_private *priv = usb_get_serial_port_data(port);
 367         unsigned long flags;
 368
 369         dbg("%s - port %d", __FUNCTION__, port->number);
 370
 371         spin_lock_irqsave(&priv->lock, flags);
 372
 373         if (priv->write_urb_in_use) {
 374                 spin_unlock_irqrestore(&priv->lock, flags);
 375                 return;
 376         }
 377
 378         count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
 379                                port->bulk_out_size);
 380
 381         if (count == 0) {
 382                 spin_unlock_irqrestore(&priv->lock, flags);
 383                 return;
 384         }
 385
 386         priv->write_urb_in_use = 1;
 387
 388         spin_unlock_irqrestore(&priv->lock, flags);
 389
 390         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
 391                               port->write_urb->transfer_buffer);
 392
 393         port->write_urb->transfer_buffer_length = count;
 394         port->write_urb->dev = port->serial->dev;
 395         result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 396         if (result) {
 397                 dev_err(&port->dev, "%s - failed submitting write urb,"
 398                         " error %d\n", __FUNCTION__, result);
 399                 priv->write_urb_in_use = 0;
 400                 // TODO: reschedule pl2303_send
 401         }
 402
 403         usb_serial_port_softint(port);
 404 }
 405
 406 static int pl2303_write(struct usb_serial_port *port, const unsigned char *buf,
 407                         int count)
 408 {
 409         struct pl2303_private *priv = usb_get_serial_port_data(port);
 410         unsigned long flags;
 411
 412         dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
 413
 414         if (!count)
 415                 return count;
 416
 417         spin_lock_irqsave(&priv->lock, flags);
 418         count = pl2303_buf_put(priv->buf, buf, count);
 419         spin_unlock_irqrestore(&priv->lock, flags);
 420
 421         pl2303_send(port);
 422
 423         return count;
 424 }
 425
 426 static int pl2303_write_room(struct usb_serial_port *port)
 427 {
 428         struct pl2303_private *priv = usb_get_serial_port_data(port);
 429         int room = 0;
 430         unsigned long flags;
 431
 432         dbg("%s - port %d", __FUNCTION__, port->number);
 433
 434         spin_lock_irqsave(&priv->lock, flags);
 435         room = pl2303_buf_space_avail(priv->buf);
 436         spin_unlock_irqrestore(&priv->lock, flags);
 437
 438         dbg("%s - returns %d", __FUNCTION__, room);
 439         return room;
 440 }
 441
 442 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
 443 {
 444         struct pl2303_private *priv = usb_get_serial_port_data(port);
 445         int chars = 0;
 446         unsigned long flags;
 447
 448         dbg("%s - port %d", __FUNCTION__, port->number);
 449
 450         spin_lock_irqsave(&priv->lock, flags);
 451         chars = pl2303_buf_data_avail(priv->buf);
 452         spin_unlock_irqrestore(&priv->lock, flags);
 453
 454         dbg("%s - returns %d", __FUNCTION__, chars);
 455         return chars;
 456 }
 457
 458 static void pl2303_set_termios(struct usb_serial_port *port,
 459                                struct ktermios *old_termios)
 460 {
 461         struct usb_serial *serial = port->serial;
 462         struct pl2303_private *priv = usb_get_serial_port_data(port);
 463         unsigned long flags;
 464         unsigned int cflag;
 465         unsigned char *buf;
 466         int baud;
 467         int i;
 468         u8 control;
 469
 470         dbg("%s -  port %d", __FUNCTION__, port->number);
 471
 472         if ((!port->tty) || (!port->tty->termios)) {
 473                 dbg("%s - no tty structures", __FUNCTION__);
 474                 return;
 475         }
 476
 477         spin_lock_irqsave(&priv->lock, flags);
 478         if (!priv->termios_initialized) {
 479                 *(port->tty->termios) = tty_std_termios;
 480                 port->tty->termios->c_cflag = B9600 | CS8 | CREAD |
 481                                               HUPCL | CLOCAL;
 482                 priv->termios_initialized = 1;
 483         }
 484         spin_unlock_irqrestore(&priv->lock, flags);
 485
 486         cflag = port->tty->termios->c_cflag;
 487         /* check that they really want us to change something */
 488         if (old_termios) {
 489                 if ((cflag == old_termios->c_cflag) &&
 490                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) ==
 491                      RELEVANT_IFLAG(old_termios->c_iflag))) {
 492                         dbg("%s - nothing to change...", __FUNCTION__);
 493                         return;
 494                 }
 495         }
 496
 497         buf = kzalloc(7, GFP_KERNEL);
 498         if (!buf) {
 499                 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
 500                 return;
 501         }
 502
 503         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 504                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 505                             0, 0, buf, 7, 100);
 506         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 507             buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 508
 509         if (cflag & CSIZE) {
 510                 switch (cflag & CSIZE) {
 511                         case CS5:       buf[6] = 5;     break;
 512                         case CS6:       buf[6] = 6;     break;
 513                         case CS7:       buf[6] = 7;     break;
 514                         default:
 515                         case CS8:       buf[6] = 8;     break;
 516                 }
 517                 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
 518         }
 519
 520         baud = 0;
 521         switch (cflag & CBAUD) {
 522                 case B0:        baud = 0;       break;
 523                 case B75:       baud = 75;      break;
 524                 case B150:      baud = 150;     break;
 525                 case B300:      baud = 300;     break;
 526                 case B600:      baud = 600;     break;
 527                 case B1200:     baud = 1200;    break;
 528                 case B1800:     baud = 1800;    break;
 529                 case B2400:     baud = 2400;    break;
 530                 case B4800:     baud = 4800;    break;
 531                 case B9600:     baud = 9600;    break;
 532                 case B19200:    baud = 19200;   break;
 533                 case B38400:    baud = 38400;   break;
 534                 case B57600:    baud = 57600;   break;
 535                 case B115200:   baud = 115200;  break;
 536                 case B230400:   baud = 230400;  break;
 537                 case B460800:   baud = 460800;  break;
 538                 default:
 539                         dev_err(&port->dev, "pl2303 driver does not support"
 540                                 " the baudrate requested (fix it)\n");
 541                         break;
 542         }
 543         dbg("%s - baud = %d", __FUNCTION__, baud);
 544         if (baud) {
 545                 buf[0] = baud & 0xff;
 546                 buf[1] = (baud >> 8) & 0xff;
 547                 buf[2] = (baud >> 16) & 0xff;
 548                 buf[3] = (baud >> 24) & 0xff;
 549         }
 550
 551         /* For reference buf[4]=0 is 1 stop bits */
 552         /* For reference buf[4]=1 is 1.5 stop bits */
 553         /* For reference buf[4]=2 is 2 stop bits */
 554         if (cflag & CSTOPB) {
 555                 buf[4] = 2;
 556                 dbg("%s - stop bits = 2", __FUNCTION__);
 557         } else {
 558                 buf[4] = 0;
 559                 dbg("%s - stop bits = 1", __FUNCTION__);
 560         }
 561
 562         if (cflag & PARENB) {
 563                 /* For reference buf[5]=0 is none parity */
 564                 /* For reference buf[5]=1 is odd parity */
 565                 /* For reference buf[5]=2 is even parity */
 566                 /* For reference buf[5]=3 is mark parity */
 567                 /* For reference buf[5]=4 is space parity */
 568                 if (cflag & PARODD) {
 569                         buf[5] = 1;
 570                         dbg("%s - parity = odd", __FUNCTION__);
 571                 } else {
 572                         buf[5] = 2;
 573                         dbg("%s - parity = even", __FUNCTION__);
 574                 }
 575         } else {
 576                 buf[5] = 0;
 577                 dbg("%s - parity = none", __FUNCTION__);
 578         }
 579
 580         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 581                             SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 582                             0, 0, buf, 7, 100);
 583         dbg("0x21:0x20:0:0  %d", i);
 584
 585         /* change control lines if we are switching to or from B0 */
 586         spin_lock_irqsave(&priv->lock, flags);
 587         control = priv->line_control;
 588         if ((cflag & CBAUD) == B0)
 589                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 590         else
 591                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 592         if (control != priv->line_control) {
 593                 control = priv->line_control;
 594                 spin_unlock_irqrestore(&priv->lock, flags);
 595                 set_control_lines(serial->dev, control);
 596         } else {
 597                 spin_unlock_irqrestore(&priv->lock, flags);
 598         }
 599
 600         buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
 601
 602         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 603                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 604                             0, 0, buf, 7, 100);
 605         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 606              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 607
 608         if (cflag & CRTSCTS) {
 609                 __u16 index;
 610                 if (priv->type == HX)
 611                         index = 0x61;
 612                 else
 613                         index = 0x41;
 614                 i = usb_control_msg(serial->dev,
 615                                     usb_sndctrlpipe(serial->dev, 0),
 616                                     VENDOR_WRITE_REQUEST,
 617                                     VENDOR_WRITE_REQUEST_TYPE,
 618                                     0x0, index, NULL, 0, 100);
 619                 dbg("0x40:0x1:0x0:0x%x  %d", index, i);
 620         }
 621
 622         kfree(buf);
 623 }
 624
 625 static void pl2303_close(struct usb_serial_port *port, struct file *filp)
 626 {
 627         struct pl2303_private *priv = usb_get_serial_port_data(port);
 628         unsigned long flags;
 629         unsigned int c_cflag;
 630         int bps;
 631         long timeout;
 632         wait_queue_t wait;
 633
 634         dbg("%s - port %d", __FUNCTION__, port->number);
 635
 636         /* wait for data to drain from the buffer */
 637         spin_lock_irqsave(&priv->lock, flags);
 638         timeout = PL2303_CLOSING_WAIT;
 639         init_waitqueue_entry(&wait, current);
 640         add_wait_queue(&port->tty->write_wait, &wait);
 641         for (;;) {
 642                 set_current_state(TASK_INTERRUPTIBLE);
 643                 if (pl2303_buf_data_avail(priv->buf) == 0 ||
 644                     timeout == 0 || signal_pending(current) ||
 645                     !usb_get_intfdata(port->serial->interface)) /* disconnect */
 646                         break;
 647                 spin_unlock_irqrestore(&priv->lock, flags);
 648                 timeout = schedule_timeout(timeout);
 649                 spin_lock_irqsave(&priv->lock, flags);
 650         }
 651         set_current_state(TASK_RUNNING);
 652         remove_wait_queue(&port->tty->write_wait, &wait);
 653         /* clear out any remaining data in the buffer */
 654         pl2303_buf_clear(priv->buf);
 655         spin_unlock_irqrestore(&priv->lock, flags);
 656
 657         /* wait for characters to drain from the device */
 658         /* (this is long enough for the entire 256 byte */
 659         /* pl2303 hardware buffer to drain with no flow */
 660         /* control for data rates of 1200 bps or more, */
 661         /* for lower rates we should really know how much */
 662         /* data is in the buffer to compute a delay */
 663         /* that is not unnecessarily long) */
 664         bps = tty_get_baud_rate(port->tty);
 665         if (bps > 1200)
 666                 timeout = max((HZ*2560)/bps,HZ/10);
 667         else
 668                 timeout = 2*HZ;
 669         schedule_timeout_interruptible(timeout);
 670
 671         /* shutdown our urbs */
 672         dbg("%s - shutting down urbs", __FUNCTION__);
 673         usb_kill_urb(port->write_urb);
 674         usb_kill_urb(port->read_urb);
 675         usb_kill_urb(port->interrupt_in_urb);
 676
 677         if (port->tty) {
 678                 c_cflag = port->tty->termios->c_cflag;
 679                 if (c_cflag & HUPCL) {
 680                         /* drop DTR and RTS */
 681                         spin_lock_irqsave(&priv->lock, flags);
 682                         priv->line_control = 0;
 683                         spin_unlock_irqrestore(&priv->lock, flags);
 684                         set_control_lines(port->serial->dev, 0);
 685                 }
 686         }
 687 }
 688
 689 static int pl2303_open(struct usb_serial_port *port, struct file *filp)
 690 {
 691         struct ktermios tmp_termios;
 692         struct usb_serial *serial = port->serial;
 693         struct pl2303_private *priv = usb_get_serial_port_data(port);
 694         unsigned char *buf;
 695         int result;
 696
 697         dbg("%s -  port %d", __FUNCTION__, port->number);
 698
 699         if (priv->type != HX) {
 700                 usb_clear_halt(serial->dev, port->write_urb->pipe);
 701                 usb_clear_halt(serial->dev, port->read_urb->pipe);
 702         }
 703
 704         buf = kmalloc(10, GFP_KERNEL);
 705         if (buf==NULL)
 706                 return -ENOMEM;
 707
 708 #define FISH(a,b,c,d)                                                           \
 709         result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0),     \
 710                                b, a, c, d, buf, 1, 100);                        \
 711         dbg("0x%x:0x%x:0x%x:0x%x  %d - %x",a,b,c,d,result,buf[0]);
 712
 713 #define SOUP(a,b,c,d)                                                           \
 714         result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0),     \
 715                                b, a, c, d, NULL, 0, 100);                       \
 716         dbg("0x%x:0x%x:0x%x:0x%x  %d",a,b,c,d,result);
 717
 718         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 719         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
 720         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 721         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 722         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 723         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
 724         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 725         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 726         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
 727         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
 728
 729         if (priv->type == HX) {
 730                 /* HX chip */
 731                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
 732                 /* reset upstream data pipes */
 733                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
 734                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
 735         } else {
 736                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
 737         }
 738
 739         kfree(buf);
 740
 741         /* Setup termios */
 742         if (port->tty) {
 743                 pl2303_set_termios(port, &tmp_termios);
 744         }
 745
 746         //FIXME: need to assert RTS and DTR if CRTSCTS off
 747
 748         dbg("%s - submitting read urb", __FUNCTION__);
 749         port->read_urb->dev = serial->dev;
 750         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
 751         if (result) {
 752                 dev_err(&port->dev, "%s - failed submitting read urb,"
 753                         " error %d\n", __FUNCTION__, result);
 754                 pl2303_close(port, NULL);
 755                 return -EPROTO;
 756         }
 757
 758         dbg("%s - submitting interrupt urb", __FUNCTION__);
 759         port->interrupt_in_urb->dev = serial->dev;
 760         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 761         if (result) {
 762                 dev_err(&port->dev, "%s - failed submitting interrupt urb,"
 763                         " error %d\n", __FUNCTION__, result);
 764                 pl2303_close(port, NULL);
 765                 return -EPROTO;
 766         }
 767         return 0;
 768 }
 769
 770 static int pl2303_tiocmset(struct usb_serial_port *port, struct file *file,
 771                            unsigned int set, unsigned int clear)
 772 {
 773         struct pl2303_private *priv = usb_get_serial_port_data(port);
 774         unsigned long flags;
 775         u8 control;
 776
 777         if (!usb_get_intfdata(port->serial->interface))
 778                 return -ENODEV;
 779
 780         spin_lock_irqsave(&priv->lock, flags);
 781         if (set & TIOCM_RTS)
 782                 priv->line_control |= CONTROL_RTS;
 783         if (set & TIOCM_DTR)
 784                 priv->line_control |= CONTROL_DTR;
 785         if (clear & TIOCM_RTS)
 786                 priv->line_control &= ~CONTROL_RTS;
 787         if (clear & TIOCM_DTR)
 788                 priv->line_control &= ~CONTROL_DTR;
 789         control = priv->line_control;
 790         spin_unlock_irqrestore(&priv->lock, flags);
 791
 792         return set_control_lines(port->serial->dev, control);
 793 }
 794
 795 static int pl2303_tiocmget(struct usb_serial_port *port, struct file *file)
 796 {
 797         struct pl2303_private *priv = usb_get_serial_port_data(port);
 798         unsigned long flags;
 799         unsigned int mcr;
 800         unsigned int status;
 801         unsigned int result;
 802
 803         dbg("%s (%d)", __FUNCTION__, port->number);
 804
 805         if (!usb_get_intfdata(port->serial->interface))
 806                 return -ENODEV;
 807
 808         spin_lock_irqsave(&priv->lock, flags);
 809         mcr = priv->line_control;
 810         status = priv->line_status;
 811         spin_unlock_irqrestore(&priv->lock, flags);
 812
 813         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
 814                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
 815                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 816                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 817                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
 818                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
 819
 820         dbg("%s - result = %x", __FUNCTION__, result);
 821
 822         return result;
 823 }
 824
 825 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
 826 {
 827         struct pl2303_private *priv = usb_get_serial_port_data(port);
 828         unsigned long flags;
 829         unsigned int prevstatus;
 830         unsigned int status;
 831         unsigned int changed;
 832
 833         spin_lock_irqsave(&priv->lock, flags);
 834         prevstatus = priv->line_status;
 835         spin_unlock_irqrestore(&priv->lock, flags);
 836
 837         while (1) {
 838                 interruptible_sleep_on(&priv->delta_msr_wait);
 839                 /* see if a signal did it */
 840                 if (signal_pending(current))
 841                         return -ERESTARTSYS;
 842
 843                 spin_lock_irqsave(&priv->lock, flags);
 844                 status = priv->line_status;
 845                 spin_unlock_irqrestore(&priv->lock, flags);
 846
 847                 changed=prevstatus^status;
 848
 849                 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
 850                     ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
 851                     ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
 852                     ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
 853                         return 0;
 854                 }
 855                 prevstatus = status;
 856         }
 857         /* NOTREACHED */
 858         return 0;
 859 }
 860
 861 static int pl2303_ioctl(struct usb_serial_port *port, struct file *file,
 862                         unsigned int cmd, unsigned long arg)
 863 {
 864         dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
 865
 866         switch (cmd) {
 867                 case TIOCMIWAIT:
 868                         dbg("%s (%d) TIOCMIWAIT", __FUNCTION__,  port->number);
 869                         return wait_modem_info(port, arg);
 870
 871                 default:
 872                         dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
 873                         break;
 874         }
 875
 876         return -ENOIOCTLCMD;
 877 }
 878
 879 static void pl2303_break_ctl(struct usb_serial_port *port, int break_state)
 880 {
 881         struct usb_serial *serial = port->serial;
 882         u16 state;
 883         int result;
 884
 885         dbg("%s - port %d", __FUNCTION__, port->number);
 886
 887         if (break_state == 0)
 888                 state = BREAK_OFF;
 889         else
 890                 state = BREAK_ON;
 891         dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
 892
 893         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 894                                  BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
 895                                  0, NULL, 0, 100);
 896         if (result)
 897                 dbg("%s - error sending break = %d", __FUNCTION__, result);
 898 }
 899
 900 static void pl2303_shutdown(struct usb_serial *serial)
 901 {
 902         int i;
 903         struct pl2303_private *priv;
 904
 905         dbg("%s", __FUNCTION__);
 906
 907         for (i = 0; i < serial->num_ports; ++i) {
 908                 priv = usb_get_serial_port_data(serial->port[i]);
 909                 if (priv) {
 910                         pl2303_buf_free(priv->buf);
 911                         kfree(priv);
 912                         usb_set_serial_port_data(serial->port[i], NULL);
 913                 }
 914         }
 915 }
 916
 917 static void pl2303_update_line_status(struct usb_serial_port *port,
 918                                       unsigned char *data,
 919                                       unsigned int actual_length)
 920 {
 921
 922         struct pl2303_private *priv = usb_get_serial_port_data(port);
 923         unsigned long flags;
 924         u8 status_idx = UART_STATE;
 925         u8 length = UART_STATE + 1;
 926         u16 idv, idp;
 927
 928         idv = le16_to_cpu(port->serial->dev->descriptor.idVendor);
 929         idp = le16_to_cpu(port->serial->dev->descriptor.idProduct);
 930
 931
 932         if (idv == SIEMENS_VENDOR_ID) {
 933                 if (idp == SIEMENS_PRODUCT_ID_X65 ||
 934                     idp == SIEMENS_PRODUCT_ID_SX1 ||
 935                     idp == SIEMENS_PRODUCT_ID_X75) {
 936
 937                         length = 1;
 938                         status_idx = 0;
 939                 }
 940         }
 941
 942         if (actual_length < length)
 943                 return;
 944
 945         /* Save off the uart status for others to look at */
 946         spin_lock_irqsave(&priv->lock, flags);
 947         priv->line_status = data[status_idx];
 948         spin_unlock_irqrestore(&priv->lock, flags);
 949         wake_up_interruptible(&priv->delta_msr_wait);
 950 }
 951
 952 static void pl2303_read_int_callback(struct urb *urb)
 953 {
 954         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 955         unsigned char *data = urb->transfer_buffer;
 956         unsigned int actual_length = urb->actual_length;
 957         int status;
 958
 959         dbg("%s (%d)", __FUNCTION__, port->number);
 960
 961         switch (urb->status) {
 962         case 0:
 963                 /* success */
 964                 break;
 965         case -ECONNRESET:
 966         case -ENOENT:
 967         case -ESHUTDOWN:
 968                 /* this urb is terminated, clean up */
 969                 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
 970                     urb->status);
 971                 return;
 972         default:
 973                 dbg("%s - nonzero urb status received: %d", __FUNCTION__,
 974                     urb->status);
 975                 goto exit;
 976         }
 977
 978         usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
 979                               urb->actual_length, urb->transfer_buffer);
 980
 981         pl2303_update_line_status(port, data, actual_length);
 982
 983 exit:
 984         status = usb_submit_urb(urb, GFP_ATOMIC);
 985         if (status)
 986                 dev_err(&urb->dev->dev,
 987                         "%s - usb_submit_urb failed with result %d\n",
 988                         __FUNCTION__, status);
 989 }
 990
 991 static void pl2303_read_bulk_callback(struct urb *urb)
 992 {
 993         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 994         struct pl2303_private *priv = usb_get_serial_port_data(port);
 995         struct tty_struct *tty;
 996         unsigned char *data = urb->transfer_buffer;
 997         unsigned long flags;
 998         int i;
 999         int result;
1000         u8 status;
1001         char tty_flag;
1002
1003         dbg("%s - port %d", __FUNCTION__, port->number);
1004
1005         if (urb->status) {
1006                 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
1007                 if (!port->open_count) {
1008                         dbg("%s - port is closed, exiting.", __FUNCTION__);
1009                         return;
1010                 }
1011                 if (urb->status == -EPROTO) {
1012                         /* PL2303 mysteriously fails with -EPROTO reschedule
1013                          * the read */
1014                         dbg("%s - caught -EPROTO, resubmitting the urb",
1015                             __FUNCTION__);
1016                         urb->status = 0;
1017                         urb->dev = port->serial->dev;
1018                         result = usb_submit_urb(urb, GFP_ATOMIC);
1019                         if (result)
1020                                 dev_err(&urb->dev->dev, "%s - failed"
1021                                         " resubmitting read urb, error %d\n",
1022                                         __FUNCTION__, result);
1023                         return;
1024                 }
1025                 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
1026                 return;
1027         }
1028
1029         usb_serial_debug_data(debug, &port->dev, __FUNCTION__,
1030                               urb->actual_length, data);
1031
1032         /* get tty_flag from status */
1033         tty_flag = TTY_NORMAL;
1034
1035         spin_lock_irqsave(&priv->lock, flags);
1036         status = priv->line_status;
1037         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
1038         spin_unlock_irqrestore(&priv->lock, flags);
1039         wake_up_interruptible(&priv->delta_msr_wait);
1040
1041         /* break takes precedence over parity, */
1042         /* which takes precedence over framing errors */
1043         if (status & UART_BREAK_ERROR )
1044                 tty_flag = TTY_BREAK;
1045         else if (status & UART_PARITY_ERROR)
1046                 tty_flag = TTY_PARITY;
1047         else if (status & UART_FRAME_ERROR)
1048                 tty_flag = TTY_FRAME;
1049         dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
1050
1051         tty = port->tty;
1052         if (tty && urb->actual_length) {
1053                 tty_buffer_request_room(tty, urb->actual_length + 1);
1054                 /* overrun is special, not associated with a char */
1055                 if (status & UART_OVERRUN_ERROR)
1056                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
1057                 for (i = 0; i < urb->actual_length; ++i)
1058                         tty_insert_flip_char(tty, data[i], tty_flag);
1059                 tty_flip_buffer_push(tty);
1060         }
1061
1062         /* Schedule the next read _if_ we are still open */
1063         if (port->open_count) {
1064                 urb->dev = port->serial->dev;
1065                 result = usb_submit_urb(urb, GFP_ATOMIC);
1066                 if (result)
1067                         dev_err(&urb->dev->dev, "%s - failed resubmitting"
1068                                 " read urb, error %d\n", __FUNCTION__, result);
1069         }
1070
1071         return;
1072 }
1073
1074 static void pl2303_write_bulk_callback(struct urb *urb)
1075 {
1076         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
1077         struct pl2303_private *priv = usb_get_serial_port_data(port);
1078         int result;
1079
1080         dbg("%s - port %d", __FUNCTION__, port->number);
1081
1082         switch (urb->status) {
1083         case 0:
1084                 /* success */
1085                 break;
1086         case -ECONNRESET:
1087         case -ENOENT:
1088         case -ESHUTDOWN:
1089                 /* this urb is terminated, clean up */
1090                 dbg("%s - urb shutting down with status: %d", __FUNCTION__,
1091                     urb->status);
1092                 priv->write_urb_in_use = 0;
1093                 return;
1094         default:
1095                 /* error in the urb, so we have to resubmit it */
1096                 dbg("%s - Overflow in write", __FUNCTION__);
1097                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__,
1098                     urb->status);
1099                 port->write_urb->transfer_buffer_length = 1;
1100                 port->write_urb->dev = port->serial->dev;
1101                 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
1102                 if (result)
1103                         dev_err(&urb->dev->dev, "%s - failed resubmitting write"
1104                                 " urb, error %d\n", __FUNCTION__, result);
1105                 else
1106                         return;
1107         }
1108
1109         priv->write_urb_in_use = 0;
1110
1111         /* send any buffered data */
1112         pl2303_send(port);
1113 }
1114
1115 /* All of the device info needed for the PL2303 SIO serial converter */
1116 static struct usb_serial_driver pl2303_device = {
1117         .driver = {
1118                 .owner =        THIS_MODULE,
1119                 .name =         "pl2303",
1120         },
1121         .id_table =             id_table,
1122         .usb_driver =           &pl2303_driver,
1123         .num_interrupt_in =     NUM_DONT_CARE,
1124         .num_bulk_in =          1,
1125         .num_bulk_out =         1,
1126         .num_ports =            1,
1127         .open =                 pl2303_open,
1128         .close =                pl2303_close,
1129         .write =                pl2303_write,
1130         .ioctl =                pl2303_ioctl,
1131         .break_ctl =            pl2303_break_ctl,
1132         .set_termios =          pl2303_set_termios,
1133         .tiocmget =             pl2303_tiocmget,
1134         .tiocmset =             pl2303_tiocmset,
1135         .read_bulk_callback =   pl2303_read_bulk_callback,
1136         .read_int_callback =    pl2303_read_int_callback,
1137         .write_bulk_callback =  pl2303_write_bulk_callback,
1138         .write_room =           pl2303_write_room,
1139         .chars_in_buffer =      pl2303_chars_in_buffer,
1140         .attach =               pl2303_startup,
1141         .shutdown =             pl2303_shutdown,
1142 };
1143
1144 static int __init pl2303_init(void)
1145 {
1146         int retval;
1147
1148         retval = usb_serial_register(&pl2303_device);
1149         if (retval)
1150                 goto failed_usb_serial_register;
1151         retval = usb_register(&pl2303_driver);
1152         if (retval)
1153                 goto failed_usb_register;
1154         info(DRIVER_DESC);
1155         return 0;
1156 failed_usb_register:
1157         usb_serial_deregister(&pl2303_device);
1158 failed_usb_serial_register:
1159         return retval;
1160 }
1161
1162 static void __exit pl2303_exit(void)
1163 {
1164         usb_deregister(&pl2303_driver);
1165         usb_serial_deregister(&pl2303_device);
1166 }
1167
1168 module_init(pl2303_init);
1169 module_exit(pl2303_exit);
1170
1171 MODULE_DESCRIPTION(DRIVER_DESC);
1172 MODULE_LICENSE("GPL");
1173
1174 module_param(debug, bool, S_IRUGO | S_IWUSR);
1175 MODULE_PARM_DESC(debug, "Debug enabled or not");
1176