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 driver
16 * See http://geocities.com/i0xox0i for information on this driver and the
17 * earthmate usb device.
19 * Lonnie Mendez <dignome@gmail.com>
21 * Fixed problem where setting or retreiving the serial config would fail with
22 * EPIPE. Removed CRTS toggling so the driver behaves more like other usbserial
23 * adapters. Issued new interval of 1ms instead of the default 10ms. As a
24 * result, transfer speed has been substantially increased. From avg. 850bps to
25 * avg. 3300bps. initial termios has also been modified. Cleaned up code and
26 * formatting issues so it is more readable. Replaced the C++ style comments.
28 * Lonnie Mendez <dignome@gmail.com>
30 * Incorporated write buffering from pl2303 driver. Fixed bug with line
31 * handling so both lines are raised in cypress_open. (was dropping rts)
32 * Various code cleanups made as well along with other misc bug fixes.
34 * Lonnie Mendez <dignome@gmail.com>
36 * Driver modified to support dynamic line settings. Various improvments
41 * Driver first released.
45 /* Thanks to Neil Whelchel for writing the first cypress m8 implementation for linux. */
46 /* Thanks to cypress for providing references for the hid reports. */
47 /* Thanks to Jiang Zhang for providing links and for general help. */
48 /* Code originates and was built up from ftdi_sio, belkin, pl2303 and others. */
51 #include <linux/kernel.h>
52 #include <linux/errno.h>
53 #include <linux/init.h>
54 #include <linux/slab.h>
55 #include <linux/tty.h>
56 #include <linux/tty_driver.h>
57 #include <linux/tty_flip.h>
58 #include <linux/module.h>
59 #include <linux/moduleparam.h>
60 #include <linux/spinlock.h>
61 #include <linux/usb.h>
62 #include <linux/usb/serial.h>
63 #include <linux/serial.h>
64 #include <linux/delay.h>
65 #include <asm/uaccess.h>
67 #include "cypress_m8.h"
70 #ifdef CONFIG_USB_SERIAL_DEBUG
81 #define DRIVER_VERSION "v1.09"
82 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
83 #define DRIVER_DESC "Cypress USB to Serial Driver"
85 /* write buffer size defines */
86 #define CYPRESS_BUF_SIZE 1024
87 #define CYPRESS_CLOSING_WAIT (30*HZ)
89 static struct usb_device_id id_table_earthmate [] = {
90 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
91 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
92 { } /* Terminating entry */
95 static struct usb_device_id id_table_cyphidcomrs232 [] = {
96 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
97 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
98 { } /* Terminating entry */
101 static struct usb_device_id id_table_nokiaca42v2 [] = {
102 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
103 { } /* Terminating entry */
106 static struct usb_device_id id_table_combined [] = {
107 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
108 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
109 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
110 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
111 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
112 { } /* Terminating entry */
115 MODULE_DEVICE_TABLE (usb, id_table_combined);
117 static struct usb_driver cypress_driver = {
119 .probe = usb_serial_probe,
120 .disconnect = usb_serial_disconnect,
121 .id_table = id_table_combined,
126 packet_format_1, /* b0:status, b1:payload count */
127 packet_format_2 /* b0[7:3]:status, b0[2:0]:payload count */
130 struct cypress_private {
131 spinlock_t lock; /* private lock */
132 int chiptype; /* identifier of device, for quirks/etc */
133 int bytes_in; /* used for statistics */
134 int bytes_out; /* used for statistics */
135 int cmd_count; /* used for statistics */
136 int cmd_ctrl; /* always set this to 1 before issuing a command */
137 struct cypress_buf *buf; /* write buffer */
138 int write_urb_in_use; /* write urb in use indicator */
139 int write_urb_interval; /* interval to use for write urb */
140 int read_urb_interval; /* interval to use for read urb */
141 int comm_is_ok; /* true if communication is (still) ok */
142 int termios_initialized;
143 __u8 line_control; /* holds dtr / rts value */
144 __u8 current_status; /* received from last read - info on dsr,cts,cd,ri,etc */
145 __u8 current_config; /* stores the current configuration byte */
146 __u8 rx_flags; /* throttling - used from whiteheat/ftdi_sio */
147 enum packet_format pkt_fmt; /* format to use for packet send / receive */
148 int get_cfg_unsafe; /* If true, the CYPRESS_GET_CONFIG is unsafe */
149 int baud_rate; /* stores current baud rate in integer form */
150 int cbr_mask; /* stores current baud rate in masked form */
151 int isthrottled; /* if throttled, discard reads */
152 wait_queue_head_t delta_msr_wait; /* used for TIOCMIWAIT */
153 char prev_status, diff_status; /* used for TIOCMIWAIT */
154 /* we pass a pointer to this as the arguement sent to cypress_set_termios old_termios */
155 struct ktermios tmp_termios; /* stores the old termios settings */
158 /* write buffer structure */
160 unsigned int buf_size;
166 /* function prototypes for the Cypress USB to serial device */
167 static int cypress_earthmate_startup (struct usb_serial *serial);
168 static int cypress_hidcom_startup (struct usb_serial *serial);
169 static int cypress_ca42v2_startup (struct usb_serial *serial);
170 static void cypress_shutdown (struct usb_serial *serial);
171 static int cypress_open (struct usb_serial_port *port, struct file *filp);
172 static void cypress_close (struct usb_serial_port *port, struct file *filp);
173 static int cypress_write (struct usb_serial_port *port, const unsigned char *buf, int count);
174 static void cypress_send (struct usb_serial_port *port);
175 static int cypress_write_room (struct usb_serial_port *port);
176 static int cypress_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
177 static void cypress_set_termios (struct usb_serial_port *port, struct ktermios * old);
178 static int cypress_tiocmget (struct usb_serial_port *port, struct file *file);
179 static int cypress_tiocmset (struct usb_serial_port *port, struct file *file, unsigned int set, unsigned int clear);
180 static int cypress_chars_in_buffer (struct usb_serial_port *port);
181 static void cypress_throttle (struct usb_serial_port *port);
182 static void cypress_unthrottle (struct usb_serial_port *port);
183 static void cypress_set_dead (struct usb_serial_port *port);
184 static void cypress_read_int_callback (struct urb *urb);
185 static void cypress_write_int_callback (struct urb *urb);
186 /* baud helper functions */
187 static int mask_to_rate (unsigned mask);
188 static unsigned rate_to_mask (int rate);
189 /* write buffer functions */
190 static struct cypress_buf *cypress_buf_alloc(unsigned int size);
191 static void cypress_buf_free(struct cypress_buf *cb);
192 static void cypress_buf_clear(struct cypress_buf *cb);
193 static unsigned int cypress_buf_data_avail(struct cypress_buf *cb);
194 static unsigned int cypress_buf_space_avail(struct cypress_buf *cb);
195 static unsigned int cypress_buf_put(struct cypress_buf *cb, const char *buf, unsigned int count);
196 static unsigned int cypress_buf_get(struct cypress_buf *cb, char *buf, unsigned int count);
199 static struct usb_serial_driver cypress_earthmate_device = {
201 .owner = THIS_MODULE,
204 .description = "DeLorme Earthmate USB",
205 .usb_driver = &cypress_driver,
206 .id_table = id_table_earthmate,
207 .num_interrupt_in = 1,
208 .num_interrupt_out = 1,
209 .num_bulk_in = NUM_DONT_CARE,
210 .num_bulk_out = NUM_DONT_CARE,
212 .attach = cypress_earthmate_startup,
213 .shutdown = cypress_shutdown,
214 .open = cypress_open,
215 .close = cypress_close,
216 .write = cypress_write,
217 .write_room = cypress_write_room,
218 .ioctl = cypress_ioctl,
219 .set_termios = cypress_set_termios,
220 .tiocmget = cypress_tiocmget,
221 .tiocmset = cypress_tiocmset,
222 .chars_in_buffer = cypress_chars_in_buffer,
223 .throttle = cypress_throttle,
224 .unthrottle = cypress_unthrottle,
225 .read_int_callback = cypress_read_int_callback,
226 .write_int_callback = cypress_write_int_callback,
229 static struct usb_serial_driver cypress_hidcom_device = {
231 .owner = THIS_MODULE,
234 .description = "HID->COM RS232 Adapter",
235 .usb_driver = &cypress_driver,
236 .id_table = id_table_cyphidcomrs232,
237 .num_interrupt_in = 1,
238 .num_interrupt_out = 1,
239 .num_bulk_in = NUM_DONT_CARE,
240 .num_bulk_out = NUM_DONT_CARE,
242 .attach = cypress_hidcom_startup,
243 .shutdown = cypress_shutdown,
244 .open = cypress_open,
245 .close = cypress_close,
246 .write = cypress_write,
247 .write_room = cypress_write_room,
248 .ioctl = cypress_ioctl,
249 .set_termios = cypress_set_termios,
250 .tiocmget = cypress_tiocmget,
251 .tiocmset = cypress_tiocmset,
252 .chars_in_buffer = cypress_chars_in_buffer,
253 .throttle = cypress_throttle,
254 .unthrottle = cypress_unthrottle,
255 .read_int_callback = cypress_read_int_callback,
256 .write_int_callback = cypress_write_int_callback,
259 static struct usb_serial_driver cypress_ca42v2_device = {
261 .owner = THIS_MODULE,
262 .name = "nokiaca42v2",
264 .description = "Nokia CA-42 V2 Adapter",
265 .usb_driver = &cypress_driver,
266 .id_table = id_table_nokiaca42v2,
267 .num_interrupt_in = 1,
268 .num_interrupt_out = 1,
269 .num_bulk_in = NUM_DONT_CARE,
270 .num_bulk_out = NUM_DONT_CARE,
272 .attach = cypress_ca42v2_startup,
273 .shutdown = cypress_shutdown,
274 .open = cypress_open,
275 .close = cypress_close,
276 .write = cypress_write,
277 .write_room = cypress_write_room,
278 .ioctl = cypress_ioctl,
279 .set_termios = cypress_set_termios,
280 .tiocmget = cypress_tiocmget,
281 .tiocmset = cypress_tiocmset,
282 .chars_in_buffer = cypress_chars_in_buffer,
283 .throttle = cypress_throttle,
284 .unthrottle = cypress_unthrottle,
285 .read_int_callback = cypress_read_int_callback,
286 .write_int_callback = cypress_write_int_callback,
289 /*****************************************************************************
290 * Cypress serial helper functions
291 *****************************************************************************/
294 /* This function can either set or retrieve the current serial line settings */
295 static int cypress_serial_control (struct usb_serial_port *port, unsigned baud_mask, int data_bits, int stop_bits,
296 int parity_enable, int parity_type, int reset, int cypress_request_type)
298 int new_baudrate = 0, retval = 0, tries = 0;
299 struct cypress_private *priv;
300 __u8 feature_buffer[5];
303 dbg("%s", __FUNCTION__);
305 priv = usb_get_serial_port_data(port);
307 if (!priv->comm_is_ok)
310 switch(cypress_request_type) {
311 case CYPRESS_SET_CONFIG:
314 * The general purpose firmware for the Cypress M8 allows for a maximum speed
315 * of 57600bps (I have no idea whether DeLorme chose to use the general purpose
316 * firmware or not), if you need to modify this speed setting for your own
317 * project please add your own chiptype and modify the code likewise. The
318 * Cypress HID->COM device will work successfully up to 115200bps (but the
319 * actual throughput is around 3kBps).
321 if (baud_mask != priv->cbr_mask) {
322 dbg("%s - baud rate is changing", __FUNCTION__);
323 if ( priv->chiptype == CT_EARTHMATE ) {
324 /* 300 and 600 baud rates are supported under the generic firmware,
325 * but are not used with NMEA and SiRF protocols */
327 if ( (baud_mask == B300) || (baud_mask == B600) ) {
328 err("%s - failed setting baud rate, unsupported speed",
330 new_baudrate = priv->baud_rate;
331 } else if ( (new_baudrate = mask_to_rate(baud_mask)) == -1) {
332 err("%s - failed setting baud rate, unsupported speed",
334 new_baudrate = priv->baud_rate;
336 } else if (priv->chiptype == CT_CYPHIDCOM) {
337 if ( (new_baudrate = mask_to_rate(baud_mask)) == -1) {
338 err("%s - failed setting baud rate, unsupported speed",
340 new_baudrate = priv->baud_rate;
342 } else if (priv->chiptype == CT_CA42V2) {
343 if ( (new_baudrate = mask_to_rate(baud_mask)) == -1) {
344 err("%s - failed setting baud rate, unsupported speed",
346 new_baudrate = priv->baud_rate;
348 } else if (priv->chiptype == CT_GENERIC) {
349 if ( (new_baudrate = mask_to_rate(baud_mask)) == -1) {
350 err("%s - failed setting baud rate, unsupported speed",
352 new_baudrate = priv->baud_rate;
355 info("%s - please define your chiptype", __FUNCTION__);
356 new_baudrate = priv->baud_rate;
358 } else { /* baud rate not changing, keep the old */
359 new_baudrate = priv->baud_rate;
361 dbg("%s - baud rate is being sent as %d", __FUNCTION__, new_baudrate);
363 memset(feature_buffer, 0, sizeof(feature_buffer));
364 /* fill the feature_buffer with new configuration */
365 *((u_int32_t *)feature_buffer) = new_baudrate;
367 feature_buffer[4] |= data_bits; /* assign data bits in 2 bit space ( max 3 ) */
369 feature_buffer[4] |= (stop_bits << 3); /* assign stop bits in 1 bit space */
370 feature_buffer[4] |= (parity_enable << 4); /* assign parity flag in 1 bit space */
371 feature_buffer[4] |= (parity_type << 5); /* assign parity type in 1 bit space */
373 feature_buffer[4] |= (reset << 7); /* assign reset at end of byte, 1 bit space */
375 dbg("%s - device is being sent this feature report:", __FUNCTION__);
376 dbg("%s - %02X - %02X - %02X - %02X - %02X", __FUNCTION__, feature_buffer[0], feature_buffer[1],
377 feature_buffer[2], feature_buffer[3], feature_buffer[4]);
380 retval = usb_control_msg(port->serial->dev,
381 usb_sndctrlpipe(port->serial->dev, 0),
383 USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
384 0x0300, 0, feature_buffer,
385 sizeof(feature_buffer), 500);
390 } while (retval != sizeof(feature_buffer) &&
393 if (retval != sizeof(feature_buffer)) {
394 err("%s - failed sending serial line settings - %d", __FUNCTION__, retval);
395 cypress_set_dead(port);
397 spin_lock_irqsave(&priv->lock, flags);
398 priv->baud_rate = new_baudrate;
399 priv->cbr_mask = baud_mask;
400 priv->current_config = feature_buffer[4];
401 spin_unlock_irqrestore(&priv->lock, flags);
404 case CYPRESS_GET_CONFIG:
405 if (priv->get_cfg_unsafe) {
406 /* Not implemented for this device,
407 and if we try to do it we're likely
408 to crash the hardware. */
411 dbg("%s - retreiving serial line settings", __FUNCTION__);
412 /* set initial values in feature buffer */
413 memset(feature_buffer, 0, sizeof(feature_buffer));
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,
421 sizeof(feature_buffer), 500);
426 } while (retval != sizeof(feature_buffer) &&
429 if (retval != sizeof(feature_buffer)) {
430 err("%s - failed to retrieve serial line settings - %d", __FUNCTION__, retval);
431 cypress_set_dead(port);
434 spin_lock_irqsave(&priv->lock, flags);
436 /* store the config in one byte, and later use bit masks to check values */
437 priv->current_config = feature_buffer[4];
438 priv->baud_rate = *((u_int32_t *)feature_buffer);
440 if ( (priv->cbr_mask = rate_to_mask(priv->baud_rate)) == 0x40)
441 dbg("%s - failed setting the baud mask (not defined)", __FUNCTION__);
442 spin_unlock_irqrestore(&priv->lock, flags);
445 spin_lock_irqsave(&priv->lock, flags);
447 spin_unlock_irqrestore(&priv->lock, flags);
450 } /* cypress_serial_control */
453 static void cypress_set_dead(struct usb_serial_port *port)
455 struct cypress_private *priv = usb_get_serial_port_data(port);
458 spin_lock_irqsave(&priv->lock, flags);
459 if (!priv->comm_is_ok) {
460 spin_unlock_irqrestore(&priv->lock, flags);
463 priv->comm_is_ok = 0;
464 spin_unlock_irqrestore(&priv->lock, flags);
466 err("cypress_m8 suspending failing port %d - interval might be too short",
471 /* given a baud mask, it will return integer baud on success */
472 static int mask_to_rate (unsigned mask)
477 case B0: rate = 0; break;
478 case B300: rate = 300; break;
479 case B600: rate = 600; break;
480 case B1200: rate = 1200; break;
481 case B2400: rate = 2400; break;
482 case B4800: rate = 4800; break;
483 case B9600: rate = 9600; break;
484 case B19200: rate = 19200; break;
485 case B38400: rate = 38400; break;
486 case B57600: rate = 57600; break;
487 case B115200: rate = 115200; break;
495 static unsigned rate_to_mask (int rate)
500 case 0: mask = B0; break;
501 case 300: mask = B300; break;
502 case 600: mask = B600; break;
503 case 1200: mask = B1200; break;
504 case 2400: mask = B2400; break;
505 case 4800: mask = B4800; break;
506 case 9600: mask = B9600; break;
507 case 19200: mask = B19200; break;
508 case 38400: mask = B38400; break;
509 case 57600: mask = B57600; break;
510 case 115200: mask = B115200; break;
511 default: mask = 0x40;
516 /*****************************************************************************
517 * Cypress serial driver functions
518 *****************************************************************************/
521 static int generic_startup (struct usb_serial *serial)
523 struct cypress_private *priv;
524 struct usb_serial_port *port = serial->port[0];
526 dbg("%s - port %d", __FUNCTION__, port->number);
528 priv = kzalloc(sizeof (struct cypress_private), GFP_KERNEL);
532 priv->comm_is_ok = !0;
533 spin_lock_init(&priv->lock);
534 priv->buf = cypress_buf_alloc(CYPRESS_BUF_SIZE);
535 if (priv->buf == NULL) {
539 init_waitqueue_head(&priv->delta_msr_wait);
541 usb_reset_configuration (serial->dev);
544 priv->line_control = 0;
545 priv->termios_initialized = 0;
547 priv->cbr_mask = B300;
548 /* Default packet format setting is determined by packet size.
549 Anything with a size larger then 9 must have a separate
550 count field since the 3 bit count field is otherwise too
551 small. Otherwise we can use the slightly more compact
552 format. This is in accordance with the cypress_m8 serial
553 converter app note. */
554 if (port->interrupt_out_size > 9) {
555 priv->pkt_fmt = packet_format_1;
557 priv->pkt_fmt = packet_format_2;
560 priv->write_urb_interval = interval;
561 priv->read_urb_interval = interval;
562 dbg("%s - port %d read & write intervals forced to %d",
563 __FUNCTION__,port->number,interval);
565 priv->write_urb_interval = port->interrupt_out_urb->interval;
566 priv->read_urb_interval = port->interrupt_in_urb->interval;
567 dbg("%s - port %d intervals: read=%d write=%d",
568 __FUNCTION__,port->number,
569 priv->read_urb_interval,priv->write_urb_interval);
571 usb_set_serial_port_data(port, priv);
577 static int cypress_earthmate_startup (struct usb_serial *serial)
579 struct cypress_private *priv;
580 struct usb_serial_port *port = serial->port[0];
582 dbg("%s", __FUNCTION__);
584 if (generic_startup(serial)) {
585 dbg("%s - Failed setting up port %d", __FUNCTION__,
590 priv = usb_get_serial_port_data(port);
591 priv->chiptype = CT_EARTHMATE;
592 /* All Earthmate devices use the separated-count packet
594 priv->pkt_fmt = packet_format_1;
595 if (serial->dev->descriptor.idProduct != PRODUCT_ID_EARTHMATEUSB) {
596 /* The old original USB Earthmate seemed able to
597 handle GET_CONFIG requests; everything they've
598 produced since that time crashes if this command is
600 dbg("%s - Marking this device as unsafe for GET_CONFIG "
601 "commands", __func__);
602 priv->get_cfg_unsafe = !0;
606 } /* cypress_earthmate_startup */
609 static int cypress_hidcom_startup (struct usb_serial *serial)
611 struct cypress_private *priv;
613 dbg("%s", __FUNCTION__);
615 if (generic_startup(serial)) {
616 dbg("%s - Failed setting up port %d", __FUNCTION__,
617 serial->port[0]->number);
621 priv = usb_get_serial_port_data(serial->port[0]);
622 priv->chiptype = CT_CYPHIDCOM;
625 } /* cypress_hidcom_startup */
628 static int cypress_ca42v2_startup (struct usb_serial *serial)
630 struct cypress_private *priv;
632 dbg("%s", __FUNCTION__);
634 if (generic_startup(serial)) {
635 dbg("%s - Failed setting up port %d", __FUNCTION__,
636 serial->port[0]->number);
640 priv = usb_get_serial_port_data(serial->port[0]);
641 priv->chiptype = CT_CA42V2;
644 } /* cypress_ca42v2_startup */
647 static void cypress_shutdown (struct usb_serial *serial)
649 struct cypress_private *priv;
651 dbg ("%s - port %d", __FUNCTION__, serial->port[0]->number);
653 /* all open ports are closed at this point */
655 priv = usb_get_serial_port_data(serial->port[0]);
658 cypress_buf_free(priv->buf);
660 usb_set_serial_port_data(serial->port[0], NULL);
665 static int cypress_open (struct usb_serial_port *port, struct file *filp)
667 struct cypress_private *priv = usb_get_serial_port_data(port);
668 struct usb_serial *serial = port->serial;
672 dbg("%s - port %d", __FUNCTION__, port->number);
674 if (!priv->comm_is_ok)
677 /* clear halts before open */
678 usb_clear_halt(serial->dev, 0x81);
679 usb_clear_halt(serial->dev, 0x02);
681 spin_lock_irqsave(&priv->lock, flags);
682 /* reset read/write statistics */
687 spin_unlock_irqrestore(&priv->lock, flags);
689 /* setting to zero could cause data loss */
690 port->tty->low_latency = 1;
692 /* raise both lines and set termios */
693 spin_lock_irqsave(&priv->lock, flags);
694 priv->line_control = CONTROL_DTR | CONTROL_RTS;
696 spin_unlock_irqrestore(&priv->lock, flags);
697 result = cypress_write(port, NULL, 0);
700 dev_err(&port->dev, "%s - failed setting the control lines - error %d\n", __FUNCTION__, result);
703 dbg("%s - success setting the control lines", __FUNCTION__);
705 cypress_set_termios(port, &priv->tmp_termios);
707 /* setup the port and start reading from the device */
708 if(!port->interrupt_in_urb){
709 err("%s - interrupt_in_urb is empty!", __FUNCTION__);
713 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
714 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
715 port->interrupt_in_urb->transfer_buffer, port->interrupt_in_urb->transfer_buffer_length,
716 cypress_read_int_callback, port, priv->read_urb_interval);
717 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
720 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
721 cypress_set_dead(port);
728 static void cypress_close(struct usb_serial_port *port, struct file * filp)
730 struct cypress_private *priv = usb_get_serial_port_data(port);
731 unsigned int c_cflag;
736 dbg("%s - port %d", __FUNCTION__, port->number);
738 /* wait for data to drain from buffer */
739 spin_lock_irq(&priv->lock);
740 timeout = CYPRESS_CLOSING_WAIT;
741 init_waitqueue_entry(&wait, current);
742 add_wait_queue(&port->tty->write_wait, &wait);
744 set_current_state(TASK_INTERRUPTIBLE);
745 if (cypress_buf_data_avail(priv->buf) == 0
746 || timeout == 0 || signal_pending(current)
747 /* without mutex, allowed due to harmless failure mode */
748 || port->serial->disconnected)
750 spin_unlock_irq(&priv->lock);
751 timeout = schedule_timeout(timeout);
752 spin_lock_irq(&priv->lock);
754 set_current_state(TASK_RUNNING);
755 remove_wait_queue(&port->tty->write_wait, &wait);
756 /* clear out any remaining data in the buffer */
757 cypress_buf_clear(priv->buf);
758 spin_unlock_irq(&priv->lock);
760 /* writing is potentially harmful, lock must be taken */
761 mutex_lock(&port->serial->disc_mutex);
762 if (port->serial->disconnected) {
763 mutex_unlock(&port->serial->disc_mutex);
766 /* wait for characters to drain from device */
767 bps = tty_get_baud_rate(port->tty);
769 timeout = max((HZ*2560)/bps,HZ/10);
772 schedule_timeout_interruptible(timeout);
774 dbg("%s - stopping urbs", __FUNCTION__);
775 usb_kill_urb (port->interrupt_in_urb);
776 usb_kill_urb (port->interrupt_out_urb);
779 c_cflag = port->tty->termios->c_cflag;
780 if (c_cflag & HUPCL) {
781 /* drop dtr and rts */
782 priv = usb_get_serial_port_data(port);
783 spin_lock_irq(&priv->lock);
784 priv->line_control = 0;
786 spin_unlock_irq(&priv->lock);
787 cypress_write(port, NULL, 0);
792 dev_info (&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
793 priv->bytes_in, priv->bytes_out, priv->cmd_count);
794 mutex_unlock(&port->serial->disc_mutex);
795 } /* cypress_close */
798 static int cypress_write(struct usb_serial_port *port, const unsigned char *buf, int count)
800 struct cypress_private *priv = usb_get_serial_port_data(port);
803 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
805 /* line control commands, which need to be executed immediately,
806 are not put into the buffer for obvious reasons.
808 if (priv->cmd_ctrl) {
816 spin_lock_irqsave(&priv->lock, flags);
817 count = cypress_buf_put(priv->buf, buf, count);
818 spin_unlock_irqrestore(&priv->lock, flags);
824 } /* cypress_write */
827 static void cypress_send(struct usb_serial_port *port)
829 int count = 0, result, offset, actual_size;
830 struct cypress_private *priv = usb_get_serial_port_data(port);
833 if (!priv->comm_is_ok)
836 dbg("%s - port %d", __FUNCTION__, port->number);
837 dbg("%s - interrupt out size is %d", __FUNCTION__, port->interrupt_out_size);
839 spin_lock_irqsave(&priv->lock, flags);
840 if (priv->write_urb_in_use) {
841 dbg("%s - can't write, urb in use", __FUNCTION__);
842 spin_unlock_irqrestore(&priv->lock, flags);
845 spin_unlock_irqrestore(&priv->lock, flags);
848 memset(port->interrupt_out_urb->transfer_buffer, 0, port->interrupt_out_size);
850 spin_lock_irqsave(&priv->lock, flags);
851 switch (priv->pkt_fmt) {
853 case packet_format_1:
854 /* this is for the CY7C64013... */
856 port->interrupt_out_buffer[0] = priv->line_control;
858 case packet_format_2:
859 /* this is for the CY7C63743... */
861 port->interrupt_out_buffer[0] = priv->line_control;
865 if (priv->line_control & CONTROL_RESET)
866 priv->line_control &= ~CONTROL_RESET;
868 if (priv->cmd_ctrl) {
870 dbg("%s - line control command being issued", __FUNCTION__);
871 spin_unlock_irqrestore(&priv->lock, flags);
874 spin_unlock_irqrestore(&priv->lock, flags);
876 count = cypress_buf_get(priv->buf, &port->interrupt_out_buffer[offset],
877 port->interrupt_out_size-offset);
883 switch (priv->pkt_fmt) {
885 case packet_format_1:
886 port->interrupt_out_buffer[1] = count;
888 case packet_format_2:
889 port->interrupt_out_buffer[0] |= count;
892 dbg("%s - count is %d", __FUNCTION__, count);
895 spin_lock_irqsave(&priv->lock, flags);
896 priv->write_urb_in_use = 1;
897 spin_unlock_irqrestore(&priv->lock, flags);
902 actual_size = count +
903 (priv->pkt_fmt == packet_format_1 ? 2 : 1);
905 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, port->interrupt_out_size,
906 port->interrupt_out_urb->transfer_buffer);
908 usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
909 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
910 port->interrupt_out_buffer, port->interrupt_out_size,
911 cypress_write_int_callback, port, priv->write_urb_interval);
912 result = usb_submit_urb (port->interrupt_out_urb, GFP_ATOMIC);
914 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__,
916 priv->write_urb_in_use = 0;
917 cypress_set_dead(port);
920 spin_lock_irqsave(&priv->lock, flags);
921 if (priv->cmd_ctrl) {
924 priv->bytes_out += count; /* do not count the line control and size bytes */
925 spin_unlock_irqrestore(&priv->lock, flags);
927 usb_serial_port_softint(port);
931 /* returns how much space is available in the soft buffer */
932 static int cypress_write_room(struct usb_serial_port *port)
934 struct cypress_private *priv = usb_get_serial_port_data(port);
938 dbg("%s - port %d", __FUNCTION__, port->number);
940 spin_lock_irqsave(&priv->lock, flags);
941 room = cypress_buf_space_avail(priv->buf);
942 spin_unlock_irqrestore(&priv->lock, flags);
944 dbg("%s - returns %d", __FUNCTION__, room);
949 static int cypress_tiocmget (struct usb_serial_port *port, struct file *file)
951 struct cypress_private *priv = usb_get_serial_port_data(port);
952 __u8 status, control;
953 unsigned int result = 0;
956 dbg("%s - port %d", __FUNCTION__, port->number);
958 spin_lock_irqsave(&priv->lock, flags);
959 control = priv->line_control;
960 status = priv->current_status;
961 spin_unlock_irqrestore(&priv->lock, flags);
963 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
964 | ((control & CONTROL_RTS) ? TIOCM_RTS : 0)
965 | ((status & UART_CTS) ? TIOCM_CTS : 0)
966 | ((status & UART_DSR) ? TIOCM_DSR : 0)
967 | ((status & UART_RI) ? TIOCM_RI : 0)
968 | ((status & UART_CD) ? TIOCM_CD : 0);
970 dbg("%s - result = %x", __FUNCTION__, result);
976 static int cypress_tiocmset (struct usb_serial_port *port, struct file *file,
977 unsigned int set, unsigned int clear)
979 struct cypress_private *priv = usb_get_serial_port_data(port);
982 dbg("%s - port %d", __FUNCTION__, port->number);
984 spin_lock_irqsave(&priv->lock, flags);
986 priv->line_control |= CONTROL_RTS;
988 priv->line_control |= CONTROL_DTR;
989 if (clear & TIOCM_RTS)
990 priv->line_control &= ~CONTROL_RTS;
991 if (clear & TIOCM_DTR)
992 priv->line_control &= ~CONTROL_DTR;
993 spin_unlock_irqrestore(&priv->lock, flags);
996 return cypress_write(port, NULL, 0);
1000 static int cypress_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
1002 struct cypress_private *priv = usb_get_serial_port_data(port);
1004 dbg("%s - port %d, cmd 0x%.4x", __FUNCTION__, port->number, cmd);
1008 if (copy_to_user((void __user *)arg, port->tty->termios, sizeof(struct ktermios))) {
1014 if (copy_from_user(port->tty->termios, (void __user *)arg, sizeof(struct ktermios))) {
1017 /* here we need to call cypress_set_termios to invoke the new settings */
1018 cypress_set_termios(port, &priv->tmp_termios);
1021 /* This code comes from drivers/char/serial.c and ftdi_sio.c */
1023 while (priv != NULL) {
1024 interruptible_sleep_on(&priv->delta_msr_wait);
1025 /* see if a signal did it */
1026 if (signal_pending(current))
1027 return -ERESTARTSYS;
1029 char diff = priv->diff_status;
1032 return -EIO; /* no change => error */
1035 /* consume all events */
1036 priv->diff_status = 0;
1038 /* return 0 if caller wanted to know about these bits */
1039 if ( ((arg & TIOCM_RNG) && (diff & UART_RI)) ||
1040 ((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
1041 ((arg & TIOCM_CD) && (diff & UART_CD)) ||
1042 ((arg & TIOCM_CTS) && (diff & UART_CTS)) ) {
1045 /* otherwise caller can't care less about what happened,
1046 * and so we continue to wait for more events.
1056 dbg("%s - arg not supported - it was 0x%04x - check include/asm/ioctls.h", __FUNCTION__, cmd);
1058 return -ENOIOCTLCMD;
1059 } /* cypress_ioctl */
1062 static void cypress_set_termios (struct usb_serial_port *port,
1063 struct ktermios *old_termios)
1065 struct cypress_private *priv = usb_get_serial_port_data(port);
1066 struct tty_struct *tty;
1067 int data_bits, stop_bits, parity_type, parity_enable;
1068 unsigned cflag, iflag, baud_mask;
1069 unsigned long flags;
1073 dbg("%s - port %d", __FUNCTION__, port->number);
1076 if ((!tty) || (!tty->termios)) {
1077 dbg("%s - no tty structures", __FUNCTION__);
1081 spin_lock_irqsave(&priv->lock, flags);
1082 if (!priv->termios_initialized) {
1083 if (priv->chiptype == CT_EARTHMATE) {
1084 *(tty->termios) = tty_std_termios;
1085 tty->termios->c_cflag = B4800 | CS8 | CREAD | HUPCL |
1087 } else if (priv->chiptype == CT_CYPHIDCOM) {
1088 *(tty->termios) = tty_std_termios;
1089 tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
1091 } else if (priv->chiptype == CT_CA42V2) {
1092 *(tty->termios) = tty_std_termios;
1093 tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
1096 priv->termios_initialized = 1;
1098 spin_unlock_irqrestore(&priv->lock, flags);
1100 cflag = tty->termios->c_cflag;
1101 iflag = tty->termios->c_iflag;
1103 /* check if there are new settings */
1105 if ((cflag != old_termios->c_cflag) ||
1106 (RELEVANT_IFLAG(iflag) !=
1107 RELEVANT_IFLAG(old_termios->c_iflag))) {
1108 dbg("%s - attempting to set new termios settings",
1110 /* should make a copy of this in case something goes
1111 * wrong in the function, we can restore it */
1112 spin_lock_irqsave(&priv->lock, flags);
1113 priv->tmp_termios = *(tty->termios);
1114 spin_unlock_irqrestore(&priv->lock, flags);
1116 dbg("%s - nothing to do, exiting", __FUNCTION__);
1122 /* set number of data bits, parity, stop bits */
1123 /* when parity is disabled the parity type bit is ignored */
1125 /* 1 means 2 stop bits, 0 means 1 stop bit */
1126 stop_bits = cflag & CSTOPB ? 1 : 0;
1128 if (cflag & PARENB) {
1130 /* 1 means odd parity, 0 means even parity */
1131 parity_type = cflag & PARODD ? 1 : 0;
1133 parity_enable = parity_type = 0;
1135 if (cflag & CSIZE) {
1136 switch (cflag & CSIZE) {
1150 err("%s - CSIZE was set, but not CS5-CS8",
1157 spin_lock_irqsave(&priv->lock, flags);
1158 oldlines = priv->line_control;
1159 if ((cflag & CBAUD) == B0) {
1160 /* drop dtr and rts */
1161 dbg("%s - dropping the lines, baud rate 0bps", __FUNCTION__);
1163 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
1165 baud_mask = (cflag & CBAUD);
1168 dbg("%s - setting baud 300bps", __FUNCTION__);
1171 dbg("%s - setting baud 600bps", __FUNCTION__);
1174 dbg("%s - setting baud 1200bps", __FUNCTION__);
1177 dbg("%s - setting baud 2400bps", __FUNCTION__);
1180 dbg("%s - setting baud 4800bps", __FUNCTION__);
1183 dbg("%s - setting baud 9600bps", __FUNCTION__);
1186 dbg("%s - setting baud 19200bps", __FUNCTION__);
1189 dbg("%s - setting baud 38400bps", __FUNCTION__);
1192 dbg("%s - setting baud 57600bps", __FUNCTION__);
1195 dbg("%s - setting baud 115200bps", __FUNCTION__);
1198 dbg("%s - unknown masked baud rate", __FUNCTION__);
1200 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
1202 spin_unlock_irqrestore(&priv->lock, flags);
1204 dbg("%s - sending %d stop_bits, %d parity_enable, %d parity_type, "
1205 "%d data_bits (+5)", __FUNCTION__, stop_bits,
1206 parity_enable, parity_type, data_bits);
1208 cypress_serial_control(port, baud_mask, data_bits, stop_bits,
1209 parity_enable, parity_type, 0, CYPRESS_SET_CONFIG);
1211 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1212 * filled into the private structure this should confirm that all is
1213 * working if it returns what we just set */
1214 cypress_serial_control(port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
1216 /* Here we can define custom tty settings for devices; the main tty
1217 * termios flag base comes from empeg.c */
1219 spin_lock_irqsave(&priv->lock, flags);
1220 if ( (priv->chiptype == CT_EARTHMATE) && (priv->baud_rate == 4800) ) {
1221 dbg("Using custom termios settings for a baud rate of "
1223 /* define custom termios settings for NMEA protocol */
1225 tty->termios->c_iflag /* input modes - */
1226 &= ~(IGNBRK /* disable ignore break */
1227 | BRKINT /* disable break causes interrupt */
1228 | PARMRK /* disable mark parity errors */
1229 | ISTRIP /* disable clear high bit of input char */
1230 | INLCR /* disable translate NL to CR */
1231 | IGNCR /* disable ignore CR */
1232 | ICRNL /* disable translate CR to NL */
1233 | IXON); /* disable enable XON/XOFF flow control */
1235 tty->termios->c_oflag /* output modes */
1236 &= ~OPOST; /* disable postprocess output char */
1238 tty->termios->c_lflag /* line discipline modes */
1239 &= ~(ECHO /* disable echo input characters */
1240 | ECHONL /* disable echo new line */
1241 | ICANON /* disable erase, kill, werase, and rprnt
1242 special characters */
1243 | ISIG /* disable interrupt, quit, and suspend
1244 special characters */
1245 | IEXTEN); /* disable non-POSIX special characters */
1246 } /* CT_CYPHIDCOM: Application should handle this for device */
1248 linechange = (priv->line_control != oldlines);
1249 spin_unlock_irqrestore(&priv->lock, flags);
1251 /* if necessary, set lines */
1254 cypress_write(port, NULL, 0);
1256 } /* cypress_set_termios */
1259 /* returns amount of data still left in soft buffer */
1260 static int cypress_chars_in_buffer(struct usb_serial_port *port)
1262 struct cypress_private *priv = usb_get_serial_port_data(port);
1264 unsigned long flags;
1266 dbg("%s - port %d", __FUNCTION__, port->number);
1268 spin_lock_irqsave(&priv->lock, flags);
1269 chars = cypress_buf_data_avail(priv->buf);
1270 spin_unlock_irqrestore(&priv->lock, flags);
1272 dbg("%s - returns %d", __FUNCTION__, chars);
1277 static void cypress_throttle (struct usb_serial_port *port)
1279 struct cypress_private *priv = usb_get_serial_port_data(port);
1280 unsigned long flags;
1282 dbg("%s - port %d", __FUNCTION__, port->number);
1284 spin_lock_irqsave(&priv->lock, flags);
1285 priv->rx_flags = THROTTLED;
1286 spin_unlock_irqrestore(&priv->lock, flags);
1290 static void cypress_unthrottle (struct usb_serial_port *port)
1292 struct cypress_private *priv = usb_get_serial_port_data(port);
1293 int actually_throttled, result;
1294 unsigned long flags;
1296 dbg("%s - port %d", __FUNCTION__, port->number);
1298 spin_lock_irqsave(&priv->lock, flags);
1299 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1301 spin_unlock_irqrestore(&priv->lock, flags);
1303 if (!priv->comm_is_ok)
1306 if (actually_throttled) {
1307 port->interrupt_in_urb->dev = port->serial->dev;
1309 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1311 dev_err(&port->dev, "%s - failed submitting read urb, "
1312 "error %d\n", __FUNCTION__, result);
1313 cypress_set_dead(port);
1319 static void cypress_read_int_callback(struct urb *urb)
1321 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1322 struct cypress_private *priv = usb_get_serial_port_data(port);
1323 struct tty_struct *tty;
1324 unsigned char *data = urb->transfer_buffer;
1325 unsigned long flags;
1326 char tty_flag = TTY_NORMAL;
1331 int status = urb->status;
1333 dbg("%s - port %d", __FUNCTION__, port->number);
1336 case 0: /* success */
1341 /* precursor to disconnect so just go away */
1344 usb_clear_halt(port->serial->dev,0x81);
1347 /* something ugly is going on... */
1348 dev_err(&urb->dev->dev,"%s - unexpected nonzero read status received: %d\n",
1349 __FUNCTION__, status);
1350 cypress_set_dead(port);
1354 spin_lock_irqsave(&priv->lock, flags);
1355 if (priv->rx_flags & THROTTLED) {
1356 dbg("%s - now throttling", __FUNCTION__);
1357 priv->rx_flags |= ACTUALLY_THROTTLED;
1358 spin_unlock_irqrestore(&priv->lock, flags);
1361 spin_unlock_irqrestore(&priv->lock, flags);
1365 dbg("%s - bad tty pointer - exiting", __FUNCTION__);
1369 spin_lock_irqsave(&priv->lock, flags);
1370 result = urb->actual_length;
1371 switch (priv->pkt_fmt) {
1373 case packet_format_1:
1374 /* This is for the CY7C64013... */
1375 priv->current_status = data[0] & 0xF8;
1376 bytes = data[1] + 2;
1381 case packet_format_2:
1382 /* This is for the CY7C63743... */
1383 priv->current_status = data[0] & 0xF8;
1384 bytes = (data[0] & 0x07) + 1;
1390 spin_unlock_irqrestore(&priv->lock, flags);
1391 if (result < bytes) {
1392 dbg("%s - wrong packet size - received %d bytes but packet "
1393 "said %d bytes", __func__, result, bytes);
1397 usb_serial_debug_data (debug, &port->dev, __FUNCTION__,
1398 urb->actual_length, data);
1400 spin_lock_irqsave(&priv->lock, flags);
1401 /* check to see if status has changed */
1403 if (priv->current_status != priv->prev_status) {
1404 priv->diff_status |= priv->current_status ^
1406 wake_up_interruptible(&priv->delta_msr_wait);
1407 priv->prev_status = priv->current_status;
1410 spin_unlock_irqrestore(&priv->lock, flags);
1412 /* hangup, as defined in acm.c... this might be a bad place for it
1414 if (tty && !(tty->termios->c_cflag & CLOCAL) &&
1415 !(priv->current_status & UART_CD)) {
1416 dbg("%s - calling hangup", __FUNCTION__);
1421 /* There is one error bit... I'm assuming it is a parity error
1422 * indicator as the generic firmware will set this bit to 1 if a
1423 * parity error occurs.
1424 * I can not find reference to any other error events. */
1425 spin_lock_irqsave(&priv->lock, flags);
1426 if (priv->current_status & CYP_ERROR) {
1427 spin_unlock_irqrestore(&priv->lock, flags);
1428 tty_flag = TTY_PARITY;
1429 dbg("%s - Parity Error detected", __FUNCTION__);
1431 spin_unlock_irqrestore(&priv->lock, flags);
1433 /* process read if there is data other than line status */
1434 if (tty && (bytes > i)) {
1435 bytes = tty_buffer_request_room(tty, bytes);
1436 for (; i < bytes ; ++i) {
1437 dbg("pushing byte number %d - %d - %c", i, data[i],
1439 tty_insert_flip_char(tty, data[i], tty_flag);
1441 tty_flip_buffer_push(port->tty);
1444 spin_lock_irqsave(&priv->lock, flags);
1445 /* control and status byte(s) are also counted */
1446 priv->bytes_in += bytes;
1447 spin_unlock_irqrestore(&priv->lock, flags);
1451 /* Continue trying to always read... unless the port has closed. */
1453 if (port->open_count > 0 && priv->comm_is_ok) {
1454 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1455 usb_rcvintpipe(port->serial->dev,
1456 port->interrupt_in_endpointAddress),
1457 port->interrupt_in_urb->transfer_buffer,
1458 port->interrupt_in_urb->transfer_buffer_length,
1459 cypress_read_int_callback, port, priv->read_urb_interval);
1460 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1462 dev_err(&urb->dev->dev, "%s - failed resubmitting "
1463 "read urb, error %d\n", __FUNCTION__,
1465 cypress_set_dead(port);
1470 } /* cypress_read_int_callback */
1473 static void cypress_write_int_callback(struct urb *urb)
1475 struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
1476 struct cypress_private *priv = usb_get_serial_port_data(port);
1478 int status = urb->status;
1480 dbg("%s - port %d", __FUNCTION__, port->number);
1489 /* this urb is terminated, clean up */
1490 dbg("%s - urb shutting down with status: %d",
1491 __FUNCTION__, status);
1492 priv->write_urb_in_use = 0;
1494 case -EPIPE: /* no break needed; clear halt and resubmit */
1495 if (!priv->comm_is_ok)
1497 usb_clear_halt(port->serial->dev, 0x02);
1498 /* error in the urb, so we have to resubmit it */
1499 dbg("%s - nonzero write bulk status received: %d",
1500 __FUNCTION__, status);
1501 port->interrupt_out_urb->transfer_buffer_length = 1;
1502 port->interrupt_out_urb->dev = port->serial->dev;
1503 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1506 dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n",
1507 __FUNCTION__, result);
1508 cypress_set_dead(port);
1511 dev_err(&urb->dev->dev,"%s - unexpected nonzero write status received: %d\n",
1512 __FUNCTION__, status);
1513 cypress_set_dead(port);
1517 priv->write_urb_in_use = 0;
1519 /* send any buffered data */
1524 /*****************************************************************************
1525 * Write buffer functions - buffering code from pl2303 used
1526 *****************************************************************************/
1531 * Allocate a circular buffer and all associated memory.
1534 static struct cypress_buf *cypress_buf_alloc(unsigned int size)
1537 struct cypress_buf *cb;
1543 cb = kmalloc(sizeof(struct cypress_buf), GFP_KERNEL);
1547 cb->buf_buf = kmalloc(size, GFP_KERNEL);
1548 if (cb->buf_buf == NULL) {
1553 cb->buf_size = size;
1554 cb->buf_get = cb->buf_put = cb->buf_buf;
1564 * Free the buffer and all associated memory.
1567 static void cypress_buf_free(struct cypress_buf *cb)
1579 * Clear out all data in the circular buffer.
1582 static void cypress_buf_clear(struct cypress_buf *cb)
1585 cb->buf_get = cb->buf_put;
1586 /* equivalent to a get of all data available */
1591 * cypress_buf_data_avail
1593 * Return the number of bytes of data available in the circular
1597 static unsigned int cypress_buf_data_avail(struct cypress_buf *cb)
1600 return ((cb->buf_size + cb->buf_put - cb->buf_get) % cb->buf_size);
1607 * cypress_buf_space_avail
1609 * Return the number of bytes of space available in the circular
1613 static unsigned int cypress_buf_space_avail(struct cypress_buf *cb)
1616 return ((cb->buf_size + cb->buf_get - cb->buf_put - 1) % cb->buf_size);
1625 * Copy data data from a user buffer and put it into the circular buffer.
1626 * Restrict to the amount of space available.
1628 * Return the number of bytes copied.
1631 static unsigned int cypress_buf_put(struct cypress_buf *cb, const char *buf,
1641 len = cypress_buf_space_avail(cb);
1648 len = cb->buf_buf + cb->buf_size - cb->buf_put;
1650 memcpy(cb->buf_put, buf, len);
1651 memcpy(cb->buf_buf, buf+len, count - len);
1652 cb->buf_put = cb->buf_buf + count - len;
1654 memcpy(cb->buf_put, buf, count);
1656 cb->buf_put += count;
1657 else /* count == len */
1658 cb->buf_put = cb->buf_buf;
1669 * Get data from the circular buffer and copy to the given buffer.
1670 * Restrict to the amount of data available.
1672 * Return the number of bytes copied.
1675 static unsigned int cypress_buf_get(struct cypress_buf *cb, char *buf,
1685 len = cypress_buf_data_avail(cb);
1692 len = cb->buf_buf + cb->buf_size - cb->buf_get;
1694 memcpy(buf, cb->buf_get, len);
1695 memcpy(buf+len, cb->buf_buf, count - len);
1696 cb->buf_get = cb->buf_buf + count - len;
1698 memcpy(buf, cb->buf_get, count);
1700 cb->buf_get += count;
1701 else /* count == len */
1702 cb->buf_get = cb->buf_buf;
1709 /*****************************************************************************
1711 *****************************************************************************/
1713 static int __init cypress_init(void)
1717 dbg("%s", __FUNCTION__);
1719 retval = usb_serial_register(&cypress_earthmate_device);
1721 goto failed_em_register;
1722 retval = usb_serial_register(&cypress_hidcom_device);
1724 goto failed_hidcom_register;
1725 retval = usb_serial_register(&cypress_ca42v2_device);
1727 goto failed_ca42v2_register;
1728 retval = usb_register(&cypress_driver);
1730 goto failed_usb_register;
1732 info(DRIVER_DESC " " DRIVER_VERSION);
1735 failed_usb_register:
1736 usb_serial_deregister(&cypress_ca42v2_device);
1737 failed_ca42v2_register:
1738 usb_serial_deregister(&cypress_hidcom_device);
1739 failed_hidcom_register:
1740 usb_serial_deregister(&cypress_earthmate_device);
1746 static void __exit cypress_exit (void)
1748 dbg("%s", __FUNCTION__);
1750 usb_deregister (&cypress_driver);
1751 usb_serial_deregister (&cypress_earthmate_device);
1752 usb_serial_deregister (&cypress_hidcom_device);
1753 usb_serial_deregister (&cypress_ca42v2_device);
1757 module_init(cypress_init);
1758 module_exit(cypress_exit);
1760 MODULE_AUTHOR( DRIVER_AUTHOR );
1761 MODULE_DESCRIPTION( DRIVER_DESC );
1762 MODULE_VERSION( DRIVER_VERSION );
1763 MODULE_LICENSE("GPL");
1765 module_param(debug, bool, S_IRUGO | S_IWUSR);
1766 MODULE_PARM_DESC(debug, "Debug enabled or not");
1767 module_param(stats, bool, S_IRUGO | S_IWUSR);
1768 MODULE_PARM_DESC(stats, "Enable statistics or not");
1769 module_param(interval, int, S_IRUGO | S_IWUSR);
1770 MODULE_PARM_DESC(interval, "Overrides interrupt interval");