1 /*
2 * Ours Technology Inc. OTi-6858 USB to serial adapter driver.
3 *
4 * Copyleft (C) 2007 Kees Lemmens (adapted for kernel 2.6.20)
5 * Copyright (C) 2006 Tomasz Michal Lukaszewski (FIXME: add e-mail)
6 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2003 IBM Corp.
8 *
9 * Many thanks to the authors of pl2303 driver: all functions in this file
10 * are heavily based on pl2303 code, buffering code is a 1-to-1 copy.
11 *
12 * Warning! You use this driver on your own risk! The only official
13 * description of this device I have is datasheet from manufacturer,
14 * and it doesn't contain almost any information needed to write a driver.
15 * Almost all knowlegde used while writing this driver was gathered by:
16 * - analyzing traffic between device and the M$ Windows 2000 driver,
17 * - trying different bit combinations and checking pin states
18 * with a voltmeter,
19 * - receiving malformed frames and producing buffer overflows
20 * to learn how errors are reported,
21 * So, THIS CODE CAN DESTROY OTi-6858 AND ANY OTHER DEVICES, THAT ARE
22 * CONNECTED TO IT!
23 *
24 * This program is free software; you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation; either version 2 of the License.
27 *
28 * See Documentation/usb/usb-serial.txt for more information on using this
29 * driver
30 *
31 * TODO:
32 * - implement correct flushing for ioctls and oti6858_close()
33 * - check how errors (rx overflow, parity error, framing error) are reported
34 * - implement oti6858_break_ctl()
35 * - implement more ioctls
36 * - test/implement flow control
37 * - allow setting custom baud rates
38 */
39
40 #include <linux/kernel.h>
41 #include <linux/errno.h>
42 #include <linux/init.h>
43 #include <linux/slab.h>
44 #include <linux/tty.h>
45 #include <linux/tty_driver.h>
46 #include <linux/tty_flip.h>
47 #include <linux/serial.h>
48 #include <linux/module.h>
49 #include <linux/moduleparam.h>
50 #include <linux/spinlock.h>
51 #include <linux/usb.h>
52 #include <linux/usb/serial.h>
53 #include <linux/uaccess.h>
54 #include <linux/kfifo.h>
55 #include "oti6858.h"
56
57 #define OTI6858_DESCRIPTION \
58 "Ours Technology Inc. OTi-6858 USB to serial adapter driver"
59 #define OTI6858_AUTHOR "Tomasz Michal Lukaszewski <FIXME@FIXME>"
60 #define OTI6858_VERSION "0.2"
61
62 static const struct usb_device_id id_table[] = {
63 { USB_DEVICE(OTI6858_VENDOR_ID, OTI6858_PRODUCT_ID) },
64 { }
65 };
66
67 MODULE_DEVICE_TABLE(usb, id_table);
68
69 static struct usb_driver oti6858_driver = {
70 .name = "oti6858",
71 .probe = usb_serial_probe,
72 .disconnect = usb_serial_disconnect,
73 .id_table = id_table,
74 .no_dynamic_id = 1,
75 };
76
77 static bool debug;
78
79 /* requests */
80 #define OTI6858_REQ_GET_STATUS (USB_DIR_IN | USB_TYPE_VENDOR | 0x00)
81 #define OTI6858_REQ_T_GET_STATUS 0x01
82
83 #define OTI6858_REQ_SET_LINE (USB_DIR_OUT | USB_TYPE_VENDOR | 0x00)
84 #define OTI6858_REQ_T_SET_LINE 0x00
85
86 #define OTI6858_REQ_CHECK_TXBUFF (USB_DIR_IN | USB_TYPE_VENDOR | 0x01)
87 #define OTI6858_REQ_T_CHECK_TXBUFF 0x00
88
89 /* format of the control packet */
90 struct oti6858_control_pkt {
91 __le16 divisor; /* baud rate = 96000000 / (16 * divisor), LE */
92 #define OTI6858_MAX_BAUD_RATE 3000000
93 u8 frame_fmt;
94 #define FMT_STOP_BITS_MASK 0xc0
95 #define FMT_STOP_BITS_1 0x00
96 #define FMT_STOP_BITS_2 0x40 /* 1.5 stop bits if FMT_DATA_BITS_5 */
97 #define FMT_PARITY_MASK 0x38
98 #define FMT_PARITY_NONE 0x00
99 #define FMT_PARITY_ODD 0x08
100 #define FMT_PARITY_EVEN 0x18
101 #define FMT_PARITY_MARK 0x28
102 #define FMT_PARITY_SPACE 0x38
103 #define FMT_DATA_BITS_MASK 0x03
104 #define FMT_DATA_BITS_5 0x00
105 #define FMT_DATA_BITS_6 0x01
106 #define FMT_DATA_BITS_7 0x02
107 #define FMT_DATA_BITS_8 0x03
108 u8 something; /* always equals 0x43 */
109 u8 control; /* settings of flow control lines */
110 #define CONTROL_MASK 0x0c
111 #define CONTROL_DTR_HIGH 0x08
112 #define CONTROL_RTS_HIGH 0x04
113 u8 tx_status;
114 #define TX_BUFFER_EMPTIED 0x09
115 u8 pin_state;
116 #define PIN_MASK 0x3f
117 #define PIN_RTS 0x20 /* output pin */
118 #define PIN_CTS 0x10 /* input pin, active low */
119 #define PIN_DSR 0x08 /* input pin, active low */
120 #define PIN_DTR 0x04 /* output pin */
121 #define PIN_RI 0x02 /* input pin, active low */
122 #define PIN_DCD 0x01 /* input pin, active low */
123 u8 rx_bytes_avail; /* number of bytes in rx buffer */;
124 };
125
126 #define OTI6858_CTRL_PKT_SIZE sizeof(struct oti6858_control_pkt)
127 #define OTI6858_CTRL_EQUALS_PENDING(a, priv) \
128 (((a)->divisor == (priv)->pending_setup.divisor) \
129 && ((a)->control == (priv)->pending_setup.control) \
130 && ((a)->frame_fmt == (priv)->pending_setup.frame_fmt))
131
132 /* function prototypes */
133 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port);
134 static void oti6858_close(struct usb_serial_port *port);
135 static void oti6858_set_termios(struct tty_struct *tty,
136 struct usb_serial_port *port, struct ktermios *old);
137 static void oti6858_init_termios(struct tty_struct *tty);
138 static int oti6858_ioctl(struct tty_struct *tty,
139 unsigned int cmd, unsigned long arg);
140 static void oti6858_read_int_callback(struct urb *urb);
141 static void oti6858_read_bulk_callback(struct urb *urb);
142 static void oti6858_write_bulk_callback(struct urb *urb);
143 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
144 const unsigned char *buf, int count);
145 static int oti6858_write_room(struct tty_struct *tty);
146 static int oti6858_chars_in_buffer(struct tty_struct *tty);
147 static int oti6858_tiocmget(struct tty_struct *tty);
148 static int oti6858_tiocmset(struct tty_struct *tty,
149 unsigned int set, unsigned int clear);
150 static int oti6858_startup(struct usb_serial *serial);
151 static void oti6858_release(struct usb_serial *serial);
152
153 /* device info */
154 static struct usb_serial_driver oti6858_device = {
155 .driver = {
156 .owner = THIS_MODULE,
157 .name = "oti6858",
158 },
159 .id_table = id_table,
160 .usb_driver = &oti6858_driver,
161 .num_ports = 1,
162 .open = oti6858_open,
163 .close = oti6858_close,
164 .write = oti6858_write,
165 .ioctl = oti6858_ioctl,
166 .set_termios = oti6858_set_termios,
167 .init_termios = oti6858_init_termios,
168 .tiocmget = oti6858_tiocmget,
169 .tiocmset = oti6858_tiocmset,
170 .read_bulk_callback = oti6858_read_bulk_callback,
171 .read_int_callback = oti6858_read_int_callback,
172 .write_bulk_callback = oti6858_write_bulk_callback,
173 .write_room = oti6858_write_room,
174 .chars_in_buffer = oti6858_chars_in_buffer,
175 .attach = oti6858_startup,
176 .release = oti6858_release,
177 };
178
179 struct oti6858_private {
180 spinlock_t lock;
181
182 struct oti6858_control_pkt status;
183
184 struct {
185 u8 read_urb_in_use;
186 u8 write_urb_in_use;
187 } flags;
188 struct delayed_work delayed_write_work;
189
190 struct {
191 __le16 divisor;
192 u8 frame_fmt;
193 u8 control;
194 } pending_setup;
195 u8 transient;
196 u8 setup_done;
197 struct delayed_work delayed_setup_work;
198
199 wait_queue_head_t intr_wait;
200 struct usb_serial_port *port; /* USB port with which associated */
201 };
202
setup_line(struct work_struct * work)203 static void setup_line(struct work_struct *work)
204 {
205 struct oti6858_private *priv = container_of(work,
206 struct oti6858_private, delayed_setup_work.work);
207 struct usb_serial_port *port = priv->port;
208 struct oti6858_control_pkt *new_setup;
209 unsigned long flags;
210 int result;
211
212 dbg("%s(port = %d)", __func__, port->number);
213
214 new_setup = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
215 if (new_setup == NULL) {
216 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
217 /* we will try again */
218 schedule_delayed_work(&priv->delayed_setup_work,
219 msecs_to_jiffies(2));
220 return;
221 }
222
223 result = usb_control_msg(port->serial->dev,
224 usb_rcvctrlpipe(port->serial->dev, 0),
225 OTI6858_REQ_T_GET_STATUS,
226 OTI6858_REQ_GET_STATUS,
227 0, 0,
228 new_setup, OTI6858_CTRL_PKT_SIZE,
229 100);
230
231 if (result != OTI6858_CTRL_PKT_SIZE) {
232 dev_err(&port->dev, "%s(): error reading status\n", __func__);
233 kfree(new_setup);
234 /* we will try again */
235 schedule_delayed_work(&priv->delayed_setup_work,
236 msecs_to_jiffies(2));
237 return;
238 }
239
240 spin_lock_irqsave(&priv->lock, flags);
241 if (!OTI6858_CTRL_EQUALS_PENDING(new_setup, priv)) {
242 new_setup->divisor = priv->pending_setup.divisor;
243 new_setup->control = priv->pending_setup.control;
244 new_setup->frame_fmt = priv->pending_setup.frame_fmt;
245
246 spin_unlock_irqrestore(&priv->lock, flags);
247 result = usb_control_msg(port->serial->dev,
248 usb_sndctrlpipe(port->serial->dev, 0),
249 OTI6858_REQ_T_SET_LINE,
250 OTI6858_REQ_SET_LINE,
251 0, 0,
252 new_setup, OTI6858_CTRL_PKT_SIZE,
253 100);
254 } else {
255 spin_unlock_irqrestore(&priv->lock, flags);
256 result = 0;
257 }
258 kfree(new_setup);
259
260 spin_lock_irqsave(&priv->lock, flags);
261 if (result != OTI6858_CTRL_PKT_SIZE)
262 priv->transient = 0;
263 priv->setup_done = 1;
264 spin_unlock_irqrestore(&priv->lock, flags);
265
266 dbg("%s(): submitting interrupt urb", __func__);
267 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
268 if (result != 0) {
269 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
270 " with error %d\n", __func__, result);
271 }
272 }
273
send_data(struct work_struct * work)274 static void send_data(struct work_struct *work)
275 {
276 struct oti6858_private *priv = container_of(work,
277 struct oti6858_private, delayed_write_work.work);
278 struct usb_serial_port *port = priv->port;
279 int count = 0, result;
280 unsigned long flags;
281 u8 *allow;
282
283 dbg("%s(port = %d)", __func__, port->number);
284
285 spin_lock_irqsave(&priv->lock, flags);
286 if (priv->flags.write_urb_in_use) {
287 spin_unlock_irqrestore(&priv->lock, flags);
288 schedule_delayed_work(&priv->delayed_write_work,
289 msecs_to_jiffies(2));
290 return;
291 }
292 priv->flags.write_urb_in_use = 1;
293 spin_unlock_irqrestore(&priv->lock, flags);
294
295 spin_lock_irqsave(&port->lock, flags);
296 count = kfifo_len(&port->write_fifo);
297 spin_unlock_irqrestore(&port->lock, flags);
298
299 if (count > port->bulk_out_size)
300 count = port->bulk_out_size;
301
302 if (count != 0) {
303 allow = kmalloc(1, GFP_KERNEL);
304 if (!allow) {
305 dev_err(&port->dev, "%s(): kmalloc failed\n",
306 __func__);
307 return;
308 }
309 result = usb_control_msg(port->serial->dev,
310 usb_rcvctrlpipe(port->serial->dev, 0),
311 OTI6858_REQ_T_CHECK_TXBUFF,
312 OTI6858_REQ_CHECK_TXBUFF,
313 count, 0, allow, 1, 100);
314 if (result != 1 || *allow != 0)
315 count = 0;
316 kfree(allow);
317 }
318
319 if (count == 0) {
320 priv->flags.write_urb_in_use = 0;
321
322 dbg("%s(): submitting interrupt urb", __func__);
323 result = usb_submit_urb(port->interrupt_in_urb, GFP_NOIO);
324 if (result != 0) {
325 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
326 " with error %d\n", __func__, result);
327 }
328 return;
329 }
330
331 count = kfifo_out_locked(&port->write_fifo,
332 port->write_urb->transfer_buffer,
333 count, &port->lock);
334 port->write_urb->transfer_buffer_length = count;
335 result = usb_submit_urb(port->write_urb, GFP_NOIO);
336 if (result != 0) {
337 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
338 " with error %d\n", __func__, result);
339 priv->flags.write_urb_in_use = 0;
340 }
341
342 usb_serial_port_softint(port);
343 }
344
oti6858_startup(struct usb_serial * serial)345 static int oti6858_startup(struct usb_serial *serial)
346 {
347 struct usb_serial_port *port = serial->port[0];
348 struct oti6858_private *priv;
349 int i;
350
351 for (i = 0; i < serial->num_ports; ++i) {
352 priv = kzalloc(sizeof(struct oti6858_private), GFP_KERNEL);
353 if (!priv)
354 break;
355
356 spin_lock_init(&priv->lock);
357 init_waitqueue_head(&priv->intr_wait);
358 /* INIT_WORK(&priv->setup_work, setup_line, serial->port[i]); */
359 /* INIT_WORK(&priv->write_work, send_data, serial->port[i]); */
360 priv->port = port;
361 INIT_DELAYED_WORK(&priv->delayed_setup_work, setup_line);
362 INIT_DELAYED_WORK(&priv->delayed_write_work, send_data);
363
364 usb_set_serial_port_data(serial->port[i], priv);
365 }
366 if (i == serial->num_ports)
367 return 0;
368
369 for (--i; i >= 0; --i) {
370 priv = usb_get_serial_port_data(serial->port[i]);
371 kfree(priv);
372 usb_set_serial_port_data(serial->port[i], NULL);
373 }
374 return -ENOMEM;
375 }
376
oti6858_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * buf,int count)377 static int oti6858_write(struct tty_struct *tty, struct usb_serial_port *port,
378 const unsigned char *buf, int count)
379 {
380 dbg("%s(port = %d, count = %d)", __func__, port->number, count);
381
382 if (!count)
383 return count;
384
385 count = kfifo_in_locked(&port->write_fifo, buf, count, &port->lock);
386
387 return count;
388 }
389
oti6858_write_room(struct tty_struct * tty)390 static int oti6858_write_room(struct tty_struct *tty)
391 {
392 struct usb_serial_port *port = tty->driver_data;
393 int room = 0;
394 unsigned long flags;
395
396 dbg("%s(port = %d)", __func__, port->number);
397
398 spin_lock_irqsave(&port->lock, flags);
399 room = kfifo_avail(&port->write_fifo);
400 spin_unlock_irqrestore(&port->lock, flags);
401
402 return room;
403 }
404
oti6858_chars_in_buffer(struct tty_struct * tty)405 static int oti6858_chars_in_buffer(struct tty_struct *tty)
406 {
407 struct usb_serial_port *port = tty->driver_data;
408 int chars = 0;
409 unsigned long flags;
410
411 dbg("%s(port = %d)", __func__, port->number);
412
413 spin_lock_irqsave(&port->lock, flags);
414 chars = kfifo_len(&port->write_fifo);
415 spin_unlock_irqrestore(&port->lock, flags);
416
417 return chars;
418 }
419
oti6858_init_termios(struct tty_struct * tty)420 static void oti6858_init_termios(struct tty_struct *tty)
421 {
422 *(tty->termios) = tty_std_termios;
423 tty->termios->c_cflag = B38400 | CS8 | CREAD | HUPCL | CLOCAL;
424 tty->termios->c_ispeed = 38400;
425 tty->termios->c_ospeed = 38400;
426 }
427
oti6858_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)428 static void oti6858_set_termios(struct tty_struct *tty,
429 struct usb_serial_port *port, struct ktermios *old_termios)
430 {
431 struct oti6858_private *priv = usb_get_serial_port_data(port);
432 unsigned long flags;
433 unsigned int cflag;
434 u8 frame_fmt, control;
435 __le16 divisor;
436 int br;
437
438 dbg("%s(port = %d)", __func__, port->number);
439
440 if (!tty) {
441 dbg("%s(): no tty structures", __func__);
442 return;
443 }
444
445 cflag = tty->termios->c_cflag;
446
447 spin_lock_irqsave(&priv->lock, flags);
448 divisor = priv->pending_setup.divisor;
449 frame_fmt = priv->pending_setup.frame_fmt;
450 control = priv->pending_setup.control;
451 spin_unlock_irqrestore(&priv->lock, flags);
452
453 frame_fmt &= ~FMT_DATA_BITS_MASK;
454 switch (cflag & CSIZE) {
455 case CS5:
456 frame_fmt |= FMT_DATA_BITS_5;
457 break;
458 case CS6:
459 frame_fmt |= FMT_DATA_BITS_6;
460 break;
461 case CS7:
462 frame_fmt |= FMT_DATA_BITS_7;
463 break;
464 default:
465 case CS8:
466 frame_fmt |= FMT_DATA_BITS_8;
467 break;
468 }
469
470 /* manufacturer claims that this device can work with baud rates
471 * up to 3 Mbps; I've tested it only on 115200 bps, so I can't
472 * guarantee that any other baud rate will work (especially
473 * the higher ones)
474 */
475 br = tty_get_baud_rate(tty);
476 if (br == 0) {
477 divisor = 0;
478 } else {
479 int real_br;
480 int new_divisor;
481 br = min(br, OTI6858_MAX_BAUD_RATE);
482
483 new_divisor = (96000000 + 8 * br) / (16 * br);
484 real_br = 96000000 / (16 * new_divisor);
485 divisor = cpu_to_le16(new_divisor);
486 tty_encode_baud_rate(tty, real_br, real_br);
487 }
488
489 frame_fmt &= ~FMT_STOP_BITS_MASK;
490 if ((cflag & CSTOPB) != 0)
491 frame_fmt |= FMT_STOP_BITS_2;
492 else
493 frame_fmt |= FMT_STOP_BITS_1;
494
495 frame_fmt &= ~FMT_PARITY_MASK;
496 if ((cflag & PARENB) != 0) {
497 if ((cflag & PARODD) != 0)
498 frame_fmt |= FMT_PARITY_ODD;
499 else
500 frame_fmt |= FMT_PARITY_EVEN;
501 } else {
502 frame_fmt |= FMT_PARITY_NONE;
503 }
504
505 control &= ~CONTROL_MASK;
506 if ((cflag & CRTSCTS) != 0)
507 control |= (CONTROL_DTR_HIGH | CONTROL_RTS_HIGH);
508
509 /* change control lines if we are switching to or from B0 */
510 /* FIXME:
511 spin_lock_irqsave(&priv->lock, flags);
512 control = priv->line_control;
513 if ((cflag & CBAUD) == B0)
514 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
515 else
516 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
517 if (control != priv->line_control) {
518 control = priv->line_control;
519 spin_unlock_irqrestore(&priv->lock, flags);
520 set_control_lines(serial->dev, control);
521 } else {
522 spin_unlock_irqrestore(&priv->lock, flags);
523 }
524 */
525
526 spin_lock_irqsave(&priv->lock, flags);
527 if (divisor != priv->pending_setup.divisor
528 || control != priv->pending_setup.control
529 || frame_fmt != priv->pending_setup.frame_fmt) {
530 priv->pending_setup.divisor = divisor;
531 priv->pending_setup.control = control;
532 priv->pending_setup.frame_fmt = frame_fmt;
533 }
534 spin_unlock_irqrestore(&priv->lock, flags);
535 }
536
oti6858_open(struct tty_struct * tty,struct usb_serial_port * port)537 static int oti6858_open(struct tty_struct *tty, struct usb_serial_port *port)
538 {
539 struct oti6858_private *priv = usb_get_serial_port_data(port);
540 struct ktermios tmp_termios;
541 struct usb_serial *serial = port->serial;
542 struct oti6858_control_pkt *buf;
543 unsigned long flags;
544 int result;
545
546 dbg("%s(port = %d)", __func__, port->number);
547
548 usb_clear_halt(serial->dev, port->write_urb->pipe);
549 usb_clear_halt(serial->dev, port->read_urb->pipe);
550
551 buf = kmalloc(OTI6858_CTRL_PKT_SIZE, GFP_KERNEL);
552 if (buf == NULL) {
553 dev_err(&port->dev, "%s(): out of memory!\n", __func__);
554 return -ENOMEM;
555 }
556
557 result = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
558 OTI6858_REQ_T_GET_STATUS,
559 OTI6858_REQ_GET_STATUS,
560 0, 0,
561 buf, OTI6858_CTRL_PKT_SIZE,
562 100);
563 if (result != OTI6858_CTRL_PKT_SIZE) {
564 /* assume default (after power-on reset) values */
565 buf->divisor = cpu_to_le16(0x009c); /* 38400 bps */
566 buf->frame_fmt = 0x03; /* 8N1 */
567 buf->something = 0x43;
568 buf->control = 0x4c; /* DTR, RTS */
569 buf->tx_status = 0x00;
570 buf->pin_state = 0x5b; /* RTS, CTS, DSR, DTR, RI, DCD */
571 buf->rx_bytes_avail = 0x00;
572 }
573
574 spin_lock_irqsave(&priv->lock, flags);
575 memcpy(&priv->status, buf, OTI6858_CTRL_PKT_SIZE);
576 priv->pending_setup.divisor = buf->divisor;
577 priv->pending_setup.frame_fmt = buf->frame_fmt;
578 priv->pending_setup.control = buf->control;
579 spin_unlock_irqrestore(&priv->lock, flags);
580 kfree(buf);
581
582 dbg("%s(): submitting interrupt urb", __func__);
583 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
584 if (result != 0) {
585 dev_err(&port->dev, "%s(): usb_submit_urb() failed"
586 " with error %d\n", __func__, result);
587 oti6858_close(port);
588 return result;
589 }
590
591 /* setup termios */
592 if (tty)
593 oti6858_set_termios(tty, port, &tmp_termios);
594 port->port.drain_delay = 256; /* FIXME: check the FIFO length */
595 return 0;
596 }
597
oti6858_close(struct usb_serial_port * port)598 static void oti6858_close(struct usb_serial_port *port)
599 {
600 struct oti6858_private *priv = usb_get_serial_port_data(port);
601 unsigned long flags;
602
603 dbg("%s(port = %d)", __func__, port->number);
604
605 spin_lock_irqsave(&port->lock, flags);
606 /* clear out any remaining data in the buffer */
607 kfifo_reset_out(&port->write_fifo);
608 spin_unlock_irqrestore(&port->lock, flags);
609
610 dbg("%s(): after buf_clear()", __func__);
611
612 /* cancel scheduled setup */
613 cancel_delayed_work_sync(&priv->delayed_setup_work);
614 cancel_delayed_work_sync(&priv->delayed_write_work);
615
616 /* shutdown our urbs */
617 dbg("%s(): shutting down urbs", __func__);
618 usb_kill_urb(port->write_urb);
619 usb_kill_urb(port->read_urb);
620 usb_kill_urb(port->interrupt_in_urb);
621 }
622
oti6858_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)623 static int oti6858_tiocmset(struct tty_struct *tty,
624 unsigned int set, unsigned int clear)
625 {
626 struct usb_serial_port *port = tty->driver_data;
627 struct oti6858_private *priv = usb_get_serial_port_data(port);
628 unsigned long flags;
629 u8 control;
630
631 dbg("%s(port = %d, set = 0x%08x, clear = 0x%08x)",
632 __func__, port->number, set, clear);
633
634 if (!usb_get_intfdata(port->serial->interface))
635 return -ENODEV;
636
637 /* FIXME: check if this is correct (active high/low) */
638 spin_lock_irqsave(&priv->lock, flags);
639 control = priv->pending_setup.control;
640 if ((set & TIOCM_RTS) != 0)
641 control |= CONTROL_RTS_HIGH;
642 if ((set & TIOCM_DTR) != 0)
643 control |= CONTROL_DTR_HIGH;
644 if ((clear & TIOCM_RTS) != 0)
645 control &= ~CONTROL_RTS_HIGH;
646 if ((clear & TIOCM_DTR) != 0)
647 control &= ~CONTROL_DTR_HIGH;
648
649 if (control != priv->pending_setup.control)
650 priv->pending_setup.control = control;
651
652 spin_unlock_irqrestore(&priv->lock, flags);
653 return 0;
654 }
655
oti6858_tiocmget(struct tty_struct * tty)656 static int oti6858_tiocmget(struct tty_struct *tty)
657 {
658 struct usb_serial_port *port = tty->driver_data;
659 struct oti6858_private *priv = usb_get_serial_port_data(port);
660 unsigned long flags;
661 unsigned pin_state;
662 unsigned result = 0;
663
664 dbg("%s(port = %d)", __func__, port->number);
665
666 if (!usb_get_intfdata(port->serial->interface))
667 return -ENODEV;
668
669 spin_lock_irqsave(&priv->lock, flags);
670 pin_state = priv->status.pin_state & PIN_MASK;
671 spin_unlock_irqrestore(&priv->lock, flags);
672
673 /* FIXME: check if this is correct (active high/low) */
674 if ((pin_state & PIN_RTS) != 0)
675 result |= TIOCM_RTS;
676 if ((pin_state & PIN_CTS) != 0)
677 result |= TIOCM_CTS;
678 if ((pin_state & PIN_DSR) != 0)
679 result |= TIOCM_DSR;
680 if ((pin_state & PIN_DTR) != 0)
681 result |= TIOCM_DTR;
682 if ((pin_state & PIN_RI) != 0)
683 result |= TIOCM_RI;
684 if ((pin_state & PIN_DCD) != 0)
685 result |= TIOCM_CD;
686
687 dbg("%s() = 0x%08x", __func__, result);
688
689 return result;
690 }
691
wait_modem_info(struct usb_serial_port * port,unsigned int arg)692 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
693 {
694 struct oti6858_private *priv = usb_get_serial_port_data(port);
695 unsigned long flags;
696 unsigned int prev, status;
697 unsigned int changed;
698
699 spin_lock_irqsave(&priv->lock, flags);
700 prev = priv->status.pin_state;
701 spin_unlock_irqrestore(&priv->lock, flags);
702
703 while (1) {
704 wait_event_interruptible(priv->intr_wait,
705 priv->status.pin_state != prev);
706 if (signal_pending(current))
707 return -ERESTARTSYS;
708
709 spin_lock_irqsave(&priv->lock, flags);
710 status = priv->status.pin_state & PIN_MASK;
711 spin_unlock_irqrestore(&priv->lock, flags);
712
713 changed = prev ^ status;
714 /* FIXME: check if this is correct (active high/low) */
715 if (((arg & TIOCM_RNG) && (changed & PIN_RI)) ||
716 ((arg & TIOCM_DSR) && (changed & PIN_DSR)) ||
717 ((arg & TIOCM_CD) && (changed & PIN_DCD)) ||
718 ((arg & TIOCM_CTS) && (changed & PIN_CTS)))
719 return 0;
720 prev = status;
721 }
722
723 /* NOTREACHED */
724 return 0;
725 }
726
oti6858_ioctl(struct tty_struct * tty,unsigned int cmd,unsigned long arg)727 static int oti6858_ioctl(struct tty_struct *tty,
728 unsigned int cmd, unsigned long arg)
729 {
730 struct usb_serial_port *port = tty->driver_data;
731
732 dbg("%s(port = %d, cmd = 0x%04x, arg = 0x%08lx)",
733 __func__, port->number, cmd, arg);
734
735 switch (cmd) {
736 case TIOCMIWAIT:
737 dbg("%s(): TIOCMIWAIT", __func__);
738 return wait_modem_info(port, arg);
739 default:
740 dbg("%s(): 0x%04x not supported", __func__, cmd);
741 break;
742 }
743 return -ENOIOCTLCMD;
744 }
745
746
oti6858_release(struct usb_serial * serial)747 static void oti6858_release(struct usb_serial *serial)
748 {
749 int i;
750
751 dbg("%s()", __func__);
752
753 for (i = 0; i < serial->num_ports; ++i)
754 kfree(usb_get_serial_port_data(serial->port[i]));
755 }
756
oti6858_read_int_callback(struct urb * urb)757 static void oti6858_read_int_callback(struct urb *urb)
758 {
759 struct usb_serial_port *port = urb->context;
760 struct oti6858_private *priv = usb_get_serial_port_data(port);
761 int transient = 0, can_recv = 0, resubmit = 1;
762 int status = urb->status;
763
764 dbg("%s(port = %d, status = %d)",
765 __func__, port->number, status);
766
767 switch (status) {
768 case 0:
769 /* success */
770 break;
771 case -ECONNRESET:
772 case -ENOENT:
773 case -ESHUTDOWN:
774 /* this urb is terminated, clean up */
775 dbg("%s(): urb shutting down with status: %d",
776 __func__, status);
777 return;
778 default:
779 dbg("%s(): nonzero urb status received: %d",
780 __func__, status);
781 break;
782 }
783
784 if (status == 0 && urb->actual_length == OTI6858_CTRL_PKT_SIZE) {
785 struct oti6858_control_pkt *xs = urb->transfer_buffer;
786 unsigned long flags;
787
788 spin_lock_irqsave(&priv->lock, flags);
789
790 if (!priv->transient) {
791 if (!OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
792 if (xs->rx_bytes_avail == 0) {
793 priv->transient = 4;
794 priv->setup_done = 0;
795 resubmit = 0;
796 dbg("%s(): scheduling setup_line()",
797 __func__);
798 schedule_delayed_work(&priv->delayed_setup_work, 0);
799 }
800 }
801 } else {
802 if (OTI6858_CTRL_EQUALS_PENDING(xs, priv)) {
803 priv->transient = 0;
804 } else if (!priv->setup_done) {
805 resubmit = 0;
806 } else if (--priv->transient == 0) {
807 if (xs->rx_bytes_avail == 0) {
808 priv->transient = 4;
809 priv->setup_done = 0;
810 resubmit = 0;
811 dbg("%s(): scheduling setup_line()",
812 __func__);
813 schedule_delayed_work(&priv->delayed_setup_work, 0);
814 }
815 }
816 }
817
818 if (!priv->transient) {
819 if (xs->pin_state != priv->status.pin_state)
820 wake_up_interruptible(&priv->intr_wait);
821 memcpy(&priv->status, xs, OTI6858_CTRL_PKT_SIZE);
822 }
823
824 if (!priv->transient && xs->rx_bytes_avail != 0) {
825 can_recv = xs->rx_bytes_avail;
826 priv->flags.read_urb_in_use = 1;
827 }
828
829 transient = priv->transient;
830 spin_unlock_irqrestore(&priv->lock, flags);
831 }
832
833 if (can_recv) {
834 int result;
835
836 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
837 if (result != 0) {
838 priv->flags.read_urb_in_use = 0;
839 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
840 " error %d\n", __func__, result);
841 } else {
842 resubmit = 0;
843 }
844 } else if (!transient) {
845 unsigned long flags;
846 int count;
847
848 spin_lock_irqsave(&port->lock, flags);
849 count = kfifo_len(&port->write_fifo);
850 spin_unlock_irqrestore(&port->lock, flags);
851
852 spin_lock_irqsave(&priv->lock, flags);
853 if (priv->flags.write_urb_in_use == 0 && count != 0) {
854 schedule_delayed_work(&priv->delayed_write_work, 0);
855 resubmit = 0;
856 }
857 spin_unlock_irqrestore(&priv->lock, flags);
858 }
859
860 if (resubmit) {
861 int result;
862
863 /* dbg("%s(): submitting interrupt urb", __func__); */
864 result = usb_submit_urb(urb, GFP_ATOMIC);
865 if (result != 0) {
866 dev_err(&urb->dev->dev,
867 "%s(): usb_submit_urb() failed with"
868 " error %d\n", __func__, result);
869 }
870 }
871 }
872
oti6858_read_bulk_callback(struct urb * urb)873 static void oti6858_read_bulk_callback(struct urb *urb)
874 {
875 struct usb_serial_port *port = urb->context;
876 struct oti6858_private *priv = usb_get_serial_port_data(port);
877 struct tty_struct *tty;
878 unsigned char *data = urb->transfer_buffer;
879 unsigned long flags;
880 int status = urb->status;
881 int result;
882
883 dbg("%s(port = %d, status = %d)",
884 __func__, port->number, status);
885
886 spin_lock_irqsave(&priv->lock, flags);
887 priv->flags.read_urb_in_use = 0;
888 spin_unlock_irqrestore(&priv->lock, flags);
889
890 if (status != 0) {
891 dbg("%s(): unable to handle the error, exiting", __func__);
892 return;
893 }
894
895 tty = tty_port_tty_get(&port->port);
896 if (tty != NULL && urb->actual_length > 0) {
897 tty_insert_flip_string(tty, data, urb->actual_length);
898 tty_flip_buffer_push(tty);
899 }
900 tty_kref_put(tty);
901
902 /* schedule the interrupt urb */
903 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
904 if (result != 0 && result != -EPERM) {
905 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
906 " error %d\n", __func__, result);
907 }
908 }
909
oti6858_write_bulk_callback(struct urb * urb)910 static void oti6858_write_bulk_callback(struct urb *urb)
911 {
912 struct usb_serial_port *port = urb->context;
913 struct oti6858_private *priv = usb_get_serial_port_data(port);
914 int status = urb->status;
915 int result;
916
917 dbg("%s(port = %d, status = %d)",
918 __func__, port->number, status);
919
920 switch (status) {
921 case 0:
922 /* success */
923 break;
924 case -ECONNRESET:
925 case -ENOENT:
926 case -ESHUTDOWN:
927 /* this urb is terminated, clean up */
928 dbg("%s(): urb shutting down with status: %d",
929 __func__, status);
930 priv->flags.write_urb_in_use = 0;
931 return;
932 default:
933 /* error in the urb, so we have to resubmit it */
934 dbg("%s(): nonzero write bulk status received: %d",
935 __func__, status);
936 dbg("%s(): overflow in write", __func__);
937
938 port->write_urb->transfer_buffer_length = 1;
939 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
940 if (result) {
941 dev_err(&port->dev, "%s(): usb_submit_urb() failed,"
942 " error %d\n", __func__, result);
943 } else {
944 return;
945 }
946 }
947
948 priv->flags.write_urb_in_use = 0;
949
950 /* schedule the interrupt urb if we are still open */
951 dbg("%s(): submitting interrupt urb", __func__);
952 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
953 if (result != 0) {
954 dev_err(&port->dev, "%s(): failed submitting int urb,"
955 " error %d\n", __func__, result);
956 }
957 }
958
959 /* module description and (de)initialization */
960
oti6858_init(void)961 static int __init oti6858_init(void)
962 {
963 int retval;
964
965 retval = usb_serial_register(&oti6858_device);
966 if (retval == 0) {
967 retval = usb_register(&oti6858_driver);
968 if (retval)
969 usb_serial_deregister(&oti6858_device);
970 }
971 return retval;
972 }
973
oti6858_exit(void)974 static void __exit oti6858_exit(void)
975 {
976 usb_deregister(&oti6858_driver);
977 usb_serial_deregister(&oti6858_device);
978 }
979
980 module_init(oti6858_init);
981 module_exit(oti6858_exit);
982
983 MODULE_DESCRIPTION(OTI6858_DESCRIPTION);
984 MODULE_AUTHOR(OTI6858_AUTHOR);
985 MODULE_VERSION(OTI6858_VERSION);
986 MODULE_LICENSE("GPL");
987
988 module_param(debug, bool, S_IRUGO | S_IWUSR);
989 MODULE_PARM_DESC(debug, "enable debug output");
990
991