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