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