mfd: wm8350-i2c: Make sure the i2c regmap functions are compiled
[linux/fpc-iii.git] / drivers / usb / serial / cypress_m8.c
blobba96eeed1babc8ab259e34dff78e97f43f3902fb
1 /*
2 * USB Cypress M8 driver
4 * Copyright (C) 2004
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
15 * driver
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
22 for linux. */
23 /* Thanks to cypress for providing references for the hid reports. */
24 /* Thanks to Jiang Zhang for providing links and for general help. */
25 /* Code originates and was built up from ftdi_sio, belkin, pl2303 and others.*/
28 #include <linux/kernel.h>
29 #include <linux/errno.h>
30 #include <linux/init.h>
31 #include <linux/slab.h>
32 #include <linux/tty.h>
33 #include <linux/tty_driver.h>
34 #include <linux/tty_flip.h>
35 #include <linux/module.h>
36 #include <linux/moduleparam.h>
37 #include <linux/spinlock.h>
38 #include <linux/usb.h>
39 #include <linux/usb/serial.h>
40 #include <linux/serial.h>
41 #include <linux/kfifo.h>
42 #include <linux/delay.h>
43 #include <linux/uaccess.h>
44 #include <asm/unaligned.h>
46 #include "cypress_m8.h"
49 static bool stats;
50 static int interval;
51 static bool unstable_bauds;
53 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
54 #define DRIVER_DESC "Cypress USB to Serial Driver"
56 /* write buffer size defines */
57 #define CYPRESS_BUF_SIZE 1024
59 static const struct usb_device_id id_table_earthmate[] = {
60 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
61 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
62 { } /* Terminating entry */
65 static const struct usb_device_id id_table_cyphidcomrs232[] = {
66 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
67 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
68 { USB_DEVICE(VENDOR_ID_FRWD, PRODUCT_ID_CYPHIDCOM_FRWD) },
69 { } /* Terminating entry */
72 static const struct usb_device_id id_table_nokiaca42v2[] = {
73 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
74 { } /* Terminating entry */
77 static const struct usb_device_id id_table_combined[] = {
78 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
79 { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
80 { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
81 { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
82 { USB_DEVICE(VENDOR_ID_FRWD, PRODUCT_ID_CYPHIDCOM_FRWD) },
83 { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
84 { } /* Terminating entry */
87 MODULE_DEVICE_TABLE(usb, id_table_combined);
89 enum packet_format {
90 packet_format_1, /* b0:status, b1:payload count */
91 packet_format_2 /* b0[7:3]:status, b0[2:0]:payload count */
94 struct cypress_private {
95 spinlock_t lock; /* private lock */
96 int chiptype; /* identifier of device, for quirks/etc */
97 int bytes_in; /* used for statistics */
98 int bytes_out; /* used for statistics */
99 int cmd_count; /* used for statistics */
100 int cmd_ctrl; /* always set this to 1 before issuing a command */
101 struct kfifo write_fifo; /* write fifo */
102 int write_urb_in_use; /* write urb in use indicator */
103 int write_urb_interval; /* interval to use for write urb */
104 int read_urb_interval; /* interval to use for read urb */
105 int comm_is_ok; /* true if communication is (still) ok */
106 int termios_initialized;
107 __u8 line_control; /* holds dtr / rts value */
108 __u8 current_status; /* received from last read - info on dsr,cts,cd,ri,etc */
109 __u8 current_config; /* stores the current configuration byte */
110 __u8 rx_flags; /* throttling - used from whiteheat/ftdi_sio */
111 enum packet_format pkt_fmt; /* format to use for packet send / receive */
112 int get_cfg_unsafe; /* If true, the CYPRESS_GET_CONFIG is unsafe */
113 int baud_rate; /* stores current baud rate in
114 integer form */
115 int isthrottled; /* if throttled, discard reads */
116 char prev_status, diff_status; /* used for TIOCMIWAIT */
117 /* we pass a pointer to this as the argument sent to
118 cypress_set_termios old_termios */
119 struct ktermios tmp_termios; /* stores the old termios settings */
122 /* function prototypes for the Cypress USB to serial device */
123 static int cypress_earthmate_port_probe(struct usb_serial_port *port);
124 static int cypress_hidcom_port_probe(struct usb_serial_port *port);
125 static int cypress_ca42v2_port_probe(struct usb_serial_port *port);
126 static int cypress_port_remove(struct usb_serial_port *port);
127 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port);
128 static void cypress_close(struct usb_serial_port *port);
129 static void cypress_dtr_rts(struct usb_serial_port *port, int on);
130 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
131 const unsigned char *buf, int count);
132 static void cypress_send(struct usb_serial_port *port);
133 static int cypress_write_room(struct tty_struct *tty);
134 static void cypress_set_termios(struct tty_struct *tty,
135 struct usb_serial_port *port, struct ktermios *old);
136 static int cypress_tiocmget(struct tty_struct *tty);
137 static int cypress_tiocmset(struct tty_struct *tty,
138 unsigned int set, unsigned int clear);
139 static int cypress_tiocmiwait(struct tty_struct *tty, unsigned long arg);
140 static int cypress_chars_in_buffer(struct tty_struct *tty);
141 static void cypress_throttle(struct tty_struct *tty);
142 static void cypress_unthrottle(struct tty_struct *tty);
143 static void cypress_set_dead(struct usb_serial_port *port);
144 static void cypress_read_int_callback(struct urb *urb);
145 static void cypress_write_int_callback(struct urb *urb);
147 static struct usb_serial_driver cypress_earthmate_device = {
148 .driver = {
149 .owner = THIS_MODULE,
150 .name = "earthmate",
152 .description = "DeLorme Earthmate USB",
153 .id_table = id_table_earthmate,
154 .num_ports = 1,
155 .port_probe = cypress_earthmate_port_probe,
156 .port_remove = cypress_port_remove,
157 .open = cypress_open,
158 .close = cypress_close,
159 .dtr_rts = cypress_dtr_rts,
160 .write = cypress_write,
161 .write_room = cypress_write_room,
162 .set_termios = cypress_set_termios,
163 .tiocmget = cypress_tiocmget,
164 .tiocmset = cypress_tiocmset,
165 .tiocmiwait = cypress_tiocmiwait,
166 .chars_in_buffer = cypress_chars_in_buffer,
167 .throttle = cypress_throttle,
168 .unthrottle = cypress_unthrottle,
169 .read_int_callback = cypress_read_int_callback,
170 .write_int_callback = cypress_write_int_callback,
173 static struct usb_serial_driver cypress_hidcom_device = {
174 .driver = {
175 .owner = THIS_MODULE,
176 .name = "cyphidcom",
178 .description = "HID->COM RS232 Adapter",
179 .id_table = id_table_cyphidcomrs232,
180 .num_ports = 1,
181 .port_probe = cypress_hidcom_port_probe,
182 .port_remove = cypress_port_remove,
183 .open = cypress_open,
184 .close = cypress_close,
185 .dtr_rts = cypress_dtr_rts,
186 .write = cypress_write,
187 .write_room = cypress_write_room,
188 .set_termios = cypress_set_termios,
189 .tiocmget = cypress_tiocmget,
190 .tiocmset = cypress_tiocmset,
191 .tiocmiwait = cypress_tiocmiwait,
192 .chars_in_buffer = cypress_chars_in_buffer,
193 .throttle = cypress_throttle,
194 .unthrottle = cypress_unthrottle,
195 .read_int_callback = cypress_read_int_callback,
196 .write_int_callback = cypress_write_int_callback,
199 static struct usb_serial_driver cypress_ca42v2_device = {
200 .driver = {
201 .owner = THIS_MODULE,
202 .name = "nokiaca42v2",
204 .description = "Nokia CA-42 V2 Adapter",
205 .id_table = id_table_nokiaca42v2,
206 .num_ports = 1,
207 .port_probe = cypress_ca42v2_port_probe,
208 .port_remove = cypress_port_remove,
209 .open = cypress_open,
210 .close = cypress_close,
211 .dtr_rts = cypress_dtr_rts,
212 .write = cypress_write,
213 .write_room = cypress_write_room,
214 .set_termios = cypress_set_termios,
215 .tiocmget = cypress_tiocmget,
216 .tiocmset = cypress_tiocmset,
217 .tiocmiwait = cypress_tiocmiwait,
218 .chars_in_buffer = cypress_chars_in_buffer,
219 .throttle = cypress_throttle,
220 .unthrottle = cypress_unthrottle,
221 .read_int_callback = cypress_read_int_callback,
222 .write_int_callback = cypress_write_int_callback,
225 static struct usb_serial_driver * const serial_drivers[] = {
226 &cypress_earthmate_device, &cypress_hidcom_device,
227 &cypress_ca42v2_device, NULL
230 /*****************************************************************************
231 * Cypress serial helper functions
232 *****************************************************************************/
234 /* FRWD Dongle hidcom needs to skip reset and speed checks */
235 static inline bool is_frwd(struct usb_device *dev)
237 return ((le16_to_cpu(dev->descriptor.idVendor) == VENDOR_ID_FRWD) &&
238 (le16_to_cpu(dev->descriptor.idProduct) == PRODUCT_ID_CYPHIDCOM_FRWD));
241 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
243 struct cypress_private *priv;
244 priv = usb_get_serial_port_data(port);
246 if (unstable_bauds)
247 return new_rate;
249 /* FRWD Dongle uses 115200 bps */
250 if (is_frwd(port->serial->dev))
251 return new_rate;
254 * The general purpose firmware for the Cypress M8 allows for
255 * a maximum speed of 57600bps (I have no idea whether DeLorme
256 * chose to use the general purpose firmware or not), if you
257 * need to modify this speed setting for your own project
258 * please add your own chiptype and modify the code likewise.
259 * The Cypress HID->COM device will work successfully up to
260 * 115200bps (but the actual throughput is around 3kBps).
262 if (port->serial->dev->speed == USB_SPEED_LOW) {
264 * Mike Isely <isely@pobox.com> 2-Feb-2008: The
265 * Cypress app note that describes this mechanism
266 * states the the low-speed part can't handle more
267 * than 800 bytes/sec, in which case 4800 baud is the
268 * safest speed for a part like that.
270 if (new_rate > 4800) {
271 dev_dbg(&port->dev,
272 "%s - failed setting baud rate, device incapable speed %d\n",
273 __func__, new_rate);
274 return -1;
277 switch (priv->chiptype) {
278 case CT_EARTHMATE:
279 if (new_rate <= 600) {
280 /* 300 and 600 baud rates are supported under
281 * the generic firmware, but are not used with
282 * NMEA and SiRF protocols */
283 dev_dbg(&port->dev,
284 "%s - failed setting baud rate, unsupported speed of %d on Earthmate GPS",
285 __func__, new_rate);
286 return -1;
288 break;
289 default:
290 break;
292 return new_rate;
296 /* This function can either set or retrieve the current serial line settings */
297 static int cypress_serial_control(struct tty_struct *tty,
298 struct usb_serial_port *port, speed_t baud_rate, int data_bits,
299 int stop_bits, int parity_enable, int parity_type, int reset,
300 int cypress_request_type)
302 int new_baudrate = 0, retval = 0, tries = 0;
303 struct cypress_private *priv;
304 struct device *dev = &port->dev;
305 u8 *feature_buffer;
306 const unsigned int feature_len = 5;
307 unsigned long flags;
309 priv = usb_get_serial_port_data(port);
311 if (!priv->comm_is_ok)
312 return -ENODEV;
314 feature_buffer = kcalloc(feature_len, sizeof(u8), GFP_KERNEL);
315 if (!feature_buffer)
316 return -ENOMEM;
318 switch (cypress_request_type) {
319 case CYPRESS_SET_CONFIG:
320 /* 0 means 'Hang up' so doesn't change the true bit rate */
321 new_baudrate = priv->baud_rate;
322 if (baud_rate && baud_rate != priv->baud_rate) {
323 dev_dbg(dev, "%s - baud rate is changing\n", __func__);
324 retval = analyze_baud_rate(port, baud_rate);
325 if (retval >= 0) {
326 new_baudrate = retval;
327 dev_dbg(dev, "%s - New baud rate set to %d\n",
328 __func__, new_baudrate);
331 dev_dbg(dev, "%s - baud rate is being sent as %d\n", __func__,
332 new_baudrate);
334 /* fill the feature_buffer with new configuration */
335 put_unaligned_le32(new_baudrate, feature_buffer);
336 feature_buffer[4] |= data_bits; /* assign data bits in 2 bit space ( max 3 ) */
337 /* 1 bit gap */
338 feature_buffer[4] |= (stop_bits << 3); /* assign stop bits in 1 bit space */
339 feature_buffer[4] |= (parity_enable << 4); /* assign parity flag in 1 bit space */
340 feature_buffer[4] |= (parity_type << 5); /* assign parity type in 1 bit space */
341 /* 1 bit gap */
342 feature_buffer[4] |= (reset << 7); /* assign reset at end of byte, 1 bit space */
344 dev_dbg(dev, "%s - device is being sent this feature report:\n", __func__);
345 dev_dbg(dev, "%s - %02X - %02X - %02X - %02X - %02X\n", __func__,
346 feature_buffer[0], feature_buffer[1],
347 feature_buffer[2], feature_buffer[3],
348 feature_buffer[4]);
350 do {
351 retval = usb_control_msg(port->serial->dev,
352 usb_sndctrlpipe(port->serial->dev, 0),
353 HID_REQ_SET_REPORT,
354 USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
355 0x0300, 0, feature_buffer,
356 feature_len, 500);
358 if (tries++ >= 3)
359 break;
361 } while (retval != feature_len &&
362 retval != -ENODEV);
364 if (retval != feature_len) {
365 dev_err(dev, "%s - failed sending serial line settings - %d\n",
366 __func__, retval);
367 cypress_set_dead(port);
368 } else {
369 spin_lock_irqsave(&priv->lock, flags);
370 priv->baud_rate = new_baudrate;
371 priv->current_config = feature_buffer[4];
372 spin_unlock_irqrestore(&priv->lock, flags);
373 /* If we asked for a speed change encode it */
374 if (baud_rate)
375 tty_encode_baud_rate(tty,
376 new_baudrate, new_baudrate);
378 break;
379 case CYPRESS_GET_CONFIG:
380 if (priv->get_cfg_unsafe) {
381 /* Not implemented for this device,
382 and if we try to do it we're likely
383 to crash the hardware. */
384 retval = -ENOTTY;
385 goto out;
387 dev_dbg(dev, "%s - retreiving serial line settings\n", __func__);
388 do {
389 retval = usb_control_msg(port->serial->dev,
390 usb_rcvctrlpipe(port->serial->dev, 0),
391 HID_REQ_GET_REPORT,
392 USB_DIR_IN | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
393 0x0300, 0, feature_buffer,
394 feature_len, 500);
396 if (tries++ >= 3)
397 break;
398 } while (retval != feature_len
399 && retval != -ENODEV);
401 if (retval != feature_len) {
402 dev_err(dev, "%s - failed to retrieve serial line settings - %d\n",
403 __func__, retval);
404 cypress_set_dead(port);
405 goto out;
406 } else {
407 spin_lock_irqsave(&priv->lock, flags);
408 /* store the config in one byte, and later
409 use bit masks to check values */
410 priv->current_config = feature_buffer[4];
411 priv->baud_rate = get_unaligned_le32(feature_buffer);
412 spin_unlock_irqrestore(&priv->lock, flags);
415 spin_lock_irqsave(&priv->lock, flags);
416 ++priv->cmd_count;
417 spin_unlock_irqrestore(&priv->lock, flags);
418 out:
419 kfree(feature_buffer);
420 return retval;
421 } /* cypress_serial_control */
424 static void cypress_set_dead(struct usb_serial_port *port)
426 struct cypress_private *priv = usb_get_serial_port_data(port);
427 unsigned long flags;
429 spin_lock_irqsave(&priv->lock, flags);
430 if (!priv->comm_is_ok) {
431 spin_unlock_irqrestore(&priv->lock, flags);
432 return;
434 priv->comm_is_ok = 0;
435 spin_unlock_irqrestore(&priv->lock, flags);
437 dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
438 "interval might be too short\n", port->port_number);
442 /*****************************************************************************
443 * Cypress serial driver functions
444 *****************************************************************************/
447 static int cypress_generic_port_probe(struct usb_serial_port *port)
449 struct usb_serial *serial = port->serial;
450 struct cypress_private *priv;
452 if (!port->interrupt_out_urb || !port->interrupt_in_urb) {
453 dev_err(&port->dev, "required endpoint is missing\n");
454 return -ENODEV;
457 priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
458 if (!priv)
459 return -ENOMEM;
461 priv->comm_is_ok = !0;
462 spin_lock_init(&priv->lock);
463 if (kfifo_alloc(&priv->write_fifo, CYPRESS_BUF_SIZE, GFP_KERNEL)) {
464 kfree(priv);
465 return -ENOMEM;
468 /* Skip reset for FRWD device. It is a workaound:
469 device hangs if it receives SET_CONFIGURE in Configured
470 state. */
471 if (!is_frwd(serial->dev))
472 usb_reset_configuration(serial->dev);
474 priv->cmd_ctrl = 0;
475 priv->line_control = 0;
476 priv->termios_initialized = 0;
477 priv->rx_flags = 0;
478 /* Default packet format setting is determined by packet size.
479 Anything with a size larger then 9 must have a separate
480 count field since the 3 bit count field is otherwise too
481 small. Otherwise we can use the slightly more compact
482 format. This is in accordance with the cypress_m8 serial
483 converter app note. */
484 if (port->interrupt_out_size > 9)
485 priv->pkt_fmt = packet_format_1;
486 else
487 priv->pkt_fmt = packet_format_2;
489 if (interval > 0) {
490 priv->write_urb_interval = interval;
491 priv->read_urb_interval = interval;
492 dev_dbg(&port->dev, "%s - read & write intervals forced to %d\n",
493 __func__, interval);
494 } else {
495 priv->write_urb_interval = port->interrupt_out_urb->interval;
496 priv->read_urb_interval = port->interrupt_in_urb->interval;
497 dev_dbg(&port->dev, "%s - intervals: read=%d write=%d\n",
498 __func__, priv->read_urb_interval,
499 priv->write_urb_interval);
501 usb_set_serial_port_data(port, priv);
503 port->port.drain_delay = 256;
505 return 0;
509 static int cypress_earthmate_port_probe(struct usb_serial_port *port)
511 struct usb_serial *serial = port->serial;
512 struct cypress_private *priv;
513 int ret;
515 ret = cypress_generic_port_probe(port);
516 if (ret) {
517 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
518 return ret;
521 priv = usb_get_serial_port_data(port);
522 priv->chiptype = CT_EARTHMATE;
523 /* All Earthmate devices use the separated-count packet
524 format! Idiotic. */
525 priv->pkt_fmt = packet_format_1;
526 if (serial->dev->descriptor.idProduct !=
527 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB)) {
528 /* The old original USB Earthmate seemed able to
529 handle GET_CONFIG requests; everything they've
530 produced since that time crashes if this command is
531 attempted :-( */
532 dev_dbg(&port->dev,
533 "%s - Marking this device as unsafe for GET_CONFIG commands\n",
534 __func__);
535 priv->get_cfg_unsafe = !0;
538 return 0;
541 static int cypress_hidcom_port_probe(struct usb_serial_port *port)
543 struct cypress_private *priv;
544 int ret;
546 ret = cypress_generic_port_probe(port);
547 if (ret) {
548 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
549 return ret;
552 priv = usb_get_serial_port_data(port);
553 priv->chiptype = CT_CYPHIDCOM;
555 return 0;
558 static int cypress_ca42v2_port_probe(struct usb_serial_port *port)
560 struct cypress_private *priv;
561 int ret;
563 ret = cypress_generic_port_probe(port);
564 if (ret) {
565 dev_dbg(&port->dev, "%s - Failed setting up port\n", __func__);
566 return ret;
569 priv = usb_get_serial_port_data(port);
570 priv->chiptype = CT_CA42V2;
572 return 0;
575 static int cypress_port_remove(struct usb_serial_port *port)
577 struct cypress_private *priv;
579 priv = usb_get_serial_port_data(port);
581 kfifo_free(&priv->write_fifo);
582 kfree(priv);
584 return 0;
587 static int cypress_open(struct tty_struct *tty, struct usb_serial_port *port)
589 struct cypress_private *priv = usb_get_serial_port_data(port);
590 struct usb_serial *serial = port->serial;
591 unsigned long flags;
592 int result = 0;
594 if (!priv->comm_is_ok)
595 return -EIO;
597 /* clear halts before open */
598 usb_clear_halt(serial->dev, 0x81);
599 usb_clear_halt(serial->dev, 0x02);
601 spin_lock_irqsave(&priv->lock, flags);
602 /* reset read/write statistics */
603 priv->bytes_in = 0;
604 priv->bytes_out = 0;
605 priv->cmd_count = 0;
606 priv->rx_flags = 0;
607 spin_unlock_irqrestore(&priv->lock, flags);
609 /* Set termios */
610 cypress_send(port);
612 if (tty)
613 cypress_set_termios(tty, port, &priv->tmp_termios);
615 /* setup the port and start reading from the device */
616 usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
617 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
618 port->interrupt_in_urb->transfer_buffer,
619 port->interrupt_in_urb->transfer_buffer_length,
620 cypress_read_int_callback, port, priv->read_urb_interval);
621 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
623 if (result) {
624 dev_err(&port->dev,
625 "%s - failed submitting read urb, error %d\n",
626 __func__, result);
627 cypress_set_dead(port);
630 return result;
631 } /* cypress_open */
633 static void cypress_dtr_rts(struct usb_serial_port *port, int on)
635 struct cypress_private *priv = usb_get_serial_port_data(port);
636 /* drop dtr and rts */
637 spin_lock_irq(&priv->lock);
638 if (on == 0)
639 priv->line_control = 0;
640 else
641 priv->line_control = CONTROL_DTR | CONTROL_RTS;
642 priv->cmd_ctrl = 1;
643 spin_unlock_irq(&priv->lock);
644 cypress_write(NULL, port, NULL, 0);
647 static void cypress_close(struct usb_serial_port *port)
649 struct cypress_private *priv = usb_get_serial_port_data(port);
650 unsigned long flags;
652 spin_lock_irqsave(&priv->lock, flags);
653 kfifo_reset_out(&priv->write_fifo);
654 spin_unlock_irqrestore(&priv->lock, flags);
656 dev_dbg(&port->dev, "%s - stopping urbs\n", __func__);
657 usb_kill_urb(port->interrupt_in_urb);
658 usb_kill_urb(port->interrupt_out_urb);
660 if (stats)
661 dev_info(&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
662 priv->bytes_in, priv->bytes_out, priv->cmd_count);
663 } /* cypress_close */
666 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
667 const unsigned char *buf, int count)
669 struct cypress_private *priv = usb_get_serial_port_data(port);
671 dev_dbg(&port->dev, "%s - %d bytes\n", __func__, count);
673 /* line control commands, which need to be executed immediately,
674 are not put into the buffer for obvious reasons.
676 if (priv->cmd_ctrl) {
677 count = 0;
678 goto finish;
681 if (!count)
682 return count;
684 count = kfifo_in_locked(&priv->write_fifo, buf, count, &priv->lock);
686 finish:
687 cypress_send(port);
689 return count;
690 } /* cypress_write */
693 static void cypress_send(struct usb_serial_port *port)
695 int count = 0, result, offset, actual_size;
696 struct cypress_private *priv = usb_get_serial_port_data(port);
697 struct device *dev = &port->dev;
698 unsigned long flags;
700 if (!priv->comm_is_ok)
701 return;
703 dev_dbg(dev, "%s - interrupt out size is %d\n", __func__,
704 port->interrupt_out_size);
706 spin_lock_irqsave(&priv->lock, flags);
707 if (priv->write_urb_in_use) {
708 dev_dbg(dev, "%s - can't write, urb in use\n", __func__);
709 spin_unlock_irqrestore(&priv->lock, flags);
710 return;
712 spin_unlock_irqrestore(&priv->lock, flags);
714 /* clear buffer */
715 memset(port->interrupt_out_urb->transfer_buffer, 0,
716 port->interrupt_out_size);
718 spin_lock_irqsave(&priv->lock, flags);
719 switch (priv->pkt_fmt) {
720 default:
721 case packet_format_1:
722 /* this is for the CY7C64013... */
723 offset = 2;
724 port->interrupt_out_buffer[0] = priv->line_control;
725 break;
726 case packet_format_2:
727 /* this is for the CY7C63743... */
728 offset = 1;
729 port->interrupt_out_buffer[0] = priv->line_control;
730 break;
733 if (priv->line_control & CONTROL_RESET)
734 priv->line_control &= ~CONTROL_RESET;
736 if (priv->cmd_ctrl) {
737 priv->cmd_count++;
738 dev_dbg(dev, "%s - line control command being issued\n", __func__);
739 spin_unlock_irqrestore(&priv->lock, flags);
740 goto send;
741 } else
742 spin_unlock_irqrestore(&priv->lock, flags);
744 count = kfifo_out_locked(&priv->write_fifo,
745 &port->interrupt_out_buffer[offset],
746 port->interrupt_out_size - offset,
747 &priv->lock);
748 if (count == 0)
749 return;
751 switch (priv->pkt_fmt) {
752 default:
753 case packet_format_1:
754 port->interrupt_out_buffer[1] = count;
755 break;
756 case packet_format_2:
757 port->interrupt_out_buffer[0] |= count;
760 dev_dbg(dev, "%s - count is %d\n", __func__, count);
762 send:
763 spin_lock_irqsave(&priv->lock, flags);
764 priv->write_urb_in_use = 1;
765 spin_unlock_irqrestore(&priv->lock, flags);
767 if (priv->cmd_ctrl)
768 actual_size = 1;
769 else
770 actual_size = count +
771 (priv->pkt_fmt == packet_format_1 ? 2 : 1);
773 usb_serial_debug_data(dev, __func__, port->interrupt_out_size,
774 port->interrupt_out_urb->transfer_buffer);
776 usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
777 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
778 port->interrupt_out_buffer, port->interrupt_out_size,
779 cypress_write_int_callback, port, priv->write_urb_interval);
780 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
781 if (result) {
782 dev_err_console(port,
783 "%s - failed submitting write urb, error %d\n",
784 __func__, result);
785 priv->write_urb_in_use = 0;
786 cypress_set_dead(port);
789 spin_lock_irqsave(&priv->lock, flags);
790 if (priv->cmd_ctrl)
791 priv->cmd_ctrl = 0;
793 /* do not count the line control and size bytes */
794 priv->bytes_out += count;
795 spin_unlock_irqrestore(&priv->lock, flags);
797 usb_serial_port_softint(port);
798 } /* cypress_send */
801 /* returns how much space is available in the soft buffer */
802 static int cypress_write_room(struct tty_struct *tty)
804 struct usb_serial_port *port = tty->driver_data;
805 struct cypress_private *priv = usb_get_serial_port_data(port);
806 int room = 0;
807 unsigned long flags;
809 spin_lock_irqsave(&priv->lock, flags);
810 room = kfifo_avail(&priv->write_fifo);
811 spin_unlock_irqrestore(&priv->lock, flags);
813 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
814 return room;
818 static int cypress_tiocmget(struct tty_struct *tty)
820 struct usb_serial_port *port = tty->driver_data;
821 struct cypress_private *priv = usb_get_serial_port_data(port);
822 __u8 status, control;
823 unsigned int result = 0;
824 unsigned long flags;
826 spin_lock_irqsave(&priv->lock, flags);
827 control = priv->line_control;
828 status = priv->current_status;
829 spin_unlock_irqrestore(&priv->lock, flags);
831 result = ((control & CONTROL_DTR) ? TIOCM_DTR : 0)
832 | ((control & CONTROL_RTS) ? TIOCM_RTS : 0)
833 | ((status & UART_CTS) ? TIOCM_CTS : 0)
834 | ((status & UART_DSR) ? TIOCM_DSR : 0)
835 | ((status & UART_RI) ? TIOCM_RI : 0)
836 | ((status & UART_CD) ? TIOCM_CD : 0);
838 dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
840 return result;
844 static int cypress_tiocmset(struct tty_struct *tty,
845 unsigned int set, unsigned int clear)
847 struct usb_serial_port *port = tty->driver_data;
848 struct cypress_private *priv = usb_get_serial_port_data(port);
849 unsigned long flags;
851 spin_lock_irqsave(&priv->lock, flags);
852 if (set & TIOCM_RTS)
853 priv->line_control |= CONTROL_RTS;
854 if (set & TIOCM_DTR)
855 priv->line_control |= CONTROL_DTR;
856 if (clear & TIOCM_RTS)
857 priv->line_control &= ~CONTROL_RTS;
858 if (clear & TIOCM_DTR)
859 priv->line_control &= ~CONTROL_DTR;
860 priv->cmd_ctrl = 1;
861 spin_unlock_irqrestore(&priv->lock, flags);
863 return cypress_write(tty, port, NULL, 0);
867 static int cypress_tiocmiwait(struct tty_struct *tty, unsigned long arg)
869 struct usb_serial_port *port = tty->driver_data;
870 struct cypress_private *priv = usb_get_serial_port_data(port);
871 char diff;
873 for (;;) {
874 interruptible_sleep_on(&port->port.delta_msr_wait);
875 /* see if a signal did it */
876 if (signal_pending(current))
877 return -ERESTARTSYS;
879 if (port->serial->disconnected)
880 return -EIO;
882 diff = priv->diff_status;
883 if (diff == 0)
884 return -EIO; /* no change => error */
886 /* consume all events */
887 priv->diff_status = 0;
889 /* return 0 if caller wanted to know about
890 these bits */
891 if (((arg & TIOCM_RNG) && (diff & UART_RI)) ||
892 ((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
893 ((arg & TIOCM_CD) && (diff & UART_CD)) ||
894 ((arg & TIOCM_CTS) && (diff & UART_CTS)))
895 return 0;
896 /* otherwise caller can't care less about what
897 * happened, and so we continue to wait for
898 * more events.
902 return 0;
905 static void cypress_set_termios(struct tty_struct *tty,
906 struct usb_serial_port *port, struct ktermios *old_termios)
908 struct cypress_private *priv = usb_get_serial_port_data(port);
909 struct device *dev = &port->dev;
910 int data_bits, stop_bits, parity_type, parity_enable;
911 unsigned cflag, iflag;
912 unsigned long flags;
913 __u8 oldlines;
914 int linechange = 0;
916 spin_lock_irqsave(&priv->lock, flags);
917 /* We can't clean this one up as we don't know the device type
918 early enough */
919 if (!priv->termios_initialized) {
920 if (priv->chiptype == CT_EARTHMATE) {
921 tty->termios = tty_std_termios;
922 tty->termios.c_cflag = B4800 | CS8 | CREAD | HUPCL |
923 CLOCAL;
924 tty->termios.c_ispeed = 4800;
925 tty->termios.c_ospeed = 4800;
926 } else if (priv->chiptype == CT_CYPHIDCOM) {
927 tty->termios = tty_std_termios;
928 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
929 CLOCAL;
930 tty->termios.c_ispeed = 9600;
931 tty->termios.c_ospeed = 9600;
932 } else if (priv->chiptype == CT_CA42V2) {
933 tty->termios = tty_std_termios;
934 tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
935 CLOCAL;
936 tty->termios.c_ispeed = 9600;
937 tty->termios.c_ospeed = 9600;
939 priv->termios_initialized = 1;
941 spin_unlock_irqrestore(&priv->lock, flags);
943 /* Unsupported features need clearing */
944 tty->termios.c_cflag &= ~(CMSPAR|CRTSCTS);
946 cflag = tty->termios.c_cflag;
947 iflag = tty->termios.c_iflag;
949 /* check if there are new settings */
950 if (old_termios) {
951 spin_lock_irqsave(&priv->lock, flags);
952 priv->tmp_termios = tty->termios;
953 spin_unlock_irqrestore(&priv->lock, flags);
956 /* set number of data bits, parity, stop bits */
957 /* when parity is disabled the parity type bit is ignored */
959 /* 1 means 2 stop bits, 0 means 1 stop bit */
960 stop_bits = cflag & CSTOPB ? 1 : 0;
962 if (cflag & PARENB) {
963 parity_enable = 1;
964 /* 1 means odd parity, 0 means even parity */
965 parity_type = cflag & PARODD ? 1 : 0;
966 } else
967 parity_enable = parity_type = 0;
969 switch (cflag & CSIZE) {
970 case CS5:
971 data_bits = 0;
972 break;
973 case CS6:
974 data_bits = 1;
975 break;
976 case CS7:
977 data_bits = 2;
978 break;
979 case CS8:
980 data_bits = 3;
981 break;
982 default:
983 dev_err(dev, "%s - CSIZE was set, but not CS5-CS8\n", __func__);
984 data_bits = 3;
986 spin_lock_irqsave(&priv->lock, flags);
987 oldlines = priv->line_control;
988 if ((cflag & CBAUD) == B0) {
989 /* drop dtr and rts */
990 dev_dbg(dev, "%s - dropping the lines, baud rate 0bps\n", __func__);
991 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
992 } else
993 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
994 spin_unlock_irqrestore(&priv->lock, flags);
996 dev_dbg(dev, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
997 __func__, stop_bits, parity_enable, parity_type, data_bits);
999 cypress_serial_control(tty, port, tty_get_baud_rate(tty),
1000 data_bits, stop_bits,
1001 parity_enable, parity_type,
1002 0, CYPRESS_SET_CONFIG);
1004 /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1005 * filled into the private structure this should confirm that all is
1006 * working if it returns what we just set */
1007 cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
1009 /* Here we can define custom tty settings for devices; the main tty
1010 * termios flag base comes from empeg.c */
1012 spin_lock_irqsave(&priv->lock, flags);
1013 if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
1014 dev_dbg(dev, "Using custom termios settings for a baud rate of 4800bps.\n");
1015 /* define custom termios settings for NMEA protocol */
1017 tty->termios.c_iflag /* input modes - */
1018 &= ~(IGNBRK /* disable ignore break */
1019 | BRKINT /* disable break causes interrupt */
1020 | PARMRK /* disable mark parity errors */
1021 | ISTRIP /* disable clear high bit of input char */
1022 | INLCR /* disable translate NL to CR */
1023 | IGNCR /* disable ignore CR */
1024 | ICRNL /* disable translate CR to NL */
1025 | IXON); /* disable enable XON/XOFF flow control */
1027 tty->termios.c_oflag /* output modes */
1028 &= ~OPOST; /* disable postprocess output char */
1030 tty->termios.c_lflag /* line discipline modes */
1031 &= ~(ECHO /* disable echo input characters */
1032 | ECHONL /* disable echo new line */
1033 | ICANON /* disable erase, kill, werase, and rprnt
1034 special characters */
1035 | ISIG /* disable interrupt, quit, and suspend
1036 special characters */
1037 | IEXTEN); /* disable non-POSIX special characters */
1038 } /* CT_CYPHIDCOM: Application should handle this for device */
1040 linechange = (priv->line_control != oldlines);
1041 spin_unlock_irqrestore(&priv->lock, flags);
1043 /* if necessary, set lines */
1044 if (linechange) {
1045 priv->cmd_ctrl = 1;
1046 cypress_write(tty, port, NULL, 0);
1048 } /* cypress_set_termios */
1051 /* returns amount of data still left in soft buffer */
1052 static int cypress_chars_in_buffer(struct tty_struct *tty)
1054 struct usb_serial_port *port = tty->driver_data;
1055 struct cypress_private *priv = usb_get_serial_port_data(port);
1056 int chars = 0;
1057 unsigned long flags;
1059 spin_lock_irqsave(&priv->lock, flags);
1060 chars = kfifo_len(&priv->write_fifo);
1061 spin_unlock_irqrestore(&priv->lock, flags);
1063 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1064 return chars;
1068 static void cypress_throttle(struct tty_struct *tty)
1070 struct usb_serial_port *port = tty->driver_data;
1071 struct cypress_private *priv = usb_get_serial_port_data(port);
1073 spin_lock_irq(&priv->lock);
1074 priv->rx_flags = THROTTLED;
1075 spin_unlock_irq(&priv->lock);
1079 static void cypress_unthrottle(struct tty_struct *tty)
1081 struct usb_serial_port *port = tty->driver_data;
1082 struct cypress_private *priv = usb_get_serial_port_data(port);
1083 int actually_throttled, result;
1085 spin_lock_irq(&priv->lock);
1086 actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1087 priv->rx_flags = 0;
1088 spin_unlock_irq(&priv->lock);
1090 if (!priv->comm_is_ok)
1091 return;
1093 if (actually_throttled) {
1094 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1095 if (result) {
1096 dev_err(&port->dev, "%s - failed submitting read urb, "
1097 "error %d\n", __func__, result);
1098 cypress_set_dead(port);
1104 static void cypress_read_int_callback(struct urb *urb)
1106 struct usb_serial_port *port = urb->context;
1107 struct cypress_private *priv = usb_get_serial_port_data(port);
1108 struct device *dev = &urb->dev->dev;
1109 struct tty_struct *tty;
1110 unsigned char *data = urb->transfer_buffer;
1111 unsigned long flags;
1112 char tty_flag = TTY_NORMAL;
1113 int havedata = 0;
1114 int bytes = 0;
1115 int result;
1116 int i = 0;
1117 int status = urb->status;
1119 switch (status) {
1120 case 0: /* success */
1121 break;
1122 case -ECONNRESET:
1123 case -ENOENT:
1124 case -ESHUTDOWN:
1125 /* precursor to disconnect so just go away */
1126 return;
1127 case -EPIPE:
1128 /* Can't call usb_clear_halt while in_interrupt */
1129 /* FALLS THROUGH */
1130 default:
1131 /* something ugly is going on... */
1132 dev_err(dev, "%s - unexpected nonzero read status received: %d\n",
1133 __func__, status);
1134 cypress_set_dead(port);
1135 return;
1138 spin_lock_irqsave(&priv->lock, flags);
1139 if (priv->rx_flags & THROTTLED) {
1140 dev_dbg(dev, "%s - now throttling\n", __func__);
1141 priv->rx_flags |= ACTUALLY_THROTTLED;
1142 spin_unlock_irqrestore(&priv->lock, flags);
1143 return;
1145 spin_unlock_irqrestore(&priv->lock, flags);
1147 tty = tty_port_tty_get(&port->port);
1148 if (!tty) {
1149 dev_dbg(dev, "%s - bad tty pointer - exiting\n", __func__);
1150 return;
1153 spin_lock_irqsave(&priv->lock, flags);
1154 result = urb->actual_length;
1155 switch (priv->pkt_fmt) {
1156 default:
1157 case packet_format_1:
1158 /* This is for the CY7C64013... */
1159 priv->current_status = data[0] & 0xF8;
1160 bytes = data[1] + 2;
1161 i = 2;
1162 if (bytes > 2)
1163 havedata = 1;
1164 break;
1165 case packet_format_2:
1166 /* This is for the CY7C63743... */
1167 priv->current_status = data[0] & 0xF8;
1168 bytes = (data[0] & 0x07) + 1;
1169 i = 1;
1170 if (bytes > 1)
1171 havedata = 1;
1172 break;
1174 spin_unlock_irqrestore(&priv->lock, flags);
1175 if (result < bytes) {
1176 dev_dbg(dev,
1177 "%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1178 __func__, result, bytes);
1179 goto continue_read;
1182 usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1184 spin_lock_irqsave(&priv->lock, flags);
1185 /* check to see if status has changed */
1186 if (priv->current_status != priv->prev_status) {
1187 priv->diff_status |= priv->current_status ^
1188 priv->prev_status;
1189 wake_up_interruptible(&port->port.delta_msr_wait);
1190 priv->prev_status = priv->current_status;
1192 spin_unlock_irqrestore(&priv->lock, flags);
1194 /* hangup, as defined in acm.c... this might be a bad place for it
1195 * though */
1196 if (tty && !(tty->termios.c_cflag & CLOCAL) &&
1197 !(priv->current_status & UART_CD)) {
1198 dev_dbg(dev, "%s - calling hangup\n", __func__);
1199 tty_hangup(tty);
1200 goto continue_read;
1203 /* There is one error bit... I'm assuming it is a parity error
1204 * indicator as the generic firmware will set this bit to 1 if a
1205 * parity error occurs.
1206 * I can not find reference to any other error events. */
1207 spin_lock_irqsave(&priv->lock, flags);
1208 if (priv->current_status & CYP_ERROR) {
1209 spin_unlock_irqrestore(&priv->lock, flags);
1210 tty_flag = TTY_PARITY;
1211 dev_dbg(dev, "%s - Parity Error detected\n", __func__);
1212 } else
1213 spin_unlock_irqrestore(&priv->lock, flags);
1215 /* process read if there is data other than line status */
1216 if (bytes > i) {
1217 tty_insert_flip_string_fixed_flag(&port->port, data + i,
1218 tty_flag, bytes - i);
1219 tty_flip_buffer_push(&port->port);
1222 spin_lock_irqsave(&priv->lock, flags);
1223 /* control and status byte(s) are also counted */
1224 priv->bytes_in += bytes;
1225 spin_unlock_irqrestore(&priv->lock, flags);
1227 continue_read:
1228 tty_kref_put(tty);
1230 /* Continue trying to always read */
1232 if (priv->comm_is_ok) {
1233 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1234 usb_rcvintpipe(port->serial->dev,
1235 port->interrupt_in_endpointAddress),
1236 port->interrupt_in_urb->transfer_buffer,
1237 port->interrupt_in_urb->transfer_buffer_length,
1238 cypress_read_int_callback, port,
1239 priv->read_urb_interval);
1240 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1241 if (result && result != -EPERM) {
1242 dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
1243 __func__, result);
1244 cypress_set_dead(port);
1247 } /* cypress_read_int_callback */
1250 static void cypress_write_int_callback(struct urb *urb)
1252 struct usb_serial_port *port = urb->context;
1253 struct cypress_private *priv = usb_get_serial_port_data(port);
1254 struct device *dev = &urb->dev->dev;
1255 int result;
1256 int status = urb->status;
1258 switch (status) {
1259 case 0:
1260 /* success */
1261 break;
1262 case -ECONNRESET:
1263 case -ENOENT:
1264 case -ESHUTDOWN:
1265 /* this urb is terminated, clean up */
1266 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1267 __func__, status);
1268 priv->write_urb_in_use = 0;
1269 return;
1270 case -EPIPE: /* no break needed; clear halt and resubmit */
1271 if (!priv->comm_is_ok)
1272 break;
1273 usb_clear_halt(port->serial->dev, 0x02);
1274 /* error in the urb, so we have to resubmit it */
1275 dev_dbg(dev, "%s - nonzero write bulk status received: %d\n",
1276 __func__, status);
1277 port->interrupt_out_urb->transfer_buffer_length = 1;
1278 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1279 if (!result)
1280 return;
1281 dev_err(dev, "%s - failed resubmitting write urb, error %d\n",
1282 __func__, result);
1283 cypress_set_dead(port);
1284 break;
1285 default:
1286 dev_err(dev, "%s - unexpected nonzero write status received: %d\n",
1287 __func__, status);
1288 cypress_set_dead(port);
1289 break;
1291 priv->write_urb_in_use = 0;
1293 /* send any buffered data */
1294 cypress_send(port);
1297 module_usb_serial_driver(serial_drivers, id_table_combined);
1299 MODULE_AUTHOR(DRIVER_AUTHOR);
1300 MODULE_DESCRIPTION(DRIVER_DESC);
1301 MODULE_LICENSE("GPL");
1303 module_param(stats, bool, S_IRUGO | S_IWUSR);
1304 MODULE_PARM_DESC(stats, "Enable statistics or not");
1305 module_param(interval, int, S_IRUGO | S_IWUSR);
1306 MODULE_PARM_DESC(interval, "Overrides interrupt interval");
1307 module_param(unstable_bauds, bool, S_IRUGO | S_IWUSR);
1308 MODULE_PARM_DESC(unstable_bauds, "Allow unstable baud rates");