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.
20 * Lonnie Mendez <dignome@gmail.com>
22 * Fixed problem where setting or retreiving the serial config would fail
23 * with EPIPE. Removed CRTS toggling so the driver behaves more like
24 * other usbserial adapters. Issued new interval of 1ms instead of the
25 * default 10ms. As a result, transfer speed has been substantially
26 * increased from avg. 850bps to avg. 3300bps. initial termios has also
27 * been modified. Cleaned up code and formatting issues so it is more
28 * readable. Replaced the C++ style comments.
30 * Lonnie Mendez <dignome@gmail.com>
32 * Incorporated write buffering from pl2303 driver. Fixed bug with line
33 * handling so both lines are raised in cypress_open. (was dropping rts)
34 * Various code cleanups made as well along with other misc bug fixes.
36 * Lonnie Mendez <dignome@gmail.com>
38 * Driver modified to support dynamic line settings. Various improvments
43 * Driver first released.
47 /* Thanks to Neil Whelchel for writing the first cypress m8 implementation
49 /* Thanks to cypress for providing references for the hid reports. */
50 /* Thanks to Jiang Zhang for providing links and for general help. */
51 /* Code originates and was built up from ftdi_sio, belkin, pl2303 and others.*/
54 #include <linux/kernel.h>
55 #include <linux/errno.h>
56 #include <linux/init.h>
57 #include <linux/slab.h>
58 #include <linux/tty.h>
59 #include <linux/tty_driver.h>
60 #include <linux/tty_flip.h>
61 #include <linux/module.h>
62 #include <linux/moduleparam.h>
63 #include <linux/spinlock.h>
64 #include <linux/usb.h>
65 #include <linux/usb/serial.h>
66 #include <linux/serial.h>
67 #include <linux/kfifo.h>
68 #include <linux/delay.h>
69 #include <linux/uaccess.h>
70 #include <asm/unaligned.h>
72 #include "cypress_m8.h"
78 static int unstable_bauds
;
83 #define DRIVER_VERSION "v1.10"
84 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
85 #define DRIVER_DESC "Cypress USB to Serial Driver"
87 /* write buffer size defines */
88 #define CYPRESS_BUF_SIZE 1024
90 static const struct usb_device_id id_table_earthmate
[] = {
91 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB
) },
92 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB_LT20
) },
93 { } /* Terminating entry */
96 static const struct usb_device_id id_table_cyphidcomrs232
[] = {
97 { USB_DEVICE(VENDOR_ID_CYPRESS
, PRODUCT_ID_CYPHIDCOM
) },
98 { USB_DEVICE(VENDOR_ID_POWERCOM
, PRODUCT_ID_UPS
) },
99 { } /* Terminating entry */
102 static const struct usb_device_id id_table_nokiaca42v2
[] = {
103 { USB_DEVICE(VENDOR_ID_DAZZLE
, PRODUCT_ID_CA42
) },
104 { } /* Terminating entry */
107 static const struct usb_device_id id_table_combined
[] = {
108 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB
) },
109 { USB_DEVICE(VENDOR_ID_DELORME
, PRODUCT_ID_EARTHMATEUSB_LT20
) },
110 { USB_DEVICE(VENDOR_ID_CYPRESS
, PRODUCT_ID_CYPHIDCOM
) },
111 { USB_DEVICE(VENDOR_ID_POWERCOM
, PRODUCT_ID_UPS
) },
112 { USB_DEVICE(VENDOR_ID_DAZZLE
, PRODUCT_ID_CA42
) },
113 { } /* Terminating entry */
116 MODULE_DEVICE_TABLE(usb
, id_table_combined
);
118 static struct usb_driver cypress_driver
= {
120 .probe
= usb_serial_probe
,
121 .disconnect
= usb_serial_disconnect
,
122 .id_table
= id_table_combined
,
127 packet_format_1
, /* b0:status, b1:payload count */
128 packet_format_2
/* b0[7:3]:status, b0[2:0]:payload count */
131 struct cypress_private
{
132 spinlock_t lock
; /* private lock */
133 int chiptype
; /* identifier of device, for quirks/etc */
134 int bytes_in
; /* used for statistics */
135 int bytes_out
; /* used for statistics */
136 int cmd_count
; /* used for statistics */
137 int cmd_ctrl
; /* always set this to 1 before issuing a command */
138 struct kfifo write_fifo
; /* write fifo */
139 int write_urb_in_use
; /* write urb in use indicator */
140 int write_urb_interval
; /* interval to use for write urb */
141 int read_urb_interval
; /* interval to use for read urb */
142 int comm_is_ok
; /* true if communication is (still) ok */
143 int termios_initialized
;
144 __u8 line_control
; /* holds dtr / rts value */
145 __u8 current_status
; /* received from last read - info on dsr,cts,cd,ri,etc */
146 __u8 current_config
; /* stores the current configuration byte */
147 __u8 rx_flags
; /* throttling - used from whiteheat/ftdi_sio */
148 enum packet_format pkt_fmt
; /* format to use for packet send / receive */
149 int get_cfg_unsafe
; /* If true, the CYPRESS_GET_CONFIG is unsafe */
150 int baud_rate
; /* stores current baud rate in
152 int isthrottled
; /* if throttled, discard reads */
153 wait_queue_head_t delta_msr_wait
; /* used for TIOCMIWAIT */
154 char prev_status
, diff_status
; /* used for TIOCMIWAIT */
155 /* we pass a pointer to this as the argument sent to
156 cypress_set_termios old_termios */
157 struct ktermios tmp_termios
; /* stores the old termios settings */
160 /* function prototypes for the Cypress USB to serial device */
161 static int cypress_earthmate_startup(struct usb_serial
*serial
);
162 static int cypress_hidcom_startup(struct usb_serial
*serial
);
163 static int cypress_ca42v2_startup(struct usb_serial
*serial
);
164 static void cypress_release(struct usb_serial
*serial
);
165 static int cypress_open(struct tty_struct
*tty
, struct usb_serial_port
*port
);
166 static void cypress_close(struct usb_serial_port
*port
);
167 static void cypress_dtr_rts(struct usb_serial_port
*port
, int on
);
168 static int cypress_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
169 const unsigned char *buf
, int count
);
170 static void cypress_send(struct usb_serial_port
*port
);
171 static int cypress_write_room(struct tty_struct
*tty
);
172 static int cypress_ioctl(struct tty_struct
*tty
, struct file
*file
,
173 unsigned int cmd
, unsigned long arg
);
174 static void cypress_set_termios(struct tty_struct
*tty
,
175 struct usb_serial_port
*port
, struct ktermios
*old
);
176 static int cypress_tiocmget(struct tty_struct
*tty
);
177 static int cypress_tiocmset(struct tty_struct
*tty
,
178 unsigned int set
, unsigned int clear
);
179 static int cypress_chars_in_buffer(struct tty_struct
*tty
);
180 static void cypress_throttle(struct tty_struct
*tty
);
181 static void cypress_unthrottle(struct tty_struct
*tty
);
182 static void cypress_set_dead(struct usb_serial_port
*port
);
183 static void cypress_read_int_callback(struct urb
*urb
);
184 static void cypress_write_int_callback(struct urb
*urb
);
186 static struct usb_serial_driver cypress_earthmate_device
= {
188 .owner
= THIS_MODULE
,
191 .description
= "DeLorme Earthmate USB",
192 .usb_driver
= &cypress_driver
,
193 .id_table
= id_table_earthmate
,
195 .attach
= cypress_earthmate_startup
,
196 .release
= cypress_release
,
197 .open
= cypress_open
,
198 .close
= cypress_close
,
199 .dtr_rts
= cypress_dtr_rts
,
200 .write
= cypress_write
,
201 .write_room
= cypress_write_room
,
202 .ioctl
= cypress_ioctl
,
203 .set_termios
= cypress_set_termios
,
204 .tiocmget
= cypress_tiocmget
,
205 .tiocmset
= cypress_tiocmset
,
206 .chars_in_buffer
= cypress_chars_in_buffer
,
207 .throttle
= cypress_throttle
,
208 .unthrottle
= cypress_unthrottle
,
209 .read_int_callback
= cypress_read_int_callback
,
210 .write_int_callback
= cypress_write_int_callback
,
213 static struct usb_serial_driver cypress_hidcom_device
= {
215 .owner
= THIS_MODULE
,
218 .description
= "HID->COM RS232 Adapter",
219 .usb_driver
= &cypress_driver
,
220 .id_table
= id_table_cyphidcomrs232
,
222 .attach
= cypress_hidcom_startup
,
223 .release
= cypress_release
,
224 .open
= cypress_open
,
225 .close
= cypress_close
,
226 .dtr_rts
= cypress_dtr_rts
,
227 .write
= cypress_write
,
228 .write_room
= cypress_write_room
,
229 .ioctl
= cypress_ioctl
,
230 .set_termios
= cypress_set_termios
,
231 .tiocmget
= cypress_tiocmget
,
232 .tiocmset
= cypress_tiocmset
,
233 .chars_in_buffer
= cypress_chars_in_buffer
,
234 .throttle
= cypress_throttle
,
235 .unthrottle
= cypress_unthrottle
,
236 .read_int_callback
= cypress_read_int_callback
,
237 .write_int_callback
= cypress_write_int_callback
,
240 static struct usb_serial_driver cypress_ca42v2_device
= {
242 .owner
= THIS_MODULE
,
243 .name
= "nokiaca42v2",
245 .description
= "Nokia CA-42 V2 Adapter",
246 .usb_driver
= &cypress_driver
,
247 .id_table
= id_table_nokiaca42v2
,
249 .attach
= cypress_ca42v2_startup
,
250 .release
= cypress_release
,
251 .open
= cypress_open
,
252 .close
= cypress_close
,
253 .dtr_rts
= cypress_dtr_rts
,
254 .write
= cypress_write
,
255 .write_room
= cypress_write_room
,
256 .ioctl
= cypress_ioctl
,
257 .set_termios
= cypress_set_termios
,
258 .tiocmget
= cypress_tiocmget
,
259 .tiocmset
= cypress_tiocmset
,
260 .chars_in_buffer
= cypress_chars_in_buffer
,
261 .throttle
= cypress_throttle
,
262 .unthrottle
= cypress_unthrottle
,
263 .read_int_callback
= cypress_read_int_callback
,
264 .write_int_callback
= cypress_write_int_callback
,
267 /*****************************************************************************
268 * Cypress serial helper functions
269 *****************************************************************************/
272 static int analyze_baud_rate(struct usb_serial_port
*port
, speed_t new_rate
)
274 struct cypress_private
*priv
;
275 priv
= usb_get_serial_port_data(port
);
281 * The general purpose firmware for the Cypress M8 allows for
282 * a maximum speed of 57600bps (I have no idea whether DeLorme
283 * chose to use the general purpose firmware or not), if you
284 * need to modify this speed setting for your own project
285 * please add your own chiptype and modify the code likewise.
286 * The Cypress HID->COM device will work successfully up to
287 * 115200bps (but the actual throughput is around 3kBps).
289 if (port
->serial
->dev
->speed
== USB_SPEED_LOW
) {
291 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
292 * Cypress app note that describes this mechanism
293 * states the the low-speed part can't handle more
294 * than 800 bytes/sec, in which case 4800 baud is the
295 * safest speed for a part like that.
297 if (new_rate
> 4800) {
298 dbg("%s - failed setting baud rate, device incapable "
299 "speed %d", __func__
, new_rate
);
303 switch (priv
->chiptype
) {
305 if (new_rate
<= 600) {
306 /* 300 and 600 baud rates are supported under
307 * the generic firmware, but are not used with
308 * NMEA and SiRF protocols */
309 dbg("%s - failed setting baud rate, unsupported speed "
310 "of %d on Earthmate GPS", __func__
, new_rate
);
321 /* This function can either set or retrieve the current serial line settings */
322 static int cypress_serial_control(struct tty_struct
*tty
,
323 struct usb_serial_port
*port
, speed_t baud_rate
, int data_bits
,
324 int stop_bits
, int parity_enable
, int parity_type
, int reset
,
325 int cypress_request_type
)
327 int new_baudrate
= 0, retval
= 0, tries
= 0;
328 struct cypress_private
*priv
;
330 const unsigned int feature_len
= 5;
335 priv
= usb_get_serial_port_data(port
);
337 if (!priv
->comm_is_ok
)
340 feature_buffer
= kcalloc(feature_len
, sizeof(u8
), GFP_KERNEL
);
344 switch (cypress_request_type
) {
345 case CYPRESS_SET_CONFIG
:
346 /* 0 means 'Hang up' so doesn't change the true bit rate */
347 new_baudrate
= priv
->baud_rate
;
348 if (baud_rate
&& baud_rate
!= priv
->baud_rate
) {
349 dbg("%s - baud rate is changing", __func__
);
350 retval
= analyze_baud_rate(port
, baud_rate
);
352 new_baudrate
= retval
;
353 dbg("%s - New baud rate set to %d",
354 __func__
, new_baudrate
);
357 dbg("%s - baud rate is being sent as %d",
358 __func__
, new_baudrate
);
360 /* fill the feature_buffer with new configuration */
361 put_unaligned_le32(new_baudrate
, feature_buffer
);
362 feature_buffer
[4] |= data_bits
; /* assign data bits in 2 bit space ( max 3 ) */
364 feature_buffer
[4] |= (stop_bits
<< 3); /* assign stop bits in 1 bit space */
365 feature_buffer
[4] |= (parity_enable
<< 4); /* assign parity flag in 1 bit space */
366 feature_buffer
[4] |= (parity_type
<< 5); /* assign parity type in 1 bit space */
368 feature_buffer
[4] |= (reset
<< 7); /* assign reset at end of byte, 1 bit space */
370 dbg("%s - device is being sent this feature report:",
372 dbg("%s - %02X - %02X - %02X - %02X - %02X", __func__
,
373 feature_buffer
[0], feature_buffer
[1],
374 feature_buffer
[2], feature_buffer
[3],
378 retval
= usb_control_msg(port
->serial
->dev
,
379 usb_sndctrlpipe(port
->serial
->dev
, 0),
381 USB_DIR_OUT
| USB_RECIP_INTERFACE
| USB_TYPE_CLASS
,
382 0x0300, 0, feature_buffer
,
388 } while (retval
!= feature_len
&&
391 if (retval
!= feature_len
) {
392 dev_err(&port
->dev
, "%s - failed sending serial "
393 "line settings - %d\n", __func__
, retval
);
394 cypress_set_dead(port
);
396 spin_lock_irqsave(&priv
->lock
, flags
);
397 priv
->baud_rate
= new_baudrate
;
398 priv
->current_config
= feature_buffer
[4];
399 spin_unlock_irqrestore(&priv
->lock
, flags
);
400 /* If we asked for a speed change encode it */
402 tty_encode_baud_rate(tty
,
403 new_baudrate
, new_baudrate
);
406 case CYPRESS_GET_CONFIG
:
407 if (priv
->get_cfg_unsafe
) {
408 /* Not implemented for this device,
409 and if we try to do it we're likely
410 to crash the hardware. */
414 dbg("%s - retreiving serial line settings", __func__
);
416 retval
= usb_control_msg(port
->serial
->dev
,
417 usb_rcvctrlpipe(port
->serial
->dev
, 0),
419 USB_DIR_IN
| USB_RECIP_INTERFACE
| USB_TYPE_CLASS
,
420 0x0300, 0, feature_buffer
,
425 } while (retval
!= feature_len
426 && retval
!= -ENODEV
);
428 if (retval
!= feature_len
) {
429 dev_err(&port
->dev
, "%s - failed to retrieve serial "
430 "line settings - %d\n", __func__
, retval
);
431 cypress_set_dead(port
);
434 spin_lock_irqsave(&priv
->lock
, flags
);
435 /* store the config in one byte, and later
436 use bit masks to check values */
437 priv
->current_config
= feature_buffer
[4];
438 priv
->baud_rate
= get_unaligned_le32(feature_buffer
);
439 spin_unlock_irqrestore(&priv
->lock
, flags
);
442 spin_lock_irqsave(&priv
->lock
, flags
);
444 spin_unlock_irqrestore(&priv
->lock
, flags
);
446 kfree(feature_buffer
);
448 } /* cypress_serial_control */
451 static void cypress_set_dead(struct usb_serial_port
*port
)
453 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
456 spin_lock_irqsave(&priv
->lock
, flags
);
457 if (!priv
->comm_is_ok
) {
458 spin_unlock_irqrestore(&priv
->lock
, flags
);
461 priv
->comm_is_ok
= 0;
462 spin_unlock_irqrestore(&priv
->lock
, flags
);
464 dev_err(&port
->dev
, "cypress_m8 suspending failing port %d - "
465 "interval might be too short\n", port
->number
);
469 /*****************************************************************************
470 * Cypress serial driver functions
471 *****************************************************************************/
474 static int generic_startup(struct usb_serial
*serial
)
476 struct cypress_private
*priv
;
477 struct usb_serial_port
*port
= serial
->port
[0];
479 dbg("%s - port %d", __func__
, port
->number
);
481 priv
= kzalloc(sizeof(struct cypress_private
), GFP_KERNEL
);
485 priv
->comm_is_ok
= !0;
486 spin_lock_init(&priv
->lock
);
487 if (kfifo_alloc(&priv
->write_fifo
, CYPRESS_BUF_SIZE
, GFP_KERNEL
)) {
491 init_waitqueue_head(&priv
->delta_msr_wait
);
493 usb_reset_configuration(serial
->dev
);
496 priv
->line_control
= 0;
497 priv
->termios_initialized
= 0;
499 /* Default packet format setting is determined by packet size.
500 Anything with a size larger then 9 must have a separate
501 count field since the 3 bit count field is otherwise too
502 small. Otherwise we can use the slightly more compact
503 format. This is in accordance with the cypress_m8 serial
504 converter app note. */
505 if (port
->interrupt_out_size
> 9)
506 priv
->pkt_fmt
= packet_format_1
;
508 priv
->pkt_fmt
= packet_format_2
;
511 priv
->write_urb_interval
= interval
;
512 priv
->read_urb_interval
= interval
;
513 dbg("%s - port %d read & write intervals forced to %d",
514 __func__
, port
->number
, interval
);
516 priv
->write_urb_interval
= port
->interrupt_out_urb
->interval
;
517 priv
->read_urb_interval
= port
->interrupt_in_urb
->interval
;
518 dbg("%s - port %d intervals: read=%d write=%d",
519 __func__
, port
->number
,
520 priv
->read_urb_interval
, priv
->write_urb_interval
);
522 usb_set_serial_port_data(port
, priv
);
528 static int cypress_earthmate_startup(struct usb_serial
*serial
)
530 struct cypress_private
*priv
;
531 struct usb_serial_port
*port
= serial
->port
[0];
535 if (generic_startup(serial
)) {
536 dbg("%s - Failed setting up port %d", __func__
,
541 priv
= usb_get_serial_port_data(port
);
542 priv
->chiptype
= CT_EARTHMATE
;
543 /* All Earthmate devices use the separated-count packet
545 priv
->pkt_fmt
= packet_format_1
;
546 if (serial
->dev
->descriptor
.idProduct
!=
547 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB
)) {
548 /* The old original USB Earthmate seemed able to
549 handle GET_CONFIG requests; everything they've
550 produced since that time crashes if this command is
552 dbg("%s - Marking this device as unsafe for GET_CONFIG "
553 "commands", __func__
);
554 priv
->get_cfg_unsafe
= !0;
558 } /* cypress_earthmate_startup */
561 static int cypress_hidcom_startup(struct usb_serial
*serial
)
563 struct cypress_private
*priv
;
567 if (generic_startup(serial
)) {
568 dbg("%s - Failed setting up port %d", __func__
,
569 serial
->port
[0]->number
);
573 priv
= usb_get_serial_port_data(serial
->port
[0]);
574 priv
->chiptype
= CT_CYPHIDCOM
;
577 } /* cypress_hidcom_startup */
580 static int cypress_ca42v2_startup(struct usb_serial
*serial
)
582 struct cypress_private
*priv
;
586 if (generic_startup(serial
)) {
587 dbg("%s - Failed setting up port %d", __func__
,
588 serial
->port
[0]->number
);
592 priv
= usb_get_serial_port_data(serial
->port
[0]);
593 priv
->chiptype
= CT_CA42V2
;
596 } /* cypress_ca42v2_startup */
599 static void cypress_release(struct usb_serial
*serial
)
601 struct cypress_private
*priv
;
603 dbg("%s - port %d", __func__
, serial
->port
[0]->number
);
605 /* all open ports are closed at this point */
607 priv
= usb_get_serial_port_data(serial
->port
[0]);
610 kfifo_free(&priv
->write_fifo
);
616 static int cypress_open(struct tty_struct
*tty
, struct usb_serial_port
*port
)
618 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
619 struct usb_serial
*serial
= port
->serial
;
623 dbg("%s - port %d", __func__
, port
->number
);
625 if (!priv
->comm_is_ok
)
628 /* clear halts before open */
629 usb_clear_halt(serial
->dev
, 0x81);
630 usb_clear_halt(serial
->dev
, 0x02);
632 spin_lock_irqsave(&priv
->lock
, flags
);
633 /* reset read/write statistics */
638 spin_unlock_irqrestore(&priv
->lock
, flags
);
644 cypress_set_termios(tty
, port
, &priv
->tmp_termios
);
646 /* setup the port and start reading from the device */
647 if (!port
->interrupt_in_urb
) {
648 dev_err(&port
->dev
, "%s - interrupt_in_urb is empty!\n",
653 usb_fill_int_urb(port
->interrupt_in_urb
, serial
->dev
,
654 usb_rcvintpipe(serial
->dev
, port
->interrupt_in_endpointAddress
),
655 port
->interrupt_in_urb
->transfer_buffer
,
656 port
->interrupt_in_urb
->transfer_buffer_length
,
657 cypress_read_int_callback
, port
, priv
->read_urb_interval
);
658 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
662 "%s - failed submitting read urb, error %d\n",
664 cypress_set_dead(port
);
666 port
->port
.drain_delay
= 256;
670 static void cypress_dtr_rts(struct usb_serial_port
*port
, int on
)
672 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
673 /* drop dtr and rts */
674 spin_lock_irq(&priv
->lock
);
676 priv
->line_control
= 0;
678 priv
->line_control
= CONTROL_DTR
| CONTROL_RTS
;
680 spin_unlock_irq(&priv
->lock
);
681 cypress_write(NULL
, port
, NULL
, 0);
684 static void cypress_close(struct usb_serial_port
*port
)
686 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
689 dbg("%s - port %d", __func__
, port
->number
);
691 /* writing is potentially harmful, lock must be taken */
692 mutex_lock(&port
->serial
->disc_mutex
);
693 if (port
->serial
->disconnected
) {
694 mutex_unlock(&port
->serial
->disc_mutex
);
697 spin_lock_irqsave(&priv
->lock
, flags
);
698 kfifo_reset_out(&priv
->write_fifo
);
699 spin_unlock_irqrestore(&priv
->lock
, flags
);
701 dbg("%s - stopping urbs", __func__
);
702 usb_kill_urb(port
->interrupt_in_urb
);
703 usb_kill_urb(port
->interrupt_out_urb
);
706 dev_info(&port
->dev
, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
707 priv
->bytes_in
, priv
->bytes_out
, priv
->cmd_count
);
708 mutex_unlock(&port
->serial
->disc_mutex
);
709 } /* cypress_close */
712 static int cypress_write(struct tty_struct
*tty
, struct usb_serial_port
*port
,
713 const unsigned char *buf
, int count
)
715 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
717 dbg("%s - port %d, %d bytes", __func__
, port
->number
, count
);
719 /* line control commands, which need to be executed immediately,
720 are not put into the buffer for obvious reasons.
722 if (priv
->cmd_ctrl
) {
730 count
= kfifo_in_locked(&priv
->write_fifo
, buf
, count
, &priv
->lock
);
736 } /* cypress_write */
739 static void cypress_send(struct usb_serial_port
*port
)
741 int count
= 0, result
, offset
, actual_size
;
742 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
745 if (!priv
->comm_is_ok
)
748 dbg("%s - port %d", __func__
, port
->number
);
749 dbg("%s - interrupt out size is %d", __func__
,
750 port
->interrupt_out_size
);
752 spin_lock_irqsave(&priv
->lock
, flags
);
753 if (priv
->write_urb_in_use
) {
754 dbg("%s - can't write, urb in use", __func__
);
755 spin_unlock_irqrestore(&priv
->lock
, flags
);
758 spin_unlock_irqrestore(&priv
->lock
, flags
);
761 memset(port
->interrupt_out_urb
->transfer_buffer
, 0,
762 port
->interrupt_out_size
);
764 spin_lock_irqsave(&priv
->lock
, flags
);
765 switch (priv
->pkt_fmt
) {
767 case packet_format_1
:
768 /* this is for the CY7C64013... */
770 port
->interrupt_out_buffer
[0] = priv
->line_control
;
772 case packet_format_2
:
773 /* this is for the CY7C63743... */
775 port
->interrupt_out_buffer
[0] = priv
->line_control
;
779 if (priv
->line_control
& CONTROL_RESET
)
780 priv
->line_control
&= ~CONTROL_RESET
;
782 if (priv
->cmd_ctrl
) {
784 dbg("%s - line control command being issued", __func__
);
785 spin_unlock_irqrestore(&priv
->lock
, flags
);
788 spin_unlock_irqrestore(&priv
->lock
, flags
);
790 count
= kfifo_out_locked(&priv
->write_fifo
,
791 &port
->interrupt_out_buffer
[offset
],
792 port
->interrupt_out_size
- offset
,
797 switch (priv
->pkt_fmt
) {
799 case packet_format_1
:
800 port
->interrupt_out_buffer
[1] = count
;
802 case packet_format_2
:
803 port
->interrupt_out_buffer
[0] |= count
;
806 dbg("%s - count is %d", __func__
, count
);
809 spin_lock_irqsave(&priv
->lock
, flags
);
810 priv
->write_urb_in_use
= 1;
811 spin_unlock_irqrestore(&priv
->lock
, flags
);
816 actual_size
= count
+
817 (priv
->pkt_fmt
== packet_format_1
? 2 : 1);
819 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
820 port
->interrupt_out_size
,
821 port
->interrupt_out_urb
->transfer_buffer
);
823 usb_fill_int_urb(port
->interrupt_out_urb
, port
->serial
->dev
,
824 usb_sndintpipe(port
->serial
->dev
, port
->interrupt_out_endpointAddress
),
825 port
->interrupt_out_buffer
, port
->interrupt_out_size
,
826 cypress_write_int_callback
, port
, priv
->write_urb_interval
);
827 result
= usb_submit_urb(port
->interrupt_out_urb
, GFP_ATOMIC
);
830 "%s - failed submitting write urb, error %d\n",
832 priv
->write_urb_in_use
= 0;
833 cypress_set_dead(port
);
836 spin_lock_irqsave(&priv
->lock
, flags
);
840 /* do not count the line control and size bytes */
841 priv
->bytes_out
+= count
;
842 spin_unlock_irqrestore(&priv
->lock
, flags
);
844 usb_serial_port_softint(port
);
848 /* returns how much space is available in the soft buffer */
849 static int cypress_write_room(struct tty_struct
*tty
)
851 struct usb_serial_port
*port
= tty
->driver_data
;
852 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
856 dbg("%s - port %d", __func__
, port
->number
);
858 spin_lock_irqsave(&priv
->lock
, flags
);
859 room
= kfifo_avail(&priv
->write_fifo
);
860 spin_unlock_irqrestore(&priv
->lock
, flags
);
862 dbg("%s - returns %d", __func__
, room
);
867 static int cypress_tiocmget(struct tty_struct
*tty
)
869 struct usb_serial_port
*port
= tty
->driver_data
;
870 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
871 __u8 status
, control
;
872 unsigned int result
= 0;
875 dbg("%s - port %d", __func__
, port
->number
);
877 spin_lock_irqsave(&priv
->lock
, flags
);
878 control
= priv
->line_control
;
879 status
= priv
->current_status
;
880 spin_unlock_irqrestore(&priv
->lock
, flags
);
882 result
= ((control
& CONTROL_DTR
) ? TIOCM_DTR
: 0)
883 | ((control
& CONTROL_RTS
) ? TIOCM_RTS
: 0)
884 | ((status
& UART_CTS
) ? TIOCM_CTS
: 0)
885 | ((status
& UART_DSR
) ? TIOCM_DSR
: 0)
886 | ((status
& UART_RI
) ? TIOCM_RI
: 0)
887 | ((status
& UART_CD
) ? TIOCM_CD
: 0);
889 dbg("%s - result = %x", __func__
, result
);
895 static int cypress_tiocmset(struct tty_struct
*tty
,
896 unsigned int set
, unsigned int clear
)
898 struct usb_serial_port
*port
= tty
->driver_data
;
899 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
902 dbg("%s - port %d", __func__
, port
->number
);
904 spin_lock_irqsave(&priv
->lock
, flags
);
906 priv
->line_control
|= CONTROL_RTS
;
908 priv
->line_control
|= CONTROL_DTR
;
909 if (clear
& TIOCM_RTS
)
910 priv
->line_control
&= ~CONTROL_RTS
;
911 if (clear
& TIOCM_DTR
)
912 priv
->line_control
&= ~CONTROL_DTR
;
914 spin_unlock_irqrestore(&priv
->lock
, flags
);
916 return cypress_write(tty
, port
, NULL
, 0);
920 static int cypress_ioctl(struct tty_struct
*tty
, struct file
*file
,
921 unsigned int cmd
, unsigned long arg
)
923 struct usb_serial_port
*port
= tty
->driver_data
;
924 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
926 dbg("%s - port %d, cmd 0x%.4x", __func__
, port
->number
, cmd
);
929 /* This code comes from drivers/char/serial.c and ftdi_sio.c */
931 while (priv
!= NULL
) {
932 interruptible_sleep_on(&priv
->delta_msr_wait
);
933 /* see if a signal did it */
934 if (signal_pending(current
))
937 char diff
= priv
->diff_status
;
939 return -EIO
; /* no change => error */
941 /* consume all events */
942 priv
->diff_status
= 0;
944 /* return 0 if caller wanted to know about
946 if (((arg
& TIOCM_RNG
) && (diff
& UART_RI
)) ||
947 ((arg
& TIOCM_DSR
) && (diff
& UART_DSR
)) ||
948 ((arg
& TIOCM_CD
) && (diff
& UART_CD
)) ||
949 ((arg
& TIOCM_CTS
) && (diff
& UART_CTS
)))
951 /* otherwise caller can't care less about what
952 * happened, and so we continue to wait for
961 dbg("%s - arg not supported - it was 0x%04x - check include/asm/ioctls.h", __func__
, cmd
);
963 } /* cypress_ioctl */
966 static void cypress_set_termios(struct tty_struct
*tty
,
967 struct usb_serial_port
*port
, struct ktermios
*old_termios
)
969 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
970 int data_bits
, stop_bits
, parity_type
, parity_enable
;
971 unsigned cflag
, iflag
;
976 dbg("%s - port %d", __func__
, port
->number
);
978 spin_lock_irqsave(&priv
->lock
, flags
);
979 /* We can't clean this one up as we don't know the device type
981 if (!priv
->termios_initialized
) {
982 if (priv
->chiptype
== CT_EARTHMATE
) {
983 *(tty
->termios
) = tty_std_termios
;
984 tty
->termios
->c_cflag
= B4800
| CS8
| CREAD
| HUPCL
|
986 tty
->termios
->c_ispeed
= 4800;
987 tty
->termios
->c_ospeed
= 4800;
988 } else if (priv
->chiptype
== CT_CYPHIDCOM
) {
989 *(tty
->termios
) = tty_std_termios
;
990 tty
->termios
->c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
992 tty
->termios
->c_ispeed
= 9600;
993 tty
->termios
->c_ospeed
= 9600;
994 } else if (priv
->chiptype
== CT_CA42V2
) {
995 *(tty
->termios
) = tty_std_termios
;
996 tty
->termios
->c_cflag
= B9600
| CS8
| CREAD
| HUPCL
|
998 tty
->termios
->c_ispeed
= 9600;
999 tty
->termios
->c_ospeed
= 9600;
1001 priv
->termios_initialized
= 1;
1003 spin_unlock_irqrestore(&priv
->lock
, flags
);
1005 /* Unsupported features need clearing */
1006 tty
->termios
->c_cflag
&= ~(CMSPAR
|CRTSCTS
);
1008 cflag
= tty
->termios
->c_cflag
;
1009 iflag
= tty
->termios
->c_iflag
;
1011 /* check if there are new settings */
1013 spin_lock_irqsave(&priv
->lock
, flags
);
1014 priv
->tmp_termios
= *(tty
->termios
);
1015 spin_unlock_irqrestore(&priv
->lock
, flags
);
1018 /* set number of data bits, parity, stop bits */
1019 /* when parity is disabled the parity type bit is ignored */
1021 /* 1 means 2 stop bits, 0 means 1 stop bit */
1022 stop_bits
= cflag
& CSTOPB
? 1 : 0;
1024 if (cflag
& PARENB
) {
1026 /* 1 means odd parity, 0 means even parity */
1027 parity_type
= cflag
& PARODD
? 1 : 0;
1029 parity_enable
= parity_type
= 0;
1031 switch (cflag
& CSIZE
) {
1045 dev_err(&port
->dev
, "%s - CSIZE was set, but not CS5-CS8\n",
1049 spin_lock_irqsave(&priv
->lock
, flags
);
1050 oldlines
= priv
->line_control
;
1051 if ((cflag
& CBAUD
) == B0
) {
1052 /* drop dtr and rts */
1053 dbg("%s - dropping the lines, baud rate 0bps", __func__
);
1054 priv
->line_control
&= ~(CONTROL_DTR
| CONTROL_RTS
);
1056 priv
->line_control
= (CONTROL_DTR
| CONTROL_RTS
);
1057 spin_unlock_irqrestore(&priv
->lock
, flags
);
1059 dbg("%s - sending %d stop_bits, %d parity_enable, %d parity_type, "
1060 "%d data_bits (+5)", __func__
, stop_bits
,
1061 parity_enable
, parity_type
, data_bits
);
1063 cypress_serial_control(tty
, port
, tty_get_baud_rate(tty
),
1064 data_bits
, stop_bits
,
1065 parity_enable
, parity_type
,
1066 0, CYPRESS_SET_CONFIG
);
1068 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1069 * filled into the private structure this should confirm that all is
1070 * working if it returns what we just set */
1071 cypress_serial_control(tty
, port
, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG
);
1073 /* Here we can define custom tty settings for devices; the main tty
1074 * termios flag base comes from empeg.c */
1076 spin_lock_irqsave(&priv
->lock
, flags
);
1077 if (priv
->chiptype
== CT_EARTHMATE
&& priv
->baud_rate
== 4800) {
1078 dbg("Using custom termios settings for a baud rate of "
1080 /* define custom termios settings for NMEA protocol */
1082 tty
->termios
->c_iflag
/* input modes - */
1083 &= ~(IGNBRK
/* disable ignore break */
1084 | BRKINT
/* disable break causes interrupt */
1085 | PARMRK
/* disable mark parity errors */
1086 | ISTRIP
/* disable clear high bit of input char */
1087 | INLCR
/* disable translate NL to CR */
1088 | IGNCR
/* disable ignore CR */
1089 | ICRNL
/* disable translate CR to NL */
1090 | IXON
); /* disable enable XON/XOFF flow control */
1092 tty
->termios
->c_oflag
/* output modes */
1093 &= ~OPOST
; /* disable postprocess output char */
1095 tty
->termios
->c_lflag
/* line discipline modes */
1096 &= ~(ECHO
/* disable echo input characters */
1097 | ECHONL
/* disable echo new line */
1098 | ICANON
/* disable erase, kill, werase, and rprnt
1099 special characters */
1100 | ISIG
/* disable interrupt, quit, and suspend
1101 special characters */
1102 | IEXTEN
); /* disable non-POSIX special characters */
1103 } /* CT_CYPHIDCOM: Application should handle this for device */
1105 linechange
= (priv
->line_control
!= oldlines
);
1106 spin_unlock_irqrestore(&priv
->lock
, flags
);
1108 /* if necessary, set lines */
1111 cypress_write(tty
, port
, NULL
, 0);
1113 } /* cypress_set_termios */
1116 /* returns amount of data still left in soft buffer */
1117 static int cypress_chars_in_buffer(struct tty_struct
*tty
)
1119 struct usb_serial_port
*port
= tty
->driver_data
;
1120 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1122 unsigned long flags
;
1124 dbg("%s - port %d", __func__
, port
->number
);
1126 spin_lock_irqsave(&priv
->lock
, flags
);
1127 chars
= kfifo_len(&priv
->write_fifo
);
1128 spin_unlock_irqrestore(&priv
->lock
, flags
);
1130 dbg("%s - returns %d", __func__
, chars
);
1135 static void cypress_throttle(struct tty_struct
*tty
)
1137 struct usb_serial_port
*port
= tty
->driver_data
;
1138 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1140 dbg("%s - port %d", __func__
, port
->number
);
1142 spin_lock_irq(&priv
->lock
);
1143 priv
->rx_flags
= THROTTLED
;
1144 spin_unlock_irq(&priv
->lock
);
1148 static void cypress_unthrottle(struct tty_struct
*tty
)
1150 struct usb_serial_port
*port
= tty
->driver_data
;
1151 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1152 int actually_throttled
, result
;
1154 dbg("%s - port %d", __func__
, port
->number
);
1156 spin_lock_irq(&priv
->lock
);
1157 actually_throttled
= priv
->rx_flags
& ACTUALLY_THROTTLED
;
1159 spin_unlock_irq(&priv
->lock
);
1161 if (!priv
->comm_is_ok
)
1164 if (actually_throttled
) {
1165 port
->interrupt_in_urb
->dev
= port
->serial
->dev
;
1167 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_KERNEL
);
1169 dev_err(&port
->dev
, "%s - failed submitting read urb, "
1170 "error %d\n", __func__
, result
);
1171 cypress_set_dead(port
);
1177 static void cypress_read_int_callback(struct urb
*urb
)
1179 struct usb_serial_port
*port
= urb
->context
;
1180 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1181 struct tty_struct
*tty
;
1182 unsigned char *data
= urb
->transfer_buffer
;
1183 unsigned long flags
;
1184 char tty_flag
= TTY_NORMAL
;
1189 int status
= urb
->status
;
1191 dbg("%s - port %d", __func__
, port
->number
);
1194 case 0: /* success */
1199 /* precursor to disconnect so just go away */
1202 /* Can't call usb_clear_halt while in_interrupt */
1205 /* something ugly is going on... */
1206 dev_err(&urb
->dev
->dev
,
1207 "%s - unexpected nonzero read status received: %d\n",
1209 cypress_set_dead(port
);
1213 spin_lock_irqsave(&priv
->lock
, flags
);
1214 if (priv
->rx_flags
& THROTTLED
) {
1215 dbg("%s - now throttling", __func__
);
1216 priv
->rx_flags
|= ACTUALLY_THROTTLED
;
1217 spin_unlock_irqrestore(&priv
->lock
, flags
);
1220 spin_unlock_irqrestore(&priv
->lock
, flags
);
1222 tty
= tty_port_tty_get(&port
->port
);
1224 dbg("%s - bad tty pointer - exiting", __func__
);
1228 spin_lock_irqsave(&priv
->lock
, flags
);
1229 result
= urb
->actual_length
;
1230 switch (priv
->pkt_fmt
) {
1232 case packet_format_1
:
1233 /* This is for the CY7C64013... */
1234 priv
->current_status
= data
[0] & 0xF8;
1235 bytes
= data
[1] + 2;
1240 case packet_format_2
:
1241 /* This is for the CY7C63743... */
1242 priv
->current_status
= data
[0] & 0xF8;
1243 bytes
= (data
[0] & 0x07) + 1;
1249 spin_unlock_irqrestore(&priv
->lock
, flags
);
1250 if (result
< bytes
) {
1251 dbg("%s - wrong packet size - received %d bytes but packet "
1252 "said %d bytes", __func__
, result
, bytes
);
1256 usb_serial_debug_data(debug
, &port
->dev
, __func__
,
1257 urb
->actual_length
, data
);
1259 spin_lock_irqsave(&priv
->lock
, flags
);
1260 /* check to see if status has changed */
1261 if (priv
->current_status
!= priv
->prev_status
) {
1262 priv
->diff_status
|= priv
->current_status
^
1264 wake_up_interruptible(&priv
->delta_msr_wait
);
1265 priv
->prev_status
= priv
->current_status
;
1267 spin_unlock_irqrestore(&priv
->lock
, flags
);
1269 /* hangup, as defined in acm.c... this might be a bad place for it
1271 if (tty
&& !(tty
->termios
->c_cflag
& CLOCAL
) &&
1272 !(priv
->current_status
& UART_CD
)) {
1273 dbg("%s - calling hangup", __func__
);
1278 /* There is one error bit... I'm assuming it is a parity error
1279 * indicator as the generic firmware will set this bit to 1 if a
1280 * parity error occurs.
1281 * I can not find reference to any other error events. */
1282 spin_lock_irqsave(&priv
->lock
, flags
);
1283 if (priv
->current_status
& CYP_ERROR
) {
1284 spin_unlock_irqrestore(&priv
->lock
, flags
);
1285 tty_flag
= TTY_PARITY
;
1286 dbg("%s - Parity Error detected", __func__
);
1288 spin_unlock_irqrestore(&priv
->lock
, flags
);
1290 /* process read if there is data other than line status */
1291 if (tty
&& bytes
> i
) {
1292 tty_insert_flip_string_fixed_flag(tty
, data
+ i
,
1293 tty_flag
, bytes
- i
);
1294 tty_flip_buffer_push(tty
);
1297 spin_lock_irqsave(&priv
->lock
, flags
);
1298 /* control and status byte(s) are also counted */
1299 priv
->bytes_in
+= bytes
;
1300 spin_unlock_irqrestore(&priv
->lock
, flags
);
1305 /* Continue trying to always read */
1307 if (priv
->comm_is_ok
) {
1308 usb_fill_int_urb(port
->interrupt_in_urb
, port
->serial
->dev
,
1309 usb_rcvintpipe(port
->serial
->dev
,
1310 port
->interrupt_in_endpointAddress
),
1311 port
->interrupt_in_urb
->transfer_buffer
,
1312 port
->interrupt_in_urb
->transfer_buffer_length
,
1313 cypress_read_int_callback
, port
,
1314 priv
->read_urb_interval
);
1315 result
= usb_submit_urb(port
->interrupt_in_urb
, GFP_ATOMIC
);
1316 if (result
&& result
!= -EPERM
) {
1317 dev_err(&urb
->dev
->dev
, "%s - failed resubmitting "
1318 "read urb, error %d\n", __func__
,
1320 cypress_set_dead(port
);
1323 } /* cypress_read_int_callback */
1326 static void cypress_write_int_callback(struct urb
*urb
)
1328 struct usb_serial_port
*port
= urb
->context
;
1329 struct cypress_private
*priv
= usb_get_serial_port_data(port
);
1331 int status
= urb
->status
;
1333 dbg("%s - port %d", __func__
, port
->number
);
1342 /* this urb is terminated, clean up */
1343 dbg("%s - urb shutting down with status: %d",
1345 priv
->write_urb_in_use
= 0;
1347 case -EPIPE
: /* no break needed; clear halt and resubmit */
1348 if (!priv
->comm_is_ok
)
1350 usb_clear_halt(port
->serial
->dev
, 0x02);
1351 /* error in the urb, so we have to resubmit it */
1352 dbg("%s - nonzero write bulk status received: %d",
1354 port
->interrupt_out_urb
->transfer_buffer_length
= 1;
1355 port
->interrupt_out_urb
->dev
= port
->serial
->dev
;
1356 result
= usb_submit_urb(port
->interrupt_out_urb
, GFP_ATOMIC
);
1359 dev_err(&urb
->dev
->dev
,
1360 "%s - failed resubmitting write urb, error %d\n",
1362 cypress_set_dead(port
);
1365 dev_err(&urb
->dev
->dev
,
1366 "%s - unexpected nonzero write status received: %d\n",
1368 cypress_set_dead(port
);
1371 priv
->write_urb_in_use
= 0;
1373 /* send any buffered data */
1378 /*****************************************************************************
1380 *****************************************************************************/
1382 static int __init
cypress_init(void)
1386 dbg("%s", __func__
);
1388 retval
= usb_serial_register(&cypress_earthmate_device
);
1390 goto failed_em_register
;
1391 retval
= usb_serial_register(&cypress_hidcom_device
);
1393 goto failed_hidcom_register
;
1394 retval
= usb_serial_register(&cypress_ca42v2_device
);
1396 goto failed_ca42v2_register
;
1397 retval
= usb_register(&cypress_driver
);
1399 goto failed_usb_register
;
1401 printk(KERN_INFO KBUILD_MODNAME
": " DRIVER_VERSION
":"
1405 failed_usb_register
:
1406 usb_serial_deregister(&cypress_ca42v2_device
);
1407 failed_ca42v2_register
:
1408 usb_serial_deregister(&cypress_hidcom_device
);
1409 failed_hidcom_register
:
1410 usb_serial_deregister(&cypress_earthmate_device
);
1416 static void __exit
cypress_exit(void)
1418 dbg("%s", __func__
);
1420 usb_deregister(&cypress_driver
);
1421 usb_serial_deregister(&cypress_earthmate_device
);
1422 usb_serial_deregister(&cypress_hidcom_device
);
1423 usb_serial_deregister(&cypress_ca42v2_device
);
1427 module_init(cypress_init
);
1428 module_exit(cypress_exit
);
1430 MODULE_AUTHOR(DRIVER_AUTHOR
);
1431 MODULE_DESCRIPTION(DRIVER_DESC
);
1432 MODULE_VERSION(DRIVER_VERSION
);
1433 MODULE_LICENSE("GPL");
1435 module_param(debug
, bool, S_IRUGO
| S_IWUSR
);
1436 MODULE_PARM_DESC(debug
, "Debug enabled or not");
1437 module_param(stats
, bool, S_IRUGO
| S_IWUSR
);
1438 MODULE_PARM_DESC(stats
, "Enable statistics or not");
1439 module_param(interval
, int, S_IRUGO
| S_IWUSR
);
1440 MODULE_PARM_DESC(interval
, "Overrides interrupt interval");
1441 module_param(unstable_bauds
, bool, S_IRUGO
| S_IWUSR
);
1442 MODULE_PARM_DESC(unstable_bauds
, "Allow unstable baud rates");