• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/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>
45 
46 #include "cypress_m8.h"
47 
48 
49 static bool stats;
50 static int interval;
51 static bool unstable_bauds;
52 
53 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
54 #define DRIVER_DESC "Cypress USB to Serial Driver"
55 
56 /* write buffer size defines */
57 #define CYPRESS_BUF_SIZE	1024
58 
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 */
63 };
64 
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 */
70 };
71 
72 static const struct usb_device_id id_table_nokiaca42v2[] = {
73 	{ USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
74 	{ }						/* Terminating entry */
75 };
76 
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 */
85 };
86 
87 MODULE_DEVICE_TABLE(usb, id_table_combined);
88 
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 */
92 };
93 
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 */
120 };
121 
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);
146 
147 static struct usb_serial_driver cypress_earthmate_device = {
148 	.driver = {
149 		.owner =		THIS_MODULE,
150 		.name =			"earthmate",
151 	},
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,
171 };
172 
173 static struct usb_serial_driver cypress_hidcom_device = {
174 	.driver = {
175 		.owner =		THIS_MODULE,
176 		.name =			"cyphidcom",
177 	},
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,
197 };
198 
199 static struct usb_serial_driver cypress_ca42v2_device = {
200 	.driver = {
201 		.owner =		THIS_MODULE,
202 		.name =			"nokiaca42v2",
203 	},
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,
223 };
224 
225 static struct usb_serial_driver * const serial_drivers[] = {
226 	&cypress_earthmate_device, &cypress_hidcom_device,
227 	&cypress_ca42v2_device, NULL
228 };
229 
230 /*****************************************************************************
231  * Cypress serial helper functions
232  *****************************************************************************/
233 
234 /* FRWD Dongle hidcom needs to skip reset and speed checks */
is_frwd(struct usb_device * dev)235 static inline bool is_frwd(struct usb_device *dev)
236 {
237 	return ((le16_to_cpu(dev->descriptor.idVendor) == VENDOR_ID_FRWD) &&
238 		(le16_to_cpu(dev->descriptor.idProduct) == PRODUCT_ID_CYPHIDCOM_FRWD));
239 }
240 
analyze_baud_rate(struct usb_serial_port * port,speed_t new_rate)241 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
242 {
243 	struct cypress_private *priv;
244 	priv = usb_get_serial_port_data(port);
245 
246 	if (unstable_bauds)
247 		return new_rate;
248 
249 	/* FRWD Dongle uses 115200 bps */
250 	if (is_frwd(port->serial->dev))
251 		return new_rate;
252 
253 	/*
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).
261 	 */
262 	if (port->serial->dev->speed == USB_SPEED_LOW) {
263 		/*
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.
269 		 */
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;
275 		}
276 	}
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;
287 		}
288 		break;
289 	default:
290 		break;
291 	}
292 	return new_rate;
293 }
294 
295 
296 /* This function can either set or retrieve the current serial line settings */
cypress_serial_control(struct tty_struct * tty,struct usb_serial_port * port,speed_t baud_rate,int data_bits,int stop_bits,int parity_enable,int parity_type,int reset,int cypress_request_type)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)
301 {
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;
308 
309 	priv = usb_get_serial_port_data(port);
310 
311 	if (!priv->comm_is_ok)
312 		return -ENODEV;
313 
314 	feature_buffer = kcalloc(feature_len, sizeof(u8), GFP_KERNEL);
315 	if (!feature_buffer)
316 		return -ENOMEM;
317 
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);
329 			}
330 		}
331 		dev_dbg(dev, "%s - baud rate is being sent as %d\n", __func__,
332 			new_baudrate);
333 
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 */
343 
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]);
349 
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);
357 
358 			if (tries++ >= 3)
359 				break;
360 
361 		} while (retval != feature_len &&
362 			 retval != -ENODEV);
363 
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);
377 		}
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;
386 		}
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);
395 
396 			if (tries++ >= 3)
397 				break;
398 		} while (retval != feature_len
399 						&& retval != -ENODEV);
400 
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);
413 		}
414 	}
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 */
422 
423 
cypress_set_dead(struct usb_serial_port * port)424 static void cypress_set_dead(struct usb_serial_port *port)
425 {
426 	struct cypress_private *priv = usb_get_serial_port_data(port);
427 	unsigned long flags;
428 
429 	spin_lock_irqsave(&priv->lock, flags);
430 	if (!priv->comm_is_ok) {
431 		spin_unlock_irqrestore(&priv->lock, flags);
432 		return;
433 	}
434 	priv->comm_is_ok = 0;
435 	spin_unlock_irqrestore(&priv->lock, flags);
436 
437 	dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
438 		"interval might be too short\n", port->number);
439 }
440 
441 
442 /*****************************************************************************
443  * Cypress serial driver functions
444  *****************************************************************************/
445 
446 
cypress_generic_port_probe(struct usb_serial_port * port)447 static int cypress_generic_port_probe(struct usb_serial_port *port)
448 {
449 	struct usb_serial *serial = port->serial;
450 	struct cypress_private *priv;
451 
452 	if (!port->interrupt_out_urb || !port->interrupt_in_urb) {
453 		dev_err(&port->dev, "required endpoint is missing\n");
454 		return -ENODEV;
455 	}
456 
457 	priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
458 	if (!priv)
459 		return -ENOMEM;
460 
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;
466 	}
467 
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);
473 
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;
488 
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);
500 	}
501 	usb_set_serial_port_data(port, priv);
502 
503 	return 0;
504 }
505 
506 
cypress_earthmate_port_probe(struct usb_serial_port * port)507 static 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 
cypress_hidcom_port_probe(struct usb_serial_port * port)539 static 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 
cypress_ca42v2_port_probe(struct usb_serial_port * port)556 static 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 
cypress_port_remove(struct usb_serial_port * port)573 static 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 
cypress_open(struct tty_struct * tty,struct usb_serial_port * port)585 static 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 	port->port.drain_delay = 256;
628 	return result;
629 } /* cypress_open */
630 
cypress_dtr_rts(struct usb_serial_port * port,int on)631 static 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 
cypress_close(struct usb_serial_port * port)645 static 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 
cypress_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * buf,int count)664 static 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 - port %d, %d bytes\n", __func__, port->number, 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 
684 finish:
685 	cypress_send(port);
686 
687 	return count;
688 } /* cypress_write */
689 
690 
cypress_send(struct usb_serial_port * port)691 static 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 
760 send:
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 */
cypress_write_room(struct tty_struct * tty)800 static 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 
cypress_tiocmget(struct tty_struct * tty)816 static 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 
cypress_tiocmset(struct tty_struct * tty,unsigned int set,unsigned int clear)842 static 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 
864 
cypress_tiocmiwait(struct tty_struct * tty,unsigned long arg)865 static int cypress_tiocmiwait(struct tty_struct *tty, unsigned long arg)
866 {
867 	struct usb_serial_port *port = tty->driver_data;
868 	struct cypress_private *priv = usb_get_serial_port_data(port);
869 	char diff;
870 
871 	for (;;) {
872 		interruptible_sleep_on(&port->port.delta_msr_wait);
873 		/* see if a signal did it */
874 		if (signal_pending(current))
875 			return -ERESTARTSYS;
876 
877 		if (port->serial->disconnected)
878 			return -EIO;
879 
880 		diff = priv->diff_status;
881 		if (diff == 0)
882 			return -EIO; /* no change => error */
883 
884 		/* consume all events */
885 		priv->diff_status = 0;
886 
887 		/* return 0 if caller wanted to know about
888 		   these bits */
889 		if (((arg & TIOCM_RNG) && (diff & UART_RI))  ||
890 			((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
891 			((arg & TIOCM_CD)  && (diff & UART_CD))  ||
892 			((arg & TIOCM_CTS) && (diff & UART_CTS)))
893 			return 0;
894 		/* otherwise caller can't care less about what
895 		 * happened, and so we continue to wait for
896 		 * more events.
897 		 */
898 	}
899 
900 	return 0;
901 }
902 
cypress_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)903 static void cypress_set_termios(struct tty_struct *tty,
904 	struct usb_serial_port *port, struct ktermios *old_termios)
905 {
906 	struct cypress_private *priv = usb_get_serial_port_data(port);
907 	struct device *dev = &port->dev;
908 	int data_bits, stop_bits, parity_type, parity_enable;
909 	unsigned cflag, iflag;
910 	unsigned long flags;
911 	__u8 oldlines;
912 	int linechange = 0;
913 
914 	spin_lock_irqsave(&priv->lock, flags);
915 	/* We can't clean this one up as we don't know the device type
916 	   early enough */
917 	if (!priv->termios_initialized) {
918 		if (priv->chiptype == CT_EARTHMATE) {
919 			tty->termios = tty_std_termios;
920 			tty->termios.c_cflag = B4800 | CS8 | CREAD | HUPCL |
921 				CLOCAL;
922 			tty->termios.c_ispeed = 4800;
923 			tty->termios.c_ospeed = 4800;
924 		} else if (priv->chiptype == CT_CYPHIDCOM) {
925 			tty->termios = tty_std_termios;
926 			tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
927 				CLOCAL;
928 			tty->termios.c_ispeed = 9600;
929 			tty->termios.c_ospeed = 9600;
930 		} else if (priv->chiptype == CT_CA42V2) {
931 			tty->termios = tty_std_termios;
932 			tty->termios.c_cflag = B9600 | CS8 | CREAD | HUPCL |
933 				CLOCAL;
934 			tty->termios.c_ispeed = 9600;
935 			tty->termios.c_ospeed = 9600;
936 		}
937 		priv->termios_initialized = 1;
938 	}
939 	spin_unlock_irqrestore(&priv->lock, flags);
940 
941 	/* Unsupported features need clearing */
942 	tty->termios.c_cflag &= ~(CMSPAR|CRTSCTS);
943 
944 	cflag = tty->termios.c_cflag;
945 	iflag = tty->termios.c_iflag;
946 
947 	/* check if there are new settings */
948 	if (old_termios) {
949 		spin_lock_irqsave(&priv->lock, flags);
950 		priv->tmp_termios = tty->termios;
951 		spin_unlock_irqrestore(&priv->lock, flags);
952 	}
953 
954 	/* set number of data bits, parity, stop bits */
955 	/* when parity is disabled the parity type bit is ignored */
956 
957 	/* 1 means 2 stop bits, 0 means 1 stop bit */
958 	stop_bits = cflag & CSTOPB ? 1 : 0;
959 
960 	if (cflag & PARENB) {
961 		parity_enable = 1;
962 		/* 1 means odd parity, 0 means even parity */
963 		parity_type = cflag & PARODD ? 1 : 0;
964 	} else
965 		parity_enable = parity_type = 0;
966 
967 	switch (cflag & CSIZE) {
968 	case CS5:
969 		data_bits = 0;
970 		break;
971 	case CS6:
972 		data_bits = 1;
973 		break;
974 	case CS7:
975 		data_bits = 2;
976 		break;
977 	case CS8:
978 		data_bits = 3;
979 		break;
980 	default:
981 		dev_err(dev, "%s - CSIZE was set, but not CS5-CS8\n", __func__);
982 		data_bits = 3;
983 	}
984 	spin_lock_irqsave(&priv->lock, flags);
985 	oldlines = priv->line_control;
986 	if ((cflag & CBAUD) == B0) {
987 		/* drop dtr and rts */
988 		dev_dbg(dev, "%s - dropping the lines, baud rate 0bps\n", __func__);
989 		priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
990 	} else
991 		priv->line_control = (CONTROL_DTR | CONTROL_RTS);
992 	spin_unlock_irqrestore(&priv->lock, flags);
993 
994 	dev_dbg(dev, "%s - sending %d stop_bits, %d parity_enable, %d parity_type, %d data_bits (+5)\n",
995 		__func__, stop_bits, parity_enable, parity_type, data_bits);
996 
997 	cypress_serial_control(tty, port, tty_get_baud_rate(tty),
998 			data_bits, stop_bits,
999 			parity_enable, parity_type,
1000 			0, CYPRESS_SET_CONFIG);
1001 
1002 	/* we perform a CYPRESS_GET_CONFIG so that the current settings are
1003 	 * filled into the private structure this should confirm that all is
1004 	 * working if it returns what we just set */
1005 	cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
1006 
1007 	/* Here we can define custom tty settings for devices; the main tty
1008 	 * termios flag base comes from empeg.c */
1009 
1010 	spin_lock_irqsave(&priv->lock, flags);
1011 	if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
1012 		dev_dbg(dev, "Using custom termios settings for a baud rate of 4800bps.\n");
1013 		/* define custom termios settings for NMEA protocol */
1014 
1015 		tty->termios.c_iflag /* input modes - */
1016 			&= ~(IGNBRK  /* disable ignore break */
1017 			| BRKINT     /* disable break causes interrupt */
1018 			| PARMRK     /* disable mark parity errors */
1019 			| ISTRIP     /* disable clear high bit of input char */
1020 			| INLCR      /* disable translate NL to CR */
1021 			| IGNCR      /* disable ignore CR */
1022 			| ICRNL      /* disable translate CR to NL */
1023 			| IXON);     /* disable enable XON/XOFF flow control */
1024 
1025 		tty->termios.c_oflag /* output modes */
1026 			&= ~OPOST;    /* disable postprocess output char */
1027 
1028 		tty->termios.c_lflag /* line discipline modes */
1029 			&= ~(ECHO     /* disable echo input characters */
1030 			| ECHONL      /* disable echo new line */
1031 			| ICANON      /* disable erase, kill, werase, and rprnt
1032 					 special characters */
1033 			| ISIG        /* disable interrupt, quit, and suspend
1034 					 special characters */
1035 			| IEXTEN);    /* disable non-POSIX special characters */
1036 	} /* CT_CYPHIDCOM: Application should handle this for device */
1037 
1038 	linechange = (priv->line_control != oldlines);
1039 	spin_unlock_irqrestore(&priv->lock, flags);
1040 
1041 	/* if necessary, set lines */
1042 	if (linechange) {
1043 		priv->cmd_ctrl = 1;
1044 		cypress_write(tty, port, NULL, 0);
1045 	}
1046 } /* cypress_set_termios */
1047 
1048 
1049 /* returns amount of data still left in soft buffer */
cypress_chars_in_buffer(struct tty_struct * tty)1050 static int cypress_chars_in_buffer(struct tty_struct *tty)
1051 {
1052 	struct usb_serial_port *port = tty->driver_data;
1053 	struct cypress_private *priv = usb_get_serial_port_data(port);
1054 	int chars = 0;
1055 	unsigned long flags;
1056 
1057 	spin_lock_irqsave(&priv->lock, flags);
1058 	chars = kfifo_len(&priv->write_fifo);
1059 	spin_unlock_irqrestore(&priv->lock, flags);
1060 
1061 	dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1062 	return chars;
1063 }
1064 
1065 
cypress_throttle(struct tty_struct * tty)1066 static void cypress_throttle(struct tty_struct *tty)
1067 {
1068 	struct usb_serial_port *port = tty->driver_data;
1069 	struct cypress_private *priv = usb_get_serial_port_data(port);
1070 
1071 	spin_lock_irq(&priv->lock);
1072 	priv->rx_flags = THROTTLED;
1073 	spin_unlock_irq(&priv->lock);
1074 }
1075 
1076 
cypress_unthrottle(struct tty_struct * tty)1077 static void cypress_unthrottle(struct tty_struct *tty)
1078 {
1079 	struct usb_serial_port *port = tty->driver_data;
1080 	struct cypress_private *priv = usb_get_serial_port_data(port);
1081 	int actually_throttled, result;
1082 
1083 	spin_lock_irq(&priv->lock);
1084 	actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1085 	priv->rx_flags = 0;
1086 	spin_unlock_irq(&priv->lock);
1087 
1088 	if (!priv->comm_is_ok)
1089 		return;
1090 
1091 	if (actually_throttled) {
1092 		result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
1093 		if (result) {
1094 			dev_err(&port->dev, "%s - failed submitting read urb, "
1095 					"error %d\n", __func__, result);
1096 			cypress_set_dead(port);
1097 		}
1098 	}
1099 }
1100 
1101 
cypress_read_int_callback(struct urb * urb)1102 static void cypress_read_int_callback(struct urb *urb)
1103 {
1104 	struct usb_serial_port *port = urb->context;
1105 	struct cypress_private *priv = usb_get_serial_port_data(port);
1106 	struct device *dev = &urb->dev->dev;
1107 	struct tty_struct *tty;
1108 	unsigned char *data = urb->transfer_buffer;
1109 	unsigned long flags;
1110 	char tty_flag = TTY_NORMAL;
1111 	int havedata = 0;
1112 	int bytes = 0;
1113 	int result;
1114 	int i = 0;
1115 	int status = urb->status;
1116 
1117 	switch (status) {
1118 	case 0: /* success */
1119 		break;
1120 	case -ECONNRESET:
1121 	case -ENOENT:
1122 	case -ESHUTDOWN:
1123 		/* precursor to disconnect so just go away */
1124 		return;
1125 	case -EPIPE:
1126 		/* Can't call usb_clear_halt while in_interrupt */
1127 		/* FALLS THROUGH */
1128 	default:
1129 		/* something ugly is going on... */
1130 		dev_err(dev, "%s - unexpected nonzero read status received: %d\n",
1131 			__func__, status);
1132 		cypress_set_dead(port);
1133 		return;
1134 	}
1135 
1136 	spin_lock_irqsave(&priv->lock, flags);
1137 	if (priv->rx_flags & THROTTLED) {
1138 		dev_dbg(dev, "%s - now throttling\n", __func__);
1139 		priv->rx_flags |= ACTUALLY_THROTTLED;
1140 		spin_unlock_irqrestore(&priv->lock, flags);
1141 		return;
1142 	}
1143 	spin_unlock_irqrestore(&priv->lock, flags);
1144 
1145 	tty = tty_port_tty_get(&port->port);
1146 	if (!tty) {
1147 		dev_dbg(dev, "%s - bad tty pointer - exiting\n", __func__);
1148 		return;
1149 	}
1150 
1151 	spin_lock_irqsave(&priv->lock, flags);
1152 	result = urb->actual_length;
1153 	switch (priv->pkt_fmt) {
1154 	default:
1155 	case packet_format_1:
1156 		/* This is for the CY7C64013... */
1157 		priv->current_status = data[0] & 0xF8;
1158 		bytes = data[1] + 2;
1159 		i = 2;
1160 		if (bytes > 2)
1161 			havedata = 1;
1162 		break;
1163 	case packet_format_2:
1164 		/* This is for the CY7C63743... */
1165 		priv->current_status = data[0] & 0xF8;
1166 		bytes = (data[0] & 0x07) + 1;
1167 		i = 1;
1168 		if (bytes > 1)
1169 			havedata = 1;
1170 		break;
1171 	}
1172 	spin_unlock_irqrestore(&priv->lock, flags);
1173 	if (result < bytes) {
1174 		dev_dbg(dev,
1175 			"%s - wrong packet size - received %d bytes but packet said %d bytes\n",
1176 			__func__, result, bytes);
1177 		goto continue_read;
1178 	}
1179 
1180 	usb_serial_debug_data(&port->dev, __func__, urb->actual_length, data);
1181 
1182 	spin_lock_irqsave(&priv->lock, flags);
1183 	/* check to see if status has changed */
1184 	if (priv->current_status != priv->prev_status) {
1185 		priv->diff_status |= priv->current_status ^
1186 			priv->prev_status;
1187 		wake_up_interruptible(&port->port.delta_msr_wait);
1188 		priv->prev_status = priv->current_status;
1189 	}
1190 	spin_unlock_irqrestore(&priv->lock, flags);
1191 
1192 	/* hangup, as defined in acm.c... this might be a bad place for it
1193 	 * though */
1194 	if (tty && !(tty->termios.c_cflag & CLOCAL) &&
1195 			!(priv->current_status & UART_CD)) {
1196 		dev_dbg(dev, "%s - calling hangup\n", __func__);
1197 		tty_hangup(tty);
1198 		goto continue_read;
1199 	}
1200 
1201 	/* There is one error bit... I'm assuming it is a parity error
1202 	 * indicator as the generic firmware will set this bit to 1 if a
1203 	 * parity error occurs.
1204 	 * I can not find reference to any other error events. */
1205 	spin_lock_irqsave(&priv->lock, flags);
1206 	if (priv->current_status & CYP_ERROR) {
1207 		spin_unlock_irqrestore(&priv->lock, flags);
1208 		tty_flag = TTY_PARITY;
1209 		dev_dbg(dev, "%s - Parity Error detected\n", __func__);
1210 	} else
1211 		spin_unlock_irqrestore(&priv->lock, flags);
1212 
1213 	/* process read if there is data other than line status */
1214 	if (bytes > i) {
1215 		tty_insert_flip_string_fixed_flag(&port->port, data + i,
1216 				tty_flag, bytes - i);
1217 		tty_flip_buffer_push(&port->port);
1218 	}
1219 
1220 	spin_lock_irqsave(&priv->lock, flags);
1221 	/* control and status byte(s) are also counted */
1222 	priv->bytes_in += bytes;
1223 	spin_unlock_irqrestore(&priv->lock, flags);
1224 
1225 continue_read:
1226 	tty_kref_put(tty);
1227 
1228 	/* Continue trying to always read */
1229 
1230 	if (priv->comm_is_ok) {
1231 		usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1232 				usb_rcvintpipe(port->serial->dev,
1233 					port->interrupt_in_endpointAddress),
1234 				port->interrupt_in_urb->transfer_buffer,
1235 				port->interrupt_in_urb->transfer_buffer_length,
1236 				cypress_read_int_callback, port,
1237 				priv->read_urb_interval);
1238 		result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1239 		if (result && result != -EPERM) {
1240 			dev_err(dev, "%s - failed resubmitting read urb, error %d\n",
1241 				__func__, result);
1242 			cypress_set_dead(port);
1243 		}
1244 	}
1245 } /* cypress_read_int_callback */
1246 
1247 
cypress_write_int_callback(struct urb * urb)1248 static void cypress_write_int_callback(struct urb *urb)
1249 {
1250 	struct usb_serial_port *port = urb->context;
1251 	struct cypress_private *priv = usb_get_serial_port_data(port);
1252 	struct device *dev = &urb->dev->dev;
1253 	int result;
1254 	int status = urb->status;
1255 
1256 	switch (status) {
1257 	case 0:
1258 		/* success */
1259 		break;
1260 	case -ECONNRESET:
1261 	case -ENOENT:
1262 	case -ESHUTDOWN:
1263 		/* this urb is terminated, clean up */
1264 		dev_dbg(dev, "%s - urb shutting down with status: %d\n",
1265 			__func__, status);
1266 		priv->write_urb_in_use = 0;
1267 		return;
1268 	case -EPIPE: /* no break needed; clear halt and resubmit */
1269 		if (!priv->comm_is_ok)
1270 			break;
1271 		usb_clear_halt(port->serial->dev, 0x02);
1272 		/* error in the urb, so we have to resubmit it */
1273 		dev_dbg(dev, "%s - nonzero write bulk status received: %d\n",
1274 			__func__, status);
1275 		port->interrupt_out_urb->transfer_buffer_length = 1;
1276 		result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1277 		if (!result)
1278 			return;
1279 		dev_err(dev, "%s - failed resubmitting write urb, error %d\n",
1280 			__func__, result);
1281 		cypress_set_dead(port);
1282 		break;
1283 	default:
1284 		dev_err(dev, "%s - unexpected nonzero write status received: %d\n",
1285 			__func__, status);
1286 		cypress_set_dead(port);
1287 		break;
1288 	}
1289 	priv->write_urb_in_use = 0;
1290 
1291 	/* send any buffered data */
1292 	cypress_send(port);
1293 }
1294 
1295 module_usb_serial_driver(serial_drivers, id_table_combined);
1296 
1297 MODULE_AUTHOR(DRIVER_AUTHOR);
1298 MODULE_DESCRIPTION(DRIVER_DESC);
1299 MODULE_LICENSE("GPL");
1300 
1301 module_param(stats, bool, S_IRUGO | S_IWUSR);
1302 MODULE_PARM_DESC(stats, "Enable statistics or not");
1303 module_param(interval, int, S_IRUGO | S_IWUSR);
1304 MODULE_PARM_DESC(interval, "Overrides interrupt interval");
1305 module_param(unstable_bauds, bool, S_IRUGO | S_IWUSR);
1306 MODULE_PARM_DESC(unstable_bauds, "Allow unstable baud rates");
1307