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