include: replace linux/module.h with "struct module" wherever possible
[linux-2.6/next.git] / drivers / usb / serial / iuu_phoenix.c
blob6aca631a407aa0891492b12c05259e4618ad333e
1 /*
2 * Infinity Unlimited USB Phoenix driver
4 * Copyright (C) 2010 James Courtier-Dutton (James@superbug.co.uk)
6 * Copyright (C) 2007 Alain Degreffe (eczema@ecze.com)
8 * Original code taken from iuutool (Copyright (C) 2006 Juan Carlos Borrás)
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.
15 * And tested with help of WB Electronics
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>
36 #ifdef CONFIG_USB_SERIAL_DEBUG
37 static int debug = 1;
38 #else
39 static int debug;
40 #endif
43 * Version Information
45 #define DRIVER_VERSION "v0.12"
46 #define DRIVER_DESC "Infinity USB Unlimited Phoenix driver"
48 static const struct usb_device_id id_table[] = {
49 {USB_DEVICE(IUU_USB_VENDOR_ID, IUU_USB_PRODUCT_ID)},
50 {} /* Terminating entry */
52 MODULE_DEVICE_TABLE(usb, id_table);
54 static struct usb_driver iuu_driver = {
55 .name = "iuu_phoenix",
56 .probe = usb_serial_probe,
57 .disconnect = usb_serial_disconnect,
58 .id_table = id_table,
59 .no_dynamic_id = 1,
62 /* turbo parameter */
63 static int boost = 100;
64 static int clockmode = 1;
65 static int cdmode = 1;
66 static int iuu_cardin;
67 static int iuu_cardout;
68 static int xmas;
69 static int vcc_default = 5;
71 static void read_rxcmd_callback(struct urb *urb);
73 struct iuu_private {
74 spinlock_t lock; /* store irq state */
75 wait_queue_head_t delta_msr_wait;
76 u8 line_status;
77 int tiostatus; /* store IUART SIGNAL for tiocmget call */
78 u8 reset; /* if 1 reset is needed */
79 int poll; /* number of poll */
80 u8 *writebuf; /* buffer for writing to device */
81 int writelen; /* num of byte to write to device */
82 u8 *buf; /* used for initialize speed */
83 u8 *dbgbuf; /* debug buffer */
84 u8 len;
85 int vcc; /* vcc (either 3 or 5 V) */
86 u32 baud;
87 u32 boost;
88 u32 clk;
92 static void iuu_free_buf(struct iuu_private *priv)
94 kfree(priv->buf);
95 kfree(priv->dbgbuf);
96 kfree(priv->writebuf);
99 static int iuu_alloc_buf(struct iuu_private *priv)
101 priv->buf = kzalloc(256, GFP_KERNEL);
102 priv->dbgbuf = kzalloc(256, GFP_KERNEL);
103 priv->writebuf = kzalloc(256, GFP_KERNEL);
104 if (!priv->buf || !priv->dbgbuf || !priv->writebuf) {
105 iuu_free_buf(priv);
106 dbg("%s problem allocation buffer", __func__);
107 return -ENOMEM;
109 dbg("%s - Privates buffers allocation success", __func__);
110 return 0;
113 static int iuu_startup(struct usb_serial *serial)
115 struct iuu_private *priv;
116 priv = kzalloc(sizeof(struct iuu_private), GFP_KERNEL);
117 dbg("%s- priv allocation success", __func__);
118 if (!priv)
119 return -ENOMEM;
120 if (iuu_alloc_buf(priv)) {
121 kfree(priv);
122 return -ENOMEM;
124 priv->vcc = vcc_default;
125 spin_lock_init(&priv->lock);
126 init_waitqueue_head(&priv->delta_msr_wait);
127 usb_set_serial_port_data(serial->port[0], priv);
128 return 0;
131 /* Release function */
132 static void iuu_release(struct usb_serial *serial)
134 struct usb_serial_port *port = serial->port[0];
135 struct iuu_private *priv = usb_get_serial_port_data(port);
136 if (!port)
137 return;
139 dbg("%s", __func__);
141 if (priv) {
142 iuu_free_buf(priv);
143 dbg("%s - I will free all", __func__);
144 usb_set_serial_port_data(port, NULL);
146 dbg("%s - priv is not anymore in port structure", __func__);
147 kfree(priv);
149 dbg("%s priv is now kfree", __func__);
153 static int iuu_tiocmset(struct tty_struct *tty,
154 unsigned int set, unsigned int clear)
156 struct usb_serial_port *port = tty->driver_data;
157 struct iuu_private *priv = usb_get_serial_port_data(port);
158 unsigned long flags;
160 /* FIXME: locking on tiomstatus */
161 dbg("%s (%d) msg : SET = 0x%04x, CLEAR = 0x%04x ", __func__,
162 port->number, set, clear);
164 spin_lock_irqsave(&priv->lock, flags);
166 if ((set & TIOCM_RTS) && !(priv->tiostatus == TIOCM_RTS)) {
167 dbg("%s TIOCMSET RESET called !!!", __func__);
168 priv->reset = 1;
170 if (set & TIOCM_RTS)
171 priv->tiostatus = TIOCM_RTS;
173 spin_unlock_irqrestore(&priv->lock, flags);
174 return 0;
177 /* This is used to provide a carrier detect mechanism
178 * When a card is present, the response is 0x00
179 * When no card , the reader respond with TIOCM_CD
180 * This is known as CD autodetect mechanism
182 static int iuu_tiocmget(struct tty_struct *tty)
184 struct usb_serial_port *port = tty->driver_data;
185 struct iuu_private *priv = usb_get_serial_port_data(port);
186 unsigned long flags;
187 int rc;
189 spin_lock_irqsave(&priv->lock, flags);
190 rc = priv->tiostatus;
191 spin_unlock_irqrestore(&priv->lock, flags);
193 return rc;
196 static void iuu_rxcmd(struct urb *urb)
198 struct usb_serial_port *port = urb->context;
199 int result;
200 int status = urb->status;
202 dbg("%s - enter", __func__);
204 if (status) {
205 dbg("%s - status = %d", __func__, status);
206 /* error stop all */
207 return;
211 memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
212 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
213 usb_sndbulkpipe(port->serial->dev,
214 port->bulk_out_endpointAddress),
215 port->write_urb->transfer_buffer, 1,
216 read_rxcmd_callback, port);
217 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
220 static int iuu_reset(struct usb_serial_port *port, u8 wt)
222 struct iuu_private *priv = usb_get_serial_port_data(port);
223 int result;
224 char *buf_ptr = port->write_urb->transfer_buffer;
225 dbg("%s - enter", __func__);
227 /* Prepare the reset sequence */
229 *buf_ptr++ = IUU_RST_SET;
230 *buf_ptr++ = IUU_DELAY_MS;
231 *buf_ptr++ = wt;
232 *buf_ptr = IUU_RST_CLEAR;
234 /* send the sequence */
236 usb_fill_bulk_urb(port->write_urb,
237 port->serial->dev,
238 usb_sndbulkpipe(port->serial->dev,
239 port->bulk_out_endpointAddress),
240 port->write_urb->transfer_buffer, 4, iuu_rxcmd, port);
241 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
242 priv->reset = 0;
243 return result;
246 /* Status Function
247 * Return value is
248 * 0x00 = no card
249 * 0x01 = smartcard
250 * 0x02 = sim card
252 static void iuu_update_status_callback(struct urb *urb)
254 struct usb_serial_port *port = urb->context;
255 struct iuu_private *priv = usb_get_serial_port_data(port);
256 u8 *st;
257 int status = urb->status;
259 dbg("%s - enter", __func__);
261 if (status) {
262 dbg("%s - status = %d", __func__, status);
263 /* error stop all */
264 return;
267 st = urb->transfer_buffer;
268 dbg("%s - enter", __func__);
269 if (urb->actual_length == 1) {
270 switch (st[0]) {
271 case 0x1:
272 priv->tiostatus = iuu_cardout;
273 break;
274 case 0x0:
275 priv->tiostatus = iuu_cardin;
276 break;
277 default:
278 priv->tiostatus = iuu_cardin;
281 iuu_rxcmd(urb);
284 static void iuu_status_callback(struct urb *urb)
286 struct usb_serial_port *port = urb->context;
287 int result;
288 int status = urb->status;
290 dbg("%s - status = %d", __func__, status);
291 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
292 usb_rcvbulkpipe(port->serial->dev,
293 port->bulk_in_endpointAddress),
294 port->read_urb->transfer_buffer, 256,
295 iuu_update_status_callback, port);
296 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
299 static int iuu_status(struct usb_serial_port *port)
301 int result;
303 dbg("%s - enter", __func__);
305 memset(port->write_urb->transfer_buffer, IUU_GET_STATE_REGISTER, 1);
306 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
307 usb_sndbulkpipe(port->serial->dev,
308 port->bulk_out_endpointAddress),
309 port->write_urb->transfer_buffer, 1,
310 iuu_status_callback, port);
311 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
312 return result;
316 static int bulk_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
318 int status;
319 struct usb_serial *serial = port->serial;
320 int actual = 0;
322 dbg("%s - enter", __func__);
324 /* send the data out the bulk port */
326 status =
327 usb_bulk_msg(serial->dev,
328 usb_sndbulkpipe(serial->dev,
329 port->bulk_out_endpointAddress), buf,
330 count, &actual, HZ * 1);
332 if (status != IUU_OPERATION_OK)
333 dbg("%s - error = %2x", __func__, status);
334 else
335 dbg("%s - write OK !", __func__);
336 return status;
339 static int read_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
341 int status;
342 struct usb_serial *serial = port->serial;
343 int actual = 0;
345 dbg("%s - enter", __func__);
347 /* send the data out the bulk port */
349 status =
350 usb_bulk_msg(serial->dev,
351 usb_rcvbulkpipe(serial->dev,
352 port->bulk_in_endpointAddress), buf,
353 count, &actual, HZ * 1);
355 if (status != IUU_OPERATION_OK)
356 dbg("%s - error = %2x", __func__, status);
357 else
358 dbg("%s - read OK !", __func__);
359 return status;
362 static int iuu_led(struct usb_serial_port *port, unsigned int R,
363 unsigned int G, unsigned int B, u8 f)
365 int status;
366 u8 *buf;
367 buf = kmalloc(8, GFP_KERNEL);
368 if (!buf)
369 return -ENOMEM;
371 dbg("%s - enter", __func__);
373 buf[0] = IUU_SET_LED;
374 buf[1] = R & 0xFF;
375 buf[2] = (R >> 8) & 0xFF;
376 buf[3] = G & 0xFF;
377 buf[4] = (G >> 8) & 0xFF;
378 buf[5] = B & 0xFF;
379 buf[6] = (B >> 8) & 0xFF;
380 buf[7] = f;
381 status = bulk_immediate(port, buf, 8);
382 kfree(buf);
383 if (status != IUU_OPERATION_OK)
384 dbg("%s - led error status = %2x", __func__, status);
385 else
386 dbg("%s - led OK !", __func__);
387 return IUU_OPERATION_OK;
390 static void iuu_rgbf_fill_buffer(u8 *buf, u8 r1, u8 r2, u8 g1, u8 g2, u8 b1,
391 u8 b2, u8 freq)
393 *buf++ = IUU_SET_LED;
394 *buf++ = r1;
395 *buf++ = r2;
396 *buf++ = g1;
397 *buf++ = g2;
398 *buf++ = b1;
399 *buf++ = b2;
400 *buf = freq;
403 static void iuu_led_activity_on(struct urb *urb)
405 struct usb_serial_port *port = urb->context;
406 int result;
407 char *buf_ptr = port->write_urb->transfer_buffer;
408 *buf_ptr++ = IUU_SET_LED;
409 if (xmas == 1) {
410 get_random_bytes(buf_ptr, 6);
411 *(buf_ptr+7) = 1;
412 } else {
413 iuu_rgbf_fill_buffer(buf_ptr, 255, 255, 0, 0, 0, 0, 255);
416 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
417 usb_sndbulkpipe(port->serial->dev,
418 port->bulk_out_endpointAddress),
419 port->write_urb->transfer_buffer, 8 ,
420 iuu_rxcmd, port);
421 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
424 static void iuu_led_activity_off(struct urb *urb)
426 struct usb_serial_port *port = urb->context;
427 int result;
428 char *buf_ptr = port->write_urb->transfer_buffer;
429 if (xmas == 1) {
430 iuu_rxcmd(urb);
431 return;
432 } else {
433 *buf_ptr++ = IUU_SET_LED;
434 iuu_rgbf_fill_buffer(buf_ptr, 0, 0, 255, 255, 0, 0, 255);
436 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
437 usb_sndbulkpipe(port->serial->dev,
438 port->bulk_out_endpointAddress),
439 port->write_urb->transfer_buffer, 8 ,
440 iuu_rxcmd, port);
441 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
446 static int iuu_clk(struct usb_serial_port *port, int dwFrq)
448 int status;
449 struct iuu_private *priv = usb_get_serial_port_data(port);
450 int Count = 0;
451 u8 FrqGenAdr = 0x69;
452 u8 DIV = 0; /* 8bit */
453 u8 XDRV = 0; /* 8bit */
454 u8 PUMP = 0; /* 3bit */
455 u8 PBmsb = 0; /* 2bit */
456 u8 PBlsb = 0; /* 8bit */
457 u8 PO = 0; /* 1bit */
458 u8 Q = 0; /* 7bit */
459 /* 24bit = 3bytes */
460 unsigned int P = 0;
461 unsigned int P2 = 0;
462 int frq = (int)dwFrq;
464 dbg("%s - enter", __func__);
466 if (frq == 0) {
467 priv->buf[Count++] = IUU_UART_WRITE_I2C;
468 priv->buf[Count++] = FrqGenAdr << 1;
469 priv->buf[Count++] = 0x09;
470 priv->buf[Count++] = 0x00;
472 status = bulk_immediate(port, (u8 *) priv->buf, Count);
473 if (status != 0) {
474 dbg("%s - write error ", __func__);
475 return status;
477 } else if (frq == 3579000) {
478 DIV = 100;
479 P = 1193;
480 Q = 40;
481 XDRV = 0;
482 } else if (frq == 3680000) {
483 DIV = 105;
484 P = 161;
485 Q = 5;
486 XDRV = 0;
487 } else if (frq == 6000000) {
488 DIV = 66;
489 P = 66;
490 Q = 2;
491 XDRV = 0x28;
492 } else {
493 unsigned int result = 0;
494 unsigned int tmp = 0;
495 unsigned int check;
496 unsigned int check2;
497 char found = 0x00;
498 unsigned int lQ = 2;
499 unsigned int lP = 2055;
500 unsigned int lDiv = 4;
502 for (lQ = 2; lQ <= 47 && !found; lQ++)
503 for (lP = 2055; lP >= 8 && !found; lP--)
504 for (lDiv = 4; lDiv <= 127 && !found; lDiv++) {
505 tmp = (12000000 / lDiv) * (lP / lQ);
506 if (abs((int)(tmp - frq)) <
507 abs((int)(frq - result))) {
508 check2 = (12000000 / lQ);
509 if (check2 < 250000)
510 continue;
511 check = (12000000 / lQ) * lP;
512 if (check > 400000000)
513 continue;
514 if (check < 100000000)
515 continue;
516 if (lDiv < 4 || lDiv > 127)
517 continue;
518 result = tmp;
519 P = lP;
520 DIV = lDiv;
521 Q = lQ;
522 if (result == frq)
523 found = 0x01;
527 P2 = ((P - PO) / 2) - 4;
528 DIV = DIV;
529 PUMP = 0x04;
530 PBmsb = (P2 >> 8 & 0x03);
531 PBlsb = P2 & 0xFF;
532 PO = (P >> 10) & 0x01;
533 Q = Q - 2;
535 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
536 priv->buf[Count++] = FrqGenAdr << 1;
537 priv->buf[Count++] = 0x09;
538 priv->buf[Count++] = 0x20; /* Adr = 0x09 */
539 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
540 priv->buf[Count++] = FrqGenAdr << 1;
541 priv->buf[Count++] = 0x0C;
542 priv->buf[Count++] = DIV; /* Adr = 0x0C */
543 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
544 priv->buf[Count++] = FrqGenAdr << 1;
545 priv->buf[Count++] = 0x12;
546 priv->buf[Count++] = XDRV; /* Adr = 0x12 */
547 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
548 priv->buf[Count++] = FrqGenAdr << 1;
549 priv->buf[Count++] = 0x13;
550 priv->buf[Count++] = 0x6B; /* Adr = 0x13 */
551 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
552 priv->buf[Count++] = FrqGenAdr << 1;
553 priv->buf[Count++] = 0x40;
554 priv->buf[Count++] = (0xC0 | ((PUMP & 0x07) << 2)) |
555 (PBmsb & 0x03); /* Adr = 0x40 */
556 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
557 priv->buf[Count++] = FrqGenAdr << 1;
558 priv->buf[Count++] = 0x41;
559 priv->buf[Count++] = PBlsb; /* Adr = 0x41 */
560 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
561 priv->buf[Count++] = FrqGenAdr << 1;
562 priv->buf[Count++] = 0x42;
563 priv->buf[Count++] = Q | (((PO & 0x01) << 7)); /* Adr = 0x42 */
564 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
565 priv->buf[Count++] = FrqGenAdr << 1;
566 priv->buf[Count++] = 0x44;
567 priv->buf[Count++] = (char)0xFF; /* Adr = 0x44 */
568 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
569 priv->buf[Count++] = FrqGenAdr << 1;
570 priv->buf[Count++] = 0x45;
571 priv->buf[Count++] = (char)0xFE; /* Adr = 0x45 */
572 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
573 priv->buf[Count++] = FrqGenAdr << 1;
574 priv->buf[Count++] = 0x46;
575 priv->buf[Count++] = 0x7F; /* Adr = 0x46 */
576 priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
577 priv->buf[Count++] = FrqGenAdr << 1;
578 priv->buf[Count++] = 0x47;
579 priv->buf[Count++] = (char)0x84; /* Adr = 0x47 */
581 status = bulk_immediate(port, (u8 *) priv->buf, Count);
582 if (status != IUU_OPERATION_OK)
583 dbg("%s - write error ", __func__);
584 return status;
587 static int iuu_uart_flush(struct usb_serial_port *port)
589 int i;
590 int status;
591 u8 rxcmd = IUU_UART_RX;
592 struct iuu_private *priv = usb_get_serial_port_data(port);
594 dbg("%s - enter", __func__);
596 if (iuu_led(port, 0xF000, 0, 0, 0xFF) < 0)
597 return -EIO;
599 for (i = 0; i < 2; i++) {
600 status = bulk_immediate(port, &rxcmd, 1);
601 if (status != IUU_OPERATION_OK) {
602 dbg("%s - uart_flush_write error", __func__);
603 return status;
606 status = read_immediate(port, &priv->len, 1);
607 if (status != IUU_OPERATION_OK) {
608 dbg("%s - uart_flush_read error", __func__);
609 return status;
612 if (priv->len > 0) {
613 dbg("%s - uart_flush datalen is : %i ", __func__,
614 priv->len);
615 status = read_immediate(port, priv->buf, priv->len);
616 if (status != IUU_OPERATION_OK) {
617 dbg("%s - uart_flush_read error", __func__);
618 return status;
622 dbg("%s - uart_flush_read OK!", __func__);
623 iuu_led(port, 0, 0xF000, 0, 0xFF);
624 return status;
627 static void read_buf_callback(struct urb *urb)
629 struct usb_serial_port *port = urb->context;
630 unsigned char *data = urb->transfer_buffer;
631 struct tty_struct *tty;
632 int status = urb->status;
634 dbg("%s - status = %d", __func__, status);
636 if (status) {
637 if (status == -EPROTO) {
638 /* reschedule needed */
640 return;
643 dbg("%s - %i chars to write", __func__, urb->actual_length);
644 tty = tty_port_tty_get(&port->port);
645 if (data == NULL)
646 dbg("%s - data is NULL !!!", __func__);
647 if (tty && urb->actual_length && data) {
648 tty_insert_flip_string(tty, data, urb->actual_length);
649 tty_flip_buffer_push(tty);
651 tty_kref_put(tty);
652 iuu_led_activity_on(urb);
655 static int iuu_bulk_write(struct usb_serial_port *port)
657 struct iuu_private *priv = usb_get_serial_port_data(port);
658 unsigned long flags;
659 int result;
660 int i;
661 int buf_len;
662 char *buf_ptr = port->write_urb->transfer_buffer;
663 dbg("%s - enter", __func__);
665 spin_lock_irqsave(&priv->lock, flags);
666 *buf_ptr++ = IUU_UART_ESC;
667 *buf_ptr++ = IUU_UART_TX;
668 *buf_ptr++ = priv->writelen;
670 memcpy(buf_ptr, priv->writebuf, priv->writelen);
671 buf_len = priv->writelen;
672 priv->writelen = 0;
673 spin_unlock_irqrestore(&priv->lock, flags);
674 if (debug == 1) {
675 for (i = 0; i < buf_len; i++)
676 sprintf(priv->dbgbuf + i*2 ,
677 "%02X", priv->writebuf[i]);
678 priv->dbgbuf[buf_len+i*2] = 0;
679 dbg("%s - writing %i chars : %s", __func__,
680 buf_len, priv->dbgbuf);
682 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
683 usb_sndbulkpipe(port->serial->dev,
684 port->bulk_out_endpointAddress),
685 port->write_urb->transfer_buffer, buf_len + 3,
686 iuu_rxcmd, port);
687 result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
688 usb_serial_port_softint(port);
689 return result;
692 static int iuu_read_buf(struct usb_serial_port *port, int len)
694 int result;
695 dbg("%s - enter", __func__);
697 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
698 usb_rcvbulkpipe(port->serial->dev,
699 port->bulk_in_endpointAddress),
700 port->read_urb->transfer_buffer, len,
701 read_buf_callback, port);
702 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
703 return result;
706 static void iuu_uart_read_callback(struct urb *urb)
708 struct usb_serial_port *port = urb->context;
709 struct iuu_private *priv = usb_get_serial_port_data(port);
710 unsigned long flags;
711 int status = urb->status;
712 int error = 0;
713 int len = 0;
714 unsigned char *data = urb->transfer_buffer;
715 priv->poll++;
717 dbg("%s - enter", __func__);
719 if (status) {
720 dbg("%s - status = %d", __func__, status);
721 /* error stop all */
722 return;
724 if (data == NULL)
725 dbg("%s - data is NULL !!!", __func__);
727 if (urb->actual_length == 1 && data != NULL)
728 len = (int) data[0];
730 if (urb->actual_length > 1) {
731 dbg("%s - urb->actual_length = %i", __func__,
732 urb->actual_length);
733 error = 1;
734 return;
736 /* if len > 0 call readbuf */
738 if (len > 0 && error == 0) {
739 dbg("%s - call read buf - len to read is %i ",
740 __func__, len);
741 status = iuu_read_buf(port, len);
742 return;
744 /* need to update status ? */
745 if (priv->poll > 99) {
746 status = iuu_status(port);
747 priv->poll = 0;
748 return;
751 /* reset waiting ? */
753 if (priv->reset == 1) {
754 status = iuu_reset(port, 0xC);
755 return;
757 /* Writebuf is waiting */
758 spin_lock_irqsave(&priv->lock, flags);
759 if (priv->writelen > 0) {
760 spin_unlock_irqrestore(&priv->lock, flags);
761 status = iuu_bulk_write(port);
762 return;
764 spin_unlock_irqrestore(&priv->lock, flags);
765 /* if nothing to write call again rxcmd */
766 dbg("%s - rxcmd recall", __func__);
767 iuu_led_activity_off(urb);
770 static int iuu_uart_write(struct tty_struct *tty, struct usb_serial_port *port,
771 const u8 *buf, int count)
773 struct iuu_private *priv = usb_get_serial_port_data(port);
774 unsigned long flags;
775 dbg("%s - enter", __func__);
777 if (count > 256)
778 return -ENOMEM;
780 spin_lock_irqsave(&priv->lock, flags);
782 /* fill the buffer */
783 memcpy(priv->writebuf + priv->writelen, buf, count);
784 priv->writelen += count;
785 spin_unlock_irqrestore(&priv->lock, flags);
787 return count;
790 static void read_rxcmd_callback(struct urb *urb)
792 struct usb_serial_port *port = urb->context;
793 int result;
794 int status = urb->status;
796 dbg("%s - status = %d", __func__, status);
798 if (status) {
799 /* error stop all */
800 return;
803 usb_fill_bulk_urb(port->read_urb, port->serial->dev,
804 usb_rcvbulkpipe(port->serial->dev,
805 port->bulk_in_endpointAddress),
806 port->read_urb->transfer_buffer, 256,
807 iuu_uart_read_callback, port);
808 result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
809 dbg("%s - submit result = %d", __func__, result);
812 static int iuu_uart_on(struct usb_serial_port *port)
814 int status;
815 u8 *buf;
817 buf = kmalloc(sizeof(u8) * 4, GFP_KERNEL);
819 if (!buf)
820 return -ENOMEM;
822 buf[0] = IUU_UART_ENABLE;
823 buf[1] = (u8) ((IUU_BAUD_9600 >> 8) & 0x00FF);
824 buf[2] = (u8) (0x00FF & IUU_BAUD_9600);
825 buf[3] = (u8) (0x0F0 & IUU_ONE_STOP_BIT) | (0x07 & IUU_PARITY_EVEN);
827 status = bulk_immediate(port, buf, 4);
828 if (status != IUU_OPERATION_OK) {
829 dbg("%s - uart_on error", __func__);
830 goto uart_enable_failed;
832 /* iuu_reset() the card after iuu_uart_on() */
833 status = iuu_uart_flush(port);
834 if (status != IUU_OPERATION_OK)
835 dbg("%s - uart_flush error", __func__);
836 uart_enable_failed:
837 kfree(buf);
838 return status;
841 /* Diables the IUU UART (a.k.a. the Phoenix voiderface) */
842 static int iuu_uart_off(struct usb_serial_port *port)
844 int status;
845 u8 *buf;
846 buf = kmalloc(1, GFP_KERNEL);
847 if (!buf)
848 return -ENOMEM;
849 buf[0] = IUU_UART_DISABLE;
851 status = bulk_immediate(port, buf, 1);
852 if (status != IUU_OPERATION_OK)
853 dbg("%s - uart_off error", __func__);
855 kfree(buf);
856 return status;
859 static int iuu_uart_baud(struct usb_serial_port *port, u32 baud_base,
860 u32 *actual, u8 parity)
862 int status;
863 u32 baud;
864 u8 *dataout;
865 u8 DataCount = 0;
866 u8 T1Frekvens = 0;
867 u8 T1reload = 0;
868 unsigned int T1FrekvensHZ = 0;
870 dbg("%s - enter baud_base=%d", __func__, baud_base);
871 dataout = kmalloc(sizeof(u8) * 5, GFP_KERNEL);
873 if (!dataout)
874 return -ENOMEM;
875 /*baud = (((priv->clk / 35) * baud_base) / 100000); */
876 baud = baud_base;
878 if (baud < 1200 || baud > 230400) {
879 kfree(dataout);
880 return IUU_INVALID_PARAMETER;
882 if (baud > 977) {
883 T1Frekvens = 3;
884 T1FrekvensHZ = 500000;
887 if (baud > 3906) {
888 T1Frekvens = 2;
889 T1FrekvensHZ = 2000000;
892 if (baud > 11718) {
893 T1Frekvens = 1;
894 T1FrekvensHZ = 6000000;
897 if (baud > 46875) {
898 T1Frekvens = 0;
899 T1FrekvensHZ = 24000000;
902 T1reload = 256 - (u8) (T1FrekvensHZ / (baud * 2));
904 /* magic number here: ENTER_FIRMWARE_UPDATE; */
905 dataout[DataCount++] = IUU_UART_ESC;
906 /* magic number here: CHANGE_BAUD; */
907 dataout[DataCount++] = IUU_UART_CHANGE;
908 dataout[DataCount++] = T1Frekvens;
909 dataout[DataCount++] = T1reload;
911 *actual = (T1FrekvensHZ / (256 - T1reload)) / 2;
913 switch (parity & 0x0F) {
914 case IUU_PARITY_NONE:
915 dataout[DataCount++] = 0x00;
916 break;
917 case IUU_PARITY_EVEN:
918 dataout[DataCount++] = 0x01;
919 break;
920 case IUU_PARITY_ODD:
921 dataout[DataCount++] = 0x02;
922 break;
923 case IUU_PARITY_MARK:
924 dataout[DataCount++] = 0x03;
925 break;
926 case IUU_PARITY_SPACE:
927 dataout[DataCount++] = 0x04;
928 break;
929 default:
930 kfree(dataout);
931 return IUU_INVALID_PARAMETER;
932 break;
935 switch (parity & 0xF0) {
936 case IUU_ONE_STOP_BIT:
937 dataout[DataCount - 1] |= IUU_ONE_STOP_BIT;
938 break;
940 case IUU_TWO_STOP_BITS:
941 dataout[DataCount - 1] |= IUU_TWO_STOP_BITS;
942 break;
943 default:
944 kfree(dataout);
945 return IUU_INVALID_PARAMETER;
946 break;
949 status = bulk_immediate(port, dataout, DataCount);
950 if (status != IUU_OPERATION_OK)
951 dbg("%s - uart_off error", __func__);
952 kfree(dataout);
953 return status;
956 static void iuu_set_termios(struct tty_struct *tty,
957 struct usb_serial_port *port, struct ktermios *old_termios)
959 const u32 supported_mask = CMSPAR|PARENB|PARODD;
960 struct iuu_private *priv = usb_get_serial_port_data(port);
961 unsigned int cflag = tty->termios->c_cflag;
962 int status;
963 u32 actual;
964 u32 parity;
965 int csize = CS7;
966 int baud;
967 u32 newval = cflag & supported_mask;
969 /* Just use the ospeed. ispeed should be the same. */
970 baud = tty->termios->c_ospeed;
972 dbg("%s - enter c_ospeed or baud=%d", __func__, baud);
974 /* compute the parity parameter */
975 parity = 0;
976 if (cflag & CMSPAR) { /* Using mark space */
977 if (cflag & PARODD)
978 parity |= IUU_PARITY_SPACE;
979 else
980 parity |= IUU_PARITY_MARK;
981 } else if (!(cflag & PARENB)) {
982 parity |= IUU_PARITY_NONE;
983 csize = CS8;
984 } else if (cflag & PARODD)
985 parity |= IUU_PARITY_ODD;
986 else
987 parity |= IUU_PARITY_EVEN;
989 parity |= (cflag & CSTOPB ? IUU_TWO_STOP_BITS : IUU_ONE_STOP_BIT);
991 /* set it */
992 status = iuu_uart_baud(port,
993 baud * priv->boost / 100,
994 &actual, parity);
996 /* set the termios value to the real one, so the user now what has
997 * changed. We support few fields so its easies to copy the old hw
998 * settings back over and then adjust them
1000 if (old_termios)
1001 tty_termios_copy_hw(tty->termios, old_termios);
1002 if (status != 0) /* Set failed - return old bits */
1003 return;
1004 /* Re-encode speed, parity and csize */
1005 tty_encode_baud_rate(tty, baud, baud);
1006 tty->termios->c_cflag &= ~(supported_mask|CSIZE);
1007 tty->termios->c_cflag |= newval | csize;
1010 static void iuu_close(struct usb_serial_port *port)
1012 /* iuu_led (port,255,0,0,0); */
1013 struct usb_serial *serial;
1015 serial = port->serial;
1016 if (!serial)
1017 return;
1019 dbg("%s - port %d", __func__, port->number);
1021 iuu_uart_off(port);
1022 if (serial->dev) {
1023 /* free writebuf */
1024 /* shutdown our urbs */
1025 dbg("%s - shutting down urbs", __func__);
1026 usb_kill_urb(port->write_urb);
1027 usb_kill_urb(port->read_urb);
1028 usb_kill_urb(port->interrupt_in_urb);
1029 iuu_led(port, 0, 0, 0xF000, 0xFF);
1033 static void iuu_init_termios(struct tty_struct *tty)
1035 dbg("%s - enter", __func__);
1036 *(tty->termios) = tty_std_termios;
1037 tty->termios->c_cflag = CLOCAL | CREAD | CS8 | B9600
1038 | TIOCM_CTS | CSTOPB | PARENB;
1039 tty->termios->c_ispeed = 9600;
1040 tty->termios->c_ospeed = 9600;
1041 tty->termios->c_lflag = 0;
1042 tty->termios->c_oflag = 0;
1043 tty->termios->c_iflag = 0;
1046 static int iuu_open(struct tty_struct *tty, struct usb_serial_port *port)
1048 struct usb_serial *serial = port->serial;
1049 u8 *buf;
1050 int result;
1051 int baud;
1052 u32 actual;
1053 struct iuu_private *priv = usb_get_serial_port_data(port);
1055 baud = tty->termios->c_ospeed;
1056 tty->termios->c_ispeed = baud;
1057 /* Re-encode speed */
1058 tty_encode_baud_rate(tty, baud, baud);
1060 dbg("%s - port %d, baud %d", __func__, port->number, baud);
1061 usb_clear_halt(serial->dev, port->write_urb->pipe);
1062 usb_clear_halt(serial->dev, port->read_urb->pipe);
1064 buf = kmalloc(10, GFP_KERNEL);
1065 if (buf == NULL)
1066 return -ENOMEM;
1068 priv->poll = 0;
1070 /* initialize writebuf */
1071 #define FISH(a, b, c, d) do { \
1072 result = usb_control_msg(port->serial->dev, \
1073 usb_rcvctrlpipe(port->serial->dev, 0), \
1074 b, a, c, d, buf, 1, 1000); \
1075 dbg("0x%x:0x%x:0x%x:0x%x %d - %x", a, b, c, d, result, \
1076 buf[0]); } while (0);
1078 #define SOUP(a, b, c, d) do { \
1079 result = usb_control_msg(port->serial->dev, \
1080 usb_sndctrlpipe(port->serial->dev, 0), \
1081 b, a, c, d, NULL, 0, 1000); \
1082 dbg("0x%x:0x%x:0x%x:0x%x %d", a, b, c, d, result); } while (0)
1084 /* This is not UART related but IUU USB driver related or something */
1085 /* like that. Basically no IUU will accept any commands from the USB */
1086 /* host unless it has received the following message */
1087 /* sprintf(buf ,"%c%c%c%c",0x03,0x02,0x02,0x0); */
1089 SOUP(0x03, 0x02, 0x02, 0x0);
1090 kfree(buf);
1091 iuu_led(port, 0xF000, 0xF000, 0, 0xFF);
1092 iuu_uart_on(port);
1093 if (boost < 100)
1094 boost = 100;
1095 priv->boost = boost;
1096 priv->baud = baud;
1097 switch (clockmode) {
1098 case 2: /* 3.680 Mhz */
1099 priv->clk = IUU_CLK_3680000;
1100 iuu_clk(port, IUU_CLK_3680000 * boost / 100);
1101 result =
1102 iuu_uart_baud(port, baud * boost / 100, &actual,
1103 IUU_PARITY_EVEN);
1104 break;
1105 case 3: /* 6.00 Mhz */
1106 iuu_clk(port, IUU_CLK_6000000 * boost / 100);
1107 priv->clk = IUU_CLK_6000000;
1108 /* Ratio of 6000000 to 3500000 for baud 9600 */
1109 result =
1110 iuu_uart_baud(port, 16457 * boost / 100, &actual,
1111 IUU_PARITY_EVEN);
1112 break;
1113 default: /* 3.579 Mhz */
1114 iuu_clk(port, IUU_CLK_3579000 * boost / 100);
1115 priv->clk = IUU_CLK_3579000;
1116 result =
1117 iuu_uart_baud(port, baud * boost / 100, &actual,
1118 IUU_PARITY_EVEN);
1121 /* set the cardin cardout signals */
1122 switch (cdmode) {
1123 case 0:
1124 iuu_cardin = 0;
1125 iuu_cardout = 0;
1126 break;
1127 case 1:
1128 iuu_cardin = TIOCM_CD;
1129 iuu_cardout = 0;
1130 break;
1131 case 2:
1132 iuu_cardin = 0;
1133 iuu_cardout = TIOCM_CD;
1134 break;
1135 case 3:
1136 iuu_cardin = TIOCM_DSR;
1137 iuu_cardout = 0;
1138 break;
1139 case 4:
1140 iuu_cardin = 0;
1141 iuu_cardout = TIOCM_DSR;
1142 break;
1143 case 5:
1144 iuu_cardin = TIOCM_CTS;
1145 iuu_cardout = 0;
1146 break;
1147 case 6:
1148 iuu_cardin = 0;
1149 iuu_cardout = TIOCM_CTS;
1150 break;
1151 case 7:
1152 iuu_cardin = TIOCM_RNG;
1153 iuu_cardout = 0;
1154 break;
1155 case 8:
1156 iuu_cardin = 0;
1157 iuu_cardout = TIOCM_RNG;
1160 iuu_uart_flush(port);
1162 dbg("%s - initialization done", __func__);
1164 memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
1165 usb_fill_bulk_urb(port->write_urb, port->serial->dev,
1166 usb_sndbulkpipe(port->serial->dev,
1167 port->bulk_out_endpointAddress),
1168 port->write_urb->transfer_buffer, 1,
1169 read_rxcmd_callback, port);
1170 result = usb_submit_urb(port->write_urb, GFP_KERNEL);
1172 if (result) {
1173 dev_err(&port->dev, "%s - failed submitting read urb,"
1174 " error %d\n", __func__, result);
1175 iuu_close(port);
1176 return -EPROTO;
1177 } else {
1178 dbg("%s - rxcmd OK", __func__);
1180 return result;
1183 /* how to change VCC */
1184 static int iuu_vcc_set(struct usb_serial_port *port, unsigned int vcc)
1186 int status;
1187 u8 *buf;
1189 buf = kmalloc(5, GFP_KERNEL);
1190 if (!buf)
1191 return -ENOMEM;
1193 dbg("%s - enter", __func__);
1195 buf[0] = IUU_SET_VCC;
1196 buf[1] = vcc & 0xFF;
1197 buf[2] = (vcc >> 8) & 0xFF;
1198 buf[3] = (vcc >> 16) & 0xFF;
1199 buf[4] = (vcc >> 24) & 0xFF;
1201 status = bulk_immediate(port, buf, 5);
1202 kfree(buf);
1204 if (status != IUU_OPERATION_OK)
1205 dbg("%s - vcc error status = %2x", __func__, status);
1206 else
1207 dbg("%s - vcc OK !", __func__);
1209 return status;
1213 * Sysfs Attributes
1216 static ssize_t show_vcc_mode(struct device *dev,
1217 struct device_attribute *attr, char *buf)
1219 struct usb_serial_port *port = to_usb_serial_port(dev);
1220 struct iuu_private *priv = usb_get_serial_port_data(port);
1222 return sprintf(buf, "%d\n", priv->vcc);
1225 static ssize_t store_vcc_mode(struct device *dev,
1226 struct device_attribute *attr, const char *buf, size_t count)
1228 struct usb_serial_port *port = to_usb_serial_port(dev);
1229 struct iuu_private *priv = usb_get_serial_port_data(port);
1230 unsigned long v;
1232 if (strict_strtoul(buf, 10, &v)) {
1233 dev_err(dev, "%s - vcc_mode: %s is not a unsigned long\n",
1234 __func__, buf);
1235 goto fail_store_vcc_mode;
1238 dbg("%s: setting vcc_mode = %ld", __func__, v);
1240 if ((v != 3) && (v != 5)) {
1241 dev_err(dev, "%s - vcc_mode %ld is invalid\n", __func__, v);
1242 } else {
1243 iuu_vcc_set(port, v);
1244 priv->vcc = v;
1246 fail_store_vcc_mode:
1247 return count;
1250 static DEVICE_ATTR(vcc_mode, S_IRUSR | S_IWUSR, show_vcc_mode,
1251 store_vcc_mode);
1253 static int iuu_create_sysfs_attrs(struct usb_serial_port *port)
1255 dbg("%s", __func__);
1257 return device_create_file(&port->dev, &dev_attr_vcc_mode);
1260 static int iuu_remove_sysfs_attrs(struct usb_serial_port *port)
1262 dbg("%s", __func__);
1264 device_remove_file(&port->dev, &dev_attr_vcc_mode);
1265 return 0;
1269 * End Sysfs Attributes
1272 static struct usb_serial_driver iuu_device = {
1273 .driver = {
1274 .owner = THIS_MODULE,
1275 .name = "iuu_phoenix",
1277 .id_table = id_table,
1278 .usb_driver = &iuu_driver,
1279 .num_ports = 1,
1280 .bulk_in_size = 512,
1281 .bulk_out_size = 512,
1282 .port_probe = iuu_create_sysfs_attrs,
1283 .port_remove = iuu_remove_sysfs_attrs,
1284 .open = iuu_open,
1285 .close = iuu_close,
1286 .write = iuu_uart_write,
1287 .read_bulk_callback = iuu_uart_read_callback,
1288 .tiocmget = iuu_tiocmget,
1289 .tiocmset = iuu_tiocmset,
1290 .set_termios = iuu_set_termios,
1291 .init_termios = iuu_init_termios,
1292 .attach = iuu_startup,
1293 .release = iuu_release,
1296 static int __init iuu_init(void)
1298 int retval;
1299 retval = usb_serial_register(&iuu_device);
1300 if (retval)
1301 goto failed_usb_serial_register;
1302 retval = usb_register(&iuu_driver);
1303 if (retval)
1304 goto failed_usb_register;
1305 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1306 DRIVER_DESC "\n");
1307 return 0;
1308 failed_usb_register:
1309 usb_serial_deregister(&iuu_device);
1310 failed_usb_serial_register:
1311 return retval;
1314 static void __exit iuu_exit(void)
1316 usb_deregister(&iuu_driver);
1317 usb_serial_deregister(&iuu_device);
1320 module_init(iuu_init);
1321 module_exit(iuu_exit);
1323 MODULE_AUTHOR("Alain Degreffe eczema@ecze.com");
1325 MODULE_DESCRIPTION(DRIVER_DESC);
1326 MODULE_LICENSE("GPL");
1328 MODULE_VERSION(DRIVER_VERSION);
1329 module_param(debug, bool, S_IRUGO | S_IWUSR);
1330 MODULE_PARM_DESC(debug, "Debug enabled or not");
1332 module_param(xmas, bool, S_IRUGO | S_IWUSR);
1333 MODULE_PARM_DESC(xmas, "Xmas colors enabled or not");
1335 module_param(boost, int, S_IRUGO | S_IWUSR);
1336 MODULE_PARM_DESC(boost, "Card overclock boost (in percent 100-500)");
1338 module_param(clockmode, int, S_IRUGO | S_IWUSR);
1339 MODULE_PARM_DESC(clockmode, "Card clock mode (1=3.579 MHz, 2=3.680 MHz, "
1340 "3=6 Mhz)");
1342 module_param(cdmode, int, S_IRUGO | S_IWUSR);
1343 MODULE_PARM_DESC(cdmode, "Card detect mode (0=none, 1=CD, 2=!CD, 3=DSR, "
1344 "4=!DSR, 5=CTS, 6=!CTS, 7=RING, 8=!RING)");
1346 module_param(vcc_default, int, S_IRUGO | S_IWUSR);
1347 MODULE_PARM_DESC(vcc_default, "Set default VCC (either 3 for 3.3V or 5 "
1348 "for 5V). Default to 5.");