2 * USB Cypress M8 driver
5 * Lonnie Mendez (dignome@gmail.com)
6 * Copyright (C) 2003,2004
7 * Neil Whelchel (koyama@firstlight.net)
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * See Documentation/usb/usb-serial.txt for more information on using this
17 * See http://geocities.com/i0xox0i for information on this driver and the
18 * earthmate usb device.
21 /* Thanks to Neil Whelchel for writing the first cypress m8 implementation
23 /* Thanks to cypress for providing references for the hid reports. */
24 /* Thanks to Jiang Zhang for providing links and for general help. */
25 /* Code originates and was built up from ftdi_sio, belkin, pl2303 and others.*/
28 #include <linux/kernel.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/slab.h>
32 #include <linux/tty.h>
33 #include <linux/tty_driver.h>
34 #include <linux/tty_flip.h>
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/spinlock.h>
38 #include <linux/usb.h>
39 #include <linux/usb/serial.h>
40 #include <linux/serial.h>
41 #include <linux/kfifo.h>
42 #include <linux/delay.h>
43 #include <linux/uaccess.h>
44 #include <asm/unaligned.h>
46 #include "cypress_m8.h"
51 static bool unstable_bauds;
53 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
54 #define DRIVER_DESC "Cypress USB to Serial Driver"
56 /* write buffer size defines */
57 #define CYPRESS_BUF_SIZE 1024
59 static const struct usb_device_id id_table_earthmate[] = {
60 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
61 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
62 { } /* Terminating entry */
65 static const struct usb_device_id id_table_cyphidcomrs232[] = {
66 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
67 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
68 { } /* Terminating entry */
71 static const struct usb_device_id id_table_nokiaca42v2[] = {
72 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
73 { } /* Terminating entry */
76 static const struct usb_device_id id_table_combined[] = {
77 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
78 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
79 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
80 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
81 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
82 { } /* Terminating entry */
85 MODULE_DEVICE_TABLE(usb, id_table_combined);
88 packet_format_1, /* b0:status, b1:payload count */
89 packet_format_2 /* b0[7:3]:status, b0[2:0]:payload count */
92 struct cypress_private {
93 spinlock_t lock; /* private lock */
94 int chiptype; /* identifier of device, for quirks/etc */
95 int bytes_in; /* used for statistics */
96 int bytes_out; /* used for statistics */
97 int cmd_count; /* used for statistics */
98 int cmd_ctrl; /* always set this to 1 before issuing a command */
99 struct kfifo write_fifo; /* write fifo */
100 int write_urb_in_use; /* write urb in use indicator */
101 int write_urb_interval; /* interval to use for write urb */
102 int read_urb_interval; /* interval to use for read urb */
103 int comm_is_ok; /* true if communication is (still) ok */
104 int termios_initialized;
105 __u8 line_control; /* holds dtr / rts value */
106 __u8 current_status; /* received from last read - info on dsr,cts,cd,ri,etc */
107 __u8 current_config; /* stores the current configuration byte */
108 __u8 rx_flags; /* throttling - used from whiteheat/ftdi_sio */
109 enum packet_format pkt_fmt; /* format to use for packet send / receive */
110 int get_cfg_unsafe; /* If true, the CYPRESS_GET_CONFIG is unsafe */
111 int baud_rate; /* stores current baud rate in
113 int isthrottled; /* if throttled, discard reads */
114 char prev_status, diff_status; /* used for TIOCMIWAIT */
115 /* we pass a pointer to this as the argument sent to
116 cypress_set_termios old_termios */
117 struct ktermios tmp_termios; /* stores the old termios settings */
120 /* function prototypes for the Cypress USB to serial device */
121 static int cypress_earthmate_port_probe(struct usb_serial_port *port);
122 static int cypress_hidcom_port_probe(struct usb_serial_port *port);
123 static int cypress_ca42v2_port_probe(struct usb_serial_port *port);
124 static int cypress_port_remove(struct usb_serial_port *port);
125 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port);
126 static void cypress_close(struct usb_serial_port *port);
127 static void cypress_dtr_rts(struct usb_serial_port *port, int on);
128 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
129 const unsigned char *buf, int count);
130 static void cypress_send(struct usb_serial_port *port);
131 static int cypress_write_room(struct tty_struct *tty);
132 static void cypress_set_termios(struct tty_struct *tty,
133 struct usb_serial_port *port, struct ktermios *old);
134 static int cypress_tiocmget(struct tty_struct *tty);
135 static int cypress_tiocmset(struct tty_struct *tty,
136 unsigned int set, unsigned int clear);
137 static int cypress_tiocmiwait(struct tty_struct *tty, unsigned long arg);
138 static int cypress_chars_in_buffer(struct tty_struct *tty);
139 static void cypress_throttle(struct tty_struct *tty);
140 static void cypress_unthrottle(struct tty_struct *tty);
141 static void cypress_set_dead(struct usb_serial_port *port);
142 static void cypress_read_int_callback(struct urb *urb);
143 static void cypress_write_int_callback(struct urb *urb);
145 static struct usb_serial_driver cypress_earthmate_device = {
147 .owner = THIS_MODULE,
150 .description = "DeLorme Earthmate USB",
151 .id_table = id_table_earthmate,
153 .port_probe = cypress_earthmate_port_probe,
154 .port_remove = cypress_port_remove,
155 .open = cypress_open,
156 .close = cypress_close,
157 .dtr_rts = cypress_dtr_rts,
158 .write = cypress_write,
159 .write_room = cypress_write_room,
160 .set_termios = cypress_set_termios,
161 .tiocmget = cypress_tiocmget,
162 .tiocmset = cypress_tiocmset,
163 .tiocmiwait = cypress_tiocmiwait,
164 .chars_in_buffer = cypress_chars_in_buffer,
165 .throttle = cypress_throttle,
166 .unthrottle = cypress_unthrottle,
167 .read_int_callback = cypress_read_int_callback,
168 .write_int_callback = cypress_write_int_callback,
171 static struct usb_serial_driver cypress_hidcom_device = {
173 .owner = THIS_MODULE,
176 .description = "HID->COM RS232 Adapter",
177 .id_table = id_table_cyphidcomrs232,
179 .port_probe = cypress_hidcom_port_probe,
180 .port_remove = cypress_port_remove,
181 .open = cypress_open,
182 .close = cypress_close,
183 .dtr_rts = cypress_dtr_rts,
184 .write = cypress_write,
185 .write_room = cypress_write_room,
186 .set_termios = cypress_set_termios,
187 .tiocmget = cypress_tiocmget,
188 .tiocmset = cypress_tiocmset,
189 .tiocmiwait = cypress_tiocmiwait,
190 .chars_in_buffer = cypress_chars_in_buffer,
191 .throttle = cypress_throttle,
192 .unthrottle = cypress_unthrottle,
193 .read_int_callback = cypress_read_int_callback,
194 .write_int_callback = cypress_write_int_callback,
197 static struct usb_serial_driver cypress_ca42v2_device = {
199 .owner = THIS_MODULE,
200 .name = "nokiaca42v2",
202 .description = "Nokia CA-42 V2 Adapter",
203 .id_table = id_table_nokiaca42v2,
205 .port_probe = cypress_ca42v2_port_probe,
206 .port_remove = cypress_port_remove,
207 .open = cypress_open,
208 .close = cypress_close,
209 .dtr_rts = cypress_dtr_rts,
210 .write = cypress_write,
211 .write_room = cypress_write_room,
212 .set_termios = cypress_set_termios,
213 .tiocmget = cypress_tiocmget,
214 .tiocmset = cypress_tiocmset,
215 .tiocmiwait = cypress_tiocmiwait,
216 .chars_in_buffer = cypress_chars_in_buffer,
217 .throttle = cypress_throttle,
218 .unthrottle = cypress_unthrottle,
219 .read_int_callback = cypress_read_int_callback,
220 .write_int_callback = cypress_write_int_callback,
223 static struct usb_serial_driver * const serial_drivers[] = {
224 &cypress_earthmate_device, &cypress_hidcom_device,
225 &cypress_ca42v2_device, NULL
228 /*****************************************************************************
229 * Cypress serial helper functions
230 *****************************************************************************/
233 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
235 struct cypress_private *priv;
236 priv = usb_get_serial_port_data(port);
242 * The general purpose firmware for the Cypress M8 allows for
243 * a maximum speed of 57600bps (I have no idea whether DeLorme
244 * chose to use the general purpose firmware or not), if you
245 * need to modify this speed setting for your own project
246 * please add your own chiptype and modify the code likewise.
247 * The Cypress HID->COM device will work successfully up to
248 * 115200bps (but the actual throughput is around 3kBps).
250 if (port->serial->dev->speed == USB_SPEED_LOW) {
252 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
253 * Cypress app note that describes this mechanism
254 * states the the low-speed part can't handle more
255 * than 800 bytes/sec, in which case 4800 baud is the
256 * safest speed for a part like that.
258 if (new_rate > 4800) {
260 "%s - failed setting baud rate, device incapable speed %d\n",
265 switch (priv->chiptype) {
267 if (new_rate <= 600) {
268 /* 300 and 600 baud rates are supported under
269 * the generic firmware, but are not used with
270 * NMEA and SiRF protocols */
272 "%s - failed setting baud rate, unsupported speed of %d on Earthmate GPS",
284 /* This function can either set or retrieve the current serial line settings */
285 static int cypress_serial_control(struct tty_struct *tty,
286 struct usb_serial_port *port, speed_t baud_rate, int data_bits,
287 int stop_bits, int parity_enable, int parity_type, int reset,
288 int cypress_request_type)
290 int new_baudrate = 0, retval = 0, tries = 0;
291 struct cypress_private *priv;
292 struct device *dev = &port->dev;
294 const unsigned int feature_len = 5;
297 priv = usb_get_serial_port_data(port);
299 if (!priv->comm_is_ok)
302 feature_buffer = kcalloc(feature_len, sizeof(u8), GFP_KERNEL);
306 switch (cypress_request_type) {
307 case CYPRESS_SET_CONFIG:
308 /* 0 means 'Hang up' so doesn't change the true bit rate */
309 new_baudrate = priv->baud_rate;
310 if (baud_rate && baud_rate != priv->baud_rate) {
311 dev_dbg(dev, "%s - baud rate is changing\n", __func__);
312 retval = analyze_baud_rate(port, baud_rate);
314 new_baudrate = retval;
315 dev_dbg(dev, "%s - New baud rate set to %d\n",
316 __func__, new_baudrate);
319 dev_dbg(dev, "%s - baud rate is being sent as %d\n", __func__,
322 /* fill the feature_buffer with new configuration */
323 put_unaligned_le32(new_baudrate, feature_buffer);
324 feature_buffer[4] |= data_bits; /* assign data bits in 2 bit space ( max 3 ) */
326 feature_buffer[4] |= (stop_bits << 3); /* assign stop bits in 1 bit space */
327 feature_buffer[4] |= (parity_enable << 4); /* assign parity flag in 1 bit space */
328 feature_buffer[4] |= (parity_type << 5); /* assign parity type in 1 bit space */
330 feature_buffer[4] |= (reset << 7); /* assign reset at end of byte, 1 bit space */
332 dev_dbg(dev, "%s - device is being sent this feature report:\n", __func__);
333 dev_dbg(dev, "%s - %02X - %02X - %02X - %02X - %02X\n", __func__,
334 feature_buffer[0], feature_buffer[1],
335 feature_buffer[2], feature_buffer[3],
339 retval = usb_control_msg(port->serial->dev,
340 usb_sndctrlpipe(port->serial->dev, 0),
342 USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
343 0x0300, 0, feature_buffer,
349 } while (retval != feature_len &&
352 if (retval != feature_len) {
353 dev_err(dev, "%s - failed sending serial line settings - %d\n",
355 cypress_set_dead(port);
357 spin_lock_irqsave(&priv->lock, flags);
358 priv->baud_rate = new_baudrate;
359 priv->current_config = feature_buffer[4];
360 spin_unlock_irqrestore(&priv->lock, flags);
361 /* If we asked for a speed change encode it */
363 tty_encode_baud_rate(tty,
364 new_baudrate, new_baudrate);
367 case CYPRESS_GET_CONFIG:
368 if (priv->get_cfg_unsafe) {
369 /* Not implemented for this device,
370 and if we try to do it we're likely
371 to crash the hardware. */
375 dev_dbg(dev, "%s - retreiving serial line settings\n", __func__);
377 retval = usb_control_msg(port->serial->dev,
378 usb_rcvctrlpipe(port->serial->dev, 0),
380 USB_DIR_IN | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
381 0x0300, 0, feature_buffer,
386 } while (retval != feature_len
387 && retval != -ENODEV);
389 if (retval != feature_len) {
390 dev_err(dev, "%s - failed to retrieve serial line settings - %d\n",
392 cypress_set_dead(port);
395 spin_lock_irqsave(&priv->lock, flags);
396 /* store the config in one byte, and later
397 use bit masks to check values */
398 priv->current_config = feature_buffer[4];
399 priv->baud_rate = get_unaligned_le32(feature_buffer);
400 spin_unlock_irqrestore(&priv->lock, flags);
403 spin_lock_irqsave(&priv->lock, flags);
405 spin_unlock_irqrestore(&priv->lock, flags);
407 kfree(feature_buffer);
409 } /* cypress_serial_control */
412 static void cypress_set_dead(struct usb_serial_port *port)
414 struct cypress_private *priv = usb_get_serial_port_data(port);
417 spin_lock_irqsave(&priv->lock, flags);
418 if (!priv->comm_is_ok) {
419 spin_unlock_irqrestore(&priv->lock, flags);
422 priv->comm_is_ok = 0;
423 spin_unlock_irqrestore(&priv->lock, flags);
425 dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
426 "interval might be too short\n", port->number);
430 /*****************************************************************************
431 * Cypress serial driver functions
432 *****************************************************************************/
435 static int cypress_generic_port_probe(struct usb_serial_port *port)
437 struct usb_serial *serial = port->serial;
438 struct cypress_private *priv;
440 priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
444 priv->comm_is_ok = !0;
445 spin_lock_init(&priv->lock);
446 if (kfifo_alloc(&priv->write_fifo, CYPRESS_BUF_SIZE, GFP_KERNEL)) {
451 usb_reset_configuration(serial->dev);
454 priv->line_control = 0;
455 priv->termios_initialized = 0;
457 /* Default packet format setting is determined by packet size.
458 Anything with a size larger then 9 must have a separate
459 count field since the 3 bit count field is otherwise too
460 small. Otherwise we can use the slightly more compact
461 format. This is in accordance with the cypress_m8 serial
462 converter app note. */
463 if (port->interrupt_out_size > 9)
464 priv->pkt_fmt = packet_format_1;
466 priv->pkt_fmt = packet_format_2;
469 priv->write_urb_interval = interval;
470 priv->read_urb_interval = interval;
471 dev_dbg(&port->dev, "%s - read & write intervals forced to %d\n",
474 priv->write_urb_interval = port->interrupt_out_urb->interval;
475 priv->read_urb_interval = port->interrupt_in_urb->interval;
476 dev_dbg(&port->dev, "%s - intervals: read=%d write=%d\n",
477 __func__, priv->read_urb_interval,
478 priv->write_urb_interval);
480 usb_set_serial_port_data(port, priv);
486 static int cypress_earthmate_port_probe(struct usb_serial_port *port)
488 struct usb_serial *serial = port->serial;
489 struct cypress_private *priv;
492 ret = cypress_generic_port_probe(port);
494 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
498 priv = usb_get_serial_port_data(port);
499 priv->chiptype = CT_EARTHMATE;
500 /* All Earthmate devices use the separated-count packet
502 priv->pkt_fmt = packet_format_1;
503 if (serial->dev->descriptor.idProduct !=
504 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB)) {
505 /* The old original USB Earthmate seemed able to
506 handle GET_CONFIG requests; everything they've
507 produced since that time crashes if this command is
510 "%s - Marking this device as unsafe for GET_CONFIG commands\n",
512 priv->get_cfg_unsafe = !0;
518 static int cypress_hidcom_port_probe(struct usb_serial_port *port)
520 struct cypress_private *priv;
523 ret = cypress_generic_port_probe(port);
525 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
529 priv = usb_get_serial_port_data(port);
530 priv->chiptype = CT_CYPHIDCOM;
535 static int cypress_ca42v2_port_probe(struct usb_serial_port *port)
537 struct cypress_private *priv;
540 ret = cypress_generic_port_probe(port);
542 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
546 priv = usb_get_serial_port_data(port);
547 priv->chiptype = CT_CA42V2;
552 static int cypress_port_remove(struct usb_serial_port *port)
554 struct cypress_private *priv;
556 priv = usb_get_serial_port_data(port);
558 kfifo_free(&priv->write_fifo);
564 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port)
566 struct cypress_private *priv = usb_get_serial_port_data(port);
567 struct usb_serial *serial = port->serial;
571 if (!priv->comm_is_ok)
574 /* clear halts before open */
575 usb_clear_halt(serial->dev, 0x81);
576 usb_clear_halt(serial->dev, 0x02);
578 spin_lock_irqsave(&priv->lock, flags);
579 /* reset read/write statistics */
584 spin_unlock_irqrestore(&priv->lock, flags);
590 cypress_set_termios(tty, port, &priv->tmp_termios);
592 /* setup the port and start reading from the device */
593 if (!port->interrupt_in_urb) {
594 dev_err(&port->dev, "%s - interrupt_in_urb is empty!\n",
599 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
600 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
601 port->interrupt_in_urb->transfer_buffer,
602 port->interrupt_in_urb->transfer_buffer_length,
603 cypress_read_int_callback, port, priv->read_urb_interval);
604 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
608 "%s - failed submitting read urb, error %d\n",
610 cypress_set_dead(port);
612 port->port.drain_delay = 256;
616 static void cypress_dtr_rts(struct usb_serial_port *port, int on)
618 struct cypress_private *priv = usb_get_serial_port_data(port);
619 /* drop dtr and rts */
620 spin_lock_irq(&priv->lock);
622 priv->line_control = 0;
624 priv->line_control = CONTROL_DTR | CONTROL_RTS;
626 spin_unlock_irq(&priv->lock);
627 cypress_write(NULL, port, NULL, 0);
630 static void cypress_close(struct usb_serial_port *port)
632 struct cypress_private *priv = usb_get_serial_port_data(port);
635 spin_lock_irqsave(&priv->lock, flags);
636 kfifo_reset_out(&priv->write_fifo);
637 spin_unlock_irqrestore(&priv->lock, flags);
639 dev_dbg(&port->dev, "%s - stopping urbs\n", __func__);
640 usb_kill_urb(port->interrupt_in_urb);
641 usb_kill_urb(port->interrupt_out_urb);
644 dev_info(&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
645 priv->bytes_in, priv->bytes_out, priv->cmd_count);
646 } /* cypress_close */
649 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
650 const unsigned char *buf, int count)
652 struct cypress_private *priv = usb_get_serial_port_data(port);
654 dev_dbg(&port->dev, "%s - port %d, %d bytes\n", __func__, port->number, count);
656 /* line control commands, which need to be executed immediately,
657 are not put into the buffer for obvious reasons.
659 if (priv->cmd_ctrl) {
667 count = kfifo_in_locked(&priv->write_fifo, buf, count, &priv->lock);
673 } /* cypress_write */
676 static void cypress_send(struct usb_serial_port *port)
678 int count = 0, result, offset, actual_size;
679 struct cypress_private *priv = usb_get_serial_port_data(port);
680 struct device *dev = &port->dev;
683 if (!priv->comm_is_ok)
686 dev_dbg(dev, "%s - interrupt out size is %d\n", __func__,
687 port->interrupt_out_size);
689 spin_lock_irqsave(&priv->lock, flags);
690 if (priv->write_urb_in_use) {
691 dev_dbg(dev, "%s - can't write, urb in use\n", __func__);
692 spin_unlock_irqrestore(&priv->lock, flags);
695 spin_unlock_irqrestore(&priv->lock, flags);
698 memset(port->interrupt_out_urb->transfer_buffer, 0,
699 port->interrupt_out_size);
701 spin_lock_irqsave(&priv->lock, flags);
702 switch (priv->pkt_fmt) {
704 case packet_format_1:
705 /* this is for the CY7C64013... */
707 port->interrupt_out_buffer[0] = priv->line_control;
709 case packet_format_2:
710 /* this is for the CY7C63743... */
712 port->interrupt_out_buffer[0] = priv->line_control;
716 if (priv->line_control & CONTROL_RESET)
717 priv->line_control &= ~CONTROL_RESET;
719 if (priv->cmd_ctrl) {
721 dev_dbg(dev, "%s - line control command being issued\n", __func__);
722 spin_unlock_irqrestore(&priv->lock, flags);
725 spin_unlock_irqrestore(&priv->lock, flags);
727 count = kfifo_out_locked(&priv->write_fifo,
728 &port->interrupt_out_buffer[offset],
729 port->interrupt_out_size - offset,
734 switch (priv->pkt_fmt) {
736 case packet_format_1:
737 port->interrupt_out_buffer[1] = count;
739 case packet_format_2:
740 port->interrupt_out_buffer[0] |= count;
743 dev_dbg(dev, "%s - count is %d\n", __func__, count);
746 spin_lock_irqsave(&priv->lock, flags);
747 priv->write_urb_in_use = 1;
748 spin_unlock_irqrestore(&priv->lock, flags);
753 actual_size = count +
754 (priv->pkt_fmt == packet_format_1 ? 2 : 1);
756 usb_serial_debug_data(dev, __func__, port->interrupt_out_size,
757 port->interrupt_out_urb->transfer_buffer);
759 usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
760 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
761 port->interrupt_out_buffer, port->interrupt_out_size,
762 cypress_write_int_callback, port, priv->write_urb_interval);
763 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
765 dev_err_console(port,
766 "%s - failed submitting write urb, error %d\n",
768 priv->write_urb_in_use = 0;
769 cypress_set_dead(port);
772 spin_lock_irqsave(&priv->lock, flags);
776 /* do not count the line control and size bytes */
777 priv->bytes_out += count;
778 spin_unlock_irqrestore(&priv->lock, flags);
780 usb_serial_port_softint(port);
784 /* returns how much space is available in the soft buffer */
785 static int cypress_write_room(struct tty_struct *tty)
787 struct usb_serial_port *port = tty->driver_data;
788 struct cypress_private *priv = usb_get_serial_port_data(port);
792 spin_lock_irqsave(&priv->lock, flags);
793 room = kfifo_avail(&priv->write_fifo);
794 spin_unlock_irqrestore(&priv->lock, flags);
796 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
801 static int cypress_tiocmget(struct tty_struct *tty)
803 struct usb_serial_port *port = tty->driver_data;
804 struct cypress_private *priv = usb_get_serial_port_data(port);
805 __u8 status, control;
806 unsigned int result = 0;
809 spin_lock_irqsave(&priv->lock, flags);
810 control = priv->line_control;
811 status = priv->current_status;
812 spin_unlock_irqrestore(&priv->lock, flags);
814 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
815 | ((control & CONTROL_RTS) ? TIOCM_RTS : 0)
816 | ((status & UART_CTS) ? TIOCM_CTS : 0)
817 | ((status & UART_DSR) ? TIOCM_DSR : 0)
818 | ((status & UART_RI) ? TIOCM_RI : 0)
819 | ((status & UART_CD) ? TIOCM_CD : 0);
821 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
827 static int cypress_tiocmset(struct tty_struct *tty,
828 unsigned int set, unsigned int clear)
830 struct usb_serial_port *port = tty->driver_data;
831 struct cypress_private *priv = usb_get_serial_port_data(port);
834 spin_lock_irqsave(&priv->lock, flags);
836 priv->line_control |= CONTROL_RTS;
838 priv->line_control |= CONTROL_DTR;
839 if (clear & TIOCM_RTS)
840 priv->line_control &= ~CONTROL_RTS;
841 if (clear & TIOCM_DTR)
842 priv->line_control &= ~CONTROL_DTR;
844 spin_unlock_irqrestore(&priv->lock, flags);
846 return cypress_write(tty, port, NULL, 0);
850 static int cypress_tiocmiwait(struct tty_struct *tty, unsigned long arg)
852 struct usb_serial_port *port = tty->driver_data;
853 struct cypress_private *priv = usb_get_serial_port_data(port);
857 interruptible_sleep_on(&port->port.delta_msr_wait);
858 /* see if a signal did it */
859 if (signal_pending(current))
862 if (port->serial->disconnected)
865 diff = priv->diff_status;
867 return -EIO; /* no change => error */
869 /* consume all events */
870 priv->diff_status = 0;
872 /* return 0 if caller wanted to know about
874 if (((arg & TIOCM_RNG) && (diff & UART_RI)) ||
875 ((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
876 ((arg & TIOCM_CD) && (diff & UART_CD)) ||
877 ((arg & TIOCM_CTS) && (diff & UART_CTS)))
879 /* otherwise caller can't care less about what
880 * happened, and so we continue to wait for
888 static void cypress_set_termios(struct tty_struct *tty,
889 struct usb_serial_port *port, struct ktermios *old_termios)
891 struct cypress_private *priv = usb_get_serial_port_data(port);
892 struct device *dev = &port->dev;
893 int data_bits, stop_bits, parity_type, parity_enable;
894 unsigned cflag, iflag;
899 spin_lock_irqsave(&priv->lock, flags);
900 /* We can't clean this one up as we don't know the device type
902 if (!priv->termios_initialized) {
903 if (priv->chiptype == CT_EARTHMATE) {
904 tty->termios = tty_std_termios;
905 tty->termios.c_cflag = B4800 | CS8 | CREAD | HUPCL |
907 tty->termios.c_ispeed = 4800;
908 tty->termios.c_ospeed = 4800;
909 } else if (priv->chiptype == CT_CYPHIDCOM) {
910 tty->termios = tty_std_termios;
911 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
913 tty->termios.c_ispeed = 9600;
914 tty->termios.c_ospeed = 9600;
915 } else if (priv->chiptype == CT_CA42V2) {
916 tty->termios = tty_std_termios;
917 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
919 tty->termios.c_ispeed = 9600;
920 tty->termios.c_ospeed = 9600;
922 priv->termios_initialized = 1;
924 spin_unlock_irqrestore(&priv->lock, flags);
926 /* Unsupported features need clearing */
927 tty->termios.c_cflag &= ~(CMSPAR|CRTSCTS);
929 cflag = tty->termios.c_cflag;
930 iflag = tty->termios.c_iflag;
932 /* check if there are new settings */
934 spin_lock_irqsave(&priv->lock, flags);
935 priv->tmp_termios = tty->termios;
936 spin_unlock_irqrestore(&priv->lock, flags);
939 /* set number of data bits, parity, stop bits */
940 /* when parity is disabled the parity type bit is ignored */
942 /* 1 means 2 stop bits, 0 means 1 stop bit */
943 stop_bits = cflag & CSTOPB ? 1 : 0;
945 if (cflag & PARENB) {
947 /* 1 means odd parity, 0 means even parity */
948 parity_type = cflag & PARODD ? 1 : 0;
950 parity_enable = parity_type = 0;
952 switch (cflag & CSIZE) {
966 dev_err(dev, "%s - CSIZE was set, but not CS5-CS8\n", __func__);
969 spin_lock_irqsave(&priv->lock, flags);
970 oldlines = priv->line_control;
971 if ((cflag & CBAUD) == B0) {
972 /* drop dtr and rts */
973 dev_dbg(dev, "%s - dropping the lines, baud rate 0bps\n", __func__);
974 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
976 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
977 spin_unlock_irqrestore(&priv->lock, flags);
979 dev_dbg(dev, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
980 __func__, stop_bits, parity_enable, parity_type, data_bits);
982 cypress_serial_control(tty, port, tty_get_baud_rate(tty),
983 data_bits, stop_bits,
984 parity_enable, parity_type,
985 0, CYPRESS_SET_CONFIG);
987 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
988 * filled into the private structure this should confirm that all is
989 * working if it returns what we just set */
990 cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
992 /* Here we can define custom tty settings for devices; the main tty
993 * termios flag base comes from empeg.c */
995 spin_lock_irqsave(&priv->lock, flags);
996 if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
997 dev_dbg(dev, "Using custom termios settings for a baud rate of 4800bps.\n");
998 /* define custom termios settings for NMEA protocol */
1000 tty->termios.c_iflag /* input modes - */
1001 &= ~(IGNBRK /* disable ignore break */
1002 | BRKINT /* disable break causes interrupt */
1003 | PARMRK /* disable mark parity errors */
1004 | ISTRIP /* disable clear high bit of input char */
1005 | INLCR /* disable translate NL to CR */
1006 | IGNCR /* disable ignore CR */
1007 | ICRNL /* disable translate CR to NL */
1008 | IXON); /* disable enable XON/XOFF flow control */
1010 tty->termios.c_oflag /* output modes */
1011 &= ~OPOST; /* disable postprocess output char */
1013 tty->termios.c_lflag /* line discipline modes */
1014 &= ~(ECHO /* disable echo input characters */
1015 | ECHONL /* disable echo new line */
1016 | ICANON /* disable erase, kill, werase, and rprnt
1017 special characters */
1018 | ISIG /* disable interrupt, quit, and suspend
1019 special characters */
1020 | IEXTEN); /* disable non-POSIX special characters */
1021 } /* CT_CYPHIDCOM: Application should handle this for device */
1023 linechange = (priv->line_control != oldlines);
1024 spin_unlock_irqrestore(&priv->lock, flags);
1026 /* if necessary, set lines */
1029 cypress_write(tty, port, NULL, 0);
1031 } /* cypress_set_termios */
1034 /* returns amount of data still left in soft buffer */
1035 static int cypress_chars_in_buffer(struct tty_struct *tty)
1037 struct usb_serial_port *port = tty->driver_data;
1038 struct cypress_private *priv = usb_get_serial_port_data(port);
1040 unsigned long flags;
1042 spin_lock_irqsave(&priv->lock, flags);
1043 chars = kfifo_len(&priv->write_fifo);
1044 spin_unlock_irqrestore(&priv->lock, flags);
1046 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1051 static void cypress_throttle(struct tty_struct *tty)
1053 struct usb_serial_port *port = tty->driver_data;
1054 struct cypress_private *priv = usb_get_serial_port_data(port);
1056 spin_lock_irq(&priv->lock);
1057 priv->rx_flags = THROTTLED;
1058 spin_unlock_irq(&priv->lock);
1062 static void cypress_unthrottle(struct tty_struct *tty)
1064 struct usb_serial_port *port = tty->driver_data;
1065 struct cypress_private *priv = usb_get_serial_port_data(port);
1066 int actually_throttled, result;
1068 spin_lock_irq(&priv->lock);
1069 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1071 spin_unlock_irq(&priv->lock);
1073 if (!priv->comm_is_ok)
1076 if (actually_throttled) {
1077 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1079 dev_err(&port->dev, "%s - failed submitting read urb, "
1080 "error %d\n", __func__, result);
1081 cypress_set_dead(port);
1087 static void cypress_read_int_callback(struct urb *urb)
1089 struct usb_serial_port *port = urb->context;
1090 struct cypress_private *priv = usb_get_serial_port_data(port);
1091 struct device *dev = &urb->dev->dev;
1092 struct tty_struct *tty;
1093 unsigned char *data = urb->transfer_buffer;
1094 unsigned long flags;
1095 char tty_flag = TTY_NORMAL;
1100 int status = urb->status;
1103 case 0: /* success */
1108 /* precursor to disconnect so just go away */
1111 /* Can't call usb_clear_halt while in_interrupt */
1114 /* something ugly is going on... */
1115 dev_err(dev, "%s - unexpected nonzero read status received: %d\n",
1117 cypress_set_dead(port);
1121 spin_lock_irqsave(&priv->lock, flags);
1122 if (priv->rx_flags & THROTTLED) {
1123 dev_dbg(dev, "%s - now throttling\n", __func__);
1124 priv->rx_flags |= ACTUALLY_THROTTLED;
1125 spin_unlock_irqrestore(&priv->lock, flags);
1128 spin_unlock_irqrestore(&priv->lock, flags);
1130 tty = tty_port_tty_get(&port->port);
1132 dev_dbg(dev, "%s - bad tty pointer - exiting\n", __func__);
1136 spin_lock_irqsave(&priv->lock, flags);
1137 result = urb->actual_length;
1138 switch (priv->pkt_fmt) {
1140 case packet_format_1:
1141 /* This is for the CY7C64013... */
1142 priv->current_status = data[0] & 0xF8;
1143 bytes = data[1] + 2;
1148 case packet_format_2:
1149 /* This is for the CY7C63743... */
1150 priv->current_status = data[0] & 0xF8;
1151 bytes = (data[0] & 0x07) + 1;
1157 spin_unlock_irqrestore(&priv->lock, flags);
1158 if (result < bytes) {
1160 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1161 __func__, result, bytes);
1165 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1167 spin_lock_irqsave(&priv->lock, flags);
1168 /* check to see if status has changed */
1169 if (priv->current_status != priv->prev_status) {
1170 priv->diff_status |= priv->current_status ^
1172 wake_up_interruptible(&port->port.delta_msr_wait);
1173 priv->prev_status = priv->current_status;
1175 spin_unlock_irqrestore(&priv->lock, flags);
1177 /* hangup, as defined in acm.c... this might be a bad place for it
1179 if (tty && !(tty->termios.c_cflag & CLOCAL) &&
1180 !(priv->current_status & UART_CD)) {
1181 dev_dbg(dev, "%s - calling hangup\n", __func__);
1186 /* There is one error bit... I'm assuming it is a parity error
1187 * indicator as the generic firmware will set this bit to 1 if a
1188 * parity error occurs.
1189 * I can not find reference to any other error events. */
1190 spin_lock_irqsave(&priv->lock, flags);
1191 if (priv->current_status & CYP_ERROR) {
1192 spin_unlock_irqrestore(&priv->lock, flags);
1193 tty_flag = TTY_PARITY;
1194 dev_dbg(dev, "%s - Parity Error detected\n", __func__);
1196 spin_unlock_irqrestore(&priv->lock, flags);
1198 /* process read if there is data other than line status */
1200 tty_insert_flip_string_fixed_flag(&port->port, data + i,
1201 tty_flag, bytes - i);
1202 tty_flip_buffer_push(&port->port);
1205 spin_lock_irqsave(&priv->lock, flags);
1206 /* control and status byte(s) are also counted */
1207 priv->bytes_in += bytes;
1208 spin_unlock_irqrestore(&priv->lock, flags);
1213 /* Continue trying to always read */
1215 if (priv->comm_is_ok) {
1216 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1217 usb_rcvintpipe(port->serial->dev,
1218 port->interrupt_in_endpointAddress),
1219 port->interrupt_in_urb->transfer_buffer,
1220 port->interrupt_in_urb->transfer_buffer_length,
1221 cypress_read_int_callback, port,
1222 priv->read_urb_interval);
1223 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1224 if (result && result != -EPERM) {
1225 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
1227 cypress_set_dead(port);
1230 } /* cypress_read_int_callback */
1233 static void cypress_write_int_callback(struct urb *urb)
1235 struct usb_serial_port *port = urb->context;
1236 struct cypress_private *priv = usb_get_serial_port_data(port);
1237 struct device *dev = &urb->dev->dev;
1239 int status = urb->status;
1248 /* this urb is terminated, clean up */
1249 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1251 priv->write_urb_in_use = 0;
1253 case -EPIPE: /* no break needed; clear halt and resubmit */
1254 if (!priv->comm_is_ok)
1256 usb_clear_halt(port->serial->dev, 0x02);
1257 /* error in the urb, so we have to resubmit it */
1258 dev_dbg(dev, "%s - nonzero write bulk status received: %d\n",
1260 port->interrupt_out_urb->transfer_buffer_length = 1;
1261 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1264 dev_err(dev, "%s - failed resubmitting write urb, error %d\n",
1266 cypress_set_dead(port);
1269 dev_err(dev, "%s - unexpected nonzero write status received: %d\n",
1271 cypress_set_dead(port);
1274 priv->write_urb_in_use = 0;
1276 /* send any buffered data */
1280 module_usb_serial_driver(serial_drivers, id_table_combined);
1282 MODULE_AUTHOR(DRIVER_AUTHOR);
1283 MODULE_DESCRIPTION(DRIVER_DESC);
1284 MODULE_LICENSE("GPL");
1286 module_param(stats, bool, S_IRUGO | S_IWUSR);
1287 MODULE_PARM_DESC(stats, "Enable statistics or not");
1288 module_param(interval, int, S_IRUGO | S_IWUSR);
1289 MODULE_PARM_DESC(interval, "Overrides interrupt interval");
1290 module_param(unstable_bauds, bool, S_IRUGO | S_IWUSR);
1291 MODULE_PARM_DESC(unstable_bauds, "Allow unstable baud rates");