3 * Controls the Moschip 7720 usb to dual port serial converter
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>
37 #include <linux/parport.h>
39 #define DRIVER_AUTHOR "Aspire Communications pvt Ltd."
40 #define DRIVER_DESC "Moschip USB Serial Driver"
42 /* default urb timeout */
43 #define MOS_WDR_TIMEOUT 5000
45 #define MOS_MAX_PORT 0x02
46 #define MOS_WRITE 0x0E
49 /* Interrupt Routines Defines */
50 #define SERIAL_IIR_RLS 0x06
51 #define SERIAL_IIR_RDA 0x04
52 #define SERIAL_IIR_CTI 0x0c
53 #define SERIAL_IIR_THR 0x02
54 #define SERIAL_IIR_MS 0x00
56 #define NUM_URBS 16 /* URB Count */
57 #define URB_TRANSFER_BUFFER_SIZE 32 /* URB Size */
59 /* This structure holds all of the local serial port information */
61 __u8 shadowLCR; /* last LCR value received */
62 __u8 shadowMCR; /* last MCR value received */
63 __u8 shadowMSR; /* last MSR value received */
65 struct usb_serial_port *port; /* loop back to the owner */
66 struct urb *write_urb_pool[NUM_URBS];
69 static struct usb_serial_driver moschip7720_2port_driver;
71 #define USB_VENDOR_ID_MOSCHIP 0x9710
72 #define MOSCHIP_DEVICE_ID_7720 0x7720
73 #define MOSCHIP_DEVICE_ID_7715 0x7715
75 static const struct usb_device_id id_table[] = {
76 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7720) },
77 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7715) },
78 { } /* terminating entry */
80 MODULE_DEVICE_TABLE(usb, id_table);
82 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
84 /* initial values for parport regs */
85 #define DCR_INIT_VAL 0x0c /* SLCTIN, nINIT */
86 #define ECR_INIT_VAL 0x00 /* SPP mode */
89 struct mos7715_parport *mos_parport;
90 struct list_head urblist_entry;
91 struct kref ref_count;
93 struct usb_ctrlrequest *setup;
96 enum mos7715_pp_modes {
98 PS2 = 1<<5, /* moschip calls this 'NIBBLE' mode */
99 PPF = 2<<5, /* moschip calls this 'CB-FIFO mode */
102 struct mos7715_parport {
103 struct parport *pp; /* back to containing struct */
104 struct kref ref_count; /* to instance of this struct */
105 struct list_head deferred_urbs; /* list deferred async urbs */
106 struct list_head active_urbs; /* list async urbs in flight */
107 spinlock_t listlock; /* protects list access */
108 bool msg_pending; /* usb sync call pending */
109 struct completion syncmsg_compl; /* usb sync call completed */
110 struct tasklet_struct urb_tasklet; /* for sending deferred urbs */
111 struct usb_serial *serial; /* back to containing struct */
112 __u8 shadowECR; /* parallel port regs... */
114 atomic_t shadowDSR; /* updated in int-in callback */
117 /* lock guards against dereferencing NULL ptr in parport ops callbacks */
118 static DEFINE_SPINLOCK(release_lock);
120 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
122 static const unsigned int dummy; /* for clarity in register access fns */
125 THR, /* serial port regs */
137 DPR, /* parallel port regs */
141 SP1_REG, /* device control regs */
142 SP2_REG, /* serial port 2 (7720 only) */
148 * Return the correct value for the Windex field of the setup packet
149 * for a control endpoint message. See the 7715 datasheet.
151 static inline __u16 get_reg_index(enum mos_regs reg)
153 static const __u16 mos7715_index_lookup_table[] = {
171 0x02, /* SP2_REG (7720 only) */
172 0x04, /* PP_REG (7715 only) */
173 0x08, /* SP_CONTROL_REG */
175 return mos7715_index_lookup_table[reg];
179 * Return the correct value for the upper byte of the Wvalue field of
180 * the setup packet for a control endpoint message.
182 static inline __u16 get_reg_value(enum mos_regs reg,
183 unsigned int serial_portnum)
185 if (reg >= SP1_REG) /* control reg */
188 else if (reg >= DPR) /* parallel port reg (7715 only) */
191 else /* serial port reg */
192 return (serial_portnum + 2) << 8;
196 * Write data byte to the specified device register. The data is embedded in
197 * the value field of the setup packet. serial_portnum is ignored for registers
198 * not specific to a particular serial port.
200 static int write_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
201 enum mos_regs reg, __u8 data)
203 struct usb_device *usbdev = serial->dev;
204 unsigned int pipe = usb_sndctrlpipe(usbdev, 0);
205 __u8 request = (__u8)0x0e;
206 __u8 requesttype = (__u8)0x40;
207 __u16 index = get_reg_index(reg);
208 __u16 value = get_reg_value(reg, serial_portnum) + data;
209 int status = usb_control_msg(usbdev, pipe, request, requesttype, value,
210 index, NULL, 0, MOS_WDR_TIMEOUT);
212 dev_err(&usbdev->dev,
213 "mos7720: usb_control_msg() failed: %d", status);
218 * Read data byte from the specified device register. The data returned by the
219 * device is embedded in the value field of the setup packet. serial_portnum is
220 * ignored for registers that are not specific to a particular serial port.
222 static int read_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
223 enum mos_regs reg, __u8 *data)
225 struct usb_device *usbdev = serial->dev;
226 unsigned int pipe = usb_rcvctrlpipe(usbdev, 0);
227 __u8 request = (__u8)0x0d;
228 __u8 requesttype = (__u8)0xc0;
229 __u16 index = get_reg_index(reg);
230 __u16 value = get_reg_value(reg, serial_portnum);
234 buf = kmalloc(1, GFP_KERNEL);
238 status = usb_control_msg(usbdev, pipe, request, requesttype, value,
239 index, buf, 1, MOS_WDR_TIMEOUT);
243 dev_err(&usbdev->dev,
244 "mos7720: usb_control_msg() failed: %d", status);
250 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
252 static inline int mos7715_change_mode(struct mos7715_parport *mos_parport,
253 enum mos7715_pp_modes mode)
255 mos_parport->shadowECR = mode;
256 write_mos_reg(mos_parport->serial, dummy, ECR, mos_parport->shadowECR);
260 static void destroy_mos_parport(struct kref *kref)
262 struct mos7715_parport *mos_parport =
263 container_of(kref, struct mos7715_parport, ref_count);
268 static void destroy_urbtracker(struct kref *kref)
270 struct urbtracker *urbtrack =
271 container_of(kref, struct urbtracker, ref_count);
272 struct mos7715_parport *mos_parport = urbtrack->mos_parport;
274 usb_free_urb(urbtrack->urb);
275 kfree(urbtrack->setup);
277 kref_put(&mos_parport->ref_count, destroy_mos_parport);
281 * This runs as a tasklet when sending an urb in a non-blocking parallel
282 * port callback had to be deferred because the disconnect mutex could not be
283 * obtained at the time.
285 static void send_deferred_urbs(unsigned long _mos_parport)
289 struct mos7715_parport *mos_parport = (void *)_mos_parport;
290 struct urbtracker *urbtrack, *tmp;
291 struct list_head *cursor, *next;
294 /* if release function ran, game over */
295 if (unlikely(mos_parport->serial == NULL))
298 dev = &mos_parport->serial->dev->dev;
300 /* try again to get the mutex */
301 if (!mutex_trylock(&mos_parport->serial->disc_mutex)) {
302 dev_dbg(dev, "%s: rescheduling tasklet\n", __func__);
303 tasklet_schedule(&mos_parport->urb_tasklet);
307 /* if device disconnected, game over */
308 if (unlikely(mos_parport->serial->disconnected)) {
309 mutex_unlock(&mos_parport->serial->disc_mutex);
313 spin_lock_irqsave(&mos_parport->listlock, flags);
314 if (list_empty(&mos_parport->deferred_urbs)) {
315 spin_unlock_irqrestore(&mos_parport->listlock, flags);
316 mutex_unlock(&mos_parport->serial->disc_mutex);
317 dev_dbg(dev, "%s: deferred_urbs list empty\n", __func__);
321 /* move contents of deferred_urbs list to active_urbs list and submit */
322 list_for_each_safe(cursor, next, &mos_parport->deferred_urbs)
323 list_move_tail(cursor, &mos_parport->active_urbs);
324 list_for_each_entry_safe(urbtrack, tmp, &mos_parport->active_urbs,
326 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
327 dev_dbg(dev, "%s: urb submitted\n", __func__);
329 dev_err(dev, "usb_submit_urb() failed: %d\n", ret_val);
330 list_del(&urbtrack->urblist_entry);
331 kref_put(&urbtrack->ref_count, destroy_urbtracker);
334 spin_unlock_irqrestore(&mos_parport->listlock, flags);
335 mutex_unlock(&mos_parport->serial->disc_mutex);
338 /* callback for parallel port control urbs submitted asynchronously */
339 static void async_complete(struct urb *urb)
341 struct urbtracker *urbtrack = urb->context;
342 int status = urb->status;
344 if (unlikely(status))
345 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
347 /* remove the urbtracker from the active_urbs list */
348 spin_lock(&urbtrack->mos_parport->listlock);
349 list_del(&urbtrack->urblist_entry);
350 spin_unlock(&urbtrack->mos_parport->listlock);
351 kref_put(&urbtrack->ref_count, destroy_urbtracker);
354 static int write_parport_reg_nonblock(struct mos7715_parport *mos_parport,
355 enum mos_regs reg, __u8 data)
357 struct urbtracker *urbtrack;
360 struct usb_serial *serial = mos_parport->serial;
361 struct usb_device *usbdev = serial->dev;
363 /* create and initialize the control urb and containing urbtracker */
364 urbtrack = kmalloc(sizeof(struct urbtracker), GFP_ATOMIC);
368 kref_get(&mos_parport->ref_count);
369 urbtrack->mos_parport = mos_parport;
370 urbtrack->urb = usb_alloc_urb(0, GFP_ATOMIC);
371 if (!urbtrack->urb) {
375 urbtrack->setup = kmalloc(sizeof(*urbtrack->setup), GFP_ATOMIC);
376 if (!urbtrack->setup) {
377 usb_free_urb(urbtrack->urb);
381 urbtrack->setup->bRequestType = (__u8)0x40;
382 urbtrack->setup->bRequest = (__u8)0x0e;
383 urbtrack->setup->wValue = cpu_to_le16(get_reg_value(reg, dummy));
384 urbtrack->setup->wIndex = cpu_to_le16(get_reg_index(reg));
385 urbtrack->setup->wLength = 0;
386 usb_fill_control_urb(urbtrack->urb, usbdev,
387 usb_sndctrlpipe(usbdev, 0),
388 (unsigned char *)urbtrack->setup,
389 NULL, 0, async_complete, urbtrack);
390 kref_init(&urbtrack->ref_count);
391 INIT_LIST_HEAD(&urbtrack->urblist_entry);
394 * get the disconnect mutex, or add tracker to the deferred_urbs list
395 * and schedule a tasklet to try again later
397 if (!mutex_trylock(&serial->disc_mutex)) {
398 spin_lock_irqsave(&mos_parport->listlock, flags);
399 list_add_tail(&urbtrack->urblist_entry,
400 &mos_parport->deferred_urbs);
401 spin_unlock_irqrestore(&mos_parport->listlock, flags);
402 tasklet_schedule(&mos_parport->urb_tasklet);
403 dev_dbg(&usbdev->dev, "tasklet scheduled");
407 /* bail if device disconnected */
408 if (serial->disconnected) {
409 kref_put(&urbtrack->ref_count, destroy_urbtracker);
410 mutex_unlock(&serial->disc_mutex);
414 /* add the tracker to the active_urbs list and submit */
415 spin_lock_irqsave(&mos_parport->listlock, flags);
416 list_add_tail(&urbtrack->urblist_entry, &mos_parport->active_urbs);
417 spin_unlock_irqrestore(&mos_parport->listlock, flags);
418 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
419 mutex_unlock(&serial->disc_mutex);
421 dev_err(&usbdev->dev,
422 "%s: submit_urb() failed: %d", __func__, ret_val);
423 spin_lock_irqsave(&mos_parport->listlock, flags);
424 list_del(&urbtrack->urblist_entry);
425 spin_unlock_irqrestore(&mos_parport->listlock, flags);
426 kref_put(&urbtrack->ref_count, destroy_urbtracker);
433 * This is the the common top part of all parallel port callback operations that
434 * send synchronous messages to the device. This implements convoluted locking
435 * that avoids two scenarios: (1) a port operation is called after usbserial
436 * has called our release function, at which point struct mos7715_parport has
437 * been destroyed, and (2) the device has been disconnected, but usbserial has
438 * not called the release function yet because someone has a serial port open.
439 * The shared release_lock prevents the first, and the mutex and disconnected
440 * flag maintained by usbserial covers the second. We also use the msg_pending
441 * flag to ensure that all synchronous usb message calls have completed before
442 * our release function can return.
444 static int parport_prologue(struct parport *pp)
446 struct mos7715_parport *mos_parport;
448 spin_lock(&release_lock);
449 mos_parport = pp->private_data;
450 if (unlikely(mos_parport == NULL)) {
451 /* release fn called, port struct destroyed */
452 spin_unlock(&release_lock);
455 mos_parport->msg_pending = true; /* synch usb call pending */
456 reinit_completion(&mos_parport->syncmsg_compl);
457 spin_unlock(&release_lock);
459 mutex_lock(&mos_parport->serial->disc_mutex);
460 if (mos_parport->serial->disconnected) {
461 /* device disconnected */
462 mutex_unlock(&mos_parport->serial->disc_mutex);
463 mos_parport->msg_pending = false;
464 complete(&mos_parport->syncmsg_compl);
472 * This is the common bottom part of all parallel port functions that send
473 * synchronous messages to the device.
475 static inline void parport_epilogue(struct parport *pp)
477 struct mos7715_parport *mos_parport = pp->private_data;
478 mutex_unlock(&mos_parport->serial->disc_mutex);
479 mos_parport->msg_pending = false;
480 complete(&mos_parport->syncmsg_compl);
483 static void parport_mos7715_write_data(struct parport *pp, unsigned char d)
485 struct mos7715_parport *mos_parport = pp->private_data;
487 if (parport_prologue(pp) < 0)
489 mos7715_change_mode(mos_parport, SPP);
490 write_mos_reg(mos_parport->serial, dummy, DPR, (__u8)d);
491 parport_epilogue(pp);
494 static unsigned char parport_mos7715_read_data(struct parport *pp)
496 struct mos7715_parport *mos_parport = pp->private_data;
499 if (parport_prologue(pp) < 0)
501 read_mos_reg(mos_parport->serial, dummy, DPR, &d);
502 parport_epilogue(pp);
506 static void parport_mos7715_write_control(struct parport *pp, unsigned char d)
508 struct mos7715_parport *mos_parport = pp->private_data;
511 if (parport_prologue(pp) < 0)
513 data = ((__u8)d & 0x0f) | (mos_parport->shadowDCR & 0xf0);
514 write_mos_reg(mos_parport->serial, dummy, DCR, data);
515 mos_parport->shadowDCR = data;
516 parport_epilogue(pp);
519 static unsigned char parport_mos7715_read_control(struct parport *pp)
521 struct mos7715_parport *mos_parport = pp->private_data;
524 spin_lock(&release_lock);
525 mos_parport = pp->private_data;
526 if (unlikely(mos_parport == NULL)) {
527 spin_unlock(&release_lock);
530 dcr = mos_parport->shadowDCR & 0x0f;
531 spin_unlock(&release_lock);
535 static unsigned char parport_mos7715_frob_control(struct parport *pp,
539 struct mos7715_parport *mos_parport = pp->private_data;
544 if (parport_prologue(pp) < 0)
546 mos_parport->shadowDCR = (mos_parport->shadowDCR & (~mask)) ^ val;
547 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
548 dcr = mos_parport->shadowDCR & 0x0f;
549 parport_epilogue(pp);
553 static unsigned char parport_mos7715_read_status(struct parport *pp)
555 unsigned char status;
556 struct mos7715_parport *mos_parport = pp->private_data;
558 spin_lock(&release_lock);
559 mos_parport = pp->private_data;
560 if (unlikely(mos_parport == NULL)) { /* release called */
561 spin_unlock(&release_lock);
564 status = atomic_read(&mos_parport->shadowDSR) & 0xf8;
565 spin_unlock(&release_lock);
569 static void parport_mos7715_enable_irq(struct parport *pp)
573 static void parport_mos7715_disable_irq(struct parport *pp)
577 static void parport_mos7715_data_forward(struct parport *pp)
579 struct mos7715_parport *mos_parport = pp->private_data;
581 if (parport_prologue(pp) < 0)
583 mos7715_change_mode(mos_parport, PS2);
584 mos_parport->shadowDCR &= ~0x20;
585 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
586 parport_epilogue(pp);
589 static void parport_mos7715_data_reverse(struct parport *pp)
591 struct mos7715_parport *mos_parport = pp->private_data;
593 if (parport_prologue(pp) < 0)
595 mos7715_change_mode(mos_parport, PS2);
596 mos_parport->shadowDCR |= 0x20;
597 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
598 parport_epilogue(pp);
601 static void parport_mos7715_init_state(struct pardevice *dev,
602 struct parport_state *s)
604 s->u.pc.ctr = DCR_INIT_VAL;
605 s->u.pc.ecr = ECR_INIT_VAL;
608 /* N.B. Parport core code requires that this function not block */
609 static void parport_mos7715_save_state(struct parport *pp,
610 struct parport_state *s)
612 struct mos7715_parport *mos_parport;
614 spin_lock(&release_lock);
615 mos_parport = pp->private_data;
616 if (unlikely(mos_parport == NULL)) { /* release called */
617 spin_unlock(&release_lock);
620 s->u.pc.ctr = mos_parport->shadowDCR;
621 s->u.pc.ecr = mos_parport->shadowECR;
622 spin_unlock(&release_lock);
625 /* N.B. Parport core code requires that this function not block */
626 static void parport_mos7715_restore_state(struct parport *pp,
627 struct parport_state *s)
629 struct mos7715_parport *mos_parport;
631 spin_lock(&release_lock);
632 mos_parport = pp->private_data;
633 if (unlikely(mos_parport == NULL)) { /* release called */
634 spin_unlock(&release_lock);
637 write_parport_reg_nonblock(mos_parport, DCR, mos_parport->shadowDCR);
638 write_parport_reg_nonblock(mos_parport, ECR, mos_parport->shadowECR);
639 spin_unlock(&release_lock);
642 static size_t parport_mos7715_write_compat(struct parport *pp,
644 size_t len, int flags)
647 struct mos7715_parport *mos_parport = pp->private_data;
650 if (parport_prologue(pp) < 0)
652 mos7715_change_mode(mos_parport, PPF);
653 retval = usb_bulk_msg(mos_parport->serial->dev,
654 usb_sndbulkpipe(mos_parport->serial->dev, 2),
655 (void *)buffer, len, &actual_len,
657 parport_epilogue(pp);
659 dev_err(&mos_parport->serial->dev->dev,
660 "mos7720: usb_bulk_msg() failed: %d", retval);
666 static struct parport_operations parport_mos7715_ops = {
667 .owner = THIS_MODULE,
668 .write_data = parport_mos7715_write_data,
669 .read_data = parport_mos7715_read_data,
671 .write_control = parport_mos7715_write_control,
672 .read_control = parport_mos7715_read_control,
673 .frob_control = parport_mos7715_frob_control,
675 .read_status = parport_mos7715_read_status,
677 .enable_irq = parport_mos7715_enable_irq,
678 .disable_irq = parport_mos7715_disable_irq,
680 .data_forward = parport_mos7715_data_forward,
681 .data_reverse = parport_mos7715_data_reverse,
683 .init_state = parport_mos7715_init_state,
684 .save_state = parport_mos7715_save_state,
685 .restore_state = parport_mos7715_restore_state,
687 .compat_write_data = parport_mos7715_write_compat,
689 .nibble_read_data = parport_ieee1284_read_nibble,
690 .byte_read_data = parport_ieee1284_read_byte,
694 * Allocate and initialize parallel port control struct, initialize
695 * the parallel port hardware device, and register with the parport subsystem.
697 static int mos7715_parport_init(struct usb_serial *serial)
699 struct mos7715_parport *mos_parport;
701 /* allocate and initialize parallel port control struct */
702 mos_parport = kzalloc(sizeof(struct mos7715_parport), GFP_KERNEL);
706 mos_parport->msg_pending = false;
707 kref_init(&mos_parport->ref_count);
708 spin_lock_init(&mos_parport->listlock);
709 INIT_LIST_HEAD(&mos_parport->active_urbs);
710 INIT_LIST_HEAD(&mos_parport->deferred_urbs);
711 usb_set_serial_data(serial, mos_parport); /* hijack private pointer */
712 mos_parport->serial = serial;
713 tasklet_init(&mos_parport->urb_tasklet, send_deferred_urbs,
714 (unsigned long) mos_parport);
715 init_completion(&mos_parport->syncmsg_compl);
717 /* cycle parallel port reset bit */
718 write_mos_reg(mos_parport->serial, dummy, PP_REG, (__u8)0x80);
719 write_mos_reg(mos_parport->serial, dummy, PP_REG, (__u8)0x00);
721 /* initialize device registers */
722 mos_parport->shadowDCR = DCR_INIT_VAL;
723 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
724 mos_parport->shadowECR = ECR_INIT_VAL;
725 write_mos_reg(mos_parport->serial, dummy, ECR, mos_parport->shadowECR);
727 /* register with parport core */
728 mos_parport->pp = parport_register_port(0, PARPORT_IRQ_NONE,
730 &parport_mos7715_ops);
731 if (mos_parport->pp == NULL) {
732 dev_err(&serial->interface->dev,
733 "Could not register parport\n");
734 kref_put(&mos_parport->ref_count, destroy_mos_parport);
737 mos_parport->pp->private_data = mos_parport;
738 mos_parport->pp->modes = PARPORT_MODE_COMPAT | PARPORT_MODE_PCSPP;
739 mos_parport->pp->dev = &serial->interface->dev;
740 parport_announce_port(mos_parport->pp);
744 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
747 * mos7720_interrupt_callback
748 * this is the callback function for when we have received data on the
749 * interrupt endpoint.
751 static void mos7720_interrupt_callback(struct urb *urb)
755 int status = urb->status;
756 struct device *dev = &urb->dev->dev;
768 /* this urb is terminated, clean up */
769 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
772 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
776 length = urb->actual_length;
777 data = urb->transfer_buffer;
779 /* Moschip get 4 bytes
780 * Byte 1 IIR Port 1 (port.number is 0)
781 * Byte 2 IIR Port 2 (port.number is 1)
782 * Byte 3 --------------
783 * Byte 4 FIFO status for both */
785 /* the above description is inverted
786 * oneukum 2007-03-14 */
788 if (unlikely(length != 4)) {
789 dev_dbg(dev, "Wrong data !!!\n");
796 if ((sp1 | sp2) & 0x01) {
797 /* No Interrupt Pending in both the ports */
798 dev_dbg(dev, "No Interrupt !!!\n");
800 switch (sp1 & 0x0f) {
802 dev_dbg(dev, "Serial Port 1: Receiver status error or address bit detected in 9-bit mode\n");
805 dev_dbg(dev, "Serial Port 1: Receiver time out\n");
808 /* dev_dbg(dev, "Serial Port 1: Modem status change\n"); */
812 switch (sp2 & 0x0f) {
814 dev_dbg(dev, "Serial Port 2: Receiver status error or address bit detected in 9-bit mode\n");
817 dev_dbg(dev, "Serial Port 2: Receiver time out\n");
820 /* dev_dbg(dev, "Serial Port 2: Modem status change\n"); */
826 result = usb_submit_urb(urb, GFP_ATOMIC);
828 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
832 * mos7715_interrupt_callback
833 * this is the 7715's callback function for when we have received data on
834 * the interrupt endpoint.
836 static void mos7715_interrupt_callback(struct urb *urb)
840 int status = urb->status;
841 struct device *dev = &urb->dev->dev;
853 /* this urb is terminated, clean up */
854 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
857 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
861 length = urb->actual_length;
862 data = urb->transfer_buffer;
864 /* Structure of data from 7715 device:
865 * Byte 1: IIR serial Port
867 * Byte 2: DSR parallel port
868 * Byte 4: FIFO status for both */
870 if (unlikely(length != 4)) {
871 dev_dbg(dev, "Wrong data !!!\n");
876 if (!(iir & 0x01)) { /* serial port interrupt pending */
877 switch (iir & 0x0f) {
879 dev_dbg(dev, "Serial Port: Receiver status error or address bit detected in 9-bit mode\n\n");
882 dev_dbg(dev, "Serial Port: Receiver time out\n");
885 /* dev_dbg(dev, "Serial Port: Modem status change\n"); */
890 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
891 { /* update local copy of DSR reg */
892 struct usb_serial_port *port = urb->context;
893 struct mos7715_parport *mos_parport = port->serial->private;
894 if (unlikely(mos_parport == NULL))
896 atomic_set(&mos_parport->shadowDSR, data[2]);
901 result = usb_submit_urb(urb, GFP_ATOMIC);
903 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
907 * mos7720_bulk_in_callback
908 * this is the callback function for when we have received data on the
911 static void mos7720_bulk_in_callback(struct urb *urb)
914 unsigned char *data ;
915 struct usb_serial_port *port;
916 int status = urb->status;
919 dev_dbg(&urb->dev->dev, "nonzero read bulk status received: %d\n", status);
925 dev_dbg(&port->dev, "Entering...%s\n", __func__);
927 data = urb->transfer_buffer;
929 if (urb->actual_length) {
930 tty_insert_flip_string(&port->port, data, urb->actual_length);
931 tty_flip_buffer_push(&port->port);
934 if (port->read_urb->status != -EINPROGRESS) {
935 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
937 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, retval = %d\n", retval);
942 * mos7720_bulk_out_data_callback
943 * this is the callback function for when we have finished sending serial
944 * data on the bulk out endpoint.
946 static void mos7720_bulk_out_data_callback(struct urb *urb)
948 struct moschip_port *mos7720_port;
949 int status = urb->status;
952 dev_dbg(&urb->dev->dev, "nonzero write bulk status received:%d\n", status);
956 mos7720_port = urb->context;
958 dev_dbg(&urb->dev->dev, "NULL mos7720_port pointer\n");
962 if (mos7720_port->open)
963 tty_port_tty_wakeup(&mos7720_port->port->port);
968 * this function installs the appropriate read interrupt endpoint callback
969 * depending on whether the device is a 7720 or 7715, thus avoiding costly
970 * run-time checks in the high-frequency callback routine itself.
972 static int mos77xx_probe(struct usb_serial *serial,
973 const struct usb_device_id *id)
975 if (id->idProduct == MOSCHIP_DEVICE_ID_7715)
976 moschip7720_2port_driver.read_int_callback =
977 mos7715_interrupt_callback;
979 moschip7720_2port_driver.read_int_callback =
980 mos7720_interrupt_callback;
985 static int mos77xx_calc_num_ports(struct usb_serial *serial)
987 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
988 if (product == MOSCHIP_DEVICE_ID_7715)
994 static int mos7720_open(struct tty_struct *tty, struct usb_serial_port *port)
996 struct usb_serial *serial;
998 struct moschip_port *mos7720_port;
1002 int allocated_urbs = 0;
1005 serial = port->serial;
1007 mos7720_port = usb_get_serial_port_data(port);
1008 if (mos7720_port == NULL)
1011 usb_clear_halt(serial->dev, port->write_urb->pipe);
1012 usb_clear_halt(serial->dev, port->read_urb->pipe);
1014 /* Initialising the write urb pool */
1015 for (j = 0; j < NUM_URBS; ++j) {
1016 urb = usb_alloc_urb(0, GFP_KERNEL);
1017 mos7720_port->write_urb_pool[j] = urb;
1021 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
1023 if (!urb->transfer_buffer) {
1024 usb_free_urb(mos7720_port->write_urb_pool[j]);
1025 mos7720_port->write_urb_pool[j] = NULL;
1031 if (!allocated_urbs)
1034 /* Initialize MCS7720 -- Write Init values to corresponding Registers
1046 * 0x08 : SP1/2 Control Reg
1048 port_number = port->port_number;
1049 read_mos_reg(serial, port_number, LSR, &data);
1051 dev_dbg(&port->dev, "SS::%p LSR:%x\n", mos7720_port, data);
1053 write_mos_reg(serial, dummy, SP1_REG, 0x02);
1054 write_mos_reg(serial, dummy, SP2_REG, 0x02);
1056 write_mos_reg(serial, port_number, IER, 0x00);
1057 write_mos_reg(serial, port_number, FCR, 0x00);
1059 write_mos_reg(serial, port_number, FCR, 0xcf);
1060 mos7720_port->shadowLCR = 0x03;
1061 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1062 mos7720_port->shadowMCR = 0x0b;
1063 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1065 write_mos_reg(serial, port_number, SP_CONTROL_REG, 0x00);
1066 read_mos_reg(serial, dummy, SP_CONTROL_REG, &data);
1067 data = data | (port->port_number + 1);
1068 write_mos_reg(serial, dummy, SP_CONTROL_REG, data);
1069 mos7720_port->shadowLCR = 0x83;
1070 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1071 write_mos_reg(serial, port_number, THR, 0x0c);
1072 write_mos_reg(serial, port_number, IER, 0x00);
1073 mos7720_port->shadowLCR = 0x03;
1074 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1075 write_mos_reg(serial, port_number, IER, 0x0c);
1077 response = usb_submit_urb(port->read_urb, GFP_KERNEL);
1079 dev_err(&port->dev, "%s - Error %d submitting read urb\n",
1080 __func__, response);
1082 /* initialize our port settings */
1083 mos7720_port->shadowMCR = UART_MCR_OUT2; /* Must set to enable ints! */
1085 /* send a open port command */
1086 mos7720_port->open = 1;
1092 * mos7720_chars_in_buffer
1093 * this function is called by the tty driver when it wants to know how many
1094 * bytes of data we currently have outstanding in the port (data that has
1095 * been written, but hasn't made it out the port yet)
1096 * If successful, we return the number of bytes left to be written in the
1098 * Otherwise we return a negative error number.
1100 static int mos7720_chars_in_buffer(struct tty_struct *tty)
1102 struct usb_serial_port *port = tty->driver_data;
1105 struct moschip_port *mos7720_port;
1107 mos7720_port = usb_get_serial_port_data(port);
1108 if (mos7720_port == NULL)
1111 for (i = 0; i < NUM_URBS; ++i) {
1112 if (mos7720_port->write_urb_pool[i] &&
1113 mos7720_port->write_urb_pool[i]->status == -EINPROGRESS)
1114 chars += URB_TRANSFER_BUFFER_SIZE;
1116 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1120 static void mos7720_close(struct usb_serial_port *port)
1122 struct usb_serial *serial;
1123 struct moschip_port *mos7720_port;
1126 serial = port->serial;
1128 mos7720_port = usb_get_serial_port_data(port);
1129 if (mos7720_port == NULL)
1132 for (j = 0; j < NUM_URBS; ++j)
1133 usb_kill_urb(mos7720_port->write_urb_pool[j]);
1135 /* Freeing Write URBs */
1136 for (j = 0; j < NUM_URBS; ++j) {
1137 if (mos7720_port->write_urb_pool[j]) {
1138 kfree(mos7720_port->write_urb_pool[j]->transfer_buffer);
1139 usb_free_urb(mos7720_port->write_urb_pool[j]);
1143 /* While closing port, shutdown all bulk read, write *
1144 * and interrupt read if they exists, otherwise nop */
1145 usb_kill_urb(port->write_urb);
1146 usb_kill_urb(port->read_urb);
1148 write_mos_reg(serial, port->port_number, MCR, 0x00);
1149 write_mos_reg(serial, port->port_number, IER, 0x00);
1151 mos7720_port->open = 0;
1154 static void mos7720_break(struct tty_struct *tty, int break_state)
1156 struct usb_serial_port *port = tty->driver_data;
1158 struct usb_serial *serial;
1159 struct moschip_port *mos7720_port;
1161 serial = port->serial;
1163 mos7720_port = usb_get_serial_port_data(port);
1164 if (mos7720_port == NULL)
1167 if (break_state == -1)
1168 data = mos7720_port->shadowLCR | UART_LCR_SBC;
1170 data = mos7720_port->shadowLCR & ~UART_LCR_SBC;
1172 mos7720_port->shadowLCR = data;
1173 write_mos_reg(serial, port->port_number, LCR, mos7720_port->shadowLCR);
1177 * mos7720_write_room
1178 * this function is called by the tty driver when it wants to know how many
1179 * bytes of data we can accept for a specific port.
1180 * If successful, we return the amount of room that we have for this port
1181 * Otherwise we return a negative error number.
1183 static int mos7720_write_room(struct tty_struct *tty)
1185 struct usb_serial_port *port = tty->driver_data;
1186 struct moschip_port *mos7720_port;
1190 mos7720_port = usb_get_serial_port_data(port);
1191 if (mos7720_port == NULL)
1194 /* FIXME: Locking */
1195 for (i = 0; i < NUM_URBS; ++i) {
1196 if (mos7720_port->write_urb_pool[i] &&
1197 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS)
1198 room += URB_TRANSFER_BUFFER_SIZE;
1201 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
1205 static int mos7720_write(struct tty_struct *tty, struct usb_serial_port *port,
1206 const unsigned char *data, int count)
1213 struct moschip_port *mos7720_port;
1214 struct usb_serial *serial;
1216 const unsigned char *current_position = data;
1218 serial = port->serial;
1220 mos7720_port = usb_get_serial_port_data(port);
1221 if (mos7720_port == NULL)
1224 /* try to find a free urb in the list */
1227 for (i = 0; i < NUM_URBS; ++i) {
1228 if (mos7720_port->write_urb_pool[i] &&
1229 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS) {
1230 urb = mos7720_port->write_urb_pool[i];
1231 dev_dbg(&port->dev, "URB:%d\n", i);
1237 dev_dbg(&port->dev, "%s - no more free urbs\n", __func__);
1241 if (urb->transfer_buffer == NULL) {
1242 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
1244 if (!urb->transfer_buffer)
1247 transfer_size = min(count, URB_TRANSFER_BUFFER_SIZE);
1249 memcpy(urb->transfer_buffer, current_position, transfer_size);
1250 usb_serial_debug_data(&port->dev, __func__, transfer_size,
1251 urb->transfer_buffer);
1253 /* fill urb with data and submit */
1254 usb_fill_bulk_urb(urb, serial->dev,
1255 usb_sndbulkpipe(serial->dev,
1256 port->bulk_out_endpointAddress),
1257 urb->transfer_buffer, transfer_size,
1258 mos7720_bulk_out_data_callback, mos7720_port);
1260 /* send it down the pipe */
1261 status = usb_submit_urb(urb, GFP_ATOMIC);
1263 dev_err_console(port, "%s - usb_submit_urb(write bulk) failed "
1264 "with status = %d\n", __func__, status);
1265 bytes_sent = status;
1268 bytes_sent = transfer_size;
1274 static void mos7720_throttle(struct tty_struct *tty)
1276 struct usb_serial_port *port = tty->driver_data;
1277 struct moschip_port *mos7720_port;
1280 mos7720_port = usb_get_serial_port_data(port);
1282 if (mos7720_port == NULL)
1285 if (!mos7720_port->open) {
1286 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1290 /* if we are implementing XON/XOFF, send the stop character */
1292 unsigned char stop_char = STOP_CHAR(tty);
1293 status = mos7720_write(tty, port, &stop_char, 1);
1298 /* if we are implementing RTS/CTS, toggle that line */
1299 if (tty->termios.c_cflag & CRTSCTS) {
1300 mos7720_port->shadowMCR &= ~UART_MCR_RTS;
1301 write_mos_reg(port->serial, port->port_number, MCR,
1302 mos7720_port->shadowMCR);
1308 static void mos7720_unthrottle(struct tty_struct *tty)
1310 struct usb_serial_port *port = tty->driver_data;
1311 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1314 if (mos7720_port == NULL)
1317 if (!mos7720_port->open) {
1318 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1322 /* if we are implementing XON/XOFF, send the start character */
1324 unsigned char start_char = START_CHAR(tty);
1325 status = mos7720_write(tty, port, &start_char, 1);
1330 /* if we are implementing RTS/CTS, toggle that line */
1331 if (tty->termios.c_cflag & CRTSCTS) {
1332 mos7720_port->shadowMCR |= UART_MCR_RTS;
1333 write_mos_reg(port->serial, port->port_number, MCR,
1334 mos7720_port->shadowMCR);
1340 /* FIXME: this function does not work */
1341 static int set_higher_rates(struct moschip_port *mos7720_port,
1344 struct usb_serial_port *port;
1345 struct usb_serial *serial;
1347 enum mos_regs sp_reg;
1348 if (mos7720_port == NULL)
1351 port = mos7720_port->port;
1352 serial = port->serial;
1354 /***********************************************
1355 * Init Sequence for higher rates
1356 ***********************************************/
1357 dev_dbg(&port->dev, "Sending Setting Commands ..........\n");
1358 port_number = port->port_number;
1360 write_mos_reg(serial, port_number, IER, 0x00);
1361 write_mos_reg(serial, port_number, FCR, 0x00);
1362 write_mos_reg(serial, port_number, FCR, 0xcf);
1363 mos7720_port->shadowMCR = 0x0b;
1364 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1365 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x00);
1367 /***********************************************
1368 * Set for higher rates *
1369 ***********************************************/
1370 /* writing baud rate verbatum into uart clock field clearly not right */
1371 if (port_number == 0)
1375 write_mos_reg(serial, dummy, sp_reg, baud * 0x10);
1376 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x03);
1377 mos7720_port->shadowMCR = 0x2b;
1378 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1380 /***********************************************
1382 ***********************************************/
1383 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1384 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1385 write_mos_reg(serial, port_number, DLL, 0x01);
1386 write_mos_reg(serial, port_number, DLM, 0x00);
1387 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1388 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1393 /* baud rate information */
1394 struct divisor_table_entry {
1399 /* Define table of divisors for moschip 7720 hardware *
1400 * These assume a 3.6864MHz crystal, the standard /16, and *
1402 static struct divisor_table_entry divisor_table[] = {
1404 { 110, 1047}, /* 2094.545455 => 230450 => .0217 % over */
1405 { 134, 857}, /* 1713.011152 => 230398.5 => .00065% under */
1421 /*****************************************************************************
1422 * calc_baud_rate_divisor
1423 * this function calculates the proper baud rate divisor for the specified
1425 *****************************************************************************/
1426 static int calc_baud_rate_divisor(struct usb_serial_port *port, int baudrate, int *divisor)
1434 dev_dbg(&port->dev, "%s - %d\n", __func__, baudrate);
1436 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
1437 if (divisor_table[i].baudrate == baudrate) {
1438 *divisor = divisor_table[i].divisor;
1443 /* After trying for all the standard baud rates *
1444 * Try calculating the divisor for this baud rate */
1445 if (baudrate > 75 && baudrate < 230400) {
1446 /* get the divisor */
1447 custom = (__u16)(230400L / baudrate);
1449 /* Check for round off */
1450 round1 = (__u16)(2304000L / baudrate);
1451 round = (__u16)(round1 - (custom * 10));
1456 dev_dbg(&port->dev, "Baud %d = %d\n", baudrate, custom);
1460 dev_dbg(&port->dev, "Baud calculation Failed...\n");
1465 * send_cmd_write_baud_rate
1466 * this function sends the proper command to change the baud rate of the
1469 static int send_cmd_write_baud_rate(struct moschip_port *mos7720_port,
1472 struct usb_serial_port *port;
1473 struct usb_serial *serial;
1476 unsigned char number;
1478 if (mos7720_port == NULL)
1481 port = mos7720_port->port;
1482 serial = port->serial;
1484 number = port->port_number;
1485 dev_dbg(&port->dev, "%s - baud = %d\n", __func__, baudrate);
1487 /* Calculate the Divisor */
1488 status = calc_baud_rate_divisor(port, baudrate, &divisor);
1490 dev_err(&port->dev, "%s - bad baud rate\n", __func__);
1494 /* Enable access to divisor latch */
1495 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1496 write_mos_reg(serial, number, LCR, mos7720_port->shadowLCR);
1498 /* Write the divisor */
1499 write_mos_reg(serial, number, DLL, (__u8)(divisor & 0xff));
1500 write_mos_reg(serial, number, DLM, (__u8)((divisor & 0xff00) >> 8));
1502 /* Disable access to divisor latch */
1503 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1504 write_mos_reg(serial, number, LCR, mos7720_port->shadowLCR);
1510 * change_port_settings
1511 * This routine is called to set the UART on the device to match
1512 * the specified new settings.
1514 static void change_port_settings(struct tty_struct *tty,
1515 struct moschip_port *mos7720_port,
1516 struct ktermios *old_termios)
1518 struct usb_serial_port *port;
1519 struct usb_serial *serial;
1530 if (mos7720_port == NULL)
1533 port = mos7720_port->port;
1534 serial = port->serial;
1535 port_number = port->port_number;
1537 if (!mos7720_port->open) {
1538 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1542 lData = UART_LCR_WLEN8;
1543 lStop = 0x00; /* 1 stop bit */
1544 lParity = 0x00; /* No parity */
1546 cflag = tty->termios.c_cflag;
1547 iflag = tty->termios.c_iflag;
1549 /* Change the number of bits */
1550 switch (cflag & CSIZE) {
1552 lData = UART_LCR_WLEN5;
1557 lData = UART_LCR_WLEN6;
1562 lData = UART_LCR_WLEN7;
1567 lData = UART_LCR_WLEN8;
1571 /* Change the Parity bit */
1572 if (cflag & PARENB) {
1573 if (cflag & PARODD) {
1574 lParity = UART_LCR_PARITY;
1575 dev_dbg(&port->dev, "%s - parity = odd\n", __func__);
1577 lParity = (UART_LCR_EPAR | UART_LCR_PARITY);
1578 dev_dbg(&port->dev, "%s - parity = even\n", __func__);
1582 dev_dbg(&port->dev, "%s - parity = none\n", __func__);
1586 lParity = lParity | 0x20;
1588 /* Change the Stop bit */
1589 if (cflag & CSTOPB) {
1590 lStop = UART_LCR_STOP;
1591 dev_dbg(&port->dev, "%s - stop bits = 2\n", __func__);
1594 dev_dbg(&port->dev, "%s - stop bits = 1\n", __func__);
1597 #define LCR_BITS_MASK 0x03 /* Mask for bits/char field */
1598 #define LCR_STOP_MASK 0x04 /* Mask for stop bits field */
1599 #define LCR_PAR_MASK 0x38 /* Mask for parity field */
1601 /* Update the LCR with the correct value */
1602 mos7720_port->shadowLCR &=
1603 ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
1604 mos7720_port->shadowLCR |= (lData | lParity | lStop);
1607 /* Disable Interrupts */
1608 write_mos_reg(serial, port_number, IER, 0x00);
1609 write_mos_reg(serial, port_number, FCR, 0x00);
1610 write_mos_reg(serial, port_number, FCR, 0xcf);
1612 /* Send the updated LCR value to the mos7720 */
1613 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1614 mos7720_port->shadowMCR = 0x0b;
1615 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1617 /* set up the MCR register and send it to the mos7720 */
1618 mos7720_port->shadowMCR = UART_MCR_OUT2;
1620 mos7720_port->shadowMCR |= (UART_MCR_DTR | UART_MCR_RTS);
1622 if (cflag & CRTSCTS) {
1623 mos7720_port->shadowMCR |= (UART_MCR_XONANY);
1624 /* To set hardware flow control to the specified *
1625 * serial port, in SP1/2_CONTROL_REG */
1627 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x01);
1629 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x02);
1632 mos7720_port->shadowMCR &= ~(UART_MCR_XONANY);
1634 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1636 /* Determine divisor based on baud rate */
1637 baud = tty_get_baud_rate(tty);
1639 /* pick a default, any default... */
1640 dev_dbg(&port->dev, "Picked default baud...\n");
1644 if (baud >= 230400) {
1645 set_higher_rates(mos7720_port, baud);
1646 /* Enable Interrupts */
1647 write_mos_reg(serial, port_number, IER, 0x0c);
1651 dev_dbg(&port->dev, "%s - baud rate = %d\n", __func__, baud);
1652 status = send_cmd_write_baud_rate(mos7720_port, baud);
1653 /* FIXME: needs to write actual resulting baud back not just
1656 tty_encode_baud_rate(tty, baud, baud);
1657 /* Enable Interrupts */
1658 write_mos_reg(serial, port_number, IER, 0x0c);
1660 if (port->read_urb->status != -EINPROGRESS) {
1661 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1663 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1668 * mos7720_set_termios
1669 * this function is called by the tty driver when it wants to change the
1670 * termios structure.
1672 static void mos7720_set_termios(struct tty_struct *tty,
1673 struct usb_serial_port *port, struct ktermios *old_termios)
1677 struct usb_serial *serial;
1678 struct moschip_port *mos7720_port;
1680 serial = port->serial;
1682 mos7720_port = usb_get_serial_port_data(port);
1684 if (mos7720_port == NULL)
1687 if (!mos7720_port->open) {
1688 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1692 dev_dbg(&port->dev, "setting termios - ASPIRE\n");
1694 cflag = tty->termios.c_cflag;
1696 dev_dbg(&port->dev, "%s - cflag %08x iflag %08x\n", __func__,
1697 tty->termios.c_cflag, RELEVANT_IFLAG(tty->termios.c_iflag));
1699 dev_dbg(&port->dev, "%s - old cflag %08x old iflag %08x\n", __func__,
1700 old_termios->c_cflag, RELEVANT_IFLAG(old_termios->c_iflag));
1702 /* change the port settings to the new ones specified */
1703 change_port_settings(tty, mos7720_port, old_termios);
1705 if (port->read_urb->status != -EINPROGRESS) {
1706 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1708 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1713 * get_lsr_info - get line status register info
1715 * Purpose: Let user call ioctl() to get info when the UART physically
1716 * is emptied. On bus types like RS485, the transmitter must
1717 * release the bus after transmitting. This must be done when
1718 * the transmit shift register is empty, not be done when the
1719 * transmit holding register is empty. This functionality
1720 * allows an RS485 driver to be written in user space.
1722 static int get_lsr_info(struct tty_struct *tty,
1723 struct moschip_port *mos7720_port, unsigned int __user *value)
1725 struct usb_serial_port *port = tty->driver_data;
1726 unsigned int result = 0;
1727 unsigned char data = 0;
1728 int port_number = port->port_number;
1731 count = mos7720_chars_in_buffer(tty);
1733 read_mos_reg(port->serial, port_number, LSR, &data);
1734 if ((data & (UART_LSR_TEMT | UART_LSR_THRE))
1735 == (UART_LSR_TEMT | UART_LSR_THRE)) {
1736 dev_dbg(&port->dev, "%s -- Empty\n", __func__);
1737 result = TIOCSER_TEMT;
1740 if (copy_to_user(value, &result, sizeof(int)))
1745 static int mos7720_tiocmget(struct tty_struct *tty)
1747 struct usb_serial_port *port = tty->driver_data;
1748 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1749 unsigned int result = 0;
1753 mcr = mos7720_port->shadowMCR;
1754 msr = mos7720_port->shadowMSR;
1756 result = ((mcr & UART_MCR_DTR) ? TIOCM_DTR : 0) /* 0x002 */
1757 | ((mcr & UART_MCR_RTS) ? TIOCM_RTS : 0) /* 0x004 */
1758 | ((msr & UART_MSR_CTS) ? TIOCM_CTS : 0) /* 0x020 */
1759 | ((msr & UART_MSR_DCD) ? TIOCM_CAR : 0) /* 0x040 */
1760 | ((msr & UART_MSR_RI) ? TIOCM_RI : 0) /* 0x080 */
1761 | ((msr & UART_MSR_DSR) ? TIOCM_DSR : 0); /* 0x100 */
1766 static int mos7720_tiocmset(struct tty_struct *tty,
1767 unsigned int set, unsigned int clear)
1769 struct usb_serial_port *port = tty->driver_data;
1770 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1773 mcr = mos7720_port->shadowMCR;
1775 if (set & TIOCM_RTS)
1776 mcr |= UART_MCR_RTS;
1777 if (set & TIOCM_DTR)
1778 mcr |= UART_MCR_DTR;
1779 if (set & TIOCM_LOOP)
1780 mcr |= UART_MCR_LOOP;
1782 if (clear & TIOCM_RTS)
1783 mcr &= ~UART_MCR_RTS;
1784 if (clear & TIOCM_DTR)
1785 mcr &= ~UART_MCR_DTR;
1786 if (clear & TIOCM_LOOP)
1787 mcr &= ~UART_MCR_LOOP;
1789 mos7720_port->shadowMCR = mcr;
1790 write_mos_reg(port->serial, port->port_number, MCR,
1791 mos7720_port->shadowMCR);
1796 static int set_modem_info(struct moschip_port *mos7720_port, unsigned int cmd,
1797 unsigned int __user *value)
1802 struct usb_serial_port *port;
1804 if (mos7720_port == NULL)
1807 port = (struct usb_serial_port *)mos7720_port->port;
1808 mcr = mos7720_port->shadowMCR;
1810 if (copy_from_user(&arg, value, sizeof(int)))
1815 if (arg & TIOCM_RTS)
1816 mcr |= UART_MCR_RTS;
1817 if (arg & TIOCM_DTR)
1818 mcr |= UART_MCR_RTS;
1819 if (arg & TIOCM_LOOP)
1820 mcr |= UART_MCR_LOOP;
1824 if (arg & TIOCM_RTS)
1825 mcr &= ~UART_MCR_RTS;
1826 if (arg & TIOCM_DTR)
1827 mcr &= ~UART_MCR_RTS;
1828 if (arg & TIOCM_LOOP)
1829 mcr &= ~UART_MCR_LOOP;
1834 mos7720_port->shadowMCR = mcr;
1835 write_mos_reg(port->serial, port->port_number, MCR,
1836 mos7720_port->shadowMCR);
1841 static int get_serial_info(struct moschip_port *mos7720_port,
1842 struct serial_struct __user *retinfo)
1844 struct serial_struct tmp;
1849 memset(&tmp, 0, sizeof(tmp));
1851 tmp.type = PORT_16550A;
1852 tmp.line = mos7720_port->port->minor;
1853 tmp.port = mos7720_port->port->port_number;
1855 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1856 tmp.xmit_fifo_size = NUM_URBS * URB_TRANSFER_BUFFER_SIZE;
1857 tmp.baud_base = 9600;
1858 tmp.close_delay = 5*HZ;
1859 tmp.closing_wait = 30*HZ;
1861 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1866 static int mos7720_ioctl(struct tty_struct *tty,
1867 unsigned int cmd, unsigned long arg)
1869 struct usb_serial_port *port = tty->driver_data;
1870 struct moschip_port *mos7720_port;
1872 mos7720_port = usb_get_serial_port_data(port);
1873 if (mos7720_port == NULL)
1878 dev_dbg(&port->dev, "%s TIOCSERGETLSR\n", __func__);
1879 return get_lsr_info(tty, mos7720_port,
1880 (unsigned int __user *)arg);
1882 /* FIXME: These should be using the mode methods */
1885 dev_dbg(&port->dev, "%s TIOCMSET/TIOCMBIC/TIOCMSET\n", __func__);
1886 return set_modem_info(mos7720_port, cmd,
1887 (unsigned int __user *)arg);
1890 dev_dbg(&port->dev, "%s TIOCGSERIAL\n", __func__);
1891 return get_serial_info(mos7720_port,
1892 (struct serial_struct __user *)arg);
1895 return -ENOIOCTLCMD;
1898 static int mos7720_startup(struct usb_serial *serial)
1900 struct usb_device *dev;
1905 product = le16_to_cpu(serial->dev->descriptor.idProduct);
1909 * The 7715 uses the first bulk in/out endpoint pair for the parallel
1910 * port, and the second for the serial port. Because the usbserial core
1911 * assumes both pairs are serial ports, we must engage in a bit of
1912 * subterfuge and swap the pointers for ports 0 and 1 in order to make
1913 * port 0 point to the serial port. However, both moschip devices use a
1914 * single interrupt-in endpoint for both ports (as mentioned a little
1915 * further down), and this endpoint was assigned to port 0. So after
1916 * the swap, we must copy the interrupt endpoint elements from port 1
1917 * (as newly assigned) to port 0, and null out port 1 pointers.
1919 if (product == MOSCHIP_DEVICE_ID_7715) {
1920 struct usb_serial_port *tmp = serial->port[0];
1921 serial->port[0] = serial->port[1];
1922 serial->port[1] = tmp;
1923 serial->port[0]->interrupt_in_urb = tmp->interrupt_in_urb;
1924 serial->port[0]->interrupt_in_buffer = tmp->interrupt_in_buffer;
1925 serial->port[0]->interrupt_in_endpointAddress =
1926 tmp->interrupt_in_endpointAddress;
1927 serial->port[1]->interrupt_in_urb = NULL;
1928 serial->port[1]->interrupt_in_buffer = NULL;
1931 /* setting configuration feature to one */
1932 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
1933 (__u8)0x03, 0x00, 0x01, 0x00, NULL, 0x00, 5000);
1935 /* start the interrupt urb */
1936 ret_val = usb_submit_urb(serial->port[0]->interrupt_in_urb, GFP_KERNEL);
1939 "%s - Error %d submitting control urb\n",
1942 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
1943 if (product == MOSCHIP_DEVICE_ID_7715) {
1944 ret_val = mos7715_parport_init(serial);
1949 /* LSR For Port 1 */
1950 read_mos_reg(serial, 0, LSR, &data);
1951 dev_dbg(&dev->dev, "LSR:%x\n", data);
1956 static void mos7720_release(struct usb_serial *serial)
1958 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
1959 /* close the parallel port */
1961 if (le16_to_cpu(serial->dev->descriptor.idProduct)
1962 == MOSCHIP_DEVICE_ID_7715) {
1963 struct urbtracker *urbtrack;
1964 unsigned long flags;
1965 struct mos7715_parport *mos_parport =
1966 usb_get_serial_data(serial);
1968 /* prevent NULL ptr dereference in port callbacks */
1969 spin_lock(&release_lock);
1970 mos_parport->pp->private_data = NULL;
1971 spin_unlock(&release_lock);
1973 /* wait for synchronous usb calls to return */
1974 if (mos_parport->msg_pending)
1975 wait_for_completion_timeout(&mos_parport->syncmsg_compl,
1976 msecs_to_jiffies(MOS_WDR_TIMEOUT));
1978 parport_remove_port(mos_parport->pp);
1979 usb_set_serial_data(serial, NULL);
1980 mos_parport->serial = NULL;
1982 /* if tasklet currently scheduled, wait for it to complete */
1983 tasklet_kill(&mos_parport->urb_tasklet);
1985 /* unlink any urbs sent by the tasklet */
1986 spin_lock_irqsave(&mos_parport->listlock, flags);
1987 list_for_each_entry(urbtrack,
1988 &mos_parport->active_urbs,
1990 usb_unlink_urb(urbtrack->urb);
1991 spin_unlock_irqrestore(&mos_parport->listlock, flags);
1993 kref_put(&mos_parport->ref_count, destroy_mos_parport);
1998 static int mos7720_port_probe(struct usb_serial_port *port)
2000 struct moschip_port *mos7720_port;
2002 mos7720_port = kzalloc(sizeof(*mos7720_port), GFP_KERNEL);
2006 /* Initialize all port interrupt end point to port 0 int endpoint.
2007 * Our device has only one interrupt endpoint common to all ports.
2009 port->interrupt_in_endpointAddress =
2010 port->serial->port[0]->interrupt_in_endpointAddress;
2011 mos7720_port->port = port;
2013 usb_set_serial_port_data(port, mos7720_port);
2018 static int mos7720_port_remove(struct usb_serial_port *port)
2020 struct moschip_port *mos7720_port;
2022 mos7720_port = usb_get_serial_port_data(port);
2023 kfree(mos7720_port);
2028 static struct usb_serial_driver moschip7720_2port_driver = {
2030 .owner = THIS_MODULE,
2031 .name = "moschip7720",
2033 .description = "Moschip 2 port adapter",
2034 .id_table = id_table,
2035 .calc_num_ports = mos77xx_calc_num_ports,
2036 .open = mos7720_open,
2037 .close = mos7720_close,
2038 .throttle = mos7720_throttle,
2039 .unthrottle = mos7720_unthrottle,
2040 .probe = mos77xx_probe,
2041 .attach = mos7720_startup,
2042 .release = mos7720_release,
2043 .port_probe = mos7720_port_probe,
2044 .port_remove = mos7720_port_remove,
2045 .ioctl = mos7720_ioctl,
2046 .tiocmget = mos7720_tiocmget,
2047 .tiocmset = mos7720_tiocmset,
2048 .set_termios = mos7720_set_termios,
2049 .write = mos7720_write,
2050 .write_room = mos7720_write_room,
2051 .chars_in_buffer = mos7720_chars_in_buffer,
2052 .break_ctl = mos7720_break,
2053 .read_bulk_callback = mos7720_bulk_in_callback,
2054 .read_int_callback = NULL /* dynamically assigned in probe() */
2057 static struct usb_serial_driver * const serial_drivers[] = {
2058 &moschip7720_2port_driver, NULL
2061 module_usb_serial_driver(serial_drivers, id_table);
2063 MODULE_AUTHOR(DRIVER_AUTHOR);
2064 MODULE_DESCRIPTION(DRIVER_DESC);
2065 MODULE_LICENSE("GPL");