drivers/usb/serial/iuu_phoenix.c

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