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