xref: /linux/drivers/usb/serial/iuu_phoenix.c (revision 040932cdcfca9b0ac55a4f74f194c2e2c8a2527b)
1 /*
2  * Infinity Unlimited USB Phoenix driver
3  *
4  * Copyright (C) 2007 Alain Degreffe (eczema@ecze.com)
5  *
6  * Original code taken from iuutool (Copyright (C) 2006 Juan Carlos Borrás)
7  *
8  *	This program is free software; you can redistribute it and/or modify
9  *	it under the terms of the GNU General Public License as published by
10  *	the Free Software Foundation; either version 2 of the License, or
11  *	(at your option) any later version.
12  *
13  *  And tested with help of WB Electronics
14  *
15  */
16 #include <linux/kernel.h>
17 #include <linux/errno.h>
18 #include <linux/init.h>
19 #include <linux/slab.h>
20 #include <linux/tty.h>
21 #include <linux/tty_driver.h>
22 #include <linux/tty_flip.h>
23 #include <linux/serial.h>
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/spinlock.h>
27 #include <linux/uaccess.h>
28 #include <linux/usb.h>
29 #include <linux/usb/serial.h>
30 #include "iuu_phoenix.h"
31 #include <linux/random.h>
32 
33 
34 #ifdef CONFIG_USB_SERIAL_DEBUG
35 static int debug = 1;
36 #else
37 static int debug;
38 #endif
39 
40 /*
41  * Version Information
42  */
43 #define DRIVER_VERSION "v0.10"
44 #define DRIVER_DESC "Infinity USB Unlimited Phoenix driver"
45 
46 static struct usb_device_id id_table[] = {
47 	{USB_DEVICE(IUU_USB_VENDOR_ID, IUU_USB_PRODUCT_ID)},
48 	{}			/* Terminating entry */
49 };
50 MODULE_DEVICE_TABLE(usb, id_table);
51 
52 static struct usb_driver iuu_driver = {
53 	.name = "iuu_phoenix",
54 	.probe = usb_serial_probe,
55 	.disconnect = usb_serial_disconnect,
56 	.id_table = id_table,
57 	.no_dynamic_id = 1,
58 };
59 
60 /* turbo parameter */
61 static int boost = 100;
62 static int clockmode = 1;
63 static int cdmode = 1;
64 static int iuu_cardin;
65 static int iuu_cardout;
66 static int xmas;
67 
68 static void read_rxcmd_callback(struct urb *urb);
69 
70 struct iuu_private {
71 	spinlock_t lock;	/* store irq state */
72 	wait_queue_head_t delta_msr_wait;
73 	u8 line_status;
74 	int tiostatus;		/* store IUART SIGNAL for tiocmget call */
75 	u8 reset;		/* if 1 reset is needed */
76 	int poll;		/* number of poll */
77 	u8 *writebuf;		/* buffer for writing to device */
78 	int writelen;		/* num of byte to write to device */
79 	u8 *buf;		/* used for initialize speed */
80 	u8 *dbgbuf;		/* debug buffer */
81 	u8 len;
82 };
83 
84 
85 static void iuu_free_buf(struct iuu_private *priv)
86 {
87 	kfree(priv->buf);
88 	kfree(priv->dbgbuf);
89 	kfree(priv->writebuf);
90 }
91 
92 static int iuu_alloc_buf(struct iuu_private *priv)
93 {
94 	priv->buf = kzalloc(256, GFP_KERNEL);
95 	priv->dbgbuf = kzalloc(256, GFP_KERNEL);
96 	priv->writebuf = kzalloc(256, GFP_KERNEL);
97 	if (!priv->buf || !priv->dbgbuf || !priv->writebuf) {
98 		iuu_free_buf(priv);
99 		dbg("%s problem allocation buffer", __func__);
100 		return -ENOMEM;
101 	}
102 	dbg("%s - Privates buffers allocation success", __func__);
103 	return 0;
104 }
105 
106 static int iuu_startup(struct usb_serial *serial)
107 {
108 	struct iuu_private *priv;
109 	priv = kzalloc(sizeof(struct iuu_private), GFP_KERNEL);
110 	dbg("%s- priv allocation success", __func__);
111 	if (!priv)
112 		return -ENOMEM;
113 	if (iuu_alloc_buf(priv)) {
114 		kfree(priv);
115 		return -ENOMEM;
116 	}
117 	spin_lock_init(&priv->lock);
118 	init_waitqueue_head(&priv->delta_msr_wait);
119 	usb_set_serial_port_data(serial->port[0], priv);
120 	return 0;
121 }
122 
123 /* Release function */
124 static void iuu_release(struct usb_serial *serial)
125 {
126 	struct usb_serial_port *port = serial->port[0];
127 	struct iuu_private *priv = usb_get_serial_port_data(port);
128 	if (!port)
129 		return;
130 
131 	dbg("%s", __func__);
132 
133 	if (priv) {
134 		iuu_free_buf(priv);
135 		dbg("%s - I will free all", __func__);
136 		usb_set_serial_port_data(port, NULL);
137 
138 		dbg("%s - priv is not anymore in port structure", __func__);
139 		kfree(priv);
140 
141 		dbg("%s priv is now kfree", __func__);
142 	}
143 }
144 
145 static int iuu_tiocmset(struct tty_struct *tty, struct file *file,
146 			unsigned int set, unsigned int clear)
147 {
148 	struct usb_serial_port *port = tty->driver_data;
149 	struct iuu_private *priv = usb_get_serial_port_data(port);
150 	unsigned long flags;
151 
152 	/* FIXME: locking on tiomstatus */
153 	dbg("%s (%d) msg : SET = 0x%04x, CLEAR = 0x%04x ", __func__,
154 	    port->number, set, clear);
155 
156 	spin_lock_irqsave(&priv->lock, flags);
157 	if (set & TIOCM_RTS)
158 		priv->tiostatus = TIOCM_RTS;
159 
160 	if (!(set & TIOCM_RTS) && priv->tiostatus == TIOCM_RTS) {
161 		dbg("%s TIOCMSET RESET called !!!", __func__);
162 		priv->reset = 1;
163 	}
164 	spin_unlock_irqrestore(&priv->lock, flags);
165 	return 0;
166 }
167 
168 /* This is used to provide a carrier detect mechanism
169  * When a card is present, the response is 0x00
170  * When no card , the reader respond with TIOCM_CD
171  * This is known as CD autodetect mechanism
172  */
173 static int iuu_tiocmget(struct tty_struct *tty, struct file *file)
174 {
175 	struct usb_serial_port *port = tty->driver_data;
176 	struct iuu_private *priv = usb_get_serial_port_data(port);
177 	unsigned long flags;
178 	int rc;
179 
180 	spin_lock_irqsave(&priv->lock, flags);
181 	rc = priv->tiostatus;
182 	spin_unlock_irqrestore(&priv->lock, flags);
183 
184 	return rc;
185 }
186 
187 static void iuu_rxcmd(struct urb *urb)
188 {
189 	struct usb_serial_port *port = urb->context;
190 	int result;
191 	int status = urb->status;
192 
193 	dbg("%s - enter", __func__);
194 
195 	if (status) {
196 		dbg("%s - status = %d", __func__, status);
197 		/* error stop all */
198 		return;
199 	}
200 
201 
202 	memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
203 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
204 			  usb_sndbulkpipe(port->serial->dev,
205 					  port->bulk_out_endpointAddress),
206 			  port->write_urb->transfer_buffer, 1,
207 			  read_rxcmd_callback, port);
208 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
209 }
210 
211 static int iuu_reset(struct usb_serial_port *port, u8 wt)
212 {
213 	struct iuu_private *priv = usb_get_serial_port_data(port);
214 	int result;
215 	char *buf_ptr = port->write_urb->transfer_buffer;
216 	dbg("%s - enter", __func__);
217 
218 	/* Prepare the reset sequence */
219 
220 	*buf_ptr++ = IUU_RST_SET;
221 	*buf_ptr++ = IUU_DELAY_MS;
222 	*buf_ptr++ = wt;
223 	*buf_ptr = IUU_RST_CLEAR;
224 
225 	/* send the sequence */
226 
227 	usb_fill_bulk_urb(port->write_urb,
228 			  port->serial->dev,
229 			  usb_sndbulkpipe(port->serial->dev,
230 					  port->bulk_out_endpointAddress),
231 			  port->write_urb->transfer_buffer, 4, iuu_rxcmd, port);
232 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
233 	priv->reset = 0;
234 	return result;
235 }
236 
237 /* Status Function
238  * Return value is
239  * 0x00 = no card
240  * 0x01 = smartcard
241  * 0x02 = sim card
242  */
243 static void iuu_update_status_callback(struct urb *urb)
244 {
245 	struct usb_serial_port *port = urb->context;
246 	struct iuu_private *priv = usb_get_serial_port_data(port);
247 	u8 *st;
248 	int status = urb->status;
249 
250 	dbg("%s - enter", __func__);
251 
252 	if (status) {
253 		dbg("%s - status = %d", __func__, status);
254 		/* error stop all */
255 		return;
256 	}
257 
258 	st = urb->transfer_buffer;
259 	dbg("%s - enter", __func__);
260 	if (urb->actual_length == 1) {
261 		switch (st[0]) {
262 		case 0x1:
263 			priv->tiostatus = iuu_cardout;
264 			break;
265 		case 0x0:
266 			priv->tiostatus = iuu_cardin;
267 			break;
268 		default:
269 			priv->tiostatus = iuu_cardin;
270 		}
271 	}
272 	iuu_rxcmd(urb);
273 }
274 
275 static void iuu_status_callback(struct urb *urb)
276 {
277 	struct usb_serial_port *port = urb->context;
278 	int result;
279 	int status = urb->status;
280 
281 	dbg("%s - status = %d", __func__, status);
282 	usb_fill_bulk_urb(port->read_urb, port->serial->dev,
283 			  usb_rcvbulkpipe(port->serial->dev,
284 					  port->bulk_in_endpointAddress),
285 			  port->read_urb->transfer_buffer, 256,
286 			  iuu_update_status_callback, port);
287 	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
288 }
289 
290 static int iuu_status(struct usb_serial_port *port)
291 {
292 	int result;
293 
294 	dbg("%s - enter", __func__);
295 
296 	memset(port->write_urb->transfer_buffer, IUU_GET_STATE_REGISTER, 1);
297 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
298 			  usb_sndbulkpipe(port->serial->dev,
299 					  port->bulk_out_endpointAddress),
300 			  port->write_urb->transfer_buffer, 1,
301 			  iuu_status_callback, port);
302 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
303 	return result;
304 
305 }
306 
307 static int bulk_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
308 {
309 	int status;
310 	struct usb_serial *serial = port->serial;
311 	int actual = 0;
312 
313 	dbg("%s - enter", __func__);
314 
315 	/* send the data out the bulk port */
316 
317 	status =
318 	    usb_bulk_msg(serial->dev,
319 			 usb_sndbulkpipe(serial->dev,
320 					 port->bulk_out_endpointAddress), buf,
321 			 count, &actual, HZ * 1);
322 
323 	if (status != IUU_OPERATION_OK)
324 		dbg("%s - error = %2x", __func__, status);
325 	else
326 		dbg("%s - write OK !", __func__);
327 	return status;
328 }
329 
330 static int read_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
331 {
332 	int status;
333 	struct usb_serial *serial = port->serial;
334 	int actual = 0;
335 
336 	dbg("%s - enter", __func__);
337 
338 	/* send the data out the bulk port */
339 
340 	status =
341 	    usb_bulk_msg(serial->dev,
342 			 usb_rcvbulkpipe(serial->dev,
343 					 port->bulk_in_endpointAddress), buf,
344 			 count, &actual, HZ * 1);
345 
346 	if (status != IUU_OPERATION_OK)
347 		dbg("%s - error = %2x", __func__, status);
348 	else
349 		dbg("%s - read OK !", __func__);
350 	return status;
351 }
352 
353 static int iuu_led(struct usb_serial_port *port, unsigned int R,
354 		   unsigned int G, unsigned int B, u8 f)
355 {
356 	int status;
357 	u8 *buf;
358 	buf = kmalloc(8, GFP_KERNEL);
359 	if (!buf)
360 		return -ENOMEM;
361 
362 	dbg("%s - enter", __func__);
363 
364 	buf[0] = IUU_SET_LED;
365 	buf[1] = R & 0xFF;
366 	buf[2] = (R >> 8) & 0xFF;
367 	buf[3] = G & 0xFF;
368 	buf[4] = (G >> 8) & 0xFF;
369 	buf[5] = B & 0xFF;
370 	buf[6] = (B >> 8) & 0xFF;
371 	buf[7] = f;
372 	status = bulk_immediate(port, buf, 8);
373 	kfree(buf);
374 	if (status != IUU_OPERATION_OK)
375 		dbg("%s - led error status = %2x", __func__, status);
376 	else
377 		dbg("%s - led OK !", __func__);
378 	return IUU_OPERATION_OK;
379 }
380 
381 static void iuu_rgbf_fill_buffer(u8 *buf, u8 r1, u8 r2, u8 g1, u8 g2, u8 b1,
382 				 u8 b2, u8 freq)
383 {
384 	*buf++ = IUU_SET_LED;
385 	*buf++ = r1;
386 	*buf++ = r2;
387 	*buf++ = g1;
388 	*buf++ = g2;
389 	*buf++ = b1;
390 	*buf++ = b2;
391 	*buf = freq;
392 }
393 
394 static void iuu_led_activity_on(struct urb *urb)
395 {
396 	struct usb_serial_port *port = urb->context;
397 	int result;
398 	char *buf_ptr = port->write_urb->transfer_buffer;
399 	*buf_ptr++ = IUU_SET_LED;
400 	if (xmas == 1) {
401 		get_random_bytes(buf_ptr, 6);
402 		*(buf_ptr+7) = 1;
403 	} else {
404 		iuu_rgbf_fill_buffer(buf_ptr, 255, 255, 0, 0, 0, 0, 255);
405 	}
406 
407 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
408 			  usb_sndbulkpipe(port->serial->dev,
409 					  port->bulk_out_endpointAddress),
410 			  port->write_urb->transfer_buffer, 8 ,
411 			  iuu_rxcmd, port);
412 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
413 }
414 
415 static void iuu_led_activity_off(struct urb *urb)
416 {
417 	struct usb_serial_port *port = urb->context;
418 	int result;
419 	char *buf_ptr = port->write_urb->transfer_buffer;
420 	if (xmas == 1) {
421 		iuu_rxcmd(urb);
422 		return;
423 	} else {
424 		*buf_ptr++ = IUU_SET_LED;
425 		iuu_rgbf_fill_buffer(buf_ptr, 0, 0, 255, 255, 0, 0, 255);
426 	}
427 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
428 			  usb_sndbulkpipe(port->serial->dev,
429 					  port->bulk_out_endpointAddress),
430 			  port->write_urb->transfer_buffer, 8 ,
431 			  iuu_rxcmd, port);
432 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
433 }
434 
435 
436 
437 static int iuu_clk(struct usb_serial_port *port, int dwFrq)
438 {
439 	int status;
440 	struct iuu_private *priv = usb_get_serial_port_data(port);
441 	int Count = 0;
442 	u8 FrqGenAdr = 0x69;
443 	u8 DIV = 0;		/* 8bit */
444 	u8 XDRV = 0;		/* 8bit */
445 	u8 PUMP = 0;		/* 3bit */
446 	u8 PBmsb = 0;		/* 2bit */
447 	u8 PBlsb = 0;		/* 8bit */
448 	u8 PO = 0;		/* 1bit */
449 	u8 Q = 0;		/* 7bit */
450 	/* 24bit = 3bytes */
451 	unsigned int P = 0;
452 	unsigned int P2 = 0;
453 	int frq = (int)dwFrq;
454 
455 	dbg("%s - enter", __func__);
456 
457 	if (frq == 0) {
458 		priv->buf[Count++] = IUU_UART_WRITE_I2C;
459 		priv->buf[Count++] = FrqGenAdr << 1;
460 		priv->buf[Count++] = 0x09;
461 		priv->buf[Count++] = 0x00;
462 
463 		status = bulk_immediate(port, (u8 *) priv->buf, Count);
464 		if (status != 0) {
465 			dbg("%s - write error ", __func__);
466 			return status;
467 		}
468 	} else if (frq == 3579000) {
469 		DIV = 100;
470 		P = 1193;
471 		Q = 40;
472 		XDRV = 0;
473 	} else if (frq == 3680000) {
474 		DIV = 105;
475 		P = 161;
476 		Q = 5;
477 		XDRV = 0;
478 	} else if (frq == 6000000) {
479 		DIV = 66;
480 		P = 66;
481 		Q = 2;
482 		XDRV = 0x28;
483 	} else {
484 		unsigned int result = 0;
485 		unsigned int tmp = 0;
486 		unsigned int check;
487 		unsigned int check2;
488 		char found = 0x00;
489 		unsigned int lQ = 2;
490 		unsigned int lP = 2055;
491 		unsigned int lDiv = 4;
492 
493 		for (lQ = 2; lQ <= 47 && !found; lQ++)
494 			for (lP = 2055; lP >= 8 && !found; lP--)
495 				for (lDiv = 4; lDiv <= 127 && !found; lDiv++) {
496 					tmp = (12000000 / lDiv) * (lP / lQ);
497 					if (abs((int)(tmp - frq)) <
498 					    abs((int)(frq - result))) {
499 						check2 = (12000000 / lQ);
500 						if (check2 < 250000)
501 							continue;
502 						check = (12000000 / lQ) * lP;
503 						if (check > 400000000)
504 							continue;
505 						if (check < 100000000)
506 							continue;
507 						if (lDiv < 4 || lDiv > 127)
508 							continue;
509 						result = tmp;
510 						P = lP;
511 						DIV = lDiv;
512 						Q = lQ;
513 						if (result == frq)
514 							found = 0x01;
515 					}
516 				}
517 	}
518 	P2 = ((P - PO) / 2) - 4;
519 	DIV = DIV;
520 	PUMP = 0x04;
521 	PBmsb = (P2 >> 8 & 0x03);
522 	PBlsb = P2 & 0xFF;
523 	PO = (P >> 10) & 0x01;
524 	Q = Q - 2;
525 
526 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/* 0x4C */
527 	priv->buf[Count++] = FrqGenAdr << 1;
528 	priv->buf[Count++] = 0x09;
529 	priv->buf[Count++] = 0x20;	/* Adr = 0x09 */
530 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/* 0x4C */
531 	priv->buf[Count++] = FrqGenAdr << 1;
532 	priv->buf[Count++] = 0x0C;
533 	priv->buf[Count++] = DIV;	/* Adr = 0x0C */
534 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/* 0x4C */
535 	priv->buf[Count++] = FrqGenAdr << 1;
536 	priv->buf[Count++] = 0x12;
537 	priv->buf[Count++] = XDRV;	/* Adr = 0x12 */
538 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
539 	priv->buf[Count++] = FrqGenAdr << 1;
540 	priv->buf[Count++] = 0x13;
541 	priv->buf[Count++] = 0x6B;	/* Adr = 0x13 */
542 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
543 	priv->buf[Count++] = FrqGenAdr << 1;
544 	priv->buf[Count++] = 0x40;
545 	priv->buf[Count++] = (0xC0 | ((PUMP & 0x07) << 2)) |
546 			     (PBmsb & 0x03);	/* Adr = 0x40 */
547 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
548 	priv->buf[Count++] = FrqGenAdr << 1;
549 	priv->buf[Count++] = 0x41;
550 	priv->buf[Count++] = PBlsb;	/* Adr = 0x41 */
551 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
552 	priv->buf[Count++] = FrqGenAdr << 1;
553 	priv->buf[Count++] = 0x42;
554 	priv->buf[Count++] = Q | (((PO & 0x01) << 7));	/* Adr = 0x42 */
555 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
556 	priv->buf[Count++] = FrqGenAdr << 1;
557 	priv->buf[Count++] = 0x44;
558 	priv->buf[Count++] = (char)0xFF;	/* Adr = 0x44 */
559 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
560 	priv->buf[Count++] = FrqGenAdr << 1;
561 	priv->buf[Count++] = 0x45;
562 	priv->buf[Count++] = (char)0xFE;	/* Adr = 0x45 */
563 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
564 	priv->buf[Count++] = FrqGenAdr << 1;
565 	priv->buf[Count++] = 0x46;
566 	priv->buf[Count++] = 0x7F;	/* Adr = 0x46 */
567 	priv->buf[Count++] = IUU_UART_WRITE_I2C;	/*  0x4C */
568 	priv->buf[Count++] = FrqGenAdr << 1;
569 	priv->buf[Count++] = 0x47;
570 	priv->buf[Count++] = (char)0x84;	/* Adr = 0x47 */
571 
572 	status = bulk_immediate(port, (u8 *) priv->buf, Count);
573 	if (status != IUU_OPERATION_OK)
574 		dbg("%s - write error ", __func__);
575 	return status;
576 }
577 
578 static int iuu_uart_flush(struct usb_serial_port *port)
579 {
580 	int i;
581 	int status;
582 	u8 rxcmd = IUU_UART_RX;
583 	struct iuu_private *priv = usb_get_serial_port_data(port);
584 
585 	dbg("%s - enter", __func__);
586 
587 	if (iuu_led(port, 0xF000, 0, 0, 0xFF) < 0)
588 		return -EIO;
589 
590 	for (i = 0; i < 2; i++) {
591 		status = bulk_immediate(port, &rxcmd, 1);
592 		if (status != IUU_OPERATION_OK) {
593 			dbg("%s - uart_flush_write error", __func__);
594 			return status;
595 		}
596 
597 		status = read_immediate(port, &priv->len, 1);
598 		if (status != IUU_OPERATION_OK) {
599 			dbg("%s - uart_flush_read error", __func__);
600 			return status;
601 		}
602 
603 		if (priv->len > 0) {
604 			dbg("%s - uart_flush datalen is : %i ", __func__,
605 			    priv->len);
606 			status = read_immediate(port, priv->buf, priv->len);
607 			if (status != IUU_OPERATION_OK) {
608 				dbg("%s - uart_flush_read error", __func__);
609 				return status;
610 			}
611 		}
612 	}
613 	dbg("%s - uart_flush_read OK!", __func__);
614 	iuu_led(port, 0, 0xF000, 0, 0xFF);
615 	return status;
616 }
617 
618 static void read_buf_callback(struct urb *urb)
619 {
620 	struct usb_serial_port *port = urb->context;
621 	unsigned char *data = urb->transfer_buffer;
622 	struct tty_struct *tty;
623 	int status = urb->status;
624 
625 	dbg("%s - status = %d", __func__, status);
626 
627 	if (status) {
628 		if (status == -EPROTO) {
629 			/* reschedule needed */
630 		}
631 		return;
632 	}
633 
634 	dbg("%s - %i chars to write", __func__, urb->actual_length);
635 	tty = tty_port_tty_get(&port->port);
636 	if (data == NULL)
637 		dbg("%s - data is NULL !!!", __func__);
638 	if (tty && urb->actual_length && data) {
639 		tty_insert_flip_string(tty, data, urb->actual_length);
640 		tty_flip_buffer_push(tty);
641 	}
642 	tty_kref_put(tty);
643 	iuu_led_activity_on(urb);
644 }
645 
646 static int iuu_bulk_write(struct usb_serial_port *port)
647 {
648 	struct iuu_private *priv = usb_get_serial_port_data(port);
649 	unsigned long flags;
650 	int result;
651 	int i;
652 	int buf_len;
653 	char *buf_ptr = port->write_urb->transfer_buffer;
654 	dbg("%s - enter", __func__);
655 
656 	spin_lock_irqsave(&priv->lock, flags);
657 	*buf_ptr++ = IUU_UART_ESC;
658 	*buf_ptr++ = IUU_UART_TX;
659 	*buf_ptr++ = priv->writelen;
660 
661 	memcpy(buf_ptr, priv->writebuf, priv->writelen);
662 	buf_len = priv->writelen;
663 	priv->writelen = 0;
664 	spin_unlock_irqrestore(&priv->lock, flags);
665 	if (debug == 1) {
666 		for (i = 0; i < buf_len; i++)
667 			sprintf(priv->dbgbuf + i*2 ,
668 				"%02X", priv->writebuf[i]);
669 		priv->dbgbuf[buf_len+i*2] = 0;
670 		dbg("%s - writing %i chars : %s", __func__,
671 		    buf_len, priv->dbgbuf);
672 	}
673 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
674 			  usb_sndbulkpipe(port->serial->dev,
675 					  port->bulk_out_endpointAddress),
676 			  port->write_urb->transfer_buffer, buf_len + 3,
677 			  iuu_rxcmd, port);
678 	result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
679 	usb_serial_port_softint(port);
680 	return result;
681 }
682 
683 static int iuu_read_buf(struct usb_serial_port *port, int len)
684 {
685 	int result;
686 	dbg("%s - enter", __func__);
687 
688 	usb_fill_bulk_urb(port->read_urb, port->serial->dev,
689 			  usb_rcvbulkpipe(port->serial->dev,
690 					  port->bulk_in_endpointAddress),
691 			  port->read_urb->transfer_buffer, len,
692 			  read_buf_callback, port);
693 	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
694 	return result;
695 }
696 
697 static void iuu_uart_read_callback(struct urb *urb)
698 {
699 	struct usb_serial_port *port = urb->context;
700 	struct iuu_private *priv = usb_get_serial_port_data(port);
701 	unsigned long flags;
702 	int status = urb->status;
703 	int error = 0;
704 	int len = 0;
705 	unsigned char *data = urb->transfer_buffer;
706 	priv->poll++;
707 
708 	dbg("%s - enter", __func__);
709 
710 	if (status) {
711 		dbg("%s - status = %d", __func__, status);
712 		/* error stop all */
713 		return;
714 	}
715 	if (data == NULL)
716 		dbg("%s - data is NULL !!!", __func__);
717 
718 	if (urb->actual_length == 1  && data != NULL)
719 		len = (int) data[0];
720 
721 	if (urb->actual_length > 1) {
722 		dbg("%s - urb->actual_length = %i", __func__,
723 		    urb->actual_length);
724 		error = 1;
725 		return;
726 	}
727 	/* if len > 0 call readbuf */
728 
729 	if (len > 0 && error == 0) {
730 		dbg("%s - call read buf - len to read is %i ",
731 			__func__, len);
732 		status = iuu_read_buf(port, len);
733 		return;
734 	}
735 	/* need to update status  ? */
736 	if (priv->poll > 99) {
737 		status = iuu_status(port);
738 		priv->poll = 0;
739 		return;
740 	}
741 
742 	/* reset waiting ? */
743 
744 	if (priv->reset == 1) {
745 		status = iuu_reset(port, 0xC);
746 		return;
747 	}
748 	/* Writebuf is waiting */
749 	spin_lock_irqsave(&priv->lock, flags);
750 	if (priv->writelen > 0) {
751 		spin_unlock_irqrestore(&priv->lock, flags);
752 		status = iuu_bulk_write(port);
753 		return;
754 	}
755 	spin_unlock_irqrestore(&priv->lock, flags);
756 	/* if nothing to write call again rxcmd */
757 	dbg("%s - rxcmd recall", __func__);
758 	iuu_led_activity_off(urb);
759 }
760 
761 static int iuu_uart_write(struct tty_struct *tty, struct usb_serial_port *port,
762 			  const u8 *buf, int count)
763 {
764 	struct iuu_private *priv = usb_get_serial_port_data(port);
765 	unsigned long flags;
766 	dbg("%s - enter", __func__);
767 
768 	if (count > 256)
769 		return -ENOMEM;
770 
771 	spin_lock_irqsave(&priv->lock, flags);
772 
773 	/* fill the buffer */
774 	memcpy(priv->writebuf + priv->writelen, buf, count);
775 	priv->writelen += count;
776 	spin_unlock_irqrestore(&priv->lock, flags);
777 
778 	return count;
779 }
780 
781 static void read_rxcmd_callback(struct urb *urb)
782 {
783 	struct usb_serial_port *port = urb->context;
784 	int result;
785 	int status = urb->status;
786 
787 	dbg("%s - status = %d", __func__, status);
788 
789 	if (status) {
790 		/* error stop all */
791 		return;
792 	}
793 
794 	usb_fill_bulk_urb(port->read_urb, port->serial->dev,
795 			  usb_rcvbulkpipe(port->serial->dev,
796 					  port->bulk_in_endpointAddress),
797 			  port->read_urb->transfer_buffer, 256,
798 			  iuu_uart_read_callback, port);
799 	result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
800 	dbg("%s - submit result = %d", __func__, result);
801 	return;
802 }
803 
804 static int iuu_uart_on(struct usb_serial_port *port)
805 {
806 	int status;
807 	u8 *buf;
808 
809 	buf = kmalloc(sizeof(u8) * 4, GFP_KERNEL);
810 
811 	if (!buf)
812 		return -ENOMEM;
813 
814 	buf[0] = IUU_UART_ENABLE;
815 	buf[1] = (u8) ((IUU_BAUD_9600 >> 8) & 0x00FF);
816 	buf[2] = (u8) (0x00FF & IUU_BAUD_9600);
817 	buf[3] = (u8) (0x0F0 & IUU_ONE_STOP_BIT) | (0x07 & IUU_PARITY_EVEN);
818 
819 	status = bulk_immediate(port, buf, 4);
820 	if (status != IUU_OPERATION_OK) {
821 		dbg("%s - uart_on error", __func__);
822 		goto uart_enable_failed;
823 	}
824 	/*  iuu_reset() the card after iuu_uart_on() */
825 	status = iuu_uart_flush(port);
826 	if (status != IUU_OPERATION_OK)
827 		dbg("%s - uart_flush error", __func__);
828 uart_enable_failed:
829 	kfree(buf);
830 	return status;
831 }
832 
833 /*  Diables the IUU UART (a.k.a. the Phoenix voiderface) */
834 static int iuu_uart_off(struct usb_serial_port *port)
835 {
836 	int status;
837 	u8 *buf;
838 	buf = kmalloc(1, GFP_KERNEL);
839 	if (!buf)
840 		return -ENOMEM;
841 	buf[0] = IUU_UART_DISABLE;
842 
843 	status = bulk_immediate(port, buf, 1);
844 	if (status != IUU_OPERATION_OK)
845 		dbg("%s - uart_off error", __func__);
846 
847 	kfree(buf);
848 	return status;
849 }
850 
851 static int iuu_uart_baud(struct usb_serial_port *port, u32 baud,
852 			 u32 *actual, u8 parity)
853 {
854 	int status;
855 	u8 *dataout;
856 	u8 DataCount = 0;
857 	u8 T1Frekvens = 0;
858 	u8 T1reload = 0;
859 	unsigned int T1FrekvensHZ = 0;
860 
861 	dataout = kmalloc(sizeof(u8) * 5, GFP_KERNEL);
862 
863 	if (!dataout)
864 		return -ENOMEM;
865 
866 	if (baud < 1200 || baud > 230400) {
867 		kfree(dataout);
868 		return IUU_INVALID_PARAMETER;
869 	}
870 	if (baud > 977) {
871 		T1Frekvens = 3;
872 		T1FrekvensHZ = 500000;
873 	}
874 
875 	if (baud > 3906) {
876 		T1Frekvens = 2;
877 		T1FrekvensHZ = 2000000;
878 	}
879 
880 	if (baud > 11718) {
881 		T1Frekvens = 1;
882 		T1FrekvensHZ = 6000000;
883 	}
884 
885 	if (baud > 46875) {
886 		T1Frekvens = 0;
887 		T1FrekvensHZ = 24000000;
888 	}
889 
890 	T1reload = 256 - (u8) (T1FrekvensHZ / (baud * 2));
891 
892 	/*  magic number here:  ENTER_FIRMWARE_UPDATE; */
893 	dataout[DataCount++] = IUU_UART_ESC;
894 	/*  magic number here:  CHANGE_BAUD; */
895 	dataout[DataCount++] = IUU_UART_CHANGE;
896 	dataout[DataCount++] = T1Frekvens;
897 	dataout[DataCount++] = T1reload;
898 
899 	*actual = (T1FrekvensHZ / (256 - T1reload)) / 2;
900 
901 	switch (parity & 0x0F) {
902 	case IUU_PARITY_NONE:
903 		dataout[DataCount++] = 0x00;
904 		break;
905 	case IUU_PARITY_EVEN:
906 		dataout[DataCount++] = 0x01;
907 		break;
908 	case IUU_PARITY_ODD:
909 		dataout[DataCount++] = 0x02;
910 		break;
911 	case IUU_PARITY_MARK:
912 		dataout[DataCount++] = 0x03;
913 		break;
914 	case IUU_PARITY_SPACE:
915 		dataout[DataCount++] = 0x04;
916 		break;
917 	default:
918 		kfree(dataout);
919 		return IUU_INVALID_PARAMETER;
920 		break;
921 	}
922 
923 	switch (parity & 0xF0) {
924 	case IUU_ONE_STOP_BIT:
925 		dataout[DataCount - 1] |= IUU_ONE_STOP_BIT;
926 		break;
927 
928 	case IUU_TWO_STOP_BITS:
929 		dataout[DataCount - 1] |= IUU_TWO_STOP_BITS;
930 		break;
931 	default:
932 		kfree(dataout);
933 		return IUU_INVALID_PARAMETER;
934 		break;
935 	}
936 
937 	status = bulk_immediate(port, dataout, DataCount);
938 	if (status != IUU_OPERATION_OK)
939 		dbg("%s - uart_off error", __func__);
940 	kfree(dataout);
941 	return status;
942 }
943 
944 static void iuu_set_termios(struct tty_struct *tty,
945 		struct usb_serial_port *port, struct ktermios *old_termios)
946 {
947 	const u32 supported_mask = CMSPAR|PARENB|PARODD;
948 
949 	unsigned int cflag = tty->termios->c_cflag;
950 	int status;
951 	u32 actual;
952 	u32 parity;
953 	int csize = CS7;
954 	int baud = 9600;	/* Fixed for the moment */
955 	u32 newval = cflag & supported_mask;
956 
957 	/* compute the parity parameter */
958 	parity = 0;
959 	if (cflag & CMSPAR) {	/* Using mark space */
960 		if (cflag & PARODD)
961 			parity |= IUU_PARITY_SPACE;
962 		else
963 			parity |= IUU_PARITY_MARK;
964 	} else if (!(cflag & PARENB)) {
965 		parity |= IUU_PARITY_NONE;
966 		csize = CS8;
967 	} else if (cflag & PARODD)
968 		parity |= IUU_PARITY_ODD;
969 	else
970 		parity |= IUU_PARITY_EVEN;
971 
972 	parity |= (cflag & CSTOPB ? IUU_TWO_STOP_BITS : IUU_ONE_STOP_BIT);
973 
974 	/* set it */
975 	status = iuu_uart_baud(port,
976 			(clockmode == 2) ? 16457 : 9600 * boost / 100,
977 			&actual, parity);
978 
979 	/* set the termios value to the real one, so the user now what has
980 	 * changed. We support few fields so its easies to copy the old hw
981 	 * settings back over and then adjust them
982 	 */
983  	if (old_termios)
984  		tty_termios_copy_hw(tty->termios, old_termios);
985 	if (status != 0)	/* Set failed - return old bits */
986 		return;
987 	/* Re-encode speed, parity and csize */
988 	tty_encode_baud_rate(tty, baud, baud);
989 	tty->termios->c_cflag &= ~(supported_mask|CSIZE);
990 	tty->termios->c_cflag |= newval | csize;
991 }
992 
993 static void iuu_close(struct usb_serial_port *port)
994 {
995 	/* iuu_led (port,255,0,0,0); */
996 	struct usb_serial *serial;
997 
998 	serial = port->serial;
999 	if (!serial)
1000 		return;
1001 
1002 	dbg("%s - port %d", __func__, port->number);
1003 
1004 	iuu_uart_off(port);
1005 	if (serial->dev) {
1006 		/* free writebuf */
1007 		/* shutdown our urbs */
1008 		dbg("%s - shutting down urbs", __func__);
1009 		usb_kill_urb(port->write_urb);
1010 		usb_kill_urb(port->read_urb);
1011 		usb_kill_urb(port->interrupt_in_urb);
1012 		msleep(1000);
1013 		/* wait one second to free all buffers */
1014 		iuu_led(port, 0, 0, 0xF000, 0xFF);
1015 		msleep(1000);
1016 		usb_reset_device(port->serial->dev);
1017 	}
1018 }
1019 
1020 static void iuu_init_termios(struct tty_struct *tty)
1021 {
1022 	*(tty->termios) = tty_std_termios;
1023 	tty->termios->c_cflag = CLOCAL | CREAD | CS8 | B9600
1024 				| TIOCM_CTS | CSTOPB | PARENB;
1025 	tty->termios->c_ispeed = 9600;
1026 	tty->termios->c_ospeed = 9600;
1027 	tty->termios->c_lflag = 0;
1028 	tty->termios->c_oflag = 0;
1029 	tty->termios->c_iflag = 0;
1030 }
1031 
1032 static int iuu_open(struct tty_struct *tty, struct usb_serial_port *port)
1033 {
1034 	struct usb_serial *serial = port->serial;
1035 	u8 *buf;
1036 	int result;
1037 	u32 actual;
1038 	struct iuu_private *priv = usb_get_serial_port_data(port);
1039 
1040 	dbg("%s -  port %d", __func__, port->number);
1041 	usb_clear_halt(serial->dev, port->write_urb->pipe);
1042 	usb_clear_halt(serial->dev, port->read_urb->pipe);
1043 
1044 	buf = kmalloc(10, GFP_KERNEL);
1045 	if (buf == NULL)
1046 		return -ENOMEM;
1047 
1048 	/* fixup the endpoint buffer size */
1049 	kfree(port->bulk_out_buffer);
1050 	port->bulk_out_buffer = kmalloc(512, GFP_KERNEL);
1051 	port->bulk_out_size = 512;
1052 	kfree(port->bulk_in_buffer);
1053 	port->bulk_in_buffer = kmalloc(512, GFP_KERNEL);
1054 	port->bulk_in_size = 512;
1055 
1056 	if (!port->bulk_out_buffer || !port->bulk_in_buffer) {
1057 		kfree(port->bulk_out_buffer);
1058 		kfree(port->bulk_in_buffer);
1059 		kfree(buf);
1060 		return -ENOMEM;
1061 	}
1062 
1063 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1064 			  usb_sndbulkpipe(port->serial->dev,
1065 					  port->bulk_out_endpointAddress),
1066 			  port->bulk_out_buffer, 512,
1067 			  NULL, NULL);
1068 
1069 
1070 	usb_fill_bulk_urb(port->read_urb, port->serial->dev,
1071 			  usb_rcvbulkpipe(port->serial->dev,
1072 					  port->bulk_in_endpointAddress),
1073 			  port->bulk_in_buffer, 512,
1074 			  NULL, NULL);
1075 
1076 	priv->poll = 0;
1077 
1078 	/* initialize writebuf */
1079 #define FISH(a, b, c, d) do { \
1080 	result = usb_control_msg(port->serial->dev,	\
1081 				usb_rcvctrlpipe(port->serial->dev, 0),	\
1082 				b, a, c, d, buf, 1, 1000); \
1083 	dbg("0x%x:0x%x:0x%x:0x%x  %d - %x", a, b, c, d, result, \
1084 				buf[0]); } while (0);
1085 
1086 #define SOUP(a, b, c, d)  do { \
1087 	result = usb_control_msg(port->serial->dev,	\
1088 				usb_sndctrlpipe(port->serial->dev, 0),	\
1089 				b, a, c, d, NULL, 0, 1000); \
1090 	dbg("0x%x:0x%x:0x%x:0x%x  %d", a, b, c, d, result); } while (0)
1091 
1092 	/*  This is not UART related but IUU USB driver related or something */
1093 	/*  like that. Basically no IUU will accept any commands from the USB */
1094 	/*  host unless it has received the following message */
1095 	/* sprintf(buf ,"%c%c%c%c",0x03,0x02,0x02,0x0); */
1096 
1097 	SOUP(0x03, 0x02, 0x02, 0x0);
1098 	kfree(buf);
1099 	iuu_led(port, 0xF000, 0xF000, 0, 0xFF);
1100 	iuu_uart_on(port);
1101 	if (boost < 100)
1102 		boost = 100;
1103 	switch (clockmode) {
1104 	case 2:		/*  3.680 Mhz */
1105 		iuu_clk(port, IUU_CLK_3680000 * boost / 100);
1106 		result =
1107 		    iuu_uart_baud(port, 9600 * boost / 100, &actual,
1108 				  IUU_PARITY_EVEN);
1109 		break;
1110 	case 3:		/*  6.00 Mhz */
1111 		iuu_clk(port, IUU_CLK_6000000 * boost / 100);
1112 		result =
1113 		    iuu_uart_baud(port, 16457 * boost / 100, &actual,
1114 				  IUU_PARITY_EVEN);
1115 		break;
1116 	default:		/*  3.579 Mhz */
1117 		iuu_clk(port, IUU_CLK_3579000 * boost / 100);
1118 		result =
1119 		    iuu_uart_baud(port, 9600 * boost / 100, &actual,
1120 				  IUU_PARITY_EVEN);
1121 	}
1122 
1123 	/* set the cardin cardout signals */
1124 	switch (cdmode) {
1125 	case 0:
1126 		iuu_cardin = 0;
1127 		iuu_cardout = 0;
1128 		break;
1129 	case 1:
1130 		iuu_cardin = TIOCM_CD;
1131 		iuu_cardout =  0;
1132 		break;
1133 	case 2:
1134 		iuu_cardin = 0;
1135 		iuu_cardout = TIOCM_CD;
1136 		break;
1137 	case 3:
1138 		iuu_cardin = TIOCM_DSR;
1139 		iuu_cardout = 0;
1140 		break;
1141 	case 4:
1142 		iuu_cardin = 0;
1143 		iuu_cardout = TIOCM_DSR;
1144 		break;
1145 	case 5:
1146 		iuu_cardin = TIOCM_CTS;
1147 		iuu_cardout = 0;
1148 		break;
1149 	case 6:
1150 		iuu_cardin = 0;
1151 		iuu_cardout = TIOCM_CTS;
1152 		break;
1153 	case 7:
1154 		iuu_cardin = TIOCM_RNG;
1155 		iuu_cardout = 0;
1156 		break;
1157 	case 8:
1158 		iuu_cardin = 0;
1159 		iuu_cardout = TIOCM_RNG;
1160 	}
1161 
1162 	iuu_uart_flush(port);
1163 
1164 	dbg("%s - initialization done", __func__);
1165 
1166 	memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
1167 	usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1168 			  usb_sndbulkpipe(port->serial->dev,
1169 					  port->bulk_out_endpointAddress),
1170 			  port->write_urb->transfer_buffer, 1,
1171 			  read_rxcmd_callback, port);
1172 	result = usb_submit_urb(port->write_urb, GFP_KERNEL);
1173 
1174 	if (result) {
1175 		dev_err(&port->dev, "%s - failed submitting read urb,"
1176 			" error %d\n", __func__, result);
1177 		iuu_close(port);
1178 		return -EPROTO;
1179 	} else {
1180 		dbg("%s - rxcmd OK", __func__);
1181 	}
1182 	return result;
1183 }
1184 
1185 static struct usb_serial_driver iuu_device = {
1186 	.driver = {
1187 		   .owner = THIS_MODULE,
1188 		   .name = "iuu_phoenix",
1189 		   },
1190 	.id_table = id_table,
1191 	.num_ports = 1,
1192 	.open = iuu_open,
1193 	.close = iuu_close,
1194 	.write = iuu_uart_write,
1195 	.read_bulk_callback = iuu_uart_read_callback,
1196 	.tiocmget = iuu_tiocmget,
1197 	.tiocmset = iuu_tiocmset,
1198 	.set_termios = iuu_set_termios,
1199 	.init_termios = iuu_init_termios,
1200 	.attach = iuu_startup,
1201 	.release = iuu_release,
1202 };
1203 
1204 static int __init iuu_init(void)
1205 {
1206 	int retval;
1207 	retval = usb_serial_register(&iuu_device);
1208 	if (retval)
1209 		goto failed_usb_serial_register;
1210 	retval = usb_register(&iuu_driver);
1211 	if (retval)
1212 		goto failed_usb_register;
1213 	printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1214 	       DRIVER_DESC "\n");
1215 	return 0;
1216 failed_usb_register:
1217 	usb_serial_deregister(&iuu_device);
1218 failed_usb_serial_register:
1219 	return retval;
1220 }
1221 
1222 static void __exit iuu_exit(void)
1223 {
1224 	usb_deregister(&iuu_driver);
1225 	usb_serial_deregister(&iuu_device);
1226 }
1227 
1228 module_init(iuu_init);
1229 module_exit(iuu_exit);
1230 
1231 MODULE_AUTHOR("Alain Degreffe eczema@ecze.com");
1232 
1233 MODULE_DESCRIPTION(DRIVER_DESC);
1234 MODULE_LICENSE("GPL");
1235 
1236 MODULE_VERSION(DRIVER_VERSION);
1237 module_param(debug, bool, S_IRUGO | S_IWUSR);
1238 MODULE_PARM_DESC(debug, "Debug enabled or not");
1239 
1240 module_param(xmas, bool, S_IRUGO | S_IWUSR);
1241 MODULE_PARM_DESC(xmas, "xmas color enabled or not");
1242 
1243 module_param(boost, int, S_IRUGO | S_IWUSR);
1244 MODULE_PARM_DESC(boost, "overclock boost percent 100 to 500");
1245 
1246 module_param(clockmode, int, S_IRUGO | S_IWUSR);
1247 MODULE_PARM_DESC(clockmode, "1=3Mhz579,2=3Mhz680,3=6Mhz");
1248 
1249 module_param(cdmode, int, S_IRUGO | S_IWUSR);
1250 MODULE_PARM_DESC(cdmode, "Card detect mode 0=none, 1=CD, 2=!CD, 3=DSR, "
1251 		 "4=!DSR, 5=CTS, 6=!CTS, 7=RING, 8=!RING");
1252