3 * Controls the Moschip 7720 usb to dual port serial convertor
5 * Copyright 2006 Moschip Semiconductor Tech. Ltd.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, version 2 of the License.
12 * Vijaya Kumar <vijaykumar.gn@gmail.com>
13 * Ajay Kumar <naanuajay@yahoo.com>
14 * Gurudeva <ngurudeva@yahoo.com>
16 * Cleaned up from the original by:
17 * Greg Kroah-Hartman <gregkh@suse.de>
19 * Originally based on drivers/usb/serial/io_edgeport.c which is:
20 * Copyright (C) 2000 Inside Out Networks, All rights reserved.
21 * Copyright (C) 2001-2002 Greg Kroah-Hartman <greg@kroah.com>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/slab.h>
27 #include <linux/tty.h>
28 #include <linux/tty_driver.h>
29 #include <linux/tty_flip.h>
30 #include <linux/module.h>
31 #include <linux/spinlock.h>
32 #include <linux/serial.h>
33 #include <linux/serial_reg.h>
34 #include <linux/usb.h>
35 #include <linux/usb/serial.h>
36 #include <linux/uaccess.h>
42 #define DRIVER_VERSION "1.0.0.4F"
43 #define DRIVER_AUTHOR "Aspire Communications pvt Ltd."
44 #define DRIVER_DESC "Moschip USB Serial Driver"
46 /* default urb timeout */
47 #define MOS_WDR_TIMEOUT (HZ * 5)
49 #define MOS_PORT1 0x0200
50 #define MOS_PORT2 0x0300
51 #define MOS_VENREG 0x0000
52 #define MOS_MAX_PORT 0x02
53 #define MOS_WRITE 0x0E
56 /* Interrupt Rotinue Defines */
57 #define SERIAL_IIR_RLS 0x06
58 #define SERIAL_IIR_RDA 0x04
59 #define SERIAL_IIR_CTI 0x0c
60 #define SERIAL_IIR_THR 0x02
61 #define SERIAL_IIR_MS 0x00
63 #define NUM_URBS 16 /* URB Count */
64 #define URB_TRANSFER_BUFFER_SIZE 32 /* URB Size */
66 /* This structure holds all of the local port information */
68 __u8 shadowLCR; /* last LCR value received */
69 __u8 shadowMCR; /* last MCR value received */
70 __u8 shadowMSR; /* last MSR value received */
72 struct async_icount icount;
73 struct usb_serial_port *port; /* loop back to the owner */
74 struct urb *write_urb_pool[NUM_URBS];
77 /* This structure holds all of the individual serial device information */
78 struct moschip_serial {
79 int interrupt_started;
84 #define USB_VENDOR_ID_MOSCHIP 0x9710
85 #define MOSCHIP_DEVICE_ID_7720 0x7720
86 #define MOSCHIP_DEVICE_ID_7715 0x7715
88 static struct usb_device_id moschip_port_id_table [] = {
89 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7720) },
90 { } /* terminating entry */
92 MODULE_DEVICE_TABLE(usb, moschip_port_id_table);
96 * mos7720_interrupt_callback
97 * this is the callback function for when we have received data on the
100 static void mos7720_interrupt_callback(struct urb *urb)
104 int status = urb->status;
109 dbg("%s", " : Entering\n");
118 /* this urb is terminated, clean up */
119 dbg("%s - urb shutting down with status: %d", __func__,
123 dbg("%s - nonzero urb status received: %d", __func__,
128 length = urb->actual_length;
129 data = urb->transfer_buffer;
131 /* Moschip get 4 bytes
132 * Byte 1 IIR Port 1 (port.number is 0)
133 * Byte 2 IIR Port 2 (port.number is 1)
134 * Byte 3 --------------
135 * Byte 4 FIFO status for both */
137 /* the above description is inverted
138 * oneukum 2007-03-14 */
140 if (unlikely(length != 4)) {
141 dbg("Wrong data !!!");
148 if ((sp1 | sp2) & 0x01) {
149 /* No Interrupt Pending in both the ports */
150 dbg("No Interrupt !!!");
152 switch (sp1 & 0x0f) {
154 dbg("Serial Port 1: Receiver status error or address "
155 "bit detected in 9-bit mode\n");
158 dbg("Serial Port 1: Receiver time out");
161 dbg("Serial Port 1: Modem status change");
165 switch (sp2 & 0x0f) {
167 dbg("Serial Port 2: Receiver status error or address "
168 "bit detected in 9-bit mode");
171 dbg("Serial Port 2: Receiver time out");
174 dbg("Serial Port 2: Modem status change");
180 result = usb_submit_urb(urb, GFP_ATOMIC);
182 dev_err(&urb->dev->dev,
183 "%s - Error %d submitting control urb\n",
189 * mos7720_bulk_in_callback
190 * this is the callback function for when we have received data on the
193 static void mos7720_bulk_in_callback(struct urb *urb)
196 unsigned char *data ;
197 struct usb_serial_port *port;
198 struct moschip_port *mos7720_port;
199 struct tty_struct *tty;
200 int status = urb->status;
203 dbg("nonzero read bulk status received: %d", status);
207 mos7720_port = urb->context;
209 dbg("%s", "NULL mos7720_port pointer \n");
213 port = mos7720_port->port;
215 dbg("Entering...%s", __func__);
217 data = urb->transfer_buffer;
219 tty = tty_port_tty_get(&port->port);
220 if (tty && urb->actual_length) {
221 tty_buffer_request_room(tty, urb->actual_length);
222 tty_insert_flip_string(tty, data, urb->actual_length);
223 tty_flip_buffer_push(tty);
227 if (!port->read_urb) {
228 dbg("URB KILLED !!!");
232 if (port->read_urb->status != -EINPROGRESS) {
233 port->read_urb->dev = port->serial->dev;
235 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
237 dbg("usb_submit_urb(read bulk) failed, retval = %d",
243 * mos7720_bulk_out_data_callback
244 * this is the callback function for when we have finished sending serial
245 * data on the bulk out endpoint.
247 static void mos7720_bulk_out_data_callback(struct urb *urb)
249 struct moschip_port *mos7720_port;
250 struct tty_struct *tty;
251 int status = urb->status;
254 dbg("nonzero write bulk status received:%d", status);
258 mos7720_port = urb->context;
260 dbg("NULL mos7720_port pointer");
264 dbg("Entering .........");
266 tty = tty_port_tty_get(&mos7720_port->port->port);
268 if (tty && mos7720_port->open)
275 * this function will be used for sending command to device
277 static int send_mos_cmd(struct usb_serial *serial, __u8 request, __u16 value,
278 __u16 index, void *data)
282 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
286 if (value < MOS_MAX_PORT) {
287 if (product == MOSCHIP_DEVICE_ID_7715)
288 value = value*0x100+0x100;
290 value = value*0x100+0x200;
293 if ((product == MOSCHIP_DEVICE_ID_7715) &&
295 dbg("serial->product== MOSCHIP_DEVICE_ID_7715");
300 if (request == MOS_WRITE) {
301 request = (__u8)MOS_WRITE;
302 requesttype = (__u8)0x40;
303 value = value + (__u16)*((unsigned char *)data);
305 pipe = usb_sndctrlpipe(serial->dev, 0);
307 request = (__u8)MOS_READ;
308 requesttype = (__u8)0xC0;
310 pipe = usb_rcvctrlpipe(serial->dev, 0);
313 status = usb_control_msg(serial->dev, pipe, request, requesttype,
314 value, index, data, size, MOS_WDR_TIMEOUT);
317 dbg("Command Write failed Value %x index %x\n", value, index);
322 static int mos7720_open(struct tty_struct *tty,
323 struct usb_serial_port *port, struct file *filp)
325 struct usb_serial *serial;
326 struct usb_serial_port *port0;
328 struct moschip_serial *mos7720_serial;
329 struct moschip_port *mos7720_port;
333 int allocated_urbs = 0;
336 serial = port->serial;
338 mos7720_port = usb_get_serial_port_data(port);
339 if (mos7720_port == NULL)
342 port0 = serial->port[0];
344 mos7720_serial = usb_get_serial_data(serial);
346 if (mos7720_serial == NULL || port0 == NULL)
349 usb_clear_halt(serial->dev, port->write_urb->pipe);
350 usb_clear_halt(serial->dev, port->read_urb->pipe);
352 /* Initialising the write urb pool */
353 for (j = 0; j < NUM_URBS; ++j) {
354 urb = usb_alloc_urb(0, GFP_KERNEL);
355 mos7720_port->write_urb_pool[j] = urb;
358 dev_err(&port->dev, "No more urbs???\n");
362 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
364 if (!urb->transfer_buffer) {
366 "%s-out of memory for urb buffers.\n",
368 usb_free_urb(mos7720_port->write_urb_pool[j]);
369 mos7720_port->write_urb_pool[j] = NULL;
378 /* Initialize MCS7720 -- Write Init values to corresponding Registers
386 * 0x08 : SP1/2 Control Reg
388 port_number = port->number - port->serial->minor;
389 send_mos_cmd(port->serial, MOS_READ, port_number, UART_LSR, &data);
390 dbg("SS::%p LSR:%x\n", mos7720_port, data);
392 dbg("Check:Sending Command ..........");
395 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x01, &data);
397 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x02, &data);
400 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
402 send_mos_cmd(serial, MOS_WRITE, port_number, 0x02, &data);
405 send_mos_cmd(serial, MOS_WRITE, port_number, 0x02, &data);
407 mos7720_port->shadowLCR = data;
408 send_mos_cmd(serial, MOS_WRITE, port_number, 0x03, &data);
410 mos7720_port->shadowMCR = data;
411 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
413 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
416 send_mos_cmd(serial, MOS_READ, MOS_MAX_PORT, 0x08, &data);
418 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x08, &data);
421 send_mos_cmd(serial, MOS_READ, MOS_MAX_PORT, port_number + 1, &data);
423 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, port_number + 1, &data);
425 send_mos_cmd(port->serial, MOS_WRITE, MOS_MAX_PORT,
426 port_number + 1, &data);
429 send_mos_cmd(serial, MOS_READ, MOS_MAX_PORT, 0x08, &data);
431 data = data | (port->number - port->serial->minor + 1);
432 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x08, &data);
435 mos7720_port->shadowLCR = data;
436 send_mos_cmd(serial, MOS_WRITE, port_number, 0x03, &data);
438 send_mos_cmd(serial, MOS_WRITE, port_number, 0x00, &data);
440 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
442 mos7720_port->shadowLCR = data;
443 send_mos_cmd(serial, MOS_WRITE, port_number, 0x03, &data);
445 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
447 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
449 /* force low_latency on so that our tty_push actually forces *
450 * the data through,otherwise it is scheduled, and with *
451 * high data rates (like with OHCI) data can get lost. */
454 tty->low_latency = 1;
456 /* see if we've set up our endpoint info yet *
457 * (can't set it up in mos7720_startup as the *
458 * structures were not set up at that time.) */
459 if (!mos7720_serial->interrupt_started) {
460 dbg("Interrupt buffer NULL !!!");
462 /* not set up yet, so do it now */
463 mos7720_serial->interrupt_started = 1;
465 dbg("To Submit URB !!!");
467 /* set up our interrupt urb */
468 usb_fill_int_urb(port0->interrupt_in_urb, serial->dev,
469 usb_rcvintpipe(serial->dev,
470 port->interrupt_in_endpointAddress),
471 port0->interrupt_in_buffer,
472 port0->interrupt_in_urb->transfer_buffer_length,
473 mos7720_interrupt_callback, mos7720_port,
474 port0->interrupt_in_urb->interval);
476 /* start interrupt read for this mos7720 this interrupt *
477 * will continue as long as the mos7720 is connected */
478 dbg("Submit URB over !!!");
479 response = usb_submit_urb(port0->interrupt_in_urb, GFP_KERNEL);
482 "%s - Error %d submitting control urb\n",
486 /* set up our bulk in urb */
487 usb_fill_bulk_urb(port->read_urb, serial->dev,
488 usb_rcvbulkpipe(serial->dev,
489 port->bulk_in_endpointAddress),
490 port->bulk_in_buffer,
491 port->read_urb->transfer_buffer_length,
492 mos7720_bulk_in_callback, mos7720_port);
493 response = usb_submit_urb(port->read_urb, GFP_KERNEL);
495 dev_err(&port->dev, "%s - Error %d submitting read urb\n",
498 /* initialize our icount structure */
499 memset(&(mos7720_port->icount), 0x00, sizeof(mos7720_port->icount));
501 /* initialize our port settings */
502 mos7720_port->shadowMCR = UART_MCR_OUT2; /* Must set to enable ints! */
504 /* send a open port command */
505 mos7720_port->open = 1;
511 * mos7720_chars_in_buffer
512 * this function is called by the tty driver when it wants to know how many
513 * bytes of data we currently have outstanding in the port (data that has
514 * been written, but hasn't made it out the port yet)
515 * If successful, we return the number of bytes left to be written in the
517 * Otherwise we return a negative error number.
519 static int mos7720_chars_in_buffer(struct tty_struct *tty)
521 struct usb_serial_port *port = tty->driver_data;
524 struct moschip_port *mos7720_port;
526 dbg("%s:entering ...........", __func__);
528 mos7720_port = usb_get_serial_port_data(port);
529 if (mos7720_port == NULL) {
530 dbg("%s:leaving ...........", __func__);
534 for (i = 0; i < NUM_URBS; ++i) {
535 if (mos7720_port->write_urb_pool[i] &&
536 mos7720_port->write_urb_pool[i]->status == -EINPROGRESS)
537 chars += URB_TRANSFER_BUFFER_SIZE;
539 dbg("%s - returns %d", __func__, chars);
543 static void mos7720_close(struct tty_struct *tty,
544 struct usb_serial_port *port, struct file *filp)
546 struct usb_serial *serial;
547 struct moschip_port *mos7720_port;
551 dbg("mos7720_close:entering...");
553 serial = port->serial;
555 mos7720_port = usb_get_serial_port_data(port);
556 if (mos7720_port == NULL)
559 for (j = 0; j < NUM_URBS; ++j)
560 usb_kill_urb(mos7720_port->write_urb_pool[j]);
562 /* Freeing Write URBs */
563 for (j = 0; j < NUM_URBS; ++j) {
564 if (mos7720_port->write_urb_pool[j]) {
565 kfree(mos7720_port->write_urb_pool[j]->transfer_buffer);
566 usb_free_urb(mos7720_port->write_urb_pool[j]);
570 /* While closing port, shutdown all bulk read, write *
571 * and interrupt read if they exists, otherwise nop */
572 dbg("Shutdown bulk write");
573 usb_kill_urb(port->write_urb);
574 dbg("Shutdown bulk read");
575 usb_kill_urb(port->read_urb);
577 mutex_lock(&serial->disc_mutex);
578 /* these commands must not be issued if the device has
579 * been disconnected */
580 if (!serial->disconnected) {
582 send_mos_cmd(serial, MOS_WRITE,
583 port->number - port->serial->minor, 0x04, &data);
586 send_mos_cmd(serial, MOS_WRITE,
587 port->number - port->serial->minor, 0x01, &data);
589 mutex_unlock(&serial->disc_mutex);
590 mos7720_port->open = 0;
592 dbg("Leaving %s", __func__);
595 static void mos7720_break(struct tty_struct *tty, int break_state)
597 struct usb_serial_port *port = tty->driver_data;
599 struct usb_serial *serial;
600 struct moschip_port *mos7720_port;
602 dbg("Entering %s", __func__);
604 serial = port->serial;
606 mos7720_port = usb_get_serial_port_data(port);
607 if (mos7720_port == NULL)
610 if (break_state == -1)
611 data = mos7720_port->shadowLCR | UART_LCR_SBC;
613 data = mos7720_port->shadowLCR & ~UART_LCR_SBC;
615 mos7720_port->shadowLCR = data;
616 send_mos_cmd(serial, MOS_WRITE, port->number - port->serial->minor,
624 * this function is called by the tty driver when it wants to know how many
625 * bytes of data we can accept for a specific port.
626 * If successful, we return the amount of room that we have for this port
627 * Otherwise we return a negative error number.
629 static int mos7720_write_room(struct tty_struct *tty)
631 struct usb_serial_port *port = tty->driver_data;
632 struct moschip_port *mos7720_port;
636 dbg("%s:entering ...........", __func__);
638 mos7720_port = usb_get_serial_port_data(port);
639 if (mos7720_port == NULL) {
640 dbg("%s:leaving ...........", __func__);
645 for (i = 0; i < NUM_URBS; ++i) {
646 if (mos7720_port->write_urb_pool[i] &&
647 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS)
648 room += URB_TRANSFER_BUFFER_SIZE;
651 dbg("%s - returns %d", __func__, room);
655 static int mos7720_write(struct tty_struct *tty, struct usb_serial_port *port,
656 const unsigned char *data, int count)
663 struct moschip_port *mos7720_port;
664 struct usb_serial *serial;
666 const unsigned char *current_position = data;
668 dbg("%s:entering ...........", __func__);
670 serial = port->serial;
672 mos7720_port = usb_get_serial_port_data(port);
673 if (mos7720_port == NULL) {
674 dbg("mos7720_port is NULL");
678 /* try to find a free urb in the list */
681 for (i = 0; i < NUM_URBS; ++i) {
682 if (mos7720_port->write_urb_pool[i] &&
683 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS) {
684 urb = mos7720_port->write_urb_pool[i];
691 dbg("%s - no more free urbs", __func__);
695 if (urb->transfer_buffer == NULL) {
696 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
698 if (urb->transfer_buffer == NULL) {
699 dev_err(&port->dev, "%s no more kernel memory...\n",
704 transfer_size = min(count, URB_TRANSFER_BUFFER_SIZE);
706 memcpy(urb->transfer_buffer, current_position, transfer_size);
707 usb_serial_debug_data(debug, &port->dev, __func__, transfer_size,
708 urb->transfer_buffer);
710 /* fill urb with data and submit */
711 usb_fill_bulk_urb(urb, serial->dev,
712 usb_sndbulkpipe(serial->dev,
713 port->bulk_out_endpointAddress),
714 urb->transfer_buffer, transfer_size,
715 mos7720_bulk_out_data_callback, mos7720_port);
717 /* send it down the pipe */
718 status = usb_submit_urb(urb, GFP_ATOMIC);
720 dev_err(&port->dev, "%s - usb_submit_urb(write bulk) failed "
721 "with status = %d\n", __func__, status);
725 bytes_sent = transfer_size;
731 static void mos7720_throttle(struct tty_struct *tty)
733 struct usb_serial_port *port = tty->driver_data;
734 struct moschip_port *mos7720_port;
737 dbg("%s- port %d\n", __func__, port->number);
739 mos7720_port = usb_get_serial_port_data(port);
741 if (mos7720_port == NULL)
744 if (!mos7720_port->open) {
745 dbg("port not opened");
749 dbg("%s: Entering ..........", __func__);
751 /* if we are implementing XON/XOFF, send the stop character */
753 unsigned char stop_char = STOP_CHAR(tty);
754 status = mos7720_write(tty, port, &stop_char, 1);
759 /* if we are implementing RTS/CTS, toggle that line */
760 if (tty->termios->c_cflag & CRTSCTS) {
761 mos7720_port->shadowMCR &= ~UART_MCR_RTS;
762 status = send_mos_cmd(port->serial, MOS_WRITE,
763 port->number - port->serial->minor,
764 UART_MCR, &mos7720_port->shadowMCR);
770 static void mos7720_unthrottle(struct tty_struct *tty)
772 struct usb_serial_port *port = tty->driver_data;
773 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
776 if (mos7720_port == NULL)
779 if (!mos7720_port->open) {
780 dbg("%s - port not opened", __func__);
784 dbg("%s: Entering ..........", __func__);
786 /* if we are implementing XON/XOFF, send the start character */
788 unsigned char start_char = START_CHAR(tty);
789 status = mos7720_write(tty, port, &start_char, 1);
794 /* if we are implementing RTS/CTS, toggle that line */
795 if (tty->termios->c_cflag & CRTSCTS) {
796 mos7720_port->shadowMCR |= UART_MCR_RTS;
797 status = send_mos_cmd(port->serial, MOS_WRITE,
798 port->number - port->serial->minor,
799 UART_MCR, &mos7720_port->shadowMCR);
805 static int set_higher_rates(struct moschip_port *mos7720_port,
809 struct usb_serial_port *port;
810 struct usb_serial *serial;
813 if (mos7720_port == NULL)
816 port = mos7720_port->port;
817 serial = port->serial;
819 /***********************************************
820 * Init Sequence for higher rates
821 ***********************************************/
822 dbg("Sending Setting Commands ..........");
823 port_number = port->number - port->serial->minor;
826 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
828 send_mos_cmd(serial, MOS_WRITE, port_number, 0x02, &data);
830 send_mos_cmd(serial, MOS_WRITE, port->number, 0x02, &data);
832 mos7720_port->shadowMCR = data;
833 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
835 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
838 send_mos_cmd(serial, MOS_READ, MOS_MAX_PORT, 0x08, &data);
840 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x08, &data);
843 /***********************************************
844 * Set for higher rates *
845 ***********************************************/
848 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, port_number + 1, &data);
851 send_mos_cmd(serial, MOS_READ, MOS_MAX_PORT, 0x08, &data);
853 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT, 0x08, &data);
856 mos7720_port->shadowMCR = data;
857 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
859 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
861 /***********************************************
863 ***********************************************/
865 data = mos7720_port->shadowLCR | UART_LCR_DLAB;
866 mos7720_port->shadowLCR = data;
867 send_mos_cmd(serial, MOS_WRITE, port_number, 0x03, &data);
869 data = 0x001; /* DLL */
870 send_mos_cmd(serial, MOS_WRITE, port_number, 0x00, &data);
871 data = 0x000; /* DLM */
872 send_mos_cmd(serial, MOS_WRITE, port_number, 0x01, &data);
874 data = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
875 mos7720_port->shadowLCR = data;
876 send_mos_cmd(serial, MOS_WRITE, port_number, 0x03, &data);
881 /* baud rate information */
882 struct divisor_table_entry {
887 /* Define table of divisors for moschip 7720 hardware *
888 * These assume a 3.6864MHz crystal, the standard /16, and *
890 static struct divisor_table_entry divisor_table[] = {
892 { 110, 1047}, /* 2094.545455 => 230450 => .0217 % over */
893 { 134, 857}, /* 1713.011152 => 230398.5 => .00065% under */
909 /*****************************************************************************
910 * calc_baud_rate_divisor
911 * this function calculates the proper baud rate divisor for the specified
913 *****************************************************************************/
914 static int calc_baud_rate_divisor(int baudrate, int *divisor)
922 dbg("%s - %d", __func__, baudrate);
924 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
925 if (divisor_table[i].baudrate == baudrate) {
926 *divisor = divisor_table[i].divisor;
931 /* After trying for all the standard baud rates *
932 * Try calculating the divisor for this baud rate */
933 if (baudrate > 75 && baudrate < 230400) {
934 /* get the divisor */
935 custom = (__u16)(230400L / baudrate);
937 /* Check for round off */
938 round1 = (__u16)(2304000L / baudrate);
939 round = (__u16)(round1 - (custom * 10));
944 dbg("Baud %d = %d", baudrate, custom);
948 dbg("Baud calculation Failed...");
953 * send_cmd_write_baud_rate
954 * this function sends the proper command to change the baud rate of the
957 static int send_cmd_write_baud_rate(struct moschip_port *mos7720_port,
960 struct usb_serial_port *port;
961 struct usb_serial *serial;
965 unsigned char number;
967 if (mos7720_port == NULL)
970 port = mos7720_port->port;
971 serial = port->serial;
973 dbg("%s: Entering ..........", __func__);
975 number = port->number - port->serial->minor;
976 dbg("%s - port = %d, baud = %d", __func__, port->number, baudrate);
978 /* Calculate the Divisor */
979 status = calc_baud_rate_divisor(baudrate, &divisor);
981 dev_err(&port->dev, "%s - bad baud rate\n", __func__);
985 /* Enable access to divisor latch */
986 data = mos7720_port->shadowLCR | UART_LCR_DLAB;
987 mos7720_port->shadowLCR = data;
988 send_mos_cmd(serial, MOS_WRITE, number, UART_LCR, &data);
990 /* Write the divisor */
991 data = ((unsigned char)(divisor & 0xff));
992 send_mos_cmd(serial, MOS_WRITE, number, 0x00, &data);
994 data = ((unsigned char)((divisor & 0xff00) >> 8));
995 send_mos_cmd(serial, MOS_WRITE, number, 0x01, &data);
997 /* Disable access to divisor latch */
998 data = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
999 mos7720_port->shadowLCR = data;
1000 send_mos_cmd(serial, MOS_WRITE, number, 0x03, &data);
1006 * change_port_settings
1007 * This routine is called to set the UART on the device to match
1008 * the specified new settings.
1010 static void change_port_settings(struct tty_struct *tty,
1011 struct moschip_port *mos7720_port,
1012 struct ktermios *old_termios)
1014 struct usb_serial_port *port;
1015 struct usb_serial *serial;
1027 if (mos7720_port == NULL)
1030 port = mos7720_port->port;
1031 serial = port->serial;
1032 port_number = port->number - port->serial->minor;
1034 dbg("%s - port %d", __func__, port->number);
1036 if (!mos7720_port->open) {
1037 dbg("%s - port not opened", __func__);
1041 dbg("%s: Entering ..........", __func__);
1043 lData = UART_LCR_WLEN8;
1044 lStop = 0x00; /* 1 stop bit */
1045 lParity = 0x00; /* No parity */
1047 cflag = tty->termios->c_cflag;
1048 iflag = tty->termios->c_iflag;
1050 /* Change the number of bits */
1051 switch (cflag & CSIZE) {
1053 lData = UART_LCR_WLEN5;
1058 lData = UART_LCR_WLEN6;
1063 lData = UART_LCR_WLEN7;
1068 lData = UART_LCR_WLEN8;
1072 /* Change the Parity bit */
1073 if (cflag & PARENB) {
1074 if (cflag & PARODD) {
1075 lParity = UART_LCR_PARITY;
1076 dbg("%s - parity = odd", __func__);
1078 lParity = (UART_LCR_EPAR | UART_LCR_PARITY);
1079 dbg("%s - parity = even", __func__);
1083 dbg("%s - parity = none", __func__);
1087 lParity = lParity | 0x20;
1089 /* Change the Stop bit */
1090 if (cflag & CSTOPB) {
1091 lStop = UART_LCR_STOP;
1092 dbg("%s - stop bits = 2", __func__);
1095 dbg("%s - stop bits = 1", __func__);
1098 #define LCR_BITS_MASK 0x03 /* Mask for bits/char field */
1099 #define LCR_STOP_MASK 0x04 /* Mask for stop bits field */
1100 #define LCR_PAR_MASK 0x38 /* Mask for parity field */
1102 /* Update the LCR with the correct value */
1103 mos7720_port->shadowLCR &=
1104 ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
1105 mos7720_port->shadowLCR |= (lData | lParity | lStop);
1108 /* Disable Interrupts */
1110 send_mos_cmd(serial, MOS_WRITE, port->number - port->serial->minor,
1114 send_mos_cmd(serial, MOS_WRITE, port_number, UART_FCR, &data);
1117 send_mos_cmd(serial, MOS_WRITE, port_number, UART_FCR, &data);
1119 /* Send the updated LCR value to the mos7720 */
1120 data = mos7720_port->shadowLCR;
1121 send_mos_cmd(serial, MOS_WRITE, port_number, UART_LCR, &data);
1124 mos7720_port->shadowMCR = data;
1125 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
1127 send_mos_cmd(serial, MOS_WRITE, port_number, 0x04, &data);
1129 /* set up the MCR register and send it to the mos7720 */
1130 mos7720_port->shadowMCR = UART_MCR_OUT2;
1132 mos7720_port->shadowMCR |= (UART_MCR_DTR | UART_MCR_RTS);
1134 if (cflag & CRTSCTS) {
1135 mos7720_port->shadowMCR |= (UART_MCR_XONANY);
1136 /* To set hardware flow control to the specified *
1137 * serial port, in SP1/2_CONTROL_REG */
1140 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT,
1144 send_mos_cmd(serial, MOS_WRITE, MOS_MAX_PORT,
1148 mos7720_port->shadowMCR &= ~(UART_MCR_XONANY);
1151 data = mos7720_port->shadowMCR;
1152 send_mos_cmd(serial, MOS_WRITE, port_number, UART_MCR, &data);
1154 /* Determine divisor based on baud rate */
1155 baud = tty_get_baud_rate(tty);
1157 /* pick a default, any default... */
1158 dbg("Picked default baud...");
1162 if (baud >= 230400) {
1163 set_higher_rates(mos7720_port, baud);
1164 /* Enable Interrupts */
1166 send_mos_cmd(serial, MOS_WRITE, port_number, UART_IER, &data);
1170 dbg("%s - baud rate = %d", __func__, baud);
1171 status = send_cmd_write_baud_rate(mos7720_port, baud);
1172 /* FIXME: needs to write actual resulting baud back not just
1175 tty_encode_baud_rate(tty, baud, baud);
1176 /* Enable Interrupts */
1178 send_mos_cmd(serial, MOS_WRITE, port_number, UART_IER, &data);
1180 if (port->read_urb->status != -EINPROGRESS) {
1181 port->read_urb->dev = serial->dev;
1183 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1185 dbg("usb_submit_urb(read bulk) failed, status = %d",
1192 * mos7720_set_termios
1193 * this function is called by the tty driver when it wants to change the
1194 * termios structure.
1196 static void mos7720_set_termios(struct tty_struct *tty,
1197 struct usb_serial_port *port, struct ktermios *old_termios)
1201 struct usb_serial *serial;
1202 struct moschip_port *mos7720_port;
1204 serial = port->serial;
1206 mos7720_port = usb_get_serial_port_data(port);
1208 if (mos7720_port == NULL)
1211 if (!mos7720_port->open) {
1212 dbg("%s - port not opened", __func__);
1216 dbg("%s\n", "setting termios - ASPIRE");
1218 cflag = tty->termios->c_cflag;
1220 dbg("%s - cflag %08x iflag %08x", __func__,
1221 tty->termios->c_cflag,
1222 RELEVANT_IFLAG(tty->termios->c_iflag));
1224 dbg("%s - old cflag %08x old iflag %08x", __func__,
1225 old_termios->c_cflag,
1226 RELEVANT_IFLAG(old_termios->c_iflag));
1228 dbg("%s - port %d", __func__, port->number);
1230 /* change the port settings to the new ones specified */
1231 change_port_settings(tty, mos7720_port, old_termios);
1233 if (!port->read_urb) {
1234 dbg("%s", "URB KILLED !!!!!\n");
1238 if (port->read_urb->status != -EINPROGRESS) {
1239 port->read_urb->dev = serial->dev;
1240 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1242 dbg("usb_submit_urb(read bulk) failed, status = %d",
1249 * get_lsr_info - get line status register info
1251 * Purpose: Let user call ioctl() to get info when the UART physically
1252 * is emptied. On bus types like RS485, the transmitter must
1253 * release the bus after transmitting. This must be done when
1254 * the transmit shift register is empty, not be done when the
1255 * transmit holding register is empty. This functionality
1256 * allows an RS485 driver to be written in user space.
1258 static int get_lsr_info(struct tty_struct *tty,
1259 struct moschip_port *mos7720_port, unsigned int __user *value)
1262 unsigned int result = 0;
1264 count = mos7720_chars_in_buffer(tty);
1266 dbg("%s -- Empty", __func__);
1267 result = TIOCSER_TEMT;
1270 if (copy_to_user(value, &result, sizeof(int)))
1275 static int set_modem_info(struct moschip_port *mos7720_port, unsigned int cmd,
1276 unsigned int __user *value)
1282 struct usb_serial_port *port;
1284 if (mos7720_port == NULL)
1287 port = (struct usb_serial_port *)mos7720_port->port;
1288 mcr = mos7720_port->shadowMCR;
1290 if (copy_from_user(&arg, value, sizeof(int)))
1295 if (arg & TIOCM_RTS)
1296 mcr |= UART_MCR_RTS;
1297 if (arg & TIOCM_DTR)
1298 mcr |= UART_MCR_RTS;
1299 if (arg & TIOCM_LOOP)
1300 mcr |= UART_MCR_LOOP;
1304 if (arg & TIOCM_RTS)
1305 mcr &= ~UART_MCR_RTS;
1306 if (arg & TIOCM_DTR)
1307 mcr &= ~UART_MCR_RTS;
1308 if (arg & TIOCM_LOOP)
1309 mcr &= ~UART_MCR_LOOP;
1313 /* turn off the RTS and DTR and LOOPBACK
1314 * and then only turn on what was asked to */
1315 mcr &= ~(UART_MCR_RTS | UART_MCR_DTR | UART_MCR_LOOP);
1316 mcr |= ((arg & TIOCM_RTS) ? UART_MCR_RTS : 0);
1317 mcr |= ((arg & TIOCM_DTR) ? UART_MCR_DTR : 0);
1318 mcr |= ((arg & TIOCM_LOOP) ? UART_MCR_LOOP : 0);
1322 mos7720_port->shadowMCR = mcr;
1324 data = mos7720_port->shadowMCR;
1325 send_mos_cmd(port->serial, MOS_WRITE,
1326 port->number - port->serial->minor, UART_MCR, &data);
1331 static int get_modem_info(struct moschip_port *mos7720_port,
1332 unsigned int __user *value)
1334 unsigned int result = 0;
1335 unsigned int msr = mos7720_port->shadowMSR;
1336 unsigned int mcr = mos7720_port->shadowMCR;
1338 result = ((mcr & UART_MCR_DTR) ? TIOCM_DTR: 0) /* 0x002 */
1339 | ((mcr & UART_MCR_RTS) ? TIOCM_RTS: 0) /* 0x004 */
1340 | ((msr & UART_MSR_CTS) ? TIOCM_CTS: 0) /* 0x020 */
1341 | ((msr & UART_MSR_DCD) ? TIOCM_CAR: 0) /* 0x040 */
1342 | ((msr & UART_MSR_RI) ? TIOCM_RI: 0) /* 0x080 */
1343 | ((msr & UART_MSR_DSR) ? TIOCM_DSR: 0); /* 0x100 */
1346 dbg("%s -- %x", __func__, result);
1348 if (copy_to_user(value, &result, sizeof(int)))
1353 static int get_serial_info(struct moschip_port *mos7720_port,
1354 struct serial_struct __user *retinfo)
1356 struct serial_struct tmp;
1361 memset(&tmp, 0, sizeof(tmp));
1363 tmp.type = PORT_16550A;
1364 tmp.line = mos7720_port->port->serial->minor;
1365 tmp.port = mos7720_port->port->number;
1367 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1368 tmp.xmit_fifo_size = NUM_URBS * URB_TRANSFER_BUFFER_SIZE;
1369 tmp.baud_base = 9600;
1370 tmp.close_delay = 5*HZ;
1371 tmp.closing_wait = 30*HZ;
1373 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1378 static int mos7720_ioctl(struct tty_struct *tty, struct file *file,
1379 unsigned int cmd, unsigned long arg)
1381 struct usb_serial_port *port = tty->driver_data;
1382 struct moschip_port *mos7720_port;
1383 struct async_icount cnow;
1384 struct async_icount cprev;
1385 struct serial_icounter_struct icount;
1387 mos7720_port = usb_get_serial_port_data(port);
1388 if (mos7720_port == NULL)
1391 dbg("%s - port %d, cmd = 0x%x", __func__, port->number, cmd);
1395 dbg("%s (%d) TIOCSERGETLSR", __func__, port->number);
1396 return get_lsr_info(tty, mos7720_port,
1397 (unsigned int __user *)arg);
1400 /* FIXME: These should be using the mode methods */
1404 dbg("%s (%d) TIOCMSET/TIOCMBIC/TIOCMSET",
1405 __func__, port->number);
1406 return set_modem_info(mos7720_port, cmd,
1407 (unsigned int __user *)arg);
1410 dbg("%s (%d) TIOCMGET", __func__, port->number);
1411 return get_modem_info(mos7720_port,
1412 (unsigned int __user *)arg);
1415 dbg("%s (%d) TIOCGSERIAL", __func__, port->number);
1416 return get_serial_info(mos7720_port,
1417 (struct serial_struct __user *)arg);
1420 dbg("%s (%d) TIOCMIWAIT", __func__, port->number);
1421 cprev = mos7720_port->icount;
1423 if (signal_pending(current))
1424 return -ERESTARTSYS;
1425 cnow = mos7720_port->icount;
1426 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1427 cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1428 return -EIO; /* no change => error */
1429 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1430 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1431 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1432 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1441 cnow = mos7720_port->icount;
1442 icount.cts = cnow.cts;
1443 icount.dsr = cnow.dsr;
1444 icount.rng = cnow.rng;
1445 icount.dcd = cnow.dcd;
1446 icount.rx = cnow.rx;
1447 icount.tx = cnow.tx;
1448 icount.frame = cnow.frame;
1449 icount.overrun = cnow.overrun;
1450 icount.parity = cnow.parity;
1451 icount.brk = cnow.brk;
1452 icount.buf_overrun = cnow.buf_overrun;
1454 dbg("%s (%d) TIOCGICOUNT RX=%d, TX=%d", __func__,
1455 port->number, icount.rx, icount.tx);
1456 if (copy_to_user((void __user *)arg, &icount, sizeof(icount)))
1461 return -ENOIOCTLCMD;
1464 static int mos7720_startup(struct usb_serial *serial)
1466 struct moschip_serial *mos7720_serial;
1467 struct moschip_port *mos7720_port;
1468 struct usb_device *dev;
1472 dbg("%s: Entering ..........", __func__);
1475 dbg("Invalid Handler");
1481 /* create our private serial structure */
1482 mos7720_serial = kzalloc(sizeof(struct moschip_serial), GFP_KERNEL);
1483 if (mos7720_serial == NULL) {
1484 dev_err(&dev->dev, "%s - Out of memory\n", __func__);
1488 usb_set_serial_data(serial, mos7720_serial);
1490 /* we set up the pointers to the endpoints in the mos7720_open *
1491 * function, as the structures aren't created yet. */
1493 /* set up port private structures */
1494 for (i = 0; i < serial->num_ports; ++i) {
1495 mos7720_port = kzalloc(sizeof(struct moschip_port), GFP_KERNEL);
1496 if (mos7720_port == NULL) {
1497 dev_err(&dev->dev, "%s - Out of memory\n", __func__);
1498 usb_set_serial_data(serial, NULL);
1499 kfree(mos7720_serial);
1503 /* Initialize all port interrupt end point to port 0 int
1504 * endpoint. Our device has only one interrupt endpoint
1505 * comman to all ports */
1506 serial->port[i]->interrupt_in_endpointAddress =
1507 serial->port[0]->interrupt_in_endpointAddress;
1509 mos7720_port->port = serial->port[i];
1510 usb_set_serial_port_data(serial->port[i], mos7720_port);
1512 dbg("port number is %d", serial->port[i]->number);
1513 dbg("serial number is %d", serial->minor);
1517 /* setting configuration feature to one */
1518 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1519 (__u8)0x03, 0x00, 0x01, 0x00, NULL, 0x00, 5*HZ);
1521 /* LSR For Port 1 */
1522 send_mos_cmd(serial, MOS_READ, 0x00, UART_LSR, &data);
1523 dbg("LSR:%x", data);
1525 /* LSR For Port 2 */
1526 send_mos_cmd(serial, MOS_READ, 0x01, UART_LSR, &data);
1527 dbg("LSR:%x", data);
1532 static void mos7720_shutdown(struct usb_serial *serial)
1536 /* free private structure allocated for serial port */
1537 for (i = 0; i < serial->num_ports; ++i) {
1538 kfree(usb_get_serial_port_data(serial->port[i]));
1539 usb_set_serial_port_data(serial->port[i], NULL);
1542 /* free private structure allocated for serial device */
1543 kfree(usb_get_serial_data(serial));
1544 usb_set_serial_data(serial, NULL);
1547 static struct usb_driver usb_driver = {
1548 .name = "moschip7720",
1549 .probe = usb_serial_probe,
1550 .disconnect = usb_serial_disconnect,
1551 .id_table = moschip_port_id_table,
1555 static struct usb_serial_driver moschip7720_2port_driver = {
1557 .owner = THIS_MODULE,
1558 .name = "moschip7720",
1560 .description = "Moschip 2 port adapter",
1561 .usb_driver = &usb_driver,
1562 .id_table = moschip_port_id_table,
1564 .open = mos7720_open,
1565 .close = mos7720_close,
1566 .throttle = mos7720_throttle,
1567 .unthrottle = mos7720_unthrottle,
1568 .attach = mos7720_startup,
1569 .shutdown = mos7720_shutdown,
1570 .ioctl = mos7720_ioctl,
1571 .set_termios = mos7720_set_termios,
1572 .write = mos7720_write,
1573 .write_room = mos7720_write_room,
1574 .chars_in_buffer = mos7720_chars_in_buffer,
1575 .break_ctl = mos7720_break,
1576 .read_bulk_callback = mos7720_bulk_in_callback,
1577 .read_int_callback = mos7720_interrupt_callback,
1580 static int __init moschip7720_init(void)
1584 dbg("%s: Entering ..........", __func__);
1586 /* Register with the usb serial */
1587 retval = usb_serial_register(&moschip7720_2port_driver);
1589 goto failed_port_device_register;
1591 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
1594 /* Register with the usb */
1595 retval = usb_register(&usb_driver);
1597 goto failed_usb_register;
1601 failed_usb_register:
1602 usb_serial_deregister(&moschip7720_2port_driver);
1604 failed_port_device_register:
1608 static void __exit moschip7720_exit(void)
1610 usb_deregister(&usb_driver);
1611 usb_serial_deregister(&moschip7720_2port_driver);
1614 module_init(moschip7720_init);
1615 module_exit(moschip7720_exit);
1617 /* Module information */
1618 MODULE_AUTHOR(DRIVER_AUTHOR);
1619 MODULE_DESCRIPTION(DRIVER_DESC);
1620 MODULE_LICENSE("GPL");
1622 module_param(debug, bool, S_IRUGO | S_IWUSR);
1623 MODULE_PARM_DESC(debug, "Debug enabled or not");