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