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 { 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_POWERCOM
, PRODUCT_ID_UPS
) },
82 { USB_DEVICE(VENDOR_ID_FRWD
, PRODUCT_ID_CYPHIDCOM_FRWD
) },
83 { USB_DEVICE(VENDOR_ID_DAZZLE
, PRODUCT_ID_CA42
) },
84 { } /* Terminating entry */
87 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
90 packet_format_1
, /* b0:status, b1:payload count */
91 packet_format_2
/* b0[7:3]:status, b0[2:0]:payload count */
94 struct cypress_private
{
95 spinlock_t lock
; /* private lock */
96 int chiptype
; /* identifier of device, for quirks/etc */
97 int bytes_in
; /* used for statistics */
98 int bytes_out
; /* used for statistics */
99 int cmd_count
; /* used for statistics */
100 int cmd_ctrl
; /* always set this to 1 before issuing a command */
101 struct kfifo write_fifo
; /* write fifo */
102 int write_urb_in_use
; /* write urb in use indicator */
103 int write_urb_interval
; /* interval to use for write urb */
104 int read_urb_interval
; /* interval to use for read urb */
105 int comm_is_ok
; /* true if communication is (still) ok */
106 int termios_initialized
;
107 __u8 line_control
; /* holds dtr / rts value */
108 __u8 current_status
; /* received from last read - info on dsr,cts,cd,ri,etc */
109 __u8 current_config
; /* stores the current configuration byte */
110 __u8 rx_flags
; /* throttling - used from whiteheat/ftdi_sio */
111 enum packet_format pkt_fmt
; /* format to use for packet send / receive */
112 int get_cfg_unsafe
; /* If true, the CYPRESS_GET_CONFIG is unsafe */
113 int baud_rate
; /* stores current baud rate in
115 int isthrottled
; /* if throttled, discard reads */
116 char prev_status
, diff_status
; /* used for TIOCMIWAIT */
117 /* we pass a pointer to this as the argument sent to
118 cypress_set_termios old_termios */
119 struct ktermios tmp_termios
; /* stores the old termios settings */
122 /* function prototypes for the Cypress USB to serial device */
123 static int cypress_earthmate_port_probe(struct usb_serial_port
*port
);
124 static int cypress_hidcom_port_probe(struct usb_serial_port
*port
);
125 static int cypress_ca42v2_port_probe(struct usb_serial_port
*port
);
126 static int cypress_port_remove(struct usb_serial_port
*port
);
127 static int cypress_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
128 static void cypress_close(struct usb_serial_port
*port
);
129 static void cypress_dtr_rts(struct usb_serial_port
*port
, int on
);
130 static int cypress_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
131 const unsigned char *buf
, int count
);
132 static void cypress_send(struct usb_serial_port
*port
);
133 static int cypress_write_room(struct tty_struct
*tty
);
134 static void cypress_set_termios(struct tty_struct
*tty
,
135 struct usb_serial_port
*port
, struct ktermios
*old
);
136 static int cypress_tiocmget(struct tty_struct
*tty
);
137 static int cypress_tiocmset(struct tty_struct
*tty
,
138 unsigned int set
, unsigned int clear
);
139 static int cypress_tiocmiwait(struct tty_struct
*tty
, unsigned long arg
);
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
= cypress_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
= cypress_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
= cypress_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",
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 priv
= kzalloc(sizeof(struct cypress_private
), GFP_KERNEL
);
456 priv
->comm_is_ok
= !0;
457 spin_lock_init(&priv
->lock
);
458 if (kfifo_alloc(&priv
->write_fifo
, CYPRESS_BUF_SIZE
, GFP_KERNEL
)) {
463 /* Skip reset for FRWD device. It is a workaound:
464 device hangs if it receives SET_CONFIGURE in Configured
466 if (!is_frwd(serial
->dev
))
467 usb_reset_configuration(serial
->dev
);
470 priv
->line_control
= 0;
471 priv
->termios_initialized
= 0;
473 /* Default packet format setting is determined by packet size.
474 Anything with a size larger then 9 must have a separate
475 count field since the 3 bit count field is otherwise too
476 small. Otherwise we can use the slightly more compact
477 format. This is in accordance with the cypress_m8 serial
478 converter app note. */
479 if (port
->interrupt_out_size
> 9)
480 priv
->pkt_fmt
= packet_format_1
;
482 priv
->pkt_fmt
= packet_format_2
;
485 priv
->write_urb_interval
= interval
;
486 priv
->read_urb_interval
= interval
;
487 dev_dbg(&port
->dev
, "%s - read & write intervals forced to %d\n",
490 priv
->write_urb_interval
= port
->interrupt_out_urb
->interval
;
491 priv
->read_urb_interval
= port
->interrupt_in_urb
->interval
;
492 dev_dbg(&port
->dev
, "%s - intervals: read=%d write=%d\n",
493 __func__
, priv
->read_urb_interval
,
494 priv
->write_urb_interval
);
496 usb_set_serial_port_data(port
, priv
);
502 static int cypress_earthmate_port_probe(struct usb_serial_port
*port
)
504 struct usb_serial
*serial
= port
->serial
;
505 struct cypress_private
*priv
;
508 ret
= cypress_generic_port_probe(port
);
510 dev_dbg(&port
->dev
, "%s - Failed setting up port\n", __func__
);
514 priv
= usb_get_serial_port_data(port
);
515 priv
->chiptype
= CT_EARTHMATE
;
516 /* All Earthmate devices use the separated-count packet
518 priv
->pkt_fmt
= packet_format_1
;
519 if (serial
->dev
->descriptor
.idProduct
!=
520 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB
)) {
521 /* The old original USB Earthmate seemed able to
522 handle GET_CONFIG requests; everything they've
523 produced since that time crashes if this command is
526 "%s - Marking this device as unsafe for GET_CONFIG commands\n",
528 priv
->get_cfg_unsafe
= !0;
534 static int cypress_hidcom_port_probe(struct usb_serial_port
*port
)
536 struct cypress_private
*priv
;
539 ret
= cypress_generic_port_probe(port
);
541 dev_dbg(&port
->dev
, "%s - Failed setting up port\n", __func__
);
545 priv
= usb_get_serial_port_data(port
);
546 priv
->chiptype
= CT_CYPHIDCOM
;
551 static int cypress_ca42v2_port_probe(struct usb_serial_port
*port
)
553 struct cypress_private
*priv
;
556 ret
= cypress_generic_port_probe(port
);
558 dev_dbg(&port
->dev
, "%s - Failed setting up port\n", __func__
);
562 priv
= usb_get_serial_port_data(port
);
563 priv
->chiptype
= CT_CA42V2
;
568 static int cypress_port_remove(struct usb_serial_port
*port
)
570 struct cypress_private
*priv
;
572 priv
= usb_get_serial_port_data(port
);
574 kfifo_free(&priv
->write_fifo
);
580 static int cypress_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
582 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
583 struct usb_serial
*serial
= port
->serial
;
587 if (!priv
->comm_is_ok
)
590 /* clear halts before open */
591 usb_clear_halt(serial
->dev
, 0x81);
592 usb_clear_halt(serial
->dev
, 0x02);
594 spin_lock_irqsave(&priv
->lock
, flags
);
595 /* reset read/write statistics */
600 spin_unlock_irqrestore(&priv
->lock
, flags
);
606 cypress_set_termios(tty
, port
, &priv
->tmp_termios
);
608 /* setup the port and start reading from the device */
609 if (!port
->interrupt_in_urb
) {
610 dev_err(&port
->dev
, "%s - interrupt_in_urb is empty!\n",
615 usb_fill_int_urb(port
->interrupt_in_urb
, serial
->dev
,
616 usb_rcvintpipe(serial
->dev
, port
->interrupt_in_endpointAddress
),
617 port
->interrupt_in_urb
->transfer_buffer
,
618 port
->interrupt_in_urb
->transfer_buffer_length
,
619 cypress_read_int_callback
, port
, priv
->read_urb_interval
);
620 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
624 "%s - failed submitting read urb, error %d\n",
626 cypress_set_dead(port
);
628 port
->port
.drain_delay
= 256;
632 static void cypress_dtr_rts(struct usb_serial_port
*port
, int on
)
634 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
635 /* drop dtr and rts */
636 spin_lock_irq(&priv
->lock
);
638 priv
->line_control
= 0;
640 priv
->line_control
= CONTROL_DTR
| CONTROL_RTS
;
642 spin_unlock_irq(&priv
->lock
);
643 cypress_write(NULL
, port
, NULL
, 0);
646 static void cypress_close(struct usb_serial_port
*port
)
648 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
651 spin_lock_irqsave(&priv
->lock
, flags
);
652 kfifo_reset_out(&priv
->write_fifo
);
653 spin_unlock_irqrestore(&priv
->lock
, flags
);
655 dev_dbg(&port
->dev
, "%s - stopping urbs\n", __func__
);
656 usb_kill_urb(port
->interrupt_in_urb
);
657 usb_kill_urb(port
->interrupt_out_urb
);
660 dev_info(&port
->dev
, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
661 priv
->bytes_in
, priv
->bytes_out
, priv
->cmd_count
);
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 - %d bytes\n", __func__
, 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_tiocmiwait(struct tty_struct
*tty
, unsigned long arg
)
868 struct usb_serial_port
*port
= tty
->driver_data
;
869 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
873 interruptible_sleep_on(&port
->port
.delta_msr_wait
);
874 /* see if a signal did it */
875 if (signal_pending(current
))
878 if (port
->serial
->disconnected
)
881 diff
= priv
->diff_status
;
883 return -EIO
; /* no change => error */
885 /* consume all events */
886 priv
->diff_status
= 0;
888 /* return 0 if caller wanted to know about
890 if (((arg
& TIOCM_RNG
) && (diff
& UART_RI
)) ||
891 ((arg
& TIOCM_DSR
) && (diff
& UART_DSR
)) ||
892 ((arg
& TIOCM_CD
) && (diff
& UART_CD
)) ||
893 ((arg
& TIOCM_CTS
) && (diff
& UART_CTS
)))
895 /* otherwise caller can't care less about what
896 * happened, and so we continue to wait for
904 static void cypress_set_termios(struct tty_struct
*tty
,
905 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
907 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
908 struct device
*dev
= &port
->dev
;
909 int data_bits
, stop_bits
, parity_type
, parity_enable
;
910 unsigned cflag
, iflag
;
915 spin_lock_irqsave(&priv
->lock
, flags
);
916 /* We can't clean this one up as we don't know the device type
918 if (!priv
->termios_initialized
) {
919 if (priv
->chiptype
== CT_EARTHMATE
) {
920 tty
->termios
= tty_std_termios
;
921 tty
->termios
.c_cflag
= B4800
| CS8
| CREAD
| HUPCL
|
923 tty
->termios
.c_ispeed
= 4800;
924 tty
->termios
.c_ospeed
= 4800;
925 } else if (priv
->chiptype
== CT_CYPHIDCOM
) {
926 tty
->termios
= tty_std_termios
;
927 tty
->termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
929 tty
->termios
.c_ispeed
= 9600;
930 tty
->termios
.c_ospeed
= 9600;
931 } else if (priv
->chiptype
== CT_CA42V2
) {
932 tty
->termios
= tty_std_termios
;
933 tty
->termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
935 tty
->termios
.c_ispeed
= 9600;
936 tty
->termios
.c_ospeed
= 9600;
938 priv
->termios_initialized
= 1;
940 spin_unlock_irqrestore(&priv
->lock
, flags
);
942 /* Unsupported features need clearing */
943 tty
->termios
.c_cflag
&= ~(CMSPAR
|CRTSCTS
);
945 cflag
= tty
->termios
.c_cflag
;
946 iflag
= tty
->termios
.c_iflag
;
948 /* check if there are new settings */
950 spin_lock_irqsave(&priv
->lock
, flags
);
951 priv
->tmp_termios
= tty
->termios
;
952 spin_unlock_irqrestore(&priv
->lock
, flags
);
955 /* set number of data bits, parity, stop bits */
956 /* when parity is disabled the parity type bit is ignored */
958 /* 1 means 2 stop bits, 0 means 1 stop bit */
959 stop_bits
= cflag
& CSTOPB
? 1 : 0;
961 if (cflag
& PARENB
) {
963 /* 1 means odd parity, 0 means even parity */
964 parity_type
= cflag
& PARODD
? 1 : 0;
966 parity_enable
= parity_type
= 0;
968 switch (cflag
& CSIZE
) {
982 dev_err(dev
, "%s - CSIZE was set, but not CS5-CS8\n", __func__
);
985 spin_lock_irqsave(&priv
->lock
, flags
);
986 oldlines
= priv
->line_control
;
987 if ((cflag
& CBAUD
) == B0
) {
988 /* drop dtr and rts */
989 dev_dbg(dev
, "%s - dropping the lines, baud rate 0bps\n", __func__
);
990 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
992 priv
->line_control
= (CONTROL_DTR
| CONTROL_RTS
);
993 spin_unlock_irqrestore(&priv
->lock
, flags
);
995 dev_dbg(dev
, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
996 __func__
, stop_bits
, parity_enable
, parity_type
, data_bits
);
998 cypress_serial_control(tty
, port
, tty_get_baud_rate(tty
),
999 data_bits
, stop_bits
,
1000 parity_enable
, parity_type
,
1001 0, CYPRESS_SET_CONFIG
);
1003 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1004 * filled into the private structure this should confirm that all is
1005 * working if it returns what we just set */
1006 cypress_serial_control(tty
, port
, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG
);
1008 /* Here we can define custom tty settings for devices; the main tty
1009 * termios flag base comes from empeg.c */
1011 spin_lock_irqsave(&priv
->lock
, flags
);
1012 if (priv
->chiptype
== CT_EARTHMATE
&& priv
->baud_rate
== 4800) {
1013 dev_dbg(dev
, "Using custom termios settings for a baud rate of 4800bps.\n");
1014 /* define custom termios settings for NMEA protocol */
1016 tty
->termios
.c_iflag
/* input modes - */
1017 &= ~(IGNBRK
/* disable ignore break */
1018 | BRKINT
/* disable break causes interrupt */
1019 | PARMRK
/* disable mark parity errors */
1020 | ISTRIP
/* disable clear high bit of input char */
1021 | INLCR
/* disable translate NL to CR */
1022 | IGNCR
/* disable ignore CR */
1023 | ICRNL
/* disable translate CR to NL */
1024 | IXON
); /* disable enable XON/XOFF flow control */
1026 tty
->termios
.c_oflag
/* output modes */
1027 &= ~OPOST
; /* disable postprocess output char */
1029 tty
->termios
.c_lflag
/* line discipline modes */
1030 &= ~(ECHO
/* disable echo input characters */
1031 | ECHONL
/* disable echo new line */
1032 | ICANON
/* disable erase, kill, werase, and rprnt
1033 special characters */
1034 | ISIG
/* disable interrupt, quit, and suspend
1035 special characters */
1036 | IEXTEN
); /* disable non-POSIX special characters */
1037 } /* CT_CYPHIDCOM: Application should handle this for device */
1039 linechange
= (priv
->line_control
!= oldlines
);
1040 spin_unlock_irqrestore(&priv
->lock
, flags
);
1042 /* if necessary, set lines */
1045 cypress_write(tty
, port
, NULL
, 0);
1047 } /* cypress_set_termios */
1050 /* returns amount of data still left in soft buffer */
1051 static int cypress_chars_in_buffer(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 unsigned long flags
;
1058 spin_lock_irqsave(&priv
->lock
, flags
);
1059 chars
= kfifo_len(&priv
->write_fifo
);
1060 spin_unlock_irqrestore(&priv
->lock
, flags
);
1062 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, chars
);
1067 static void cypress_throttle(struct tty_struct
*tty
)
1069 struct usb_serial_port
*port
= tty
->driver_data
;
1070 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1072 spin_lock_irq(&priv
->lock
);
1073 priv
->rx_flags
= THROTTLED
;
1074 spin_unlock_irq(&priv
->lock
);
1078 static void cypress_unthrottle(struct tty_struct
*tty
)
1080 struct usb_serial_port
*port
= tty
->driver_data
;
1081 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1082 int actually_throttled
, result
;
1084 spin_lock_irq(&priv
->lock
);
1085 actually_throttled
= priv
->rx_flags
& ACTUALLY_THROTTLED
;
1087 spin_unlock_irq(&priv
->lock
);
1089 if (!priv
->comm_is_ok
)
1092 if (actually_throttled
) {
1093 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
1095 dev_err(&port
->dev
, "%s - failed submitting read urb, "
1096 "error %d\n", __func__
, result
);
1097 cypress_set_dead(port
);
1103 static void cypress_read_int_callback(struct urb
*urb
)
1105 struct usb_serial_port
*port
= urb
->context
;
1106 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1107 struct device
*dev
= &urb
->dev
->dev
;
1108 struct tty_struct
*tty
;
1109 unsigned char *data
= urb
->transfer_buffer
;
1110 unsigned long flags
;
1111 char tty_flag
= TTY_NORMAL
;
1116 int status
= urb
->status
;
1119 case 0: /* success */
1124 /* precursor to disconnect so just go away */
1127 /* Can't call usb_clear_halt while in_interrupt */
1130 /* something ugly is going on... */
1131 dev_err(dev
, "%s - unexpected nonzero read status received: %d\n",
1133 cypress_set_dead(port
);
1137 spin_lock_irqsave(&priv
->lock
, flags
);
1138 if (priv
->rx_flags
& THROTTLED
) {
1139 dev_dbg(dev
, "%s - now throttling\n", __func__
);
1140 priv
->rx_flags
|= ACTUALLY_THROTTLED
;
1141 spin_unlock_irqrestore(&priv
->lock
, flags
);
1144 spin_unlock_irqrestore(&priv
->lock
, flags
);
1146 tty
= tty_port_tty_get(&port
->port
);
1148 dev_dbg(dev
, "%s - bad tty pointer - exiting\n", __func__
);
1152 spin_lock_irqsave(&priv
->lock
, flags
);
1153 result
= urb
->actual_length
;
1154 switch (priv
->pkt_fmt
) {
1156 case packet_format_1
:
1157 /* This is for the CY7C64013... */
1158 priv
->current_status
= data
[0] & 0xF8;
1159 bytes
= data
[1] + 2;
1164 case packet_format_2
:
1165 /* This is for the CY7C63743... */
1166 priv
->current_status
= data
[0] & 0xF8;
1167 bytes
= (data
[0] & 0x07) + 1;
1173 spin_unlock_irqrestore(&priv
->lock
, flags
);
1174 if (result
< bytes
) {
1176 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1177 __func__
, result
, bytes
);
1181 usb_serial_debug_data(&port
->dev
, __func__
, urb
->actual_length
, data
);
1183 spin_lock_irqsave(&priv
->lock
, flags
);
1184 /* check to see if status has changed */
1185 if (priv
->current_status
!= priv
->prev_status
) {
1186 priv
->diff_status
|= priv
->current_status
^
1188 wake_up_interruptible(&port
->port
.delta_msr_wait
);
1189 priv
->prev_status
= priv
->current_status
;
1191 spin_unlock_irqrestore(&priv
->lock
, flags
);
1193 /* hangup, as defined in acm.c... this might be a bad place for it
1195 if (tty
&& !(tty
->termios
.c_cflag
& CLOCAL
) &&
1196 !(priv
->current_status
& UART_CD
)) {
1197 dev_dbg(dev
, "%s - calling hangup\n", __func__
);
1202 /* There is one error bit... I'm assuming it is a parity error
1203 * indicator as the generic firmware will set this bit to 1 if a
1204 * parity error occurs.
1205 * I can not find reference to any other error events. */
1206 spin_lock_irqsave(&priv
->lock
, flags
);
1207 if (priv
->current_status
& CYP_ERROR
) {
1208 spin_unlock_irqrestore(&priv
->lock
, flags
);
1209 tty_flag
= TTY_PARITY
;
1210 dev_dbg(dev
, "%s - Parity Error detected\n", __func__
);
1212 spin_unlock_irqrestore(&priv
->lock
, flags
);
1214 /* process read if there is data other than line status */
1216 tty_insert_flip_string_fixed_flag(&port
->port
, data
+ i
,
1217 tty_flag
, bytes
- i
);
1218 tty_flip_buffer_push(&port
->port
);
1221 spin_lock_irqsave(&priv
->lock
, flags
);
1222 /* control and status byte(s) are also counted */
1223 priv
->bytes_in
+= bytes
;
1224 spin_unlock_irqrestore(&priv
->lock
, flags
);
1229 /* Continue trying to always read */
1231 if (priv
->comm_is_ok
) {
1232 usb_fill_int_urb(port
->interrupt_in_urb
, port
->serial
->dev
,
1233 usb_rcvintpipe(port
->serial
->dev
,
1234 port
->interrupt_in_endpointAddress
),
1235 port
->interrupt_in_urb
->transfer_buffer
,
1236 port
->interrupt_in_urb
->transfer_buffer_length
,
1237 cypress_read_int_callback
, port
,
1238 priv
->read_urb_interval
);
1239 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
1240 if (result
&& result
!= -EPERM
) {
1241 dev_err(dev
, "%s - failed resubmitting read urb, error %d\n",
1243 cypress_set_dead(port
);
1246 } /* cypress_read_int_callback */
1249 static void cypress_write_int_callback(struct urb
*urb
)
1251 struct usb_serial_port
*port
= urb
->context
;
1252 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1253 struct device
*dev
= &urb
->dev
->dev
;
1255 int status
= urb
->status
;
1264 /* this urb is terminated, clean up */
1265 dev_dbg(dev
, "%s - urb shutting down with status: %d\n",
1267 priv
->write_urb_in_use
= 0;
1269 case -EPIPE
: /* no break needed; clear halt and resubmit */
1270 if (!priv
->comm_is_ok
)
1272 usb_clear_halt(port
->serial
->dev
, 0x02);
1273 /* error in the urb, so we have to resubmit it */
1274 dev_dbg(dev
, "%s - nonzero write bulk status received: %d\n",
1276 port
->interrupt_out_urb
->transfer_buffer_length
= 1;
1277 result
= usb_submit_urb(port
->interrupt_out_urb
, GFP_ATOMIC
);
1280 dev_err(dev
, "%s - failed resubmitting write urb, error %d\n",
1282 cypress_set_dead(port
);
1285 dev_err(dev
, "%s - unexpected nonzero write status received: %d\n",
1287 cypress_set_dead(port
);
1290 priv
->write_urb_in_use
= 0;
1292 /* send any buffered data */
1296 module_usb_serial_driver(serial_drivers
, id_table_combined
);
1298 MODULE_AUTHOR(DRIVER_AUTHOR
);
1299 MODULE_DESCRIPTION(DRIVER_DESC
);
1300 MODULE_LICENSE("GPL");
1302 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1303 MODULE_PARM_DESC(stats
, "Enable statistics or not");
1304 module_param(interval
, int, S_IRUGO
| S_IWUSR
);
1305 MODULE_PARM_DESC(interval
, "Overrides interrupt interval");
1306 module_param(unstable_bauds
, bool, S_IRUGO
| S_IWUSR
);
1307 MODULE_PARM_DESC(unstable_bauds
, "Allow unstable baud rates");