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