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;
383 port = tty->driver_data;
384 tty = port->port.tty;
388 gs_shutdown_port (port);
389 port->port.flags &= ~(ASYNC_NORMAL_ACTIVE|GS_ACTIVE);
390 port->port.tty = NULL;
391 port->port.count = 0;
393 wake_up_interruptible(&port->port.open_wait);
398 int gs_block_til_ready(void *port_, struct file * filp)
400 struct gs_port *port = port_;
401 DECLARE_WAITQUEUE(wait, current);
405 struct tty_struct *tty;
412 tty = port->port.tty;
414 gs_dprintk (GS_DEBUG_BTR, "Entering gs_block_till_ready.\n");
416 * If the device is in the middle of being closed, then block
417 * until it's done, and then try again.
419 if (tty_hung_up_p(filp) || port->port.flags & ASYNC_CLOSING) {
420 interruptible_sleep_on(&port->port.close_wait);
421 if (port->port.flags & ASYNC_HUP_NOTIFY)
427 gs_dprintk (GS_DEBUG_BTR, "after hung up\n");
430 * If non-blocking mode is set, or the port is not enabled,
431 * then make the check up front and then exit.
433 if ((filp->f_flags & O_NONBLOCK) ||
434 (tty->flags & (1 << TTY_IO_ERROR))) {
435 port->port.flags |= ASYNC_NORMAL_ACTIVE;
439 gs_dprintk (GS_DEBUG_BTR, "after nonblock\n");
445 * Block waiting for the carrier detect and the line to become
446 * free (i.e., not in use by the callout). While we are in
447 * this loop, port->port.count is dropped by one, so that
448 * rs_close() knows when to free things. We restore it upon
449 * exit, either normal or abnormal.
453 add_wait_queue(&port->port.open_wait, &wait);
455 gs_dprintk (GS_DEBUG_BTR, "after add waitq.\n");
456 spin_lock_irqsave(&port->driver_lock, flags);
457 if (!tty_hung_up_p(filp)) {
460 spin_unlock_irqrestore(&port->driver_lock, flags);
461 port->port.blocked_open++;
463 CD = port->rd->get_CD (port);
464 gs_dprintk (GS_DEBUG_BTR, "CD is now %d.\n", CD);
465 set_current_state (TASK_INTERRUPTIBLE);
466 if (tty_hung_up_p(filp) ||
467 !(port->port.flags & ASYNC_INITIALIZED)) {
468 if (port->port.flags & ASYNC_HUP_NOTIFY)
471 retval = -ERESTARTSYS;
474 if (!(port->port.flags & ASYNC_CLOSING) &&
477 gs_dprintk (GS_DEBUG_BTR, "signal_pending is now: %d (%lx)\n",
478 (int)signal_pending (current), *(long*)(¤t->blocked));
479 if (signal_pending(current)) {
480 retval = -ERESTARTSYS;
485 gs_dprintk (GS_DEBUG_BTR, "Got out of the loop. (%d)\n",
486 port->port.blocked_open);
487 set_current_state (TASK_RUNNING);
488 remove_wait_queue(&port->port.open_wait, &wait);
489 if (!tty_hung_up_p(filp)) {
492 port->port.blocked_open--;
496 port->port.flags |= ASYNC_NORMAL_ACTIVE;
502 void gs_close(struct tty_struct * tty, struct file * filp)
505 struct gs_port *port;
509 port = (struct gs_port *) tty->driver_data;
513 if (!port->port.tty) {
514 /* This seems to happen when this is called from vhangup. */
515 gs_dprintk (GS_DEBUG_CLOSE, "gs: Odd: port->port.tty is NULL\n");
516 port->port.tty = tty;
519 spin_lock_irqsave(&port->driver_lock, flags);
521 if (tty_hung_up_p(filp)) {
522 spin_unlock_irqrestore(&port->driver_lock, flags);
523 if (port->rd->hungup)
524 port->rd->hungup (port);
529 if ((tty->count == 1) && (port->port.count != 1)) {
530 printk(KERN_ERR "gs: gs_close port %p: bad port count;"
531 " tty->count is 1, port count is %d\n", port, port->port.count);
532 port->port.count = 1;
534 if (--port->port.count < 0) {
535 printk(KERN_ERR "gs: gs_close port %p: bad port count: %d\n", port, port->port.count);
536 port->port.count = 0;
539 if (port->port.count) {
540 gs_dprintk(GS_DEBUG_CLOSE, "gs_close port %p: count: %d\n", port, port->port.count);
541 spin_unlock_irqrestore(&port->driver_lock, flags);
545 port->port.flags |= ASYNC_CLOSING;
548 * Now we wait for the transmit buffer to clear; and we notify
549 * the line discipline to only process XON/XOFF characters.
552 /* if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
553 tty_wait_until_sent(tty, port->closing_wait); */
556 * At this point we stop accepting input. To do this, we
557 * disable the receive line status interrupts, and tell the
558 * interrupt driver to stop checking the data ready bit in the
559 * line status register.
562 port->rd->disable_rx_interrupts (port);
563 spin_unlock_irqrestore(&port->driver_lock, flags);
565 /* close has no way of returning "EINTR", so discard return value */
566 if (port->closing_wait != ASYNC_CLOSING_WAIT_NONE)
567 gs_wait_tx_flushed (port, port->closing_wait);
569 port->port.flags &= ~GS_ACTIVE;
571 gs_flush_buffer(tty);
573 tty_ldisc_flush(tty);
577 port->rd->close (port);
578 port->rd->shutdown_port (port);
579 port->port.tty = NULL;
581 if (port->port.blocked_open) {
582 if (port->close_delay) {
583 spin_unlock_irqrestore(&port->driver_lock, flags);
584 msleep_interruptible(jiffies_to_msecs(port->close_delay));
585 spin_lock_irqsave(&port->driver_lock, flags);
587 wake_up_interruptible(&port->port.open_wait);
589 port->port.flags &= ~(ASYNC_NORMAL_ACTIVE|ASYNC_CLOSING | ASYNC_INITIALIZED);
590 wake_up_interruptible(&port->port.close_wait);
596 void gs_set_termios (struct tty_struct * tty,
597 struct ktermios * old_termios)
599 struct gs_port *port;
600 int baudrate, tmp, rv;
601 struct ktermios *tiosp;
605 port = tty->driver_data;
608 if (!port->port.tty) {
609 /* This seems to happen when this is called after gs_close. */
610 gs_dprintk (GS_DEBUG_TERMIOS, "gs: Odd: port->port.tty is NULL\n");
611 port->port.tty = tty;
615 tiosp = tty->termios;
617 if (gs_debug & GS_DEBUG_TERMIOS) {
618 gs_dprintk (GS_DEBUG_TERMIOS, "termios structure (%p):\n", tiosp);
621 if(old_termios && (gs_debug & GS_DEBUG_TERMIOS)) {
622 if(tiosp->c_iflag != old_termios->c_iflag) printk("c_iflag changed\n");
623 if(tiosp->c_oflag != old_termios->c_oflag) printk("c_oflag changed\n");
624 if(tiosp->c_cflag != old_termios->c_cflag) printk("c_cflag changed\n");
625 if(tiosp->c_lflag != old_termios->c_lflag) printk("c_lflag changed\n");
626 if(tiosp->c_line != old_termios->c_line) printk("c_line changed\n");
627 if(!memcmp(tiosp->c_cc, old_termios->c_cc, NCC)) printk("c_cc changed\n");
630 baudrate = tty_get_baud_rate(tty);
632 if ((tiosp->c_cflag & CBAUD) == B38400) {
633 if ( (port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
635 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
637 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
639 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
641 else if ((port->port.flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST)
642 baudrate = (port->baud_base / port->custom_divisor);
645 /* I recommend using THIS instead of the mess in termios (and
646 duplicating the above code). Next we should create a clean
647 interface towards this variable. If your card supports arbitrary
648 baud rates, (e.g. CD1400 or 16550 based cards) then everything
649 will be very easy..... */
650 port->baud = baudrate;
652 /* Two timer ticks seems enough to wakeup something like SLIP driver */
653 /* Baudrate/10 is cps. Divide by HZ to get chars per tick. */
654 tmp = (baudrate / 10 / HZ) * 2;
656 if (tmp < 0) tmp = 0;
657 if (tmp >= SERIAL_XMIT_SIZE) tmp = SERIAL_XMIT_SIZE-1;
659 port->wakeup_chars = tmp;
661 /* We should really wait for the characters to be all sent before
662 changing the settings. -- CAL */
663 rv = gs_wait_tx_flushed (port, MAX_SCHEDULE_TIMEOUT);
664 if (rv < 0) return /* rv */;
666 rv = port->rd->set_real_termios(port);
667 if (rv < 0) return /* rv */;
670 (old_termios->c_cflag & CRTSCTS)) &&
671 !( tiosp->c_cflag & CRTSCTS)) {
676 #ifdef tytso_patch_94Nov25_1726
677 /* This "makes sense", Why is it commented out? */
679 if (!(old_termios->c_cflag & CLOCAL) &&
680 (tty->termios->c_cflag & CLOCAL))
681 wake_up_interruptible(&port->gs.open_wait);
690 /* Must be called with interrupts enabled */
691 int gs_init_port(struct gs_port *port)
697 if (port->port.flags & ASYNC_INITIALIZED) {
701 if (!port->xmit_buf) {
702 /* We may sleep in get_zeroed_page() */
705 tmp = get_zeroed_page(GFP_KERNEL);
706 spin_lock_irqsave (&port->driver_lock, flags);
710 port->xmit_buf = (unsigned char *) tmp;
711 spin_unlock_irqrestore(&port->driver_lock, flags);
712 if (!port->xmit_buf) {
718 spin_lock_irqsave (&port->driver_lock, flags);
720 clear_bit(TTY_IO_ERROR, &port->port.tty->flags);
721 mutex_init(&port->port_write_mutex);
722 port->xmit_cnt = port->xmit_head = port->xmit_tail = 0;
723 spin_unlock_irqrestore(&port->driver_lock, flags);
724 gs_set_termios(port->port.tty, NULL);
725 spin_lock_irqsave (&port->driver_lock, flags);
726 port->port.flags |= ASYNC_INITIALIZED;
727 port->port.flags &= ~GS_TX_INTEN;
729 spin_unlock_irqrestore(&port->driver_lock, flags);
735 int gs_setserial(struct gs_port *port, struct serial_struct __user *sp)
737 struct serial_struct sio;
739 if (copy_from_user(&sio, sp, sizeof(struct serial_struct)))
742 if (!capable(CAP_SYS_ADMIN)) {
743 if ((sio.baud_base != port->baud_base) ||
744 (sio.close_delay != port->close_delay) ||
745 ((sio.flags & ~ASYNC_USR_MASK) !=
746 (port->port.flags & ~ASYNC_USR_MASK)))
750 port->port.flags = (port->port.flags & ~ASYNC_USR_MASK) |
751 (sio.flags & ASYNC_USR_MASK);
753 port->baud_base = sio.baud_base;
754 port->close_delay = sio.close_delay;
755 port->closing_wait = sio.closing_wait;
756 port->custom_divisor = sio.custom_divisor;
758 gs_set_termios (port->port.tty, NULL);
764 /*****************************************************************************/
767 * Generate the serial struct info.
770 int gs_getserial(struct gs_port *port, struct serial_struct __user *sp)
772 struct serial_struct sio;
774 memset(&sio, 0, sizeof(struct serial_struct));
775 sio.flags = port->port.flags;
776 sio.baud_base = port->baud_base;
777 sio.close_delay = port->close_delay;
778 sio.closing_wait = port->closing_wait;
779 sio.custom_divisor = port->custom_divisor;
782 /* If you want you can override these. */
783 sio.type = PORT_UNKNOWN;
784 sio.xmit_fifo_size = -1;
789 if (port->rd->getserial)
790 port->rd->getserial (port, &sio);
792 if (copy_to_user(sp, &sio, sizeof(struct serial_struct)))
799 void gs_got_break(struct gs_port *port)
803 tty_insert_flip_char(port->port.tty, 0, TTY_BREAK);
804 tty_schedule_flip(port->port.tty);
805 if (port->port.flags & ASYNC_SAK) {
806 do_SAK (port->port.tty);
813 EXPORT_SYMBOL(gs_put_char);
814 EXPORT_SYMBOL(gs_write);
815 EXPORT_SYMBOL(gs_write_room);
816 EXPORT_SYMBOL(gs_chars_in_buffer);
817 EXPORT_SYMBOL(gs_flush_buffer);
818 EXPORT_SYMBOL(gs_flush_chars);
819 EXPORT_SYMBOL(gs_stop);
820 EXPORT_SYMBOL(gs_start);
821 EXPORT_SYMBOL(gs_hangup);
822 EXPORT_SYMBOL(gs_block_til_ready);
823 EXPORT_SYMBOL(gs_close);
824 EXPORT_SYMBOL(gs_set_termios);
825 EXPORT_SYMBOL(gs_init_port);
826 EXPORT_SYMBOL(gs_setserial);
827 EXPORT_SYMBOL(gs_getserial);
828 EXPORT_SYMBOL(gs_got_break);
830 MODULE_LICENSE("GPL");