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