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/slab.h>
26 #include <linux/tty.h>
27 #include <linux/tty_driver.h>
28 #include <linux/tty_flip.h>
29 #include <linux/module.h>
30 #include <linux/spinlock.h>
31 #include <linux/serial.h>
32 #include <linux/serial_reg.h>
33 #include <linux/usb.h>
34 #include <linux/usb/serial.h>
35 #include <linux/uaccess.h>
36 #include <linux/parport.h>
38 #define DRIVER_AUTHOR "Aspire Communications pvt Ltd."
39 #define DRIVER_DESC "Moschip USB Serial Driver"
41 /* default urb timeout */
42 #define MOS_WDR_TIMEOUT 5000
44 #define MOS_MAX_PORT 0x02
45 #define MOS_WRITE 0x0E
48 /* Interrupt Routines Defines */
49 #define SERIAL_IIR_RLS 0x06
50 #define SERIAL_IIR_RDA 0x04
51 #define SERIAL_IIR_CTI 0x0c
52 #define SERIAL_IIR_THR 0x02
53 #define SERIAL_IIR_MS 0x00
55 #define NUM_URBS 16 /* URB Count */
56 #define URB_TRANSFER_BUFFER_SIZE 32 /* URB Size */
58 /* This structure holds all of the local serial port information */
60 __u8 shadowLCR; /* last LCR value received */
61 __u8 shadowMCR; /* last MCR value received */
62 __u8 shadowMSR; /* last MSR value received */
64 struct usb_serial_port *port; /* loop back to the owner */
65 struct urb *write_urb_pool[NUM_URBS];
68 #define USB_VENDOR_ID_MOSCHIP 0x9710
69 #define MOSCHIP_DEVICE_ID_7720 0x7720
70 #define MOSCHIP_DEVICE_ID_7715 0x7715
72 static const struct usb_device_id id_table[] = {
73 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7720) },
74 { USB_DEVICE(USB_VENDOR_ID_MOSCHIP, MOSCHIP_DEVICE_ID_7715) },
75 { } /* terminating entry */
77 MODULE_DEVICE_TABLE(usb, id_table);
79 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
81 /* initial values for parport regs */
82 #define DCR_INIT_VAL 0x0c /* SLCTIN, nINIT */
83 #define ECR_INIT_VAL 0x00 /* SPP mode */
86 struct mos7715_parport *mos_parport;
87 struct list_head urblist_entry;
88 struct kref ref_count;
90 struct usb_ctrlrequest *setup;
93 enum mos7715_pp_modes {
95 PS2 = 1<<5, /* moschip calls this 'NIBBLE' mode */
96 PPF = 2<<5, /* moschip calls this 'CB-FIFO mode */
99 struct mos7715_parport {
100 struct parport *pp; /* back to containing struct */
101 struct kref ref_count; /* to instance of this struct */
102 struct list_head deferred_urbs; /* list deferred async urbs */
103 struct list_head active_urbs; /* list async urbs in flight */
104 spinlock_t listlock; /* protects list access */
105 bool msg_pending; /* usb sync call pending */
106 struct completion syncmsg_compl; /* usb sync call completed */
107 struct tasklet_struct urb_tasklet; /* for sending deferred urbs */
108 struct usb_serial *serial; /* back to containing struct */
109 __u8 shadowECR; /* parallel port regs... */
111 atomic_t shadowDSR; /* updated in int-in callback */
114 /* lock guards against dereferencing NULL ptr in parport ops callbacks */
115 static DEFINE_SPINLOCK(release_lock);
117 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
119 static const unsigned int dummy; /* for clarity in register access fns */
122 MOS7720_THR, /* serial port regs */
134 MOS7720_DPR, /* parallel port regs */
138 MOS7720_SP1_REG, /* device control regs */
139 MOS7720_SP2_REG, /* serial port 2 (7720 only) */
141 MOS7720_SP_CONTROL_REG,
145 * Return the correct value for the Windex field of the setup packet
146 * for a control endpoint message. See the 7715 datasheet.
148 static inline __u16 get_reg_index(enum mos_regs reg)
150 static const __u16 mos7715_index_lookup_table[] = {
151 0x00, /* MOS7720_THR */
152 0x00, /* MOS7720_RHR */
153 0x01, /* MOS7720_IER */
154 0x02, /* MOS7720_FCR */
155 0x02, /* MOS7720_ISR */
156 0x03, /* MOS7720_LCR */
157 0x04, /* MOS7720_MCR */
158 0x05, /* MOS7720_LSR */
159 0x06, /* MOS7720_MSR */
160 0x07, /* MOS7720_SPR */
161 0x00, /* MOS7720_DLL */
162 0x01, /* MOS7720_DLM */
163 0x00, /* MOS7720_DPR */
164 0x01, /* MOS7720_DSR */
165 0x02, /* MOS7720_DCR */
166 0x0a, /* MOS7720_ECR */
167 0x01, /* MOS7720_SP1_REG */
168 0x02, /* MOS7720_SP2_REG (7720 only) */
169 0x04, /* MOS7720_PP_REG (7715 only) */
170 0x08, /* MOS7720_SP_CONTROL_REG */
172 return mos7715_index_lookup_table[reg];
176 * Return the correct value for the upper byte of the Wvalue field of
177 * the setup packet for a control endpoint message.
179 static inline __u16 get_reg_value(enum mos_regs reg,
180 unsigned int serial_portnum)
182 if (reg >= MOS7720_SP1_REG) /* control reg */
185 else if (reg >= MOS7720_DPR) /* parallel port reg (7715 only) */
188 else /* serial port reg */
189 return (serial_portnum + 2) << 8;
193 * Write data byte to the specified device register. The data is embedded in
194 * the value field of the setup packet. serial_portnum is ignored for registers
195 * not specific to a particular serial port.
197 static int write_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
198 enum mos_regs reg, __u8 data)
200 struct usb_device *usbdev = serial->dev;
201 unsigned int pipe = usb_sndctrlpipe(usbdev, 0);
202 __u8 request = (__u8)0x0e;
203 __u8 requesttype = (__u8)0x40;
204 __u16 index = get_reg_index(reg);
205 __u16 value = get_reg_value(reg, serial_portnum) + data;
206 int status = usb_control_msg(usbdev, pipe, request, requesttype, value,
207 index, NULL, 0, MOS_WDR_TIMEOUT);
209 dev_err(&usbdev->dev,
210 "mos7720: usb_control_msg() failed: %d\n", status);
215 * Read data byte from the specified device register. The data returned by the
216 * device is embedded in the value field of the setup packet. serial_portnum is
217 * ignored for registers that are not specific to a particular serial port.
219 static int read_mos_reg(struct usb_serial *serial, unsigned int serial_portnum,
220 enum mos_regs reg, __u8 *data)
222 struct usb_device *usbdev = serial->dev;
223 unsigned int pipe = usb_rcvctrlpipe(usbdev, 0);
224 __u8 request = (__u8)0x0d;
225 __u8 requesttype = (__u8)0xc0;
226 __u16 index = get_reg_index(reg);
227 __u16 value = get_reg_value(reg, serial_portnum);
231 buf = kmalloc(1, GFP_KERNEL);
237 status = usb_control_msg(usbdev, pipe, request, requesttype, value,
238 index, buf, 1, MOS_WDR_TIMEOUT);
242 dev_err(&usbdev->dev,
243 "mos7720: usb_control_msg() failed: %d\n", status);
254 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
256 static inline int mos7715_change_mode(struct mos7715_parport *mos_parport,
257 enum mos7715_pp_modes mode)
259 mos_parport->shadowECR = mode;
260 write_mos_reg(mos_parport->serial, dummy, MOS7720_ECR,
261 mos_parport->shadowECR);
265 static void destroy_mos_parport(struct kref *kref)
267 struct mos7715_parport *mos_parport =
268 container_of(kref, struct mos7715_parport, ref_count);
273 static void destroy_urbtracker(struct kref *kref)
275 struct urbtracker *urbtrack =
276 container_of(kref, struct urbtracker, ref_count);
277 struct mos7715_parport *mos_parport = urbtrack->mos_parport;
279 usb_free_urb(urbtrack->urb);
280 kfree(urbtrack->setup);
282 kref_put(&mos_parport->ref_count, destroy_mos_parport);
286 * This runs as a tasklet when sending an urb in a non-blocking parallel
287 * port callback had to be deferred because the disconnect mutex could not be
288 * obtained at the time.
290 static void send_deferred_urbs(unsigned long _mos_parport)
294 struct mos7715_parport *mos_parport = (void *)_mos_parport;
295 struct urbtracker *urbtrack, *tmp;
296 struct list_head *cursor, *next;
299 /* if release function ran, game over */
300 if (unlikely(mos_parport->serial == NULL))
303 dev = &mos_parport->serial->dev->dev;
305 /* try again to get the mutex */
306 if (!mutex_trylock(&mos_parport->serial->disc_mutex)) {
307 dev_dbg(dev, "%s: rescheduling tasklet\n", __func__);
308 tasklet_schedule(&mos_parport->urb_tasklet);
312 /* if device disconnected, game over */
313 if (unlikely(mos_parport->serial->disconnected)) {
314 mutex_unlock(&mos_parport->serial->disc_mutex);
318 spin_lock_irqsave(&mos_parport->listlock, flags);
319 if (list_empty(&mos_parport->deferred_urbs)) {
320 spin_unlock_irqrestore(&mos_parport->listlock, flags);
321 mutex_unlock(&mos_parport->serial->disc_mutex);
322 dev_dbg(dev, "%s: deferred_urbs list empty\n", __func__);
326 /* move contents of deferred_urbs list to active_urbs list and submit */
327 list_for_each_safe(cursor, next, &mos_parport->deferred_urbs)
328 list_move_tail(cursor, &mos_parport->active_urbs);
329 list_for_each_entry_safe(urbtrack, tmp, &mos_parport->active_urbs,
331 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
332 dev_dbg(dev, "%s: urb submitted\n", __func__);
334 dev_err(dev, "usb_submit_urb() failed: %d\n", ret_val);
335 list_del(&urbtrack->urblist_entry);
336 kref_put(&urbtrack->ref_count, destroy_urbtracker);
339 spin_unlock_irqrestore(&mos_parport->listlock, flags);
340 mutex_unlock(&mos_parport->serial->disc_mutex);
343 /* callback for parallel port control urbs submitted asynchronously */
344 static void async_complete(struct urb *urb)
346 struct urbtracker *urbtrack = urb->context;
347 int status = urb->status;
349 if (unlikely(status))
350 dev_dbg(&urb->dev->dev, "%s - nonzero urb status received: %d\n", __func__, status);
352 /* remove the urbtracker from the active_urbs list */
353 spin_lock(&urbtrack->mos_parport->listlock);
354 list_del(&urbtrack->urblist_entry);
355 spin_unlock(&urbtrack->mos_parport->listlock);
356 kref_put(&urbtrack->ref_count, destroy_urbtracker);
359 static int write_parport_reg_nonblock(struct mos7715_parport *mos_parport,
360 enum mos_regs reg, __u8 data)
362 struct urbtracker *urbtrack;
365 struct usb_serial *serial = mos_parport->serial;
366 struct usb_device *usbdev = serial->dev;
368 /* create and initialize the control urb and containing urbtracker */
369 urbtrack = kmalloc(sizeof(struct urbtracker), GFP_ATOMIC);
373 urbtrack->urb = usb_alloc_urb(0, GFP_ATOMIC);
374 if (!urbtrack->urb) {
378 urbtrack->setup = kmalloc(sizeof(*urbtrack->setup), GFP_ATOMIC);
379 if (!urbtrack->setup) {
380 usb_free_urb(urbtrack->urb);
384 urbtrack->setup->bRequestType = (__u8)0x40;
385 urbtrack->setup->bRequest = (__u8)0x0e;
386 urbtrack->setup->wValue = cpu_to_le16(get_reg_value(reg, dummy));
387 urbtrack->setup->wIndex = cpu_to_le16(get_reg_index(reg));
388 urbtrack->setup->wLength = 0;
389 usb_fill_control_urb(urbtrack->urb, usbdev,
390 usb_sndctrlpipe(usbdev, 0),
391 (unsigned char *)urbtrack->setup,
392 NULL, 0, async_complete, urbtrack);
393 kref_get(&mos_parport->ref_count);
394 urbtrack->mos_parport = mos_parport;
395 kref_init(&urbtrack->ref_count);
396 INIT_LIST_HEAD(&urbtrack->urblist_entry);
399 * get the disconnect mutex, or add tracker to the deferred_urbs list
400 * and schedule a tasklet to try again later
402 if (!mutex_trylock(&serial->disc_mutex)) {
403 spin_lock_irqsave(&mos_parport->listlock, flags);
404 list_add_tail(&urbtrack->urblist_entry,
405 &mos_parport->deferred_urbs);
406 spin_unlock_irqrestore(&mos_parport->listlock, flags);
407 tasklet_schedule(&mos_parport->urb_tasklet);
408 dev_dbg(&usbdev->dev, "tasklet scheduled\n");
412 /* bail if device disconnected */
413 if (serial->disconnected) {
414 kref_put(&urbtrack->ref_count, destroy_urbtracker);
415 mutex_unlock(&serial->disc_mutex);
419 /* add the tracker to the active_urbs list and submit */
420 spin_lock_irqsave(&mos_parport->listlock, flags);
421 list_add_tail(&urbtrack->urblist_entry, &mos_parport->active_urbs);
422 spin_unlock_irqrestore(&mos_parport->listlock, flags);
423 ret_val = usb_submit_urb(urbtrack->urb, GFP_ATOMIC);
424 mutex_unlock(&serial->disc_mutex);
426 dev_err(&usbdev->dev,
427 "%s: submit_urb() failed: %d\n", __func__, ret_val);
428 spin_lock_irqsave(&mos_parport->listlock, flags);
429 list_del(&urbtrack->urblist_entry);
430 spin_unlock_irqrestore(&mos_parport->listlock, flags);
431 kref_put(&urbtrack->ref_count, destroy_urbtracker);
438 * This is the the common top part of all parallel port callback operations that
439 * send synchronous messages to the device. This implements convoluted locking
440 * that avoids two scenarios: (1) a port operation is called after usbserial
441 * has called our release function, at which point struct mos7715_parport has
442 * been destroyed, and (2) the device has been disconnected, but usbserial has
443 * not called the release function yet because someone has a serial port open.
444 * The shared release_lock prevents the first, and the mutex and disconnected
445 * flag maintained by usbserial covers the second. We also use the msg_pending
446 * flag to ensure that all synchronous usb message calls have completed before
447 * our release function can return.
449 static int parport_prologue(struct parport *pp)
451 struct mos7715_parport *mos_parport;
453 spin_lock(&release_lock);
454 mos_parport = pp->private_data;
455 if (unlikely(mos_parport == NULL)) {
456 /* release fn called, port struct destroyed */
457 spin_unlock(&release_lock);
460 mos_parport->msg_pending = true; /* synch usb call pending */
461 reinit_completion(&mos_parport->syncmsg_compl);
462 spin_unlock(&release_lock);
464 mutex_lock(&mos_parport->serial->disc_mutex);
465 if (mos_parport->serial->disconnected) {
466 /* device disconnected */
467 mutex_unlock(&mos_parport->serial->disc_mutex);
468 mos_parport->msg_pending = false;
469 complete(&mos_parport->syncmsg_compl);
477 * This is the common bottom part of all parallel port functions that send
478 * synchronous messages to the device.
480 static inline void parport_epilogue(struct parport *pp)
482 struct mos7715_parport *mos_parport = pp->private_data;
483 mutex_unlock(&mos_parport->serial->disc_mutex);
484 mos_parport->msg_pending = false;
485 complete(&mos_parport->syncmsg_compl);
488 static void parport_mos7715_write_data(struct parport *pp, unsigned char d)
490 struct mos7715_parport *mos_parport = pp->private_data;
492 if (parport_prologue(pp) < 0)
494 mos7715_change_mode(mos_parport, SPP);
495 write_mos_reg(mos_parport->serial, dummy, MOS7720_DPR, (__u8)d);
496 parport_epilogue(pp);
499 static unsigned char parport_mos7715_read_data(struct parport *pp)
501 struct mos7715_parport *mos_parport = pp->private_data;
504 if (parport_prologue(pp) < 0)
506 read_mos_reg(mos_parport->serial, dummy, MOS7720_DPR, &d);
507 parport_epilogue(pp);
511 static void parport_mos7715_write_control(struct parport *pp, unsigned char d)
513 struct mos7715_parport *mos_parport = pp->private_data;
516 if (parport_prologue(pp) < 0)
518 data = ((__u8)d & 0x0f) | (mos_parport->shadowDCR & 0xf0);
519 write_mos_reg(mos_parport->serial, dummy, MOS7720_DCR, data);
520 mos_parport->shadowDCR = data;
521 parport_epilogue(pp);
524 static unsigned char parport_mos7715_read_control(struct parport *pp)
526 struct mos7715_parport *mos_parport = pp->private_data;
529 spin_lock(&release_lock);
530 mos_parport = pp->private_data;
531 if (unlikely(mos_parport == NULL)) {
532 spin_unlock(&release_lock);
535 dcr = mos_parport->shadowDCR & 0x0f;
536 spin_unlock(&release_lock);
540 static unsigned char parport_mos7715_frob_control(struct parport *pp,
544 struct mos7715_parport *mos_parport = pp->private_data;
549 if (parport_prologue(pp) < 0)
551 mos_parport->shadowDCR = (mos_parport->shadowDCR & (~mask)) ^ val;
552 write_mos_reg(mos_parport->serial, dummy, MOS7720_DCR,
553 mos_parport->shadowDCR);
554 dcr = mos_parport->shadowDCR & 0x0f;
555 parport_epilogue(pp);
559 static unsigned char parport_mos7715_read_status(struct parport *pp)
561 unsigned char status;
562 struct mos7715_parport *mos_parport = pp->private_data;
564 spin_lock(&release_lock);
565 mos_parport = pp->private_data;
566 if (unlikely(mos_parport == NULL)) { /* release called */
567 spin_unlock(&release_lock);
570 status = atomic_read(&mos_parport->shadowDSR) & 0xf8;
571 spin_unlock(&release_lock);
575 static void parport_mos7715_enable_irq(struct parport *pp)
579 static void parport_mos7715_disable_irq(struct parport *pp)
583 static void parport_mos7715_data_forward(struct parport *pp)
585 struct mos7715_parport *mos_parport = pp->private_data;
587 if (parport_prologue(pp) < 0)
589 mos7715_change_mode(mos_parport, PS2);
590 mos_parport->shadowDCR &= ~0x20;
591 write_mos_reg(mos_parport->serial, dummy, MOS7720_DCR,
592 mos_parport->shadowDCR);
593 parport_epilogue(pp);
596 static void parport_mos7715_data_reverse(struct parport *pp)
598 struct mos7715_parport *mos_parport = pp->private_data;
600 if (parport_prologue(pp) < 0)
602 mos7715_change_mode(mos_parport, PS2);
603 mos_parport->shadowDCR |= 0x20;
604 write_mos_reg(mos_parport->serial, dummy, MOS7720_DCR,
605 mos_parport->shadowDCR);
606 parport_epilogue(pp);
609 static void parport_mos7715_init_state(struct pardevice *dev,
610 struct parport_state *s)
612 s->u.pc.ctr = DCR_INIT_VAL;
613 s->u.pc.ecr = ECR_INIT_VAL;
616 /* N.B. Parport core code requires that this function not block */
617 static void parport_mos7715_save_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 s->u.pc.ctr = mos_parport->shadowDCR;
629 s->u.pc.ecr = mos_parport->shadowECR;
630 spin_unlock(&release_lock);
633 /* N.B. Parport core code requires that this function not block */
634 static void parport_mos7715_restore_state(struct parport *pp,
635 struct parport_state *s)
637 struct mos7715_parport *mos_parport;
639 spin_lock(&release_lock);
640 mos_parport = pp->private_data;
641 if (unlikely(mos_parport == NULL)) { /* release called */
642 spin_unlock(&release_lock);
645 mos_parport->shadowDCR = s->u.pc.ctr;
646 mos_parport->shadowECR = s->u.pc.ecr;
647 write_parport_reg_nonblock(mos_parport, MOS7720_DCR,
648 mos_parport->shadowDCR);
649 write_parport_reg_nonblock(mos_parport, MOS7720_ECR,
650 mos_parport->shadowECR);
651 spin_unlock(&release_lock);
654 static size_t parport_mos7715_write_compat(struct parport *pp,
656 size_t len, int flags)
659 struct mos7715_parport *mos_parport = pp->private_data;
662 if (parport_prologue(pp) < 0)
664 mos7715_change_mode(mos_parport, PPF);
665 retval = usb_bulk_msg(mos_parport->serial->dev,
666 usb_sndbulkpipe(mos_parport->serial->dev, 2),
667 (void *)buffer, len, &actual_len,
669 parport_epilogue(pp);
671 dev_err(&mos_parport->serial->dev->dev,
672 "mos7720: usb_bulk_msg() failed: %d\n", retval);
678 static struct parport_operations parport_mos7715_ops = {
679 .owner = THIS_MODULE,
680 .write_data = parport_mos7715_write_data,
681 .read_data = parport_mos7715_read_data,
683 .write_control = parport_mos7715_write_control,
684 .read_control = parport_mos7715_read_control,
685 .frob_control = parport_mos7715_frob_control,
687 .read_status = parport_mos7715_read_status,
689 .enable_irq = parport_mos7715_enable_irq,
690 .disable_irq = parport_mos7715_disable_irq,
692 .data_forward = parport_mos7715_data_forward,
693 .data_reverse = parport_mos7715_data_reverse,
695 .init_state = parport_mos7715_init_state,
696 .save_state = parport_mos7715_save_state,
697 .restore_state = parport_mos7715_restore_state,
699 .compat_write_data = parport_mos7715_write_compat,
701 .nibble_read_data = parport_ieee1284_read_nibble,
702 .byte_read_data = parport_ieee1284_read_byte,
706 * Allocate and initialize parallel port control struct, initialize
707 * the parallel port hardware device, and register with the parport subsystem.
709 static int mos7715_parport_init(struct usb_serial *serial)
711 struct mos7715_parport *mos_parport;
713 /* allocate and initialize parallel port control struct */
714 mos_parport = kzalloc(sizeof(struct mos7715_parport), GFP_KERNEL);
718 mos_parport->msg_pending = false;
719 kref_init(&mos_parport->ref_count);
720 spin_lock_init(&mos_parport->listlock);
721 INIT_LIST_HEAD(&mos_parport->active_urbs);
722 INIT_LIST_HEAD(&mos_parport->deferred_urbs);
723 usb_set_serial_data(serial, mos_parport); /* hijack private pointer */
724 mos_parport->serial = serial;
725 tasklet_init(&mos_parport->urb_tasklet, send_deferred_urbs,
726 (unsigned long) mos_parport);
727 init_completion(&mos_parport->syncmsg_compl);
729 /* cycle parallel port reset bit */
730 write_mos_reg(mos_parport->serial, dummy, MOS7720_PP_REG, (__u8)0x80);
731 write_mos_reg(mos_parport->serial, dummy, MOS7720_PP_REG, (__u8)0x00);
733 /* initialize device registers */
734 mos_parport->shadowDCR = DCR_INIT_VAL;
735 write_mos_reg(mos_parport->serial, dummy, MOS7720_DCR,
736 mos_parport->shadowDCR);
737 mos_parport->shadowECR = ECR_INIT_VAL;
738 write_mos_reg(mos_parport->serial, dummy, MOS7720_ECR,
739 mos_parport->shadowECR);
741 /* register with parport core */
742 mos_parport->pp = parport_register_port(0, PARPORT_IRQ_NONE,
744 &parport_mos7715_ops);
745 if (mos_parport->pp == NULL) {
746 dev_err(&serial->interface->dev,
747 "Could not register parport\n");
748 kref_put(&mos_parport->ref_count, destroy_mos_parport);
751 mos_parport->pp->private_data = mos_parport;
752 mos_parport->pp->modes = PARPORT_MODE_COMPAT | PARPORT_MODE_PCSPP;
753 mos_parport->pp->dev = &serial->interface->dev;
754 parport_announce_port(mos_parport->pp);
758 #endif /* CONFIG_USB_SERIAL_MOS7715_PARPORT */
761 * mos7720_interrupt_callback
762 * this is the callback function for when we have received data on the
763 * interrupt endpoint.
765 static void mos7720_interrupt_callback(struct urb *urb)
769 int status = urb->status;
770 struct device *dev = &urb->dev->dev;
782 /* this urb is terminated, clean up */
783 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
786 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
790 length = urb->actual_length;
791 data = urb->transfer_buffer;
793 /* Moschip get 4 bytes
794 * Byte 1 IIR Port 1 (port.number is 0)
795 * Byte 2 IIR Port 2 (port.number is 1)
796 * Byte 3 --------------
797 * Byte 4 FIFO status for both */
799 /* the above description is inverted
800 * oneukum 2007-03-14 */
802 if (unlikely(length != 4)) {
803 dev_dbg(dev, "Wrong data !!!\n");
810 if ((sp1 | sp2) & 0x01) {
811 /* No Interrupt Pending in both the ports */
812 dev_dbg(dev, "No Interrupt !!!\n");
814 switch (sp1 & 0x0f) {
816 dev_dbg(dev, "Serial Port 1: Receiver status error or address bit detected in 9-bit mode\n");
819 dev_dbg(dev, "Serial Port 1: Receiver time out\n");
822 /* dev_dbg(dev, "Serial Port 1: Modem status change\n"); */
826 switch (sp2 & 0x0f) {
828 dev_dbg(dev, "Serial Port 2: Receiver status error or address bit detected in 9-bit mode\n");
831 dev_dbg(dev, "Serial Port 2: Receiver time out\n");
834 /* dev_dbg(dev, "Serial Port 2: Modem status change\n"); */
840 result = usb_submit_urb(urb, GFP_ATOMIC);
842 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
846 * mos7715_interrupt_callback
847 * this is the 7715's callback function for when we have received data on
848 * the interrupt endpoint.
850 static void mos7715_interrupt_callback(struct urb *urb)
854 int status = urb->status;
855 struct device *dev = &urb->dev->dev;
867 /* this urb is terminated, clean up */
868 dev_dbg(dev, "%s - urb shutting down with status: %d\n", __func__, status);
871 dev_dbg(dev, "%s - nonzero urb status received: %d\n", __func__, status);
875 length = urb->actual_length;
876 data = urb->transfer_buffer;
878 /* Structure of data from 7715 device:
879 * Byte 1: IIR serial Port
881 * Byte 2: DSR parallel port
882 * Byte 4: FIFO status for both */
884 if (unlikely(length != 4)) {
885 dev_dbg(dev, "Wrong data !!!\n");
890 if (!(iir & 0x01)) { /* serial port interrupt pending */
891 switch (iir & 0x0f) {
893 dev_dbg(dev, "Serial Port: Receiver status error or address bit detected in 9-bit mode\n");
896 dev_dbg(dev, "Serial Port: Receiver time out\n");
899 /* dev_dbg(dev, "Serial Port: Modem status change\n"); */
904 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
905 { /* update local copy of DSR reg */
906 struct usb_serial_port *port = urb->context;
907 struct mos7715_parport *mos_parport = port->serial->private;
908 if (unlikely(mos_parport == NULL))
910 atomic_set(&mos_parport->shadowDSR, data[2]);
915 result = usb_submit_urb(urb, GFP_ATOMIC);
917 dev_err(dev, "%s - Error %d submitting control urb\n", __func__, result);
921 * mos7720_bulk_in_callback
922 * this is the callback function for when we have received data on the
925 static void mos7720_bulk_in_callback(struct urb *urb)
928 unsigned char *data ;
929 struct usb_serial_port *port;
930 int status = urb->status;
933 dev_dbg(&urb->dev->dev, "nonzero read bulk status received: %d\n", status);
939 dev_dbg(&port->dev, "Entering...%s\n", __func__);
941 data = urb->transfer_buffer;
943 if (urb->actual_length) {
944 tty_insert_flip_string(&port->port, data, urb->actual_length);
945 tty_flip_buffer_push(&port->port);
948 if (port->read_urb->status != -EINPROGRESS) {
949 retval = usb_submit_urb(port->read_urb, GFP_ATOMIC);
951 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, retval = %d\n", retval);
956 * mos7720_bulk_out_data_callback
957 * this is the callback function for when we have finished sending serial
958 * data on the bulk out endpoint.
960 static void mos7720_bulk_out_data_callback(struct urb *urb)
962 struct moschip_port *mos7720_port;
963 int status = urb->status;
966 dev_dbg(&urb->dev->dev, "nonzero write bulk status received:%d\n", status);
970 mos7720_port = urb->context;
972 dev_dbg(&urb->dev->dev, "NULL mos7720_port pointer\n");
976 if (mos7720_port->open)
977 tty_port_tty_wakeup(&mos7720_port->port->port);
980 static int mos77xx_calc_num_ports(struct usb_serial *serial)
982 u16 product = le16_to_cpu(serial->dev->descriptor.idProduct);
983 if (product == MOSCHIP_DEVICE_ID_7715)
989 static int mos7720_open(struct tty_struct *tty, struct usb_serial_port *port)
991 struct usb_serial *serial;
993 struct moschip_port *mos7720_port;
997 int allocated_urbs = 0;
1000 serial = port->serial;
1002 mos7720_port = usb_get_serial_port_data(port);
1003 if (mos7720_port == NULL)
1006 usb_clear_halt(serial->dev, port->write_urb->pipe);
1007 usb_clear_halt(serial->dev, port->read_urb->pipe);
1009 /* Initialising the write urb pool */
1010 for (j = 0; j < NUM_URBS; ++j) {
1011 urb = usb_alloc_urb(0, GFP_KERNEL);
1012 mos7720_port->write_urb_pool[j] = urb;
1016 urb->transfer_buffer = kmalloc(URB_TRANSFER_BUFFER_SIZE,
1018 if (!urb->transfer_buffer) {
1019 usb_free_urb(mos7720_port->write_urb_pool[j]);
1020 mos7720_port->write_urb_pool[j] = NULL;
1026 if (!allocated_urbs)
1029 /* Initialize MCS7720 -- Write Init values to corresponding Registers
1032 * 0 : MOS7720_THR/MOS7720_RHR
1041 * 0x08 : SP1/2 Control Reg
1043 port_number = port->port_number;
1044 read_mos_reg(serial, port_number, MOS7720_LSR, &data);
1046 dev_dbg(&port->dev, "SS::%p LSR:%x\n", mos7720_port, data);
1048 write_mos_reg(serial, dummy, MOS7720_SP1_REG, 0x02);
1049 write_mos_reg(serial, dummy, MOS7720_SP2_REG, 0x02);
1051 write_mos_reg(serial, port_number, MOS7720_IER, 0x00);
1052 write_mos_reg(serial, port_number, MOS7720_FCR, 0x00);
1054 write_mos_reg(serial, port_number, MOS7720_FCR, 0xcf);
1055 mos7720_port->shadowLCR = 0x03;
1056 write_mos_reg(serial, port_number, MOS7720_LCR,
1057 mos7720_port->shadowLCR);
1058 mos7720_port->shadowMCR = 0x0b;
1059 write_mos_reg(serial, port_number, MOS7720_MCR,
1060 mos7720_port->shadowMCR);
1062 write_mos_reg(serial, port_number, MOS7720_SP_CONTROL_REG, 0x00);
1063 read_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG, &data);
1064 data = data | (port->port_number + 1);
1065 write_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG, data);
1066 mos7720_port->shadowLCR = 0x83;
1067 write_mos_reg(serial, port_number, MOS7720_LCR,
1068 mos7720_port->shadowLCR);
1069 write_mos_reg(serial, port_number, MOS7720_THR, 0x0c);
1070 write_mos_reg(serial, port_number, MOS7720_IER, 0x00);
1071 mos7720_port->shadowLCR = 0x03;
1072 write_mos_reg(serial, port_number, MOS7720_LCR,
1073 mos7720_port->shadowLCR);
1074 write_mos_reg(serial, port_number, MOS7720_IER, 0x0c);
1076 response = usb_submit_urb(port->read_urb, GFP_KERNEL);
1078 dev_err(&port->dev, "%s - Error %d submitting read urb\n",
1079 __func__, response);
1081 /* initialize our port settings */
1082 mos7720_port->shadowMCR = UART_MCR_OUT2; /* Must set to enable ints! */
1084 /* send a open port command */
1085 mos7720_port->open = 1;
1091 * mos7720_chars_in_buffer
1092 * this function is called by the tty driver when it wants to know how many
1093 * bytes of data we currently have outstanding in the port (data that has
1094 * been written, but hasn't made it out the port yet)
1095 * If successful, we return the number of bytes left to be written in the
1097 * Otherwise we return a negative error number.
1099 static int mos7720_chars_in_buffer(struct tty_struct *tty)
1101 struct usb_serial_port *port = tty->driver_data;
1104 struct moschip_port *mos7720_port;
1106 mos7720_port = usb_get_serial_port_data(port);
1107 if (mos7720_port == NULL)
1110 for (i = 0; i < NUM_URBS; ++i) {
1111 if (mos7720_port->write_urb_pool[i] &&
1112 mos7720_port->write_urb_pool[i]->status == -EINPROGRESS)
1113 chars += URB_TRANSFER_BUFFER_SIZE;
1115 dev_dbg(&port->dev, "%s - returns %d\n", __func__, chars);
1119 static void mos7720_close(struct usb_serial_port *port)
1121 struct usb_serial *serial;
1122 struct moschip_port *mos7720_port;
1125 serial = port->serial;
1127 mos7720_port = usb_get_serial_port_data(port);
1128 if (mos7720_port == NULL)
1131 for (j = 0; j < NUM_URBS; ++j)
1132 usb_kill_urb(mos7720_port->write_urb_pool[j]);
1134 /* Freeing Write URBs */
1135 for (j = 0; j < NUM_URBS; ++j) {
1136 if (mos7720_port->write_urb_pool[j]) {
1137 kfree(mos7720_port->write_urb_pool[j]->transfer_buffer);
1138 usb_free_urb(mos7720_port->write_urb_pool[j]);
1142 /* While closing port, shutdown all bulk read, write *
1143 * and interrupt read if they exists, otherwise nop */
1144 usb_kill_urb(port->write_urb);
1145 usb_kill_urb(port->read_urb);
1147 write_mos_reg(serial, port->port_number, MOS7720_MCR, 0x00);
1148 write_mos_reg(serial, port->port_number, MOS7720_IER, 0x00);
1150 mos7720_port->open = 0;
1153 static void mos7720_break(struct tty_struct *tty, int break_state)
1155 struct usb_serial_port *port = tty->driver_data;
1157 struct usb_serial *serial;
1158 struct moschip_port *mos7720_port;
1160 serial = port->serial;
1162 mos7720_port = usb_get_serial_port_data(port);
1163 if (mos7720_port == NULL)
1166 if (break_state == -1)
1167 data = mos7720_port->shadowLCR | UART_LCR_SBC;
1169 data = mos7720_port->shadowLCR & ~UART_LCR_SBC;
1171 mos7720_port->shadowLCR = data;
1172 write_mos_reg(serial, port->port_number, MOS7720_LCR,
1173 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) {
1245 bytes_sent = -ENOMEM;
1249 transfer_size = min(count, URB_TRANSFER_BUFFER_SIZE);
1251 memcpy(urb->transfer_buffer, current_position, transfer_size);
1252 usb_serial_debug_data(&port->dev, __func__, transfer_size,
1253 urb->transfer_buffer);
1255 /* fill urb with data and submit */
1256 usb_fill_bulk_urb(urb, serial->dev,
1257 usb_sndbulkpipe(serial->dev,
1258 port->bulk_out_endpointAddress),
1259 urb->transfer_buffer, transfer_size,
1260 mos7720_bulk_out_data_callback, mos7720_port);
1262 /* send it down the pipe */
1263 status = usb_submit_urb(urb, GFP_ATOMIC);
1265 dev_err_console(port, "%s - usb_submit_urb(write bulk) failed "
1266 "with status = %d\n", __func__, status);
1267 bytes_sent = status;
1270 bytes_sent = transfer_size;
1276 static void mos7720_throttle(struct tty_struct *tty)
1278 struct usb_serial_port *port = tty->driver_data;
1279 struct moschip_port *mos7720_port;
1282 mos7720_port = usb_get_serial_port_data(port);
1284 if (mos7720_port == NULL)
1287 if (!mos7720_port->open) {
1288 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1292 /* if we are implementing XON/XOFF, send the stop character */
1294 unsigned char stop_char = STOP_CHAR(tty);
1295 status = mos7720_write(tty, port, &stop_char, 1);
1300 /* if we are implementing RTS/CTS, toggle that line */
1301 if (tty->termios.c_cflag & CRTSCTS) {
1302 mos7720_port->shadowMCR &= ~UART_MCR_RTS;
1303 write_mos_reg(port->serial, port->port_number, MOS7720_MCR,
1304 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, MOS7720_MCR,
1334 mos7720_port->shadowMCR);
1338 /* FIXME: this function does not work */
1339 static int set_higher_rates(struct moschip_port *mos7720_port,
1342 struct usb_serial_port *port;
1343 struct usb_serial *serial;
1345 enum mos_regs sp_reg;
1346 if (mos7720_port == NULL)
1349 port = mos7720_port->port;
1350 serial = port->serial;
1352 /***********************************************
1353 * Init Sequence for higher rates
1354 ***********************************************/
1355 dev_dbg(&port->dev, "Sending Setting Commands ..........\n");
1356 port_number = port->port_number;
1358 write_mos_reg(serial, port_number, MOS7720_IER, 0x00);
1359 write_mos_reg(serial, port_number, MOS7720_FCR, 0x00);
1360 write_mos_reg(serial, port_number, MOS7720_FCR, 0xcf);
1361 mos7720_port->shadowMCR = 0x0b;
1362 write_mos_reg(serial, port_number, MOS7720_MCR,
1363 mos7720_port->shadowMCR);
1364 write_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG, 0x00);
1366 /***********************************************
1367 * Set for higher rates *
1368 ***********************************************/
1369 /* writing baud rate verbatum into uart clock field clearly not right */
1370 if (port_number == 0)
1371 sp_reg = MOS7720_SP1_REG;
1373 sp_reg = MOS7720_SP2_REG;
1374 write_mos_reg(serial, dummy, sp_reg, baud * 0x10);
1375 write_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG, 0x03);
1376 mos7720_port->shadowMCR = 0x2b;
1377 write_mos_reg(serial, port_number, MOS7720_MCR,
1378 mos7720_port->shadowMCR);
1380 /***********************************************
1382 ***********************************************/
1383 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1384 write_mos_reg(serial, port_number, MOS7720_LCR,
1385 mos7720_port->shadowLCR);
1386 write_mos_reg(serial, port_number, MOS7720_DLL, 0x01);
1387 write_mos_reg(serial, port_number, MOS7720_DLM, 0x00);
1388 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1389 write_mos_reg(serial, port_number, MOS7720_LCR,
1390 mos7720_port->shadowLCR);
1395 /* baud rate information */
1396 struct divisor_table_entry {
1401 /* Define table of divisors for moschip 7720 hardware *
1402 * These assume a 3.6864MHz crystal, the standard /16, and *
1404 static struct divisor_table_entry divisor_table[] = {
1406 { 110, 1047}, /* 2094.545455 => 230450 => .0217 % over */
1407 { 134, 857}, /* 1713.011152 => 230398.5 => .00065% under */
1423 /*****************************************************************************
1424 * calc_baud_rate_divisor
1425 * this function calculates the proper baud rate divisor for the specified
1427 *****************************************************************************/
1428 static int calc_baud_rate_divisor(struct usb_serial_port *port, int baudrate, int *divisor)
1436 dev_dbg(&port->dev, "%s - %d\n", __func__, baudrate);
1438 for (i = 0; i < ARRAY_SIZE(divisor_table); i++) {
1439 if (divisor_table[i].baudrate == baudrate) {
1440 *divisor = divisor_table[i].divisor;
1445 /* After trying for all the standard baud rates *
1446 * Try calculating the divisor for this baud rate */
1447 if (baudrate > 75 && baudrate < 230400) {
1448 /* get the divisor */
1449 custom = (__u16)(230400L / baudrate);
1451 /* Check for round off */
1452 round1 = (__u16)(2304000L / baudrate);
1453 round = (__u16)(round1 - (custom * 10));
1458 dev_dbg(&port->dev, "Baud %d = %d\n", baudrate, custom);
1462 dev_dbg(&port->dev, "Baud calculation Failed...\n");
1467 * send_cmd_write_baud_rate
1468 * this function sends the proper command to change the baud rate of the
1471 static int send_cmd_write_baud_rate(struct moschip_port *mos7720_port,
1474 struct usb_serial_port *port;
1475 struct usb_serial *serial;
1478 unsigned char number;
1480 if (mos7720_port == NULL)
1483 port = mos7720_port->port;
1484 serial = port->serial;
1486 number = port->port_number;
1487 dev_dbg(&port->dev, "%s - baud = %d\n", __func__, baudrate);
1489 /* Calculate the Divisor */
1490 status = calc_baud_rate_divisor(port, baudrate, &divisor);
1492 dev_err(&port->dev, "%s - bad baud rate\n", __func__);
1496 /* Enable access to divisor latch */
1497 mos7720_port->shadowLCR = mos7720_port->shadowLCR | UART_LCR_DLAB;
1498 write_mos_reg(serial, number, MOS7720_LCR, mos7720_port->shadowLCR);
1500 /* Write the divisor */
1501 write_mos_reg(serial, number, MOS7720_DLL, (__u8)(divisor & 0xff));
1502 write_mos_reg(serial, number, MOS7720_DLM,
1503 (__u8)((divisor & 0xff00) >> 8));
1505 /* Disable access to divisor latch */
1506 mos7720_port->shadowLCR = mos7720_port->shadowLCR & ~UART_LCR_DLAB;
1507 write_mos_reg(serial, number, MOS7720_LCR, mos7720_port->shadowLCR);
1513 * change_port_settings
1514 * This routine is called to set the UART on the device to match
1515 * the specified new settings.
1517 static void change_port_settings(struct tty_struct *tty,
1518 struct moschip_port *mos7720_port,
1519 struct ktermios *old_termios)
1521 struct usb_serial_port *port;
1522 struct usb_serial *serial;
1533 if (mos7720_port == NULL)
1536 port = mos7720_port->port;
1537 serial = port->serial;
1538 port_number = port->port_number;
1540 if (!mos7720_port->open) {
1541 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1545 lData = UART_LCR_WLEN8;
1546 lStop = 0x00; /* 1 stop bit */
1547 lParity = 0x00; /* No parity */
1549 cflag = tty->termios.c_cflag;
1550 iflag = tty->termios.c_iflag;
1552 /* Change the number of bits */
1553 switch (cflag & CSIZE) {
1555 lData = UART_LCR_WLEN5;
1560 lData = UART_LCR_WLEN6;
1565 lData = UART_LCR_WLEN7;
1570 lData = UART_LCR_WLEN8;
1574 /* Change the Parity bit */
1575 if (cflag & PARENB) {
1576 if (cflag & PARODD) {
1577 lParity = UART_LCR_PARITY;
1578 dev_dbg(&port->dev, "%s - parity = odd\n", __func__);
1580 lParity = (UART_LCR_EPAR | UART_LCR_PARITY);
1581 dev_dbg(&port->dev, "%s - parity = even\n", __func__);
1585 dev_dbg(&port->dev, "%s - parity = none\n", __func__);
1589 lParity = lParity | 0x20;
1591 /* Change the Stop bit */
1592 if (cflag & CSTOPB) {
1593 lStop = UART_LCR_STOP;
1594 dev_dbg(&port->dev, "%s - stop bits = 2\n", __func__);
1597 dev_dbg(&port->dev, "%s - stop bits = 1\n", __func__);
1600 #define LCR_BITS_MASK 0x03 /* Mask for bits/char field */
1601 #define LCR_STOP_MASK 0x04 /* Mask for stop bits field */
1602 #define LCR_PAR_MASK 0x38 /* Mask for parity field */
1604 /* Update the LCR with the correct value */
1605 mos7720_port->shadowLCR &=
1606 ~(LCR_BITS_MASK | LCR_STOP_MASK | LCR_PAR_MASK);
1607 mos7720_port->shadowLCR |= (lData | lParity | lStop);
1610 /* Disable Interrupts */
1611 write_mos_reg(serial, port_number, MOS7720_IER, 0x00);
1612 write_mos_reg(serial, port_number, MOS7720_FCR, 0x00);
1613 write_mos_reg(serial, port_number, MOS7720_FCR, 0xcf);
1615 /* Send the updated LCR value to the mos7720 */
1616 write_mos_reg(serial, port_number, MOS7720_LCR,
1617 mos7720_port->shadowLCR);
1618 mos7720_port->shadowMCR = 0x0b;
1619 write_mos_reg(serial, port_number, MOS7720_MCR,
1620 mos7720_port->shadowMCR);
1622 /* set up the MCR register and send it to the mos7720 */
1623 mos7720_port->shadowMCR = UART_MCR_OUT2;
1625 mos7720_port->shadowMCR |= (UART_MCR_DTR | UART_MCR_RTS);
1627 if (cflag & CRTSCTS) {
1628 mos7720_port->shadowMCR |= (UART_MCR_XONANY);
1629 /* To set hardware flow control to the specified *
1630 * serial port, in SP1/2_CONTROL_REG */
1632 write_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG,
1635 write_mos_reg(serial, dummy, MOS7720_SP_CONTROL_REG,
1639 mos7720_port->shadowMCR &= ~(UART_MCR_XONANY);
1641 write_mos_reg(serial, port_number, MOS7720_MCR,
1642 mos7720_port->shadowMCR);
1644 /* Determine divisor based on baud rate */
1645 baud = tty_get_baud_rate(tty);
1647 /* pick a default, any default... */
1648 dev_dbg(&port->dev, "Picked default baud...\n");
1652 if (baud >= 230400) {
1653 set_higher_rates(mos7720_port, baud);
1654 /* Enable Interrupts */
1655 write_mos_reg(serial, port_number, MOS7720_IER, 0x0c);
1659 dev_dbg(&port->dev, "%s - baud rate = %d\n", __func__, baud);
1660 status = send_cmd_write_baud_rate(mos7720_port, baud);
1661 /* FIXME: needs to write actual resulting baud back not just
1664 tty_encode_baud_rate(tty, baud, baud);
1665 /* Enable Interrupts */
1666 write_mos_reg(serial, port_number, MOS7720_IER, 0x0c);
1668 if (port->read_urb->status != -EINPROGRESS) {
1669 status = usb_submit_urb(port->read_urb, GFP_KERNEL);
1671 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1676 * mos7720_set_termios
1677 * this function is called by the tty driver when it wants to change the
1678 * termios structure.
1680 static void mos7720_set_termios(struct tty_struct *tty,
1681 struct usb_serial_port *port, struct ktermios *old_termios)
1685 struct usb_serial *serial;
1686 struct moschip_port *mos7720_port;
1688 serial = port->serial;
1690 mos7720_port = usb_get_serial_port_data(port);
1692 if (mos7720_port == NULL)
1695 if (!mos7720_port->open) {
1696 dev_dbg(&port->dev, "%s - port not opened\n", __func__);
1700 dev_dbg(&port->dev, "setting termios - ASPIRE\n");
1702 cflag = tty->termios.c_cflag;
1704 dev_dbg(&port->dev, "%s - cflag %08x iflag %08x\n", __func__,
1705 tty->termios.c_cflag, RELEVANT_IFLAG(tty->termios.c_iflag));
1707 dev_dbg(&port->dev, "%s - old cflag %08x old iflag %08x\n", __func__,
1708 old_termios->c_cflag, RELEVANT_IFLAG(old_termios->c_iflag));
1710 /* change the port settings to the new ones specified */
1711 change_port_settings(tty, mos7720_port, old_termios);
1713 if (port->read_urb->status != -EINPROGRESS) {
1714 status = usb_submit_urb(port->read_urb, GFP_KERNEL);
1716 dev_dbg(&port->dev, "usb_submit_urb(read bulk) failed, status = %d\n", status);
1721 * get_lsr_info - get line status register info
1723 * Purpose: Let user call ioctl() to get info when the UART physically
1724 * is emptied. On bus types like RS485, the transmitter must
1725 * release the bus after transmitting. This must be done when
1726 * the transmit shift register is empty, not be done when the
1727 * transmit holding register is empty. This functionality
1728 * allows an RS485 driver to be written in user space.
1730 static int get_lsr_info(struct tty_struct *tty,
1731 struct moschip_port *mos7720_port, unsigned int __user *value)
1733 struct usb_serial_port *port = tty->driver_data;
1734 unsigned int result = 0;
1735 unsigned char data = 0;
1736 int port_number = port->port_number;
1739 count = mos7720_chars_in_buffer(tty);
1741 read_mos_reg(port->serial, port_number, MOS7720_LSR, &data);
1742 if ((data & (UART_LSR_TEMT | UART_LSR_THRE))
1743 == (UART_LSR_TEMT | UART_LSR_THRE)) {
1744 dev_dbg(&port->dev, "%s -- Empty\n", __func__);
1745 result = TIOCSER_TEMT;
1748 if (copy_to_user(value, &result, sizeof(int)))
1753 static int mos7720_tiocmget(struct tty_struct *tty)
1755 struct usb_serial_port *port = tty->driver_data;
1756 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1757 unsigned int result = 0;
1761 mcr = mos7720_port->shadowMCR;
1762 msr = mos7720_port->shadowMSR;
1764 result = ((mcr & UART_MCR_DTR) ? TIOCM_DTR : 0) /* 0x002 */
1765 | ((mcr & UART_MCR_RTS) ? TIOCM_RTS : 0) /* 0x004 */
1766 | ((msr & UART_MSR_CTS) ? TIOCM_CTS : 0) /* 0x020 */
1767 | ((msr & UART_MSR_DCD) ? TIOCM_CAR : 0) /* 0x040 */
1768 | ((msr & UART_MSR_RI) ? TIOCM_RI : 0) /* 0x080 */
1769 | ((msr & UART_MSR_DSR) ? TIOCM_DSR : 0); /* 0x100 */
1774 static int mos7720_tiocmset(struct tty_struct *tty,
1775 unsigned int set, unsigned int clear)
1777 struct usb_serial_port *port = tty->driver_data;
1778 struct moschip_port *mos7720_port = usb_get_serial_port_data(port);
1781 mcr = mos7720_port->shadowMCR;
1783 if (set & TIOCM_RTS)
1784 mcr |= UART_MCR_RTS;
1785 if (set & TIOCM_DTR)
1786 mcr |= UART_MCR_DTR;
1787 if (set & TIOCM_LOOP)
1788 mcr |= UART_MCR_LOOP;
1790 if (clear & TIOCM_RTS)
1791 mcr &= ~UART_MCR_RTS;
1792 if (clear & TIOCM_DTR)
1793 mcr &= ~UART_MCR_DTR;
1794 if (clear & TIOCM_LOOP)
1795 mcr &= ~UART_MCR_LOOP;
1797 mos7720_port->shadowMCR = mcr;
1798 write_mos_reg(port->serial, port->port_number, MOS7720_MCR,
1799 mos7720_port->shadowMCR);
1804 static int set_modem_info(struct moschip_port *mos7720_port, unsigned int cmd,
1805 unsigned int __user *value)
1810 struct usb_serial_port *port;
1812 if (mos7720_port == NULL)
1815 port = (struct usb_serial_port *)mos7720_port->port;
1816 mcr = mos7720_port->shadowMCR;
1818 if (copy_from_user(&arg, value, sizeof(int)))
1823 if (arg & TIOCM_RTS)
1824 mcr |= UART_MCR_RTS;
1825 if (arg & TIOCM_DTR)
1826 mcr |= UART_MCR_RTS;
1827 if (arg & TIOCM_LOOP)
1828 mcr |= UART_MCR_LOOP;
1832 if (arg & TIOCM_RTS)
1833 mcr &= ~UART_MCR_RTS;
1834 if (arg & TIOCM_DTR)
1835 mcr &= ~UART_MCR_RTS;
1836 if (arg & TIOCM_LOOP)
1837 mcr &= ~UART_MCR_LOOP;
1842 mos7720_port->shadowMCR = mcr;
1843 write_mos_reg(port->serial, port->port_number, MOS7720_MCR,
1844 mos7720_port->shadowMCR);
1849 static int get_serial_info(struct moschip_port *mos7720_port,
1850 struct serial_struct __user *retinfo)
1852 struct serial_struct tmp;
1857 memset(&tmp, 0, sizeof(tmp));
1859 tmp.type = PORT_16550A;
1860 tmp.line = mos7720_port->port->minor;
1861 tmp.port = mos7720_port->port->port_number;
1863 tmp.flags = ASYNC_SKIP_TEST | ASYNC_AUTO_IRQ;
1864 tmp.xmit_fifo_size = NUM_URBS * URB_TRANSFER_BUFFER_SIZE;
1865 tmp.baud_base = 9600;
1866 tmp.close_delay = 5*HZ;
1867 tmp.closing_wait = 30*HZ;
1869 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
1874 static int mos7720_ioctl(struct tty_struct *tty,
1875 unsigned int cmd, unsigned long arg)
1877 struct usb_serial_port *port = tty->driver_data;
1878 struct moschip_port *mos7720_port;
1880 mos7720_port = usb_get_serial_port_data(port);
1881 if (mos7720_port == NULL)
1886 dev_dbg(&port->dev, "%s TIOCSERGETLSR\n", __func__);
1887 return get_lsr_info(tty, mos7720_port,
1888 (unsigned int __user *)arg);
1890 /* FIXME: These should be using the mode methods */
1893 dev_dbg(&port->dev, "%s TIOCMSET/TIOCMBIC/TIOCMSET\n", __func__);
1894 return set_modem_info(mos7720_port, cmd,
1895 (unsigned int __user *)arg);
1898 dev_dbg(&port->dev, "%s TIOCGSERIAL\n", __func__);
1899 return get_serial_info(mos7720_port,
1900 (struct serial_struct __user *)arg);
1903 return -ENOIOCTLCMD;
1906 static int mos7720_startup(struct usb_serial *serial)
1908 struct usb_device *dev;
1913 if (serial->num_bulk_in < 2 || serial->num_bulk_out < 2) {
1914 dev_err(&serial->interface->dev, "missing bulk endpoints\n");
1918 product = le16_to_cpu(serial->dev->descriptor.idProduct);
1922 * The 7715 uses the first bulk in/out endpoint pair for the parallel
1923 * port, and the second for the serial port. Because the usbserial core
1924 * assumes both pairs are serial ports, we must engage in a bit of
1925 * subterfuge and swap the pointers for ports 0 and 1 in order to make
1926 * port 0 point to the serial port. However, both moschip devices use a
1927 * single interrupt-in endpoint for both ports (as mentioned a little
1928 * further down), and this endpoint was assigned to port 0. So after
1929 * the swap, we must copy the interrupt endpoint elements from port 1
1930 * (as newly assigned) to port 0, and null out port 1 pointers.
1932 if (product == MOSCHIP_DEVICE_ID_7715) {
1933 struct usb_serial_port *tmp = serial->port[0];
1934 serial->port[0] = serial->port[1];
1935 serial->port[1] = tmp;
1936 serial->port[0]->interrupt_in_urb = tmp->interrupt_in_urb;
1937 serial->port[0]->interrupt_in_buffer = tmp->interrupt_in_buffer;
1938 serial->port[0]->interrupt_in_endpointAddress =
1939 tmp->interrupt_in_endpointAddress;
1940 serial->port[1]->interrupt_in_urb = NULL;
1941 serial->port[1]->interrupt_in_buffer = NULL;
1943 if (serial->port[0]->interrupt_in_urb) {
1944 struct urb *urb = serial->port[0]->interrupt_in_urb;
1946 urb->complete = mos7715_interrupt_callback;
1950 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
1951 if (product == MOSCHIP_DEVICE_ID_7715) {
1952 ret_val = mos7715_parport_init(serial);
1957 /* start the interrupt urb */
1958 ret_val = usb_submit_urb(serial->port[0]->interrupt_in_urb, GFP_KERNEL);
1960 dev_err(&dev->dev, "failed to submit interrupt urb: %d\n",
1964 /* LSR For Port 1 */
1965 read_mos_reg(serial, 0, MOS7720_LSR, &data);
1966 dev_dbg(&dev->dev, "LSR:%x\n", data);
1971 static void mos7720_release(struct usb_serial *serial)
1973 usb_kill_urb(serial->port[0]->interrupt_in_urb);
1975 #ifdef CONFIG_USB_SERIAL_MOS7715_PARPORT
1976 /* close the parallel port */
1978 if (le16_to_cpu(serial->dev->descriptor.idProduct)
1979 == MOSCHIP_DEVICE_ID_7715) {
1980 struct urbtracker *urbtrack;
1981 unsigned long flags;
1982 struct mos7715_parport *mos_parport =
1983 usb_get_serial_data(serial);
1985 /* prevent NULL ptr dereference in port callbacks */
1986 spin_lock(&release_lock);
1987 mos_parport->pp->private_data = NULL;
1988 spin_unlock(&release_lock);
1990 /* wait for synchronous usb calls to return */
1991 if (mos_parport->msg_pending)
1992 wait_for_completion_timeout(&mos_parport->syncmsg_compl,
1993 msecs_to_jiffies(MOS_WDR_TIMEOUT));
1995 parport_remove_port(mos_parport->pp);
1996 usb_set_serial_data(serial, NULL);
1997 mos_parport->serial = NULL;
1999 /* if tasklet currently scheduled, wait for it to complete */
2000 tasklet_kill(&mos_parport->urb_tasklet);
2002 /* unlink any urbs sent by the tasklet */
2003 spin_lock_irqsave(&mos_parport->listlock, flags);
2004 list_for_each_entry(urbtrack,
2005 &mos_parport->active_urbs,
2007 usb_unlink_urb(urbtrack->urb);
2008 spin_unlock_irqrestore(&mos_parport->listlock, flags);
2009 parport_del_port(mos_parport->pp);
2011 kref_put(&mos_parport->ref_count, destroy_mos_parport);
2016 static int mos7720_port_probe(struct usb_serial_port *port)
2018 struct moschip_port *mos7720_port;
2020 mos7720_port = kzalloc(sizeof(*mos7720_port), GFP_KERNEL);
2024 /* Initialize all port interrupt end point to port 0 int endpoint.
2025 * Our device has only one interrupt endpoint common to all ports.
2027 port->interrupt_in_endpointAddress =
2028 port->serial->port[0]->interrupt_in_endpointAddress;
2029 mos7720_port->port = port;
2031 usb_set_serial_port_data(port, mos7720_port);
2036 static int mos7720_port_remove(struct usb_serial_port *port)
2038 struct moschip_port *mos7720_port;
2040 mos7720_port = usb_get_serial_port_data(port);
2041 kfree(mos7720_port);
2046 static struct usb_serial_driver moschip7720_2port_driver = {
2048 .owner = THIS_MODULE,
2049 .name = "moschip7720",
2051 .description = "Moschip 2 port adapter",
2052 .id_table = id_table,
2053 .calc_num_ports = mos77xx_calc_num_ports,
2054 .open = mos7720_open,
2055 .close = mos7720_close,
2056 .throttle = mos7720_throttle,
2057 .unthrottle = mos7720_unthrottle,
2058 .attach = mos7720_startup,
2059 .release = mos7720_release,
2060 .port_probe = mos7720_port_probe,
2061 .port_remove = mos7720_port_remove,
2062 .ioctl = mos7720_ioctl,
2063 .tiocmget = mos7720_tiocmget,
2064 .tiocmset = mos7720_tiocmset,
2065 .set_termios = mos7720_set_termios,
2066 .write = mos7720_write,
2067 .write_room = mos7720_write_room,
2068 .chars_in_buffer = mos7720_chars_in_buffer,
2069 .break_ctl = mos7720_break,
2070 .read_bulk_callback = mos7720_bulk_in_callback,
2071 .read_int_callback = mos7720_interrupt_callback,
2074 static struct usb_serial_driver * const serial_drivers[] = {
2075 &moschip7720_2port_driver, NULL
2078 module_usb_serial_driver(serial_drivers, id_table);
2080 MODULE_AUTHOR(DRIVER_AUTHOR);
2081 MODULE_DESCRIPTION(DRIVER_DESC);
2082 MODULE_LICENSE("GPL");