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/slab.h>
31 #include <linux/tty.h>
32 #include <linux/tty_driver.h>
33 #include <linux/tty_flip.h>
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/spinlock.h>
37 #include <linux/usb.h>
38 #include <linux/usb/serial.h>
39 #include <linux/serial.h>
40 #include <linux/kfifo.h>
41 #include <linux/delay.h>
42 #include <linux/uaccess.h>
43 #include <asm/unaligned.h>
45 #include "cypress_m8.h"
50 static bool unstable_bauds;
52 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
53 #define DRIVER_DESC "Cypress USB to Serial Driver"
55 /* write buffer size defines */
56 #define CYPRESS_BUF_SIZE 1024
58 static const struct usb_device_id id_table_earthmate[] = {
59 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
60 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
61 { } /* Terminating entry */
64 static const struct usb_device_id id_table_cyphidcomrs232[] = {
65 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
66 { USB_DEVICE(VENDOR_ID_SAI, PRODUCT_ID_CYPHIDCOM) },
67 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
68 { USB_DEVICE(VENDOR_ID_FRWD, PRODUCT_ID_CYPHIDCOM_FRWD) },
69 { } /* Terminating entry */
72 static const struct usb_device_id id_table_nokiaca42v2[] = {
73 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
74 { } /* Terminating entry */
77 static const struct usb_device_id id_table_combined[] = {
78 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
79 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
80 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
81 { USB_DEVICE(VENDOR_ID_SAI, PRODUCT_ID_CYPHIDCOM) },
82 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
83 { USB_DEVICE(VENDOR_ID_FRWD, PRODUCT_ID_CYPHIDCOM_FRWD) },
84 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
85 { } /* Terminating entry */
88 MODULE_DEVICE_TABLE(usb, id_table_combined);
91 packet_format_1, /* b0:status, b1:payload count */
92 packet_format_2 /* b0[7:3]:status, b0[2:0]:payload count */
95 struct cypress_private {
96 spinlock_t lock; /* private lock */
97 int chiptype; /* identifier of device, for quirks/etc */
98 int bytes_in; /* used for statistics */
99 int bytes_out; /* used for statistics */
100 int cmd_count; /* used for statistics */
101 int cmd_ctrl; /* always set this to 1 before issuing a command */
102 struct kfifo write_fifo; /* write fifo */
103 int write_urb_in_use; /* write urb in use indicator */
104 int write_urb_interval; /* interval to use for write urb */
105 int read_urb_interval; /* interval to use for read urb */
106 int comm_is_ok; /* true if communication is (still) ok */
107 int termios_initialized;
108 __u8 line_control; /* holds dtr / rts value */
109 __u8 current_status; /* received from last read - info on dsr,cts,cd,ri,etc */
110 __u8 current_config; /* stores the current configuration byte */
111 __u8 rx_flags; /* throttling - used from whiteheat/ftdi_sio */
112 enum packet_format pkt_fmt; /* format to use for packet send / receive */
113 int get_cfg_unsafe; /* If true, the CYPRESS_GET_CONFIG is unsafe */
114 int baud_rate; /* stores current baud rate in
116 int isthrottled; /* if throttled, discard reads */
117 char prev_status; /* used for TIOCMIWAIT */
118 /* we pass a pointer to this as the argument sent to
119 cypress_set_termios old_termios */
120 struct ktermios tmp_termios; /* stores the old termios settings */
123 /* function prototypes for the Cypress USB to serial device */
124 static int cypress_earthmate_port_probe(struct usb_serial_port *port);
125 static int cypress_hidcom_port_probe(struct usb_serial_port *port);
126 static int cypress_ca42v2_port_probe(struct usb_serial_port *port);
127 static int cypress_port_remove(struct usb_serial_port *port);
128 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port);
129 static void cypress_close(struct usb_serial_port *port);
130 static void cypress_dtr_rts(struct usb_serial_port *port, int on);
131 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
132 const unsigned char *buf, int count);
133 static void cypress_send(struct usb_serial_port *port);
134 static int cypress_write_room(struct tty_struct *tty);
135 static void cypress_set_termios(struct tty_struct *tty,
136 struct usb_serial_port *port, struct ktermios *old);
137 static int cypress_tiocmget(struct tty_struct *tty);
138 static int cypress_tiocmset(struct tty_struct *tty,
139 unsigned int set, unsigned int clear);
140 static int cypress_chars_in_buffer(struct tty_struct *tty);
141 static void cypress_throttle(struct tty_struct *tty);
142 static void cypress_unthrottle(struct tty_struct *tty);
143 static void cypress_set_dead(struct usb_serial_port *port);
144 static void cypress_read_int_callback(struct urb *urb);
145 static void cypress_write_int_callback(struct urb *urb);
147 static struct usb_serial_driver cypress_earthmate_device = {
149 .owner = THIS_MODULE,
152 .description = "DeLorme Earthmate USB",
153 .id_table = id_table_earthmate,
155 .port_probe = cypress_earthmate_port_probe,
156 .port_remove = cypress_port_remove,
157 .open = cypress_open,
158 .close = cypress_close,
159 .dtr_rts = cypress_dtr_rts,
160 .write = cypress_write,
161 .write_room = cypress_write_room,
162 .set_termios = cypress_set_termios,
163 .tiocmget = cypress_tiocmget,
164 .tiocmset = cypress_tiocmset,
165 .tiocmiwait = usb_serial_generic_tiocmiwait,
166 .chars_in_buffer = cypress_chars_in_buffer,
167 .throttle = cypress_throttle,
168 .unthrottle = cypress_unthrottle,
169 .read_int_callback = cypress_read_int_callback,
170 .write_int_callback = cypress_write_int_callback,
173 static struct usb_serial_driver cypress_hidcom_device = {
175 .owner = THIS_MODULE,
178 .description = "HID->COM RS232 Adapter",
179 .id_table = id_table_cyphidcomrs232,
181 .port_probe = cypress_hidcom_port_probe,
182 .port_remove = cypress_port_remove,
183 .open = cypress_open,
184 .close = cypress_close,
185 .dtr_rts = cypress_dtr_rts,
186 .write = cypress_write,
187 .write_room = cypress_write_room,
188 .set_termios = cypress_set_termios,
189 .tiocmget = cypress_tiocmget,
190 .tiocmset = cypress_tiocmset,
191 .tiocmiwait = usb_serial_generic_tiocmiwait,
192 .chars_in_buffer = cypress_chars_in_buffer,
193 .throttle = cypress_throttle,
194 .unthrottle = cypress_unthrottle,
195 .read_int_callback = cypress_read_int_callback,
196 .write_int_callback = cypress_write_int_callback,
199 static struct usb_serial_driver cypress_ca42v2_device = {
201 .owner = THIS_MODULE,
202 .name = "nokiaca42v2",
204 .description = "Nokia CA-42 V2 Adapter",
205 .id_table = id_table_nokiaca42v2,
207 .port_probe = cypress_ca42v2_port_probe,
208 .port_remove = cypress_port_remove,
209 .open = cypress_open,
210 .close = cypress_close,
211 .dtr_rts = cypress_dtr_rts,
212 .write = cypress_write,
213 .write_room = cypress_write_room,
214 .set_termios = cypress_set_termios,
215 .tiocmget = cypress_tiocmget,
216 .tiocmset = cypress_tiocmset,
217 .tiocmiwait = usb_serial_generic_tiocmiwait,
218 .chars_in_buffer = cypress_chars_in_buffer,
219 .throttle = cypress_throttle,
220 .unthrottle = cypress_unthrottle,
221 .read_int_callback = cypress_read_int_callback,
222 .write_int_callback = cypress_write_int_callback,
225 static struct usb_serial_driver * const serial_drivers[] = {
226 &cypress_earthmate_device, &cypress_hidcom_device,
227 &cypress_ca42v2_device, NULL
230 /*****************************************************************************
231 * Cypress serial helper functions
232 *****************************************************************************/
234 /* FRWD Dongle hidcom needs to skip reset and speed checks */
235 static inline bool is_frwd(struct usb_device *dev)
237 return ((le16_to_cpu(dev->descriptor.idVendor) == VENDOR_ID_FRWD) &&
238 (le16_to_cpu(dev->descriptor.idProduct) == PRODUCT_ID_CYPHIDCOM_FRWD));
241 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
243 struct cypress_private *priv;
244 priv = usb_get_serial_port_data(port);
249 /* FRWD Dongle uses 115200 bps */
250 if (is_frwd(port->serial->dev))
254 * The general purpose firmware for the Cypress M8 allows for
255 * a maximum speed of 57600bps (I have no idea whether DeLorme
256 * chose to use the general purpose firmware or not), if you
257 * need to modify this speed setting for your own project
258 * please add your own chiptype and modify the code likewise.
259 * The Cypress HID->COM device will work successfully up to
260 * 115200bps (but the actual throughput is around 3kBps).
262 if (port->serial->dev->speed == USB_SPEED_LOW) {
264 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
265 * Cypress app note that describes this mechanism
266 * states the the low-speed part can't handle more
267 * than 800 bytes/sec, in which case 4800 baud is the
268 * safest speed for a part like that.
270 if (new_rate > 4800) {
272 "%s - failed setting baud rate, device incapable speed %d\n",
277 switch (priv->chiptype) {
279 if (new_rate <= 600) {
280 /* 300 and 600 baud rates are supported under
281 * the generic firmware, but are not used with
282 * NMEA and SiRF protocols */
284 "%s - failed setting baud rate, unsupported speed of %d on Earthmate GPS\n",
296 /* This function can either set or retrieve the current serial line settings */
297 static int cypress_serial_control(struct tty_struct *tty,
298 struct usb_serial_port *port, speed_t baud_rate, int data_bits,
299 int stop_bits, int parity_enable, int parity_type, int reset,
300 int cypress_request_type)
302 int new_baudrate = 0, retval = 0, tries = 0;
303 struct cypress_private *priv;
304 struct device *dev = &port->dev;
306 const unsigned int feature_len = 5;
309 priv = usb_get_serial_port_data(port);
311 if (!priv->comm_is_ok)
314 feature_buffer = kcalloc(feature_len, sizeof(u8), GFP_KERNEL);
318 switch (cypress_request_type) {
319 case CYPRESS_SET_CONFIG:
320 /* 0 means 'Hang up' so doesn't change the true bit rate */
321 new_baudrate = priv->baud_rate;
322 if (baud_rate && baud_rate != priv->baud_rate) {
323 dev_dbg(dev, "%s - baud rate is changing\n", __func__);
324 retval = analyze_baud_rate(port, baud_rate);
326 new_baudrate = retval;
327 dev_dbg(dev, "%s - New baud rate set to %d\n",
328 __func__, new_baudrate);
331 dev_dbg(dev, "%s - baud rate is being sent as %d\n", __func__,
334 /* fill the feature_buffer with new configuration */
335 put_unaligned_le32(new_baudrate, feature_buffer);
336 feature_buffer[4] |= data_bits; /* assign data bits in 2 bit space ( max 3 ) */
338 feature_buffer[4] |= (stop_bits << 3); /* assign stop bits in 1 bit space */
339 feature_buffer[4] |= (parity_enable << 4); /* assign parity flag in 1 bit space */
340 feature_buffer[4] |= (parity_type << 5); /* assign parity type in 1 bit space */
342 feature_buffer[4] |= (reset << 7); /* assign reset at end of byte, 1 bit space */
344 dev_dbg(dev, "%s - device is being sent this feature report:\n", __func__);
345 dev_dbg(dev, "%s - %02X - %02X - %02X - %02X - %02X\n", __func__,
346 feature_buffer[0], feature_buffer[1],
347 feature_buffer[2], feature_buffer[3],
351 retval = usb_control_msg(port->serial->dev,
352 usb_sndctrlpipe(port->serial->dev, 0),
354 USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
355 0x0300, 0, feature_buffer,
361 } while (retval != feature_len &&
364 if (retval != feature_len) {
365 dev_err(dev, "%s - failed sending serial line settings - %d\n",
367 cypress_set_dead(port);
369 spin_lock_irqsave(&priv->lock, flags);
370 priv->baud_rate = new_baudrate;
371 priv->current_config = feature_buffer[4];
372 spin_unlock_irqrestore(&priv->lock, flags);
373 /* If we asked for a speed change encode it */
375 tty_encode_baud_rate(tty,
376 new_baudrate, new_baudrate);
379 case CYPRESS_GET_CONFIG:
380 if (priv->get_cfg_unsafe) {
381 /* Not implemented for this device,
382 and if we try to do it we're likely
383 to crash the hardware. */
387 dev_dbg(dev, "%s - retreiving serial line settings\n", __func__);
389 retval = usb_control_msg(port->serial->dev,
390 usb_rcvctrlpipe(port->serial->dev, 0),
392 USB_DIR_IN | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
393 0x0300, 0, feature_buffer,
398 } while (retval != feature_len
399 && retval != -ENODEV);
401 if (retval != feature_len) {
402 dev_err(dev, "%s - failed to retrieve serial line settings - %d\n",
404 cypress_set_dead(port);
407 spin_lock_irqsave(&priv->lock, flags);
408 /* store the config in one byte, and later
409 use bit masks to check values */
410 priv->current_config = feature_buffer[4];
411 priv->baud_rate = get_unaligned_le32(feature_buffer);
412 spin_unlock_irqrestore(&priv->lock, flags);
415 spin_lock_irqsave(&priv->lock, flags);
417 spin_unlock_irqrestore(&priv->lock, flags);
419 kfree(feature_buffer);
421 } /* cypress_serial_control */
424 static void cypress_set_dead(struct usb_serial_port *port)
426 struct cypress_private *priv = usb_get_serial_port_data(port);
429 spin_lock_irqsave(&priv->lock, flags);
430 if (!priv->comm_is_ok) {
431 spin_unlock_irqrestore(&priv->lock, flags);
434 priv->comm_is_ok = 0;
435 spin_unlock_irqrestore(&priv->lock, flags);
437 dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
438 "interval might be too short\n", port->port_number);
442 /*****************************************************************************
443 * Cypress serial driver functions
444 *****************************************************************************/
447 static int cypress_generic_port_probe(struct usb_serial_port *port)
449 struct usb_serial *serial = port->serial;
450 struct cypress_private *priv;
452 if (!port->interrupt_out_urb || !port->interrupt_in_urb) {
453 dev_err(&port->dev, "required endpoint is missing\n");
457 priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
461 priv->comm_is_ok = !0;
462 spin_lock_init(&priv->lock);
463 if (kfifo_alloc(&priv->write_fifo, CYPRESS_BUF_SIZE, GFP_KERNEL)) {
468 /* Skip reset for FRWD device. It is a workaound:
469 device hangs if it receives SET_CONFIGURE in Configured
471 if (!is_frwd(serial->dev))
472 usb_reset_configuration(serial->dev);
475 priv->line_control = 0;
476 priv->termios_initialized = 0;
478 /* Default packet format setting is determined by packet size.
479 Anything with a size larger then 9 must have a separate
480 count field since the 3 bit count field is otherwise too
481 small. Otherwise we can use the slightly more compact
482 format. This is in accordance with the cypress_m8 serial
483 converter app note. */
484 if (port->interrupt_out_size > 9)
485 priv->pkt_fmt = packet_format_1;
487 priv->pkt_fmt = packet_format_2;
490 priv->write_urb_interval = interval;
491 priv->read_urb_interval = interval;
492 dev_dbg(&port->dev, "%s - read & write intervals forced to %d\n",
495 priv->write_urb_interval = port->interrupt_out_urb->interval;
496 priv->read_urb_interval = port->interrupt_in_urb->interval;
497 dev_dbg(&port->dev, "%s - intervals: read=%d write=%d\n",
498 __func__, priv->read_urb_interval,
499 priv->write_urb_interval);
501 usb_set_serial_port_data(port, priv);
503 port->port.drain_delay = 256;
509 static int cypress_earthmate_port_probe(struct usb_serial_port *port)
511 struct usb_serial *serial = port->serial;
512 struct cypress_private *priv;
515 ret = cypress_generic_port_probe(port);
517 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
521 priv = usb_get_serial_port_data(port);
522 priv->chiptype = CT_EARTHMATE;
523 /* All Earthmate devices use the separated-count packet
525 priv->pkt_fmt = packet_format_1;
526 if (serial->dev->descriptor.idProduct !=
527 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB)) {
528 /* The old original USB Earthmate seemed able to
529 handle GET_CONFIG requests; everything they've
530 produced since that time crashes if this command is
533 "%s - Marking this device as unsafe for GET_CONFIG commands\n",
535 priv->get_cfg_unsafe = !0;
541 static int cypress_hidcom_port_probe(struct usb_serial_port *port)
543 struct cypress_private *priv;
546 ret = cypress_generic_port_probe(port);
548 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
552 priv = usb_get_serial_port_data(port);
553 priv->chiptype = CT_CYPHIDCOM;
558 static int cypress_ca42v2_port_probe(struct usb_serial_port *port)
560 struct cypress_private *priv;
563 ret = cypress_generic_port_probe(port);
565 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
569 priv = usb_get_serial_port_data(port);
570 priv->chiptype = CT_CA42V2;
575 static int cypress_port_remove(struct usb_serial_port *port)
577 struct cypress_private *priv;
579 priv = usb_get_serial_port_data(port);
581 kfifo_free(&priv->write_fifo);
587 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port)
589 struct cypress_private *priv = usb_get_serial_port_data(port);
590 struct usb_serial *serial = port->serial;
594 if (!priv->comm_is_ok)
597 /* clear halts before open */
598 usb_clear_halt(serial->dev, 0x81);
599 usb_clear_halt(serial->dev, 0x02);
601 spin_lock_irqsave(&priv->lock, flags);
602 /* reset read/write statistics */
607 spin_unlock_irqrestore(&priv->lock, flags);
613 cypress_set_termios(tty, port, &priv->tmp_termios);
615 /* setup the port and start reading from the device */
616 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
617 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
618 port->interrupt_in_urb->transfer_buffer,
619 port->interrupt_in_urb->transfer_buffer_length,
620 cypress_read_int_callback, port, priv->read_urb_interval);
621 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
625 "%s - failed submitting read urb, error %d\n",
627 cypress_set_dead(port);
633 static void cypress_dtr_rts(struct usb_serial_port *port, int on)
635 struct cypress_private *priv = usb_get_serial_port_data(port);
636 /* drop dtr and rts */
637 spin_lock_irq(&priv->lock);
639 priv->line_control = 0;
641 priv->line_control = CONTROL_DTR | CONTROL_RTS;
643 spin_unlock_irq(&priv->lock);
644 cypress_write(NULL, port, NULL, 0);
647 static void cypress_close(struct usb_serial_port *port)
649 struct cypress_private *priv = usb_get_serial_port_data(port);
652 spin_lock_irqsave(&priv->lock, flags);
653 kfifo_reset_out(&priv->write_fifo);
654 spin_unlock_irqrestore(&priv->lock, flags);
656 dev_dbg(&port->dev, "%s - stopping urbs\n", __func__);
657 usb_kill_urb(port->interrupt_in_urb);
658 usb_kill_urb(port->interrupt_out_urb);
661 dev_info(&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
662 priv->bytes_in, priv->bytes_out, priv->cmd_count);
663 } /* cypress_close */
666 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
667 const unsigned char *buf, int count)
669 struct cypress_private *priv = usb_get_serial_port_data(port);
671 dev_dbg(&port->dev, "%s - %d bytes\n", __func__, count);
673 /* line control commands, which need to be executed immediately,
674 are not put into the buffer for obvious reasons.
676 if (priv->cmd_ctrl) {
684 count = kfifo_in_locked(&priv->write_fifo, buf, count, &priv->lock);
690 } /* cypress_write */
693 static void cypress_send(struct usb_serial_port *port)
695 int count = 0, result, offset, actual_size;
696 struct cypress_private *priv = usb_get_serial_port_data(port);
697 struct device *dev = &port->dev;
700 if (!priv->comm_is_ok)
703 dev_dbg(dev, "%s - interrupt out size is %d\n", __func__,
704 port->interrupt_out_size);
706 spin_lock_irqsave(&priv->lock, flags);
707 if (priv->write_urb_in_use) {
708 dev_dbg(dev, "%s - can't write, urb in use\n", __func__);
709 spin_unlock_irqrestore(&priv->lock, flags);
712 spin_unlock_irqrestore(&priv->lock, flags);
715 memset(port->interrupt_out_urb->transfer_buffer, 0,
716 port->interrupt_out_size);
718 spin_lock_irqsave(&priv->lock, flags);
719 switch (priv->pkt_fmt) {
721 case packet_format_1:
722 /* this is for the CY7C64013... */
724 port->interrupt_out_buffer[0] = priv->line_control;
726 case packet_format_2:
727 /* this is for the CY7C63743... */
729 port->interrupt_out_buffer[0] = priv->line_control;
733 if (priv->line_control & CONTROL_RESET)
734 priv->line_control &= ~CONTROL_RESET;
736 if (priv->cmd_ctrl) {
738 dev_dbg(dev, "%s - line control command being issued\n", __func__);
739 spin_unlock_irqrestore(&priv->lock, flags);
742 spin_unlock_irqrestore(&priv->lock, flags);
744 count = kfifo_out_locked(&priv->write_fifo,
745 &port->interrupt_out_buffer[offset],
746 port->interrupt_out_size - offset,
751 switch (priv->pkt_fmt) {
753 case packet_format_1:
754 port->interrupt_out_buffer[1] = count;
756 case packet_format_2:
757 port->interrupt_out_buffer[0] |= count;
760 dev_dbg(dev, "%s - count is %d\n", __func__, count);
763 spin_lock_irqsave(&priv->lock, flags);
764 priv->write_urb_in_use = 1;
765 spin_unlock_irqrestore(&priv->lock, flags);
770 actual_size = count +
771 (priv->pkt_fmt == packet_format_1 ? 2 : 1);
773 usb_serial_debug_data(dev, __func__, port->interrupt_out_size,
774 port->interrupt_out_urb->transfer_buffer);
776 usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
777 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
778 port->interrupt_out_buffer, actual_size,
779 cypress_write_int_callback, port, priv->write_urb_interval);
780 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
782 dev_err_console(port,
783 "%s - failed submitting write urb, error %d\n",
785 priv->write_urb_in_use = 0;
786 cypress_set_dead(port);
789 spin_lock_irqsave(&priv->lock, flags);
793 /* do not count the line control and size bytes */
794 priv->bytes_out += count;
795 spin_unlock_irqrestore(&priv->lock, flags);
797 usb_serial_port_softint(port);
801 /* returns how much space is available in the soft buffer */
802 static int cypress_write_room(struct tty_struct *tty)
804 struct usb_serial_port *port = tty->driver_data;
805 struct cypress_private *priv = usb_get_serial_port_data(port);
809 spin_lock_irqsave(&priv->lock, flags);
810 room = kfifo_avail(&priv->write_fifo);
811 spin_unlock_irqrestore(&priv->lock, flags);
813 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
818 static int cypress_tiocmget(struct tty_struct *tty)
820 struct usb_serial_port *port = tty->driver_data;
821 struct cypress_private *priv = usb_get_serial_port_data(port);
822 __u8 status, control;
823 unsigned int result = 0;
826 spin_lock_irqsave(&priv->lock, flags);
827 control = priv->line_control;
828 status = priv->current_status;
829 spin_unlock_irqrestore(&priv->lock, flags);
831 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
832 | ((control & CONTROL_RTS) ? TIOCM_RTS : 0)
833 | ((status & UART_CTS) ? TIOCM_CTS : 0)
834 | ((status & UART_DSR) ? TIOCM_DSR : 0)
835 | ((status & UART_RI) ? TIOCM_RI : 0)
836 | ((status & UART_CD) ? TIOCM_CD : 0);
838 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
844 static int cypress_tiocmset(struct tty_struct *tty,
845 unsigned int set, unsigned int clear)
847 struct usb_serial_port *port = tty->driver_data;
848 struct cypress_private *priv = usb_get_serial_port_data(port);
851 spin_lock_irqsave(&priv->lock, flags);
853 priv->line_control |= CONTROL_RTS;
855 priv->line_control |= CONTROL_DTR;
856 if (clear & TIOCM_RTS)
857 priv->line_control &= ~CONTROL_RTS;
858 if (clear & TIOCM_DTR)
859 priv->line_control &= ~CONTROL_DTR;
861 spin_unlock_irqrestore(&priv->lock, flags);
863 return cypress_write(tty, port, NULL, 0);
866 static void cypress_set_termios(struct tty_struct *tty,
867 struct usb_serial_port *port, struct ktermios *old_termios)
869 struct cypress_private *priv = usb_get_serial_port_data(port);
870 struct device *dev = &port->dev;
871 int data_bits, stop_bits, parity_type, parity_enable;
872 unsigned cflag, iflag;
877 spin_lock_irqsave(&priv->lock, flags);
878 /* We can't clean this one up as we don't know the device type
880 if (!priv->termios_initialized) {
881 if (priv->chiptype == CT_EARTHMATE) {
882 tty->termios = tty_std_termios;
883 tty->termios.c_cflag = B4800 | CS8 | CREAD | HUPCL |
885 tty->termios.c_ispeed = 4800;
886 tty->termios.c_ospeed = 4800;
887 } else if (priv->chiptype == CT_CYPHIDCOM) {
888 tty->termios = tty_std_termios;
889 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
891 tty->termios.c_ispeed = 9600;
892 tty->termios.c_ospeed = 9600;
893 } else if (priv->chiptype == CT_CA42V2) {
894 tty->termios = tty_std_termios;
895 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
897 tty->termios.c_ispeed = 9600;
898 tty->termios.c_ospeed = 9600;
900 priv->termios_initialized = 1;
902 spin_unlock_irqrestore(&priv->lock, flags);
904 /* Unsupported features need clearing */
905 tty->termios.c_cflag &= ~(CMSPAR|CRTSCTS);
907 cflag = tty->termios.c_cflag;
908 iflag = tty->termios.c_iflag;
910 /* check if there are new settings */
912 spin_lock_irqsave(&priv->lock, flags);
913 priv->tmp_termios = tty->termios;
914 spin_unlock_irqrestore(&priv->lock, flags);
917 /* set number of data bits, parity, stop bits */
918 /* when parity is disabled the parity type bit is ignored */
920 /* 1 means 2 stop bits, 0 means 1 stop bit */
921 stop_bits = cflag & CSTOPB ? 1 : 0;
923 if (cflag & PARENB) {
925 /* 1 means odd parity, 0 means even parity */
926 parity_type = cflag & PARODD ? 1 : 0;
928 parity_enable = parity_type = 0;
930 switch (cflag & CSIZE) {
944 dev_err(dev, "%s - CSIZE was set, but not CS5-CS8\n", __func__);
947 spin_lock_irqsave(&priv->lock, flags);
948 oldlines = priv->line_control;
949 if ((cflag & CBAUD) == B0) {
950 /* drop dtr and rts */
951 dev_dbg(dev, "%s - dropping the lines, baud rate 0bps\n", __func__);
952 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
954 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
955 spin_unlock_irqrestore(&priv->lock, flags);
957 dev_dbg(dev, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
958 __func__, stop_bits, parity_enable, parity_type, data_bits);
960 cypress_serial_control(tty, port, tty_get_baud_rate(tty),
961 data_bits, stop_bits,
962 parity_enable, parity_type,
963 0, CYPRESS_SET_CONFIG);
965 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
966 * filled into the private structure this should confirm that all is
967 * working if it returns what we just set */
968 cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
970 /* Here we can define custom tty settings for devices; the main tty
971 * termios flag base comes from empeg.c */
973 spin_lock_irqsave(&priv->lock, flags);
974 if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
975 dev_dbg(dev, "Using custom termios settings for a baud rate of 4800bps.\n");
976 /* define custom termios settings for NMEA protocol */
978 tty->termios.c_iflag /* input modes - */
979 &= ~(IGNBRK /* disable ignore break */
980 | BRKINT /* disable break causes interrupt */
981 | PARMRK /* disable mark parity errors */
982 | ISTRIP /* disable clear high bit of input char */
983 | INLCR /* disable translate NL to CR */
984 | IGNCR /* disable ignore CR */
985 | ICRNL /* disable translate CR to NL */
986 | IXON); /* disable enable XON/XOFF flow control */
988 tty->termios.c_oflag /* output modes */
989 &= ~OPOST; /* disable postprocess output char */
991 tty->termios.c_lflag /* line discipline modes */
992 &= ~(ECHO /* disable echo input characters */
993 | ECHONL /* disable echo new line */
994 | ICANON /* disable erase, kill, werase, and rprnt
995 special characters */
996 | ISIG /* disable interrupt, quit, and suspend
997 special characters */
998 | IEXTEN); /* disable non-POSIX special characters */
999 } /* CT_CYPHIDCOM: Application should handle this for device */
1001 linechange = (priv->line_control != oldlines);
1002 spin_unlock_irqrestore(&priv->lock, flags);
1004 /* if necessary, set lines */
1007 cypress_write(tty, port, NULL, 0);
1009 } /* cypress_set_termios */
1012 /* returns amount of data still left in soft buffer */
1013 static int cypress_chars_in_buffer(struct tty_struct *tty)
1015 struct usb_serial_port *port = tty->driver_data;
1016 struct cypress_private *priv = usb_get_serial_port_data(port);
1018 unsigned long flags;
1020 spin_lock_irqsave(&priv->lock, flags);
1021 chars = kfifo_len(&priv->write_fifo);
1022 spin_unlock_irqrestore(&priv->lock, flags);
1024 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1029 static void cypress_throttle(struct tty_struct *tty)
1031 struct usb_serial_port *port = tty->driver_data;
1032 struct cypress_private *priv = usb_get_serial_port_data(port);
1034 spin_lock_irq(&priv->lock);
1035 priv->rx_flags = THROTTLED;
1036 spin_unlock_irq(&priv->lock);
1040 static void cypress_unthrottle(struct tty_struct *tty)
1042 struct usb_serial_port *port = tty->driver_data;
1043 struct cypress_private *priv = usb_get_serial_port_data(port);
1044 int actually_throttled, result;
1046 spin_lock_irq(&priv->lock);
1047 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1049 spin_unlock_irq(&priv->lock);
1051 if (!priv->comm_is_ok)
1054 if (actually_throttled) {
1055 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1057 dev_err(&port->dev, "%s - failed submitting read urb, "
1058 "error %d\n", __func__, result);
1059 cypress_set_dead(port);
1065 static void cypress_read_int_callback(struct urb *urb)
1067 struct usb_serial_port *port = urb->context;
1068 struct cypress_private *priv = usb_get_serial_port_data(port);
1069 struct device *dev = &urb->dev->dev;
1070 struct tty_struct *tty;
1071 unsigned char *data = urb->transfer_buffer;
1072 unsigned long flags;
1073 char tty_flag = TTY_NORMAL;
1078 int status = urb->status;
1081 case 0: /* success */
1086 /* precursor to disconnect so just go away */
1089 /* Can't call usb_clear_halt while in_interrupt */
1092 /* something ugly is going on... */
1093 dev_err(dev, "%s - unexpected nonzero read status received: %d\n",
1095 cypress_set_dead(port);
1099 spin_lock_irqsave(&priv->lock, flags);
1100 if (priv->rx_flags & THROTTLED) {
1101 dev_dbg(dev, "%s - now throttling\n", __func__);
1102 priv->rx_flags |= ACTUALLY_THROTTLED;
1103 spin_unlock_irqrestore(&priv->lock, flags);
1106 spin_unlock_irqrestore(&priv->lock, flags);
1108 tty = tty_port_tty_get(&port->port);
1110 dev_dbg(dev, "%s - bad tty pointer - exiting\n", __func__);
1114 spin_lock_irqsave(&priv->lock, flags);
1115 result = urb->actual_length;
1116 switch (priv->pkt_fmt) {
1118 case packet_format_1:
1119 /* This is for the CY7C64013... */
1120 priv->current_status = data[0] & 0xF8;
1121 bytes = data[1] + 2;
1126 case packet_format_2:
1127 /* This is for the CY7C63743... */
1128 priv->current_status = data[0] & 0xF8;
1129 bytes = (data[0] & 0x07) + 1;
1135 spin_unlock_irqrestore(&priv->lock, flags);
1136 if (result < bytes) {
1138 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1139 __func__, result, bytes);
1143 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1145 spin_lock_irqsave(&priv->lock, flags);
1146 /* check to see if status has changed */
1147 if (priv->current_status != priv->prev_status) {
1148 u8 delta = priv->current_status ^ priv->prev_status;
1150 if (delta & UART_MSR_MASK) {
1151 if (delta & UART_CTS)
1153 if (delta & UART_DSR)
1155 if (delta & UART_RI)
1157 if (delta & UART_CD)
1160 wake_up_interruptible(&port->port.delta_msr_wait);
1163 priv->prev_status = priv->current_status;
1165 spin_unlock_irqrestore(&priv->lock, flags);
1167 /* hangup, as defined in acm.c... this might be a bad place for it
1169 if (tty && !(tty->termios.c_cflag & CLOCAL) &&
1170 !(priv->current_status & UART_CD)) {
1171 dev_dbg(dev, "%s - calling hangup\n", __func__);
1176 /* There is one error bit... I'm assuming it is a parity error
1177 * indicator as the generic firmware will set this bit to 1 if a
1178 * parity error occurs.
1179 * I can not find reference to any other error events. */
1180 spin_lock_irqsave(&priv->lock, flags);
1181 if (priv->current_status & CYP_ERROR) {
1182 spin_unlock_irqrestore(&priv->lock, flags);
1183 tty_flag = TTY_PARITY;
1184 dev_dbg(dev, "%s - Parity Error detected\n", __func__);
1186 spin_unlock_irqrestore(&priv->lock, flags);
1188 /* process read if there is data other than line status */
1190 tty_insert_flip_string_fixed_flag(&port->port, data + i,
1191 tty_flag, bytes - i);
1192 tty_flip_buffer_push(&port->port);
1195 spin_lock_irqsave(&priv->lock, flags);
1196 /* control and status byte(s) are also counted */
1197 priv->bytes_in += bytes;
1198 spin_unlock_irqrestore(&priv->lock, flags);
1203 /* Continue trying to always read */
1205 if (priv->comm_is_ok) {
1206 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1207 usb_rcvintpipe(port->serial->dev,
1208 port->interrupt_in_endpointAddress),
1209 port->interrupt_in_urb->transfer_buffer,
1210 port->interrupt_in_urb->transfer_buffer_length,
1211 cypress_read_int_callback, port,
1212 priv->read_urb_interval);
1213 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1214 if (result && result != -EPERM) {
1215 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
1217 cypress_set_dead(port);
1220 } /* cypress_read_int_callback */
1223 static void cypress_write_int_callback(struct urb *urb)
1225 struct usb_serial_port *port = urb->context;
1226 struct cypress_private *priv = usb_get_serial_port_data(port);
1227 struct device *dev = &urb->dev->dev;
1228 int status = urb->status;
1237 /* this urb is terminated, clean up */
1238 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1240 priv->write_urb_in_use = 0;
1243 /* Cannot call usb_clear_halt while in_interrupt */
1246 dev_err(dev, "%s - unexpected nonzero write status received: %d\n",
1248 cypress_set_dead(port);
1251 priv->write_urb_in_use = 0;
1253 /* send any buffered data */
1257 module_usb_serial_driver(serial_drivers, id_table_combined);
1259 MODULE_AUTHOR(DRIVER_AUTHOR);
1260 MODULE_DESCRIPTION(DRIVER_DESC);
1261 MODULE_LICENSE("GPL");
1263 module_param(stats, bool, S_IRUGO | S_IWUSR);
1264 MODULE_PARM_DESC(stats, "Enable statistics or not");
1265 module_param(interval, int, S_IRUGO | S_IWUSR);
1266 MODULE_PARM_DESC(interval, "Overrides interrupt interval");
1267 module_param(unstable_bauds, bool, S_IRUGO | S_IWUSR);
1268 MODULE_PARM_DESC(unstable_bauds, "Allow unstable baud rates");