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