drivers/usb/serial/pl2303.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Prolific PL2303 USB to serial adaptor driver
   4  *
   5  * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
   6  * Copyright (C) 2003 IBM Corp.
   7  *
   8  * Original driver for 2.2.x by anonymous
   9  *
  10  * See Documentation/usb/usb-serial.txt for more information on using this
  11  * driver
  12  */
  13
  14 #include <linux/kernel.h>
  15 #include <linux/errno.h>
  16 #include <linux/slab.h>
  17 #include <linux/tty.h>
  18 #include <linux/tty_driver.h>
  19 #include <linux/tty_flip.h>
  20 #include <linux/serial.h>
  21 #include <linux/module.h>
  22 #include <linux/moduleparam.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/uaccess.h>
  25 #include <linux/usb.h>
  26 #include <linux/usb/serial.h>
  27 #include <asm/unaligned.h>
  28 #include "pl2303.h"
  29
  30
  31 #define PL2303_QUIRK_UART_STATE_IDX0            BIT(0)
  32 #define PL2303_QUIRK_LEGACY                     BIT(1)
  33 #define PL2303_QUIRK_ENDPOINT_HACK              BIT(2)
  34
  35 static const struct usb_device_id id_table[] = {
  36         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID),
  37                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  38         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
  39         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
  40         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
  41         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_CHILITAG) },
  42         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
  43         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
  44         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
  45         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
  46         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
  47         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
  48         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ZTEK) },
  49         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_TB) },
  50         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
  51         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
  52         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
  53                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  54         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
  55                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  56         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
  57                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  58         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
  59         { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
  60         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
  61         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
  62         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
  63         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
  64         { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
  65         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
  66         { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
  67         { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
  68         { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
  69         { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
  70         { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
  71         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1),
  72                 .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  73         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65),
  74                 .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  75         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75),
  76                 .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  77         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
  78                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  79         { USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
  80         { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
  81         { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
  82         { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
  83         { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
  84         { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
  85         { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
  86         { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
  87         { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
  88         { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
  89                 .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  90         { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
  91         { USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
  92         { USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
  93         { USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
  94         { USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
  95         { USB_DEVICE(HP_VENDOR_ID, HP_LD220TA_PRODUCT_ID) },
  96         { USB_DEVICE(HP_VENDOR_ID, HP_LD381_PRODUCT_ID) },
  97         { USB_DEVICE(HP_VENDOR_ID, HP_LD381GC_PRODUCT_ID) },
  98         { USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
  99         { USB_DEVICE(HP_VENDOR_ID, HP_LD960TA_PRODUCT_ID) },
 100         { USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
 101         { USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
 102         { USB_DEVICE(HP_VENDOR_ID, HP_LM920_PRODUCT_ID) },
 103         { USB_DEVICE(HP_VENDOR_ID, HP_LM940_PRODUCT_ID) },
 104         { USB_DEVICE(HP_VENDOR_ID, HP_TD620_PRODUCT_ID) },
 105         { USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
 106         { USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
 107         { USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
 108         { USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
 109         { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
 110         { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530GC_PRODUCT_ID) },
 111         { USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
 112         { USB_DEVICE(AT_VENDOR_ID, AT_VTKIT3_PRODUCT_ID) },
 113         { }                                     /* Terminating entry */
 114 };
 115
 116 MODULE_DEVICE_TABLE(usb, id_table);
 117
 118 #define SET_LINE_REQUEST_TYPE           0x21
 119 #define SET_LINE_REQUEST                0x20
 120
 121 #define SET_CONTROL_REQUEST_TYPE        0x21
 122 #define SET_CONTROL_REQUEST             0x22
 123 #define CONTROL_DTR                     0x01
 124 #define CONTROL_RTS                     0x02
 125
 126 #define BREAK_REQUEST_TYPE              0x21
 127 #define BREAK_REQUEST                   0x23
 128 #define BREAK_ON                        0xffff
 129 #define BREAK_OFF                       0x0000
 130
 131 #define GET_LINE_REQUEST_TYPE           0xa1
 132 #define GET_LINE_REQUEST                0x21
 133
 134 #define VENDOR_WRITE_REQUEST_TYPE       0x40
 135 #define VENDOR_WRITE_REQUEST            0x01
 136
 137 #define VENDOR_READ_REQUEST_TYPE        0xc0
 138 #define VENDOR_READ_REQUEST             0x01
 139
 140 #define UART_STATE_INDEX                8
 141 #define UART_STATE_MSR_MASK             0x8b
 142 #define UART_STATE_TRANSIENT_MASK       0x74
 143 #define UART_DCD                        0x01
 144 #define UART_DSR                        0x02
 145 #define UART_BREAK_ERROR                0x04
 146 #define UART_RING                       0x08
 147 #define UART_FRAME_ERROR                0x10
 148 #define UART_PARITY_ERROR               0x20
 149 #define UART_OVERRUN_ERROR              0x40
 150 #define UART_CTS                        0x80
 151
 152 static void pl2303_set_break(struct usb_serial_port *port, bool enable);
 153
 154 enum pl2303_type {
 155         TYPE_01,        /* Type 0 and 1 (difference unknown) */
 156         TYPE_HX,        /* HX version of the pl2303 chip */
 157         TYPE_COUNT
 158 };
 159
 160 struct pl2303_type_data {
 161         speed_t max_baud_rate;
 162         unsigned long quirks;
 163 };
 164
 165 struct pl2303_serial_private {
 166         const struct pl2303_type_data *type;
 167         unsigned long quirks;
 168 };
 169
 170 struct pl2303_private {
 171         spinlock_t lock;
 172         u8 line_control;
 173         u8 line_status;
 174
 175         u8 line_settings[7];
 176 };
 177
 178 static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
 179         [TYPE_01] = {
 180                 .max_baud_rate =        1228800,
 181                 .quirks =               PL2303_QUIRK_LEGACY,
 182         },
 183         [TYPE_HX] = {
 184                 .max_baud_rate =        12000000,
 185         },
 186 };
 187
 188 static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
 189                                                         unsigned char buf[1])
 190 {
 191         struct device *dev = &serial->interface->dev;
 192         int res;
 193
 194         res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 195                         VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
 196                         value, 0, buf, 1, 100);
 197         if (res != 1) {
 198                 dev_err(dev, "%s - failed to read [%04x]: %d\n", __func__,
 199                                                                 value, res);
 200                 if (res >= 0)
 201                         res = -EIO;
 202
 203                 return res;
 204         }
 205
 206         dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, buf[0]);
 207
 208         return 0;
 209 }
 210
 211 static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
 212 {
 213         struct device *dev = &serial->interface->dev;
 214         int res;
 215
 216         dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, index);
 217
 218         res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 219                         VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
 220                         value, index, NULL, 0, 100);
 221         if (res) {
 222                 dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
 223                                                                 value, res);
 224                 return res;
 225         }
 226
 227         return 0;
 228 }
 229
 230 static int pl2303_probe(struct usb_serial *serial,
 231                                         const struct usb_device_id *id)
 232 {
 233         usb_set_serial_data(serial, (void *)id->driver_info);
 234
 235         return 0;
 236 }
 237
 238 /*
 239  * Use interrupt endpoint from first interface if available.
 240  *
 241  * This is needed due to the looney way its endpoints are set up.
 242  */
 243 static int pl2303_endpoint_hack(struct usb_serial *serial,
 244                                         struct usb_serial_endpoints *epds)
 245 {
 246         struct usb_interface *interface = serial->interface;
 247         struct usb_device *dev = serial->dev;
 248         struct device *ddev = &interface->dev;
 249         struct usb_host_interface *iface_desc;
 250         struct usb_endpoint_descriptor *endpoint;
 251         unsigned int i;
 252
 253         if (interface == dev->actconfig->interface[0])
 254                 return 0;
 255
 256         /* check out the endpoints of the other interface */
 257         iface_desc = dev->actconfig->interface[0]->cur_altsetting;
 258
 259         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
 260                 endpoint = &iface_desc->endpoint[i].desc;
 261
 262                 if (!usb_endpoint_is_int_in(endpoint))
 263                         continue;
 264
 265                 dev_dbg(ddev, "found interrupt in on separate interface\n");
 266                 if (epds->num_interrupt_in < ARRAY_SIZE(epds->interrupt_in))
 267                         epds->interrupt_in[epds->num_interrupt_in++] = endpoint;
 268         }
 269
 270         return 0;
 271 }
 272
 273 static int pl2303_calc_num_ports(struct usb_serial *serial,
 274                                         struct usb_serial_endpoints *epds)
 275 {
 276         unsigned long quirks = (unsigned long)usb_get_serial_data(serial);
 277         struct device *dev = &serial->interface->dev;
 278         int ret;
 279
 280         if (quirks & PL2303_QUIRK_ENDPOINT_HACK) {
 281                 ret = pl2303_endpoint_hack(serial, epds);
 282                 if (ret)
 283                         return ret;
 284         }
 285
 286         if (epds->num_interrupt_in < 1) {
 287                 dev_err(dev, "required interrupt-in endpoint missing\n");
 288                 return -ENODEV;
 289         }
 290
 291         return 1;
 292 }
 293
 294 static int pl2303_startup(struct usb_serial *serial)
 295 {
 296         struct pl2303_serial_private *spriv;
 297         enum pl2303_type type = TYPE_01;
 298         unsigned char *buf;
 299
 300         spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
 301         if (!spriv)
 302                 return -ENOMEM;
 303
 304         buf = kmalloc(1, GFP_KERNEL);
 305         if (!buf) {
 306                 kfree(spriv);
 307                 return -ENOMEM;
 308         }
 309
 310         if (serial->dev->descriptor.bDeviceClass == 0x02)
 311                 type = TYPE_01;         /* type 0 */
 312         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 313                 type = TYPE_HX;
 314         else if (serial->dev->descriptor.bDeviceClass == 0x00)
 315                 type = TYPE_01;         /* type 1 */
 316         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
 317                 type = TYPE_01;         /* type 1 */
 318         dev_dbg(&serial->interface->dev, "device type: %d\n", type);
 319
 320         spriv->type = &pl2303_type_data[type];
 321         spriv->quirks = (unsigned long)usb_get_serial_data(serial);
 322         spriv->quirks |= spriv->type->quirks;
 323
 324         usb_set_serial_data(serial, spriv);
 325
 326         pl2303_vendor_read(serial, 0x8484, buf);
 327         pl2303_vendor_write(serial, 0x0404, 0);
 328         pl2303_vendor_read(serial, 0x8484, buf);
 329         pl2303_vendor_read(serial, 0x8383, buf);
 330         pl2303_vendor_read(serial, 0x8484, buf);
 331         pl2303_vendor_write(serial, 0x0404, 1);
 332         pl2303_vendor_read(serial, 0x8484, buf);
 333         pl2303_vendor_read(serial, 0x8383, buf);
 334         pl2303_vendor_write(serial, 0, 1);
 335         pl2303_vendor_write(serial, 1, 0);
 336         if (spriv->quirks & PL2303_QUIRK_LEGACY)
 337                 pl2303_vendor_write(serial, 2, 0x24);
 338         else
 339                 pl2303_vendor_write(serial, 2, 0x44);
 340
 341         kfree(buf);
 342
 343         return 0;
 344 }
 345
 346 static void pl2303_release(struct usb_serial *serial)
 347 {
 348         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 349
 350         kfree(spriv);
 351 }
 352
 353 static int pl2303_port_probe(struct usb_serial_port *port)
 354 {
 355         struct pl2303_private *priv;
 356
 357         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 358         if (!priv)
 359                 return -ENOMEM;
 360
 361         spin_lock_init(&priv->lock);
 362
 363         usb_set_serial_port_data(port, priv);
 364
 365         port->port.drain_delay = 256;
 366
 367         return 0;
 368 }
 369
 370 static int pl2303_port_remove(struct usb_serial_port *port)
 371 {
 372         struct pl2303_private *priv = usb_get_serial_port_data(port);
 373
 374         kfree(priv);
 375
 376         return 0;
 377 }
 378
 379 static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
 380 {
 381         struct usb_device *dev = port->serial->dev;
 382         int retval;
 383
 384         dev_dbg(&port->dev, "%s - %02x\n", __func__, value);
 385
 386         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 387                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 388                                  value, 0, NULL, 0, 100);
 389         if (retval)
 390                 dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
 391
 392         return retval;
 393 }
 394
 395 /*
 396  * Returns the nearest supported baud rate that can be set directly without
 397  * using divisors.
 398  */
 399 static speed_t pl2303_get_supported_baud_rate(speed_t baud)
 400 {
 401         static const speed_t baud_sup[] = {
 402                 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600,
 403                 14400, 19200, 28800, 38400, 57600, 115200, 230400, 460800,
 404                 614400, 921600, 1228800, 2457600, 3000000, 6000000
 405         };
 406
 407         unsigned i;
 408
 409         for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
 410                 if (baud_sup[i] > baud)
 411                         break;
 412         }
 413
 414         if (i == ARRAY_SIZE(baud_sup))
 415                 baud = baud_sup[i - 1];
 416         else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
 417                 baud = baud_sup[i - 1];
 418         else
 419                 baud = baud_sup[i];
 420
 421         return baud;
 422 }
 423
 424 /*
 425  * NOTE: If unsupported baud rates are set directly, the PL2303 seems to
 426  *       use 9600 baud.
 427  */
 428 static speed_t pl2303_encode_baud_rate_direct(unsigned char buf[4],
 429                                                                 speed_t baud)
 430 {
 431         put_unaligned_le32(baud, buf);
 432
 433         return baud;
 434 }
 435
 436 static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
 437                                                                 speed_t baud)
 438 {
 439         unsigned int baseline, mantissa, exponent;
 440
 441         /*
 442          * Apparently the formula is:
 443          *   baudrate = 12M * 32 / (mantissa * 4^exponent)
 444          * where
 445          *   mantissa = buf[8:0]
 446          *   exponent = buf[11:9]
 447          */
 448         baseline = 12000000 * 32;
 449         mantissa = baseline / baud;
 450         if (mantissa == 0)
 451                 mantissa = 1;   /* Avoid dividing by zero if baud > 32*12M. */
 452         exponent = 0;
 453         while (mantissa >= 512) {
 454                 if (exponent < 7) {
 455                         mantissa >>= 2; /* divide by 4 */
 456                         exponent++;
 457                 } else {
 458                         /* Exponent is maxed. Trim mantissa and leave. */
 459                         mantissa = 511;
 460                         break;
 461                 }
 462         }
 463
 464         buf[3] = 0x80;
 465         buf[2] = 0;
 466         buf[1] = exponent << 1 | mantissa >> 8;
 467         buf[0] = mantissa & 0xff;
 468
 469         /* Calculate and return the exact baud rate. */
 470         baud = (baseline / mantissa) >> (exponent << 1);
 471
 472         return baud;
 473 }
 474
 475 static void pl2303_encode_baud_rate(struct tty_struct *tty,
 476                                         struct usb_serial_port *port,
 477                                         u8 buf[4])
 478 {
 479         struct usb_serial *serial = port->serial;
 480         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 481         speed_t baud_sup;
 482         speed_t baud;
 483
 484         baud = tty_get_baud_rate(tty);
 485         dev_dbg(&port->dev, "baud requested = %u\n", baud);
 486         if (!baud)
 487                 return;
 488
 489         if (spriv->type->max_baud_rate)
 490                 baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
 491         /*
 492          * Use direct method for supported baud rates, otherwise use divisors.
 493          */
 494         baud_sup = pl2303_get_supported_baud_rate(baud);
 495
 496         if (baud == baud_sup)
 497                 baud = pl2303_encode_baud_rate_direct(buf, baud);
 498         else
 499                 baud = pl2303_encode_baud_rate_divisor(buf, baud);
 500
 501         /* Save resulting baud rate */
 502         tty_encode_baud_rate(tty, baud, baud);
 503         dev_dbg(&port->dev, "baud set = %u\n", baud);
 504 }
 505
 506 static int pl2303_get_line_request(struct usb_serial_port *port,
 507                                                         unsigned char buf[7])
 508 {
 509         struct usb_device *udev = port->serial->dev;
 510         int ret;
 511
 512         ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
 513                                 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 514                                 0, 0, buf, 7, 100);
 515         if (ret != 7) {
 516                 dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
 517
 518                 if (ret >= 0)
 519                         ret = -EIO;
 520
 521                 return ret;
 522         }
 523
 524         dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
 525
 526         return 0;
 527 }
 528
 529 static int pl2303_set_line_request(struct usb_serial_port *port,
 530                                                         unsigned char buf[7])
 531 {
 532         struct usb_device *udev = port->serial->dev;
 533         int ret;
 534
 535         ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 536                                 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 537                                 0, 0, buf, 7, 100);
 538         if (ret < 0) {
 539                 dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
 540                 return ret;
 541         }
 542
 543         dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
 544
 545         return 0;
 546 }
 547
 548 static bool pl2303_termios_change(const struct ktermios *a, const struct ktermios *b)
 549 {
 550         bool ixon_change;
 551
 552         ixon_change = ((a->c_iflag ^ b->c_iflag) & (IXON | IXANY)) ||
 553                         a->c_cc[VSTART] != b->c_cc[VSTART] ||
 554                         a->c_cc[VSTOP] != b->c_cc[VSTOP];
 555
 556         return tty_termios_hw_change(a, b) || ixon_change;
 557 }
 558
 559 static void pl2303_set_termios(struct tty_struct *tty,
 560                 struct usb_serial_port *port, struct ktermios *old_termios)
 561 {
 562         struct usb_serial *serial = port->serial;
 563         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 564         struct pl2303_private *priv = usb_get_serial_port_data(port);
 565         unsigned long flags;
 566         unsigned char *buf;
 567         int ret;
 568         u8 control;
 569
 570         if (old_termios && !pl2303_termios_change(&tty->termios, old_termios))
 571                 return;
 572
 573         buf = kzalloc(7, GFP_KERNEL);
 574         if (!buf) {
 575                 /* Report back no change occurred */
 576                 if (old_termios)
 577                         tty->termios = *old_termios;
 578                 return;
 579         }
 580
 581         pl2303_get_line_request(port, buf);
 582
 583         switch (C_CSIZE(tty)) {
 584         case CS5:
 585                 buf[6] = 5;
 586                 break;
 587         case CS6:
 588                 buf[6] = 6;
 589                 break;
 590         case CS7:
 591                 buf[6] = 7;
 592                 break;
 593         default:
 594         case CS8:
 595                 buf[6] = 8;
 596         }
 597         dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
 598
 599         /* For reference buf[0]:buf[3] baud rate value */
 600         pl2303_encode_baud_rate(tty, port, &buf[0]);
 601
 602         /* For reference buf[4]=0 is 1 stop bits */
 603         /* For reference buf[4]=1 is 1.5 stop bits */
 604         /* For reference buf[4]=2 is 2 stop bits */
 605         if (C_CSTOPB(tty)) {
 606                 /*
 607                  * NOTE: Comply with "real" UARTs / RS232:
 608                  *       use 1.5 instead of 2 stop bits with 5 data bits
 609                  */
 610                 if (C_CSIZE(tty) == CS5) {
 611                         buf[4] = 1;
 612                         dev_dbg(&port->dev, "stop bits = 1.5\n");
 613                 } else {
 614                         buf[4] = 2;
 615                         dev_dbg(&port->dev, "stop bits = 2\n");
 616                 }
 617         } else {
 618                 buf[4] = 0;
 619                 dev_dbg(&port->dev, "stop bits = 1\n");
 620         }
 621
 622         if (C_PARENB(tty)) {
 623                 /* For reference buf[5]=0 is none parity */
 624                 /* For reference buf[5]=1 is odd parity */
 625                 /* For reference buf[5]=2 is even parity */
 626                 /* For reference buf[5]=3 is mark parity */
 627                 /* For reference buf[5]=4 is space parity */
 628                 if (C_PARODD(tty)) {
 629                         if (C_CMSPAR(tty)) {
 630                                 buf[5] = 3;
 631                                 dev_dbg(&port->dev, "parity = mark\n");
 632                         } else {
 633                                 buf[5] = 1;
 634                                 dev_dbg(&port->dev, "parity = odd\n");
 635                         }
 636                 } else {
 637                         if (C_CMSPAR(tty)) {
 638                                 buf[5] = 4;
 639                                 dev_dbg(&port->dev, "parity = space\n");
 640                         } else {
 641                                 buf[5] = 2;
 642                                 dev_dbg(&port->dev, "parity = even\n");
 643                         }
 644                 }
 645         } else {
 646                 buf[5] = 0;
 647                 dev_dbg(&port->dev, "parity = none\n");
 648         }
 649
 650         /*
 651          * Some PL2303 are known to lose bytes if you change serial settings
 652          * even to the same values as before. Thus we actually need to filter
 653          * in this specific case.
 654          *
 655          * Note that the tty_termios_hw_change check above is not sufficient
 656          * as a previously requested baud rate may differ from the one
 657          * actually used (and stored in old_termios).
 658          *
 659          * NOTE: No additional locking needed for line_settings as it is
 660          *       only used in set_termios, which is serialised against itself.
 661          */
 662         if (!old_termios || memcmp(buf, priv->line_settings, 7)) {
 663                 ret = pl2303_set_line_request(port, buf);
 664                 if (!ret)
 665                         memcpy(priv->line_settings, buf, 7);
 666         }
 667
 668         /* change control lines if we are switching to or from B0 */
 669         spin_lock_irqsave(&priv->lock, flags);
 670         control = priv->line_control;
 671         if (C_BAUD(tty) == B0)
 672                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 673         else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
 674                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 675         if (control != priv->line_control) {
 676                 control = priv->line_control;
 677                 spin_unlock_irqrestore(&priv->lock, flags);
 678                 pl2303_set_control_lines(port, control);
 679         } else {
 680                 spin_unlock_irqrestore(&priv->lock, flags);
 681         }
 682
 683         if (C_CRTSCTS(tty)) {
 684                 if (spriv->quirks & PL2303_QUIRK_LEGACY)
 685                         pl2303_vendor_write(serial, 0x0, 0x41);
 686                 else
 687                         pl2303_vendor_write(serial, 0x0, 0x61);
 688         } else if (I_IXON(tty) && !I_IXANY(tty) && START_CHAR(tty) == 0x11 &&
 689                         STOP_CHAR(tty) == 0x13) {
 690                 pl2303_vendor_write(serial, 0x0, 0xc0);
 691         } else {
 692                 pl2303_vendor_write(serial, 0x0, 0x0);
 693         }
 694
 695         kfree(buf);
 696 }
 697
 698 static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
 699 {
 700         struct pl2303_private *priv = usb_get_serial_port_data(port);
 701         unsigned long flags;
 702         u8 control;
 703
 704         spin_lock_irqsave(&priv->lock, flags);
 705         if (on)
 706                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 707         else
 708                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 709         control = priv->line_control;
 710         spin_unlock_irqrestore(&priv->lock, flags);
 711
 712         pl2303_set_control_lines(port, control);
 713 }
 714
 715 static void pl2303_close(struct usb_serial_port *port)
 716 {
 717         usb_serial_generic_close(port);
 718         usb_kill_urb(port->interrupt_in_urb);
 719         pl2303_set_break(port, false);
 720 }
 721
 722 static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
 723 {
 724         struct usb_serial *serial = port->serial;
 725         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 726         int result;
 727
 728         if (spriv->quirks & PL2303_QUIRK_LEGACY) {
 729                 usb_clear_halt(serial->dev, port->write_urb->pipe);
 730                 usb_clear_halt(serial->dev, port->read_urb->pipe);
 731         } else {
 732                 /* reset upstream data pipes */
 733                 pl2303_vendor_write(serial, 8, 0);
 734                 pl2303_vendor_write(serial, 9, 0);
 735         }
 736
 737         /* Setup termios */
 738         if (tty)
 739                 pl2303_set_termios(tty, port, NULL);
 740
 741         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 742         if (result) {
 743                 dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
 744                         result);
 745                 return result;
 746         }
 747
 748         result = usb_serial_generic_open(tty, port);
 749         if (result) {
 750                 usb_kill_urb(port->interrupt_in_urb);
 751                 return result;
 752         }
 753
 754         return 0;
 755 }
 756
 757 static int pl2303_tiocmset(struct tty_struct *tty,
 758                            unsigned int set, unsigned int clear)
 759 {
 760         struct usb_serial_port *port = tty->driver_data;
 761         struct pl2303_private *priv = usb_get_serial_port_data(port);
 762         unsigned long flags;
 763         u8 control;
 764         int ret;
 765
 766         spin_lock_irqsave(&priv->lock, flags);
 767         if (set & TIOCM_RTS)
 768                 priv->line_control |= CONTROL_RTS;
 769         if (set & TIOCM_DTR)
 770                 priv->line_control |= CONTROL_DTR;
 771         if (clear & TIOCM_RTS)
 772                 priv->line_control &= ~CONTROL_RTS;
 773         if (clear & TIOCM_DTR)
 774                 priv->line_control &= ~CONTROL_DTR;
 775         control = priv->line_control;
 776         spin_unlock_irqrestore(&priv->lock, flags);
 777
 778         ret = pl2303_set_control_lines(port, control);
 779         if (ret)
 780                 return usb_translate_errors(ret);
 781
 782         return 0;
 783 }
 784
 785 static int pl2303_tiocmget(struct tty_struct *tty)
 786 {
 787         struct usb_serial_port *port = tty->driver_data;
 788         struct pl2303_private *priv = usb_get_serial_port_data(port);
 789         unsigned long flags;
 790         unsigned int mcr;
 791         unsigned int status;
 792         unsigned int result;
 793
 794         spin_lock_irqsave(&priv->lock, flags);
 795         mcr = priv->line_control;
 796         status = priv->line_status;
 797         spin_unlock_irqrestore(&priv->lock, flags);
 798
 799         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
 800                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
 801                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 802                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 803                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
 804                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
 805
 806         dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
 807
 808         return result;
 809 }
 810
 811 static int pl2303_carrier_raised(struct usb_serial_port *port)
 812 {
 813         struct pl2303_private *priv = usb_get_serial_port_data(port);
 814
 815         if (priv->line_status & UART_DCD)
 816                 return 1;
 817
 818         return 0;
 819 }
 820
 821 static int pl2303_ioctl(struct tty_struct *tty,
 822                         unsigned int cmd, unsigned long arg)
 823 {
 824         struct serial_struct ser;
 825         struct usb_serial_port *port = tty->driver_data;
 826
 827         switch (cmd) {
 828         case TIOCGSERIAL:
 829                 memset(&ser, 0, sizeof ser);
 830                 ser.type = PORT_16654;
 831                 ser.line = port->minor;
 832                 ser.port = port->port_number;
 833                 ser.baud_base = 460800;
 834
 835                 if (copy_to_user((void __user *)arg, &ser, sizeof ser))
 836                         return -EFAULT;
 837
 838                 return 0;
 839         default:
 840                 break;
 841         }
 842
 843         return -ENOIOCTLCMD;
 844 }
 845
 846 static void pl2303_set_break(struct usb_serial_port *port, bool enable)
 847 {
 848         struct usb_serial *serial = port->serial;
 849         u16 state;
 850         int result;
 851
 852         if (enable)
 853                 state = BREAK_ON;
 854         else
 855                 state = BREAK_OFF;
 856
 857         dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
 858                         state == BREAK_OFF ? "off" : "on");
 859
 860         result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 861                                  BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
 862                                  0, NULL, 0, 100);
 863         if (result)
 864                 dev_err(&port->dev, "error sending break = %d\n", result);
 865 }
 866
 867 static void pl2303_break_ctl(struct tty_struct *tty, int state)
 868 {
 869         struct usb_serial_port *port = tty->driver_data;
 870
 871         pl2303_set_break(port, state);
 872 }
 873
 874 static void pl2303_update_line_status(struct usb_serial_port *port,
 875                                       unsigned char *data,
 876                                       unsigned int actual_length)
 877 {
 878         struct usb_serial *serial = port->serial;
 879         struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
 880         struct pl2303_private *priv = usb_get_serial_port_data(port);
 881         struct tty_struct *tty;
 882         unsigned long flags;
 883         unsigned int status_idx = UART_STATE_INDEX;
 884         u8 status;
 885         u8 delta;
 886
 887         if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
 888                 status_idx = 0;
 889
 890         if (actual_length < status_idx + 1)
 891                 return;
 892
 893         status = data[status_idx];
 894
 895         /* Save off the uart status for others to look at */
 896         spin_lock_irqsave(&priv->lock, flags);
 897         delta = priv->line_status ^ status;
 898         priv->line_status = status;
 899         spin_unlock_irqrestore(&priv->lock, flags);
 900
 901         if (status & UART_BREAK_ERROR)
 902                 usb_serial_handle_break(port);
 903
 904         if (delta & UART_STATE_MSR_MASK) {
 905                 if (delta & UART_CTS)
 906                         port->icount.cts++;
 907                 if (delta & UART_DSR)
 908                         port->icount.dsr++;
 909                 if (delta & UART_RING)
 910                         port->icount.rng++;
 911                 if (delta & UART_DCD) {
 912                         port->icount.dcd++;
 913                         tty = tty_port_tty_get(&port->port);
 914                         if (tty) {
 915                                 usb_serial_handle_dcd_change(port, tty,
 916                                                         status & UART_DCD);
 917                                 tty_kref_put(tty);
 918                         }
 919                 }
 920
 921                 wake_up_interruptible(&port->port.delta_msr_wait);
 922         }
 923 }
 924
 925 static void pl2303_read_int_callback(struct urb *urb)
 926 {
 927         struct usb_serial_port *port =  urb->context;
 928         unsigned char *data = urb->transfer_buffer;
 929         unsigned int actual_length = urb->actual_length;
 930         int status = urb->status;
 931         int retval;
 932
 933         switch (status) {
 934         case 0:
 935                 /* success */
 936                 break;
 937         case -ECONNRESET:
 938         case -ENOENT:
 939         case -ESHUTDOWN:
 940                 /* this urb is terminated, clean up */
 941                 dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
 942                         __func__, status);
 943                 return;
 944         default:
 945                 dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
 946                         __func__, status);
 947                 goto exit;
 948         }
 949
 950         usb_serial_debug_data(&port->dev, __func__,
 951                               urb->actual_length, urb->transfer_buffer);
 952
 953         pl2303_update_line_status(port, data, actual_length);
 954
 955 exit:
 956         retval = usb_submit_urb(urb, GFP_ATOMIC);
 957         if (retval) {
 958                 dev_err(&port->dev,
 959                         "%s - usb_submit_urb failed with result %d\n",
 960                         __func__, retval);
 961         }
 962 }
 963
 964 static void pl2303_process_read_urb(struct urb *urb)
 965 {
 966         struct usb_serial_port *port = urb->context;
 967         struct pl2303_private *priv = usb_get_serial_port_data(port);
 968         unsigned char *data = urb->transfer_buffer;
 969         char tty_flag = TTY_NORMAL;
 970         unsigned long flags;
 971         u8 line_status;
 972         int i;
 973
 974         /* update line status */
 975         spin_lock_irqsave(&priv->lock, flags);
 976         line_status = priv->line_status;
 977         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
 978         spin_unlock_irqrestore(&priv->lock, flags);
 979
 980         if (!urb->actual_length)
 981                 return;
 982
 983         /*
 984          * Break takes precedence over parity, which takes precedence over
 985          * framing errors.
 986          */
 987         if (line_status & UART_BREAK_ERROR)
 988                 tty_flag = TTY_BREAK;
 989         else if (line_status & UART_PARITY_ERROR)
 990                 tty_flag = TTY_PARITY;
 991         else if (line_status & UART_FRAME_ERROR)
 992                 tty_flag = TTY_FRAME;
 993
 994         if (tty_flag != TTY_NORMAL)
 995                 dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
 996                                                                 tty_flag);
 997         /* overrun is special, not associated with a char */
 998         if (line_status & UART_OVERRUN_ERROR)
 999                 tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
1000
1001         if (port->port.console && port->sysrq) {
1002                 for (i = 0; i < urb->actual_length; ++i)
1003                         if (!usb_serial_handle_sysrq_char(port, data[i]))
1004                                 tty_insert_flip_char(&port->port, data[i],
1005                                                 tty_flag);
1006         } else {
1007                 tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
1008                                                         urb->actual_length);
1009         }
1010
1011         tty_flip_buffer_push(&port->port);
1012 }
1013
1014 static struct usb_serial_driver pl2303_device = {
1015         .driver = {
1016                 .owner =        THIS_MODULE,
1017                 .name =         "pl2303",
1018         },
1019         .id_table =             id_table,
1020         .num_bulk_in =          1,
1021         .num_bulk_out =         1,
1022         .num_interrupt_in =     0,      /* see pl2303_calc_num_ports */
1023         .bulk_in_size =         256,
1024         .bulk_out_size =        256,
1025         .open =                 pl2303_open,
1026         .close =                pl2303_close,
1027         .dtr_rts =              pl2303_dtr_rts,
1028         .carrier_raised =       pl2303_carrier_raised,
1029         .ioctl =                pl2303_ioctl,
1030         .break_ctl =            pl2303_break_ctl,
1031         .set_termios =          pl2303_set_termios,
1032         .tiocmget =             pl2303_tiocmget,
1033         .tiocmset =             pl2303_tiocmset,
1034         .tiocmiwait =           usb_serial_generic_tiocmiwait,
1035         .process_read_urb =     pl2303_process_read_urb,
1036         .read_int_callback =    pl2303_read_int_callback,
1037         .probe =                pl2303_probe,
1038         .calc_num_ports =       pl2303_calc_num_ports,
1039         .attach =               pl2303_startup,
1040         .release =              pl2303_release,
1041         .port_probe =           pl2303_port_probe,
1042         .port_remove =          pl2303_port_remove,
1043 };
1044
1045 static struct usb_serial_driver * const serial_drivers[] = {
1046         &pl2303_device, NULL
1047 };
1048
1049 module_usb_serial_driver(serial_drivers, id_table);
1050
1051 MODULE_DESCRIPTION("Prolific PL2303 USB to serial adaptor driver");
1052 MODULE_LICENSE("GPL v2");