SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/usb/serial/pl2303.c

   1 /*
   2  * Prolific PL2303 USB to serial adaptor driver
   3  *
   4  * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com)
   5  * Copyright (C) 2003 IBM Corp.
   6  *
   7  * Original driver for 2.2.x by anonymous
   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 driver
  15  *
  16  * 2002_Mar_26 gkh
  17  *      allowed driver to work properly if there is no tty assigned to a port
  18  *      (this happens for serial console devices.)
  19  *
  20  * 2001_Oct_06 gkh
  21  *      Added RTS and DTR line control.  Thanks to joe@bndlg.de for parts of it.
  22  *
  23  * 2001_Sep_19 gkh
  24  *      Added break support.
  25  *
  26  * 2001_Aug_30 gkh
  27  *      fixed oops in write_bulk_callback.
  28  *
  29  * 2001_Aug_28 gkh
  30  *      reworked buffer logic to be like other usb-serial drivers.  Hopefully
  31  *      removing some reported problems.
  32  *
  33  * 2001_Jun_06 gkh
  34  *      finished porting to 2.4 format.
  35  *
  36  */
  37
  38 #include <linux/config.h>
  39 #include <linux/kernel.h>
  40 #include <linux/errno.h>
  41 #include <linux/init.h>
  42 #include <linux/slab.h>
  43 #include <linux/tty.h>
  44 #include <linux/tty_driver.h>
  45 #include <linux/tty_flip.h>
  46 #include <linux/serial.h>
  47 #include <linux/module.h>
  48 #include <linux/moduleparam.h>
  49 #include <linux/spinlock.h>
  50 #include <asm/uaccess.h>
  51 #include <linux/usb.h>
  52 #include "usb-serial.h"
  53 #include "pl2303.h"
  54
  55 /*
  56  * Version Information
  57  */
  58 #define DRIVER_VERSION "v0.12"
  59 #define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver"
  60
  61 static int debug;
  62
  63 #define PL2303_CLOSING_WAIT     (30*HZ)
  64
  65 #define PL2303_BUF_SIZE         1024
  66 #define PL2303_TMP_BUF_SIZE     1024
  67
  68 static DECLARE_MUTEX(pl2303_tmp_buf_sem);
  69
  70 struct pl2303_buf {
  71         unsigned int    buf_size;
  72         char            *buf_buf;
  73         char            *buf_get;
  74         char            *buf_put;
  75 };
  76
  77 static struct usb_device_id id_table [] = {
  78         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) },
  79         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
  80         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
  81         { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
  82         { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
  83         { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) },
  84         { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
  85         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
  86         { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
  87         { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
  88         { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
  89         { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
  90         { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
  91         { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
  92         { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
  93         { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
  94         { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
  95         { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) },
  96         { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) },
  97         { }                                     /* Terminating entry */
  98 };
  99
 100 MODULE_DEVICE_TABLE (usb, id_table);
 101
 102 static struct usb_driver pl2303_driver = {
 103         .owner =        THIS_MODULE,
 104         .name =         "pl2303",
 105         .probe =        usb_serial_probe,
 106         .disconnect =   usb_serial_disconnect,
 107         .id_table =     id_table,
 108 };
 109
 110 #define SET_LINE_REQUEST_TYPE           0x21
 111 #define SET_LINE_REQUEST                0x20
 112
 113 #define SET_CONTROL_REQUEST_TYPE        0x21
 114 #define SET_CONTROL_REQUEST             0x22
 115 #define CONTROL_DTR                     0x01
 116 #define CONTROL_RTS                     0x02
 117
 118 #define BREAK_REQUEST_TYPE              0x21
 119 #define BREAK_REQUEST                   0x23
 120 #define BREAK_ON                        0xffff
 121 #define BREAK_OFF                       0x0000
 122
 123 #define GET_LINE_REQUEST_TYPE           0xa1
 124 #define GET_LINE_REQUEST                0x21
 125
 126 #define VENDOR_WRITE_REQUEST_TYPE       0x40
 127 #define VENDOR_WRITE_REQUEST            0x01
 128
 129 #define VENDOR_READ_REQUEST_TYPE        0xc0
 130 #define VENDOR_READ_REQUEST             0x01
 131
 132 #define UART_STATE                      0x08
 133 #define UART_STATE_TRANSIENT_MASK       0x74
 134 #define UART_DCD                        0x01
 135 #define UART_DSR                        0x02
 136 #define UART_BREAK_ERROR                0x04
 137 #define UART_RING                       0x08
 138 #define UART_FRAME_ERROR                0x10
 139 #define UART_PARITY_ERROR               0x20
 140 #define UART_OVERRUN_ERROR              0x40
 141 #define UART_CTS                        0x80
 142
 143 /* function prototypes for a PL2303 serial converter */
 144 static int pl2303_open (struct usb_serial_port *port, struct file *filp);
 145 static void pl2303_close (struct usb_serial_port *port, struct file *filp);
 146 static void pl2303_set_termios (struct usb_serial_port *port,
 147                                 struct termios *old);
 148 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file,
 149                          unsigned int cmd, unsigned long arg);
 150 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs);
 151 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs);
 152 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs);
 153 static int pl2303_write (struct usb_serial_port *port,
 154                          const unsigned char *buf, int count);
 155 static void pl2303_send (struct usb_serial_port *port);
 156 static int pl2303_write_room(struct usb_serial_port *port);
 157 static int pl2303_chars_in_buffer(struct usb_serial_port *port);
 158 static void pl2303_break_ctl(struct usb_serial_port *port,int break_state);
 159 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file);
 160 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
 161                             unsigned int set, unsigned int clear);
 162 static int pl2303_startup (struct usb_serial *serial);
 163 static void pl2303_shutdown (struct usb_serial *serial);
 164 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size);
 165 static void pl2303_buf_free(struct pl2303_buf *pb);
 166 static void pl2303_buf_clear(struct pl2303_buf *pb);
 167 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb);
 168 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb);
 169 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
 170         unsigned int count);
 171 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
 172         unsigned int count);
 173
 174
 175 /* All of the device info needed for the PL2303 SIO serial converter */
 176 static struct usb_serial_device_type pl2303_device = {
 177         .owner =                THIS_MODULE,
 178         .name =                 "PL-2303",
 179         .id_table =             id_table,
 180         .num_interrupt_in =     NUM_DONT_CARE,
 181         .num_bulk_in =          1,
 182         .num_bulk_out =         1,
 183         .num_ports =            1,
 184         .open =                 pl2303_open,
 185         .close =                pl2303_close,
 186         .write =                pl2303_write,
 187         .ioctl =                pl2303_ioctl,
 188         .break_ctl =            pl2303_break_ctl,
 189         .set_termios =          pl2303_set_termios,
 190         .tiocmget =             pl2303_tiocmget,
 191         .tiocmset =             pl2303_tiocmset,
 192         .read_bulk_callback =   pl2303_read_bulk_callback,
 193         .read_int_callback =    pl2303_read_int_callback,
 194         .write_bulk_callback =  pl2303_write_bulk_callback,
 195         .write_room =           pl2303_write_room,
 196         .chars_in_buffer =      pl2303_chars_in_buffer,
 197         .attach =               pl2303_startup,
 198         .shutdown =             pl2303_shutdown,
 199 };
 200
 201 enum pl2303_type {
 202         type_0,         /* don't know the difference between type 0 and */
 203         type_1,         /* type 1, until someone from prolific tells us... */
 204         HX,             /* HX version of the pl2303 chip */
 205 };
 206
 207 struct pl2303_private {
 208         spinlock_t lock;
 209         struct pl2303_buf *buf;
 210         int write_urb_in_use;
 211         wait_queue_head_t delta_msr_wait;
 212         u8 line_control;
 213         u8 line_status;
 214         u8 termios_initialized;
 215         enum pl2303_type type;
 216 };
 217
 218
 219 static int pl2303_startup (struct usb_serial *serial)
 220 {
 221         struct pl2303_private *priv;
 222         enum pl2303_type type = type_0;
 223         int i;
 224
 225         if (serial->dev->descriptor.bDeviceClass == 0x02)
 226                 type = type_0;
 227         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 228                 type = HX;
 229         else if (serial->dev->descriptor.bDeviceClass == 0x00)
 230                 type = type_1;
 231         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
 232                 type = type_1;
 233         dbg("device type: %d", type);
 234
 235         for (i = 0; i < serial->num_ports; ++i) {
 236                 priv = kmalloc (sizeof (struct pl2303_private), GFP_KERNEL);
 237                 if (!priv)
 238                         goto cleanup;
 239                 memset (priv, 0x00, sizeof (struct pl2303_private));
 240                 spin_lock_init(&priv->lock);
 241                 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
 242                 if (priv->buf == NULL) {
 243                         kfree(priv);
 244                         goto cleanup;
 245                 }
 246                 init_waitqueue_head(&priv->delta_msr_wait);
 247                 priv->type = type;
 248                 usb_set_serial_port_data(serial->port[i], priv);
 249         }
 250         return 0;
 251
 252 cleanup:
 253         for (--i; i>=0; --i) {
 254                 priv = usb_get_serial_port_data(serial->port[i]);
 255                 pl2303_buf_free(priv->buf);
 256                 kfree(priv);
 257                 usb_set_serial_port_data(serial->port[i], NULL);
 258         }
 259         return -ENOMEM;
 260 }
 261
 262 static int set_control_lines (struct usb_device *dev, u8 value)
 263 {
 264         int retval;
 265
 266         retval = usb_control_msg (dev, usb_sndctrlpipe (dev, 0),
 267                                   SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 268                                   value, 0, NULL, 0, 100);
 269         dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
 270         return retval;
 271 }
 272
 273 static int pl2303_write (struct usb_serial_port *port,  const unsigned char *buf, int count)
 274 {
 275         struct pl2303_private *priv = usb_get_serial_port_data(port);
 276         unsigned long flags;
 277
 278         dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
 279
 280         if (!count)
 281                 return count;
 282
 283         spin_lock_irqsave(&priv->lock, flags);
 284         count = pl2303_buf_put(priv->buf, buf, count);
 285         spin_unlock_irqrestore(&priv->lock, flags);
 286
 287         pl2303_send(port);
 288
 289         return count;
 290 }
 291
 292 static void pl2303_send(struct usb_serial_port *port)
 293 {
 294         int count, result;
 295         struct pl2303_private *priv = usb_get_serial_port_data(port);
 296         unsigned long flags;
 297
 298         dbg("%s - port %d", __FUNCTION__, port->number);
 299
 300         spin_lock_irqsave(&priv->lock, flags);
 301
 302         if (priv->write_urb_in_use) {
 303                 spin_unlock_irqrestore(&priv->lock, flags);
 304                 return;
 305         }
 306
 307         count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
 308                 port->bulk_out_size);
 309
 310         if (count == 0) {
 311                 spin_unlock_irqrestore(&priv->lock, flags);
 312                 return;
 313         }
 314
 315         priv->write_urb_in_use = 1;
 316
 317         spin_unlock_irqrestore(&priv->lock, flags);
 318
 319         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, port->write_urb->transfer_buffer);
 320
 321         port->write_urb->transfer_buffer_length = count;
 322         port->write_urb->dev = port->serial->dev;
 323         result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
 324         if (result) {
 325                 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result);
 326                 priv->write_urb_in_use = 0;
 327                 // TODO: reschedule pl2303_send
 328         }
 329
 330         schedule_work(&port->work);
 331 }
 332
 333 static int pl2303_write_room(struct usb_serial_port *port)
 334 {
 335         struct pl2303_private *priv = usb_get_serial_port_data(port);
 336         int room = 0;
 337         unsigned long flags;
 338
 339         dbg("%s - port %d", __FUNCTION__, port->number);
 340
 341         spin_lock_irqsave(&priv->lock, flags);
 342         room = pl2303_buf_space_avail(priv->buf);
 343         spin_unlock_irqrestore(&priv->lock, flags);
 344
 345         dbg("%s - returns %d", __FUNCTION__, room);
 346         return room;
 347 }
 348
 349 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
 350 {
 351         struct pl2303_private *priv = usb_get_serial_port_data(port);
 352         int chars = 0;
 353         unsigned long flags;
 354
 355         dbg("%s - port %d", __FUNCTION__, port->number);
 356
 357         spin_lock_irqsave(&priv->lock, flags);
 358         chars = pl2303_buf_data_avail(priv->buf);
 359         spin_unlock_irqrestore(&priv->lock, flags);
 360
 361         dbg("%s - returns %d", __FUNCTION__, chars);
 362         return chars;
 363 }
 364
 365 static void pl2303_set_termios (struct usb_serial_port *port, struct termios *old_termios)
 366 {
 367         struct usb_serial *serial = port->serial;
 368         struct pl2303_private *priv = usb_get_serial_port_data(port);
 369         unsigned long flags;
 370         unsigned int cflag;
 371         unsigned char *buf;
 372         int baud;
 373         int i;
 374         u8 control;
 375
 376         dbg("%s -  port %d", __FUNCTION__, port->number);
 377
 378         if ((!port->tty) || (!port->tty->termios)) {
 379                 dbg("%s - no tty structures", __FUNCTION__);
 380                 return;
 381         }
 382
 383         spin_lock_irqsave(&priv->lock, flags);
 384         if (!priv->termios_initialized) {
 385                 *(port->tty->termios) = tty_std_termios;
 386                 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
 387                 priv->termios_initialized = 1;
 388         }
 389         spin_unlock_irqrestore(&priv->lock, flags);
 390
 391         cflag = port->tty->termios->c_cflag;
 392         /* check that they really want us to change something */
 393         if (old_termios) {
 394                 if ((cflag == old_termios->c_cflag) &&
 395                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
 396                     dbg("%s - nothing to change...", __FUNCTION__);
 397                     return;
 398                 }
 399         }
 400
 401         buf = kmalloc (7, GFP_KERNEL);
 402         if (!buf) {
 403                 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
 404                 return;
 405         }
 406         memset (buf, 0x00, 0x07);
 407
 408         i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
 409                              GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 410                              0, 0, buf, 7, 100);
 411         dbg ("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 412              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 413
 414
 415         if (cflag & CSIZE) {
 416                 switch (cflag & CSIZE) {
 417                         case CS5:       buf[6] = 5;     break;
 418                         case CS6:       buf[6] = 6;     break;
 419                         case CS7:       buf[6] = 7;     break;
 420                         default:
 421                         case CS8:       buf[6] = 8;     break;
 422                 }
 423                 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
 424         }
 425
 426         baud = 0;
 427         switch (cflag & CBAUD) {
 428                 case B0:        baud = 0;       break;
 429                 case B75:       baud = 75;      break;
 430                 case B150:      baud = 150;     break;
 431                 case B300:      baud = 300;     break;
 432                 case B600:      baud = 600;     break;
 433                 case B1200:     baud = 1200;    break;
 434                 case B1800:     baud = 1800;    break;
 435                 case B2400:     baud = 2400;    break;
 436                 case B4800:     baud = 4800;    break;
 437                 case B9600:     baud = 9600;    break;
 438                 case B19200:    baud = 19200;   break;
 439                 case B38400:    baud = 38400;   break;
 440                 case B57600:    baud = 57600;   break;
 441                 case B115200:   baud = 115200;  break;
 442                 case B230400:   baud = 230400;  break;
 443                 case B460800:   baud = 460800;  break;
 444                 default:
 445                         dev_err(&port->dev, "pl2303 driver does not support the baudrate requested (fix it)\n");
 446                         break;
 447         }
 448         dbg("%s - baud = %d", __FUNCTION__, baud);
 449         if (baud) {
 450                 buf[0] = baud & 0xff;
 451                 buf[1] = (baud >> 8) & 0xff;
 452                 buf[2] = (baud >> 16) & 0xff;
 453                 buf[3] = (baud >> 24) & 0xff;
 454         }
 455
 456         /* For reference buf[4]=0 is 1 stop bits */
 457         /* For reference buf[4]=1 is 1.5 stop bits */
 458         /* For reference buf[4]=2 is 2 stop bits */
 459         if (cflag & CSTOPB) {
 460                 buf[4] = 2;
 461                 dbg("%s - stop bits = 2", __FUNCTION__);
 462         } else {
 463                 buf[4] = 0;
 464                 dbg("%s - stop bits = 1", __FUNCTION__);
 465         }
 466
 467         if (cflag & PARENB) {
 468                 /* For reference buf[5]=0 is none parity */
 469                 /* For reference buf[5]=1 is odd parity */
 470                 /* For reference buf[5]=2 is even parity */
 471                 /* For reference buf[5]=3 is mark parity */
 472                 /* For reference buf[5]=4 is space parity */
 473                 if (cflag & PARODD) {
 474                         buf[5] = 1;
 475                         dbg("%s - parity = odd", __FUNCTION__);
 476                 } else {
 477                         buf[5] = 2;
 478                         dbg("%s - parity = even", __FUNCTION__);
 479                 }
 480         } else {
 481                 buf[5] = 0;
 482                 dbg("%s - parity = none", __FUNCTION__);
 483         }
 484
 485         i = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
 486                              SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 487                              0, 0, buf, 7, 100);
 488         dbg ("0x21:0x20:0:0  %d", i);
 489
 490         /* change control lines if we are switching to or from B0 */
 491         spin_lock_irqsave(&priv->lock, flags);
 492         control = priv->line_control;
 493         if ((cflag & CBAUD) == B0)
 494                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 495         else
 496                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 497         if (control != priv->line_control) {
 498                 control = priv->line_control;
 499                 spin_unlock_irqrestore(&priv->lock, flags);
 500                 set_control_lines(serial->dev, control);
 501         } else {
 502                 spin_unlock_irqrestore(&priv->lock, flags);
 503         }
 504
 505         buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
 506
 507         i = usb_control_msg (serial->dev, usb_rcvctrlpipe (serial->dev, 0),
 508                              GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 509                              0, 0, buf, 7, 100);
 510         dbg ("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 511              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 512
 513         if (cflag & CRTSCTS) {
 514                 __u16 index;
 515                 if (priv->type == HX)
 516                         index = 0x61;
 517                 else
 518                         index = 0x41;
 519                 i = usb_control_msg(serial->dev,
 520                                     usb_sndctrlpipe(serial->dev, 0),
 521                                     VENDOR_WRITE_REQUEST,
 522                                     VENDOR_WRITE_REQUEST_TYPE,
 523                                     0x0, index, NULL, 0, 100);
 524                 dbg ("0x40:0x1:0x0:0x%x  %d", index, i);
 525         }
 526
 527         kfree (buf);
 528 }
 529
 530 static int pl2303_open (struct usb_serial_port *port, struct file *filp)
 531 {
 532         struct termios tmp_termios;
 533         struct usb_serial *serial = port->serial;
 534         struct pl2303_private *priv = usb_get_serial_port_data(port);
 535         unsigned char *buf;
 536         int result;
 537
 538         dbg("%s -  port %d", __FUNCTION__, port->number);
 539
 540         usb_clear_halt(serial->dev, port->write_urb->pipe);
 541         usb_clear_halt(serial->dev, port->read_urb->pipe);
 542
 543         buf = kmalloc(10, GFP_KERNEL);
 544         if (buf==NULL)
 545                 return -ENOMEM;
 546
 547 #define FISH(a,b,c,d)                                                           \
 548         result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0),     \
 549                                b, a, c, d, buf, 1, 100);                        \
 550         dbg("0x%x:0x%x:0x%x:0x%x  %d - %x",a,b,c,d,result,buf[0]);
 551
 552 #define SOUP(a,b,c,d)                                                           \
 553         result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0),     \
 554                                b, a, c, d, NULL, 0, 100);                       \
 555         dbg("0x%x:0x%x:0x%x:0x%x  %d",a,b,c,d,result);
 556
 557         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 558         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
 559         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 560         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 561         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 562         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
 563         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 564         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 565         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
 566         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
 567
 568         if (priv->type == HX) {
 569                 /* HX chip */
 570                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
 571                 /* reset upstream data pipes */
 572                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
 573                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
 574         } else {
 575                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
 576         }
 577
 578         kfree(buf);
 579
 580         /* Setup termios */
 581         if (port->tty) {
 582                 pl2303_set_termios (port, &tmp_termios);
 583         }
 584
 585         //FIXME: need to assert RTS and DTR if CRTSCTS off
 586
 587         dbg("%s - submitting read urb", __FUNCTION__);
 588         port->read_urb->dev = serial->dev;
 589         result = usb_submit_urb (port->read_urb, GFP_KERNEL);
 590         if (result) {
 591                 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result);
 592                 pl2303_close (port, NULL);
 593                 return -EPROTO;
 594         }
 595
 596         dbg("%s - submitting interrupt urb", __FUNCTION__);
 597         port->interrupt_in_urb->dev = serial->dev;
 598         result = usb_submit_urb (port->interrupt_in_urb, GFP_KERNEL);
 599         if (result) {
 600                 dev_err(&port->dev, "%s - failed submitting interrupt urb, error %d\n", __FUNCTION__, result);
 601                 pl2303_close (port, NULL);
 602                 return -EPROTO;
 603         }
 604         return 0;
 605 }
 606
 607
 608 static void pl2303_close (struct usb_serial_port *port, struct file *filp)
 609 {
 610         struct pl2303_private *priv = usb_get_serial_port_data(port);
 611         unsigned long flags;
 612         unsigned int c_cflag;
 613         int bps;
 614         long timeout;
 615         wait_queue_t wait;                                              \
 616
 617         dbg("%s - port %d", __FUNCTION__, port->number);
 618
 619         /* wait for data to drain from the buffer */
 620         spin_lock_irqsave(&priv->lock, flags);
 621         timeout = PL2303_CLOSING_WAIT;
 622         init_waitqueue_entry(&wait, current);
 623         add_wait_queue(&port->tty->write_wait, &wait);
 624         for (;;) {
 625                 set_current_state(TASK_INTERRUPTIBLE);
 626                 if (pl2303_buf_data_avail(priv->buf) == 0
 627                 || timeout == 0 || signal_pending(current)
 628                 || !usb_get_intfdata(port->serial->interface))  /* disconnect */
 629                         break;
 630                 spin_unlock_irqrestore(&priv->lock, flags);
 631                 timeout = schedule_timeout(timeout);
 632                 spin_lock_irqsave(&priv->lock, flags);
 633         }
 634         set_current_state(TASK_RUNNING);
 635         remove_wait_queue(&port->tty->write_wait, &wait);
 636         /* clear out any remaining data in the buffer */
 637         pl2303_buf_clear(priv->buf);
 638         spin_unlock_irqrestore(&priv->lock, flags);
 639
 640         /* wait for characters to drain from the device */
 641         /* (this is long enough for the entire 256 byte */
 642         /* pl2303 hardware buffer to drain with no flow */
 643         /* control for data rates of 1200 bps or more, */
 644         /* for lower rates we should really know how much */
 645         /* data is in the buffer to compute a delay */
 646         /* that is not unnecessarily long) */
 647         bps = tty_get_baud_rate(port->tty);
 648         if (bps > 1200)
 649                 timeout = max((HZ*2560)/bps,HZ/10);
 650         else
 651                 timeout = 2*HZ;
 652         set_current_state(TASK_INTERRUPTIBLE);
 653         schedule_timeout(timeout);
 654
 655         /* shutdown our urbs */
 656         dbg("%s - shutting down urbs", __FUNCTION__);
 657         usb_kill_urb(port->write_urb);
 658         usb_kill_urb(port->read_urb);
 659         usb_kill_urb(port->interrupt_in_urb);
 660
 661         if (port->tty) {
 662                 c_cflag = port->tty->termios->c_cflag;
 663                 if (c_cflag & HUPCL) {
 664                         /* drop DTR and RTS */
 665                         spin_lock_irqsave(&priv->lock, flags);
 666                         priv->line_control = 0;
 667                         spin_unlock_irqrestore (&priv->lock, flags);
 668                         set_control_lines (port->serial->dev, 0);
 669                 }
 670         }
 671 }
 672
 673 static int pl2303_tiocmset (struct usb_serial_port *port, struct file *file,
 674                             unsigned int set, unsigned int clear)
 675 {
 676         struct pl2303_private *priv = usb_get_serial_port_data(port);
 677         unsigned long flags;
 678         u8 control;
 679
 680         spin_lock_irqsave (&priv->lock, flags);
 681         if (set & TIOCM_RTS)
 682                 priv->line_control |= CONTROL_RTS;
 683         if (set & TIOCM_DTR)
 684                 priv->line_control |= CONTROL_DTR;
 685         if (clear & TIOCM_RTS)
 686                 priv->line_control &= ~CONTROL_RTS;
 687         if (clear & TIOCM_DTR)
 688                 priv->line_control &= ~CONTROL_DTR;
 689         control = priv->line_control;
 690         spin_unlock_irqrestore (&priv->lock, flags);
 691
 692         return set_control_lines (port->serial->dev, control);
 693 }
 694
 695 static int pl2303_tiocmget (struct usb_serial_port *port, struct file *file)
 696 {
 697         struct pl2303_private *priv = usb_get_serial_port_data(port);
 698         unsigned long flags;
 699         unsigned int mcr;
 700         unsigned int status;
 701         unsigned int result;
 702
 703         dbg("%s (%d)", __FUNCTION__, port->number);
 704
 705         spin_lock_irqsave (&priv->lock, flags);
 706         mcr = priv->line_control;
 707         status = priv->line_status;
 708         spin_unlock_irqrestore (&priv->lock, flags);
 709
 710         result = ((mcr & CONTROL_DTR)           ? TIOCM_DTR : 0)
 711                   | ((mcr & CONTROL_RTS)        ? TIOCM_RTS : 0)
 712                   | ((status & UART_CTS)        ? TIOCM_CTS : 0)
 713                   | ((status & UART_DSR)        ? TIOCM_DSR : 0)
 714                   | ((status & UART_RING)       ? TIOCM_RI  : 0)
 715                   | ((status & UART_DCD)        ? TIOCM_CD  : 0);
 716
 717         dbg("%s - result = %x", __FUNCTION__, result);
 718
 719         return result;
 720 }
 721
 722 static int wait_modem_info(struct usb_serial_port *port, unsigned int arg)
 723 {
 724         struct pl2303_private *priv = usb_get_serial_port_data(port);
 725         unsigned long flags;
 726         unsigned int prevstatus;
 727         unsigned int status;
 728         unsigned int changed;
 729
 730         spin_lock_irqsave (&priv->lock, flags);
 731         prevstatus = priv->line_status;
 732         spin_unlock_irqrestore (&priv->lock, flags);
 733
 734         while (1) {
 735                 interruptible_sleep_on(&priv->delta_msr_wait);
 736                 /* see if a signal did it */
 737                 if (signal_pending(current))
 738                         return -ERESTARTSYS;
 739
 740                 spin_lock_irqsave (&priv->lock, flags);
 741                 status = priv->line_status;
 742                 spin_unlock_irqrestore (&priv->lock, flags);
 743
 744                 changed=prevstatus^status;
 745
 746                 if (((arg & TIOCM_RNG) && (changed & UART_RING)) ||
 747                     ((arg & TIOCM_DSR) && (changed & UART_DSR)) ||
 748                     ((arg & TIOCM_CD)  && (changed & UART_DCD)) ||
 749                     ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) {
 750                         return 0;
 751                 }
 752                 prevstatus = status;
 753         }
 754         /* NOTREACHED */
 755         return 0;
 756 }
 757
 758 static int pl2303_ioctl (struct usb_serial_port *port, struct file *file, unsigned int cmd, unsigned long arg)
 759 {
 760         dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd);
 761
 762         switch (cmd) {
 763                 case TIOCMIWAIT:
 764                         dbg("%s (%d) TIOCMIWAIT", __FUNCTION__,  port->number);
 765                         return wait_modem_info(port, arg);
 766
 767                 default:
 768                         dbg("%s not supported = 0x%04x", __FUNCTION__, cmd);
 769                         break;
 770         }
 771
 772         return -ENOIOCTLCMD;
 773 }
 774
 775 static void pl2303_break_ctl (struct usb_serial_port *port, int break_state)
 776 {
 777         struct usb_serial *serial = port->serial;
 778         u16 state;
 779         int result;
 780
 781         dbg("%s - port %d", __FUNCTION__, port->number);
 782
 783         if (break_state == 0)
 784                 state = BREAK_OFF;
 785         else
 786                 state = BREAK_ON;
 787         dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on");
 788
 789         result = usb_control_msg (serial->dev, usb_sndctrlpipe (serial->dev, 0),
 790                                   BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
 791                                   0, NULL, 0, 100);
 792         if (result)
 793                 dbg("%s - error sending break = %d", __FUNCTION__, result);
 794 }
 795
 796
 797 static void pl2303_shutdown (struct usb_serial *serial)
 798 {
 799         int i;
 800         struct pl2303_private *priv;
 801
 802         dbg("%s", __FUNCTION__);
 803
 804         for (i = 0; i < serial->num_ports; ++i) {
 805                 priv = usb_get_serial_port_data(serial->port[i]);
 806                 if (priv) {
 807                         pl2303_buf_free(priv->buf);
 808                         kfree(priv);
 809                         usb_set_serial_port_data(serial->port[i], NULL);
 810                 }
 811         }
 812 }
 813
 814
 815 static void pl2303_read_int_callback (struct urb *urb, struct pt_regs *regs)
 816 {
 817         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 818         struct pl2303_private *priv = usb_get_serial_port_data(port);
 819         unsigned char *data = urb->transfer_buffer;
 820         unsigned long flags;
 821         int status;
 822         u8 uart_state;
 823
 824         dbg("%s (%d)", __FUNCTION__, port->number);
 825
 826         switch (urb->status) {
 827         case 0:
 828                 /* success */
 829                 break;
 830         case -ECONNRESET:
 831         case -ENOENT:
 832         case -ESHUTDOWN:
 833                 /* this urb is terminated, clean up */
 834                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 835                 return;
 836         default:
 837                 dbg("%s - nonzero urb status received: %d", __FUNCTION__, urb->status);
 838                 goto exit;
 839         }
 840
 841
 842         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
 843
 844         if (urb->actual_length < UART_STATE)
 845                 goto exit;
 846
 847         /* Save off the uart status for others to look at */
 848         uart_state = data[UART_STATE];
 849         spin_lock_irqsave(&priv->lock, flags);
 850         uart_state |= (priv->line_status & UART_STATE_TRANSIENT_MASK);
 851         priv->line_status = uart_state;
 852         spin_unlock_irqrestore(&priv->lock, flags);
 853
 854 exit:
 855         status = usb_submit_urb (urb, GFP_ATOMIC);
 856         if (status)
 857                 dev_err(&urb->dev->dev, "%s - usb_submit_urb failed with result %d\n",
 858                         __FUNCTION__, status);
 859 }
 860
 861
 862 static void pl2303_read_bulk_callback (struct urb *urb, struct pt_regs *regs)
 863 {
 864         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 865         struct pl2303_private *priv = usb_get_serial_port_data(port);
 866         struct tty_struct *tty;
 867         unsigned char *data = urb->transfer_buffer;
 868         unsigned long flags;
 869         int i;
 870         int result;
 871         u8 status;
 872         char tty_flag;
 873
 874         dbg("%s - port %d", __FUNCTION__, port->number);
 875
 876         if (urb->status) {
 877                 dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
 878                 if (!port->open_count) {
 879                         dbg("%s - port is closed, exiting.", __FUNCTION__);
 880                         return;
 881                 }
 882                 if (urb->status == -EPROTO) {
 883                         /* PL2303 mysteriously fails with -EPROTO reschedule the read */
 884                         dbg("%s - caught -EPROTO, resubmitting the urb", __FUNCTION__);
 885                         urb->status = 0;
 886                         urb->dev = port->serial->dev;
 887                         result = usb_submit_urb(urb, GFP_ATOMIC);
 888                         if (result)
 889                                 dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
 890                         return;
 891                 }
 892                 dbg("%s - unable to handle the error, exiting.", __FUNCTION__);
 893                 return;
 894         }
 895
 896         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
 897
 898         /* get tty_flag from status */
 899         tty_flag = TTY_NORMAL;
 900
 901         spin_lock_irqsave(&priv->lock, flags);
 902         status = priv->line_status;
 903         priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
 904         spin_unlock_irqrestore(&priv->lock, flags);
 905         wake_up_interruptible (&priv->delta_msr_wait);
 906
 907         /* break takes precedence over parity, */
 908         /* which takes precedence over framing errors */
 909         if (status & UART_BREAK_ERROR )
 910                 tty_flag = TTY_BREAK;
 911         else if (status & UART_PARITY_ERROR)
 912                 tty_flag = TTY_PARITY;
 913         else if (status & UART_FRAME_ERROR)
 914                 tty_flag = TTY_FRAME;
 915         dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag);
 916
 917         tty = port->tty;
 918         if (tty && urb->actual_length) {
 919                 /* overrun is special, not associated with a char */
 920                 if (status & UART_OVERRUN_ERROR)
 921                         tty_insert_flip_char(tty, 0, TTY_OVERRUN);
 922
 923                 for (i = 0; i < urb->actual_length; ++i) {
 924                         if (tty->flip.count >= TTY_FLIPBUF_SIZE) {
 925                                 tty_flip_buffer_push(tty);
 926                         }
 927                         tty_insert_flip_char (tty, data[i], tty_flag);
 928                 }
 929                 tty_flip_buffer_push (tty);
 930         }
 931
 932         /* Schedule the next read _if_ we are still open */
 933         if (port->open_count) {
 934                 urb->dev = port->serial->dev;
 935                 result = usb_submit_urb(urb, GFP_ATOMIC);
 936                 if (result)
 937                         dev_err(&urb->dev->dev, "%s - failed resubmitting read urb, error %d\n", __FUNCTION__, result);
 938         }
 939
 940         return;
 941 }
 942
 943
 944
 945 static void pl2303_write_bulk_callback (struct urb *urb, struct pt_regs *regs)
 946 {
 947         struct usb_serial_port *port = (struct usb_serial_port *) urb->context;
 948         struct pl2303_private *priv = usb_get_serial_port_data(port);
 949         int result;
 950
 951         dbg("%s - port %d", __FUNCTION__, port->number);
 952
 953         switch (urb->status) {
 954         case 0:
 955                 /* success */
 956                 break;
 957         case -ECONNRESET:
 958         case -ENOENT:
 959         case -ESHUTDOWN:
 960                 /* this urb is terminated, clean up */
 961                 dbg("%s - urb shutting down with status: %d", __FUNCTION__, urb->status);
 962                 priv->write_urb_in_use = 0;
 963                 return;
 964         default:
 965                 /* error in the urb, so we have to resubmit it */
 966                 dbg("%s - Overflow in write", __FUNCTION__);
 967                 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
 968                 port->write_urb->transfer_buffer_length = 1;
 969                 port->write_urb->dev = port->serial->dev;
 970                 result = usb_submit_urb (port->write_urb, GFP_ATOMIC);
 971                 if (result)
 972                         dev_err(&urb->dev->dev, "%s - failed resubmitting write urb, error %d\n", __FUNCTION__, result);
 973                 else
 974                         return;
 975         }
 976
 977         priv->write_urb_in_use = 0;
 978
 979         /* send any buffered data */
 980         pl2303_send(port);
 981 }
 982
 983
 984 /*
 985  * pl2303_buf_alloc
 986  *
 987  * Allocate a circular buffer and all associated memory.
 988  */
 989
 990 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
 991 {
 992
 993         struct pl2303_buf *pb;
 994
 995
 996         if (size == 0)
 997                 return NULL;
 998
 999         pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
1000         if (pb == NULL)
1001                 return NULL;
1002
1003         pb->buf_buf = kmalloc(size, GFP_KERNEL);
1004         if (pb->buf_buf == NULL) {
1005                 kfree(pb);
1006                 return NULL;
1007         }
1008
1009         pb->buf_size = size;
1010         pb->buf_get = pb->buf_put = pb->buf_buf;
1011
1012         return pb;
1013
1014 }
1015
1016
1017 /*
1018  * pl2303_buf_free
1019  *
1020  * Free the buffer and all associated memory.
1021  */
1022
1023 static void pl2303_buf_free(struct pl2303_buf *pb)
1024 {
1025         if (pb != NULL) {
1026                 if (pb->buf_buf != NULL)
1027                         kfree(pb->buf_buf);
1028                 kfree(pb);
1029         }
1030 }
1031
1032
1033 /*
1034  * pl2303_buf_clear
1035  *
1036  * Clear out all data in the circular buffer.
1037  */
1038
1039 static void pl2303_buf_clear(struct pl2303_buf *pb)
1040 {
1041         if (pb != NULL)
1042                 pb->buf_get = pb->buf_put;
1043                 /* equivalent to a get of all data available */
1044 }
1045
1046
1047 /*
1048  * pl2303_buf_data_avail
1049  *
1050  * Return the number of bytes of data available in the circular
1051  * buffer.
1052  */
1053
1054 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
1055 {
1056         if (pb != NULL)
1057                 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
1058         else
1059                 return 0;
1060 }
1061
1062
1063 /*
1064  * pl2303_buf_space_avail
1065  *
1066  * Return the number of bytes of space available in the circular
1067  * buffer.
1068  */
1069
1070 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
1071 {
1072         if (pb != NULL)
1073                 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
1074         else
1075                 return 0;
1076 }
1077
1078
1079 /*
1080  * pl2303_buf_put
1081  *
1082  * Copy data data from a user buffer and put it into the circular buffer.
1083  * Restrict to the amount of space available.
1084  *
1085  * Return the number of bytes copied.
1086  */
1087
1088 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
1089         unsigned int count)
1090 {
1091
1092         unsigned int len;
1093
1094
1095         if (pb == NULL)
1096                 return 0;
1097
1098         len  = pl2303_buf_space_avail(pb);
1099         if (count > len)
1100                 count = len;
1101
1102         if (count == 0)
1103                 return 0;
1104
1105         len = pb->buf_buf + pb->buf_size - pb->buf_put;
1106         if (count > len) {
1107                 memcpy(pb->buf_put, buf, len);
1108                 memcpy(pb->buf_buf, buf+len, count - len);
1109                 pb->buf_put = pb->buf_buf + count - len;
1110         } else {
1111                 memcpy(pb->buf_put, buf, count);
1112                 if (count < len)
1113                         pb->buf_put += count;
1114                 else /* count == len */
1115                         pb->buf_put = pb->buf_buf;
1116         }
1117
1118         return count;
1119
1120 }
1121
1122
1123 /*
1124  * pl2303_buf_get
1125  *
1126  * Get data from the circular buffer and copy to the given buffer.
1127  * Restrict to the amount of data available.
1128  *
1129  * Return the number of bytes copied.
1130  */
1131
1132 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
1133         unsigned int count)
1134 {
1135
1136         unsigned int len;
1137
1138
1139         if (pb == NULL)
1140                 return 0;
1141
1142         len = pl2303_buf_data_avail(pb);
1143         if (count > len)
1144                 count = len;
1145
1146         if (count == 0)
1147                 return 0;
1148
1149         len = pb->buf_buf + pb->buf_size - pb->buf_get;
1150         if (count > len) {
1151                 memcpy(buf, pb->buf_get, len);
1152                 memcpy(buf+len, pb->buf_buf, count - len);
1153                 pb->buf_get = pb->buf_buf + count - len;
1154         } else {
1155                 memcpy(buf, pb->buf_get, count);
1156                 if (count < len)
1157                         pb->buf_get += count;
1158                 else /* count == len */
1159                         pb->buf_get = pb->buf_buf;
1160         }
1161
1162         return count;
1163
1164 }
1165
1166 static int __init pl2303_init (void)
1167 {
1168         int retval;
1169         retval = usb_serial_register(&pl2303_device);
1170         if (retval)
1171                 goto failed_usb_serial_register;
1172         retval = usb_register(&pl2303_driver);
1173         if (retval)
1174                 goto failed_usb_register;
1175         info(DRIVER_DESC " " DRIVER_VERSION);
1176         return 0;
1177 failed_usb_register:
1178         usb_serial_deregister(&pl2303_device);
1179 failed_usb_serial_register:
1180         return retval;
1181 }
1182
1183
1184 static void __exit pl2303_exit (void)
1185 {
1186         usb_deregister (&pl2303_driver);
1187         usb_serial_deregister (&pl2303_device);
1188 }
1189
1190
1191 module_init(pl2303_init);
1192 module_exit(pl2303_exit);
1193
1194 MODULE_DESCRIPTION(DRIVER_DESC);
1195 MODULE_VERSION(DRIVER_VERSION);
1196 MODULE_LICENSE("GPL");
1197
1198 module_param(debug, bool, S_IRUGO | S_IWUSR);
1199 MODULE_PARM_DESC(debug, "Debug enabled or not");
1200