USB: kl5usb105: minor clean ups
[linux-2.6.git] / drivers / usb / serial / kl5kusb105.c
1 /*
2  * KLSI KL5KUSB105 chip RS232 converter driver
3  *
4  *   Copyright (C) 2001 Utz-Uwe Haus <haus@uuhaus.de>
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  * All information about the device was acquired using SniffUSB ans snoopUSB
12  * on Windows98.
13  * It was written out of frustration with the PalmConnect USB Serial adapter
14  * sold by Palm Inc.
15  * Neither Palm, nor their contractor (MCCI) or their supplier (KLSI) provided
16  * information that was not already available.
17  *
18  * It seems that KLSI bought some silicon-design information from ScanLogic,
19  * whose SL11R processor is at the core of the KL5KUSB chipset from KLSI.
20  * KLSI has firmware available for their devices; it is probable that the
21  * firmware differs from that used by KLSI in their products. If you have an
22  * original KLSI device and can provide some information on it, I would be
23  * most interested in adding support for it here. If you have any information
24  * on the protocol used (or find errors in my reverse-engineered stuff), please
25  * let me know.
26  *
27  * The code was only tested with a PalmConnect USB adapter; if you
28  * are adventurous, try it with any KLSI-based device and let me know how it
29  * breaks so that I can fix it!
30  */
31
32 /* TODO:
33  *      check modem line signals
34  *      implement handshaking or decide that we do not support it
35  */
36
37 /* History:
38  *   0.3a - implemented pools of write URBs
39  *   0.3  - alpha version for public testing
40  *   0.2  - TIOCMGET works, so autopilot(1) can be used!
41  *   0.1  - can be used to do pilot-xfer -p /dev/ttyUSB0 -l
42  *
43  *   The driver skeleton is mainly based on mct_u232.c and various other
44  *   pieces of code shamelessly copied from the drivers/usb/serial/ directory.
45  */
46
47
48 #include <linux/kernel.h>
49 #include <linux/errno.h>
50 #include <linux/init.h>
51 #include <linux/slab.h>
52 #include <linux/tty.h>
53 #include <linux/tty_driver.h>
54 #include <linux/tty_flip.h>
55 #include <linux/module.h>
56 #include <linux/uaccess.h>
57 #include <asm/unaligned.h>
58 #include <linux/usb.h>
59 #include <linux/usb/serial.h>
60 #include "kl5kusb105.h"
61
62 static int debug;
63
64 /*
65  * Version Information
66  */
67 #define DRIVER_VERSION "v0.3a"
68 #define DRIVER_AUTHOR "Utz-Uwe Haus <haus@uuhaus.de>"
69 #define DRIVER_DESC "KLSI KL5KUSB105 chipset USB->Serial Converter driver"
70
71
72 /*
73  * Function prototypes
74  */
75 static int  klsi_105_startup(struct usb_serial *serial);
76 static void klsi_105_disconnect(struct usb_serial *serial);
77 static void klsi_105_release(struct usb_serial *serial);
78 static int  klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port);
79 static void klsi_105_close(struct usb_serial_port *port);
80 static int  klsi_105_write(struct tty_struct *tty,
81         struct usb_serial_port *port, const unsigned char *buf, int count);
82 static void klsi_105_write_bulk_callback(struct urb *urb);
83 static int  klsi_105_chars_in_buffer(struct tty_struct *tty);
84 static int  klsi_105_write_room(struct tty_struct *tty);
85 static void klsi_105_read_bulk_callback(struct urb *urb);
86 static void klsi_105_set_termios(struct tty_struct *tty,
87                         struct usb_serial_port *port, struct ktermios *old);
88 static void klsi_105_throttle(struct tty_struct *tty);
89 static void klsi_105_unthrottle(struct tty_struct *tty);
90 static int  klsi_105_tiocmget(struct tty_struct *tty, struct file *file);
91 static int  klsi_105_tiocmset(struct tty_struct *tty, struct file *file,
92                         unsigned int set, unsigned int clear);
93
94 /*
95  * All of the device info needed for the KLSI converters.
96  */
97 static const struct usb_device_id id_table[] = {
98         { USB_DEVICE(PALMCONNECT_VID, PALMCONNECT_PID) },
99         { USB_DEVICE(KLSI_VID, KLSI_KL5KUSB105D_PID) },
100         { }             /* Terminating entry */
101 };
102
103 MODULE_DEVICE_TABLE(usb, id_table);
104
105 static struct usb_driver kl5kusb105d_driver = {
106         .name =         "kl5kusb105d",
107         .probe =        usb_serial_probe,
108         .disconnect =   usb_serial_disconnect,
109         .id_table =     id_table,
110         .no_dynamic_id =        1,
111 };
112
113 static struct usb_serial_driver kl5kusb105d_device = {
114         .driver = {
115                 .owner =        THIS_MODULE,
116                 .name =         "kl5kusb105d",
117         },
118         .description =          "KL5KUSB105D / PalmConnect",
119         .usb_driver =           &kl5kusb105d_driver,
120         .id_table =             id_table,
121         .num_ports =            1,
122         .open =                 klsi_105_open,
123         .close =                klsi_105_close,
124         .write =                klsi_105_write,
125         .write_bulk_callback =  klsi_105_write_bulk_callback,
126         .chars_in_buffer =      klsi_105_chars_in_buffer,
127         .write_room =           klsi_105_write_room,
128         .read_bulk_callback =   klsi_105_read_bulk_callback,
129         .set_termios =          klsi_105_set_termios,
130         /*.break_ctl =          klsi_105_break_ctl,*/
131         .tiocmget =             klsi_105_tiocmget,
132         .tiocmset =             klsi_105_tiocmset,
133         .attach =               klsi_105_startup,
134         .disconnect =           klsi_105_disconnect,
135         .release =              klsi_105_release,
136         .throttle =             klsi_105_throttle,
137         .unthrottle =           klsi_105_unthrottle,
138 };
139
140 struct klsi_105_port_settings {
141         __u8    pktlen;         /* always 5, it seems */
142         __u8    baudrate;
143         __u8    databits;
144         __u8    unknown1;
145         __u8    unknown2;
146 } __attribute__ ((packed));
147
148 /* we implement a pool of NUM_URBS urbs per usb_serial */
149 #define NUM_URBS                        1
150 #define URB_TRANSFER_BUFFER_SIZE        64
151 struct klsi_105_private {
152         struct klsi_105_port_settings   cfg;
153         struct ktermios                 termios;
154         unsigned long                   line_state; /* modem line settings */
155         /* write pool */
156         struct urb                      *write_urb_pool[NUM_URBS];
157         spinlock_t                      lock;
158         unsigned long                   bytes_in;
159         unsigned long                   bytes_out;
160 };
161
162
163 /*
164  * Handle vendor specific USB requests
165  */
166
167
168 #define KLSI_TIMEOUT     5000 /* default urb timeout */
169
170 static int klsi_105_chg_port_settings(struct usb_serial_port *port,
171                                       struct klsi_105_port_settings *settings)
172 {
173         int rc;
174
175         rc = usb_control_msg(port->serial->dev,
176                         usb_sndctrlpipe(port->serial->dev, 0),
177                         KL5KUSB105A_SIO_SET_DATA,
178                         USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_INTERFACE,
179                         0, /* value */
180                         0, /* index */
181                         settings,
182                         sizeof(struct klsi_105_port_settings),
183                         KLSI_TIMEOUT);
184         if (rc < 0)
185                 dev_err(&port->dev,
186                         "Change port settings failed (error = %d)\n", rc);
187         dev_info(&port->serial->dev->dev,
188                  "%d byte block, baudrate %x, databits %d, u1 %d, u2 %d\n",
189                  settings->pktlen, settings->baudrate, settings->databits,
190                  settings->unknown1, settings->unknown2);
191         return rc;
192 }
193
194 /* translate a 16-bit status value from the device to linux's TIO bits */
195 static unsigned long klsi_105_status2linestate(const __u16 status)
196 {
197         unsigned long res = 0;
198
199         res =   ((status & KL5KUSB105A_DSR) ? TIOCM_DSR : 0)
200               | ((status & KL5KUSB105A_CTS) ? TIOCM_CTS : 0)
201               ;
202
203         return res;
204 }
205
206 /*
207  * Read line control via vendor command and return result through
208  * *line_state_p
209  */
210 /* It seems that the status buffer has always only 2 bytes length */
211 #define KLSI_STATUSBUF_LEN      2
212 static int klsi_105_get_line_state(struct usb_serial_port *port,
213                                    unsigned long *line_state_p)
214 {
215         int rc;
216         u8 *status_buf;
217         __u16 status;
218
219         dev_info(&port->serial->dev->dev, "sending SIO Poll request\n");
220
221         status_buf = kmalloc(KLSI_STATUSBUF_LEN, GFP_KERNEL);
222         if (!status_buf) {
223                 dev_err(&port->dev, "%s - out of memory for status buffer.\n",
224                                 __func__);
225                 return -ENOMEM;
226         }
227         status_buf[0] = 0xff;
228         status_buf[1] = 0xff;
229         rc = usb_control_msg(port->serial->dev,
230                              usb_rcvctrlpipe(port->serial->dev, 0),
231                              KL5KUSB105A_SIO_POLL,
232                              USB_TYPE_VENDOR | USB_DIR_IN,
233                              0, /* value */
234                              0, /* index */
235                              status_buf, KLSI_STATUSBUF_LEN,
236                              10000
237                              );
238         if (rc < 0)
239                 dev_err(&port->dev, "Reading line status failed (error = %d)\n",
240                         rc);
241         else {
242                 status = get_unaligned_le16(status_buf);
243
244                 dev_info(&port->serial->dev->dev, "read status %x %x",
245                          status_buf[0], status_buf[1]);
246
247                 *line_state_p = klsi_105_status2linestate(status);
248         }
249
250         kfree(status_buf);
251         return rc;
252 }
253
254
255 /*
256  * Driver's tty interface functions
257  */
258
259 static int klsi_105_startup(struct usb_serial *serial)
260 {
261         struct klsi_105_private *priv;
262         int i, j;
263
264         /* check if we support the product id (see keyspan.c)
265          * FIXME
266          */
267
268         /* allocate the private data structure */
269         for (i = 0; i < serial->num_ports; i++) {
270                 priv = kmalloc(sizeof(struct klsi_105_private),
271                                                    GFP_KERNEL);
272                 if (!priv) {
273                         dbg("%skmalloc for klsi_105_private failed.", __func__);
274                         i--;
275                         goto err_cleanup;
276                 }
277                 /* set initial values for control structures */
278                 priv->cfg.pktlen    = 5;
279                 priv->cfg.baudrate  = kl5kusb105a_sio_b9600;
280                 priv->cfg.databits  = kl5kusb105a_dtb_8;
281                 priv->cfg.unknown1  = 0;
282                 priv->cfg.unknown2  = 1;
283
284                 priv->line_state    = 0;
285
286                 priv->bytes_in      = 0;
287                 priv->bytes_out     = 0;
288                 usb_set_serial_port_data(serial->port[i], priv);
289
290                 spin_lock_init(&priv->lock);
291                 for (j = 0; j < NUM_URBS; j++) {
292                         struct urb *urb = usb_alloc_urb(0, GFP_KERNEL);
293
294                         priv->write_urb_pool[j] = urb;
295                         if (urb == NULL) {
296                                 dev_err(&serial->dev->dev, "No more urbs???\n");
297                                 goto err_cleanup;
298                         }
299
300                         urb->transfer_buffer =
301                                 kmalloc(URB_TRANSFER_BUFFER_SIZE, GFP_KERNEL);
302                         if (!urb->transfer_buffer) {
303                                 dev_err(&serial->dev->dev,
304                                         "%s - out of memory for urb buffers.\n",
305                                         __func__);
306                                 goto err_cleanup;
307                         }
308                 }
309
310                 /* priv->termios is left uninitalized until port opening */
311                 init_waitqueue_head(&serial->port[i]->write_wait);
312         }
313
314         return 0;
315
316 err_cleanup:
317         for (; i >= 0; i--) {
318                 priv = usb_get_serial_port_data(serial->port[i]);
319                 for (j = 0; j < NUM_URBS; j++) {
320                         if (priv->write_urb_pool[j]) {
321                                 kfree(priv->write_urb_pool[j]->transfer_buffer);
322                                 usb_free_urb(priv->write_urb_pool[j]);
323                         }
324                 }
325                 kfree(priv);
326                 usb_set_serial_port_data(serial->port[i], NULL);
327         }
328         return -ENOMEM;
329 }
330
331 static void klsi_105_disconnect(struct usb_serial *serial)
332 {
333         int i;
334
335         dbg("%s", __func__);
336
337         /* stop reads and writes on all ports */
338         for (i = 0; i < serial->num_ports; ++i) {
339                 struct klsi_105_private *priv =
340                                 usb_get_serial_port_data(serial->port[i]);
341
342                 if (priv) {
343                         /* kill our write urb pool */
344                         int j;
345                         struct urb **write_urbs = priv->write_urb_pool;
346
347                         for (j = 0; j < NUM_URBS; j++) {
348                                 if (write_urbs[j]) {
349                                         usb_kill_urb(write_urbs[j]);
350                                         usb_free_urb(write_urbs[j]);
351                                 }
352                         }
353                 }
354         }
355 }
356
357 static void klsi_105_release(struct usb_serial *serial)
358 {
359         int i;
360
361         dbg("%s", __func__);
362
363         for (i = 0; i < serial->num_ports; ++i) {
364                 struct klsi_105_private *priv =
365                                 usb_get_serial_port_data(serial->port[i]);
366
367                 kfree(priv);
368         }
369 }
370
371 static int  klsi_105_open(struct tty_struct *tty, struct usb_serial_port *port)
372 {
373         struct klsi_105_private *priv = usb_get_serial_port_data(port);
374         int retval = 0;
375         int rc;
376         int i;
377         unsigned long line_state;
378         struct klsi_105_port_settings *cfg;
379         unsigned long flags;
380
381         dbg("%s port %d", __func__, port->number);
382
383         /* Do a defined restart:
384          * Set up sane default baud rate and send the 'READ_ON'
385          * vendor command.
386          * FIXME: set modem line control (how?)
387          * Then read the modem line control and store values in
388          * priv->line_state.
389          */
390         cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
391         if (!cfg) {
392                 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
393                                 __func__);
394                 return -ENOMEM;
395         }
396         cfg->pktlen   = 5;
397         cfg->baudrate = kl5kusb105a_sio_b9600;
398         cfg->databits = kl5kusb105a_dtb_8;
399         cfg->unknown1 = 0;
400         cfg->unknown2 = 1;
401         klsi_105_chg_port_settings(port, cfg);
402
403         /* set up termios structure */
404         spin_lock_irqsave(&priv->lock, flags);
405         priv->termios.c_iflag = tty->termios->c_iflag;
406         priv->termios.c_oflag = tty->termios->c_oflag;
407         priv->termios.c_cflag = tty->termios->c_cflag;
408         priv->termios.c_lflag = tty->termios->c_lflag;
409         for (i = 0; i < NCCS; i++)
410                 priv->termios.c_cc[i] = tty->termios->c_cc[i];
411         priv->cfg.pktlen   = cfg->pktlen;
412         priv->cfg.baudrate = cfg->baudrate;
413         priv->cfg.databits = cfg->databits;
414         priv->cfg.unknown1 = cfg->unknown1;
415         priv->cfg.unknown2 = cfg->unknown2;
416         spin_unlock_irqrestore(&priv->lock, flags);
417
418         /* READ_ON and urb submission */
419         usb_fill_bulk_urb(port->read_urb, port->serial->dev,
420                       usb_rcvbulkpipe(port->serial->dev,
421                                       port->bulk_in_endpointAddress),
422                       port->read_urb->transfer_buffer,
423                       port->read_urb->transfer_buffer_length,
424                       klsi_105_read_bulk_callback,
425                       port);
426
427         rc = usb_submit_urb(port->read_urb, GFP_KERNEL);
428         if (rc) {
429                 dev_err(&port->dev, "%s - failed submitting read urb, "
430                         "error %d\n", __func__, rc);
431                 retval = rc;
432                 goto exit;
433         }
434
435         rc = usb_control_msg(port->serial->dev,
436                              usb_sndctrlpipe(port->serial->dev, 0),
437                              KL5KUSB105A_SIO_CONFIGURE,
438                              USB_TYPE_VENDOR|USB_DIR_OUT|USB_RECIP_INTERFACE,
439                              KL5KUSB105A_SIO_CONFIGURE_READ_ON,
440                              0, /* index */
441                              NULL,
442                              0,
443                              KLSI_TIMEOUT);
444         if (rc < 0) {
445                 dev_err(&port->dev, "Enabling read failed (error = %d)\n", rc);
446                 retval = rc;
447         } else
448                 dbg("%s - enabled reading", __func__);
449
450         rc = klsi_105_get_line_state(port, &line_state);
451         if (rc >= 0) {
452                 spin_lock_irqsave(&priv->lock, flags);
453                 priv->line_state = line_state;
454                 spin_unlock_irqrestore(&priv->lock, flags);
455                 dbg("%s - read line state 0x%lx", __func__, line_state);
456                 retval = 0;
457         } else
458                 retval = rc;
459
460 exit:
461         kfree(cfg);
462         return retval;
463 }
464
465 static void klsi_105_close(struct usb_serial_port *port)
466 {
467         struct klsi_105_private *priv = usb_get_serial_port_data(port);
468         int rc;
469
470         dbg("%s port %d", __func__, port->number);
471
472         mutex_lock(&port->serial->disc_mutex);
473         if (!port->serial->disconnected) {
474                 /* send READ_OFF */
475                 rc = usb_control_msg(port->serial->dev,
476                                      usb_sndctrlpipe(port->serial->dev, 0),
477                                      KL5KUSB105A_SIO_CONFIGURE,
478                                      USB_TYPE_VENDOR | USB_DIR_OUT,
479                                      KL5KUSB105A_SIO_CONFIGURE_READ_OFF,
480                                      0, /* index */
481                                      NULL, 0,
482                                      KLSI_TIMEOUT);
483                 if (rc < 0)
484                         dev_err(&port->dev,
485                                 "Disabling read failed (error = %d)\n", rc);
486         }
487         mutex_unlock(&port->serial->disc_mutex);
488
489         /* shutdown our bulk reads and writes */
490         usb_kill_urb(port->write_urb);
491         usb_kill_urb(port->read_urb);
492         /* unlink our write pool */
493         /* FIXME */
494         /* wgg - do I need this? I think so. */
495         usb_kill_urb(port->interrupt_in_urb);
496         dev_info(&port->serial->dev->dev,
497                  "port stats: %ld bytes in, %ld bytes out\n",
498                  priv->bytes_in, priv->bytes_out);
499 }
500
501 /* We need to write a complete 64-byte data block and encode the
502  * number actually sent in the first double-byte, LSB-order. That
503  * leaves at most 62 bytes of payload.
504  */
505 #define KLSI_105_DATA_OFFSET    2   /* in the bulk urb data block */
506
507 static int klsi_105_write(struct tty_struct *tty,
508         struct usb_serial_port *port, const unsigned char *buf, int count)
509 {
510         struct klsi_105_private *priv = usb_get_serial_port_data(port);
511         int result, size;
512         int bytes_sent = 0;
513
514         dbg("%s - port %d", __func__, port->number);
515
516         while (count > 0) {
517                 /* try to find a free urb (write 0 bytes if none) */
518                 struct urb *urb = NULL;
519                 unsigned long flags;
520                 int i;
521                 /* since the pool is per-port we might not need
522                    the spin lock !? */
523                 spin_lock_irqsave(&priv->lock, flags);
524                 for (i = 0; i < NUM_URBS; i++) {
525                         if (priv->write_urb_pool[i]->status != -EINPROGRESS) {
526                                 urb = priv->write_urb_pool[i];
527                                 dbg("%s - using pool URB %d", __func__, i);
528                                 break;
529                         }
530                 }
531                 spin_unlock_irqrestore(&priv->lock, flags);
532
533                 if (urb == NULL) {
534                         dbg("%s - no more free urbs", __func__);
535                         goto exit;
536                 }
537
538                 if (urb->transfer_buffer == NULL) {
539                         urb->transfer_buffer =
540                                 kmalloc(URB_TRANSFER_BUFFER_SIZE, GFP_ATOMIC);
541                         if (urb->transfer_buffer == NULL) {
542                                 dev_err(&port->dev,
543                                         "%s - no more kernel memory...\n",
544                                         __func__);
545                                 goto exit;
546                         }
547                 }
548
549                 size = min(count, port->bulk_out_size - KLSI_105_DATA_OFFSET);
550                 size = min(size, URB_TRANSFER_BUFFER_SIZE -
551                                                         KLSI_105_DATA_OFFSET);
552
553                 memcpy(urb->transfer_buffer + KLSI_105_DATA_OFFSET, buf, size);
554
555                 /* write payload size into transfer buffer */
556                 ((__u8 *)urb->transfer_buffer)[0] = (__u8) (size & 0xFF);
557                 ((__u8 *)urb->transfer_buffer)[1] = (__u8) ((size & 0xFF00)>>8);
558
559                 /* set up our urb */
560                 usb_fill_bulk_urb(urb, port->serial->dev,
561                               usb_sndbulkpipe(port->serial->dev,
562                                               port->bulk_out_endpointAddress),
563                               urb->transfer_buffer,
564                               URB_TRANSFER_BUFFER_SIZE,
565                               klsi_105_write_bulk_callback,
566                               port);
567
568                 /* send the data out the bulk port */
569                 result = usb_submit_urb(urb, GFP_ATOMIC);
570                 if (result) {
571                         dev_err(&port->dev,
572                                 "%s - failed submitting write urb, error %d\n",
573                                 __func__, result);
574                         goto exit;
575                 }
576                 buf += size;
577                 bytes_sent += size;
578                 count -= size;
579         }
580 exit:
581         /* lockless, but it's for debug info only... */
582         priv->bytes_out += bytes_sent;
583
584         return bytes_sent;      /* that's how much we wrote */
585 }
586
587 static void klsi_105_write_bulk_callback(struct urb *urb)
588 {
589         struct usb_serial_port *port = urb->context;
590         int status = urb->status;
591
592         dbg("%s - port %d", __func__, port->number);
593
594         if (status) {
595                 dbg("%s - nonzero write bulk status received: %d", __func__,
596                     status);
597                 return;
598         }
599
600         usb_serial_port_softint(port);
601 }
602
603 /* return number of characters currently in the writing process */
604 static int klsi_105_chars_in_buffer(struct tty_struct *tty)
605 {
606         struct usb_serial_port *port = tty->driver_data;
607         int chars = 0;
608         int i;
609         unsigned long flags;
610         struct klsi_105_private *priv = usb_get_serial_port_data(port);
611
612         spin_lock_irqsave(&priv->lock, flags);
613
614         for (i = 0; i < NUM_URBS; ++i) {
615                 if (priv->write_urb_pool[i]->status == -EINPROGRESS)
616                         chars += URB_TRANSFER_BUFFER_SIZE;
617         }
618
619         spin_unlock_irqrestore(&priv->lock, flags);
620
621         dbg("%s - returns %d", __func__, chars);
622         return chars;
623 }
624
625 static int klsi_105_write_room(struct tty_struct *tty)
626 {
627         struct usb_serial_port *port = tty->driver_data;
628         unsigned long flags;
629         int i;
630         int room = 0;
631         struct klsi_105_private *priv = usb_get_serial_port_data(port);
632
633         spin_lock_irqsave(&priv->lock, flags);
634         for (i = 0; i < NUM_URBS; ++i) {
635                 if (priv->write_urb_pool[i]->status != -EINPROGRESS)
636                         room += URB_TRANSFER_BUFFER_SIZE;
637         }
638
639         spin_unlock_irqrestore(&priv->lock, flags);
640
641         dbg("%s - returns %d", __func__, room);
642         return room;
643 }
644
645 static void klsi_105_read_bulk_callback(struct urb *urb)
646 {
647         struct usb_serial_port *port = urb->context;
648         struct klsi_105_private *priv = usb_get_serial_port_data(port);
649         struct tty_struct *tty;
650         unsigned char *data = urb->transfer_buffer;
651         int rc;
652         int status = urb->status;
653
654         dbg("%s - port %d", __func__, port->number);
655
656         /* The urb might have been killed. */
657         if (status) {
658                 dbg("%s - nonzero read bulk status received: %d", __func__,
659                     status);
660                 return;
661         }
662
663         /* The data received is again preceded by a length double-byte in LSB-
664          * first order (see klsi_105_write() )
665          */
666         if (urb->actual_length == 0) {
667                 /* empty urbs seem to happen, we ignore them */
668                 /* dbg("%s - emtpy URB", __func__); */
669                ;
670         } else if (urb->actual_length <= 2) {
671                 dbg("%s - size %d URB not understood", __func__,
672                     urb->actual_length);
673                 usb_serial_debug_data(debug, &port->dev, __func__,
674                                       urb->actual_length, data);
675         } else {
676                 int bytes_sent = ((__u8 *) data)[0] +
677                                  ((unsigned int) ((__u8 *) data)[1] << 8);
678                 tty = tty_port_tty_get(&port->port);
679                 /* we should immediately resubmit the URB, before attempting
680                  * to pass the data on to the tty layer. But that needs locking
681                  * against re-entry an then mixed-up data because of
682                  * intermixed tty_flip_buffer_push()s
683                  * FIXME
684                  */
685                 usb_serial_debug_data(debug, &port->dev, __func__,
686                                       urb->actual_length, data);
687
688                 if (bytes_sent + 2 > urb->actual_length) {
689                         dbg("%s - trying to read more data than available"
690                             " (%d vs. %d)", __func__,
691                             bytes_sent+2, urb->actual_length);
692                         /* cap at implied limit */
693                         bytes_sent = urb->actual_length - 2;
694                 }
695
696                 tty_insert_flip_string(tty, data + 2, bytes_sent);
697                 tty_flip_buffer_push(tty);
698                 tty_kref_put(tty);
699
700                 /* again lockless, but debug info only */
701                 priv->bytes_in += bytes_sent;
702         }
703         /* Continue trying to always read  */
704         usb_fill_bulk_urb(port->read_urb, port->serial->dev,
705                       usb_rcvbulkpipe(port->serial->dev,
706                                       port->bulk_in_endpointAddress),
707                       port->read_urb->transfer_buffer,
708                       port->read_urb->transfer_buffer_length,
709                       klsi_105_read_bulk_callback,
710                       port);
711         rc = usb_submit_urb(port->read_urb, GFP_ATOMIC);
712         if (rc)
713                 dev_err(&port->dev,
714                         "%s - failed resubmitting read urb, error %d\n",
715                         __func__, rc);
716 }
717
718 static void klsi_105_set_termios(struct tty_struct *tty,
719                                  struct usb_serial_port *port,
720                                  struct ktermios *old_termios)
721 {
722         struct klsi_105_private *priv = usb_get_serial_port_data(port);
723         unsigned int iflag = tty->termios->c_iflag;
724         unsigned int old_iflag = old_termios->c_iflag;
725         unsigned int cflag = tty->termios->c_cflag;
726         unsigned int old_cflag = old_termios->c_cflag;
727         struct klsi_105_port_settings *cfg;
728         unsigned long flags;
729         speed_t baud;
730
731         cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
732         if (!cfg) {
733                 dev_err(&port->dev, "%s - out of memory for config buffer.\n",
734                                 __func__);
735                 return;
736         }
737
738         /* lock while we are modifying the settings */
739         spin_lock_irqsave(&priv->lock, flags);
740
741         /*
742          * Update baud rate
743          */
744         baud = tty_get_baud_rate(tty);
745
746         if ((cflag & CBAUD) != (old_cflag & CBAUD)) {
747                 /* reassert DTR and (maybe) RTS on transition from B0 */
748                 if ((old_cflag & CBAUD) == B0) {
749                         dbg("%s: baud was B0", __func__);
750 #if 0
751                         priv->control_state |= TIOCM_DTR;
752                         /* don't set RTS if using hardware flow control */
753                         if (!(old_cflag & CRTSCTS))
754                                 priv->control_state |= TIOCM_RTS;
755                         mct_u232_set_modem_ctrl(serial, priv->control_state);
756 #endif
757                 }
758         }
759         switch (baud) {
760         case 0: /* handled below */
761                 break;
762         case 1200:
763                 priv->cfg.baudrate = kl5kusb105a_sio_b1200;
764                 break;
765         case 2400:
766                 priv->cfg.baudrate = kl5kusb105a_sio_b2400;
767                 break;
768         case 4800:
769                 priv->cfg.baudrate = kl5kusb105a_sio_b4800;
770                 break;
771         case 9600:
772                 priv->cfg.baudrate = kl5kusb105a_sio_b9600;
773                 break;
774         case 19200:
775                 priv->cfg.baudrate = kl5kusb105a_sio_b19200;
776                 break;
777         case 38400:
778                 priv->cfg.baudrate = kl5kusb105a_sio_b38400;
779                 break;
780         case 57600:
781                 priv->cfg.baudrate = kl5kusb105a_sio_b57600;
782                 break;
783         case 115200:
784                 priv->cfg.baudrate = kl5kusb105a_sio_b115200;
785                 break;
786         default:
787                 dbg("KLSI USB->Serial converter:"
788                     " unsupported baudrate request, using default of 9600");
789                         priv->cfg.baudrate = kl5kusb105a_sio_b9600;
790                 baud = 9600;
791                 break;
792         }
793         if ((cflag & CBAUD) == B0) {
794                 dbg("%s: baud is B0", __func__);
795                 /* Drop RTS and DTR */
796                 /* maybe this should be simulated by sending read
797                  * disable and read enable messages?
798                  */
799                 ;
800 #if 0
801                 priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
802                 mct_u232_set_modem_ctrl(serial, priv->control_state);
803 #endif
804         }
805         tty_encode_baud_rate(tty, baud, baud);
806
807         if ((cflag & CSIZE) != (old_cflag & CSIZE)) {
808                 /* set the number of data bits */
809                 switch (cflag & CSIZE) {
810                 case CS5:
811                         dbg("%s - 5 bits/byte not supported", __func__);
812                         spin_unlock_irqrestore(&priv->lock, flags);
813                         goto err;
814                 case CS6:
815                         dbg("%s - 6 bits/byte not supported", __func__);
816                         spin_unlock_irqrestore(&priv->lock, flags);
817                         goto err;
818                 case CS7:
819                         priv->cfg.databits = kl5kusb105a_dtb_7;
820                         break;
821                 case CS8:
822                         priv->cfg.databits = kl5kusb105a_dtb_8;
823                         break;
824                 default:
825                         dev_err(&port->dev,
826                                 "CSIZE was not CS5-CS8, using default of 8\n");
827                         priv->cfg.databits = kl5kusb105a_dtb_8;
828                         break;
829                 }
830         }
831
832         /*
833          * Update line control register (LCR)
834          */
835         if ((cflag & (PARENB|PARODD)) != (old_cflag & (PARENB|PARODD))
836             || (cflag & CSTOPB) != (old_cflag & CSTOPB)) {
837                 /* Not currently supported */
838                 tty->termios->c_cflag &= ~(PARENB|PARODD|CSTOPB);
839 #if 0
840                 priv->last_lcr = 0;
841
842                 /* set the parity */
843                 if (cflag & PARENB)
844                         priv->last_lcr |= (cflag & PARODD) ?
845                                 MCT_U232_PARITY_ODD : MCT_U232_PARITY_EVEN;
846                 else
847                         priv->last_lcr |= MCT_U232_PARITY_NONE;
848
849                 /* set the number of stop bits */
850                 priv->last_lcr |= (cflag & CSTOPB) ?
851                         MCT_U232_STOP_BITS_2 : MCT_U232_STOP_BITS_1;
852
853                 mct_u232_set_line_ctrl(serial, priv->last_lcr);
854 #endif
855                 ;
856         }
857         /*
858          * Set flow control: well, I do not really now how to handle DTR/RTS.
859          * Just do what we have seen with SniffUSB on Win98.
860          */
861         if ((iflag & IXOFF) != (old_iflag & IXOFF)
862             || (iflag & IXON) != (old_iflag & IXON)
863             ||  (cflag & CRTSCTS) != (old_cflag & CRTSCTS)) {
864                 /* Not currently supported */
865                 tty->termios->c_cflag &= ~CRTSCTS;
866                 /* Drop DTR/RTS if no flow control otherwise assert */
867 #if 0
868                 if ((iflag & IXOFF) || (iflag & IXON) || (cflag & CRTSCTS))
869                         priv->control_state |= TIOCM_DTR | TIOCM_RTS;
870                 else
871                         priv->control_state &= ~(TIOCM_DTR | TIOCM_RTS);
872                 mct_u232_set_modem_ctrl(serial, priv->control_state);
873 #endif
874                 ;
875         }
876         memcpy(cfg, &priv->cfg, sizeof(*cfg));
877         spin_unlock_irqrestore(&priv->lock, flags);
878
879         /* now commit changes to device */
880         klsi_105_chg_port_settings(port, cfg);
881 err:
882         kfree(cfg);
883 }
884
885 #if 0
886 static void mct_u232_break_ctl(struct tty_struct *tty, int break_state)
887 {
888         struct usb_serial_port *port = tty->driver_data;
889         struct usb_serial *serial = port->serial;
890         struct mct_u232_private *priv =
891                                 (struct mct_u232_private *)port->private;
892         unsigned char lcr = priv->last_lcr;
893
894         dbg("%sstate=%d", __func__, break_state);
895
896         /* LOCKING */
897         if (break_state)
898                 lcr |= MCT_U232_SET_BREAK;
899
900         mct_u232_set_line_ctrl(serial, lcr);
901 }
902 #endif
903
904 static int klsi_105_tiocmget(struct tty_struct *tty, struct file *file)
905 {
906         struct usb_serial_port *port = tty->driver_data;
907         struct klsi_105_private *priv = usb_get_serial_port_data(port);
908         unsigned long flags;
909         int rc;
910         unsigned long line_state;
911         dbg("%s - request, just guessing", __func__);
912
913         rc = klsi_105_get_line_state(port, &line_state);
914         if (rc < 0) {
915                 dev_err(&port->dev,
916                         "Reading line control failed (error = %d)\n", rc);
917                 /* better return value? EAGAIN? */
918                 return rc;
919         }
920
921         spin_lock_irqsave(&priv->lock, flags);
922         priv->line_state = line_state;
923         spin_unlock_irqrestore(&priv->lock, flags);
924         dbg("%s - read line state 0x%lx", __func__, line_state);
925         return (int)line_state;
926 }
927
928 static int klsi_105_tiocmset(struct tty_struct *tty, struct file *file,
929                              unsigned int set, unsigned int clear)
930 {
931         int retval = -EINVAL;
932
933         dbg("%s", __func__);
934
935 /* if this ever gets implemented, it should be done something like this:
936         struct usb_serial *serial = port->serial;
937         struct klsi_105_private *priv = usb_get_serial_port_data(port);
938         unsigned long flags;
939         int control;
940
941         spin_lock_irqsave (&priv->lock, flags);
942         if (set & TIOCM_RTS)
943                 priv->control_state |= TIOCM_RTS;
944         if (set & TIOCM_DTR)
945                 priv->control_state |= TIOCM_DTR;
946         if (clear & TIOCM_RTS)
947                 priv->control_state &= ~TIOCM_RTS;
948         if (clear & TIOCM_DTR)
949                 priv->control_state &= ~TIOCM_DTR;
950         control = priv->control_state;
951         spin_unlock_irqrestore (&priv->lock, flags);
952         retval = mct_u232_set_modem_ctrl(serial, control);
953 */
954         return retval;
955 }
956
957 static void klsi_105_throttle(struct tty_struct *tty)
958 {
959         struct usb_serial_port *port = tty->driver_data;
960         dbg("%s - port %d", __func__, port->number);
961         usb_kill_urb(port->read_urb);
962 }
963
964 static void klsi_105_unthrottle(struct tty_struct *tty)
965 {
966         struct usb_serial_port *port = tty->driver_data;
967         int result;
968
969         dbg("%s - port %d", __func__, port->number);
970
971         port->read_urb->dev = port->serial->dev;
972         result = usb_submit_urb(port->read_urb, GFP_KERNEL);
973         if (result)
974                 dev_err(&port->dev,
975                         "%s - failed submitting read urb, error %d\n",
976                         __func__, result);
977 }
978
979
980 static int __init klsi_105_init(void)
981 {
982         int retval;
983         retval = usb_serial_register(&kl5kusb105d_device);
984         if (retval)
985                 goto failed_usb_serial_register;
986         retval = usb_register(&kl5kusb105d_driver);
987         if (retval)
988                 goto failed_usb_register;
989
990         printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
991                DRIVER_DESC "\n");
992         return 0;
993 failed_usb_register:
994         usb_serial_deregister(&kl5kusb105d_device);
995 failed_usb_serial_register:
996         return retval;
997 }
998
999 static void __exit klsi_105_exit(void)
1000 {
1001         usb_deregister(&kl5kusb105d_driver);
1002         usb_serial_deregister(&kl5kusb105d_device);
1003 }
1004
1005
1006 module_init(klsi_105_init);
1007 module_exit(klsi_105_exit);
1008
1009 MODULE_AUTHOR(DRIVER_AUTHOR);
1010 MODULE_DESCRIPTION(DRIVER_DESC);
1011 MODULE_LICENSE("GPL");
1012
1013
1014 module_param(debug, bool, S_IRUGO | S_IWUSR);
1015 MODULE_PARM_DESC(debug, "enable extensive debugging messages");