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