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_POWERCOM
, PRODUCT_ID_UPS
) },
67 { USB_DEVICE(VENDOR_ID_FRWD
, PRODUCT_ID_CYPHIDCOM_FRWD
) },
68 { } /* Terminating entry */
71 static const struct usb_device_id id_table_nokiaca42v2
[] = {
72 { USB_DEVICE(VENDOR_ID_DAZZLE
, PRODUCT_ID_CA42
) },
73 { } /* Terminating entry */
76 static const struct usb_device_id id_table_combined
[] = {
77 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB
) },
78 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB_LT20
) },
79 { USB_DEVICE(VENDOR_ID_CYPRESS
, PRODUCT_ID_CYPHIDCOM
) },
80 { USB_DEVICE(VENDOR_ID_POWERCOM
, PRODUCT_ID_UPS
) },
81 { USB_DEVICE(VENDOR_ID_FRWD
, PRODUCT_ID_CYPHIDCOM_FRWD
) },
82 { USB_DEVICE(VENDOR_ID_DAZZLE
, PRODUCT_ID_CA42
) },
83 { } /* Terminating entry */
86 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
89 packet_format_1
, /* b0:status, b1:payload count */
90 packet_format_2
/* b0[7:3]:status, b0[2:0]:payload count */
93 struct cypress_private
{
94 spinlock_t lock
; /* private lock */
95 int chiptype
; /* identifier of device, for quirks/etc */
96 int bytes_in
; /* used for statistics */
97 int bytes_out
; /* used for statistics */
98 int cmd_count
; /* used for statistics */
99 int cmd_ctrl
; /* always set this to 1 before issuing a command */
100 struct kfifo write_fifo
; /* write fifo */
101 int write_urb_in_use
; /* write urb in use indicator */
102 int write_urb_interval
; /* interval to use for write urb */
103 int read_urb_interval
; /* interval to use for read urb */
104 int comm_is_ok
; /* true if communication is (still) ok */
105 int termios_initialized
;
106 __u8 line_control
; /* holds dtr / rts value */
107 __u8 current_status
; /* received from last read - info on dsr,cts,cd,ri,etc */
108 __u8 current_config
; /* stores the current configuration byte */
109 __u8 rx_flags
; /* throttling - used from whiteheat/ftdi_sio */
110 enum packet_format pkt_fmt
; /* format to use for packet send / receive */
111 int get_cfg_unsafe
; /* If true, the CYPRESS_GET_CONFIG is unsafe */
112 int baud_rate
; /* stores current baud rate in
114 int isthrottled
; /* if throttled, discard reads */
115 char prev_status
; /* used for TIOCMIWAIT */
116 /* we pass a pointer to this as the argument sent to
117 cypress_set_termios old_termios */
118 struct ktermios tmp_termios
; /* stores the old termios settings */
121 /* function prototypes for the Cypress USB to serial device */
122 static int cypress_earthmate_port_probe(struct usb_serial_port
*port
);
123 static int cypress_hidcom_port_probe(struct usb_serial_port
*port
);
124 static int cypress_ca42v2_port_probe(struct usb_serial_port
*port
);
125 static int cypress_port_remove(struct usb_serial_port
*port
);
126 static int cypress_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
127 static void cypress_close(struct usb_serial_port
*port
);
128 static void cypress_dtr_rts(struct usb_serial_port
*port
, int on
);
129 static int cypress_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
130 const unsigned char *buf
, int count
);
131 static void cypress_send(struct usb_serial_port
*port
);
132 static int cypress_write_room(struct tty_struct
*tty
);
133 static void cypress_set_termios(struct tty_struct
*tty
,
134 struct usb_serial_port
*port
, struct ktermios
*old
);
135 static int cypress_tiocmget(struct tty_struct
*tty
);
136 static int cypress_tiocmset(struct tty_struct
*tty
,
137 unsigned int set
, unsigned int clear
);
138 static int cypress_chars_in_buffer(struct tty_struct
*tty
);
139 static void cypress_throttle(struct tty_struct
*tty
);
140 static void cypress_unthrottle(struct tty_struct
*tty
);
141 static void cypress_set_dead(struct usb_serial_port
*port
);
142 static void cypress_read_int_callback(struct urb
*urb
);
143 static void cypress_write_int_callback(struct urb
*urb
);
145 static struct usb_serial_driver cypress_earthmate_device
= {
147 .owner
= THIS_MODULE
,
150 .description
= "DeLorme Earthmate USB",
151 .id_table
= id_table_earthmate
,
153 .port_probe
= cypress_earthmate_port_probe
,
154 .port_remove
= cypress_port_remove
,
155 .open
= cypress_open
,
156 .close
= cypress_close
,
157 .dtr_rts
= cypress_dtr_rts
,
158 .write
= cypress_write
,
159 .write_room
= cypress_write_room
,
160 .set_termios
= cypress_set_termios
,
161 .tiocmget
= cypress_tiocmget
,
162 .tiocmset
= cypress_tiocmset
,
163 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
164 .chars_in_buffer
= cypress_chars_in_buffer
,
165 .throttle
= cypress_throttle
,
166 .unthrottle
= cypress_unthrottle
,
167 .read_int_callback
= cypress_read_int_callback
,
168 .write_int_callback
= cypress_write_int_callback
,
171 static struct usb_serial_driver cypress_hidcom_device
= {
173 .owner
= THIS_MODULE
,
176 .description
= "HID->COM RS232 Adapter",
177 .id_table
= id_table_cyphidcomrs232
,
179 .port_probe
= cypress_hidcom_port_probe
,
180 .port_remove
= cypress_port_remove
,
181 .open
= cypress_open
,
182 .close
= cypress_close
,
183 .dtr_rts
= cypress_dtr_rts
,
184 .write
= cypress_write
,
185 .write_room
= cypress_write_room
,
186 .set_termios
= cypress_set_termios
,
187 .tiocmget
= cypress_tiocmget
,
188 .tiocmset
= cypress_tiocmset
,
189 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
190 .chars_in_buffer
= cypress_chars_in_buffer
,
191 .throttle
= cypress_throttle
,
192 .unthrottle
= cypress_unthrottle
,
193 .read_int_callback
= cypress_read_int_callback
,
194 .write_int_callback
= cypress_write_int_callback
,
197 static struct usb_serial_driver cypress_ca42v2_device
= {
199 .owner
= THIS_MODULE
,
200 .name
= "nokiaca42v2",
202 .description
= "Nokia CA-42 V2 Adapter",
203 .id_table
= id_table_nokiaca42v2
,
205 .port_probe
= cypress_ca42v2_port_probe
,
206 .port_remove
= cypress_port_remove
,
207 .open
= cypress_open
,
208 .close
= cypress_close
,
209 .dtr_rts
= cypress_dtr_rts
,
210 .write
= cypress_write
,
211 .write_room
= cypress_write_room
,
212 .set_termios
= cypress_set_termios
,
213 .tiocmget
= cypress_tiocmget
,
214 .tiocmset
= cypress_tiocmset
,
215 .tiocmiwait
= usb_serial_generic_tiocmiwait
,
216 .chars_in_buffer
= cypress_chars_in_buffer
,
217 .throttle
= cypress_throttle
,
218 .unthrottle
= cypress_unthrottle
,
219 .read_int_callback
= cypress_read_int_callback
,
220 .write_int_callback
= cypress_write_int_callback
,
223 static struct usb_serial_driver
* const serial_drivers
[] = {
224 &cypress_earthmate_device
, &cypress_hidcom_device
,
225 &cypress_ca42v2_device
, NULL
228 /*****************************************************************************
229 * Cypress serial helper functions
230 *****************************************************************************/
232 /* FRWD Dongle hidcom needs to skip reset and speed checks */
233 static inline bool is_frwd(struct usb_device
*dev
)
235 return ((le16_to_cpu(dev
->descriptor
.idVendor
) == VENDOR_ID_FRWD
) &&
236 (le16_to_cpu(dev
->descriptor
.idProduct
) == PRODUCT_ID_CYPHIDCOM_FRWD
));
239 static int analyze_baud_rate(struct usb_serial_port
*port
, speed_t new_rate
)
241 struct cypress_private
*priv
;
242 priv
= usb_get_serial_port_data(port
);
247 /* FRWD Dongle uses 115200 bps */
248 if (is_frwd(port
->serial
->dev
))
252 * The general purpose firmware for the Cypress M8 allows for
253 * a maximum speed of 57600bps (I have no idea whether DeLorme
254 * chose to use the general purpose firmware or not), if you
255 * need to modify this speed setting for your own project
256 * please add your own chiptype and modify the code likewise.
257 * The Cypress HID->COM device will work successfully up to
258 * 115200bps (but the actual throughput is around 3kBps).
260 if (port
->serial
->dev
->speed
== USB_SPEED_LOW
) {
262 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
263 * Cypress app note that describes this mechanism
264 * states the the low-speed part can't handle more
265 * than 800 bytes/sec, in which case 4800 baud is the
266 * safest speed for a part like that.
268 if (new_rate
> 4800) {
270 "%s - failed setting baud rate, device incapable speed %d\n",
275 switch (priv
->chiptype
) {
277 if (new_rate
<= 600) {
278 /* 300 and 600 baud rates are supported under
279 * the generic firmware, but are not used with
280 * NMEA and SiRF protocols */
282 "%s - failed setting baud rate, unsupported speed of %d on Earthmate GPS",
294 /* This function can either set or retrieve the current serial line settings */
295 static int cypress_serial_control(struct tty_struct
*tty
,
296 struct usb_serial_port
*port
, speed_t baud_rate
, int data_bits
,
297 int stop_bits
, int parity_enable
, int parity_type
, int reset
,
298 int cypress_request_type
)
300 int new_baudrate
= 0, retval
= 0, tries
= 0;
301 struct cypress_private
*priv
;
302 struct device
*dev
= &port
->dev
;
304 const unsigned int feature_len
= 5;
307 priv
= usb_get_serial_port_data(port
);
309 if (!priv
->comm_is_ok
)
312 feature_buffer
= kcalloc(feature_len
, sizeof(u8
), GFP_KERNEL
);
316 switch (cypress_request_type
) {
317 case CYPRESS_SET_CONFIG
:
318 /* 0 means 'Hang up' so doesn't change the true bit rate */
319 new_baudrate
= priv
->baud_rate
;
320 if (baud_rate
&& baud_rate
!= priv
->baud_rate
) {
321 dev_dbg(dev
, "%s - baud rate is changing\n", __func__
);
322 retval
= analyze_baud_rate(port
, baud_rate
);
324 new_baudrate
= retval
;
325 dev_dbg(dev
, "%s - New baud rate set to %d\n",
326 __func__
, new_baudrate
);
329 dev_dbg(dev
, "%s - baud rate is being sent as %d\n", __func__
,
332 /* fill the feature_buffer with new configuration */
333 put_unaligned_le32(new_baudrate
, feature_buffer
);
334 feature_buffer
[4] |= data_bits
; /* assign data bits in 2 bit space ( max 3 ) */
336 feature_buffer
[4] |= (stop_bits
<< 3); /* assign stop bits in 1 bit space */
337 feature_buffer
[4] |= (parity_enable
<< 4); /* assign parity flag in 1 bit space */
338 feature_buffer
[4] |= (parity_type
<< 5); /* assign parity type in 1 bit space */
340 feature_buffer
[4] |= (reset
<< 7); /* assign reset at end of byte, 1 bit space */
342 dev_dbg(dev
, "%s - device is being sent this feature report:\n", __func__
);
343 dev_dbg(dev
, "%s - %02X - %02X - %02X - %02X - %02X\n", __func__
,
344 feature_buffer
[0], feature_buffer
[1],
345 feature_buffer
[2], feature_buffer
[3],
349 retval
= usb_control_msg(port
->serial
->dev
,
350 usb_sndctrlpipe(port
->serial
->dev
, 0),
352 USB_DIR_OUT
| USB_RECIP_INTERFACE
| USB_TYPE_CLASS
,
353 0x0300, 0, feature_buffer
,
359 } while (retval
!= feature_len
&&
362 if (retval
!= feature_len
) {
363 dev_err(dev
, "%s - failed sending serial line settings - %d\n",
365 cypress_set_dead(port
);
367 spin_lock_irqsave(&priv
->lock
, flags
);
368 priv
->baud_rate
= new_baudrate
;
369 priv
->current_config
= feature_buffer
[4];
370 spin_unlock_irqrestore(&priv
->lock
, flags
);
371 /* If we asked for a speed change encode it */
373 tty_encode_baud_rate(tty
,
374 new_baudrate
, new_baudrate
);
377 case CYPRESS_GET_CONFIG
:
378 if (priv
->get_cfg_unsafe
) {
379 /* Not implemented for this device,
380 and if we try to do it we're likely
381 to crash the hardware. */
385 dev_dbg(dev
, "%s - retreiving serial line settings\n", __func__
);
387 retval
= usb_control_msg(port
->serial
->dev
,
388 usb_rcvctrlpipe(port
->serial
->dev
, 0),
390 USB_DIR_IN
| USB_RECIP_INTERFACE
| USB_TYPE_CLASS
,
391 0x0300, 0, feature_buffer
,
396 } while (retval
!= feature_len
397 && retval
!= -ENODEV
);
399 if (retval
!= feature_len
) {
400 dev_err(dev
, "%s - failed to retrieve serial line settings - %d\n",
402 cypress_set_dead(port
);
405 spin_lock_irqsave(&priv
->lock
, flags
);
406 /* store the config in one byte, and later
407 use bit masks to check values */
408 priv
->current_config
= feature_buffer
[4];
409 priv
->baud_rate
= get_unaligned_le32(feature_buffer
);
410 spin_unlock_irqrestore(&priv
->lock
, flags
);
413 spin_lock_irqsave(&priv
->lock
, flags
);
415 spin_unlock_irqrestore(&priv
->lock
, flags
);
417 kfree(feature_buffer
);
419 } /* cypress_serial_control */
422 static void cypress_set_dead(struct usb_serial_port
*port
)
424 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
427 spin_lock_irqsave(&priv
->lock
, flags
);
428 if (!priv
->comm_is_ok
) {
429 spin_unlock_irqrestore(&priv
->lock
, flags
);
432 priv
->comm_is_ok
= 0;
433 spin_unlock_irqrestore(&priv
->lock
, flags
);
435 dev_err(&port
->dev
, "cypress_m8 suspending failing port %d - "
436 "interval might be too short\n", port
->port_number
);
440 /*****************************************************************************
441 * Cypress serial driver functions
442 *****************************************************************************/
445 static int cypress_generic_port_probe(struct usb_serial_port
*port
)
447 struct usb_serial
*serial
= port
->serial
;
448 struct cypress_private
*priv
;
450 priv
= kzalloc(sizeof(struct cypress_private
), GFP_KERNEL
);
454 priv
->comm_is_ok
= !0;
455 spin_lock_init(&priv
->lock
);
456 if (kfifo_alloc(&priv
->write_fifo
, CYPRESS_BUF_SIZE
, GFP_KERNEL
)) {
461 /* Skip reset for FRWD device. It is a workaound:
462 device hangs if it receives SET_CONFIGURE in Configured
464 if (!is_frwd(serial
->dev
))
465 usb_reset_configuration(serial
->dev
);
468 priv
->line_control
= 0;
469 priv
->termios_initialized
= 0;
471 /* Default packet format setting is determined by packet size.
472 Anything with a size larger then 9 must have a separate
473 count field since the 3 bit count field is otherwise too
474 small. Otherwise we can use the slightly more compact
475 format. This is in accordance with the cypress_m8 serial
476 converter app note. */
477 if (port
->interrupt_out_size
> 9)
478 priv
->pkt_fmt
= packet_format_1
;
480 priv
->pkt_fmt
= packet_format_2
;
483 priv
->write_urb_interval
= interval
;
484 priv
->read_urb_interval
= interval
;
485 dev_dbg(&port
->dev
, "%s - read & write intervals forced to %d\n",
488 priv
->write_urb_interval
= port
->interrupt_out_urb
->interval
;
489 priv
->read_urb_interval
= port
->interrupt_in_urb
->interval
;
490 dev_dbg(&port
->dev
, "%s - intervals: read=%d write=%d\n",
491 __func__
, priv
->read_urb_interval
,
492 priv
->write_urb_interval
);
494 usb_set_serial_port_data(port
, priv
);
496 port
->port
.drain_delay
= 256;
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
);
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);
865 static void cypress_set_termios(struct tty_struct
*tty
,
866 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
868 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
869 struct device
*dev
= &port
->dev
;
870 int data_bits
, stop_bits
, parity_type
, parity_enable
;
871 unsigned cflag
, iflag
;
876 spin_lock_irqsave(&priv
->lock
, flags
);
877 /* We can't clean this one up as we don't know the device type
879 if (!priv
->termios_initialized
) {
880 if (priv
->chiptype
== CT_EARTHMATE
) {
881 tty
->termios
= tty_std_termios
;
882 tty
->termios
.c_cflag
= B4800
| CS8
| CREAD
| HUPCL
|
884 tty
->termios
.c_ispeed
= 4800;
885 tty
->termios
.c_ospeed
= 4800;
886 } else if (priv
->chiptype
== CT_CYPHIDCOM
) {
887 tty
->termios
= tty_std_termios
;
888 tty
->termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
890 tty
->termios
.c_ispeed
= 9600;
891 tty
->termios
.c_ospeed
= 9600;
892 } else if (priv
->chiptype
== CT_CA42V2
) {
893 tty
->termios
= tty_std_termios
;
894 tty
->termios
.c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
896 tty
->termios
.c_ispeed
= 9600;
897 tty
->termios
.c_ospeed
= 9600;
899 priv
->termios_initialized
= 1;
901 spin_unlock_irqrestore(&priv
->lock
, flags
);
903 /* Unsupported features need clearing */
904 tty
->termios
.c_cflag
&= ~(CMSPAR
|CRTSCTS
);
906 cflag
= tty
->termios
.c_cflag
;
907 iflag
= tty
->termios
.c_iflag
;
909 /* check if there are new settings */
911 spin_lock_irqsave(&priv
->lock
, flags
);
912 priv
->tmp_termios
= tty
->termios
;
913 spin_unlock_irqrestore(&priv
->lock
, flags
);
916 /* set number of data bits, parity, stop bits */
917 /* when parity is disabled the parity type bit is ignored */
919 /* 1 means 2 stop bits, 0 means 1 stop bit */
920 stop_bits
= cflag
& CSTOPB
? 1 : 0;
922 if (cflag
& PARENB
) {
924 /* 1 means odd parity, 0 means even parity */
925 parity_type
= cflag
& PARODD
? 1 : 0;
927 parity_enable
= parity_type
= 0;
929 switch (cflag
& CSIZE
) {
943 dev_err(dev
, "%s - CSIZE was set, but not CS5-CS8\n", __func__
);
946 spin_lock_irqsave(&priv
->lock
, flags
);
947 oldlines
= priv
->line_control
;
948 if ((cflag
& CBAUD
) == B0
) {
949 /* drop dtr and rts */
950 dev_dbg(dev
, "%s - dropping the lines, baud rate 0bps\n", __func__
);
951 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
953 priv
->line_control
= (CONTROL_DTR
| CONTROL_RTS
);
954 spin_unlock_irqrestore(&priv
->lock
, flags
);
956 dev_dbg(dev
, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
957 __func__
, stop_bits
, parity_enable
, parity_type
, data_bits
);
959 cypress_serial_control(tty
, port
, tty_get_baud_rate(tty
),
960 data_bits
, stop_bits
,
961 parity_enable
, parity_type
,
962 0, CYPRESS_SET_CONFIG
);
964 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
965 * filled into the private structure this should confirm that all is
966 * working if it returns what we just set */
967 cypress_serial_control(tty
, port
, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG
);
969 /* Here we can define custom tty settings for devices; the main tty
970 * termios flag base comes from empeg.c */
972 spin_lock_irqsave(&priv
->lock
, flags
);
973 if (priv
->chiptype
== CT_EARTHMATE
&& priv
->baud_rate
== 4800) {
974 dev_dbg(dev
, "Using custom termios settings for a baud rate of 4800bps.\n");
975 /* define custom termios settings for NMEA protocol */
977 tty
->termios
.c_iflag
/* input modes - */
978 &= ~(IGNBRK
/* disable ignore break */
979 | BRKINT
/* disable break causes interrupt */
980 | PARMRK
/* disable mark parity errors */
981 | ISTRIP
/* disable clear high bit of input char */
982 | INLCR
/* disable translate NL to CR */
983 | IGNCR
/* disable ignore CR */
984 | ICRNL
/* disable translate CR to NL */
985 | IXON
); /* disable enable XON/XOFF flow control */
987 tty
->termios
.c_oflag
/* output modes */
988 &= ~OPOST
; /* disable postprocess output char */
990 tty
->termios
.c_lflag
/* line discipline modes */
991 &= ~(ECHO
/* disable echo input characters */
992 | ECHONL
/* disable echo new line */
993 | ICANON
/* disable erase, kill, werase, and rprnt
994 special characters */
995 | ISIG
/* disable interrupt, quit, and suspend
996 special characters */
997 | IEXTEN
); /* disable non-POSIX special characters */
998 } /* CT_CYPHIDCOM: Application should handle this for device */
1000 linechange
= (priv
->line_control
!= oldlines
);
1001 spin_unlock_irqrestore(&priv
->lock
, flags
);
1003 /* if necessary, set lines */
1006 cypress_write(tty
, port
, NULL
, 0);
1008 } /* cypress_set_termios */
1011 /* returns amount of data still left in soft buffer */
1012 static int cypress_chars_in_buffer(struct tty_struct
*tty
)
1014 struct usb_serial_port
*port
= tty
->driver_data
;
1015 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1017 unsigned long flags
;
1019 spin_lock_irqsave(&priv
->lock
, flags
);
1020 chars
= kfifo_len(&priv
->write_fifo
);
1021 spin_unlock_irqrestore(&priv
->lock
, flags
);
1023 dev_dbg(&port
->dev
, "%s - returns %d\n", __func__
, chars
);
1028 static void cypress_throttle(struct tty_struct
*tty
)
1030 struct usb_serial_port
*port
= tty
->driver_data
;
1031 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1033 spin_lock_irq(&priv
->lock
);
1034 priv
->rx_flags
= THROTTLED
;
1035 spin_unlock_irq(&priv
->lock
);
1039 static void cypress_unthrottle(struct tty_struct
*tty
)
1041 struct usb_serial_port
*port
= tty
->driver_data
;
1042 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1043 int actually_throttled
, result
;
1045 spin_lock_irq(&priv
->lock
);
1046 actually_throttled
= priv
->rx_flags
& ACTUALLY_THROTTLED
;
1048 spin_unlock_irq(&priv
->lock
);
1050 if (!priv
->comm_is_ok
)
1053 if (actually_throttled
) {
1054 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
1056 dev_err(&port
->dev
, "%s - failed submitting read urb, "
1057 "error %d\n", __func__
, result
);
1058 cypress_set_dead(port
);
1064 static void cypress_read_int_callback(struct urb
*urb
)
1066 struct usb_serial_port
*port
= urb
->context
;
1067 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1068 struct device
*dev
= &urb
->dev
->dev
;
1069 struct tty_struct
*tty
;
1070 unsigned char *data
= urb
->transfer_buffer
;
1071 unsigned long flags
;
1072 char tty_flag
= TTY_NORMAL
;
1077 int status
= urb
->status
;
1080 case 0: /* success */
1085 /* precursor to disconnect so just go away */
1088 /* Can't call usb_clear_halt while in_interrupt */
1091 /* something ugly is going on... */
1092 dev_err(dev
, "%s - unexpected nonzero read status received: %d\n",
1094 cypress_set_dead(port
);
1098 spin_lock_irqsave(&priv
->lock
, flags
);
1099 if (priv
->rx_flags
& THROTTLED
) {
1100 dev_dbg(dev
, "%s - now throttling\n", __func__
);
1101 priv
->rx_flags
|= ACTUALLY_THROTTLED
;
1102 spin_unlock_irqrestore(&priv
->lock
, flags
);
1105 spin_unlock_irqrestore(&priv
->lock
, flags
);
1107 tty
= tty_port_tty_get(&port
->port
);
1109 dev_dbg(dev
, "%s - bad tty pointer - exiting\n", __func__
);
1113 spin_lock_irqsave(&priv
->lock
, flags
);
1114 result
= urb
->actual_length
;
1115 switch (priv
->pkt_fmt
) {
1117 case packet_format_1
:
1118 /* This is for the CY7C64013... */
1119 priv
->current_status
= data
[0] & 0xF8;
1120 bytes
= data
[1] + 2;
1125 case packet_format_2
:
1126 /* This is for the CY7C63743... */
1127 priv
->current_status
= data
[0] & 0xF8;
1128 bytes
= (data
[0] & 0x07) + 1;
1134 spin_unlock_irqrestore(&priv
->lock
, flags
);
1135 if (result
< bytes
) {
1137 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1138 __func__
, result
, bytes
);
1142 usb_serial_debug_data(&port
->dev
, __func__
, urb
->actual_length
, data
);
1144 spin_lock_irqsave(&priv
->lock
, flags
);
1145 /* check to see if status has changed */
1146 if (priv
->current_status
!= priv
->prev_status
) {
1147 u8 delta
= priv
->current_status
^ priv
->prev_status
;
1149 if (delta
& UART_MSR_MASK
) {
1150 if (delta
& UART_CTS
)
1152 if (delta
& UART_DSR
)
1154 if (delta
& UART_RI
)
1156 if (delta
& UART_CD
)
1159 wake_up_interruptible(&port
->port
.delta_msr_wait
);
1162 priv
->prev_status
= priv
->current_status
;
1164 spin_unlock_irqrestore(&priv
->lock
, flags
);
1166 /* hangup, as defined in acm.c... this might be a bad place for it
1168 if (tty
&& !(tty
->termios
.c_cflag
& CLOCAL
) &&
1169 !(priv
->current_status
& UART_CD
)) {
1170 dev_dbg(dev
, "%s - calling hangup\n", __func__
);
1175 /* There is one error bit... I'm assuming it is a parity error
1176 * indicator as the generic firmware will set this bit to 1 if a
1177 * parity error occurs.
1178 * I can not find reference to any other error events. */
1179 spin_lock_irqsave(&priv
->lock
, flags
);
1180 if (priv
->current_status
& CYP_ERROR
) {
1181 spin_unlock_irqrestore(&priv
->lock
, flags
);
1182 tty_flag
= TTY_PARITY
;
1183 dev_dbg(dev
, "%s - Parity Error detected\n", __func__
);
1185 spin_unlock_irqrestore(&priv
->lock
, flags
);
1187 /* process read if there is data other than line status */
1189 tty_insert_flip_string_fixed_flag(&port
->port
, data
+ i
,
1190 tty_flag
, bytes
- i
);
1191 tty_flip_buffer_push(&port
->port
);
1194 spin_lock_irqsave(&priv
->lock
, flags
);
1195 /* control and status byte(s) are also counted */
1196 priv
->bytes_in
+= bytes
;
1197 spin_unlock_irqrestore(&priv
->lock
, flags
);
1202 /* Continue trying to always read */
1204 if (priv
->comm_is_ok
) {
1205 usb_fill_int_urb(port
->interrupt_in_urb
, port
->serial
->dev
,
1206 usb_rcvintpipe(port
->serial
->dev
,
1207 port
->interrupt_in_endpointAddress
),
1208 port
->interrupt_in_urb
->transfer_buffer
,
1209 port
->interrupt_in_urb
->transfer_buffer_length
,
1210 cypress_read_int_callback
, port
,
1211 priv
->read_urb_interval
);
1212 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
1213 if (result
&& result
!= -EPERM
) {
1214 dev_err(dev
, "%s - failed resubmitting read urb, error %d\n",
1216 cypress_set_dead(port
);
1219 } /* cypress_read_int_callback */
1222 static void cypress_write_int_callback(struct urb
*urb
)
1224 struct usb_serial_port
*port
= urb
->context
;
1225 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1226 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;
1242 case -EPIPE
: /* no break needed; clear halt and resubmit */
1243 if (!priv
->comm_is_ok
)
1245 usb_clear_halt(port
->serial
->dev
, 0x02);
1246 /* error in the urb, so we have to resubmit it */
1247 dev_dbg(dev
, "%s - nonzero write bulk status received: %d\n",
1249 port
->interrupt_out_urb
->transfer_buffer_length
= 1;
1250 result
= usb_submit_urb(port
->interrupt_out_urb
, GFP_ATOMIC
);
1253 dev_err(dev
, "%s - failed resubmitting write urb, error %d\n",
1255 cypress_set_dead(port
);
1258 dev_err(dev
, "%s - unexpected nonzero write status received: %d\n",
1260 cypress_set_dead(port
);
1263 priv
->write_urb_in_use
= 0;
1265 /* send any buffered data */
1269 module_usb_serial_driver(serial_drivers
, id_table_combined
);
1271 MODULE_AUTHOR(DRIVER_AUTHOR
);
1272 MODULE_DESCRIPTION(DRIVER_DESC
);
1273 MODULE_LICENSE("GPL");
1275 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1276 MODULE_PARM_DESC(stats
, "Enable statistics or not");
1277 module_param(interval
, int, S_IRUGO
| S_IWUSR
);
1278 MODULE_PARM_DESC(interval
, "Overrides interrupt interval");
1279 module_param(unstable_bauds
, bool, S_IRUGO
| S_IWUSR
);
1280 MODULE_PARM_DESC(unstable_bauds
, "Allow unstable baud rates");