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