git.oblomov.eu Git - linux-2.6/blob - drivers/usb/serial/cypress_m8.c

   1 /*
   2  * USB Cypress M8 driver
   3  *
   4  *      Copyright (C) 2004
   5  *          Lonnie Mendez (dignome@gmail.com)
   6  *      Copyright (C) 2003,2004
   7  *          Neil Whelchel (koyama@firstlight.net)
   8  *
   9  *      This program is free software; you can redistribute it and/or modify
  10  *      it under the terms of the GNU General Public License as published by
  11  *      the Free Software Foundation; either version 2 of the License, or
  12  *      (at your option) any later version.
  13  *
  14  * See Documentation/usb/usb-serial.txt for more information on using this
  15  * driver
  16  *
  17  * See http://geocities.com/i0xox0i for information on this driver and the
  18  * earthmate usb device.
  19  *
  20  *  Lonnie Mendez <dignome@gmail.com>
  21  *  4-29-2005
  22  *      Fixed problem where setting or retreiving the serial config would fail
  23  *      with EPIPE.  Removed CRTS toggling so the driver behaves more like
  24  *      other usbserial adapters.  Issued new interval of 1ms instead of the
  25  *      default 10ms.  As a result, transfer speed has been substantially
  26  *      increased from avg. 850bps to avg. 3300bps.  initial termios has also
  27  *      been modified.  Cleaned up code and formatting issues so it is more
  28  *      readable.  Replaced the C++ style comments.
  29  *
  30  *  Lonnie Mendez <dignome@gmail.com>
  31  *  12-15-2004
  32  *      Incorporated write buffering from pl2303 driver.  Fixed bug with line
  33  *      handling so both lines are raised in cypress_open. (was dropping rts)
  34  *      Various code cleanups made as well along with other misc bug fixes.
  35  *
  36  *  Lonnie Mendez <dignome@gmail.com>
  37  *  04-10-2004
  38  *      Driver modified to support dynamic line settings.  Various improvments
  39  *      and features.
  40  *
  41  *  Neil Whelchel
  42  *  10-2003
  43  *      Driver first released.
  44  *
  45  */
  46
  47 /* Thanks to Neil Whelchel for writing the first cypress m8 implementation
  48    for linux. */
  49 /* Thanks to cypress for providing references for the hid reports. */
  50 /* Thanks to Jiang Zhang for providing links and for general help. */
  51 /* Code originates and was built up from ftdi_sio, belkin, pl2303 and others.*/
  52
  53
  54 #include <linux/kernel.h>
  55 #include <linux/errno.h>
  56 #include <linux/init.h>
  57 #include <linux/slab.h>
  58 #include <linux/tty.h>
  59 #include <linux/tty_driver.h>
  60 #include <linux/tty_flip.h>
  61 #include <linux/module.h>
  62 #include <linux/moduleparam.h>
  63 #include <linux/spinlock.h>
  64 #include <linux/usb.h>
  65 #include <linux/usb/serial.h>
  66 #include <linux/serial.h>
  67 #include <linux/delay.h>
  68 #include <linux/uaccess.h>
  69
  70 #include "cypress_m8.h"
  71
  72
  73 #ifdef CONFIG_USB_SERIAL_DEBUG
  74         static int debug = 1;
  75 #else
  76         static int debug;
  77 #endif
  78 static int stats;
  79 static int interval;
  80
  81 /*
  82  * Version Information
  83  */
  84 #define DRIVER_VERSION "v1.09"
  85 #define DRIVER_AUTHOR "Lonnie Mendez <dignome@gmail.com>, Neil Whelchel <koyama@firstlight.net>"
  86 #define DRIVER_DESC "Cypress USB to Serial Driver"
  87
  88 /* write buffer size defines */
  89 #define CYPRESS_BUF_SIZE        1024
  90 #define CYPRESS_CLOSING_WAIT    (30*HZ)
  91
  92 static struct usb_device_id id_table_earthmate [] = {
  93         { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
  94         { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
  95         { }                                             /* Terminating entry */
  96 };
  97
  98 static struct usb_device_id id_table_cyphidcomrs232 [] = {
  99         { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
 100         { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
 101         { }                                             /* Terminating entry */
 102 };
 103
 104 static struct usb_device_id id_table_nokiaca42v2 [] = {
 105         { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
 106         { }                                             /* Terminating entry */
 107 };
 108
 109 static struct usb_device_id id_table_combined [] = {
 110         { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB) },
 111         { USB_DEVICE(VENDOR_ID_DELORME, PRODUCT_ID_EARTHMATEUSB_LT20) },
 112         { USB_DEVICE(VENDOR_ID_CYPRESS, PRODUCT_ID_CYPHIDCOM) },
 113         { USB_DEVICE(VENDOR_ID_POWERCOM, PRODUCT_ID_UPS) },
 114         { USB_DEVICE(VENDOR_ID_DAZZLE, PRODUCT_ID_CA42) },
 115         { }                                             /* Terminating entry */
 116 };
 117
 118 MODULE_DEVICE_TABLE(usb, id_table_combined);
 119
 120 static struct usb_driver cypress_driver = {
 121         .name =         "cypress",
 122         .probe =        usb_serial_probe,
 123         .disconnect =   usb_serial_disconnect,
 124         .id_table =     id_table_combined,
 125         .no_dynamic_id =        1,
 126 };
 127
 128 enum packet_format {
 129         packet_format_1,  /* b0:status, b1:payload count */
 130         packet_format_2   /* b0[7:3]:status, b0[2:0]:payload count */
 131 };
 132
 133 struct cypress_private {
 134         spinlock_t lock;                   /* private lock */
 135         int chiptype;                      /* identifier of device, for quirks/etc */
 136         int bytes_in;                      /* used for statistics */
 137         int bytes_out;                     /* used for statistics */
 138         int cmd_count;                     /* used for statistics */
 139         int cmd_ctrl;                      /* always set this to 1 before issuing a command */
 140         struct cypress_buf *buf;           /* write buffer */
 141         int write_urb_in_use;              /* write urb in use indicator */
 142         int write_urb_interval;            /* interval to use for write urb */
 143         int read_urb_interval;             /* interval to use for read urb */
 144         int comm_is_ok;                    /* true if communication is (still) ok */
 145         int termios_initialized;
 146         __u8 line_control;                 /* holds dtr / rts value */
 147         __u8 current_status;               /* received from last read - info on dsr,cts,cd,ri,etc */
 148         __u8 current_config;               /* stores the current configuration byte */
 149         __u8 rx_flags;                     /* throttling - used from whiteheat/ftdi_sio */
 150         enum packet_format pkt_fmt;        /* format to use for packet send / receive */
 151         int get_cfg_unsafe;                /* If true, the CYPRESS_GET_CONFIG is unsafe */
 152         int baud_rate;                     /* stores current baud rate in
 153                                               integer form */
 154         int isthrottled;                   /* if throttled, discard reads */
 155         wait_queue_head_t delta_msr_wait;  /* used for TIOCMIWAIT */
 156         char prev_status, diff_status;     /* used for TIOCMIWAIT */
 157         /* we pass a pointer to this as the arguement sent to
 158            cypress_set_termios old_termios */
 159         struct ktermios tmp_termios;       /* stores the old termios settings */
 160 };
 161
 162 /* write buffer structure */
 163 struct cypress_buf {
 164         unsigned int    buf_size;
 165         char            *buf_buf;
 166         char            *buf_get;
 167         char            *buf_put;
 168 };
 169
 170 /* function prototypes for the Cypress USB to serial device */
 171 static int  cypress_earthmate_startup(struct usb_serial *serial);
 172 static int  cypress_hidcom_startup(struct usb_serial *serial);
 173 static int  cypress_ca42v2_startup(struct usb_serial *serial);
 174 static void cypress_shutdown(struct usb_serial *serial);
 175 static int  cypress_open(struct tty_struct *tty,
 176                         struct usb_serial_port *port, struct file *filp);
 177 static void cypress_close(struct usb_serial_port *port);
 178 static void cypress_dtr_rts(struct usb_serial_port *port, int on);
 179 static int  cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
 180                         const unsigned char *buf, int count);
 181 static void cypress_send(struct usb_serial_port *port);
 182 static int  cypress_write_room(struct tty_struct *tty);
 183 static int  cypress_ioctl(struct tty_struct *tty, struct file *file,
 184                         unsigned int cmd, unsigned long arg);
 185 static void cypress_set_termios(struct tty_struct *tty,
 186                         struct usb_serial_port *port, struct ktermios *old);
 187 static int  cypress_tiocmget(struct tty_struct *tty, struct file *file);
 188 static int  cypress_tiocmset(struct tty_struct *tty, struct file *file,
 189                         unsigned int set, unsigned int clear);
 190 static int  cypress_chars_in_buffer(struct tty_struct *tty);
 191 static void cypress_throttle(struct tty_struct *tty);
 192 static void cypress_unthrottle(struct tty_struct *tty);
 193 static void cypress_set_dead(struct usb_serial_port *port);
 194 static void cypress_read_int_callback(struct urb *urb);
 195 static void cypress_write_int_callback(struct urb *urb);
 196 /* write buffer functions */
 197 static struct cypress_buf *cypress_buf_alloc(unsigned int size);
 198 static void cypress_buf_free(struct cypress_buf *cb);
 199 static void cypress_buf_clear(struct cypress_buf *cb);
 200 static unsigned int cypress_buf_data_avail(struct cypress_buf *cb);
 201 static unsigned int cypress_buf_space_avail(struct cypress_buf *cb);
 202 static unsigned int cypress_buf_put(struct cypress_buf *cb,
 203                                         const char *buf, unsigned int count);
 204 static unsigned int cypress_buf_get(struct cypress_buf *cb,
 205                                         char *buf, unsigned int count);
 206
 207
 208 static struct usb_serial_driver cypress_earthmate_device = {
 209         .driver = {
 210                 .owner =                THIS_MODULE,
 211                 .name =                 "earthmate",
 212         },
 213         .description =                  "DeLorme Earthmate USB",
 214         .usb_driver =                   &cypress_driver,
 215         .id_table =                     id_table_earthmate,
 216         .num_ports =                    1,
 217         .attach =                       cypress_earthmate_startup,
 218         .shutdown =                     cypress_shutdown,
 219         .open =                         cypress_open,
 220         .close =                        cypress_close,
 221         .dtr_rts =                      cypress_dtr_rts,
 222         .write =                        cypress_write,
 223         .write_room =                   cypress_write_room,
 224         .ioctl =                        cypress_ioctl,
 225         .set_termios =                  cypress_set_termios,
 226         .tiocmget =                     cypress_tiocmget,
 227         .tiocmset =                     cypress_tiocmset,
 228         .chars_in_buffer =              cypress_chars_in_buffer,
 229         .throttle =                     cypress_throttle,
 230         .unthrottle =                   cypress_unthrottle,
 231         .read_int_callback =            cypress_read_int_callback,
 232         .write_int_callback =           cypress_write_int_callback,
 233 };
 234
 235 static struct usb_serial_driver cypress_hidcom_device = {
 236         .driver = {
 237                 .owner =                THIS_MODULE,
 238                 .name =                 "cyphidcom",
 239         },
 240         .description =                  "HID->COM RS232 Adapter",
 241         .usb_driver =                   &cypress_driver,
 242         .id_table =                     id_table_cyphidcomrs232,
 243         .num_ports =                    1,
 244         .attach =                       cypress_hidcom_startup,
 245         .shutdown =                     cypress_shutdown,
 246         .open =                         cypress_open,
 247         .close =                        cypress_close,
 248         .dtr_rts =                      cypress_dtr_rts,
 249         .write =                        cypress_write,
 250         .write_room =                   cypress_write_room,
 251         .ioctl =                        cypress_ioctl,
 252         .set_termios =                  cypress_set_termios,
 253         .tiocmget =                     cypress_tiocmget,
 254         .tiocmset =                     cypress_tiocmset,
 255         .chars_in_buffer =              cypress_chars_in_buffer,
 256         .throttle =                     cypress_throttle,
 257         .unthrottle =                   cypress_unthrottle,
 258         .read_int_callback =            cypress_read_int_callback,
 259         .write_int_callback =           cypress_write_int_callback,
 260 };
 261
 262 static struct usb_serial_driver cypress_ca42v2_device = {
 263         .driver = {
 264                 .owner =                THIS_MODULE,
 265                 .name =                 "nokiaca42v2",
 266         },
 267         .description =                  "Nokia CA-42 V2 Adapter",
 268         .usb_driver =                   &cypress_driver,
 269         .id_table =                     id_table_nokiaca42v2,
 270         .num_ports =                    1,
 271         .attach =                       cypress_ca42v2_startup,
 272         .shutdown =                     cypress_shutdown,
 273         .open =                         cypress_open,
 274         .close =                        cypress_close,
 275         .dtr_rts =                      cypress_dtr_rts,
 276         .write =                        cypress_write,
 277         .write_room =                   cypress_write_room,
 278         .ioctl =                        cypress_ioctl,
 279         .set_termios =                  cypress_set_termios,
 280         .tiocmget =                     cypress_tiocmget,
 281         .tiocmset =                     cypress_tiocmset,
 282         .chars_in_buffer =              cypress_chars_in_buffer,
 283         .throttle =                     cypress_throttle,
 284         .unthrottle =                   cypress_unthrottle,
 285         .read_int_callback =            cypress_read_int_callback,
 286         .write_int_callback =           cypress_write_int_callback,
 287 };
 288
 289 /*****************************************************************************
 290  * Cypress serial helper functions
 291  *****************************************************************************/
 292
 293
 294 static int analyze_baud_rate(struct usb_serial_port *port, speed_t new_rate)
 295 {
 296         struct cypress_private *priv;
 297         priv = usb_get_serial_port_data(port);
 298
 299         /*
 300          * The general purpose firmware for the Cypress M8 allows for
 301          * a maximum speed of 57600bps (I have no idea whether DeLorme
 302          * chose to use the general purpose firmware or not), if you
 303          * need to modify this speed setting for your own project
 304          * please add your own chiptype and modify the code likewise.
 305          * The Cypress HID->COM device will work successfully up to
 306          * 115200bps (but the actual throughput is around 3kBps).
 307          */
 308         if (port->serial->dev->speed == USB_SPEED_LOW) {
 309                 /*
 310                  * Mike Isely <isely@pobox.com> 2-Feb-2008: The
 311                  * Cypress app note that describes this mechanism
 312                  * states the the low-speed part can't handle more
 313                  * than 800 bytes/sec, in which case 4800 baud is the
 314                  * safest speed for a part like that.
 315                  */
 316                 if (new_rate > 4800) {
 317                         dbg("%s - failed setting baud rate, device incapable "
 318                             "speed %d", __func__, new_rate);
 319                         return -1;
 320                 }
 321         }
 322         switch (priv->chiptype) {
 323         case CT_EARTHMATE:
 324                 if (new_rate <= 600) {
 325                         /* 300 and 600 baud rates are supported under
 326                          * the generic firmware, but are not used with
 327                          * NMEA and SiRF protocols */
 328                         dbg("%s - failed setting baud rate, unsupported speed "
 329                             "of %d on Earthmate GPS", __func__, new_rate);
 330                         return -1;
 331                 }
 332                 break;
 333         default:
 334                 break;
 335         }
 336         return new_rate;
 337 }
 338
 339
 340 /* This function can either set or retrieve the current serial line settings */
 341 static int cypress_serial_control(struct tty_struct *tty,
 342         struct usb_serial_port *port, speed_t baud_rate, int data_bits,
 343         int stop_bits, int parity_enable, int parity_type, int reset,
 344         int cypress_request_type)
 345 {
 346         int new_baudrate = 0, retval = 0, tries = 0;
 347         struct cypress_private *priv;
 348         __u8 feature_buffer[5];
 349         unsigned long flags;
 350
 351         dbg("%s", __func__);
 352
 353         priv = usb_get_serial_port_data(port);
 354
 355         if (!priv->comm_is_ok)
 356                 return -ENODEV;
 357
 358         switch (cypress_request_type) {
 359         case CYPRESS_SET_CONFIG:
 360                 new_baudrate = priv->baud_rate;
 361                 /* 0 means 'Hang up' so doesn't change the true bit rate */
 362                 if (baud_rate == 0)
 363                         new_baudrate = priv->baud_rate;
 364                 /* Change of speed ? */
 365                 else if (baud_rate != priv->baud_rate) {
 366                         dbg("%s - baud rate is changing", __func__);
 367                         retval = analyze_baud_rate(port, baud_rate);
 368                         if (retval >=  0) {
 369                                 new_baudrate = retval;
 370                                 dbg("%s - New baud rate set to %d",
 371                                     __func__, new_baudrate);
 372                         }
 373                 }
 374                 dbg("%s - baud rate is being sent as %d",
 375                                         __func__, new_baudrate);
 376
 377                 memset(feature_buffer, 0, sizeof(feature_buffer));
 378                 /* fill the feature_buffer with new configuration */
 379                 *((u_int32_t *)feature_buffer) = new_baudrate;
 380                 feature_buffer[4] |= data_bits;   /* assign data bits in 2 bit space ( max 3 ) */
 381                 /* 1 bit gap */
 382                 feature_buffer[4] |= (stop_bits << 3);   /* assign stop bits in 1 bit space */
 383                 feature_buffer[4] |= (parity_enable << 4);   /* assign parity flag in 1 bit space */
 384                 feature_buffer[4] |= (parity_type << 5);   /* assign parity type in 1 bit space */
 385                 /* 1 bit gap */
 386                 feature_buffer[4] |= (reset << 7);   /* assign reset at end of byte, 1 bit space */
 387
 388                 dbg("%s - device is being sent this feature report:",
 389                                                                 __func__);
 390                 dbg("%s - %02X - %02X - %02X - %02X - %02X", __func__,
 391                         feature_buffer[0], feature_buffer[1],
 392                         feature_buffer[2], feature_buffer[3],
 393                         feature_buffer[4]);
 394
 395                 do {
 396                         retval = usb_control_msg(port->serial->dev,
 397                                         usb_sndctrlpipe(port->serial->dev, 0),
 398                                         HID_REQ_SET_REPORT,
 399                                         USB_DIR_OUT | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
 400                                         0x0300, 0, feature_buffer,
 401                                         sizeof(feature_buffer), 500);
 402
 403                         if (tries++ >= 3)
 404                                 break;
 405
 406                 } while (retval != sizeof(feature_buffer) &&
 407                          retval != -ENODEV);
 408
 409                 if (retval != sizeof(feature_buffer)) {
 410                         dev_err(&port->dev, "%s - failed sending serial "
 411                                 "line settings - %d\n", __func__, retval);
 412                         cypress_set_dead(port);
 413                 } else {
 414                         spin_lock_irqsave(&priv->lock, flags);
 415                         priv->baud_rate = new_baudrate;
 416                         priv->current_config = feature_buffer[4];
 417                         spin_unlock_irqrestore(&priv->lock, flags);
 418                         /* If we asked for a speed change encode it */
 419                         if (baud_rate)
 420                                 tty_encode_baud_rate(tty,
 421                                         new_baudrate, new_baudrate);
 422                 }
 423         break;
 424         case CYPRESS_GET_CONFIG:
 425                 if (priv->get_cfg_unsafe) {
 426                         /* Not implemented for this device,
 427                            and if we try to do it we're likely
 428                            to crash the hardware. */
 429                         return -ENOTTY;
 430                 }
 431                 dbg("%s - retreiving serial line settings", __func__);
 432                 /* set initial values in feature buffer */
 433                 memset(feature_buffer, 0, sizeof(feature_buffer));
 434
 435                 do {
 436                         retval = usb_control_msg(port->serial->dev,
 437                                         usb_rcvctrlpipe(port->serial->dev, 0),
 438                                         HID_REQ_GET_REPORT,
 439                                         USB_DIR_IN | USB_RECIP_INTERFACE | USB_TYPE_CLASS,
 440                                         0x0300, 0, feature_buffer,
 441                                         sizeof(feature_buffer), 500);
 442
 443                         if (tries++ >= 3)
 444                                 break;
 445                 } while (retval != sizeof(feature_buffer)
 446                                                 && retval != -ENODEV);
 447
 448                 if (retval != sizeof(feature_buffer)) {
 449                         dev_err(&port->dev, "%s - failed to retrieve serial "
 450                                 "line settings - %d\n", __func__, retval);
 451                         cypress_set_dead(port);
 452                         return retval;
 453                 } else {
 454                         spin_lock_irqsave(&priv->lock, flags);
 455                         /* store the config in one byte, and later
 456                            use bit masks to check values */
 457                         priv->current_config = feature_buffer[4];
 458                         priv->baud_rate = *((u_int32_t *)feature_buffer);
 459                         spin_unlock_irqrestore(&priv->lock, flags);
 460                 }
 461         }
 462         spin_lock_irqsave(&priv->lock, flags);
 463         ++priv->cmd_count;
 464         spin_unlock_irqrestore(&priv->lock, flags);
 465
 466         return retval;
 467 } /* cypress_serial_control */
 468
 469
 470 static void cypress_set_dead(struct usb_serial_port *port)
 471 {
 472         struct cypress_private *priv = usb_get_serial_port_data(port);
 473         unsigned long flags;
 474
 475         spin_lock_irqsave(&priv->lock, flags);
 476         if (!priv->comm_is_ok) {
 477                 spin_unlock_irqrestore(&priv->lock, flags);
 478                 return;
 479         }
 480         priv->comm_is_ok = 0;
 481         spin_unlock_irqrestore(&priv->lock, flags);
 482
 483         dev_err(&port->dev, "cypress_m8 suspending failing port %d - "
 484                 "interval might be too short\n", port->number);
 485 }
 486
 487
 488 /*****************************************************************************
 489  * Cypress serial driver functions
 490  *****************************************************************************/
 491
 492
 493 static int generic_startup(struct usb_serial *serial)
 494 {
 495         struct cypress_private *priv;
 496         struct usb_serial_port *port = serial->port[0];
 497
 498         dbg("%s - port %d", __func__, port->number);
 499
 500         priv = kzalloc(sizeof(struct cypress_private), GFP_KERNEL);
 501         if (!priv)
 502                 return -ENOMEM;
 503
 504         priv->comm_is_ok = !0;
 505         spin_lock_init(&priv->lock);
 506         priv->buf = cypress_buf_alloc(CYPRESS_BUF_SIZE);
 507         if (priv->buf == NULL) {
 508                 kfree(priv);
 509                 return -ENOMEM;
 510         }
 511         init_waitqueue_head(&priv->delta_msr_wait);
 512
 513         usb_reset_configuration(serial->dev);
 514
 515         priv->cmd_ctrl = 0;
 516         priv->line_control = 0;
 517         priv->termios_initialized = 0;
 518         priv->rx_flags = 0;
 519         /* Default packet format setting is determined by packet size.
 520            Anything with a size larger then 9 must have a separate
 521            count field since the 3 bit count field is otherwise too
 522            small.  Otherwise we can use the slightly more compact
 523            format.  This is in accordance with the cypress_m8 serial
 524            converter app note. */
 525         if (port->interrupt_out_size > 9)
 526                 priv->pkt_fmt = packet_format_1;
 527         else
 528                 priv->pkt_fmt = packet_format_2;
 529
 530         if (interval > 0) {
 531                 priv->write_urb_interval = interval;
 532                 priv->read_urb_interval = interval;
 533                 dbg("%s - port %d read & write intervals forced to %d",
 534                     __func__, port->number, interval);
 535         } else {
 536                 priv->write_urb_interval = port->interrupt_out_urb->interval;
 537                 priv->read_urb_interval = port->interrupt_in_urb->interval;
 538                 dbg("%s - port %d intervals: read=%d write=%d",
 539                     __func__, port->number,
 540                     priv->read_urb_interval, priv->write_urb_interval);
 541         }
 542         usb_set_serial_port_data(port, priv);
 543
 544         return 0;
 545 }
 546
 547
 548 static int cypress_earthmate_startup(struct usb_serial *serial)
 549 {
 550         struct cypress_private *priv;
 551         struct usb_serial_port *port = serial->port[0];
 552
 553         dbg("%s", __func__);
 554
 555         if (generic_startup(serial)) {
 556                 dbg("%s - Failed setting up port %d", __func__,
 557                                 port->number);
 558                 return 1;
 559         }
 560
 561         priv = usb_get_serial_port_data(port);
 562         priv->chiptype = CT_EARTHMATE;
 563         /* All Earthmate devices use the separated-count packet
 564            format!  Idiotic. */
 565         priv->pkt_fmt = packet_format_1;
 566         if (serial->dev->descriptor.idProduct !=
 567                                 cpu_to_le16(PRODUCT_ID_EARTHMATEUSB)) {
 568                 /* The old original USB Earthmate seemed able to
 569                    handle GET_CONFIG requests; everything they've
 570                    produced since that time crashes if this command is
 571                    attempted :-( */
 572                 dbg("%s - Marking this device as unsafe for GET_CONFIG "
 573                     "commands", __func__);
 574                 priv->get_cfg_unsafe = !0;
 575         }
 576
 577         return 0;
 578 } /* cypress_earthmate_startup */
 579
 580
 581 static int cypress_hidcom_startup(struct usb_serial *serial)
 582 {
 583         struct cypress_private *priv;
 584
 585         dbg("%s", __func__);
 586
 587         if (generic_startup(serial)) {
 588                 dbg("%s - Failed setting up port %d", __func__,
 589                                 serial->port[0]->number);
 590                 return 1;
 591         }
 592
 593         priv = usb_get_serial_port_data(serial->port[0]);
 594         priv->chiptype = CT_CYPHIDCOM;
 595
 596         return 0;
 597 } /* cypress_hidcom_startup */
 598
 599
 600 static int cypress_ca42v2_startup(struct usb_serial *serial)
 601 {
 602         struct cypress_private *priv;
 603
 604         dbg("%s", __func__);
 605
 606         if (generic_startup(serial)) {
 607                 dbg("%s - Failed setting up port %d", __func__,
 608                                 serial->port[0]->number);
 609                 return 1;
 610         }
 611
 612         priv = usb_get_serial_port_data(serial->port[0]);
 613         priv->chiptype = CT_CA42V2;
 614
 615         return 0;
 616 } /* cypress_ca42v2_startup */
 617
 618
 619 static void cypress_shutdown(struct usb_serial *serial)
 620 {
 621         struct cypress_private *priv;
 622
 623         dbg("%s - port %d", __func__, serial->port[0]->number);
 624
 625         /* all open ports are closed at this point */
 626
 627         priv = usb_get_serial_port_data(serial->port[0]);
 628
 629         if (priv) {
 630                 cypress_buf_free(priv->buf);
 631                 kfree(priv);
 632                 usb_set_serial_port_data(serial->port[0], NULL);
 633         }
 634 }
 635
 636
 637 static int cypress_open(struct tty_struct *tty,
 638                         struct usb_serial_port *port, struct file *filp)
 639 {
 640         struct cypress_private *priv = usb_get_serial_port_data(port);
 641         struct usb_serial *serial = port->serial;
 642         unsigned long flags;
 643         int result = 0;
 644
 645         dbg("%s - port %d", __func__, port->number);
 646
 647         if (!priv->comm_is_ok)
 648                 return -EIO;
 649
 650         /* clear halts before open */
 651         usb_clear_halt(serial->dev, 0x81);
 652         usb_clear_halt(serial->dev, 0x02);
 653
 654         spin_lock_irqsave(&priv->lock, flags);
 655         /* reset read/write statistics */
 656         priv->bytes_in = 0;
 657         priv->bytes_out = 0;
 658         priv->cmd_count = 0;
 659         priv->rx_flags = 0;
 660         spin_unlock_irqrestore(&priv->lock, flags);
 661
 662         /* Set termios */
 663         result = cypress_write(tty, port, NULL, 0);
 664
 665         if (result) {
 666                 dev_err(&port->dev,
 667                         "%s - failed setting the control lines - error %d\n",
 668                                                         __func__, result);
 669                 return result;
 670         } else
 671                 dbg("%s - success setting the control lines", __func__);
 672
 673         if (tty)
 674                 cypress_set_termios(tty, port, &priv->tmp_termios);
 675
 676         /* setup the port and start reading from the device */
 677         if (!port->interrupt_in_urb) {
 678                 dev_err(&port->dev, "%s - interrupt_in_urb is empty!\n",
 679                         __func__);
 680                 return -1;
 681         }
 682
 683         usb_fill_int_urb(port->interrupt_in_urb, serial->dev,
 684                 usb_rcvintpipe(serial->dev, port->interrupt_in_endpointAddress),
 685                 port->interrupt_in_urb->transfer_buffer,
 686                 port->interrupt_in_urb->transfer_buffer_length,
 687                 cypress_read_int_callback, port, priv->read_urb_interval);
 688         result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
 689
 690         if (result) {
 691                 dev_err(&port->dev,
 692                         "%s - failed submitting read urb, error %d\n",
 693                                                         __func__, result);
 694                 cypress_set_dead(port);
 695         }
 696         port->port.drain_delay = 256;
 697         return result;
 698 } /* cypress_open */
 699
 700 static void cypress_dtr_rts(struct usb_serial_port *port, int on)
 701 {
 702         struct cypress_private *priv = usb_get_serial_port_data(port);
 703         /* drop dtr and rts */
 704         priv = usb_get_serial_port_data(port);
 705         spin_lock_irq(&priv->lock);
 706         if (on == 0)
 707                 priv->line_control = 0;
 708         else
 709                 priv->line_control = CONTROL_DTR | CONTROL_RTS;
 710         priv->cmd_ctrl = 1;
 711         spin_unlock_irq(&priv->lock);
 712         cypress_write(NULL, port, NULL, 0);
 713 }
 714
 715 static void cypress_close(struct usb_serial_port *port)
 716 {
 717         struct cypress_private *priv = usb_get_serial_port_data(port);
 718
 719         dbg("%s - port %d", __func__, port->number);
 720
 721         /* writing is potentially harmful, lock must be taken */
 722         mutex_lock(&port->serial->disc_mutex);
 723         if (port->serial->disconnected) {
 724                 mutex_unlock(&port->serial->disc_mutex);
 725                 return;
 726         }
 727         cypress_buf_clear(priv->buf);
 728         dbg("%s - stopping urbs", __func__);
 729         usb_kill_urb(port->interrupt_in_urb);
 730         usb_kill_urb(port->interrupt_out_urb);
 731
 732
 733         if (stats)
 734                 dev_info(&port->dev, "Statistics: %d Bytes In | %d Bytes Out | %d Commands Issued\n",
 735                         priv->bytes_in, priv->bytes_out, priv->cmd_count);
 736         mutex_unlock(&port->serial->disc_mutex);
 737 } /* cypress_close */
 738
 739
 740 static int cypress_write(struct tty_struct *tty, struct usb_serial_port *port,
 741                                         const unsigned char *buf, int count)
 742 {
 743         struct cypress_private *priv = usb_get_serial_port_data(port);
 744         unsigned long flags;
 745
 746         dbg("%s - port %d, %d bytes", __func__, port->number, count);
 747
 748         /* line control commands, which need to be executed immediately,
 749            are not put into the buffer for obvious reasons.
 750          */
 751         if (priv->cmd_ctrl) {
 752                 count = 0;
 753                 goto finish;
 754         }
 755
 756         if (!count)
 757                 return count;
 758
 759         spin_lock_irqsave(&priv->lock, flags);
 760         count = cypress_buf_put(priv->buf, buf, count);
 761         spin_unlock_irqrestore(&priv->lock, flags);
 762
 763 finish:
 764         cypress_send(port);
 765
 766         return count;
 767 } /* cypress_write */
 768
 769
 770 static void cypress_send(struct usb_serial_port *port)
 771 {
 772         int count = 0, result, offset, actual_size;
 773         struct cypress_private *priv = usb_get_serial_port_data(port);
 774         unsigned long flags;
 775
 776         if (!priv->comm_is_ok)
 777                 return;
 778
 779         dbg("%s - port %d", __func__, port->number);
 780         dbg("%s - interrupt out size is %d", __func__,
 781                                                 port->interrupt_out_size);
 782
 783         spin_lock_irqsave(&priv->lock, flags);
 784         if (priv->write_urb_in_use) {
 785                 dbg("%s - can't write, urb in use", __func__);
 786                 spin_unlock_irqrestore(&priv->lock, flags);
 787                 return;
 788         }
 789         spin_unlock_irqrestore(&priv->lock, flags);
 790
 791         /* clear buffer */
 792         memset(port->interrupt_out_urb->transfer_buffer, 0,
 793                                                 port->interrupt_out_size);
 794
 795         spin_lock_irqsave(&priv->lock, flags);
 796         switch (priv->pkt_fmt) {
 797         default:
 798         case packet_format_1:
 799                 /* this is for the CY7C64013... */
 800                 offset = 2;
 801                 port->interrupt_out_buffer[0] = priv->line_control;
 802                 break;
 803         case packet_format_2:
 804                 /* this is for the CY7C63743... */
 805                 offset = 1;
 806                 port->interrupt_out_buffer[0] = priv->line_control;
 807                 break;
 808         }
 809
 810         if (priv->line_control & CONTROL_RESET)
 811                 priv->line_control &= ~CONTROL_RESET;
 812
 813         if (priv->cmd_ctrl) {
 814                 priv->cmd_count++;
 815                 dbg("%s - line control command being issued", __func__);
 816                 spin_unlock_irqrestore(&priv->lock, flags);
 817                 goto send;
 818         } else
 819                 spin_unlock_irqrestore(&priv->lock, flags);
 820
 821         count = cypress_buf_get(priv->buf, &port->interrupt_out_buffer[offset],
 822                                 port->interrupt_out_size-offset);
 823
 824         if (count == 0)
 825                 return;
 826
 827         switch (priv->pkt_fmt) {
 828         default:
 829         case packet_format_1:
 830                 port->interrupt_out_buffer[1] = count;
 831                 break;
 832         case packet_format_2:
 833                 port->interrupt_out_buffer[0] |= count;
 834         }
 835
 836         dbg("%s - count is %d", __func__, count);
 837
 838 send:
 839         spin_lock_irqsave(&priv->lock, flags);
 840         priv->write_urb_in_use = 1;
 841         spin_unlock_irqrestore(&priv->lock, flags);
 842
 843         if (priv->cmd_ctrl)
 844                 actual_size = 1;
 845         else
 846                 actual_size = count +
 847                               (priv->pkt_fmt == packet_format_1 ? 2 : 1);
 848
 849         usb_serial_debug_data(debug, &port->dev, __func__,
 850                 port->interrupt_out_size,
 851                 port->interrupt_out_urb->transfer_buffer);
 852
 853         usb_fill_int_urb(port->interrupt_out_urb, port->serial->dev,
 854                 usb_sndintpipe(port->serial->dev, port->interrupt_out_endpointAddress),
 855                 port->interrupt_out_buffer, port->interrupt_out_size,
 856                 cypress_write_int_callback, port, priv->write_urb_interval);
 857         result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
 858         if (result) {
 859                 dev_err(&port->dev,
 860                                 "%s - failed submitting write urb, error %d\n",
 861                                                         __func__, result);
 862                 priv->write_urb_in_use = 0;
 863                 cypress_set_dead(port);
 864         }
 865
 866         spin_lock_irqsave(&priv->lock, flags);
 867         if (priv->cmd_ctrl)
 868                 priv->cmd_ctrl = 0;
 869
 870         /* do not count the line control and size bytes */
 871         priv->bytes_out += count;
 872         spin_unlock_irqrestore(&priv->lock, flags);
 873
 874         usb_serial_port_softint(port);
 875 } /* cypress_send */
 876
 877
 878 /* returns how much space is available in the soft buffer */
 879 static int cypress_write_room(struct tty_struct *tty)
 880 {
 881         struct usb_serial_port *port = tty->driver_data;
 882         struct cypress_private *priv = usb_get_serial_port_data(port);
 883         int room = 0;
 884         unsigned long flags;
 885
 886         dbg("%s - port %d", __func__, port->number);
 887
 888         spin_lock_irqsave(&priv->lock, flags);
 889         room = cypress_buf_space_avail(priv->buf);
 890         spin_unlock_irqrestore(&priv->lock, flags);
 891
 892         dbg("%s - returns %d", __func__, room);
 893         return room;
 894 }
 895
 896
 897 static int cypress_tiocmget(struct tty_struct *tty, struct file *file)
 898 {
 899         struct usb_serial_port *port = tty->driver_data;
 900         struct cypress_private *priv = usb_get_serial_port_data(port);
 901         __u8 status, control;
 902         unsigned int result = 0;
 903         unsigned long flags;
 904
 905         dbg("%s - port %d", __func__, port->number);
 906
 907         spin_lock_irqsave(&priv->lock, flags);
 908         control = priv->line_control;
 909         status = priv->current_status;
 910         spin_unlock_irqrestore(&priv->lock, flags);
 911
 912         result = ((control & CONTROL_DTR)        ? TIOCM_DTR : 0)
 913                 | ((control & CONTROL_RTS)       ? TIOCM_RTS : 0)
 914                 | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 915                 | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 916                 | ((status & UART_RI)         ? TIOCM_RI  : 0)
 917                 | ((status & UART_CD)         ? TIOCM_CD  : 0);
 918
 919         dbg("%s - result = %x", __func__, result);
 920
 921         return result;
 922 }
 923
 924
 925 static int cypress_tiocmset(struct tty_struct *tty, struct file *file,
 926                                unsigned int set, unsigned int clear)
 927 {
 928         struct usb_serial_port *port = tty->driver_data;
 929         struct cypress_private *priv = usb_get_serial_port_data(port);
 930         unsigned long flags;
 931
 932         dbg("%s - port %d", __func__, port->number);
 933
 934         spin_lock_irqsave(&priv->lock, flags);
 935         if (set & TIOCM_RTS)
 936                 priv->line_control |= CONTROL_RTS;
 937         if (set & TIOCM_DTR)
 938                 priv->line_control |= CONTROL_DTR;
 939         if (clear & TIOCM_RTS)
 940                 priv->line_control &= ~CONTROL_RTS;
 941         if (clear & TIOCM_DTR)
 942                 priv->line_control &= ~CONTROL_DTR;
 943         priv->cmd_ctrl = 1;
 944         spin_unlock_irqrestore(&priv->lock, flags);
 945
 946         return cypress_write(tty, port, NULL, 0);
 947 }
 948
 949
 950 static int cypress_ioctl(struct tty_struct *tty, struct file *file,
 951                                         unsigned int cmd, unsigned long arg)
 952 {
 953         struct usb_serial_port *port = tty->driver_data;
 954         struct cypress_private *priv = usb_get_serial_port_data(port);
 955
 956         dbg("%s - port %d, cmd 0x%.4x", __func__, port->number, cmd);
 957
 958         switch (cmd) {
 959         /* This code comes from drivers/char/serial.c and ftdi_sio.c */
 960         case TIOCMIWAIT:
 961                 while (priv != NULL) {
 962                         interruptible_sleep_on(&priv->delta_msr_wait);
 963                         /* see if a signal did it */
 964                         if (signal_pending(current))
 965                                 return -ERESTARTSYS;
 966                         else {
 967                                 char diff = priv->diff_status;
 968                                 if (diff == 0)
 969                                         return -EIO; /* no change => error */
 970
 971                                 /* consume all events */
 972                                 priv->diff_status = 0;
 973
 974                                 /* return 0 if caller wanted to know about
 975                                    these bits */
 976                                 if (((arg & TIOCM_RNG) && (diff & UART_RI)) ||
 977                                     ((arg & TIOCM_DSR) && (diff & UART_DSR)) ||
 978                                     ((arg & TIOCM_CD) && (diff & UART_CD)) ||
 979                                     ((arg & TIOCM_CTS) && (diff & UART_CTS)))
 980                                         return 0;
 981                                 /* otherwise caller can't care less about what
 982                                  * happened, and so we continue to wait for
 983                                  * more events.
 984                                  */
 985                         }
 986                 }
 987                 return 0;
 988         default:
 989                 break;
 990         }
 991         dbg("%s - arg not supported - it was 0x%04x - check include/asm/ioctls.h", __func__, cmd);
 992         return -ENOIOCTLCMD;
 993 } /* cypress_ioctl */
 994
 995
 996 static void cypress_set_termios(struct tty_struct *tty,
 997         struct usb_serial_port *port, struct ktermios *old_termios)
 998 {
 999         struct cypress_private *priv = usb_get_serial_port_data(port);
1000         int data_bits, stop_bits, parity_type, parity_enable;
1001         unsigned cflag, iflag;
1002         unsigned long flags;
1003         __u8 oldlines;
1004         int linechange = 0;
1005
1006         dbg("%s - port %d", __func__, port->number);
1007
1008         spin_lock_irqsave(&priv->lock, flags);
1009         if (!priv->termios_initialized) {
1010                 if (priv->chiptype == CT_EARTHMATE) {
1011                         *(tty->termios) = tty_std_termios;
1012                         tty->termios->c_cflag = B4800 | CS8 | CREAD | HUPCL |
1013                                 CLOCAL;
1014                         tty->termios->c_ispeed = 4800;
1015                         tty->termios->c_ospeed = 4800;
1016                 } else if (priv->chiptype == CT_CYPHIDCOM) {
1017                         *(tty->termios) = tty_std_termios;
1018                         tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
1019                                 CLOCAL;
1020                         tty->termios->c_ispeed = 9600;
1021                         tty->termios->c_ospeed = 9600;
1022                 } else if (priv->chiptype == CT_CA42V2) {
1023                         *(tty->termios) = tty_std_termios;
1024                         tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL |
1025                                 CLOCAL;
1026                         tty->termios->c_ispeed = 9600;
1027                         tty->termios->c_ospeed = 9600;
1028                 }
1029                 priv->termios_initialized = 1;
1030         }
1031         spin_unlock_irqrestore(&priv->lock, flags);
1032
1033         /* Unsupported features need clearing */
1034         tty->termios->c_cflag &= ~(CMSPAR|CRTSCTS);
1035
1036         cflag = tty->termios->c_cflag;
1037         iflag = tty->termios->c_iflag;
1038
1039         /* check if there are new settings */
1040         if (old_termios) {
1041                 spin_lock_irqsave(&priv->lock, flags);
1042                 priv->tmp_termios = *(tty->termios);
1043                 spin_unlock_irqrestore(&priv->lock, flags);
1044         }
1045
1046         /* set number of data bits, parity, stop bits */
1047         /* when parity is disabled the parity type bit is ignored */
1048
1049         /* 1 means 2 stop bits, 0 means 1 stop bit */
1050         stop_bits = cflag & CSTOPB ? 1 : 0;
1051
1052         if (cflag & PARENB) {
1053                 parity_enable = 1;
1054                 /* 1 means odd parity, 0 means even parity */
1055                 parity_type = cflag & PARODD ? 1 : 0;
1056         } else
1057                 parity_enable = parity_type = 0;
1058
1059         switch (cflag & CSIZE) {
1060         case CS5:
1061                 data_bits = 0;
1062                 break;
1063         case CS6:
1064                 data_bits = 1;
1065                 break;
1066         case CS7:
1067                 data_bits = 2;
1068                 break;
1069         case CS8:
1070                 data_bits = 3;
1071                 break;
1072         default:
1073                 dev_err(&port->dev, "%s - CSIZE was set, but not CS5-CS8\n",
1074                         __func__);
1075                 data_bits = 3;
1076         }
1077         spin_lock_irqsave(&priv->lock, flags);
1078         oldlines = priv->line_control;
1079         if ((cflag & CBAUD) == B0) {
1080                 /* drop dtr and rts */
1081                 dbg("%s - dropping the lines, baud rate 0bps", __func__);
1082                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
1083         } else
1084                 priv->line_control = (CONTROL_DTR | CONTROL_RTS);
1085         spin_unlock_irqrestore(&priv->lock, flags);
1086
1087         dbg("%s - sending %d stop_bits, %d parity_enable, %d parity_type, "
1088                         "%d data_bits (+5)", __func__, stop_bits,
1089                         parity_enable, parity_type, data_bits);
1090
1091         cypress_serial_control(tty, port, tty_get_baud_rate(tty),
1092                         data_bits, stop_bits,
1093                         parity_enable, parity_type,
1094                         0, CYPRESS_SET_CONFIG);
1095
1096         /* we perform a CYPRESS_GET_CONFIG so that the current settings are
1097          * filled into the private structure this should confirm that all is
1098          * working if it returns what we just set */
1099         cypress_serial_control(tty, port, 0, 0, 0, 0, 0, 0, CYPRESS_GET_CONFIG);
1100
1101         /* Here we can define custom tty settings for devices; the main tty
1102          * termios flag base comes from empeg.c */
1103
1104         spin_lock_irqsave(&priv->lock, flags);
1105         if (priv->chiptype == CT_EARTHMATE && priv->baud_rate == 4800) {
1106                 dbg("Using custom termios settings for a baud rate of "
1107                                 "4800bps.");
1108                 /* define custom termios settings for NMEA protocol */
1109
1110                 tty->termios->c_iflag /* input modes - */
1111                         &= ~(IGNBRK  /* disable ignore break */
1112                         | BRKINT     /* disable break causes interrupt */
1113                         | PARMRK     /* disable mark parity errors */
1114                         | ISTRIP     /* disable clear high bit of input char */
1115                         | INLCR      /* disable translate NL to CR */
1116                         | IGNCR      /* disable ignore CR */
1117                         | ICRNL      /* disable translate CR to NL */
1118                         | IXON);     /* disable enable XON/XOFF flow control */
1119
1120                 tty->termios->c_oflag /* output modes */
1121                         &= ~OPOST;    /* disable postprocess output char */
1122
1123                 tty->termios->c_lflag /* line discipline modes */
1124                         &= ~(ECHO     /* disable echo input characters */
1125                         | ECHONL      /* disable echo new line */
1126                         | ICANON      /* disable erase, kill, werase, and rprnt
1127                                          special characters */
1128                         | ISIG        /* disable interrupt, quit, and suspend
1129                                          special characters */
1130                         | IEXTEN);    /* disable non-POSIX special characters */
1131         } /* CT_CYPHIDCOM: Application should handle this for device */
1132
1133         linechange = (priv->line_control != oldlines);
1134         spin_unlock_irqrestore(&priv->lock, flags);
1135
1136         /* if necessary, set lines */
1137         if (linechange) {
1138                 priv->cmd_ctrl = 1;
1139                 cypress_write(tty, port, NULL, 0);
1140         }
1141 } /* cypress_set_termios */
1142
1143
1144 /* returns amount of data still left in soft buffer */
1145 static int cypress_chars_in_buffer(struct tty_struct *tty)
1146 {
1147         struct usb_serial_port *port = tty->driver_data;
1148         struct cypress_private *priv = usb_get_serial_port_data(port);
1149         int chars = 0;
1150         unsigned long flags;
1151
1152         dbg("%s - port %d", __func__, port->number);
1153
1154         spin_lock_irqsave(&priv->lock, flags);
1155         chars = cypress_buf_data_avail(priv->buf);
1156         spin_unlock_irqrestore(&priv->lock, flags);
1157
1158         dbg("%s - returns %d", __func__, chars);
1159         return chars;
1160 }
1161
1162
1163 static void cypress_throttle(struct tty_struct *tty)
1164 {
1165         struct usb_serial_port *port = tty->driver_data;
1166         struct cypress_private *priv = usb_get_serial_port_data(port);
1167         unsigned long flags;
1168
1169         dbg("%s - port %d", __func__, port->number);
1170
1171         spin_lock_irqsave(&priv->lock, flags);
1172         priv->rx_flags = THROTTLED;
1173         spin_unlock_irqrestore(&priv->lock, flags);
1174 }
1175
1176
1177 static void cypress_unthrottle(struct tty_struct *tty)
1178 {
1179         struct usb_serial_port *port = tty->driver_data;
1180         struct cypress_private *priv = usb_get_serial_port_data(port);
1181         int actually_throttled, result;
1182         unsigned long flags;
1183
1184         dbg("%s - port %d", __func__, port->number);
1185
1186         spin_lock_irqsave(&priv->lock, flags);
1187         actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
1188         priv->rx_flags = 0;
1189         spin_unlock_irqrestore(&priv->lock, flags);
1190
1191         if (!priv->comm_is_ok)
1192                 return;
1193
1194         if (actually_throttled) {
1195                 port->interrupt_in_urb->dev = port->serial->dev;
1196
1197                 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1198                 if (result) {
1199                         dev_err(&port->dev, "%s - failed submitting read urb, "
1200                                         "error %d\n", __func__, result);
1201                         cypress_set_dead(port);
1202                 }
1203         }
1204 }
1205
1206
1207 static void cypress_read_int_callback(struct urb *urb)
1208 {
1209         struct usb_serial_port *port = urb->context;
1210         struct cypress_private *priv = usb_get_serial_port_data(port);
1211         struct tty_struct *tty;
1212         unsigned char *data = urb->transfer_buffer;
1213         unsigned long flags;
1214         char tty_flag = TTY_NORMAL;
1215         int havedata = 0;
1216         int bytes = 0;
1217         int result;
1218         int i = 0;
1219         int status = urb->status;
1220
1221         dbg("%s - port %d", __func__, port->number);
1222
1223         switch (status) {
1224         case 0: /* success */
1225                 break;
1226         case -ECONNRESET:
1227         case -ENOENT:
1228         case -ESHUTDOWN:
1229                 /* precursor to disconnect so just go away */
1230                 return;
1231         case -EPIPE:
1232                 usb_clear_halt(port->serial->dev, 0x81);
1233                 break;
1234         default:
1235                 /* something ugly is going on... */
1236                 dev_err(&urb->dev->dev,
1237                         "%s - unexpected nonzero read status received: %d\n",
1238                                                         __func__, status);
1239                 cypress_set_dead(port);
1240                 return;
1241         }
1242
1243         spin_lock_irqsave(&priv->lock, flags);
1244         if (priv->rx_flags & THROTTLED) {
1245                 dbg("%s - now throttling", __func__);
1246                 priv->rx_flags |= ACTUALLY_THROTTLED;
1247                 spin_unlock_irqrestore(&priv->lock, flags);
1248                 return;
1249         }
1250         spin_unlock_irqrestore(&priv->lock, flags);
1251
1252         tty = tty_port_tty_get(&port->port);
1253         if (!tty) {
1254                 dbg("%s - bad tty pointer - exiting", __func__);
1255                 return;
1256         }
1257
1258         spin_lock_irqsave(&priv->lock, flags);
1259         result = urb->actual_length;
1260         switch (priv->pkt_fmt) {
1261         default:
1262         case packet_format_1:
1263                 /* This is for the CY7C64013... */
1264                 priv->current_status = data[0] & 0xF8;
1265                 bytes = data[1] + 2;
1266                 i = 2;
1267                 if (bytes > 2)
1268                         havedata = 1;
1269                 break;
1270         case packet_format_2:
1271                 /* This is for the CY7C63743... */
1272                 priv->current_status = data[0] & 0xF8;
1273                 bytes = (data[0] & 0x07) + 1;
1274                 i = 1;
1275                 if (bytes > 1)
1276                         havedata = 1;
1277                 break;
1278         }
1279         spin_unlock_irqrestore(&priv->lock, flags);
1280         if (result < bytes) {
1281                 dbg("%s - wrong packet size - received %d bytes but packet "
1282                     "said %d bytes", __func__, result, bytes);
1283                 goto continue_read;
1284         }
1285
1286         usb_serial_debug_data(debug, &port->dev, __func__,
1287                                                 urb->actual_length, data);
1288
1289         spin_lock_irqsave(&priv->lock, flags);
1290         /* check to see if status has changed */
1291         if (priv->current_status != priv->prev_status) {
1292                 priv->diff_status |= priv->current_status ^
1293                         priv->prev_status;
1294                 wake_up_interruptible(&priv->delta_msr_wait);
1295                 priv->prev_status = priv->current_status;
1296         }
1297         spin_unlock_irqrestore(&priv->lock, flags);
1298
1299         /* hangup, as defined in acm.c... this might be a bad place for it
1300          * though */
1301         if (tty && !(tty->termios->c_cflag & CLOCAL) &&
1302                         !(priv->current_status & UART_CD)) {
1303                 dbg("%s - calling hangup", __func__);
1304                 tty_hangup(tty);
1305                 goto continue_read;
1306         }
1307
1308         /* There is one error bit... I'm assuming it is a parity error
1309          * indicator as the generic firmware will set this bit to 1 if a
1310          * parity error occurs.
1311          * I can not find reference to any other error events. */
1312         spin_lock_irqsave(&priv->lock, flags);
1313         if (priv->current_status & CYP_ERROR) {
1314                 spin_unlock_irqrestore(&priv->lock, flags);
1315                 tty_flag = TTY_PARITY;
1316                 dbg("%s - Parity Error detected", __func__);
1317         } else
1318                 spin_unlock_irqrestore(&priv->lock, flags);
1319
1320         /* process read if there is data other than line status */
1321         if (tty && (bytes > i)) {
1322                 bytes = tty_buffer_request_room(tty, bytes);
1323                 for (; i < bytes ; ++i) {
1324                         dbg("pushing byte number %d - %d - %c", i, data[i],
1325                                         data[i]);
1326                         tty_insert_flip_char(tty, data[i], tty_flag);
1327                 }
1328                 tty_flip_buffer_push(tty);
1329         }
1330
1331         spin_lock_irqsave(&priv->lock, flags);
1332         /* control and status byte(s) are also counted */
1333         priv->bytes_in += bytes;
1334         spin_unlock_irqrestore(&priv->lock, flags);
1335
1336 continue_read:
1337         tty_kref_put(tty);
1338
1339         /* Continue trying to always read... unless the port has closed. */
1340
1341         if (port->port.count > 0 && priv->comm_is_ok) {
1342                 usb_fill_int_urb(port->interrupt_in_urb, port->serial->dev,
1343                                 usb_rcvintpipe(port->serial->dev,
1344                                         port->interrupt_in_endpointAddress),
1345                                 port->interrupt_in_urb->transfer_buffer,
1346                                 port->interrupt_in_urb->transfer_buffer_length,
1347                                 cypress_read_int_callback, port,
1348                                 priv->read_urb_interval);
1349                 result = usb_submit_urb(port->interrupt_in_urb, GFP_ATOMIC);
1350                 if (result) {
1351                         dev_err(&urb->dev->dev, "%s - failed resubmitting "
1352                                         "read urb, error %d\n", __func__,
1353                                         result);
1354                         cypress_set_dead(port);
1355                 }
1356         }
1357
1358         return;
1359 } /* cypress_read_int_callback */
1360
1361
1362 static void cypress_write_int_callback(struct urb *urb)
1363 {
1364         struct usb_serial_port *port = urb->context;
1365         struct cypress_private *priv = usb_get_serial_port_data(port);
1366         int result;
1367         int status = urb->status;
1368
1369         dbg("%s - port %d", __func__, port->number);
1370
1371         switch (status) {
1372         case 0:
1373                 /* success */
1374                 break;
1375         case -ECONNRESET:
1376         case -ENOENT:
1377         case -ESHUTDOWN:
1378                 /* this urb is terminated, clean up */
1379                 dbg("%s - urb shutting down with status: %d",
1380                                                 __func__, status);
1381                 priv->write_urb_in_use = 0;
1382                 return;
1383         case -EPIPE: /* no break needed; clear halt and resubmit */
1384                 if (!priv->comm_is_ok)
1385                         break;
1386                 usb_clear_halt(port->serial->dev, 0x02);
1387                 /* error in the urb, so we have to resubmit it */
1388                 dbg("%s - nonzero write bulk status received: %d",
1389                         __func__, status);
1390                 port->interrupt_out_urb->transfer_buffer_length = 1;
1391                 port->interrupt_out_urb->dev = port->serial->dev;
1392                 result = usb_submit_urb(port->interrupt_out_urb, GFP_ATOMIC);
1393                 if (!result)
1394                         return;
1395                 dev_err(&urb->dev->dev,
1396                         "%s - failed resubmitting write urb, error %d\n",
1397                                                         __func__, result);
1398                 cypress_set_dead(port);
1399                 break;
1400         default:
1401                 dev_err(&urb->dev->dev,
1402                          "%s - unexpected nonzero write status received: %d\n",
1403                                                         __func__, status);
1404                 cypress_set_dead(port);
1405                 break;
1406         }
1407         priv->write_urb_in_use = 0;
1408
1409         /* send any buffered data */
1410         cypress_send(port);
1411 }
1412
1413
1414 /*****************************************************************************
1415  * Write buffer functions - buffering code from pl2303 used
1416  *****************************************************************************/
1417
1418 /*
1419  * cypress_buf_alloc
1420  *
1421  * Allocate a circular buffer and all associated memory.
1422  */
1423
1424 static struct cypress_buf *cypress_buf_alloc(unsigned int size)
1425 {
1426
1427         struct cypress_buf *cb;
1428
1429
1430         if (size == 0)
1431                 return NULL;
1432
1433         cb = kmalloc(sizeof(struct cypress_buf), GFP_KERNEL);
1434         if (cb == NULL)
1435                 return NULL;
1436
1437         cb->buf_buf = kmalloc(size, GFP_KERNEL);
1438         if (cb->buf_buf == NULL) {
1439                 kfree(cb);
1440                 return NULL;
1441         }
1442
1443         cb->buf_size = size;
1444         cb->buf_get = cb->buf_put = cb->buf_buf;
1445
1446         return cb;
1447
1448 }
1449
1450
1451 /*
1452  * cypress_buf_free
1453  *
1454  * Free the buffer and all associated memory.
1455  */
1456
1457 static void cypress_buf_free(struct cypress_buf *cb)
1458 {
1459         if (cb) {
1460                 kfree(cb->buf_buf);
1461                 kfree(cb);
1462         }
1463 }
1464
1465
1466 /*
1467  * cypress_buf_clear
1468  *
1469  * Clear out all data in the circular buffer.
1470  */
1471
1472 static void cypress_buf_clear(struct cypress_buf *cb)
1473 {
1474         if (cb != NULL)
1475                 cb->buf_get = cb->buf_put;
1476                 /* equivalent to a get of all data available */
1477 }
1478
1479
1480 /*
1481  * cypress_buf_data_avail
1482  *
1483  * Return the number of bytes of data available in the circular
1484  * buffer.
1485  */
1486
1487 static unsigned int cypress_buf_data_avail(struct cypress_buf *cb)
1488 {
1489         if (cb != NULL)
1490                 return (cb->buf_size + cb->buf_put - cb->buf_get)
1491                                                         % cb->buf_size;
1492         else
1493                 return 0;
1494 }
1495
1496
1497 /*
1498  * cypress_buf_space_avail
1499  *
1500  * Return the number of bytes of space available in the circular
1501  * buffer.
1502  */
1503
1504 static unsigned int cypress_buf_space_avail(struct cypress_buf *cb)
1505 {
1506         if (cb != NULL)
1507                 return (cb->buf_size + cb->buf_get - cb->buf_put - 1)
1508                                                         % cb->buf_size;
1509         else
1510                 return 0;
1511 }
1512
1513
1514 /*
1515  * cypress_buf_put
1516  *
1517  * Copy data data from a user buffer and put it into the circular buffer.
1518  * Restrict to the amount of space available.
1519  *
1520  * Return the number of bytes copied.
1521  */
1522
1523 static unsigned int cypress_buf_put(struct cypress_buf *cb, const char *buf,
1524         unsigned int count)
1525 {
1526
1527         unsigned int len;
1528
1529
1530         if (cb == NULL)
1531                 return 0;
1532
1533         len  = cypress_buf_space_avail(cb);
1534         if (count > len)
1535                 count = len;
1536
1537         if (count == 0)
1538                 return 0;
1539
1540         len = cb->buf_buf + cb->buf_size - cb->buf_put;
1541         if (count > len) {
1542                 memcpy(cb->buf_put, buf, len);
1543                 memcpy(cb->buf_buf, buf+len, count - len);
1544                 cb->buf_put = cb->buf_buf + count - len;
1545         } else {
1546                 memcpy(cb->buf_put, buf, count);
1547                 if (count < len)
1548                         cb->buf_put += count;
1549                 else /* count == len */
1550                         cb->buf_put = cb->buf_buf;
1551         }
1552
1553         return count;
1554
1555 }
1556
1557
1558 /*
1559  * cypress_buf_get
1560  *
1561  * Get data from the circular buffer and copy to the given buffer.
1562  * Restrict to the amount of data available.
1563  *
1564  * Return the number of bytes copied.
1565  */
1566
1567 static unsigned int cypress_buf_get(struct cypress_buf *cb, char *buf,
1568         unsigned int count)
1569 {
1570
1571         unsigned int len;
1572
1573
1574         if (cb == NULL)
1575                 return 0;
1576
1577         len = cypress_buf_data_avail(cb);
1578         if (count > len)
1579                 count = len;
1580
1581         if (count == 0)
1582                 return 0;
1583
1584         len = cb->buf_buf + cb->buf_size - cb->buf_get;
1585         if (count > len) {
1586                 memcpy(buf, cb->buf_get, len);
1587                 memcpy(buf+len, cb->buf_buf, count - len);
1588                 cb->buf_get = cb->buf_buf + count - len;
1589         } else {
1590                 memcpy(buf, cb->buf_get, count);
1591                 if (count < len)
1592                         cb->buf_get += count;
1593                 else /* count == len */
1594                         cb->buf_get = cb->buf_buf;
1595         }
1596
1597         return count;
1598
1599 }
1600
1601 /*****************************************************************************
1602  * Module functions
1603  *****************************************************************************/
1604
1605 static int __init cypress_init(void)
1606 {
1607         int retval;
1608
1609         dbg("%s", __func__);
1610
1611         retval = usb_serial_register(&cypress_earthmate_device);
1612         if (retval)
1613                 goto failed_em_register;
1614         retval = usb_serial_register(&cypress_hidcom_device);
1615         if (retval)
1616                 goto failed_hidcom_register;
1617         retval = usb_serial_register(&cypress_ca42v2_device);
1618         if (retval)
1619                 goto failed_ca42v2_register;
1620         retval = usb_register(&cypress_driver);
1621         if (retval)
1622                 goto failed_usb_register;
1623
1624         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1625                DRIVER_DESC "\n");
1626         return 0;
1627
1628 failed_usb_register:
1629         usb_serial_deregister(&cypress_ca42v2_device);
1630 failed_ca42v2_register:
1631         usb_serial_deregister(&cypress_hidcom_device);
1632 failed_hidcom_register:
1633         usb_serial_deregister(&cypress_earthmate_device);
1634 failed_em_register:
1635         return retval;
1636 }
1637
1638
1639 static void __exit cypress_exit(void)
1640 {
1641         dbg("%s", __func__);
1642
1643         usb_deregister(&cypress_driver);
1644         usb_serial_deregister(&cypress_earthmate_device);
1645         usb_serial_deregister(&cypress_hidcom_device);
1646         usb_serial_deregister(&cypress_ca42v2_device);
1647 }
1648
1649
1650 module_init(cypress_init);
1651 module_exit(cypress_exit);
1652
1653 MODULE_AUTHOR(DRIVER_AUTHOR);
1654 MODULE_DESCRIPTION(DRIVER_DESC);
1655 MODULE_VERSION(DRIVER_VERSION);
1656 MODULE_LICENSE("GPL");
1657
1658 module_param(debug, bool, S_IRUGO | S_IWUSR);
1659 MODULE_PARM_DESC(debug, "Debug enabled or not");
1660 module_param(stats, bool, S_IRUGO | S_IWUSR);
1661 MODULE_PARM_DESC(stats, "Enable statistics or not");
1662 module_param(interval, int, S_IRUGO | S_IWUSR);
1663 MODULE_PARM_DESC(interval, "Overrides interrupt interval");