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