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>
37 #include <linux/parport.h>
42 #define DRIVER_VERSION "2.1"
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_MAX_PORT 0x02
50 #define MOS_WRITE 0x0E
53 /* Interrupt Rotinue Defines */
54 #define SERIAL_IIR_RLS 0x06
55 #define SERIAL_IIR_RDA 0x04
56 #define SERIAL_IIR_CTI 0x0c
57 #define SERIAL_IIR_THR 0x02
58 #define SERIAL_IIR_MS 0x00
60 #define NUM_URBS 16 /* URB Count */
61 #define URB_TRANSFER_BUFFER_SIZE 32 /* URB Size */
63 /* This structure holds all of the local serial port information */
65 __u8 shadowLCR; /* last LCR value received */
66 __u8 shadowMCR; /* last MCR value received */
67 __u8 shadowMSR; /* last MSR value received */
69 struct async_icount icount;
70 struct usb_serial_port *port; /* loop back to the owner */
71 struct urb *write_urb_pool[NUM_URBS];
76 static struct usb_serial_driver moschip7720_2port_driver;
78 #define USB_VENDOR_ID_MOSCHIP 0x9710
79 #define MOSCHIP_DEVICE_ID_7720 0x7720
80 #define MOSCHIP_DEVICE_ID_7715 0x7715
82 static const struct usb_device_id id_table[] = {
83 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7720) },
84 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7715) },
85 { } /* terminating entry */
87 MODULE_DEVICE_TABLE(usb, id_table);
89 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
91 /* initial values for parport regs */
92 #define DCR_INIT_VAL 0x0c /* SLCTIN, nINIT */
93 #define ECR_INIT_VAL 0x00 /* SPP mode */
96 struct mos7715_parport *mos_parport;
97 struct list_head urblist_entry;
98 struct kref ref_count;
102 enum mos7715_pp_modes {
104 PS2 = 1<<5, /* moschip calls this 'NIBBLE' mode */
105 PPF = 2<<5, /* moschip calls this 'CB-FIFO mode */
108 struct mos7715_parport {
109 struct parport *pp; /* back to containing struct */
110 struct kref ref_count; /* to instance of this struct */
111 struct list_head deferred_urbs; /* list deferred async urbs */
112 struct list_head active_urbs; /* list async urbs in flight */
113 spinlock_t listlock; /* protects list access */
114 bool msg_pending; /* usb sync call pending */
115 struct completion syncmsg_compl; /* usb sync call completed */
116 struct tasklet_struct urb_tasklet; /* for sending deferred urbs */
117 struct usb_serial *serial; /* back to containing struct */
118 __u8 shadowECR; /* parallel port regs... */
120 atomic_t shadowDSR; /* updated in int-in callback */
123 /* lock guards against dereferencing NULL ptr in parport ops callbacks */
124 static DEFINE_SPINLOCK(release_lock);
126 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
128 static const unsigned int dummy; /* for clarity in register access fns */
131 THR, /* serial port regs */
143 DPR, /* parallel port regs */
147 SP1_REG, /* device control regs */
148 SP2_REG, /* serial port 2 (7720 only) */
154 * Return the correct value for the Windex field of the setup packet
155 * for a control endpoint message. See the 7715 datasheet.
157 static inline __u16 get_reg_index(enum mos_regs reg)
159 static const __u16 mos7715_index_lookup_table[] = {
177 0x02, /* SP2_REG (7720 only) */
178 0x04, /* PP_REG (7715 only) */
179 0x08, /* SP_CONTROL_REG */
181 return mos7715_index_lookup_table[reg];
185 * Return the correct value for the upper byte of the Wvalue field of
186 * the setup packet for a control endpoint message.
188 static inline __u16 get_reg_value(enum mos_regs reg,
189 unsigned int serial_portnum)
191 if (reg >= SP1_REG) /* control reg */
194 else if (reg >= DPR) /* parallel port reg (7715 only) */
197 else /* serial port reg */
198 return (serial_portnum + 2) << 8;
202 * Write data byte to the specified device register. The data is embedded in
203 * the value field of the setup packet. serial_portnum is ignored for registers
204 * not specific to a particular serial port.
206 static int write_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
207 enum mos_regs reg, __u8 data)
209 struct usb_device *usbdev = serial->dev;
210 unsigned int pipe = usb_sndctrlpipe(usbdev, 0);
211 __u8 request = (__u8)0x0e;
212 __u8 requesttype = (__u8)0x40;
213 __u16 index = get_reg_index(reg);
214 __u16 value = get_reg_value(reg, serial_portnum) + data;
215 int status = usb_control_msg(usbdev, pipe, request, requesttype, value,
216 index, NULL, 0, MOS_WDR_TIMEOUT);
218 dev_err(&usbdev->dev,
219 "mos7720: usb_control_msg() failed: %d", status);
224 * Read data byte from the specified device register. The data returned by the
225 * device is embedded in the value field of the setup packet. serial_portnum is
226 * ignored for registers that are not specific to a particular serial port.
228 static int read_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
229 enum mos_regs reg, __u8 *data)
231 struct usb_device *usbdev = serial->dev;
232 unsigned int pipe = usb_rcvctrlpipe(usbdev, 0);
233 __u8 request = (__u8)0x0d;
234 __u8 requesttype = (__u8)0xc0;
235 __u16 index = get_reg_index(reg);
236 __u16 value = get_reg_value(reg, serial_portnum);
237 int status = usb_control_msg(usbdev, pipe, request, requesttype, value,
238 index, data, 1, MOS_WDR_TIMEOUT);
240 dev_err(&usbdev->dev,
241 "mos7720: usb_control_msg() failed: %d", status);
245 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
247 static inline int mos7715_change_mode(struct mos7715_parport *mos_parport,
248 enum mos7715_pp_modes mode)
250 mos_parport->shadowECR = mode;
251 write_mos_reg(mos_parport->serial, dummy, ECR, mos_parport->shadowECR);
255 static void destroy_mos_parport(struct kref *kref)
257 struct mos7715_parport *mos_parport =
258 container_of(kref, struct mos7715_parport, ref_count);
263 static void destroy_urbtracker(struct kref *kref)
265 struct urbtracker *urbtrack =
266 container_of(kref, struct urbtracker, ref_count);
267 struct mos7715_parport *mos_parport = urbtrack->mos_parport;
269 usb_free_urb(urbtrack->urb);
271 kref_put(&mos_parport->ref_count, destroy_mos_parport);
275 * This runs as a tasklet when sending an urb in a non-blocking parallel
276 * port callback had to be deferred because the disconnect mutex could not be
277 * obtained at the time.
279 static void send_deferred_urbs(unsigned long _mos_parport)
283 struct mos7715_parport *mos_parport = (void *)_mos_parport;
284 struct urbtracker *urbtrack, *tmp;
285 struct list_head *cursor, *next;
288 /* if release function ran, game over */
289 if (unlikely(mos_parport->serial == NULL))
292 dev = &mos_parport->serial->dev->dev;
294 /* try again to get the mutex */
295 if (!mutex_trylock(&mos_parport->serial->disc_mutex)) {
296 dev_dbg(dev, "%s: rescheduling tasklet\n", __func__);
297 tasklet_schedule(&mos_parport->urb_tasklet);
301 /* if device disconnected, game over */
302 if (unlikely(mos_parport->serial->disconnected)) {
303 mutex_unlock(&mos_parport->serial->disc_mutex);
307 spin_lock_irqsave(&mos_parport->listlock, flags);
308 if (list_empty(&mos_parport->deferred_urbs)) {
309 spin_unlock_irqrestore(&mos_parport->listlock, flags);
310 mutex_unlock(&mos_parport->serial->disc_mutex);
311 dev_dbg(dev, "%s: deferred_urbs list empty\n", __func__);
315 /* move contents of deferred_urbs list to active_urbs list and submit */
316 list_for_each_safe(cursor, next, &mos_parport->deferred_urbs)
317 list_move_tail(cursor, &mos_parport->active_urbs);
318 list_for_each_entry_safe(urbtrack, tmp, &mos_parport->active_urbs,
320 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
321 dev_dbg(dev, "%s: urb submitted\n", __func__);
323 dev_err(dev, "usb_submit_urb() failed: %d\n", ret_val);
324 list_del(&urbtrack->urblist_entry);
325 kref_put(&urbtrack->ref_count, destroy_urbtracker);
328 spin_unlock_irqrestore(&mos_parport->listlock, flags);
329 mutex_unlock(&mos_parport->serial->disc_mutex);
332 /* callback for parallel port control urbs submitted asynchronously */
333 static void async_complete(struct urb *urb)
335 struct urbtracker *urbtrack = urb->context;
336 int status = urb->status;
338 if (unlikely(status))
339 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
341 /* remove the urbtracker from the active_urbs list */
342 spin_lock(&urbtrack->mos_parport->listlock);
343 list_del(&urbtrack->urblist_entry);
344 spin_unlock(&urbtrack->mos_parport->listlock);
345 kref_put(&urbtrack->ref_count, destroy_urbtracker);
348 static int write_parport_reg_nonblock(struct mos7715_parport *mos_parport,
349 enum mos_regs reg, __u8 data)
351 struct urbtracker *urbtrack;
354 struct usb_ctrlrequest setup;
355 struct usb_serial *serial = mos_parport->serial;
356 struct usb_device *usbdev = serial->dev;
358 /* create and initialize the control urb and containing urbtracker */
359 urbtrack = kmalloc(sizeof(struct urbtracker), GFP_ATOMIC);
360 if (urbtrack == NULL) {
361 dev_err(&usbdev->dev, "out of memory");
364 kref_get(&mos_parport->ref_count);
365 urbtrack->mos_parport = mos_parport;
366 urbtrack->urb = usb_alloc_urb(0, GFP_ATOMIC);
367 if (urbtrack->urb == NULL) {
368 dev_err(&usbdev->dev, "out of urbs");
372 setup.bRequestType = (__u8)0x40;
373 setup.bRequest = (__u8)0x0e;
374 setup.wValue = get_reg_value(reg, dummy);
375 setup.wIndex = get_reg_index(reg);
377 usb_fill_control_urb(urbtrack->urb, usbdev,
378 usb_sndctrlpipe(usbdev, 0),
379 (unsigned char *)&setup,
380 NULL, 0, async_complete, urbtrack);
381 kref_init(&urbtrack->ref_count);
382 INIT_LIST_HEAD(&urbtrack->urblist_entry);
385 * get the disconnect mutex, or add tracker to the deferred_urbs list
386 * and schedule a tasklet to try again later
388 if (!mutex_trylock(&serial->disc_mutex)) {
389 spin_lock_irqsave(&mos_parport->listlock, flags);
390 list_add_tail(&urbtrack->urblist_entry,
391 &mos_parport->deferred_urbs);
392 spin_unlock_irqrestore(&mos_parport->listlock, flags);
393 tasklet_schedule(&mos_parport->urb_tasklet);
394 dev_dbg(&usbdev->dev, "tasklet scheduled");
398 /* bail if device disconnected */
399 if (serial->disconnected) {
400 kref_put(&urbtrack->ref_count, destroy_urbtracker);
401 mutex_unlock(&serial->disc_mutex);
405 /* add the tracker to the active_urbs list and submit */
406 spin_lock_irqsave(&mos_parport->listlock, flags);
407 list_add_tail(&urbtrack->urblist_entry, &mos_parport->active_urbs);
408 spin_unlock_irqrestore(&mos_parport->listlock, flags);
409 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
410 mutex_unlock(&serial->disc_mutex);
412 dev_err(&usbdev->dev,
413 "%s: submit_urb() failed: %d", __func__, ret_val);
414 spin_lock_irqsave(&mos_parport->listlock, flags);
415 list_del(&urbtrack->urblist_entry);
416 spin_unlock_irqrestore(&mos_parport->listlock, flags);
417 kref_put(&urbtrack->ref_count, destroy_urbtracker);
424 * This is the the common top part of all parallel port callback operations that
425 * send synchronous messages to the device. This implements convoluted locking
426 * that avoids two scenarios: (1) a port operation is called after usbserial
427 * has called our release function, at which point struct mos7715_parport has
428 * been destroyed, and (2) the device has been disconnected, but usbserial has
429 * not called the release function yet because someone has a serial port open.
430 * The shared release_lock prevents the first, and the mutex and disconnected
431 * flag maintained by usbserial covers the second. We also use the msg_pending
432 * flag to ensure that all synchronous usb messgage calls have completed before
433 * our release function can return.
435 static int parport_prologue(struct parport *pp)
437 struct mos7715_parport *mos_parport;
439 spin_lock(&release_lock);
440 mos_parport = pp->private_data;
441 if (unlikely(mos_parport == NULL)) {
442 /* release fn called, port struct destroyed */
443 spin_unlock(&release_lock);
446 mos_parport->msg_pending = true; /* synch usb call pending */
447 INIT_COMPLETION(mos_parport->syncmsg_compl);
448 spin_unlock(&release_lock);
450 mutex_lock(&mos_parport->serial->disc_mutex);
451 if (mos_parport->serial->disconnected) {
452 /* device disconnected */
453 mutex_unlock(&mos_parport->serial->disc_mutex);
454 mos_parport->msg_pending = false;
455 complete(&mos_parport->syncmsg_compl);
463 * This is the the common bottom part of all parallel port functions that send
464 * synchronous messages to the device.
466 static inline void parport_epilogue(struct parport *pp)
468 struct mos7715_parport *mos_parport = pp->private_data;
469 mutex_unlock(&mos_parport->serial->disc_mutex);
470 mos_parport->msg_pending = false;
471 complete(&mos_parport->syncmsg_compl);
474 static void parport_mos7715_write_data(struct parport *pp, unsigned char d)
476 struct mos7715_parport *mos_parport = pp->private_data;
478 if (parport_prologue(pp) < 0)
480 mos7715_change_mode(mos_parport, SPP);
481 write_mos_reg(mos_parport->serial, dummy, DPR, (__u8)d);
482 parport_epilogue(pp);
485 static unsigned char parport_mos7715_read_data(struct parport *pp)
487 struct mos7715_parport *mos_parport = pp->private_data;
490 if (parport_prologue(pp) < 0)
492 read_mos_reg(mos_parport->serial, dummy, DPR, &d);
493 parport_epilogue(pp);
497 static void parport_mos7715_write_control(struct parport *pp, unsigned char d)
499 struct mos7715_parport *mos_parport = pp->private_data;
502 if (parport_prologue(pp) < 0)
504 data = ((__u8)d & 0x0f) | (mos_parport->shadowDCR & 0xf0);
505 write_mos_reg(mos_parport->serial, dummy, DCR, data);
506 mos_parport->shadowDCR = data;
507 parport_epilogue(pp);
510 static unsigned char parport_mos7715_read_control(struct parport *pp)
512 struct mos7715_parport *mos_parport = pp->private_data;
515 spin_lock(&release_lock);
516 mos_parport = pp->private_data;
517 if (unlikely(mos_parport == NULL)) {
518 spin_unlock(&release_lock);
521 dcr = mos_parport->shadowDCR & 0x0f;
522 spin_unlock(&release_lock);
526 static unsigned char parport_mos7715_frob_control(struct parport *pp,
530 struct mos7715_parport *mos_parport = pp->private_data;
535 if (parport_prologue(pp) < 0)
537 mos_parport->shadowDCR = (mos_parport->shadowDCR & (~mask)) ^ val;
538 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
539 dcr = mos_parport->shadowDCR & 0x0f;
540 parport_epilogue(pp);
544 static unsigned char parport_mos7715_read_status(struct parport *pp)
546 unsigned char status;
547 struct mos7715_parport *mos_parport = pp->private_data;
549 spin_lock(&release_lock);
550 mos_parport = pp->private_data;
551 if (unlikely(mos_parport == NULL)) { /* release called */
552 spin_unlock(&release_lock);
555 status = atomic_read(&mos_parport->shadowDSR) & 0xf8;
556 spin_unlock(&release_lock);
560 static void parport_mos7715_enable_irq(struct parport *pp)
564 static void parport_mos7715_disable_irq(struct parport *pp)
568 static void parport_mos7715_data_forward(struct parport *pp)
570 struct mos7715_parport *mos_parport = pp->private_data;
572 if (parport_prologue(pp) < 0)
574 mos7715_change_mode(mos_parport, PS2);
575 mos_parport->shadowDCR &= ~0x20;
576 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
577 parport_epilogue(pp);
580 static void parport_mos7715_data_reverse(struct parport *pp)
582 struct mos7715_parport *mos_parport = pp->private_data;
584 if (parport_prologue(pp) < 0)
586 mos7715_change_mode(mos_parport, PS2);
587 mos_parport->shadowDCR |= 0x20;
588 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
589 parport_epilogue(pp);
592 static void parport_mos7715_init_state(struct pardevice *dev,
593 struct parport_state *s)
595 s->u.pc.ctr = DCR_INIT_VAL;
596 s->u.pc.ecr = ECR_INIT_VAL;
599 /* N.B. Parport core code requires that this function not block */
600 static void parport_mos7715_save_state(struct parport *pp,
601 struct parport_state *s)
603 struct mos7715_parport *mos_parport;
605 spin_lock(&release_lock);
606 mos_parport = pp->private_data;
607 if (unlikely(mos_parport == NULL)) { /* release called */
608 spin_unlock(&release_lock);
611 s->u.pc.ctr = mos_parport->shadowDCR;
612 s->u.pc.ecr = mos_parport->shadowECR;
613 spin_unlock(&release_lock);
616 /* N.B. Parport core code requires that this function not block */
617 static void parport_mos7715_restore_state(struct parport *pp,
618 struct parport_state *s)
620 struct mos7715_parport *mos_parport;
622 spin_lock(&release_lock);
623 mos_parport = pp->private_data;
624 if (unlikely(mos_parport == NULL)) { /* release called */
625 spin_unlock(&release_lock);
628 write_parport_reg_nonblock(mos_parport, DCR, mos_parport->shadowDCR);
629 write_parport_reg_nonblock(mos_parport, ECR, mos_parport->shadowECR);
630 spin_unlock(&release_lock);
633 static size_t parport_mos7715_write_compat(struct parport *pp,
635 size_t len, int flags)
638 struct mos7715_parport *mos_parport = pp->private_data;
641 if (parport_prologue(pp) < 0)
643 mos7715_change_mode(mos_parport, PPF);
644 retval = usb_bulk_msg(mos_parport->serial->dev,
645 usb_sndbulkpipe(mos_parport->serial->dev, 2),
646 (void *)buffer, len, &actual_len,
648 parport_epilogue(pp);
650 dev_err(&mos_parport->serial->dev->dev,
651 "mos7720: usb_bulk_msg() failed: %d", retval);
657 static struct parport_operations parport_mos7715_ops = {
658 .owner = THIS_MODULE,
659 .write_data = parport_mos7715_write_data,
660 .read_data = parport_mos7715_read_data,
662 .write_control = parport_mos7715_write_control,
663 .read_control = parport_mos7715_read_control,
664 .frob_control = parport_mos7715_frob_control,
666 .read_status = parport_mos7715_read_status,
668 .enable_irq = parport_mos7715_enable_irq,
669 .disable_irq = parport_mos7715_disable_irq,
671 .data_forward = parport_mos7715_data_forward,
672 .data_reverse = parport_mos7715_data_reverse,
674 .init_state = parport_mos7715_init_state,
675 .save_state = parport_mos7715_save_state,
676 .restore_state = parport_mos7715_restore_state,
678 .compat_write_data = parport_mos7715_write_compat,
680 .nibble_read_data = parport_ieee1284_read_nibble,
681 .byte_read_data = parport_ieee1284_read_byte,
685 * Allocate and initialize parallel port control struct, initialize
686 * the parallel port hardware device, and register with the parport subsystem.
688 static int mos7715_parport_init(struct usb_serial *serial)
690 struct mos7715_parport *mos_parport;
692 /* allocate and initialize parallel port control struct */
693 mos_parport = kzalloc(sizeof(struct mos7715_parport), GFP_KERNEL);
694 if (mos_parport == NULL) {
695 dev_dbg(&serial->dev->dev, "%s: kzalloc failed\n", __func__);
698 mos_parport->msg_pending = false;
699 kref_init(&mos_parport->ref_count);
700 spin_lock_init(&mos_parport->listlock);
701 INIT_LIST_HEAD(&mos_parport->active_urbs);
702 INIT_LIST_HEAD(&mos_parport->deferred_urbs);
703 usb_set_serial_data(serial, mos_parport); /* hijack private pointer */
704 mos_parport->serial = serial;
705 tasklet_init(&mos_parport->urb_tasklet, send_deferred_urbs,
706 (unsigned long) mos_parport);
707 init_completion(&mos_parport->syncmsg_compl);
709 /* cycle parallel port reset bit */
710 write_mos_reg(mos_parport->serial, dummy, PP_REG, (__u8)0x80);
711 write_mos_reg(mos_parport->serial, dummy, PP_REG, (__u8)0x00);
713 /* initialize device registers */
714 mos_parport->shadowDCR = DCR_INIT_VAL;
715 write_mos_reg(mos_parport->serial, dummy, DCR, mos_parport->shadowDCR);
716 mos_parport->shadowECR = ECR_INIT_VAL;
717 write_mos_reg(mos_parport->serial, dummy, ECR, mos_parport->shadowECR);
719 /* register with parport core */
720 mos_parport->pp = parport_register_port(0, PARPORT_IRQ_NONE,
722 &parport_mos7715_ops);
723 if (mos_parport->pp == NULL) {
724 dev_err(&serial->interface->dev,
725 "Could not register parport\n");
726 kref_put(&mos_parport->ref_count, destroy_mos_parport);
729 mos_parport->pp->private_data = mos_parport;
730 mos_parport->pp->modes = PARPORT_MODE_COMPAT | PARPORT_MODE_PCSPP;
731 mos_parport->pp->dev = &serial->interface->dev;
732 parport_announce_port(mos_parport->pp);
736 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
739 * mos7720_interrupt_callback
740 * this is the callback function for when we have received data on the
741 * interrupt endpoint.
743 static void mos7720_interrupt_callback(struct urb *urb)
747 int status = urb->status;
748 struct device *dev = &urb->dev->dev;
760 /* this urb is terminated, clean up */
761 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
764 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
768 length = urb->actual_length;
769 data = urb->transfer_buffer;
771 /* Moschip get 4 bytes
772 * Byte 1 IIR Port 1 (port.number is 0)
773 * Byte 2 IIR Port 2 (port.number is 1)
774 * Byte 3 --------------
775 * Byte 4 FIFO status for both */
777 /* the above description is inverted
778 * oneukum 2007-03-14 */
780 if (unlikely(length != 4)) {
781 dev_dbg(dev, "Wrong data !!!\n");
788 if ((sp1 | sp2) & 0x01) {
789 /* No Interrupt Pending in both the ports */
790 dev_dbg(dev, "No Interrupt !!!\n");
792 switch (sp1 & 0x0f) {
794 dev_dbg(dev, "Serial Port 1: Receiver status error or address bit detected in 9-bit mode\n");
797 dev_dbg(dev, "Serial Port 1: Receiver time out\n");
800 /* dev_dbg(dev, "Serial Port 1: Modem status change\n"); */
804 switch (sp2 & 0x0f) {
806 dev_dbg(dev, "Serial Port 2: Receiver status error or address bit detected in 9-bit mode\n");
809 dev_dbg(dev, "Serial Port 2: Receiver time out\n");
812 /* dev_dbg(dev, "Serial Port 2: Modem status change\n"); */
818 result = usb_submit_urb(urb, GFP_ATOMIC);
820 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
824 * mos7715_interrupt_callback
825 * this is the 7715's callback function for when we have received data on
826 * the interrupt endpoint.
828 static void mos7715_interrupt_callback(struct urb *urb)
832 int status = urb->status;
833 struct device *dev = &urb->dev->dev;
845 /* this urb is terminated, clean up */
846 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
849 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
853 length = urb->actual_length;
854 data = urb->transfer_buffer;
856 /* Structure of data from 7715 device:
857 * Byte 1: IIR serial Port
859 * Byte 2: DSR parallel port
860 * Byte 4: FIFO status for both */
862 if (unlikely(length != 4)) {
863 dev_dbg(dev, "Wrong data !!!\n");
868 if (!(iir & 0x01)) { /* serial port interrupt pending */
869 switch (iir & 0x0f) {
871 dev_dbg(dev, "Serial Port: Receiver status error or address bit detected in 9-bit mode\n\n");
874 dev_dbg(dev, "Serial Port: Receiver time out\n");
877 /* dev_dbg(dev, "Serial Port: Modem status change\n"); */
882 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
883 { /* update local copy of DSR reg */
884 struct usb_serial_port *port = urb->context;
885 struct mos7715_parport *mos_parport = port->serial->private;
886 if (unlikely(mos_parport == NULL))
888 atomic_set(&mos_parport->shadowDSR, data[2]);
893 result = usb_submit_urb(urb, GFP_ATOMIC);
895 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
899 * mos7720_bulk_in_callback
900 * this is the callback function for when we have received data on the
903 static void mos7720_bulk_in_callback(struct urb *urb)
906 unsigned char *data ;
907 struct usb_serial_port *port;
908 struct tty_struct *tty;
909 int status = urb->status;
912 dev_dbg(&urb->dev->dev, "nonzero read bulk status received: %d\n", status);
918 dev_dbg(&port->dev, "Entering...%s\n", __func__);
920 data = urb->transfer_buffer;
922 tty = tty_port_tty_get(&port->port);
923 if (tty && urb->actual_length) {
924 tty_insert_flip_string(tty, data, urb->actual_length);
925 tty_flip_buffer_push(tty);
929 if (port->read_urb->status != -EINPROGRESS) {
930 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
932 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, retval = %d\n", retval);
937 * mos7720_bulk_out_data_callback
938 * this is the callback function for when we have finished sending serial
939 * data on the bulk out endpoint.
941 static void mos7720_bulk_out_data_callback(struct urb *urb)
943 struct moschip_port *mos7720_port;
944 struct tty_struct *tty;
945 int status = urb->status;
948 dev_dbg(&urb->dev->dev, "nonzero write bulk status received:%d\n", status);
952 mos7720_port = urb->context;
954 dev_dbg(&urb->dev->dev, "NULL mos7720_port pointer\n");
958 tty = tty_port_tty_get(&mos7720_port->port->port);
960 if (tty && mos7720_port->open)
967 * this function installs the appropriate read interrupt endpoint callback
968 * depending on whether the device is a 7720 or 7715, thus avoiding costly
969 * run-time checks in the high-frequency callback routine itself.
971 static int mos77xx_probe(struct usb_serial *serial,
972 const struct usb_device_id *id)
974 if (id->idProduct == MOSCHIP_DEVICE_ID_7715)
975 moschip7720_2port_driver.read_int_callback =
976 mos7715_interrupt_callback;
978 moschip7720_2port_driver.read_int_callback =
979 mos7720_interrupt_callback;
984 static int mos77xx_calc_num_ports(struct usb_serial *serial)
986 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
987 if (product == MOSCHIP_DEVICE_ID_7715)
993 static int mos7720_open(struct tty_struct *tty, struct usb_serial_port *port)
995 struct usb_serial *serial;
997 struct moschip_port *mos7720_port;
1001 int allocated_urbs = 0;
1004 serial = port->serial;
1006 mos7720_port = usb_get_serial_port_data(port);
1007 if (mos7720_port == NULL)
1010 usb_clear_halt(serial->dev, port->write_urb->pipe);
1011 usb_clear_halt(serial->dev, port->read_urb->pipe);
1013 /* Initialising the write urb pool */
1014 for (j = 0; j < NUM_URBS; ++j) {
1015 urb = usb_alloc_urb(0, GFP_KERNEL);
1016 mos7720_port->write_urb_pool[j] = urb;
1019 dev_err(&port->dev, "No more urbs???\n");
1023 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
1025 if (!urb->transfer_buffer) {
1027 "%s-out of memory for urb buffers.\n",
1029 usb_free_urb(mos7720_port->write_urb_pool[j]);
1030 mos7720_port->write_urb_pool[j] = NULL;
1036 if (!allocated_urbs)
1039 /* Initialize MCS7720 -- Write Init values to corresponding Registers
1051 * 0x08 : SP1/2 Control Reg
1053 port_number = port->number - port->serial->minor;
1054 read_mos_reg(serial, port_number, LSR, &data);
1056 dev_dbg(&port->dev, "SS::%p LSR:%x\n", mos7720_port, data);
1058 write_mos_reg(serial, dummy, SP1_REG, 0x02);
1059 write_mos_reg(serial, dummy, SP2_REG, 0x02);
1061 write_mos_reg(serial, port_number, IER, 0x00);
1062 write_mos_reg(serial, port_number, FCR, 0x00);
1064 write_mos_reg(serial, port_number, FCR, 0xcf);
1065 mos7720_port->shadowLCR = 0x03;
1066 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1067 mos7720_port->shadowMCR = 0x0b;
1068 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1070 write_mos_reg(serial, port_number, SP_CONTROL_REG, 0x00);
1071 read_mos_reg(serial, dummy, SP_CONTROL_REG, &data);
1072 data = data | (port->number - port->serial->minor + 1);
1073 write_mos_reg(serial, dummy, SP_CONTROL_REG, data);
1074 mos7720_port->shadowLCR = 0x83;
1075 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1076 write_mos_reg(serial, port_number, THR, 0x0c);
1077 write_mos_reg(serial, port_number, IER, 0x00);
1078 mos7720_port->shadowLCR = 0x03;
1079 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1080 write_mos_reg(serial, port_number, IER, 0x0c);
1082 response = usb_submit_urb(port->read_urb, GFP_KERNEL);
1084 dev_err(&port->dev, "%s - Error %d submitting read urb\n",
1085 __func__, response);
1087 /* initialize our icount structure */
1088 memset(&(mos7720_port->icount), 0x00, sizeof(mos7720_port->icount));
1090 /* initialize our port settings */
1091 mos7720_port->shadowMCR = UART_MCR_OUT2; /* Must set to enable ints! */
1093 /* send a open port command */
1094 mos7720_port->open = 1;
1100 * mos7720_chars_in_buffer
1101 * this function is called by the tty driver when it wants to know how many
1102 * bytes of data we currently have outstanding in the port (data that has
1103 * been written, but hasn't made it out the port yet)
1104 * If successful, we return the number of bytes left to be written in the
1106 * Otherwise we return a negative error number.
1108 static int mos7720_chars_in_buffer(struct tty_struct *tty)
1110 struct usb_serial_port *port = tty->driver_data;
1113 struct moschip_port *mos7720_port;
1115 mos7720_port = usb_get_serial_port_data(port);
1116 if (mos7720_port == NULL)
1119 for (i = 0; i < NUM_URBS; ++i) {
1120 if (mos7720_port->write_urb_pool[i] &&
1121 mos7720_port->write_urb_pool[i]->status == -EINPROGRESS)
1122 chars += URB_TRANSFER_BUFFER_SIZE;
1124 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1128 static void mos7720_close(struct usb_serial_port *port)
1130 struct usb_serial *serial;
1131 struct moschip_port *mos7720_port;
1134 serial = port->serial;
1136 mos7720_port = usb_get_serial_port_data(port);
1137 if (mos7720_port == NULL)
1140 for (j = 0; j < NUM_URBS; ++j)
1141 usb_kill_urb(mos7720_port->write_urb_pool[j]);
1143 /* Freeing Write URBs */
1144 for (j = 0; j < NUM_URBS; ++j) {
1145 if (mos7720_port->write_urb_pool[j]) {
1146 kfree(mos7720_port->write_urb_pool[j]->transfer_buffer);
1147 usb_free_urb(mos7720_port->write_urb_pool[j]);
1151 /* While closing port, shutdown all bulk read, write *
1152 * and interrupt read if they exists, otherwise nop */
1153 usb_kill_urb(port->write_urb);
1154 usb_kill_urb(port->read_urb);
1156 mutex_lock(&serial->disc_mutex);
1157 /* these commands must not be issued if the device has
1158 * been disconnected */
1159 if (!serial->disconnected) {
1160 write_mos_reg(serial, port->number - port->serial->minor,
1162 write_mos_reg(serial, port->number - port->serial->minor,
1165 mutex_unlock(&serial->disc_mutex);
1166 mos7720_port->open = 0;
1169 static void mos7720_break(struct tty_struct *tty, int break_state)
1171 struct usb_serial_port *port = tty->driver_data;
1173 struct usb_serial *serial;
1174 struct moschip_port *mos7720_port;
1176 serial = port->serial;
1178 mos7720_port = usb_get_serial_port_data(port);
1179 if (mos7720_port == NULL)
1182 if (break_state == -1)
1183 data = mos7720_port->shadowLCR | UART_LCR_SBC;
1185 data = mos7720_port->shadowLCR & ~UART_LCR_SBC;
1187 mos7720_port->shadowLCR = data;
1188 write_mos_reg(serial, port->number - port->serial->minor,
1189 LCR, mos7720_port->shadowLCR);
1193 * mos7720_write_room
1194 * this function is called by the tty driver when it wants to know how many
1195 * bytes of data we can accept for a specific port.
1196 * If successful, we return the amount of room that we have for this port
1197 * Otherwise we return a negative error number.
1199 static int mos7720_write_room(struct tty_struct *tty)
1201 struct usb_serial_port *port = tty->driver_data;
1202 struct moschip_port *mos7720_port;
1206 mos7720_port = usb_get_serial_port_data(port);
1207 if (mos7720_port == NULL)
1210 /* FIXME: Locking */
1211 for (i = 0; i < NUM_URBS; ++i) {
1212 if (mos7720_port->write_urb_pool[i] &&
1213 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS)
1214 room += URB_TRANSFER_BUFFER_SIZE;
1217 dev_dbg(&port->dev, "%s - returns %d\n", __func__, room);
1221 static int mos7720_write(struct tty_struct *tty, struct usb_serial_port *port,
1222 const unsigned char *data, int count)
1229 struct moschip_port *mos7720_port;
1230 struct usb_serial *serial;
1232 const unsigned char *current_position = data;
1234 serial = port->serial;
1236 mos7720_port = usb_get_serial_port_data(port);
1237 if (mos7720_port == NULL)
1240 /* try to find a free urb in the list */
1243 for (i = 0; i < NUM_URBS; ++i) {
1244 if (mos7720_port->write_urb_pool[i] &&
1245 mos7720_port->write_urb_pool[i]->status != -EINPROGRESS) {
1246 urb = mos7720_port->write_urb_pool[i];
1247 dev_dbg(&port->dev, "URB:%d\n", i);
1253 dev_dbg(&port->dev, "%s - no more free urbs\n", __func__);
1257 if (urb->transfer_buffer == NULL) {
1258 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
1260 if (urb->transfer_buffer == NULL) {
1261 dev_err_console(port, "%s no more kernel memory...\n",
1266 transfer_size = min(count, URB_TRANSFER_BUFFER_SIZE);
1268 memcpy(urb->transfer_buffer, current_position, transfer_size);
1269 usb_serial_debug_data(debug, &port->dev, __func__, transfer_size,
1270 urb->transfer_buffer);
1272 /* fill urb with data and submit */
1273 usb_fill_bulk_urb(urb, serial->dev,
1274 usb_sndbulkpipe(serial->dev,
1275 port->bulk_out_endpointAddress),
1276 urb->transfer_buffer, transfer_size,
1277 mos7720_bulk_out_data_callback, mos7720_port);
1279 /* send it down the pipe */
1280 status = usb_submit_urb(urb, GFP_ATOMIC);
1282 dev_err_console(port, "%s - usb_submit_urb(write bulk) failed "
1283 "with status = %d\n", __func__, status);
1284 bytes_sent = status;
1287 bytes_sent = transfer_size;
1293 static void mos7720_throttle(struct tty_struct *tty)
1295 struct usb_serial_port *port = tty->driver_data;
1296 struct moschip_port *mos7720_port;
1299 mos7720_port = usb_get_serial_port_data(port);
1301 if (mos7720_port == NULL)
1304 if (!mos7720_port->open) {
1305 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1309 /* if we are implementing XON/XOFF, send the stop character */
1311 unsigned char stop_char = STOP_CHAR(tty);
1312 status = mos7720_write(tty, port, &stop_char, 1);
1317 /* if we are implementing RTS/CTS, toggle that line */
1318 if (tty->termios->c_cflag & CRTSCTS) {
1319 mos7720_port->shadowMCR &= ~UART_MCR_RTS;
1320 write_mos_reg(port->serial, port->number - port->serial->minor,
1321 MCR, mos7720_port->shadowMCR);
1327 static void mos7720_unthrottle(struct tty_struct *tty)
1329 struct usb_serial_port *port = tty->driver_data;
1330 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1333 if (mos7720_port == NULL)
1336 if (!mos7720_port->open) {
1337 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1341 /* if we are implementing XON/XOFF, send the start character */
1343 unsigned char start_char = START_CHAR(tty);
1344 status = mos7720_write(tty, port, &start_char, 1);
1349 /* if we are implementing RTS/CTS, toggle that line */
1350 if (tty->termios->c_cflag & CRTSCTS) {
1351 mos7720_port->shadowMCR |= UART_MCR_RTS;
1352 write_mos_reg(port->serial, port->number - port->serial->minor,
1353 MCR, mos7720_port->shadowMCR);
1359 /* FIXME: this function does not work */
1360 static int set_higher_rates(struct moschip_port *mos7720_port,
1363 struct usb_serial_port *port;
1364 struct usb_serial *serial;
1366 enum mos_regs sp_reg;
1367 if (mos7720_port == NULL)
1370 port = mos7720_port->port;
1371 serial = port->serial;
1373 /***********************************************
1374 * Init Sequence for higher rates
1375 ***********************************************/
1376 dev_dbg(&port->dev, "Sending Setting Commands ..........\n");
1377 port_number = port->number - port->serial->minor;
1379 write_mos_reg(serial, port_number, IER, 0x00);
1380 write_mos_reg(serial, port_number, FCR, 0x00);
1381 write_mos_reg(serial, port_number, FCR, 0xcf);
1382 mos7720_port->shadowMCR = 0x0b;
1383 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1384 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x00);
1386 /***********************************************
1387 * Set for higher rates *
1388 ***********************************************/
1389 /* writing baud rate verbatum into uart clock field clearly not right */
1390 if (port_number == 0)
1394 write_mos_reg(serial, dummy, sp_reg, baud * 0x10);
1395 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x03);
1396 mos7720_port->shadowMCR = 0x2b;
1397 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1399 /***********************************************
1401 ***********************************************/
1402 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1403 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1404 write_mos_reg(serial, port_number, DLL, 0x01);
1405 write_mos_reg(serial, port_number, DLM, 0x00);
1406 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1407 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1412 /* baud rate information */
1413 struct divisor_table_entry {
1418 /* Define table of divisors for moschip 7720 hardware *
1419 * These assume a 3.6864MHz crystal, the standard /16, and *
1421 static struct divisor_table_entry divisor_table[] = {
1423 { 110, 1047}, /* 2094.545455 => 230450 => .0217 % over */
1424 { 134, 857}, /* 1713.011152 => 230398.5 => .00065% under */
1440 /*****************************************************************************
1441 * calc_baud_rate_divisor
1442 * this function calculates the proper baud rate divisor for the specified
1444 *****************************************************************************/
1445 static int calc_baud_rate_divisor(struct usb_serial_port *port, int baudrate, int *divisor)
1453 dev_dbg(&port->dev, "%s - %d\n", __func__, baudrate);
1455 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
1456 if (divisor_table[i].baudrate == baudrate) {
1457 *divisor = divisor_table[i].divisor;
1462 /* After trying for all the standard baud rates *
1463 * Try calculating the divisor for this baud rate */
1464 if (baudrate > 75 && baudrate < 230400) {
1465 /* get the divisor */
1466 custom = (__u16)(230400L / baudrate);
1468 /* Check for round off */
1469 round1 = (__u16)(2304000L / baudrate);
1470 round = (__u16)(round1 - (custom * 10));
1475 dev_dbg(&port->dev, "Baud %d = %d\n", baudrate, custom);
1479 dev_dbg(&port->dev, "Baud calculation Failed...\n");
1484 * send_cmd_write_baud_rate
1485 * this function sends the proper command to change the baud rate of the
1488 static int send_cmd_write_baud_rate(struct moschip_port *mos7720_port,
1491 struct usb_serial_port *port;
1492 struct usb_serial *serial;
1495 unsigned char number;
1497 if (mos7720_port == NULL)
1500 port = mos7720_port->port;
1501 serial = port->serial;
1503 number = port->number - port->serial->minor;
1504 dev_dbg(&port->dev, "%s - baud = %d\n", __func__, baudrate);
1506 /* Calculate the Divisor */
1507 status = calc_baud_rate_divisor(port, baudrate, &divisor);
1509 dev_err(&port->dev, "%s - bad baud rate\n", __func__);
1513 /* Enable access to divisor latch */
1514 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1515 write_mos_reg(serial, number, LCR, mos7720_port->shadowLCR);
1517 /* Write the divisor */
1518 write_mos_reg(serial, number, DLL, (__u8)(divisor & 0xff));
1519 write_mos_reg(serial, number, DLM, (__u8)((divisor & 0xff00) >> 8));
1521 /* Disable access to divisor latch */
1522 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1523 write_mos_reg(serial, number, LCR, mos7720_port->shadowLCR);
1529 * change_port_settings
1530 * This routine is called to set the UART on the device to match
1531 * the specified new settings.
1533 static void change_port_settings(struct tty_struct *tty,
1534 struct moschip_port *mos7720_port,
1535 struct ktermios *old_termios)
1537 struct usb_serial_port *port;
1538 struct usb_serial *serial;
1549 if (mos7720_port == NULL)
1552 port = mos7720_port->port;
1553 serial = port->serial;
1554 port_number = port->number - port->serial->minor;
1556 if (!mos7720_port->open) {
1557 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1561 lData = UART_LCR_WLEN8;
1562 lStop = 0x00; /* 1 stop bit */
1563 lParity = 0x00; /* No parity */
1565 cflag = tty->termios->c_cflag;
1566 iflag = tty->termios->c_iflag;
1568 /* Change the number of bits */
1569 switch (cflag & CSIZE) {
1571 lData = UART_LCR_WLEN5;
1576 lData = UART_LCR_WLEN6;
1581 lData = UART_LCR_WLEN7;
1586 lData = UART_LCR_WLEN8;
1590 /* Change the Parity bit */
1591 if (cflag & PARENB) {
1592 if (cflag & PARODD) {
1593 lParity = UART_LCR_PARITY;
1594 dev_dbg(&port->dev, "%s - parity = odd\n", __func__);
1596 lParity = (UART_LCR_EPAR | UART_LCR_PARITY);
1597 dev_dbg(&port->dev, "%s - parity = even\n", __func__);
1601 dev_dbg(&port->dev, "%s - parity = none\n", __func__);
1605 lParity = lParity | 0x20;
1607 /* Change the Stop bit */
1608 if (cflag & CSTOPB) {
1609 lStop = UART_LCR_STOP;
1610 dev_dbg(&port->dev, "%s - stop bits = 2\n", __func__);
1613 dev_dbg(&port->dev, "%s - stop bits = 1\n", __func__);
1616 #define LCR_BITS_MASK 0x03 /* Mask for bits/char field */
1617 #define LCR_STOP_MASK 0x04 /* Mask for stop bits field */
1618 #define LCR_PAR_MASK 0x38 /* Mask for parity field */
1620 /* Update the LCR with the correct value */
1621 mos7720_port->shadowLCR &=
1622 ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
1623 mos7720_port->shadowLCR |= (lData | lParity | lStop);
1626 /* Disable Interrupts */
1627 write_mos_reg(serial, port_number, IER, 0x00);
1628 write_mos_reg(serial, port_number, FCR, 0x00);
1629 write_mos_reg(serial, port_number, FCR, 0xcf);
1631 /* Send the updated LCR value to the mos7720 */
1632 write_mos_reg(serial, port_number, LCR, mos7720_port->shadowLCR);
1633 mos7720_port->shadowMCR = 0x0b;
1634 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1636 /* set up the MCR register and send it to the mos7720 */
1637 mos7720_port->shadowMCR = UART_MCR_OUT2;
1639 mos7720_port->shadowMCR |= (UART_MCR_DTR | UART_MCR_RTS);
1641 if (cflag & CRTSCTS) {
1642 mos7720_port->shadowMCR |= (UART_MCR_XONANY);
1643 /* To set hardware flow control to the specified *
1644 * serial port, in SP1/2_CONTROL_REG */
1646 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x01);
1648 write_mos_reg(serial, dummy, SP_CONTROL_REG, 0x02);
1651 mos7720_port->shadowMCR &= ~(UART_MCR_XONANY);
1653 write_mos_reg(serial, port_number, MCR, mos7720_port->shadowMCR);
1655 /* Determine divisor based on baud rate */
1656 baud = tty_get_baud_rate(tty);
1658 /* pick a default, any default... */
1659 dev_dbg(&port->dev, "Picked default baud...\n");
1663 if (baud >= 230400) {
1664 set_higher_rates(mos7720_port, baud);
1665 /* Enable Interrupts */
1666 write_mos_reg(serial, port_number, IER, 0x0c);
1670 dev_dbg(&port->dev, "%s - baud rate = %d\n", __func__, baud);
1671 status = send_cmd_write_baud_rate(mos7720_port, baud);
1672 /* FIXME: needs to write actual resulting baud back not just
1675 tty_encode_baud_rate(tty, baud, baud);
1676 /* Enable Interrupts */
1677 write_mos_reg(serial, port_number, IER, 0x0c);
1679 if (port->read_urb->status != -EINPROGRESS) {
1680 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1682 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1687 * mos7720_set_termios
1688 * this function is called by the tty driver when it wants to change the
1689 * termios structure.
1691 static void mos7720_set_termios(struct tty_struct *tty,
1692 struct usb_serial_port *port, struct ktermios *old_termios)
1696 struct usb_serial *serial;
1697 struct moschip_port *mos7720_port;
1699 serial = port->serial;
1701 mos7720_port = usb_get_serial_port_data(port);
1703 if (mos7720_port == NULL)
1706 if (!mos7720_port->open) {
1707 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1711 dev_dbg(&port->dev, "setting termios - ASPIRE\n");
1713 cflag = tty->termios->c_cflag;
1715 dev_dbg(&port->dev, "%s - cflag %08x iflag %08x\n", __func__,
1716 tty->termios->c_cflag, RELEVANT_IFLAG(tty->termios->c_iflag));
1718 dev_dbg(&port->dev, "%s - old cflag %08x old iflag %08x\n", __func__,
1719 old_termios->c_cflag, RELEVANT_IFLAG(old_termios->c_iflag));
1721 /* change the port settings to the new ones specified */
1722 change_port_settings(tty, mos7720_port, old_termios);
1724 if (port->read_urb->status != -EINPROGRESS) {
1725 status = usb_submit_urb(port->read_urb, GFP_ATOMIC);
1727 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1732 * get_lsr_info - get line status register info
1734 * Purpose: Let user call ioctl() to get info when the UART physically
1735 * is emptied. On bus types like RS485, the transmitter must
1736 * release the bus after transmitting. This must be done when
1737 * the transmit shift register is empty, not be done when the
1738 * transmit holding register is empty. This functionality
1739 * allows an RS485 driver to be written in user space.
1741 static int get_lsr_info(struct tty_struct *tty,
1742 struct moschip_port *mos7720_port, unsigned int __user *value)
1744 struct usb_serial_port *port = tty->driver_data;
1745 unsigned int result = 0;
1746 unsigned char data = 0;
1747 int port_number = port->number - port->serial->minor;
1750 count = mos7720_chars_in_buffer(tty);
1752 read_mos_reg(port->serial, port_number, LSR, &data);
1753 if ((data & (UART_LSR_TEMT | UART_LSR_THRE))
1754 == (UART_LSR_TEMT | UART_LSR_THRE)) {
1755 dev_dbg(&port->dev, "%s -- Empty\n", __func__);
1756 result = TIOCSER_TEMT;
1759 if (copy_to_user(value, &result, sizeof(int)))
1764 static int mos7720_tiocmget(struct tty_struct *tty)
1766 struct usb_serial_port *port = tty->driver_data;
1767 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1768 unsigned int result = 0;
1772 mcr = mos7720_port->shadowMCR;
1773 msr = mos7720_port->shadowMSR;
1775 result = ((mcr & UART_MCR_DTR) ? TIOCM_DTR : 0) /* 0x002 */
1776 | ((mcr & UART_MCR_RTS) ? TIOCM_RTS : 0) /* 0x004 */
1777 | ((msr & UART_MSR_CTS) ? TIOCM_CTS : 0) /* 0x020 */
1778 | ((msr & UART_MSR_DCD) ? TIOCM_CAR : 0) /* 0x040 */
1779 | ((msr & UART_MSR_RI) ? TIOCM_RI : 0) /* 0x080 */
1780 | ((msr & UART_MSR_DSR) ? TIOCM_DSR : 0); /* 0x100 */
1785 static int mos7720_tiocmset(struct tty_struct *tty,
1786 unsigned int set, unsigned int clear)
1788 struct usb_serial_port *port = tty->driver_data;
1789 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1792 mcr = mos7720_port->shadowMCR;
1794 if (set & TIOCM_RTS)
1795 mcr |= UART_MCR_RTS;
1796 if (set & TIOCM_DTR)
1797 mcr |= UART_MCR_DTR;
1798 if (set & TIOCM_LOOP)
1799 mcr |= UART_MCR_LOOP;
1801 if (clear & TIOCM_RTS)
1802 mcr &= ~UART_MCR_RTS;
1803 if (clear & TIOCM_DTR)
1804 mcr &= ~UART_MCR_DTR;
1805 if (clear & TIOCM_LOOP)
1806 mcr &= ~UART_MCR_LOOP;
1808 mos7720_port->shadowMCR = mcr;
1809 write_mos_reg(port->serial, port->number - port->serial->minor,
1810 MCR, mos7720_port->shadowMCR);
1815 static int mos7720_get_icount(struct tty_struct *tty,
1816 struct serial_icounter_struct *icount)
1818 struct usb_serial_port *port = tty->driver_data;
1819 struct moschip_port *mos7720_port;
1820 struct async_icount cnow;
1822 mos7720_port = usb_get_serial_port_data(port);
1823 cnow = mos7720_port->icount;
1825 icount->cts = cnow.cts;
1826 icount->dsr = cnow.dsr;
1827 icount->rng = cnow.rng;
1828 icount->dcd = cnow.dcd;
1829 icount->rx = cnow.rx;
1830 icount->tx = cnow.tx;
1831 icount->frame = cnow.frame;
1832 icount->overrun = cnow.overrun;
1833 icount->parity = cnow.parity;
1834 icount->brk = cnow.brk;
1835 icount->buf_overrun = cnow.buf_overrun;
1837 dev_dbg(&port->dev, "%s TIOCGICOUNT RX=%d, TX=%d\n", __func__,
1838 icount->rx, icount->tx);
1842 static int set_modem_info(struct moschip_port *mos7720_port, unsigned int cmd,
1843 unsigned int __user *value)
1848 struct usb_serial_port *port;
1850 if (mos7720_port == NULL)
1853 port = (struct usb_serial_port *)mos7720_port->port;
1854 mcr = mos7720_port->shadowMCR;
1856 if (copy_from_user(&arg, value, sizeof(int)))
1861 if (arg & TIOCM_RTS)
1862 mcr |= UART_MCR_RTS;
1863 if (arg & TIOCM_DTR)
1864 mcr |= UART_MCR_RTS;
1865 if (arg & TIOCM_LOOP)
1866 mcr |= UART_MCR_LOOP;
1870 if (arg & TIOCM_RTS)
1871 mcr &= ~UART_MCR_RTS;
1872 if (arg & TIOCM_DTR)
1873 mcr &= ~UART_MCR_RTS;
1874 if (arg & TIOCM_LOOP)
1875 mcr &= ~UART_MCR_LOOP;
1880 mos7720_port->shadowMCR = mcr;
1881 write_mos_reg(port->serial, port->number - port->serial->minor,
1882 MCR, mos7720_port->shadowMCR);
1887 static int get_serial_info(struct moschip_port *mos7720_port,
1888 struct serial_struct __user *retinfo)
1890 struct serial_struct tmp;
1895 memset(&tmp, 0, sizeof(tmp));
1897 tmp.type = PORT_16550A;
1898 tmp.line = mos7720_port->port->serial->minor;
1899 tmp.port = mos7720_port->port->number;
1901 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1902 tmp.xmit_fifo_size = NUM_URBS * URB_TRANSFER_BUFFER_SIZE;
1903 tmp.baud_base = 9600;
1904 tmp.close_delay = 5*HZ;
1905 tmp.closing_wait = 30*HZ;
1907 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1912 static int mos7720_ioctl(struct tty_struct *tty,
1913 unsigned int cmd, unsigned long arg)
1915 struct usb_serial_port *port = tty->driver_data;
1916 struct moschip_port *mos7720_port;
1917 struct async_icount cnow;
1918 struct async_icount cprev;
1920 mos7720_port = usb_get_serial_port_data(port);
1921 if (mos7720_port == NULL)
1924 dev_dbg(&port->dev, "%s - cmd = 0x%x", __func__, cmd);
1928 dev_dbg(&port->dev, "%s TIOCSERGETLSR\n", __func__);
1929 return get_lsr_info(tty, mos7720_port,
1930 (unsigned int __user *)arg);
1932 /* FIXME: These should be using the mode methods */
1935 dev_dbg(&port->dev, "%s TIOCMSET/TIOCMBIC/TIOCMSET\n", __func__);
1936 return set_modem_info(mos7720_port, cmd,
1937 (unsigned int __user *)arg);
1940 dev_dbg(&port->dev, "%s TIOCGSERIAL\n", __func__);
1941 return get_serial_info(mos7720_port,
1942 (struct serial_struct __user *)arg);
1945 dev_dbg(&port->dev, "%s TIOCMIWAIT\n", __func__);
1946 cprev = mos7720_port->icount;
1948 if (signal_pending(current))
1949 return -ERESTARTSYS;
1950 cnow = mos7720_port->icount;
1951 if (cnow.rng == cprev.rng && cnow.dsr == cprev.dsr &&
1952 cnow.dcd == cprev.dcd && cnow.cts == cprev.cts)
1953 return -EIO; /* no change => error */
1954 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1955 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1956 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1957 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1966 return -ENOIOCTLCMD;
1969 static int mos7720_startup(struct usb_serial *serial)
1971 struct moschip_port *mos7720_port;
1972 struct usb_device *dev;
1978 product = le16_to_cpu(serial->dev->descriptor.idProduct);
1982 * The 7715 uses the first bulk in/out endpoint pair for the parallel
1983 * port, and the second for the serial port. Because the usbserial core
1984 * assumes both pairs are serial ports, we must engage in a bit of
1985 * subterfuge and swap the pointers for ports 0 and 1 in order to make
1986 * port 0 point to the serial port. However, both moschip devices use a
1987 * single interrupt-in endpoint for both ports (as mentioned a little
1988 * further down), and this endpoint was assigned to port 0. So after
1989 * the swap, we must copy the interrupt endpoint elements from port 1
1990 * (as newly assigned) to port 0, and null out port 1 pointers.
1992 if (product == MOSCHIP_DEVICE_ID_7715) {
1993 struct usb_serial_port *tmp = serial->port[0];
1994 serial->port[0] = serial->port[1];
1995 serial->port[1] = tmp;
1996 serial->port[0]->interrupt_in_urb = tmp->interrupt_in_urb;
1997 serial->port[0]->interrupt_in_buffer = tmp->interrupt_in_buffer;
1998 serial->port[0]->interrupt_in_endpointAddress =
1999 tmp->interrupt_in_endpointAddress;
2000 serial->port[1]->interrupt_in_urb = NULL;
2001 serial->port[1]->interrupt_in_buffer = NULL;
2005 /* set up serial port private structures */
2006 for (i = 0; i < serial->num_ports; ++i) {
2007 mos7720_port = kzalloc(sizeof(struct moschip_port), GFP_KERNEL);
2008 if (mos7720_port == NULL) {
2009 dev_err(&dev->dev, "%s - Out of memory\n", __func__);
2013 /* Initialize all port interrupt end point to port 0 int
2014 * endpoint. Our device has only one interrupt endpoint
2015 * common to all ports */
2016 serial->port[i]->interrupt_in_endpointAddress =
2017 serial->port[0]->interrupt_in_endpointAddress;
2019 mos7720_port->port = serial->port[i];
2020 usb_set_serial_port_data(serial->port[i], mos7720_port);
2022 dev_dbg(&dev->dev, "port number is %d\n", serial->port[i]->number);
2023 dev_dbg(&dev->dev, "serial number is %d\n", serial->minor);
2027 /* setting configuration feature to one */
2028 usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
2029 (__u8)0x03, 0x00, 0x01, 0x00, NULL, 0x00, 5*HZ);
2031 /* start the interrupt urb */
2032 ret_val = usb_submit_urb(serial->port[0]->interrupt_in_urb, GFP_KERNEL);
2035 "%s - Error %d submitting control urb\n",
2038 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
2039 if (product == MOSCHIP_DEVICE_ID_7715) {
2040 ret_val = mos7715_parport_init(serial);
2045 /* LSR For Port 1 */
2046 read_mos_reg(serial, 0, LSR, &data);
2047 dev_dbg(&dev->dev, "LSR:%x\n", data);
2052 static void mos7720_release(struct usb_serial *serial)
2056 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
2057 /* close the parallel port */
2059 if (le16_to_cpu(serial->dev->descriptor.idProduct)
2060 == MOSCHIP_DEVICE_ID_7715) {
2061 struct urbtracker *urbtrack;
2062 unsigned long flags;
2063 struct mos7715_parport *mos_parport =
2064 usb_get_serial_data(serial);
2066 /* prevent NULL ptr dereference in port callbacks */
2067 spin_lock(&release_lock);
2068 mos_parport->pp->private_data = NULL;
2069 spin_unlock(&release_lock);
2071 /* wait for synchronous usb calls to return */
2072 if (mos_parport->msg_pending)
2073 wait_for_completion_timeout(&mos_parport->syncmsg_compl,
2076 parport_remove_port(mos_parport->pp);
2077 usb_set_serial_data(serial, NULL);
2078 mos_parport->serial = NULL;
2080 /* if tasklet currently scheduled, wait for it to complete */
2081 tasklet_kill(&mos_parport->urb_tasklet);
2083 /* unlink any urbs sent by the tasklet */
2084 spin_lock_irqsave(&mos_parport->listlock, flags);
2085 list_for_each_entry(urbtrack,
2086 &mos_parport->active_urbs,
2088 usb_unlink_urb(urbtrack->urb);
2089 spin_unlock_irqrestore(&mos_parport->listlock, flags);
2091 kref_put(&mos_parport->ref_count, destroy_mos_parport);
2094 /* free private structure allocated for serial port */
2095 for (i = 0; i < serial->num_ports; ++i)
2096 kfree(usb_get_serial_port_data(serial->port[i]));
2099 static struct usb_serial_driver moschip7720_2port_driver = {
2101 .owner = THIS_MODULE,
2102 .name = "moschip7720",
2104 .description = "Moschip 2 port adapter",
2105 .id_table = id_table,
2106 .calc_num_ports = mos77xx_calc_num_ports,
2107 .open = mos7720_open,
2108 .close = mos7720_close,
2109 .throttle = mos7720_throttle,
2110 .unthrottle = mos7720_unthrottle,
2111 .probe = mos77xx_probe,
2112 .attach = mos7720_startup,
2113 .release = mos7720_release,
2114 .ioctl = mos7720_ioctl,
2115 .tiocmget = mos7720_tiocmget,
2116 .tiocmset = mos7720_tiocmset,
2117 .get_icount = mos7720_get_icount,
2118 .set_termios = mos7720_set_termios,
2119 .write = mos7720_write,
2120 .write_room = mos7720_write_room,
2121 .chars_in_buffer = mos7720_chars_in_buffer,
2122 .break_ctl = mos7720_break,
2123 .read_bulk_callback = mos7720_bulk_in_callback,
2124 .read_int_callback = NULL /* dynamically assigned in probe() */
2127 static struct usb_serial_driver * const serial_drivers[] = {
2128 &moschip7720_2port_driver, NULL
2131 module_usb_serial_driver(serial_drivers, id_table);
2133 MODULE_AUTHOR(DRIVER_AUTHOR);
2134 MODULE_DESCRIPTION(DRIVER_DESC);
2135 MODULE_LICENSE("GPL");
2137 module_param(debug, bool, S_IRUGO | S_IWUSR);
2138 MODULE_PARM_DESC(debug, "Debug enabled or not");