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