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"
52 static bool unstable_bauds;
57 #define DRIVER_VERSION "v1.10"
58 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
59 #define DRIVER_DESC "Cypress USB to Serial Driver"
61 /* write buffer size defines */
62 #define CYPRESS_BUF_SIZE 1024
64 static const struct usb_device_id id_table_earthmate[] = {
65 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
66 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
67 { } /* Terminating entry */
70 static const struct usb_device_id id_table_cyphidcomrs232[] = {
71 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
72 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
73 { } /* Terminating entry */
76 static const struct usb_device_id id_table_nokiaca42v2[] = {
77 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
78 { } /* Terminating entry */
81 static const struct usb_device_id id_table_combined[] = {
82 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
83 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
84 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
85 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
86 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
87 { } /* Terminating entry */
90 MODULE_DEVICE_TABLE(usb, id_table_combined);
93 packet_format_1, /* b0:status, b1:payload count */
94 packet_format_2 /* b0[7:3]:status, b0[2:0]:payload count */
97 struct cypress_private {
98 spinlock_t lock; /* private lock */
99 int chiptype; /* identifier of device, for quirks/etc */
100 int bytes_in; /* used for statistics */
101 int bytes_out; /* used for statistics */
102 int cmd_count; /* used for statistics */
103 int cmd_ctrl; /* always set this to 1 before issuing a command */
104 struct kfifo write_fifo; /* write fifo */
105 int write_urb_in_use; /* write urb in use indicator */
106 int write_urb_interval; /* interval to use for write urb */
107 int read_urb_interval; /* interval to use for read urb */
108 int comm_is_ok; /* true if communication is (still) ok */
109 int termios_initialized;
110 __u8 line_control; /* holds dtr / rts value */
111 __u8 current_status; /* received from last read - info on dsr,cts,cd,ri,etc */
112 __u8 current_config; /* stores the current configuration byte */
113 __u8 rx_flags; /* throttling - used from whiteheat/ftdi_sio */
114 enum packet_format pkt_fmt; /* format to use for packet send / receive */
115 int get_cfg_unsafe; /* If true, the CYPRESS_GET_CONFIG is unsafe */
116 int baud_rate; /* stores current baud rate in
118 int isthrottled; /* if throttled, discard reads */
119 wait_queue_head_t delta_msr_wait; /* used for TIOCMIWAIT */
120 char prev_status, diff_status; /* used for TIOCMIWAIT */
121 /* we pass a pointer to this as the argument sent to
122 cypress_set_termios old_termios */
123 struct ktermios tmp_termios; /* stores the old termios settings */
126 /* function prototypes for the Cypress USB to serial device */
127 static int cypress_earthmate_startup(struct usb_serial *serial);
128 static int cypress_hidcom_startup(struct usb_serial *serial);
129 static int cypress_ca42v2_startup(struct usb_serial *serial);
130 static void cypress_release(struct usb_serial *serial);
131 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port);
132 static void cypress_close(struct usb_serial_port *port);
133 static void cypress_dtr_rts(struct usb_serial_port *port, int on);
134 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
135 const unsigned char *buf, int count);
136 static void cypress_send(struct usb_serial_port *port);
137 static int cypress_write_room(struct tty_struct *tty);
138 static int cypress_ioctl(struct tty_struct *tty,
139 unsigned int cmd, unsigned long arg);
140 static void cypress_set_termios(struct tty_struct *tty,
141 struct usb_serial_port *port, struct ktermios *old);
142 static int cypress_tiocmget(struct tty_struct *tty);
143 static int cypress_tiocmset(struct tty_struct *tty,
144 unsigned int set, unsigned int clear);
145 static int cypress_chars_in_buffer(struct tty_struct *tty);
146 static void cypress_throttle(struct tty_struct *tty);
147 static void cypress_unthrottle(struct tty_struct *tty);
148 static void cypress_set_dead(struct usb_serial_port *port);
149 static void cypress_read_int_callback(struct urb *urb);
150 static void cypress_write_int_callback(struct urb *urb);
152 static struct usb_serial_driver cypress_earthmate_device = {
154 .owner = THIS_MODULE,
157 .description = "DeLorme Earthmate USB",
158 .id_table = id_table_earthmate,
160 .attach = cypress_earthmate_startup,
161 .release = cypress_release,
162 .open = cypress_open,
163 .close = cypress_close,
164 .dtr_rts = cypress_dtr_rts,
165 .write = cypress_write,
166 .write_room = cypress_write_room,
167 .ioctl = cypress_ioctl,
168 .set_termios = cypress_set_termios,
169 .tiocmget = cypress_tiocmget,
170 .tiocmset = cypress_tiocmset,
171 .chars_in_buffer = cypress_chars_in_buffer,
172 .throttle = cypress_throttle,
173 .unthrottle = cypress_unthrottle,
174 .read_int_callback = cypress_read_int_callback,
175 .write_int_callback = cypress_write_int_callback,
178 static struct usb_serial_driver cypress_hidcom_device = {
180 .owner = THIS_MODULE,
183 .description = "HID->COM RS232 Adapter",
184 .id_table = id_table_cyphidcomrs232,
186 .attach = cypress_hidcom_startup,
187 .release = cypress_release,
188 .open = cypress_open,
189 .close = cypress_close,
190 .dtr_rts = cypress_dtr_rts,
191 .write = cypress_write,
192 .write_room = cypress_write_room,
193 .ioctl = cypress_ioctl,
194 .set_termios = cypress_set_termios,
195 .tiocmget = cypress_tiocmget,
196 .tiocmset = cypress_tiocmset,
197 .chars_in_buffer = cypress_chars_in_buffer,
198 .throttle = cypress_throttle,
199 .unthrottle = cypress_unthrottle,
200 .read_int_callback = cypress_read_int_callback,
201 .write_int_callback = cypress_write_int_callback,
204 static struct usb_serial_driver cypress_ca42v2_device = {
206 .owner = THIS_MODULE,
207 .name = "nokiaca42v2",
209 .description = "Nokia CA-42 V2 Adapter",
210 .id_table = id_table_nokiaca42v2,
212 .attach = cypress_ca42v2_startup,
213 .release = cypress_release,
214 .open = cypress_open,
215 .close = cypress_close,
216 .dtr_rts = cypress_dtr_rts,
217 .write = cypress_write,
218 .write_room = cypress_write_room,
219 .ioctl = cypress_ioctl,
220 .set_termios = cypress_set_termios,
221 .tiocmget = cypress_tiocmget,
222 .tiocmset = cypress_tiocmset,
223 .chars_in_buffer = cypress_chars_in_buffer,
224 .throttle = cypress_throttle,
225 .unthrottle = cypress_unthrottle,
226 .read_int_callback = cypress_read_int_callback,
227 .write_int_callback = cypress_write_int_callback,
230 static struct usb_serial_driver * const serial_drivers[] = {
231 &cypress_earthmate_device, &cypress_hidcom_device,
232 &cypress_ca42v2_device, NULL
235 /*****************************************************************************
236 * Cypress serial helper functions
237 *****************************************************************************/
240 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
242 struct cypress_private *priv;
243 priv = usb_get_serial_port_data(port);
249 * The general purpose firmware for the Cypress M8 allows for
250 * a maximum speed of 57600bps (I have no idea whether DeLorme
251 * chose to use the general purpose firmware or not), if you
252 * need to modify this speed setting for your own project
253 * please add your own chiptype and modify the code likewise.
254 * The Cypress HID->COM device will work successfully up to
255 * 115200bps (but the actual throughput is around 3kBps).
257 if (port->serial->dev->speed == USB_SPEED_LOW) {
259 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
260 * Cypress app note that describes this mechanism
261 * states the the low-speed part can't handle more
262 * than 800 bytes/sec, in which case 4800 baud is the
263 * safest speed for a part like that.
265 if (new_rate > 4800) {
267 "%s - failed setting baud rate, device incapable speed %d\n",
272 switch (priv->chiptype) {
274 if (new_rate <= 600) {
275 /* 300 and 600 baud rates are supported under
276 * the generic firmware, but are not used with
277 * NMEA and SiRF protocols */
279 "%s - failed setting baud rate, unsupported speed of %d on Earthmate GPS",
291 /* This function can either set or retrieve the current serial line settings */
292 static int cypress_serial_control(struct tty_struct *tty,
293 struct usb_serial_port *port, speed_t baud_rate, int data_bits,
294 int stop_bits, int parity_enable, int parity_type, int reset,
295 int cypress_request_type)
297 int new_baudrate = 0, retval = 0, tries = 0;
298 struct cypress_private *priv;
299 struct device *dev = &port->dev;
301 const unsigned int feature_len = 5;
304 priv = usb_get_serial_port_data(port);
306 if (!priv->comm_is_ok)
309 feature_buffer = kcalloc(feature_len, sizeof(u8), GFP_KERNEL);
313 switch (cypress_request_type) {
314 case CYPRESS_SET_CONFIG:
315 /* 0 means 'Hang up' so doesn't change the true bit rate */
316 new_baudrate = priv->baud_rate;
317 if (baud_rate && baud_rate != priv->baud_rate) {
318 dev_dbg(dev, "%s - baud rate is changing\n", __func__);
319 retval = analyze_baud_rate(port, baud_rate);
321 new_baudrate = retval;
322 dev_dbg(dev, "%s - New baud rate set to %d\n",
323 __func__, new_baudrate);
326 dev_dbg(dev, "%s - baud rate is being sent as %d\n", __func__,
329 /* fill the feature_buffer with new configuration */
330 put_unaligned_le32(new_baudrate, feature_buffer);
331 feature_buffer[4] |= data_bits; /* assign data bits in 2 bit space ( max 3 ) */
333 feature_buffer[4] |= (stop_bits << 3); /* assign stop bits in 1 bit space */
334 feature_buffer[4] |= (parity_enable << 4); /* assign parity flag in 1 bit space */
335 feature_buffer[4] |= (parity_type << 5); /* assign parity type in 1 bit space */
337 feature_buffer[4] |= (reset << 7); /* assign reset at end of byte, 1 bit space */
339 dev_dbg(dev, "%s - device is being sent this feature report:\n", __func__);
340 dev_dbg(dev, "%s - %02X - %02X - %02X - %02X - %02X\n", __func__,
341 feature_buffer[0], feature_buffer[1],
342 feature_buffer[2], feature_buffer[3],
346 retval = usb_control_msg(port->serial->dev,
347 usb_sndctrlpipe(port->serial->dev, 0),
349 USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
350 0x0300, 0, feature_buffer,
356 } while (retval != feature_len &&
359 if (retval != feature_len) {
360 dev_err(dev, "%s - failed sending serial line settings - %d\n",
362 cypress_set_dead(port);
364 spin_lock_irqsave(&priv->lock, flags);
365 priv->baud_rate = new_baudrate;
366 priv->current_config = feature_buffer[4];
367 spin_unlock_irqrestore(&priv->lock, flags);
368 /* If we asked for a speed change encode it */
370 tty_encode_baud_rate(tty,
371 new_baudrate, new_baudrate);
374 case CYPRESS_GET_CONFIG:
375 if (priv->get_cfg_unsafe) {
376 /* Not implemented for this device,
377 and if we try to do it we're likely
378 to crash the hardware. */
382 dev_dbg(dev, "%s - retreiving serial line settings\n", __func__);
384 retval = usb_control_msg(port->serial->dev,
385 usb_rcvctrlpipe(port->serial->dev, 0),
387 USB_DIR_IN | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
388 0x0300, 0, feature_buffer,
393 } while (retval != feature_len
394 && retval != -ENODEV);
396 if (retval != feature_len) {
397 dev_err(dev, "%s - failed to retrieve serial line settings - %d\n",
399 cypress_set_dead(port);
402 spin_lock_irqsave(&priv->lock, flags);
403 /* store the config in one byte, and later
404 use bit masks to check values */
405 priv->current_config = feature_buffer[4];
406 priv->baud_rate = get_unaligned_le32(feature_buffer);
407 spin_unlock_irqrestore(&priv->lock, flags);
410 spin_lock_irqsave(&priv->lock, flags);
412 spin_unlock_irqrestore(&priv->lock, flags);
414 kfree(feature_buffer);
416 } /* cypress_serial_control */
419 static void cypress_set_dead(struct usb_serial_port *port)
421 struct cypress_private *priv = usb_get_serial_port_data(port);
424 spin_lock_irqsave(&priv->lock, flags);
425 if (!priv->comm_is_ok) {
426 spin_unlock_irqrestore(&priv->lock, flags);
429 priv->comm_is_ok = 0;
430 spin_unlock_irqrestore(&priv->lock, flags);
432 dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
433 "interval might be too short\n", port->number);
437 /*****************************************************************************
438 * Cypress serial driver functions
439 *****************************************************************************/
442 static int generic_startup(struct usb_serial *serial)
444 struct cypress_private *priv;
445 struct usb_serial_port *port = serial->port[0];
447 priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
451 priv->comm_is_ok = !0;
452 spin_lock_init(&priv->lock);
453 if (kfifo_alloc(&priv->write_fifo, CYPRESS_BUF_SIZE, GFP_KERNEL)) {
457 init_waitqueue_head(&priv->delta_msr_wait);
459 usb_reset_configuration(serial->dev);
462 priv->line_control = 0;
463 priv->termios_initialized = 0;
465 /* Default packet format setting is determined by packet size.
466 Anything with a size larger then 9 must have a separate
467 count field since the 3 bit count field is otherwise too
468 small. Otherwise we can use the slightly more compact
469 format. This is in accordance with the cypress_m8 serial
470 converter app note. */
471 if (port->interrupt_out_size > 9)
472 priv->pkt_fmt = packet_format_1;
474 priv->pkt_fmt = packet_format_2;
477 priv->write_urb_interval = interval;
478 priv->read_urb_interval = interval;
479 dev_dbg(&port->dev, "%s - read & write intervals forced to %d\n",
482 priv->write_urb_interval = port->interrupt_out_urb->interval;
483 priv->read_urb_interval = port->interrupt_in_urb->interval;
484 dev_dbg(&port->dev, "%s - intervals: read=%d write=%d\n",
485 __func__, priv->read_urb_interval,
486 priv->write_urb_interval);
488 usb_set_serial_port_data(port, priv);
494 static int cypress_earthmate_startup(struct usb_serial *serial)
496 struct cypress_private *priv;
497 struct usb_serial_port *port = serial->port[0];
499 if (generic_startup(serial)) {
500 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
504 priv = usb_get_serial_port_data(port);
505 priv->chiptype = CT_EARTHMATE;
506 /* All Earthmate devices use the separated-count packet
508 priv->pkt_fmt = packet_format_1;
509 if (serial->dev->descriptor.idProduct !=
510 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB)) {
511 /* The old original USB Earthmate seemed able to
512 handle GET_CONFIG requests; everything they've
513 produced since that time crashes if this command is
516 "%s - Marking this device as unsafe for GET_CONFIG commands\n",
518 priv->get_cfg_unsafe = !0;
522 } /* cypress_earthmate_startup */
525 static int cypress_hidcom_startup(struct usb_serial *serial)
527 struct cypress_private *priv;
528 struct usb_serial_port *port = serial->port[0];
530 if (generic_startup(serial)) {
531 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
535 priv = usb_get_serial_port_data(port);
536 priv->chiptype = CT_CYPHIDCOM;
539 } /* cypress_hidcom_startup */
542 static int cypress_ca42v2_startup(struct usb_serial *serial)
544 struct cypress_private *priv;
545 struct usb_serial_port *port = serial->port[0];
547 if (generic_startup(serial)) {
548 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
552 priv = usb_get_serial_port_data(port);
553 priv->chiptype = CT_CA42V2;
556 } /* cypress_ca42v2_startup */
559 static void cypress_release(struct usb_serial *serial)
561 struct cypress_private *priv;
563 /* all open ports are closed at this point */
564 priv = usb_get_serial_port_data(serial->port[0]);
567 kfifo_free(&priv->write_fifo);
573 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port)
575 struct cypress_private *priv = usb_get_serial_port_data(port);
576 struct usb_serial *serial = port->serial;
580 if (!priv->comm_is_ok)
583 /* clear halts before open */
584 usb_clear_halt(serial->dev, 0x81);
585 usb_clear_halt(serial->dev, 0x02);
587 spin_lock_irqsave(&priv->lock, flags);
588 /* reset read/write statistics */
593 spin_unlock_irqrestore(&priv->lock, flags);
599 cypress_set_termios(tty, port, &priv->tmp_termios);
601 /* setup the port and start reading from the device */
602 if (!port->interrupt_in_urb) {
603 dev_err(&port->dev, "%s - interrupt_in_urb is empty!\n",
608 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
609 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
610 port->interrupt_in_urb->transfer_buffer,
611 port->interrupt_in_urb->transfer_buffer_length,
612 cypress_read_int_callback, port, priv->read_urb_interval);
613 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
617 "%s - failed submitting read urb, error %d\n",
619 cypress_set_dead(port);
621 port->port.drain_delay = 256;
625 static void cypress_dtr_rts(struct usb_serial_port *port, int on)
627 struct cypress_private *priv = usb_get_serial_port_data(port);
628 /* drop dtr and rts */
629 spin_lock_irq(&priv->lock);
631 priv->line_control = 0;
633 priv->line_control = CONTROL_DTR | CONTROL_RTS;
635 spin_unlock_irq(&priv->lock);
636 cypress_write(NULL, port, NULL, 0);
639 static void cypress_close(struct usb_serial_port *port)
641 struct cypress_private *priv = usb_get_serial_port_data(port);
644 /* writing is potentially harmful, lock must be taken */
645 mutex_lock(&port->serial->disc_mutex);
646 if (port->serial->disconnected) {
647 mutex_unlock(&port->serial->disc_mutex);
650 spin_lock_irqsave(&priv->lock, flags);
651 kfifo_reset_out(&priv->write_fifo);
652 spin_unlock_irqrestore(&priv->lock, flags);
654 dev_dbg(&port->dev, "%s - stopping urbs\n", __func__);
655 usb_kill_urb(port->interrupt_in_urb);
656 usb_kill_urb(port->interrupt_out_urb);
659 dev_info(&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
660 priv->bytes_in, priv->bytes_out, priv->cmd_count);
661 mutex_unlock(&port->serial->disc_mutex);
662 } /* cypress_close */
665 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
666 const unsigned char *buf, int count)
668 struct cypress_private *priv = usb_get_serial_port_data(port);
670 dev_dbg(&port->dev, "%s - port %d, %d bytes\n", __func__, port->number, count);
672 /* line control commands, which need to be executed immediately,
673 are not put into the buffer for obvious reasons.
675 if (priv->cmd_ctrl) {
683 count = kfifo_in_locked(&priv->write_fifo, buf, count, &priv->lock);
689 } /* cypress_write */
692 static void cypress_send(struct usb_serial_port *port)
694 int count = 0, result, offset, actual_size;
695 struct cypress_private *priv = usb_get_serial_port_data(port);
696 struct device *dev = &port->dev;
699 if (!priv->comm_is_ok)
702 dev_dbg(dev, "%s - interrupt out size is %d\n", __func__,
703 port->interrupt_out_size);
705 spin_lock_irqsave(&priv->lock, flags);
706 if (priv->write_urb_in_use) {
707 dev_dbg(dev, "%s - can't write, urb in use\n", __func__);
708 spin_unlock_irqrestore(&priv->lock, flags);
711 spin_unlock_irqrestore(&priv->lock, flags);
714 memset(port->interrupt_out_urb->transfer_buffer, 0,
715 port->interrupt_out_size);
717 spin_lock_irqsave(&priv->lock, flags);
718 switch (priv->pkt_fmt) {
720 case packet_format_1:
721 /* this is for the CY7C64013... */
723 port->interrupt_out_buffer[0] = priv->line_control;
725 case packet_format_2:
726 /* this is for the CY7C63743... */
728 port->interrupt_out_buffer[0] = priv->line_control;
732 if (priv->line_control & CONTROL_RESET)
733 priv->line_control &= ~CONTROL_RESET;
735 if (priv->cmd_ctrl) {
737 dev_dbg(dev, "%s - line control command being issued\n", __func__);
738 spin_unlock_irqrestore(&priv->lock, flags);
741 spin_unlock_irqrestore(&priv->lock, flags);
743 count = kfifo_out_locked(&priv->write_fifo,
744 &port->interrupt_out_buffer[offset],
745 port->interrupt_out_size - offset,
750 switch (priv->pkt_fmt) {
752 case packet_format_1:
753 port->interrupt_out_buffer[1] = count;
755 case packet_format_2:
756 port->interrupt_out_buffer[0] |= count;
759 dev_dbg(dev, "%s - count is %d\n", __func__, count);
762 spin_lock_irqsave(&priv->lock, flags);
763 priv->write_urb_in_use = 1;
764 spin_unlock_irqrestore(&priv->lock, flags);
769 actual_size = count +
770 (priv->pkt_fmt == packet_format_1 ? 2 : 1);
772 usb_serial_debug_data(dev, __func__, port->interrupt_out_size,
773 port->interrupt_out_urb->transfer_buffer);
775 usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
776 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
777 port->interrupt_out_buffer, port->interrupt_out_size,
778 cypress_write_int_callback, port, priv->write_urb_interval);
779 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
781 dev_err_console(port,
782 "%s - failed submitting write urb, error %d\n",
784 priv->write_urb_in_use = 0;
785 cypress_set_dead(port);
788 spin_lock_irqsave(&priv->lock, flags);
792 /* do not count the line control and size bytes */
793 priv->bytes_out += count;
794 spin_unlock_irqrestore(&priv->lock, flags);
796 usb_serial_port_softint(port);
800 /* returns how much space is available in the soft buffer */
801 static int cypress_write_room(struct tty_struct *tty)
803 struct usb_serial_port *port = tty->driver_data;
804 struct cypress_private *priv = usb_get_serial_port_data(port);
808 spin_lock_irqsave(&priv->lock, flags);
809 room = kfifo_avail(&priv->write_fifo);
810 spin_unlock_irqrestore(&priv->lock, flags);
812 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
817 static int cypress_tiocmget(struct tty_struct *tty)
819 struct usb_serial_port *port = tty->driver_data;
820 struct cypress_private *priv = usb_get_serial_port_data(port);
821 __u8 status, control;
822 unsigned int result = 0;
825 spin_lock_irqsave(&priv->lock, flags);
826 control = priv->line_control;
827 status = priv->current_status;
828 spin_unlock_irqrestore(&priv->lock, flags);
830 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
831 | ((control & CONTROL_RTS) ? TIOCM_RTS : 0)
832 | ((status & UART_CTS) ? TIOCM_CTS : 0)
833 | ((status & UART_DSR) ? TIOCM_DSR : 0)
834 | ((status & UART_RI) ? TIOCM_RI : 0)
835 | ((status & UART_CD) ? TIOCM_CD : 0);
837 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
843 static int cypress_tiocmset(struct tty_struct *tty,
844 unsigned int set, unsigned int clear)
846 struct usb_serial_port *port = tty->driver_data;
847 struct cypress_private *priv = usb_get_serial_port_data(port);
850 spin_lock_irqsave(&priv->lock, flags);
852 priv->line_control |= CONTROL_RTS;
854 priv->line_control |= CONTROL_DTR;
855 if (clear & TIOCM_RTS)
856 priv->line_control &= ~CONTROL_RTS;
857 if (clear & TIOCM_DTR)
858 priv->line_control &= ~CONTROL_DTR;
860 spin_unlock_irqrestore(&priv->lock, flags);
862 return cypress_write(tty, port, NULL, 0);
866 static int cypress_ioctl(struct tty_struct *tty,
867 unsigned int cmd, unsigned long arg)
869 struct usb_serial_port *port = tty->driver_data;
870 struct cypress_private *priv = usb_get_serial_port_data(port);
872 dev_dbg(&port->dev, "%s - port %d, cmd 0x%.4x\n", __func__, port->number, cmd);
875 /* This code comes from drivers/char/serial.c and ftdi_sio.c */
877 while (priv != NULL) {
878 interruptible_sleep_on(&priv->delta_msr_wait);
879 /* see if a signal did it */
880 if (signal_pending(current))
883 char diff = priv->diff_status;
885 return -EIO; /* no change => error */
887 /* consume all events */
888 priv->diff_status = 0;
890 /* return 0 if caller wanted to know about
892 if (((arg & TIOCM_RNG) && (diff & UART_RI)) ||
893 ((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
894 ((arg & TIOCM_CD) && (diff & UART_CD)) ||
895 ((arg & TIOCM_CTS) && (diff & UART_CTS)))
897 /* otherwise caller can't care less about what
898 * happened, and so we continue to wait for
907 dev_dbg(&port->dev, "%s - arg not supported - it was 0x%04x - check include/asm/ioctls.h\n", __func__, cmd);
909 } /* cypress_ioctl */
912 static void cypress_set_termios(struct tty_struct *tty,
913 struct usb_serial_port *port, struct ktermios *old_termios)
915 struct cypress_private *priv = usb_get_serial_port_data(port);
916 struct device *dev = &port->dev;
917 int data_bits, stop_bits, parity_type, parity_enable;
918 unsigned cflag, iflag;
923 spin_lock_irqsave(&priv->lock, flags);
924 /* We can't clean this one up as we don't know the device type
926 if (!priv->termios_initialized) {
927 if (priv->chiptype == CT_EARTHMATE) {
928 *(tty->termios) = tty_std_termios;
929 tty->termios->c_cflag = B4800 | CS8 | CREAD | HUPCL |
931 tty->termios->c_ispeed = 4800;
932 tty->termios->c_ospeed = 4800;
933 } else if (priv->chiptype == CT_CYPHIDCOM) {
934 *(tty->termios) = tty_std_termios;
935 tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
937 tty->termios->c_ispeed = 9600;
938 tty->termios->c_ospeed = 9600;
939 } else if (priv->chiptype == CT_CA42V2) {
940 *(tty->termios) = tty_std_termios;
941 tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
943 tty->termios->c_ispeed = 9600;
944 tty->termios->c_ospeed = 9600;
946 priv->termios_initialized = 1;
948 spin_unlock_irqrestore(&priv->lock, flags);
950 /* Unsupported features need clearing */
951 tty->termios->c_cflag &= ~(CMSPAR|CRTSCTS);
953 cflag = tty->termios->c_cflag;
954 iflag = tty->termios->c_iflag;
956 /* check if there are new settings */
958 spin_lock_irqsave(&priv->lock, flags);
959 priv->tmp_termios = *(tty->termios);
960 spin_unlock_irqrestore(&priv->lock, flags);
963 /* set number of data bits, parity, stop bits */
964 /* when parity is disabled the parity type bit is ignored */
966 /* 1 means 2 stop bits, 0 means 1 stop bit */
967 stop_bits = cflag & CSTOPB ? 1 : 0;
969 if (cflag & PARENB) {
971 /* 1 means odd parity, 0 means even parity */
972 parity_type = cflag & PARODD ? 1 : 0;
974 parity_enable = parity_type = 0;
976 switch (cflag & CSIZE) {
990 dev_err(dev, "%s - CSIZE was set, but not CS5-CS8\n", __func__);
993 spin_lock_irqsave(&priv->lock, flags);
994 oldlines = priv->line_control;
995 if ((cflag & CBAUD) == B0) {
996 /* drop dtr and rts */
997 dev_dbg(dev, "%s - dropping the lines, baud rate 0bps\n", __func__);
998 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
1000 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
1001 spin_unlock_irqrestore(&priv->lock, flags);
1003 dev_dbg(dev, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
1004 __func__, stop_bits, parity_enable, parity_type, data_bits);
1006 cypress_serial_control(tty, port, tty_get_baud_rate(tty),
1007 data_bits, stop_bits,
1008 parity_enable, parity_type,
1009 0, CYPRESS_SET_CONFIG);
1011 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1012 * filled into the private structure this should confirm that all is
1013 * working if it returns what we just set */
1014 cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
1016 /* Here we can define custom tty settings for devices; the main tty
1017 * termios flag base comes from empeg.c */
1019 spin_lock_irqsave(&priv->lock, flags);
1020 if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
1021 dev_dbg(dev, "Using custom termios settings for a baud rate of 4800bps.\n");
1022 /* define custom termios settings for NMEA protocol */
1024 tty->termios->c_iflag /* input modes - */
1025 &= ~(IGNBRK /* disable ignore break */
1026 | BRKINT /* disable break causes interrupt */
1027 | PARMRK /* disable mark parity errors */
1028 | ISTRIP /* disable clear high bit of input char */
1029 | INLCR /* disable translate NL to CR */
1030 | IGNCR /* disable ignore CR */
1031 | ICRNL /* disable translate CR to NL */
1032 | IXON); /* disable enable XON/XOFF flow control */
1034 tty->termios->c_oflag /* output modes */
1035 &= ~OPOST; /* disable postprocess output char */
1037 tty->termios->c_lflag /* line discipline modes */
1038 &= ~(ECHO /* disable echo input characters */
1039 | ECHONL /* disable echo new line */
1040 | ICANON /* disable erase, kill, werase, and rprnt
1041 special characters */
1042 | ISIG /* disable interrupt, quit, and suspend
1043 special characters */
1044 | IEXTEN); /* disable non-POSIX special characters */
1045 } /* CT_CYPHIDCOM: Application should handle this for device */
1047 linechange = (priv->line_control != oldlines);
1048 spin_unlock_irqrestore(&priv->lock, flags);
1050 /* if necessary, set lines */
1053 cypress_write(tty, port, NULL, 0);
1055 } /* cypress_set_termios */
1058 /* returns amount of data still left in soft buffer */
1059 static int cypress_chars_in_buffer(struct tty_struct *tty)
1061 struct usb_serial_port *port = tty->driver_data;
1062 struct cypress_private *priv = usb_get_serial_port_data(port);
1064 unsigned long flags;
1066 spin_lock_irqsave(&priv->lock, flags);
1067 chars = kfifo_len(&priv->write_fifo);
1068 spin_unlock_irqrestore(&priv->lock, flags);
1070 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1075 static void cypress_throttle(struct tty_struct *tty)
1077 struct usb_serial_port *port = tty->driver_data;
1078 struct cypress_private *priv = usb_get_serial_port_data(port);
1080 spin_lock_irq(&priv->lock);
1081 priv->rx_flags = THROTTLED;
1082 spin_unlock_irq(&priv->lock);
1086 static void cypress_unthrottle(struct tty_struct *tty)
1088 struct usb_serial_port *port = tty->driver_data;
1089 struct cypress_private *priv = usb_get_serial_port_data(port);
1090 int actually_throttled, result;
1092 spin_lock_irq(&priv->lock);
1093 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1095 spin_unlock_irq(&priv->lock);
1097 if (!priv->comm_is_ok)
1100 if (actually_throttled) {
1101 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1103 dev_err(&port->dev, "%s - failed submitting read urb, "
1104 "error %d\n", __func__, result);
1105 cypress_set_dead(port);
1111 static void cypress_read_int_callback(struct urb *urb)
1113 struct usb_serial_port *port = urb->context;
1114 struct cypress_private *priv = usb_get_serial_port_data(port);
1115 struct device *dev = &urb->dev->dev;
1116 struct tty_struct *tty;
1117 unsigned char *data = urb->transfer_buffer;
1118 unsigned long flags;
1119 char tty_flag = TTY_NORMAL;
1124 int status = urb->status;
1127 case 0: /* success */
1132 /* precursor to disconnect so just go away */
1135 /* Can't call usb_clear_halt while in_interrupt */
1138 /* something ugly is going on... */
1139 dev_err(dev, "%s - unexpected nonzero read status received: %d\n",
1141 cypress_set_dead(port);
1145 spin_lock_irqsave(&priv->lock, flags);
1146 if (priv->rx_flags & THROTTLED) {
1147 dev_dbg(dev, "%s - now throttling\n", __func__);
1148 priv->rx_flags |= ACTUALLY_THROTTLED;
1149 spin_unlock_irqrestore(&priv->lock, flags);
1152 spin_unlock_irqrestore(&priv->lock, flags);
1154 tty = tty_port_tty_get(&port->port);
1156 dev_dbg(dev, "%s - bad tty pointer - exiting\n", __func__);
1160 spin_lock_irqsave(&priv->lock, flags);
1161 result = urb->actual_length;
1162 switch (priv->pkt_fmt) {
1164 case packet_format_1:
1165 /* This is for the CY7C64013... */
1166 priv->current_status = data[0] & 0xF8;
1167 bytes = data[1] + 2;
1172 case packet_format_2:
1173 /* This is for the CY7C63743... */
1174 priv->current_status = data[0] & 0xF8;
1175 bytes = (data[0] & 0x07) + 1;
1181 spin_unlock_irqrestore(&priv->lock, flags);
1182 if (result < bytes) {
1184 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1185 __func__, result, bytes);
1189 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1191 spin_lock_irqsave(&priv->lock, flags);
1192 /* check to see if status has changed */
1193 if (priv->current_status != priv->prev_status) {
1194 priv->diff_status |= priv->current_status ^
1196 wake_up_interruptible(&priv->delta_msr_wait);
1197 priv->prev_status = priv->current_status;
1199 spin_unlock_irqrestore(&priv->lock, flags);
1201 /* hangup, as defined in acm.c... this might be a bad place for it
1203 if (tty && !(tty->termios->c_cflag & CLOCAL) &&
1204 !(priv->current_status & UART_CD)) {
1205 dev_dbg(dev, "%s - calling hangup\n", __func__);
1210 /* There is one error bit... I'm assuming it is a parity error
1211 * indicator as the generic firmware will set this bit to 1 if a
1212 * parity error occurs.
1213 * I can not find reference to any other error events. */
1214 spin_lock_irqsave(&priv->lock, flags);
1215 if (priv->current_status & CYP_ERROR) {
1216 spin_unlock_irqrestore(&priv->lock, flags);
1217 tty_flag = TTY_PARITY;
1218 dev_dbg(dev, "%s - Parity Error detected\n", __func__);
1220 spin_unlock_irqrestore(&priv->lock, flags);
1222 /* process read if there is data other than line status */
1223 if (tty && bytes > i) {
1224 tty_insert_flip_string_fixed_flag(tty, data + i,
1225 tty_flag, bytes - i);
1226 tty_flip_buffer_push(tty);
1229 spin_lock_irqsave(&priv->lock, flags);
1230 /* control and status byte(s) are also counted */
1231 priv->bytes_in += bytes;
1232 spin_unlock_irqrestore(&priv->lock, flags);
1237 /* Continue trying to always read */
1239 if (priv->comm_is_ok) {
1240 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1241 usb_rcvintpipe(port->serial->dev,
1242 port->interrupt_in_endpointAddress),
1243 port->interrupt_in_urb->transfer_buffer,
1244 port->interrupt_in_urb->transfer_buffer_length,
1245 cypress_read_int_callback, port,
1246 priv->read_urb_interval);
1247 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1248 if (result && result != -EPERM) {
1249 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
1251 cypress_set_dead(port);
1254 } /* cypress_read_int_callback */
1257 static void cypress_write_int_callback(struct urb *urb)
1259 struct usb_serial_port *port = urb->context;
1260 struct cypress_private *priv = usb_get_serial_port_data(port);
1261 struct device *dev = &urb->dev->dev;
1263 int status = urb->status;
1272 /* this urb is terminated, clean up */
1273 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1275 priv->write_urb_in_use = 0;
1277 case -EPIPE: /* no break needed; clear halt and resubmit */
1278 if (!priv->comm_is_ok)
1280 usb_clear_halt(port->serial->dev, 0x02);
1281 /* error in the urb, so we have to resubmit it */
1282 dev_dbg(dev, "%s - nonzero write bulk status received: %d\n",
1284 port->interrupt_out_urb->transfer_buffer_length = 1;
1285 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1288 dev_err(dev, "%s - failed resubmitting write urb, error %d\n",
1290 cypress_set_dead(port);
1293 dev_err(dev, "%s - unexpected nonzero write status received: %d\n",
1295 cypress_set_dead(port);
1298 priv->write_urb_in_use = 0;
1300 /* send any buffered data */
1304 module_usb_serial_driver(serial_drivers, id_table_combined);
1306 MODULE_AUTHOR(DRIVER_AUTHOR);
1307 MODULE_DESCRIPTION(DRIVER_DESC);
1308 MODULE_VERSION(DRIVER_VERSION);
1309 MODULE_LICENSE("GPL");
1311 module_param(debug, bool, S_IRUGO | S_IWUSR);
1312 MODULE_PARM_DESC(debug, "Debug enabled or not");
1313 module_param(stats, bool, S_IRUGO | S_IWUSR);
1314 MODULE_PARM_DESC(stats, "Enable statistics or not");
1315 module_param(interval, int, S_IRUGO | S_IWUSR);
1316 MODULE_PARM_DESC(interval, "Overrides interrupt interval");
1317 module_param(unstable_bauds, bool, S_IRUGO | S_IWUSR);
1318 MODULE_PARM_DESC(unstable_bauds, "Allow unstable baud rates");