USB: ssu100.c: remove dbg() tracing calls
[deliverable/linux.git] / drivers / usb / serial / ssu100.c
1 /*
2 * usb-serial driver for Quatech SSU-100
3 *
4 * based on ftdi_sio.c and the original serqt_usb.c from Quatech
5 *
6 */
7
8 #include <linux/errno.h>
9 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/tty.h>
12 #include <linux/tty_driver.h>
13 #include <linux/tty_flip.h>
14 #include <linux/module.h>
15 #include <linux/serial.h>
16 #include <linux/usb.h>
17 #include <linux/usb/serial.h>
18 #include <linux/serial_reg.h>
19 #include <linux/uaccess.h>
20
21 #define QT_OPEN_CLOSE_CHANNEL 0xca
22 #define QT_SET_GET_DEVICE 0xc2
23 #define QT_SET_GET_REGISTER 0xc0
24 #define QT_GET_SET_PREBUF_TRIG_LVL 0xcc
25 #define QT_SET_ATF 0xcd
26 #define QT_GET_SET_UART 0xc1
27 #define QT_TRANSFER_IN 0xc0
28 #define QT_HW_FLOW_CONTROL_MASK 0xc5
29 #define QT_SW_FLOW_CONTROL_MASK 0xc6
30
31 #define SERIAL_MSR_MASK 0xf0
32
33 #define SERIAL_CRTSCTS ((UART_MCR_RTS << 8) | UART_MSR_CTS)
34
35 #define SERIAL_EVEN_PARITY (UART_LCR_PARITY | UART_LCR_EPAR)
36
37 #define MAX_BAUD_RATE 460800
38
39 #define ATC_DISABLED 0x00
40 #define DUPMODE_BITS 0xc0
41 #define RR_BITS 0x03
42 #define LOOPMODE_BITS 0x41
43 #define RS232_MODE 0x00
44 #define RTSCTS_TO_CONNECTOR 0x40
45 #define CLKS_X4 0x02
46 #define FULLPWRBIT 0x00000080
47 #define NEXT_BOARD_POWER_BIT 0x00000004
48
49 static bool debug;
50
51 /* Version Information */
52 #define DRIVER_VERSION "v0.1"
53 #define DRIVER_DESC "Quatech SSU-100 USB to Serial Driver"
54
55 #define USB_VENDOR_ID_QUATECH 0x061d /* Quatech VID */
56 #define QUATECH_SSU100 0xC020 /* SSU100 */
57
58 static const struct usb_device_id id_table[] = {
59 {USB_DEVICE(USB_VENDOR_ID_QUATECH, QUATECH_SSU100)},
60 {} /* Terminating entry */
61 };
62
63 MODULE_DEVICE_TABLE(usb, id_table);
64
65
66 static struct usb_driver ssu100_driver = {
67 .name = "ssu100",
68 .probe = usb_serial_probe,
69 .disconnect = usb_serial_disconnect,
70 .id_table = id_table,
71 .suspend = usb_serial_suspend,
72 .resume = usb_serial_resume,
73 .supports_autosuspend = 1,
74 };
75
76 struct ssu100_port_private {
77 spinlock_t status_lock;
78 u8 shadowLSR;
79 u8 shadowMSR;
80 wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
81 struct async_icount icount;
82 };
83
84 static void ssu100_release(struct usb_serial *serial)
85 {
86 struct ssu100_port_private *priv = usb_get_serial_port_data(*serial->port);
87
88 kfree(priv);
89 }
90
91 static inline int ssu100_control_msg(struct usb_device *dev,
92 u8 request, u16 data, u16 index)
93 {
94 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
95 request, 0x40, data, index,
96 NULL, 0, 300);
97 }
98
99 static inline int ssu100_setdevice(struct usb_device *dev, u8 *data)
100 {
101 u16 x = ((u16)(data[1] << 8) | (u16)(data[0]));
102
103 return ssu100_control_msg(dev, QT_SET_GET_DEVICE, x, 0);
104 }
105
106
107 static inline int ssu100_getdevice(struct usb_device *dev, u8 *data)
108 {
109 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
110 QT_SET_GET_DEVICE, 0xc0, 0, 0,
111 data, 3, 300);
112 }
113
114 static inline int ssu100_getregister(struct usb_device *dev,
115 unsigned short uart,
116 unsigned short reg,
117 u8 *data)
118 {
119 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
120 QT_SET_GET_REGISTER, 0xc0, reg,
121 uart, data, sizeof(*data), 300);
122
123 }
124
125
126 static inline int ssu100_setregister(struct usb_device *dev,
127 unsigned short uart,
128 unsigned short reg,
129 u16 data)
130 {
131 u16 value = (data << 8) | reg;
132
133 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
134 QT_SET_GET_REGISTER, 0x40, value, uart,
135 NULL, 0, 300);
136
137 }
138
139 #define set_mctrl(dev, set) update_mctrl((dev), (set), 0)
140 #define clear_mctrl(dev, clear) update_mctrl((dev), 0, (clear))
141
142 /* these do not deal with device that have more than 1 port */
143 static inline int update_mctrl(struct usb_device *dev, unsigned int set,
144 unsigned int clear)
145 {
146 unsigned urb_value;
147 int result;
148
149 if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
150 dbg("%s - DTR|RTS not being set|cleared", __func__);
151 return 0; /* no change */
152 }
153
154 clear &= ~set; /* 'set' takes precedence over 'clear' */
155 urb_value = 0;
156 if (set & TIOCM_DTR)
157 urb_value |= UART_MCR_DTR;
158 if (set & TIOCM_RTS)
159 urb_value |= UART_MCR_RTS;
160
161 result = ssu100_setregister(dev, 0, UART_MCR, urb_value);
162 if (result < 0)
163 dbg("%s Error from MODEM_CTRL urb", __func__);
164
165 return result;
166 }
167
168 static int ssu100_initdevice(struct usb_device *dev)
169 {
170 u8 *data;
171 int result = 0;
172
173 data = kzalloc(3, GFP_KERNEL);
174 if (!data)
175 return -ENOMEM;
176
177 result = ssu100_getdevice(dev, data);
178 if (result < 0) {
179 dbg("%s - get_device failed %i", __func__, result);
180 goto out;
181 }
182
183 data[1] &= ~FULLPWRBIT;
184
185 result = ssu100_setdevice(dev, data);
186 if (result < 0) {
187 dbg("%s - setdevice failed %i", __func__, result);
188 goto out;
189 }
190
191 result = ssu100_control_msg(dev, QT_GET_SET_PREBUF_TRIG_LVL, 128, 0);
192 if (result < 0) {
193 dbg("%s - set prebuffer level failed %i", __func__, result);
194 goto out;
195 }
196
197 result = ssu100_control_msg(dev, QT_SET_ATF, ATC_DISABLED, 0);
198 if (result < 0) {
199 dbg("%s - set ATFprebuffer level failed %i", __func__, result);
200 goto out;
201 }
202
203 result = ssu100_getdevice(dev, data);
204 if (result < 0) {
205 dbg("%s - get_device failed %i", __func__, result);
206 goto out;
207 }
208
209 data[0] &= ~(RR_BITS | DUPMODE_BITS);
210 data[0] |= CLKS_X4;
211 data[1] &= ~(LOOPMODE_BITS);
212 data[1] |= RS232_MODE;
213
214 result = ssu100_setdevice(dev, data);
215 if (result < 0) {
216 dbg("%s - setdevice failed %i", __func__, result);
217 goto out;
218 }
219
220 out: kfree(data);
221 return result;
222
223 }
224
225
226 static void ssu100_set_termios(struct tty_struct *tty,
227 struct usb_serial_port *port,
228 struct ktermios *old_termios)
229 {
230 struct usb_device *dev = port->serial->dev;
231 struct ktermios *termios = tty->termios;
232 u16 baud, divisor, remainder;
233 unsigned int cflag = termios->c_cflag;
234 u16 urb_value = 0; /* will hold the new flags */
235 int result;
236
237 if (cflag & PARENB) {
238 if (cflag & PARODD)
239 urb_value |= UART_LCR_PARITY;
240 else
241 urb_value |= SERIAL_EVEN_PARITY;
242 }
243
244 switch (cflag & CSIZE) {
245 case CS5:
246 urb_value |= UART_LCR_WLEN5;
247 break;
248 case CS6:
249 urb_value |= UART_LCR_WLEN6;
250 break;
251 case CS7:
252 urb_value |= UART_LCR_WLEN7;
253 break;
254 default:
255 case CS8:
256 urb_value |= UART_LCR_WLEN8;
257 break;
258 }
259
260 baud = tty_get_baud_rate(tty);
261 if (!baud)
262 baud = 9600;
263
264 dbg("%s - got baud = %d\n", __func__, baud);
265
266
267 divisor = MAX_BAUD_RATE / baud;
268 remainder = MAX_BAUD_RATE % baud;
269 if (((remainder * 2) >= baud) && (baud != 110))
270 divisor++;
271
272 urb_value = urb_value << 8;
273
274 result = ssu100_control_msg(dev, QT_GET_SET_UART, divisor, urb_value);
275 if (result < 0)
276 dbg("%s - set uart failed", __func__);
277
278 if (cflag & CRTSCTS)
279 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
280 SERIAL_CRTSCTS, 0);
281 else
282 result = ssu100_control_msg(dev, QT_HW_FLOW_CONTROL_MASK,
283 0, 0);
284 if (result < 0)
285 dbg("%s - set HW flow control failed", __func__);
286
287 if (I_IXOFF(tty) || I_IXON(tty)) {
288 u16 x = ((u16)(START_CHAR(tty) << 8) | (u16)(STOP_CHAR(tty)));
289
290 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
291 x, 0);
292 } else
293 result = ssu100_control_msg(dev, QT_SW_FLOW_CONTROL_MASK,
294 0, 0);
295
296 if (result < 0)
297 dbg("%s - set SW flow control failed", __func__);
298
299 }
300
301
302 static int ssu100_open(struct tty_struct *tty, struct usb_serial_port *port)
303 {
304 struct usb_device *dev = port->serial->dev;
305 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
306 u8 *data;
307 int result;
308 unsigned long flags;
309
310 data = kzalloc(2, GFP_KERNEL);
311 if (!data)
312 return -ENOMEM;
313
314 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
315 QT_OPEN_CLOSE_CHANNEL,
316 QT_TRANSFER_IN, 0x01,
317 0, data, 2, 300);
318 if (result < 0) {
319 dbg("%s - open failed %i", __func__, result);
320 kfree(data);
321 return result;
322 }
323
324 spin_lock_irqsave(&priv->status_lock, flags);
325 priv->shadowLSR = data[0];
326 priv->shadowMSR = data[1];
327 spin_unlock_irqrestore(&priv->status_lock, flags);
328
329 kfree(data);
330
331 /* set to 9600 */
332 result = ssu100_control_msg(dev, QT_GET_SET_UART, 0x30, 0x0300);
333 if (result < 0)
334 dbg("%s - set uart failed", __func__);
335
336 if (tty)
337 ssu100_set_termios(tty, port, tty->termios);
338
339 return usb_serial_generic_open(tty, port);
340 }
341
342 static void ssu100_close(struct usb_serial_port *port)
343 {
344 usb_serial_generic_close(port);
345 }
346
347 static int get_serial_info(struct usb_serial_port *port,
348 struct serial_struct __user *retinfo)
349 {
350 struct serial_struct tmp;
351
352 if (!retinfo)
353 return -EFAULT;
354
355 memset(&tmp, 0, sizeof(tmp));
356 tmp.line = port->serial->minor;
357 tmp.port = 0;
358 tmp.irq = 0;
359 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
360 tmp.xmit_fifo_size = port->bulk_out_size;
361 tmp.baud_base = 9600;
362 tmp.close_delay = 5*HZ;
363 tmp.closing_wait = 30*HZ;
364
365 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
366 return -EFAULT;
367 return 0;
368 }
369
370 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
371 {
372 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
373 struct async_icount prev, cur;
374 unsigned long flags;
375
376 spin_lock_irqsave(&priv->status_lock, flags);
377 prev = priv->icount;
378 spin_unlock_irqrestore(&priv->status_lock, flags);
379
380 while (1) {
381 wait_event_interruptible(priv->delta_msr_wait,
382 ((priv->icount.rng != prev.rng) ||
383 (priv->icount.dsr != prev.dsr) ||
384 (priv->icount.dcd != prev.dcd) ||
385 (priv->icount.cts != prev.cts)));
386
387 if (signal_pending(current))
388 return -ERESTARTSYS;
389
390 spin_lock_irqsave(&priv->status_lock, flags);
391 cur = priv->icount;
392 spin_unlock_irqrestore(&priv->status_lock, flags);
393
394 if ((prev.rng == cur.rng) &&
395 (prev.dsr == cur.dsr) &&
396 (prev.dcd == cur.dcd) &&
397 (prev.cts == cur.cts))
398 return -EIO;
399
400 if ((arg & TIOCM_RNG && (prev.rng != cur.rng)) ||
401 (arg & TIOCM_DSR && (prev.dsr != cur.dsr)) ||
402 (arg & TIOCM_CD && (prev.dcd != cur.dcd)) ||
403 (arg & TIOCM_CTS && (prev.cts != cur.cts)))
404 return 0;
405 }
406 return 0;
407 }
408
409 static int ssu100_get_icount(struct tty_struct *tty,
410 struct serial_icounter_struct *icount)
411 {
412 struct usb_serial_port *port = tty->driver_data;
413 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
414 struct async_icount cnow = priv->icount;
415
416 icount->cts = cnow.cts;
417 icount->dsr = cnow.dsr;
418 icount->rng = cnow.rng;
419 icount->dcd = cnow.dcd;
420 icount->rx = cnow.rx;
421 icount->tx = cnow.tx;
422 icount->frame = cnow.frame;
423 icount->overrun = cnow.overrun;
424 icount->parity = cnow.parity;
425 icount->brk = cnow.brk;
426 icount->buf_overrun = cnow.buf_overrun;
427
428 return 0;
429 }
430
431
432
433 static int ssu100_ioctl(struct tty_struct *tty,
434 unsigned int cmd, unsigned long arg)
435 {
436 struct usb_serial_port *port = tty->driver_data;
437
438 dbg("%s cmd 0x%04x", __func__, cmd);
439
440 switch (cmd) {
441 case TIOCGSERIAL:
442 return get_serial_info(port,
443 (struct serial_struct __user *) arg);
444
445 case TIOCMIWAIT:
446 return wait_modem_info(port, arg);
447
448 default:
449 break;
450 }
451
452 dbg("%s arg not supported", __func__);
453
454 return -ENOIOCTLCMD;
455 }
456
457 static int ssu100_attach(struct usb_serial *serial)
458 {
459 struct ssu100_port_private *priv;
460 struct usb_serial_port *port = *serial->port;
461
462 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
463 if (!priv) {
464 dev_err(&port->dev, "%s- kmalloc(%Zd) failed.\n", __func__,
465 sizeof(*priv));
466 return -ENOMEM;
467 }
468
469 spin_lock_init(&priv->status_lock);
470 init_waitqueue_head(&priv->delta_msr_wait);
471 usb_set_serial_port_data(port, priv);
472
473 return ssu100_initdevice(serial->dev);
474 }
475
476 static int ssu100_tiocmget(struct tty_struct *tty)
477 {
478 struct usb_serial_port *port = tty->driver_data;
479 struct usb_device *dev = port->serial->dev;
480 u8 *d;
481 int r;
482
483 d = kzalloc(2, GFP_KERNEL);
484 if (!d)
485 return -ENOMEM;
486
487 r = ssu100_getregister(dev, 0, UART_MCR, d);
488 if (r < 0)
489 goto mget_out;
490
491 r = ssu100_getregister(dev, 0, UART_MSR, d+1);
492 if (r < 0)
493 goto mget_out;
494
495 r = (d[0] & UART_MCR_DTR ? TIOCM_DTR : 0) |
496 (d[0] & UART_MCR_RTS ? TIOCM_RTS : 0) |
497 (d[1] & UART_MSR_CTS ? TIOCM_CTS : 0) |
498 (d[1] & UART_MSR_DCD ? TIOCM_CAR : 0) |
499 (d[1] & UART_MSR_RI ? TIOCM_RI : 0) |
500 (d[1] & UART_MSR_DSR ? TIOCM_DSR : 0);
501
502 mget_out:
503 kfree(d);
504 return r;
505 }
506
507 static int ssu100_tiocmset(struct tty_struct *tty,
508 unsigned int set, unsigned int clear)
509 {
510 struct usb_serial_port *port = tty->driver_data;
511 struct usb_device *dev = port->serial->dev;
512
513 return update_mctrl(dev, set, clear);
514 }
515
516 static void ssu100_dtr_rts(struct usb_serial_port *port, int on)
517 {
518 struct usb_device *dev = port->serial->dev;
519
520 mutex_lock(&port->serial->disc_mutex);
521 if (!port->serial->disconnected) {
522 /* Disable flow control */
523 if (!on &&
524 ssu100_setregister(dev, 0, UART_MCR, 0) < 0)
525 dev_err(&port->dev, "error from flowcontrol urb\n");
526 /* drop RTS and DTR */
527 if (on)
528 set_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
529 else
530 clear_mctrl(dev, TIOCM_DTR | TIOCM_RTS);
531 }
532 mutex_unlock(&port->serial->disc_mutex);
533 }
534
535 static void ssu100_update_msr(struct usb_serial_port *port, u8 msr)
536 {
537 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
538 unsigned long flags;
539
540 spin_lock_irqsave(&priv->status_lock, flags);
541 priv->shadowMSR = msr;
542 spin_unlock_irqrestore(&priv->status_lock, flags);
543
544 if (msr & UART_MSR_ANY_DELTA) {
545 /* update input line counters */
546 if (msr & UART_MSR_DCTS)
547 priv->icount.cts++;
548 if (msr & UART_MSR_DDSR)
549 priv->icount.dsr++;
550 if (msr & UART_MSR_DDCD)
551 priv->icount.dcd++;
552 if (msr & UART_MSR_TERI)
553 priv->icount.rng++;
554 wake_up_interruptible(&priv->delta_msr_wait);
555 }
556 }
557
558 static void ssu100_update_lsr(struct usb_serial_port *port, u8 lsr,
559 char *tty_flag)
560 {
561 struct ssu100_port_private *priv = usb_get_serial_port_data(port);
562 unsigned long flags;
563
564 spin_lock_irqsave(&priv->status_lock, flags);
565 priv->shadowLSR = lsr;
566 spin_unlock_irqrestore(&priv->status_lock, flags);
567
568 *tty_flag = TTY_NORMAL;
569 if (lsr & UART_LSR_BRK_ERROR_BITS) {
570 /* we always want to update icount, but we only want to
571 * update tty_flag for one case */
572 if (lsr & UART_LSR_BI) {
573 priv->icount.brk++;
574 *tty_flag = TTY_BREAK;
575 usb_serial_handle_break(port);
576 }
577 if (lsr & UART_LSR_PE) {
578 priv->icount.parity++;
579 if (*tty_flag == TTY_NORMAL)
580 *tty_flag = TTY_PARITY;
581 }
582 if (lsr & UART_LSR_FE) {
583 priv->icount.frame++;
584 if (*tty_flag == TTY_NORMAL)
585 *tty_flag = TTY_FRAME;
586 }
587 if (lsr & UART_LSR_OE){
588 priv->icount.overrun++;
589 if (*tty_flag == TTY_NORMAL)
590 *tty_flag = TTY_OVERRUN;
591 }
592 }
593
594 }
595
596 static int ssu100_process_packet(struct urb *urb,
597 struct tty_struct *tty)
598 {
599 struct usb_serial_port *port = urb->context;
600 char *packet = (char *)urb->transfer_buffer;
601 char flag = TTY_NORMAL;
602 u32 len = urb->actual_length;
603 int i;
604 char *ch;
605
606 if ((len >= 4) &&
607 (packet[0] == 0x1b) && (packet[1] == 0x1b) &&
608 ((packet[2] == 0x00) || (packet[2] == 0x01))) {
609 if (packet[2] == 0x00) {
610 ssu100_update_lsr(port, packet[3], &flag);
611 if (flag == TTY_OVERRUN)
612 tty_insert_flip_char(tty, 0, TTY_OVERRUN);
613 }
614 if (packet[2] == 0x01)
615 ssu100_update_msr(port, packet[3]);
616
617 len -= 4;
618 ch = packet + 4;
619 } else
620 ch = packet;
621
622 if (!len)
623 return 0; /* status only */
624
625 if (port->port.console && port->sysrq) {
626 for (i = 0; i < len; i++, ch++) {
627 if (!usb_serial_handle_sysrq_char(port, *ch))
628 tty_insert_flip_char(tty, *ch, flag);
629 }
630 } else
631 tty_insert_flip_string_fixed_flag(tty, ch, flag, len);
632
633 return len;
634 }
635
636 static void ssu100_process_read_urb(struct urb *urb)
637 {
638 struct usb_serial_port *port = urb->context;
639 struct tty_struct *tty;
640 int count;
641
642 tty = tty_port_tty_get(&port->port);
643 if (!tty)
644 return;
645
646 count = ssu100_process_packet(urb, tty);
647
648 if (count)
649 tty_flip_buffer_push(tty);
650 tty_kref_put(tty);
651 }
652
653 static struct usb_serial_driver ssu100_device = {
654 .driver = {
655 .owner = THIS_MODULE,
656 .name = "ssu100",
657 },
658 .description = DRIVER_DESC,
659 .id_table = id_table,
660 .num_ports = 1,
661 .open = ssu100_open,
662 .close = ssu100_close,
663 .attach = ssu100_attach,
664 .release = ssu100_release,
665 .dtr_rts = ssu100_dtr_rts,
666 .process_read_urb = ssu100_process_read_urb,
667 .tiocmget = ssu100_tiocmget,
668 .tiocmset = ssu100_tiocmset,
669 .get_icount = ssu100_get_icount,
670 .ioctl = ssu100_ioctl,
671 .set_termios = ssu100_set_termios,
672 .disconnect = usb_serial_generic_disconnect,
673 };
674
675 static struct usb_serial_driver * const serial_drivers[] = {
676 &ssu100_device, NULL
677 };
678
679 module_usb_serial_driver(ssu100_driver, serial_drivers);
680
681 MODULE_DESCRIPTION(DRIVER_DESC);
682 MODULE_LICENSE("GPL");
683
684 module_param(debug, bool, S_IRUGO | S_IWUSR);
685 MODULE_PARM_DESC(debug, "Debug enabled or not");
This page took 0.058086 seconds and 5 git commands to generate.