4 * Copyright (C) 1998/1999 R.E.Wolff@BitWizard.nl
6 * written for the SX serial driver.
7 * Contains the code that should be shared over all the serial drivers.
9 * Credit for the idea to do it this way might go to Alan Cox.
12 * Version 0.1 -- December, 1998. Initial version.
13 * Version 0.2 -- March, 1999. Some more routines. Bugfixes. Etc.
14 * Version 0.5 -- August, 1999. Some more fixes. Reformat for Linus.
16 * BitWizard is actively maintaining this file. We sometimes find
17 * that someone submitted changes to this file. We really appreciate
18 * your help, but please submit changes through us. We're doing our
19 * best to be responsive. -- REW
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/tty.h>
25 #include <linux/serial.h>
27 #include <linux/generic_serial.h>
28 #include <linux/interrupt.h>
29 #include <linux/tty_flip.h>
30 #include <linux/delay.h>
31 #include <asm/uaccess.h>
38 #define gs_dprintk(f, str...) if (gs_debug & f) printk (str)
40 #define gs_dprintk(f, str...) /* nothing */
43 #define func_enter() gs_dprintk (GS_DEBUG_FLOW, "gs: enter %s\n", __func__)
44 #define func_exit() gs_dprintk (GS_DEBUG_FLOW, "gs: exit %s\n", __func__)
46 #define RS_EVENT_WRITE_WAKEUP 1
48 module_param(gs_debug, int, 0644);
51 int gs_put_char(struct tty_struct * tty, unsigned char ch)
57 port = tty->driver_data;
61 if (! (port->port.flags & ASYNC_INITIALIZED)) return 0;
63 /* Take a lock on the serial tranmit buffer! */
64 mutex_lock(& port->port_write_mutex);
66 if (port->xmit_cnt >= SERIAL_XMIT_SIZE - 1) {
67 /* Sorry, buffer is full, drop character. Update statistics???? -- REW */
68 mutex_unlock(&port->port_write_mutex);
72 port->xmit_buf[port->xmit_head++] = ch;
73 port->xmit_head &= SERIAL_XMIT_SIZE - 1;
74 port->xmit_cnt++; /* Characters in buffer */
76 mutex_unlock(&port->port_write_mutex);
83 > Problems to take into account are:
84 > -1- Interrupts that empty part of the buffer.
85 > -2- page faults on the access to userspace.
86 > -3- Other processes that are also trying to do a "write".
89 int gs_write(struct tty_struct * tty,
90 const unsigned char *buf, int count)
98 port = tty->driver_data;
102 if (! (port->port.flags & ASYNC_INITIALIZED))
105 /* get exclusive "write" access to this port (problem 3) */
106 /* This is not a spinlock because we can have a disk access (page
107 fault) in copy_from_user */
108 mutex_lock(& port->port_write_mutex);
114 /* This is safe because we "OWN" the "head". Noone else can
115 change the "head": we own the port_write_mutex. */
116 /* Don't overrun the end of the buffer */
117 t = SERIAL_XMIT_SIZE - port->xmit_head;
120 /* This is safe because the xmit_cnt can only decrease. This
121 would increase "t", so we might copy too little chars. */
122 /* Don't copy past the "head" of the buffer */
123 t = SERIAL_XMIT_SIZE - 1 - port->xmit_cnt;
126 /* Can't copy more? break out! */
129 memcpy (port->xmit_buf + port->xmit_head, buf, c);
131 port -> xmit_cnt += c;
132 port -> xmit_head = (port->xmit_head + c) & (SERIAL_XMIT_SIZE -1);
137 mutex_unlock(& port->port_write_mutex);
139 gs_dprintk (GS_DEBUG_WRITE, "write: interrupts are %s\n",
140 (port->port.flags & GS_TX_INTEN)?"enabled": "disabled");
142 if (port->xmit_cnt &&
145 !(port->port.flags & GS_TX_INTEN)) {
146 port->port.flags |= GS_TX_INTEN;
147 port->rd->enable_tx_interrupts (port);
155 int gs_write_room(struct tty_struct * tty)
157 struct gs_port *port = tty->driver_data;
161 ret = SERIAL_XMIT_SIZE - port->xmit_cnt - 1;
169 int gs_chars_in_buffer(struct tty_struct *tty)
171 struct gs_port *port = tty->driver_data;
175 return port->xmit_cnt;
179 static int gs_real_chars_in_buffer(struct tty_struct *tty)
181 struct gs_port *port;
184 port = tty->driver_data;
186 if (!port->rd) return 0;
187 if (!port->rd->chars_in_buffer) return 0;
190 return port->xmit_cnt + port->rd->chars_in_buffer (port);
194 static int gs_wait_tx_flushed (void * ptr, unsigned long timeout)
196 struct gs_port *port = ptr;
197 unsigned long end_jiffies;
198 int jiffies_to_transmit, charsleft = 0, rv = 0;
203 gs_dprintk (GS_DEBUG_FLUSH, "port=%p.\n", port);
205 gs_dprintk (GS_DEBUG_FLUSH, "xmit_cnt=%x, xmit_buf=%p, tty=%p.\n",
206 port->xmit_cnt, port->xmit_buf, port->port.tty);
209 if (!port || port->xmit_cnt < 0 || !port->xmit_buf) {
210 gs_dprintk (GS_DEBUG_FLUSH, "ERROR: !port, !port->xmit_buf or prot->xmit_cnt < 0.\n");
212 return -EINVAL; /* This is an error which we don't know how to handle. */
215 rcib = gs_real_chars_in_buffer(port->port.tty);
218 gs_dprintk (GS_DEBUG_FLUSH, "nothing to wait for.\n");
222 /* stop trying: now + twice the time it would normally take + seconds */
223 if (timeout == 0) timeout = MAX_SCHEDULE_TIMEOUT;
224 end_jiffies = jiffies;
225 if (timeout != MAX_SCHEDULE_TIMEOUT)
226 end_jiffies += port->baud?(2 * rcib * 10 * HZ / port->baud):0;
227 end_jiffies += timeout;
229 gs_dprintk (GS_DEBUG_FLUSH, "now=%lx, end=%lx (%ld).\n",
230 jiffies, end_jiffies, end_jiffies-jiffies);
232 /* the expression is actually jiffies < end_jiffies, but that won't
233 work around the wraparound. Tricky eh? */
234 while ((charsleft = gs_real_chars_in_buffer (port->port.tty)) &&
235 time_after (end_jiffies, jiffies)) {
237 chars * (bits/char) * (jiffies /sec) / (bits/sec) = jiffies!
240 charsleft += 16; /* Allow 16 chars more to be transmitted ... */
241 jiffies_to_transmit = port->baud?(1 + charsleft * 10 * HZ / port->baud):0;
242 /* ^^^ Round up.... */
243 if (jiffies_to_transmit <= 0) jiffies_to_transmit = 1;
245 gs_dprintk (GS_DEBUG_FLUSH, "Expect to finish in %d jiffies "
246 "(%d chars).\n", jiffies_to_transmit, charsleft);
248 msleep_interruptible(jiffies_to_msecs(jiffies_to_transmit));
249 if (signal_pending (current)) {
250 gs_dprintk (GS_DEBUG_FLUSH, "Signal pending. Bombing out: ");
256 gs_dprintk (GS_DEBUG_FLUSH, "charsleft = %d.\n", charsleft);
257 set_current_state (TASK_RUNNING);
265 void gs_flush_buffer(struct tty_struct *tty)
267 struct gs_port *port;
272 port = tty->driver_data;
276 /* XXX Would the write semaphore do? */
277 spin_lock_irqsave (&port->driver_lock, flags);
278 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
279 spin_unlock_irqrestore (&port->driver_lock, flags);
286 void gs_flush_chars(struct tty_struct * tty)
288 struct gs_port *port;
292 port = tty->driver_data;
296 if (port->xmit_cnt <= 0 || tty->stopped || tty->hw_stopped ||
302 /* Beats me -- REW */
303 port->port.flags |= GS_TX_INTEN;
304 port->rd->enable_tx_interrupts (port);
309 void gs_stop(struct tty_struct * tty)
311 struct gs_port *port;
315 port = tty->driver_data;
319 if (port->xmit_cnt &&
321 (port->port.flags & GS_TX_INTEN) ) {
322 port->port.flags &= ~GS_TX_INTEN;
323 port->rd->disable_tx_interrupts (port);
329 void gs_start(struct tty_struct * tty)
331 struct gs_port *port;
333 port = tty->driver_data;
337 if (port->xmit_cnt &&
339 !(port->port.flags & GS_TX_INTEN) ) {
340 port->port.flags |= GS_TX_INTEN;
341 port->rd->enable_tx_interrupts (port);
347 static void gs_shutdown_port (struct gs_port *port)
355 if (!(port->port.flags & ASYNC_INITIALIZED))
358 spin_lock_irqsave(&port->driver_lock, flags);
360 if (port->xmit_buf) {
361 free_page((unsigned long) port->xmit_buf);
362 port->xmit_buf = NULL;
366 set_bit(TTY_IO_ERROR, &port->port.tty->flags);
368 port->rd->shutdown_port (port);
370 port->port.flags &= ~ASYNC_INITIALIZED;
371 spin_unlock_irqrestore(&port->driver_lock, flags);
377 void gs_hangup(struct tty_struct *tty)
379 struct gs_port *port;
384 port = tty->driver_data;
385 tty = port->port.tty;
389 gs_shutdown_port (port);
390 spin_lock_irqsave(&port->port.lock, flags);
391 port->port.flags &= ~(ASYNC_NORMAL_ACTIVE|GS_ACTIVE);
392 port->port.tty = NULL;
393 port->port.count = 0;
394 spin_unlock_irqrestore(&port->port.lock, flags);
396 wake_up_interruptible(&port->port.open_wait);
401 int gs_block_til_ready(void *port_, struct file * filp)
403 struct gs_port *gp = port_;
404 struct tty_port *port = &gp->port;
405 DECLARE_WAITQUEUE(wait, current);
409 struct tty_struct *tty;
418 gs_dprintk (GS_DEBUG_BTR, "Entering gs_block_till_ready.\n");
420 * If the device is in the middle of being closed, then block
421 * until it's done, and then try again.
423 if (tty_hung_up_p(filp) || port->flags & ASYNC_CLOSING) {
424 interruptible_sleep_on(&port->close_wait);
425 if (port->flags & ASYNC_HUP_NOTIFY)
431 gs_dprintk (GS_DEBUG_BTR, "after hung up\n");
434 * If non-blocking mode is set, or the port is not enabled,
435 * then make the check up front and then exit.
437 if ((filp->f_flags & O_NONBLOCK) ||
438 (tty->flags & (1 << TTY_IO_ERROR))) {
439 port->flags |= ASYNC_NORMAL_ACTIVE;
443 gs_dprintk (GS_DEBUG_BTR, "after nonblock\n");
449 * Block waiting for the carrier detect and the line to become
450 * free (i.e., not in use by the callout). While we are in
451 * this loop, port->count is dropped by one, so that
452 * rs_close() knows when to free things. We restore it upon
453 * exit, either normal or abnormal.
457 add_wait_queue(&port->open_wait, &wait);
459 gs_dprintk (GS_DEBUG_BTR, "after add waitq.\n");
460 spin_lock_irqsave(&port->lock, flags);
461 if (!tty_hung_up_p(filp)) {
464 port->blocked_open++;
465 spin_unlock_irqrestore(&port->lock, flags);
467 CD = tty_port_carrier_raised(port);
468 gs_dprintk (GS_DEBUG_BTR, "CD is now %d.\n", CD);
469 set_current_state (TASK_INTERRUPTIBLE);
470 if (tty_hung_up_p(filp) ||
471 !(port->flags & ASYNC_INITIALIZED)) {
472 if (port->flags & ASYNC_HUP_NOTIFY)
475 retval = -ERESTARTSYS;
478 if (!(port->flags & ASYNC_CLOSING) &&
481 gs_dprintk (GS_DEBUG_BTR, "signal_pending is now: %d (%lx)\n",
482 (int)signal_pending (current), *(long*)(¤t->blocked));
483 if (signal_pending(current)) {
484 retval = -ERESTARTSYS;
489 gs_dprintk (GS_DEBUG_BTR, "Got out of the loop. (%d)\n",
491 set_current_state (TASK_RUNNING);
492 remove_wait_queue(&port->open_wait, &wait);
494 spin_lock_irqsave(&port->lock, flags);
495 if (!tty_hung_up_p(filp)) {
498 port->blocked_open--;
500 port->flags |= ASYNC_NORMAL_ACTIVE;
501 spin_unlock_irqrestore(&port->lock, flags);
507 void gs_close(struct tty_struct * tty, struct file * filp)
510 struct gs_port *port;
514 port = tty->driver_data;
518 if (!port->port.tty) {
519 /* This seems to happen when this is called from vhangup. */
520 gs_dprintk (GS_DEBUG_CLOSE, "gs: Odd: port->port.tty is NULL\n");
521 port->port.tty = tty;
524 spin_lock_irqsave(&port->port.lock, flags);
526 if (tty_hung_up_p(filp)) {
527 spin_unlock_irqrestore(&port->port.lock, flags);
528 if (port->rd->hungup)
529 port->rd->hungup (port);
534 if ((tty->count == 1) && (port->port.count != 1)) {
535 printk(KERN_ERR "gs: gs_close port %p: bad port count;"
536 " tty->count is 1, port count is %d\n", port, port->port.count);
537 port->port.count = 1;
539 if (--port->port.count < 0) {
540 printk(KERN_ERR "gs: gs_close port %p: bad port count: %d\n", port, port->port.count);
541 port->port.count = 0;
544 if (port->port.count) {
545 gs_dprintk(GS_DEBUG_CLOSE, "gs_close port %p: count: %d\n", port, port->port.count);
546 spin_unlock_irqrestore(&port->port.lock, flags);
550 port->port.flags |= ASYNC_CLOSING;
553 * Now we wait for the transmit buffer to clear; and we notify
554 * the line discipline to only process XON/XOFF characters.
557 /* if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
558 tty_wait_until_sent(tty, port->closing_wait); */
561 * At this point we stop accepting input. To do this, we
562 * disable the receive line status interrupts, and tell the
563 * interrupt driver to stop checking the data ready bit in the
564 * line status register.
567 spin_lock_irqsave(&port->driver_lock, flags);
568 port->rd->disable_rx_interrupts (port);
569 spin_unlock_irqrestore(&port->driver_lock, flags);
570 spin_unlock_irqrestore(&port->port.lock, flags);
572 /* close has no way of returning "EINTR", so discard return value */
573 if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
574 gs_wait_tx_flushed (port, port->closing_wait);
576 port->port.flags &= ~GS_ACTIVE;
578 gs_flush_buffer(tty);
580 tty_ldisc_flush(tty);
583 spin_lock_irqsave(&port->driver_lock, flags);
585 port->rd->close (port);
586 port->rd->shutdown_port (port);
587 spin_unlock_irqrestore(&port->driver_lock, flags);
589 spin_lock_irqsave(&port->port.lock, flags);
590 port->port.tty = NULL;
592 if (port->port.blocked_open) {
593 if (port->close_delay) {
594 spin_unlock_irqrestore(&port->port.lock, flags);
595 msleep_interruptible(jiffies_to_msecs(port->close_delay));
596 spin_lock_irqsave(&port->port.lock, flags);
598 wake_up_interruptible(&port->port.open_wait);
600 port->port.flags &= ~(ASYNC_NORMAL_ACTIVE|ASYNC_CLOSING | ASYNC_INITIALIZED);
601 spin_unlock_irqrestore(&port->port.lock, flags);
602 wake_up_interruptible(&port->port.close_wait);
608 void gs_set_termios (struct tty_struct * tty,
609 struct ktermios * old_termios)
611 struct gs_port *port;
612 int baudrate, tmp, rv;
613 struct ktermios *tiosp;
617 port = tty->driver_data;
620 if (!port->port.tty) {
621 /* This seems to happen when this is called after gs_close. */
622 gs_dprintk (GS_DEBUG_TERMIOS, "gs: Odd: port->port.tty is NULL\n");
623 port->port.tty = tty;
627 tiosp = tty->termios;
629 if (gs_debug & GS_DEBUG_TERMIOS) {
630 gs_dprintk (GS_DEBUG_TERMIOS, "termios structure (%p):\n", tiosp);
633 if(old_termios && (gs_debug & GS_DEBUG_TERMIOS)) {
634 if(tiosp->c_iflag != old_termios->c_iflag) printk("c_iflag changed\n");
635 if(tiosp->c_oflag != old_termios->c_oflag) printk("c_oflag changed\n");
636 if(tiosp->c_cflag != old_termios->c_cflag) printk("c_cflag changed\n");
637 if(tiosp->c_lflag != old_termios->c_lflag) printk("c_lflag changed\n");
638 if(tiosp->c_line != old_termios->c_line) printk("c_line changed\n");
639 if(!memcmp(tiosp->c_cc, old_termios->c_cc, NCC)) printk("c_cc changed\n");
642 baudrate = tty_get_baud_rate(tty);
644 if ((tiosp->c_cflag & CBAUD) == B38400) {
645 if ( (port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
647 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
649 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
651 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
653 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST)
654 baudrate = (port->baud_base / port->custom_divisor);
657 /* I recommend using THIS instead of the mess in termios (and
658 duplicating the above code). Next we should create a clean
659 interface towards this variable. If your card supports arbitrary
660 baud rates, (e.g. CD1400 or 16550 based cards) then everything
661 will be very easy..... */
662 port->baud = baudrate;
664 /* Two timer ticks seems enough to wakeup something like SLIP driver */
665 /* Baudrate/10 is cps. Divide by HZ to get chars per tick. */
666 tmp = (baudrate / 10 / HZ) * 2;
668 if (tmp < 0) tmp = 0;
669 if (tmp >= SERIAL_XMIT_SIZE) tmp = SERIAL_XMIT_SIZE-1;
671 port->wakeup_chars = tmp;
673 /* We should really wait for the characters to be all sent before
674 changing the settings. -- CAL */
675 rv = gs_wait_tx_flushed (port, MAX_SCHEDULE_TIMEOUT);
676 if (rv < 0) return /* rv */;
678 rv = port->rd->set_real_termios(port);
679 if (rv < 0) return /* rv */;
682 (old_termios->c_cflag & CRTSCTS)) &&
683 !( tiosp->c_cflag & CRTSCTS)) {
688 #ifdef tytso_patch_94Nov25_1726
689 /* This "makes sense", Why is it commented out? */
691 if (!(old_termios->c_cflag & CLOCAL) &&
692 (tty->termios->c_cflag & CLOCAL))
693 wake_up_interruptible(&port->gs.open_wait);
702 /* Must be called with interrupts enabled */
703 int gs_init_port(struct gs_port *port)
709 if (port->port.flags & ASYNC_INITIALIZED) {
713 if (!port->xmit_buf) {
714 /* We may sleep in get_zeroed_page() */
717 tmp = get_zeroed_page(GFP_KERNEL);
718 spin_lock_irqsave (&port->driver_lock, flags);
722 port->xmit_buf = (unsigned char *) tmp;
723 spin_unlock_irqrestore(&port->driver_lock, flags);
724 if (!port->xmit_buf) {
730 spin_lock_irqsave (&port->driver_lock, flags);
732 clear_bit(TTY_IO_ERROR, &port->port.tty->flags);
733 mutex_init(&port->port_write_mutex);
734 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
735 spin_unlock_irqrestore(&port->driver_lock, flags);
736 gs_set_termios(port->port.tty, NULL);
737 spin_lock_irqsave (&port->driver_lock, flags);
738 port->port.flags |= ASYNC_INITIALIZED;
739 port->port.flags &= ~GS_TX_INTEN;
741 spin_unlock_irqrestore(&port->driver_lock, flags);
747 int gs_setserial(struct gs_port *port, struct serial_struct __user *sp)
749 struct serial_struct sio;
751 if (copy_from_user(&sio, sp, sizeof(struct serial_struct)))
754 if (!capable(CAP_SYS_ADMIN)) {
755 if ((sio.baud_base != port->baud_base) ||
756 (sio.close_delay != port->close_delay) ||
757 ((sio.flags & ~ASYNC_USR_MASK) !=
758 (port->port.flags & ~ASYNC_USR_MASK)))
762 port->port.flags = (port->port.flags & ~ASYNC_USR_MASK) |
763 (sio.flags & ASYNC_USR_MASK);
765 port->baud_base = sio.baud_base;
766 port->close_delay = sio.close_delay;
767 port->closing_wait = sio.closing_wait;
768 port->custom_divisor = sio.custom_divisor;
770 gs_set_termios (port->port.tty, NULL);
776 /*****************************************************************************/
779 * Generate the serial struct info.
782 int gs_getserial(struct gs_port *port, struct serial_struct __user *sp)
784 struct serial_struct sio;
786 memset(&sio, 0, sizeof(struct serial_struct));
787 sio.flags = port->port.flags;
788 sio.baud_base = port->baud_base;
789 sio.close_delay = port->close_delay;
790 sio.closing_wait = port->closing_wait;
791 sio.custom_divisor = port->custom_divisor;
794 /* If you want you can override these. */
795 sio.type = PORT_UNKNOWN;
796 sio.xmit_fifo_size = -1;
801 if (port->rd->getserial)
802 port->rd->getserial (port, &sio);
804 if (copy_to_user(sp, &sio, sizeof(struct serial_struct)))
811 void gs_got_break(struct gs_port *port)
815 tty_insert_flip_char(port->port.tty, 0, TTY_BREAK);
816 tty_schedule_flip(port->port.tty);
817 if (port->port.flags & ASYNC_SAK) {
818 do_SAK (port->port.tty);
825 EXPORT_SYMBOL(gs_put_char);
826 EXPORT_SYMBOL(gs_write);
827 EXPORT_SYMBOL(gs_write_room);
828 EXPORT_SYMBOL(gs_chars_in_buffer);
829 EXPORT_SYMBOL(gs_flush_buffer);
830 EXPORT_SYMBOL(gs_flush_chars);
831 EXPORT_SYMBOL(gs_stop);
832 EXPORT_SYMBOL(gs_start);
833 EXPORT_SYMBOL(gs_hangup);
834 EXPORT_SYMBOL(gs_block_til_ready);
835 EXPORT_SYMBOL(gs_close);
836 EXPORT_SYMBOL(gs_set_termios);
837 EXPORT_SYMBOL(gs_init_port);
838 EXPORT_SYMBOL(gs_setserial);
839 EXPORT_SYMBOL(gs_getserial);
840 EXPORT_SYMBOL(gs_got_break);
842 MODULE_LICENSE("GPL");