2 * linux/drivers/char/core.c
4 * Driver core for serial ports
6 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
8 * Copyright 1999 ARM Limited
9 * Copyright (C) 2000-2001 Deep Blue Solutions Ltd.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/module.h>
26 #include <linux/tty.h>
27 #include <linux/slab.h>
28 #include <linux/init.h>
29 #include <linux/console.h>
30 #include <linux/serial_core.h>
31 #include <linux/smp_lock.h>
32 #include <linux/device.h>
33 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
34 #include <linux/delay.h>
35 #include <linux/mutex.h>
38 #include <asm/uaccess.h>
41 * This is used to lock changes in serial line configuration.
43 static DEFINE_MUTEX(port_mutex);
46 * lockdep: port->lock is initialized in two places, but we
47 * want only one lock-class:
49 static struct lock_class_key port_lock_key;
51 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
53 #define uart_users(state) ((state)->count + ((state)->info ? (state)->info->blocked_open : 0))
55 #ifdef CONFIG_SERIAL_CORE_CONSOLE
56 #define uart_console(port) ((port)->cons && (port)->cons->index == (port)->line)
58 #define uart_console(port) (0)
61 static void uart_change_speed(struct uart_state *state,
62 struct ktermios *old_termios);
63 static void uart_wait_until_sent(struct tty_struct *tty, int timeout);
64 static void uart_change_pm(struct uart_state *state, int pm_state);
67 * This routine is used by the interrupt handler to schedule processing in
68 * the software interrupt portion of the driver.
70 void uart_write_wakeup(struct uart_port *port)
72 struct uart_info *info = port->info;
74 * This means you called this function _after_ the port was
75 * closed. No cookie for you.
78 tasklet_schedule(&info->tlet);
81 static void uart_stop(struct tty_struct *tty)
83 struct uart_state *state = tty->driver_data;
84 struct uart_port *port = state->port;
87 spin_lock_irqsave(&port->lock, flags);
88 port->ops->stop_tx(port);
89 spin_unlock_irqrestore(&port->lock, flags);
92 static void __uart_start(struct tty_struct *tty)
94 struct uart_state *state = tty->driver_data;
95 struct uart_port *port = state->port;
97 if (!uart_circ_empty(&state->info->xmit) && state->info->xmit.buf &&
98 !tty->stopped && !tty->hw_stopped)
99 port->ops->start_tx(port);
102 static void uart_start(struct tty_struct *tty)
104 struct uart_state *state = tty->driver_data;
105 struct uart_port *port = state->port;
108 spin_lock_irqsave(&port->lock, flags);
110 spin_unlock_irqrestore(&port->lock, flags);
113 static void uart_tasklet_action(unsigned long data)
115 struct uart_state *state = (struct uart_state *)data;
116 tty_wakeup(state->info->tty);
120 uart_update_mctrl(struct uart_port *port, unsigned int set, unsigned int clear)
125 spin_lock_irqsave(&port->lock, flags);
127 port->mctrl = (old & ~clear) | set;
128 if (old != port->mctrl)
129 port->ops->set_mctrl(port, port->mctrl);
130 spin_unlock_irqrestore(&port->lock, flags);
133 #define uart_set_mctrl(port, set) uart_update_mctrl(port, set, 0)
134 #define uart_clear_mctrl(port, clear) uart_update_mctrl(port, 0, clear)
137 * Startup the port. This will be called once per open. All calls
138 * will be serialised by the per-port semaphore.
140 static int uart_startup(struct uart_state *state, int init_hw)
142 struct uart_info *info = state->info;
143 struct uart_port *port = state->port;
147 if (info->flags & UIF_INITIALIZED)
151 * Set the TTY IO error marker - we will only clear this
152 * once we have successfully opened the port. Also set
153 * up the tty->alt_speed kludge
155 set_bit(TTY_IO_ERROR, &info->tty->flags);
157 if (port->type == PORT_UNKNOWN)
161 * Initialise and allocate the transmit and temporary
164 if (!info->xmit.buf) {
165 page = get_zeroed_page(GFP_KERNEL);
169 info->xmit.buf = (unsigned char *) page;
170 uart_circ_clear(&info->xmit);
173 retval = port->ops->startup(port);
177 * Initialise the hardware port settings.
179 uart_change_speed(state, NULL);
182 * Setup the RTS and DTR signals once the
183 * port is open and ready to respond.
185 if (info->tty->termios->c_cflag & CBAUD)
186 uart_set_mctrl(port, TIOCM_RTS | TIOCM_DTR);
189 if (info->flags & UIF_CTS_FLOW) {
190 spin_lock_irq(&port->lock);
191 if (!(port->ops->get_mctrl(port) & TIOCM_CTS))
192 info->tty->hw_stopped = 1;
193 spin_unlock_irq(&port->lock);
196 info->flags |= UIF_INITIALIZED;
198 clear_bit(TTY_IO_ERROR, &info->tty->flags);
201 if (retval && capable(CAP_SYS_ADMIN))
208 * This routine will shutdown a serial port; interrupts are disabled, and
209 * DTR is dropped if the hangup on close termio flag is on. Calls to
210 * uart_shutdown are serialised by the per-port semaphore.
212 static void uart_shutdown(struct uart_state *state)
214 struct uart_info *info = state->info;
215 struct uart_port *port = state->port;
218 * Set the TTY IO error marker
221 set_bit(TTY_IO_ERROR, &info->tty->flags);
223 if (info->flags & UIF_INITIALIZED) {
224 info->flags &= ~UIF_INITIALIZED;
227 * Turn off DTR and RTS early.
229 if (!info->tty || (info->tty->termios->c_cflag & HUPCL))
230 uart_clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
233 * clear delta_msr_wait queue to avoid mem leaks: we may free
234 * the irq here so the queue might never be woken up. Note
235 * that we won't end up waiting on delta_msr_wait again since
236 * any outstanding file descriptors should be pointing at
237 * hung_up_tty_fops now.
239 wake_up_interruptible(&info->delta_msr_wait);
242 * Free the IRQ and disable the port.
244 port->ops->shutdown(port);
247 * Ensure that the IRQ handler isn't running on another CPU.
249 synchronize_irq(port->irq);
253 * kill off our tasklet
255 tasklet_kill(&info->tlet);
258 * Free the transmit buffer page.
260 if (info->xmit.buf) {
261 free_page((unsigned long)info->xmit.buf);
262 info->xmit.buf = NULL;
267 * uart_update_timeout - update per-port FIFO timeout.
268 * @port: uart_port structure describing the port
269 * @cflag: termios cflag value
270 * @baud: speed of the port
272 * Set the port FIFO timeout value. The @cflag value should
273 * reflect the actual hardware settings.
276 uart_update_timeout(struct uart_port *port, unsigned int cflag,
281 /* byte size and parity */
282 switch (cflag & CSIZE) {
303 * The total number of bits to be transmitted in the fifo.
305 bits = bits * port->fifosize;
308 * Figure the timeout to send the above number of bits.
309 * Add .02 seconds of slop
311 port->timeout = (HZ * bits) / baud + HZ/50;
314 EXPORT_SYMBOL(uart_update_timeout);
317 * uart_get_baud_rate - return baud rate for a particular port
318 * @port: uart_port structure describing the port in question.
319 * @termios: desired termios settings.
320 * @old: old termios (or NULL)
321 * @min: minimum acceptable baud rate
322 * @max: maximum acceptable baud rate
324 * Decode the termios structure into a numeric baud rate,
325 * taking account of the magic 38400 baud rate (with spd_*
326 * flags), and mapping the %B0 rate to 9600 baud.
328 * If the new baud rate is invalid, try the old termios setting.
329 * If it's still invalid, we try 9600 baud.
331 * Update the @termios structure to reflect the baud rate
332 * we're actually going to be using. Don't do this for the case
333 * where B0 is requested ("hang up").
336 uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
337 struct ktermios *old, unsigned int min, unsigned int max)
339 unsigned int try, baud, altbaud = 38400;
341 upf_t flags = port->flags & UPF_SPD_MASK;
343 if (flags == UPF_SPD_HI)
345 if (flags == UPF_SPD_VHI)
347 if (flags == UPF_SPD_SHI)
349 if (flags == UPF_SPD_WARP)
352 for (try = 0; try < 2; try++) {
353 baud = tty_termios_baud_rate(termios);
356 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
363 * Special case: B0 rate.
370 if (baud >= min && baud <= max)
374 * Oops, the quotient was zero. Try again with
375 * the old baud rate if possible.
377 termios->c_cflag &= ~CBAUD;
379 baud = tty_termios_baud_rate(old);
381 tty_termios_encode_baud_rate(termios,
388 * As a last resort, if the quotient is zero,
389 * default to 9600 bps
392 tty_termios_encode_baud_rate(termios, 9600, 9600);
398 EXPORT_SYMBOL(uart_get_baud_rate);
401 * uart_get_divisor - return uart clock divisor
402 * @port: uart_port structure describing the port.
403 * @baud: desired baud rate
405 * Calculate the uart clock divisor for the port.
408 uart_get_divisor(struct uart_port *port, unsigned int baud)
413 * Old custom speed handling.
415 if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
416 quot = port->custom_divisor;
418 quot = (port->uartclk + (8 * baud)) / (16 * baud);
423 EXPORT_SYMBOL(uart_get_divisor);
425 /* FIXME: Consistent locking policy */
427 uart_change_speed(struct uart_state *state, struct ktermios *old_termios)
429 struct tty_struct *tty = state->info->tty;
430 struct uart_port *port = state->port;
431 struct ktermios *termios;
434 * If we have no tty, termios, or the port does not exist,
435 * then we can't set the parameters for this port.
437 if (!tty || !tty->termios || port->type == PORT_UNKNOWN)
440 termios = tty->termios;
443 * Set flags based on termios cflag
445 if (termios->c_cflag & CRTSCTS)
446 state->info->flags |= UIF_CTS_FLOW;
448 state->info->flags &= ~UIF_CTS_FLOW;
450 if (termios->c_cflag & CLOCAL)
451 state->info->flags &= ~UIF_CHECK_CD;
453 state->info->flags |= UIF_CHECK_CD;
455 port->ops->set_termios(port, termios, old_termios);
459 __uart_put_char(struct uart_port *port, struct circ_buf *circ, unsigned char c)
467 spin_lock_irqsave(&port->lock, flags);
468 if (uart_circ_chars_free(circ) != 0) {
469 circ->buf[circ->head] = c;
470 circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
473 spin_unlock_irqrestore(&port->lock, flags);
477 static int uart_put_char(struct tty_struct *tty, unsigned char ch)
479 struct uart_state *state = tty->driver_data;
481 return __uart_put_char(state->port, &state->info->xmit, ch);
484 static void uart_flush_chars(struct tty_struct *tty)
490 uart_write(struct tty_struct *tty, const unsigned char *buf, int count)
492 struct uart_state *state = tty->driver_data;
493 struct uart_port *port;
494 struct circ_buf *circ;
499 * This means you called this function _after_ the port was
500 * closed. No cookie for you.
502 if (!state || !state->info) {
508 circ = &state->info->xmit;
513 spin_lock_irqsave(&port->lock, flags);
515 c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
520 memcpy(circ->buf + circ->head, buf, c);
521 circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
526 spin_unlock_irqrestore(&port->lock, flags);
532 static int uart_write_room(struct tty_struct *tty)
534 struct uart_state *state = tty->driver_data;
538 spin_lock_irqsave(&state->port->lock, flags);
539 ret = uart_circ_chars_free(&state->info->xmit);
540 spin_unlock_irqrestore(&state->port->lock, flags);
544 static int uart_chars_in_buffer(struct tty_struct *tty)
546 struct uart_state *state = tty->driver_data;
550 spin_lock_irqsave(&state->port->lock, flags);
551 ret = uart_circ_chars_pending(&state->info->xmit);
552 spin_unlock_irqrestore(&state->port->lock, flags);
556 static void uart_flush_buffer(struct tty_struct *tty)
558 struct uart_state *state = tty->driver_data;
559 struct uart_port *port = state->port;
563 * This means you called this function _after_ the port was
564 * closed. No cookie for you.
566 if (!state || !state->info) {
571 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
573 spin_lock_irqsave(&port->lock, flags);
574 uart_circ_clear(&state->info->xmit);
575 spin_unlock_irqrestore(&port->lock, flags);
580 * This function is used to send a high-priority XON/XOFF character to
583 static void uart_send_xchar(struct tty_struct *tty, char ch)
585 struct uart_state *state = tty->driver_data;
586 struct uart_port *port = state->port;
589 if (port->ops->send_xchar)
590 port->ops->send_xchar(port, ch);
594 spin_lock_irqsave(&port->lock, flags);
595 port->ops->start_tx(port);
596 spin_unlock_irqrestore(&port->lock, flags);
601 static void uart_throttle(struct tty_struct *tty)
603 struct uart_state *state = tty->driver_data;
606 uart_send_xchar(tty, STOP_CHAR(tty));
608 if (tty->termios->c_cflag & CRTSCTS)
609 uart_clear_mctrl(state->port, TIOCM_RTS);
612 static void uart_unthrottle(struct tty_struct *tty)
614 struct uart_state *state = tty->driver_data;
615 struct uart_port *port = state->port;
621 uart_send_xchar(tty, START_CHAR(tty));
624 if (tty->termios->c_cflag & CRTSCTS)
625 uart_set_mctrl(port, TIOCM_RTS);
628 static int uart_get_info(struct uart_state *state,
629 struct serial_struct __user *retinfo)
631 struct uart_port *port = state->port;
632 struct serial_struct tmp;
634 memset(&tmp, 0, sizeof(tmp));
636 /* Ensure the state we copy is consistent and no hardware changes
638 mutex_lock(&state->mutex);
640 tmp.type = port->type;
641 tmp.line = port->line;
642 tmp.port = port->iobase;
643 if (HIGH_BITS_OFFSET)
644 tmp.port_high = (long) port->iobase >> HIGH_BITS_OFFSET;
646 tmp.flags = port->flags;
647 tmp.xmit_fifo_size = port->fifosize;
648 tmp.baud_base = port->uartclk / 16;
649 tmp.close_delay = state->close_delay / 10;
650 tmp.closing_wait = state->closing_wait == USF_CLOSING_WAIT_NONE ?
651 ASYNC_CLOSING_WAIT_NONE :
652 state->closing_wait / 10;
653 tmp.custom_divisor = port->custom_divisor;
654 tmp.hub6 = port->hub6;
655 tmp.io_type = port->iotype;
656 tmp.iomem_reg_shift = port->regshift;
657 tmp.iomem_base = (void *)(unsigned long)port->mapbase;
659 mutex_unlock(&state->mutex);
661 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
666 static int uart_set_info(struct uart_state *state,
667 struct serial_struct __user *newinfo)
669 struct serial_struct new_serial;
670 struct uart_port *port = state->port;
671 unsigned long new_port;
672 unsigned int change_irq, change_port, closing_wait;
673 unsigned int old_custom_divisor, close_delay;
674 upf_t old_flags, new_flags;
677 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
680 new_port = new_serial.port;
681 if (HIGH_BITS_OFFSET)
682 new_port += (unsigned long) new_serial.port_high << HIGH_BITS_OFFSET;
684 new_serial.irq = irq_canonicalize(new_serial.irq);
685 close_delay = new_serial.close_delay * 10;
686 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
687 USF_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
690 * This semaphore protects state->count. It is also
691 * very useful to prevent opens. Also, take the
692 * port configuration semaphore to make sure that a
693 * module insertion/removal doesn't change anything
696 mutex_lock(&state->mutex);
698 change_irq = !(port->flags & UPF_FIXED_PORT)
699 && new_serial.irq != port->irq;
702 * Since changing the 'type' of the port changes its resource
703 * allocations, we should treat type changes the same as
706 change_port = !(port->flags & UPF_FIXED_PORT)
707 && (new_port != port->iobase ||
708 (unsigned long)new_serial.iomem_base != port->mapbase ||
709 new_serial.hub6 != port->hub6 ||
710 new_serial.io_type != port->iotype ||
711 new_serial.iomem_reg_shift != port->regshift ||
712 new_serial.type != port->type);
714 old_flags = port->flags;
715 new_flags = new_serial.flags;
716 old_custom_divisor = port->custom_divisor;
718 if (!capable(CAP_SYS_ADMIN)) {
720 if (change_irq || change_port ||
721 (new_serial.baud_base != port->uartclk / 16) ||
722 (close_delay != state->close_delay) ||
723 (closing_wait != state->closing_wait) ||
724 (new_serial.xmit_fifo_size &&
725 new_serial.xmit_fifo_size != port->fifosize) ||
726 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
728 port->flags = ((port->flags & ~UPF_USR_MASK) |
729 (new_flags & UPF_USR_MASK));
730 port->custom_divisor = new_serial.custom_divisor;
735 * Ask the low level driver to verify the settings.
737 if (port->ops->verify_port)
738 retval = port->ops->verify_port(port, &new_serial);
740 if ((new_serial.irq >= NR_IRQS) || (new_serial.irq < 0) ||
741 (new_serial.baud_base < 9600))
747 if (change_port || change_irq) {
751 * Make sure that we are the sole user of this port.
753 if (uart_users(state) > 1)
757 * We need to shutdown the serial port at the old
758 * port/type/irq combination.
760 uart_shutdown(state);
764 unsigned long old_iobase, old_mapbase;
765 unsigned int old_type, old_iotype, old_hub6, old_shift;
767 old_iobase = port->iobase;
768 old_mapbase = port->mapbase;
769 old_type = port->type;
770 old_hub6 = port->hub6;
771 old_iotype = port->iotype;
772 old_shift = port->regshift;
775 * Free and release old regions
777 if (old_type != PORT_UNKNOWN)
778 port->ops->release_port(port);
780 port->iobase = new_port;
781 port->type = new_serial.type;
782 port->hub6 = new_serial.hub6;
783 port->iotype = new_serial.io_type;
784 port->regshift = new_serial.iomem_reg_shift;
785 port->mapbase = (unsigned long)new_serial.iomem_base;
788 * Claim and map the new regions
790 if (port->type != PORT_UNKNOWN) {
791 retval = port->ops->request_port(port);
793 /* Always success - Jean II */
798 * If we fail to request resources for the
799 * new port, try to restore the old settings.
801 if (retval && old_type != PORT_UNKNOWN) {
802 port->iobase = old_iobase;
803 port->type = old_type;
804 port->hub6 = old_hub6;
805 port->iotype = old_iotype;
806 port->regshift = old_shift;
807 port->mapbase = old_mapbase;
808 retval = port->ops->request_port(port);
810 * If we failed to restore the old settings,
814 port->type = PORT_UNKNOWN;
820 /* Added to return the correct error -Ram Gupta */
826 port->irq = new_serial.irq;
827 if (!(port->flags & UPF_FIXED_PORT))
828 port->uartclk = new_serial.baud_base * 16;
829 port->flags = (port->flags & ~UPF_CHANGE_MASK) |
830 (new_flags & UPF_CHANGE_MASK);
831 port->custom_divisor = new_serial.custom_divisor;
832 state->close_delay = close_delay;
833 state->closing_wait = closing_wait;
834 if (new_serial.xmit_fifo_size)
835 port->fifosize = new_serial.xmit_fifo_size;
836 if (state->info->tty)
837 state->info->tty->low_latency =
838 (port->flags & UPF_LOW_LATENCY) ? 1 : 0;
842 if (port->type == PORT_UNKNOWN)
844 if (state->info->flags & UIF_INITIALIZED) {
845 if (((old_flags ^ port->flags) & UPF_SPD_MASK) ||
846 old_custom_divisor != port->custom_divisor) {
848 * If they're setting up a custom divisor or speed,
849 * instead of clearing it, then bitch about it. No
850 * need to rate-limit; it's CAP_SYS_ADMIN only.
852 if (port->flags & UPF_SPD_MASK) {
855 "%s sets custom speed on %s. This "
856 "is deprecated.\n", current->comm,
857 tty_name(state->info->tty, buf));
859 uart_change_speed(state, NULL);
862 retval = uart_startup(state, 1);
864 mutex_unlock(&state->mutex);
870 * uart_get_lsr_info - get line status register info.
871 * Note: uart_ioctl protects us against hangups.
873 static int uart_get_lsr_info(struct uart_state *state,
874 unsigned int __user *value)
876 struct uart_port *port = state->port;
879 result = port->ops->tx_empty(port);
882 * If we're about to load something into the transmit
883 * register, we'll pretend the transmitter isn't empty to
884 * avoid a race condition (depending on when the transmit
885 * interrupt happens).
888 ((uart_circ_chars_pending(&state->info->xmit) > 0) &&
889 !state->info->tty->stopped && !state->info->tty->hw_stopped))
890 result &= ~TIOCSER_TEMT;
892 return put_user(result, value);
895 static int uart_tiocmget(struct tty_struct *tty, struct file *file)
897 struct uart_state *state = tty->driver_data;
898 struct uart_port *port = state->port;
901 mutex_lock(&state->mutex);
902 if ((!file || !tty_hung_up_p(file)) &&
903 !(tty->flags & (1 << TTY_IO_ERROR))) {
904 result = port->mctrl;
906 spin_lock_irq(&port->lock);
907 result |= port->ops->get_mctrl(port);
908 spin_unlock_irq(&port->lock);
910 mutex_unlock(&state->mutex);
916 uart_tiocmset(struct tty_struct *tty, struct file *file,
917 unsigned int set, unsigned int clear)
919 struct uart_state *state = tty->driver_data;
920 struct uart_port *port = state->port;
923 mutex_lock(&state->mutex);
924 if ((!file || !tty_hung_up_p(file)) &&
925 !(tty->flags & (1 << TTY_IO_ERROR))) {
926 uart_update_mctrl(port, set, clear);
929 mutex_unlock(&state->mutex);
933 static void uart_break_ctl(struct tty_struct *tty, int break_state)
935 struct uart_state *state = tty->driver_data;
936 struct uart_port *port = state->port;
938 mutex_lock(&state->mutex);
940 if (port->type != PORT_UNKNOWN)
941 port->ops->break_ctl(port, break_state);
943 mutex_unlock(&state->mutex);
946 static int uart_do_autoconfig(struct uart_state *state)
948 struct uart_port *port = state->port;
951 if (!capable(CAP_SYS_ADMIN))
955 * Take the per-port semaphore. This prevents count from
956 * changing, and hence any extra opens of the port while
957 * we're auto-configuring.
959 if (mutex_lock_interruptible(&state->mutex))
963 if (uart_users(state) == 1) {
964 uart_shutdown(state);
967 * If we already have a port type configured,
968 * we must release its resources.
970 if (port->type != PORT_UNKNOWN)
971 port->ops->release_port(port);
973 flags = UART_CONFIG_TYPE;
974 if (port->flags & UPF_AUTO_IRQ)
975 flags |= UART_CONFIG_IRQ;
978 * This will claim the ports resources if
981 port->ops->config_port(port, flags);
983 ret = uart_startup(state, 1);
985 mutex_unlock(&state->mutex);
990 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
991 * - mask passed in arg for lines of interest
992 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
993 * Caller should use TIOCGICOUNT to see which one it was
996 uart_wait_modem_status(struct uart_state *state, unsigned long arg)
998 struct uart_port *port = state->port;
999 DECLARE_WAITQUEUE(wait, current);
1000 struct uart_icount cprev, cnow;
1004 * note the counters on entry
1006 spin_lock_irq(&port->lock);
1007 memcpy(&cprev, &port->icount, sizeof(struct uart_icount));
1010 * Force modem status interrupts on
1012 port->ops->enable_ms(port);
1013 spin_unlock_irq(&port->lock);
1015 add_wait_queue(&state->info->delta_msr_wait, &wait);
1017 spin_lock_irq(&port->lock);
1018 memcpy(&cnow, &port->icount, sizeof(struct uart_icount));
1019 spin_unlock_irq(&port->lock);
1021 set_current_state(TASK_INTERRUPTIBLE);
1023 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1024 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1025 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1026 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1033 /* see if a signal did it */
1034 if (signal_pending(current)) {
1042 current->state = TASK_RUNNING;
1043 remove_wait_queue(&state->info->delta_msr_wait, &wait);
1049 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1050 * Return: write counters to the user passed counter struct
1051 * NB: both 1->0 and 0->1 transitions are counted except for
1052 * RI where only 0->1 is counted.
1054 static int uart_get_count(struct uart_state *state,
1055 struct serial_icounter_struct __user *icnt)
1057 struct serial_icounter_struct icount;
1058 struct uart_icount cnow;
1059 struct uart_port *port = state->port;
1061 spin_lock_irq(&port->lock);
1062 memcpy(&cnow, &port->icount, sizeof(struct uart_icount));
1063 spin_unlock_irq(&port->lock);
1065 icount.cts = cnow.cts;
1066 icount.dsr = cnow.dsr;
1067 icount.rng = cnow.rng;
1068 icount.dcd = cnow.dcd;
1069 icount.rx = cnow.rx;
1070 icount.tx = cnow.tx;
1071 icount.frame = cnow.frame;
1072 icount.overrun = cnow.overrun;
1073 icount.parity = cnow.parity;
1074 icount.brk = cnow.brk;
1075 icount.buf_overrun = cnow.buf_overrun;
1077 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1081 * Called via sys_ioctl. We can use spin_lock_irq() here.
1084 uart_ioctl(struct tty_struct *tty, struct file *filp, unsigned int cmd,
1087 struct uart_state *state = tty->driver_data;
1088 void __user *uarg = (void __user *)arg;
1089 int ret = -ENOIOCTLCMD;
1093 * These ioctls don't rely on the hardware to be present.
1097 ret = uart_get_info(state, uarg);
1101 ret = uart_set_info(state, uarg);
1105 ret = uart_do_autoconfig(state);
1108 case TIOCSERGWILD: /* obsolete */
1109 case TIOCSERSWILD: /* obsolete */
1114 if (ret != -ENOIOCTLCMD)
1117 if (tty->flags & (1 << TTY_IO_ERROR)) {
1123 * The following should only be used when hardware is present.
1127 ret = uart_wait_modem_status(state, arg);
1131 ret = uart_get_count(state, uarg);
1135 if (ret != -ENOIOCTLCMD)
1138 mutex_lock(&state->mutex);
1140 if (tty_hung_up_p(filp)) {
1146 * All these rely on hardware being present and need to be
1147 * protected against the tty being hung up.
1150 case TIOCSERGETLSR: /* Get line status register */
1151 ret = uart_get_lsr_info(state, uarg);
1155 struct uart_port *port = state->port;
1156 if (port->ops->ioctl)
1157 ret = port->ops->ioctl(port, cmd, arg);
1162 mutex_unlock(&state->mutex);
1167 static void uart_set_termios(struct tty_struct *tty,
1168 struct ktermios *old_termios)
1170 struct uart_state *state = tty->driver_data;
1171 unsigned long flags;
1172 unsigned int cflag = tty->termios->c_cflag;
1176 * These are the bits that are used to setup various
1177 * flags in the low level driver. We can ignore the Bfoo
1178 * bits in c_cflag; c_[io]speed will always be set
1179 * appropriately by set_termios() in tty_ioctl.c
1181 #define RELEVANT_IFLAG(iflag) ((iflag) & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
1182 if ((cflag ^ old_termios->c_cflag) == 0 &&
1183 tty->termios->c_ospeed == old_termios->c_ospeed &&
1184 tty->termios->c_ispeed == old_termios->c_ispeed &&
1185 RELEVANT_IFLAG(tty->termios->c_iflag ^ old_termios->c_iflag) == 0) {
1189 uart_change_speed(state, old_termios);
1191 /* Handle transition to B0 status */
1192 if ((old_termios->c_cflag & CBAUD) && !(cflag & CBAUD))
1193 uart_clear_mctrl(state->port, TIOCM_RTS | TIOCM_DTR);
1195 /* Handle transition away from B0 status */
1196 if (!(old_termios->c_cflag & CBAUD) && (cflag & CBAUD)) {
1197 unsigned int mask = TIOCM_DTR;
1198 if (!(cflag & CRTSCTS) ||
1199 !test_bit(TTY_THROTTLED, &tty->flags))
1201 uart_set_mctrl(state->port, mask);
1204 /* Handle turning off CRTSCTS */
1205 if ((old_termios->c_cflag & CRTSCTS) && !(cflag & CRTSCTS)) {
1206 spin_lock_irqsave(&state->port->lock, flags);
1207 tty->hw_stopped = 0;
1209 spin_unlock_irqrestore(&state->port->lock, flags);
1212 /* Handle turning on CRTSCTS */
1213 if (!(old_termios->c_cflag & CRTSCTS) && (cflag & CRTSCTS)) {
1214 spin_lock_irqsave(&state->port->lock, flags);
1215 if (!(state->port->ops->get_mctrl(state->port) & TIOCM_CTS)) {
1216 tty->hw_stopped = 1;
1217 state->port->ops->stop_tx(state->port);
1219 spin_unlock_irqrestore(&state->port->lock, flags);
1223 * No need to wake up processes in open wait, since they
1224 * sample the CLOCAL flag once, and don't recheck it.
1225 * XXX It's not clear whether the current behavior is correct
1226 * or not. Hence, this may change.....
1228 if (!(old_termios->c_cflag & CLOCAL) &&
1229 (tty->termios->c_cflag & CLOCAL))
1230 wake_up_interruptible(&state->info->open_wait);
1235 * In 2.4.5, calls to this will be serialized via the BKL in
1236 * linux/drivers/char/tty_io.c:tty_release()
1237 * linux/drivers/char/tty_io.c:do_tty_handup()
1239 static void uart_close(struct tty_struct *tty, struct file *filp)
1241 struct uart_state *state = tty->driver_data;
1242 struct uart_port *port;
1244 BUG_ON(!kernel_locked());
1246 if (!state || !state->port)
1251 pr_debug("uart_close(%d) called\n", port->line);
1253 mutex_lock(&state->mutex);
1255 if (tty_hung_up_p(filp))
1258 if ((tty->count == 1) && (state->count != 1)) {
1260 * Uh, oh. tty->count is 1, which means that the tty
1261 * structure will be freed. state->count should always
1262 * be one in these conditions. If it's greater than
1263 * one, we've got real problems, since it means the
1264 * serial port won't be shutdown.
1266 printk(KERN_ERR "uart_close: bad serial port count; tty->count is 1, "
1267 "state->count is %d\n", state->count);
1270 if (--state->count < 0) {
1271 printk(KERN_ERR "uart_close: bad serial port count for %s: %d\n",
1272 tty->name, state->count);
1279 * Now we wait for the transmit buffer to clear; and we notify
1280 * the line discipline to only process XON/XOFF characters by
1281 * setting tty->closing.
1285 if (state->closing_wait != USF_CLOSING_WAIT_NONE)
1286 tty_wait_until_sent(tty, msecs_to_jiffies(state->closing_wait));
1289 * At this point, we stop accepting input. To do this, we
1290 * disable the receive line status interrupts.
1292 if (state->info->flags & UIF_INITIALIZED) {
1293 unsigned long flags;
1294 spin_lock_irqsave(&port->lock, flags);
1295 port->ops->stop_rx(port);
1296 spin_unlock_irqrestore(&port->lock, flags);
1298 * Before we drop DTR, make sure the UART transmitter
1299 * has completely drained; this is especially
1300 * important if there is a transmit FIFO!
1302 uart_wait_until_sent(tty, port->timeout);
1305 uart_shutdown(state);
1306 uart_flush_buffer(tty);
1308 tty_ldisc_flush(tty);
1311 state->info->tty = NULL;
1313 if (state->info->blocked_open) {
1314 if (state->close_delay)
1315 msleep_interruptible(state->close_delay);
1316 } else if (!uart_console(port)) {
1317 uart_change_pm(state, 3);
1321 * Wake up anyone trying to open this port.
1323 state->info->flags &= ~UIF_NORMAL_ACTIVE;
1324 wake_up_interruptible(&state->info->open_wait);
1327 mutex_unlock(&state->mutex);
1330 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1332 struct uart_state *state = tty->driver_data;
1333 struct uart_port *port = state->port;
1334 unsigned long char_time, expire;
1336 if (port->type == PORT_UNKNOWN || port->fifosize == 0)
1342 * Set the check interval to be 1/5 of the estimated time to
1343 * send a single character, and make it at least 1. The check
1344 * interval should also be less than the timeout.
1346 * Note: we have to use pretty tight timings here to satisfy
1349 char_time = (port->timeout - HZ/50) / port->fifosize;
1350 char_time = char_time / 5;
1353 if (timeout && timeout < char_time)
1354 char_time = timeout;
1357 * If the transmitter hasn't cleared in twice the approximate
1358 * amount of time to send the entire FIFO, it probably won't
1359 * ever clear. This assumes the UART isn't doing flow
1360 * control, which is currently the case. Hence, if it ever
1361 * takes longer than port->timeout, this is probably due to a
1362 * UART bug of some kind. So, we clamp the timeout parameter at
1365 if (timeout == 0 || timeout > 2 * port->timeout)
1366 timeout = 2 * port->timeout;
1368 expire = jiffies + timeout;
1370 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1371 port->line, jiffies, expire);
1374 * Check whether the transmitter is empty every 'char_time'.
1375 * 'timeout' / 'expire' give us the maximum amount of time
1378 while (!port->ops->tx_empty(port)) {
1379 msleep_interruptible(jiffies_to_msecs(char_time));
1380 if (signal_pending(current))
1382 if (time_after(jiffies, expire))
1385 set_current_state(TASK_RUNNING); /* might not be needed */
1390 * This is called with the BKL held in
1391 * linux/drivers/char/tty_io.c:do_tty_hangup()
1392 * We're called from the eventd thread, so we can sleep for
1393 * a _short_ time only.
1395 static void uart_hangup(struct tty_struct *tty)
1397 struct uart_state *state = tty->driver_data;
1399 BUG_ON(!kernel_locked());
1400 pr_debug("uart_hangup(%d)\n", state->port->line);
1402 mutex_lock(&state->mutex);
1403 if (state->info && state->info->flags & UIF_NORMAL_ACTIVE) {
1404 uart_flush_buffer(tty);
1405 uart_shutdown(state);
1407 state->info->flags &= ~UIF_NORMAL_ACTIVE;
1408 state->info->tty = NULL;
1409 wake_up_interruptible(&state->info->open_wait);
1410 wake_up_interruptible(&state->info->delta_msr_wait);
1412 mutex_unlock(&state->mutex);
1416 * Copy across the serial console cflag setting into the termios settings
1417 * for the initial open of the port. This allows continuity between the
1418 * kernel settings, and the settings init adopts when it opens the port
1419 * for the first time.
1421 static void uart_update_termios(struct uart_state *state)
1423 struct tty_struct *tty = state->info->tty;
1424 struct uart_port *port = state->port;
1426 if (uart_console(port) && port->cons->cflag) {
1427 tty->termios->c_cflag = port->cons->cflag;
1428 port->cons->cflag = 0;
1432 * If the device failed to grab its irq resources,
1433 * or some other error occurred, don't try to talk
1434 * to the port hardware.
1436 if (!(tty->flags & (1 << TTY_IO_ERROR))) {
1438 * Make termios settings take effect.
1440 uart_change_speed(state, NULL);
1443 * And finally enable the RTS and DTR signals.
1445 if (tty->termios->c_cflag & CBAUD)
1446 uart_set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1451 * Block the open until the port is ready. We must be called with
1452 * the per-port semaphore held.
1455 uart_block_til_ready(struct file *filp, struct uart_state *state)
1457 DECLARE_WAITQUEUE(wait, current);
1458 struct uart_info *info = state->info;
1459 struct uart_port *port = state->port;
1462 info->blocked_open++;
1465 add_wait_queue(&info->open_wait, &wait);
1467 set_current_state(TASK_INTERRUPTIBLE);
1470 * If we have been hung up, tell userspace/restart open.
1472 if (tty_hung_up_p(filp) || info->tty == NULL)
1476 * If the port has been closed, tell userspace/restart open.
1478 if (!(info->flags & UIF_INITIALIZED))
1482 * If non-blocking mode is set, or CLOCAL mode is set,
1483 * we don't want to wait for the modem status lines to
1484 * indicate that the port is ready.
1486 * Also, if the port is not enabled/configured, we want
1487 * to allow the open to succeed here. Note that we will
1488 * have set TTY_IO_ERROR for a non-existant port.
1490 if ((filp->f_flags & O_NONBLOCK) ||
1491 (info->tty->termios->c_cflag & CLOCAL) ||
1492 (info->tty->flags & (1 << TTY_IO_ERROR)))
1496 * Set DTR to allow modem to know we're waiting. Do
1497 * not set RTS here - we want to make sure we catch
1498 * the data from the modem.
1500 if (info->tty->termios->c_cflag & CBAUD)
1501 uart_set_mctrl(port, TIOCM_DTR);
1504 * and wait for the carrier to indicate that the
1505 * modem is ready for us.
1507 spin_lock_irq(&port->lock);
1508 port->ops->enable_ms(port);
1509 mctrl = port->ops->get_mctrl(port);
1510 spin_unlock_irq(&port->lock);
1511 if (mctrl & TIOCM_CAR)
1514 mutex_unlock(&state->mutex);
1516 mutex_lock(&state->mutex);
1518 if (signal_pending(current))
1521 set_current_state(TASK_RUNNING);
1522 remove_wait_queue(&info->open_wait, &wait);
1525 info->blocked_open--;
1527 if (signal_pending(current))
1528 return -ERESTARTSYS;
1530 if (!info->tty || tty_hung_up_p(filp))
1536 static struct uart_state *uart_get(struct uart_driver *drv, int line)
1538 struct uart_state *state;
1541 state = drv->state + line;
1542 if (mutex_lock_interruptible(&state->mutex)) {
1548 if (!state->port || state->port->flags & UPF_DEAD) {
1554 state->info = kzalloc(sizeof(struct uart_info), GFP_KERNEL);
1556 init_waitqueue_head(&state->info->open_wait);
1557 init_waitqueue_head(&state->info->delta_msr_wait);
1560 * Link the info into the other structures.
1562 state->port->info = state->info;
1564 tasklet_init(&state->info->tlet, uart_tasklet_action,
1565 (unsigned long)state);
1575 mutex_unlock(&state->mutex);
1577 return ERR_PTR(ret);
1581 * calls to uart_open are serialised by the BKL in
1582 * fs/char_dev.c:chrdev_open()
1583 * Note that if this fails, then uart_close() _will_ be called.
1585 * In time, we want to scrap the "opening nonpresent ports"
1586 * behaviour and implement an alternative way for setserial
1587 * to set base addresses/ports/types. This will allow us to
1588 * get rid of a certain amount of extra tests.
1590 static int uart_open(struct tty_struct *tty, struct file *filp)
1592 struct uart_driver *drv = (struct uart_driver *)tty->driver->driver_state;
1593 struct uart_state *state;
1594 int retval, line = tty->index;
1596 BUG_ON(!kernel_locked());
1597 pr_debug("uart_open(%d) called\n", line);
1600 * tty->driver->num won't change, so we won't fail here with
1601 * tty->driver_data set to something non-NULL (and therefore
1602 * we won't get caught by uart_close()).
1605 if (line >= tty->driver->num)
1609 * We take the semaphore inside uart_get to guarantee that we won't
1610 * be re-entered while allocating the info structure, or while we
1611 * request any IRQs that the driver may need. This also has the nice
1612 * side-effect that it delays the action of uart_hangup, so we can
1613 * guarantee that info->tty will always contain something reasonable.
1615 state = uart_get(drv, line);
1616 if (IS_ERR(state)) {
1617 retval = PTR_ERR(state);
1622 * Once we set tty->driver_data here, we are guaranteed that
1623 * uart_close() will decrement the driver module use count.
1624 * Any failures from here onwards should not touch the count.
1626 tty->driver_data = state;
1627 tty->low_latency = (state->port->flags & UPF_LOW_LATENCY) ? 1 : 0;
1629 state->info->tty = tty;
1632 * If the port is in the middle of closing, bail out now.
1634 if (tty_hung_up_p(filp)) {
1637 mutex_unlock(&state->mutex);
1642 * Make sure the device is in D0 state.
1644 if (state->count == 1)
1645 uart_change_pm(state, 0);
1648 * Start up the serial port.
1650 retval = uart_startup(state, 0);
1653 * If we succeeded, wait until the port is ready.
1656 retval = uart_block_til_ready(filp, state);
1657 mutex_unlock(&state->mutex);
1660 * If this is the first open to succeed, adjust things to suit.
1662 if (retval == 0 && !(state->info->flags & UIF_NORMAL_ACTIVE)) {
1663 state->info->flags |= UIF_NORMAL_ACTIVE;
1665 uart_update_termios(state);
1672 static const char *uart_type(struct uart_port *port)
1674 const char *str = NULL;
1676 if (port->ops->type)
1677 str = port->ops->type(port);
1685 #ifdef CONFIG_PROC_FS
1687 static int uart_line_info(char *buf, struct uart_driver *drv, int i)
1689 struct uart_state *state = drv->state + i;
1691 struct uart_port *port = state->port;
1693 unsigned int status;
1699 mmio = port->iotype >= UPIO_MEM;
1700 ret = sprintf(buf, "%d: uart:%s %s%08llX irq:%d",
1701 port->line, uart_type(port),
1702 mmio ? "mmio:0x" : "port:",
1703 mmio ? (unsigned long long)port->mapbase
1704 : (unsigned long long) port->iobase,
1707 if (port->type == PORT_UNKNOWN) {
1712 if (capable(CAP_SYS_ADMIN)) {
1713 mutex_lock(&state->mutex);
1714 pm_state = state->pm_state;
1716 uart_change_pm(state, 0);
1717 spin_lock_irq(&port->lock);
1718 status = port->ops->get_mctrl(port);
1719 spin_unlock_irq(&port->lock);
1721 uart_change_pm(state, pm_state);
1722 mutex_unlock(&state->mutex);
1724 ret += sprintf(buf + ret, " tx:%d rx:%d",
1725 port->icount.tx, port->icount.rx);
1726 if (port->icount.frame)
1727 ret += sprintf(buf + ret, " fe:%d",
1728 port->icount.frame);
1729 if (port->icount.parity)
1730 ret += sprintf(buf + ret, " pe:%d",
1731 port->icount.parity);
1732 if (port->icount.brk)
1733 ret += sprintf(buf + ret, " brk:%d",
1735 if (port->icount.overrun)
1736 ret += sprintf(buf + ret, " oe:%d",
1737 port->icount.overrun);
1739 #define INFOBIT(bit, str) \
1740 if (port->mctrl & (bit)) \
1741 strncat(stat_buf, (str), sizeof(stat_buf) - \
1742 strlen(stat_buf) - 2)
1743 #define STATBIT(bit, str) \
1744 if (status & (bit)) \
1745 strncat(stat_buf, (str), sizeof(stat_buf) - \
1746 strlen(stat_buf) - 2)
1750 INFOBIT(TIOCM_RTS, "|RTS");
1751 STATBIT(TIOCM_CTS, "|CTS");
1752 INFOBIT(TIOCM_DTR, "|DTR");
1753 STATBIT(TIOCM_DSR, "|DSR");
1754 STATBIT(TIOCM_CAR, "|CD");
1755 STATBIT(TIOCM_RNG, "|RI");
1758 strcat(stat_buf, "\n");
1760 ret += sprintf(buf + ret, stat_buf);
1770 static int uart_read_proc(char *page, char **start, off_t off,
1771 int count, int *eof, void *data)
1773 struct tty_driver *ttydrv = data;
1774 struct uart_driver *drv = ttydrv->driver_state;
1778 len += sprintf(page, "serinfo:1.0 driver%s%s revision:%s\n",
1780 for (i = 0; i < drv->nr && len < PAGE_SIZE - 96; i++) {
1781 l = uart_line_info(page + len, drv, i);
1783 if (len + begin > off + count)
1785 if (len + begin < off) {
1792 if (off >= len + begin)
1794 *start = page + (off - begin);
1795 return (count < begin + len - off) ? count : (begin + len - off);
1799 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1801 * uart_console_write - write a console message to a serial port
1802 * @port: the port to write the message
1803 * @s: array of characters
1804 * @count: number of characters in string to write
1805 * @write: function to write character to port
1807 void uart_console_write(struct uart_port *port, const char *s,
1809 void (*putchar)(struct uart_port *, int))
1813 for (i = 0; i < count; i++, s++) {
1815 putchar(port, '\r');
1819 EXPORT_SYMBOL_GPL(uart_console_write);
1822 * Check whether an invalid uart number has been specified, and
1823 * if so, search for the first available port that does have
1826 struct uart_port * __init
1827 uart_get_console(struct uart_port *ports, int nr, struct console *co)
1829 int idx = co->index;
1831 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
1832 ports[idx].membase == NULL))
1833 for (idx = 0; idx < nr; idx++)
1834 if (ports[idx].iobase != 0 ||
1835 ports[idx].membase != NULL)
1844 * uart_parse_options - Parse serial port baud/parity/bits/flow contro.
1845 * @options: pointer to option string
1846 * @baud: pointer to an 'int' variable for the baud rate.
1847 * @parity: pointer to an 'int' variable for the parity.
1848 * @bits: pointer to an 'int' variable for the number of data bits.
1849 * @flow: pointer to an 'int' variable for the flow control character.
1851 * uart_parse_options decodes a string containing the serial console
1852 * options. The format of the string is <baud><parity><bits><flow>,
1856 uart_parse_options(char *options, int *baud, int *parity, int *bits, int *flow)
1860 *baud = simple_strtoul(s, NULL, 10);
1861 while (*s >= '0' && *s <= '9')
1870 EXPORT_SYMBOL_GPL(uart_parse_options);
1877 static const struct baud_rates baud_rates[] = {
1878 { 921600, B921600 },
1879 { 460800, B460800 },
1880 { 230400, B230400 },
1881 { 115200, B115200 },
1893 * uart_set_options - setup the serial console parameters
1894 * @port: pointer to the serial ports uart_port structure
1895 * @co: console pointer
1897 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1898 * @bits: number of data bits
1899 * @flow: flow control character - 'r' (rts)
1902 uart_set_options(struct uart_port *port, struct console *co,
1903 int baud, int parity, int bits, int flow)
1905 struct ktermios termios;
1906 static struct ktermios dummy;
1910 * Ensure that the serial console lock is initialised
1913 spin_lock_init(&port->lock);
1914 lockdep_set_class(&port->lock, &port_lock_key);
1916 memset(&termios, 0, sizeof(struct ktermios));
1918 termios.c_cflag = CREAD | HUPCL | CLOCAL;
1921 * Construct a cflag setting.
1923 for (i = 0; baud_rates[i].rate; i++)
1924 if (baud_rates[i].rate <= baud)
1927 termios.c_cflag |= baud_rates[i].cflag;
1930 termios.c_cflag |= CS7;
1932 termios.c_cflag |= CS8;
1936 termios.c_cflag |= PARODD;
1939 termios.c_cflag |= PARENB;
1944 termios.c_cflag |= CRTSCTS;
1947 * some uarts on other side don't support no flow control.
1948 * So we set * DTR in host uart to make them happy
1950 port->mctrl |= TIOCM_DTR;
1952 port->ops->set_termios(port, &termios, &dummy);
1954 * Allow the setting of the UART parameters with a NULL console
1958 co->cflag = termios.c_cflag;
1962 EXPORT_SYMBOL_GPL(uart_set_options);
1963 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
1965 static void uart_change_pm(struct uart_state *state, int pm_state)
1967 struct uart_port *port = state->port;
1969 if (state->pm_state != pm_state) {
1971 port->ops->pm(port, pm_state, state->pm_state);
1972 state->pm_state = pm_state;
1977 struct uart_port *port;
1978 struct uart_driver *driver;
1981 static int serial_match_port(struct device *dev, void *data)
1983 struct uart_match *match = data;
1984 dev_t devt = MKDEV(match->driver->major, match->driver->minor) + match->port->line;
1986 return dev->devt == devt; /* Actually, only one tty per port */
1989 int uart_suspend_port(struct uart_driver *drv, struct uart_port *port)
1991 struct uart_state *state = drv->state + port->line;
1992 struct device *tty_dev;
1993 struct uart_match match = {port, drv};
1995 mutex_lock(&state->mutex);
1997 if (!console_suspend_enabled && uart_console(port)) {
1998 /* we're going to avoid suspending serial console */
1999 mutex_unlock(&state->mutex);
2003 tty_dev = device_find_child(port->dev, &match, serial_match_port);
2004 if (device_may_wakeup(tty_dev)) {
2005 enable_irq_wake(port->irq);
2006 put_device(tty_dev);
2007 mutex_unlock(&state->mutex);
2010 port->suspended = 1;
2012 if (state->info && state->info->flags & UIF_INITIALIZED) {
2013 const struct uart_ops *ops = port->ops;
2016 state->info->flags = (state->info->flags & ~UIF_INITIALIZED)
2019 spin_lock_irq(&port->lock);
2021 ops->set_mctrl(port, 0);
2023 spin_unlock_irq(&port->lock);
2026 * Wait for the transmitter to empty.
2028 for (tries = 3; !ops->tx_empty(port) && tries; tries--)
2031 printk(KERN_ERR "%s%s%s%d: Unable to drain "
2033 port->dev ? port->dev->bus_id : "",
2034 port->dev ? ": " : "",
2035 drv->dev_name, port->line);
2037 ops->shutdown(port);
2041 * Disable the console device before suspending.
2043 if (uart_console(port))
2044 console_stop(port->cons);
2046 uart_change_pm(state, 3);
2048 mutex_unlock(&state->mutex);
2053 int uart_resume_port(struct uart_driver *drv, struct uart_port *port)
2055 struct uart_state *state = drv->state + port->line;
2057 mutex_lock(&state->mutex);
2059 if (!console_suspend_enabled && uart_console(port)) {
2060 /* no need to resume serial console, it wasn't suspended */
2061 mutex_unlock(&state->mutex);
2065 if (!port->suspended) {
2066 disable_irq_wake(port->irq);
2067 mutex_unlock(&state->mutex);
2070 port->suspended = 0;
2073 * Re-enable the console device after suspending.
2075 if (uart_console(port)) {
2076 struct ktermios termios;
2079 * First try to use the console cflag setting.
2081 memset(&termios, 0, sizeof(struct ktermios));
2082 termios.c_cflag = port->cons->cflag;
2085 * If that's unset, use the tty termios setting.
2087 if (state->info && state->info->tty && termios.c_cflag == 0)
2088 termios = *state->info->tty->termios;
2090 uart_change_pm(state, 0);
2091 port->ops->set_termios(port, &termios, NULL);
2092 console_start(port->cons);
2095 if (state->info && state->info->flags & UIF_SUSPENDED) {
2096 const struct uart_ops *ops = port->ops;
2099 uart_change_pm(state, 0);
2100 spin_lock_irq(&port->lock);
2101 ops->set_mctrl(port, 0);
2102 spin_unlock_irq(&port->lock);
2103 ret = ops->startup(port);
2105 uart_change_speed(state, NULL);
2106 spin_lock_irq(&port->lock);
2107 ops->set_mctrl(port, port->mctrl);
2108 ops->start_tx(port);
2109 spin_unlock_irq(&port->lock);
2110 state->info->flags |= UIF_INITIALIZED;
2113 * Failed to resume - maybe hardware went away?
2114 * Clear the "initialized" flag so we won't try
2115 * to call the low level drivers shutdown method.
2117 uart_shutdown(state);
2120 state->info->flags &= ~UIF_SUSPENDED;
2123 mutex_unlock(&state->mutex);
2129 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2133 switch (port->iotype) {
2135 snprintf(address, sizeof(address),
2136 "I/O 0x%x", port->iobase);
2139 snprintf(address, sizeof(address),
2140 "I/O 0x%x offset 0x%x", port->iobase, port->hub6);
2147 snprintf(address, sizeof(address),
2148 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2151 strlcpy(address, "*unknown*", sizeof(address));
2155 printk(KERN_INFO "%s%s%s%d at %s (irq = %d) is a %s\n",
2156 port->dev ? port->dev->bus_id : "",
2157 port->dev ? ": " : "",
2158 drv->dev_name, port->line, address, port->irq, uart_type(port));
2162 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2163 struct uart_port *port)
2168 * If there isn't a port here, don't do anything further.
2170 if (!port->iobase && !port->mapbase && !port->membase)
2174 * Now do the auto configuration stuff. Note that config_port
2175 * is expected to claim the resources and map the port for us.
2177 flags = UART_CONFIG_TYPE;
2178 if (port->flags & UPF_AUTO_IRQ)
2179 flags |= UART_CONFIG_IRQ;
2180 if (port->flags & UPF_BOOT_AUTOCONF) {
2181 port->type = PORT_UNKNOWN;
2182 port->ops->config_port(port, flags);
2185 if (port->type != PORT_UNKNOWN) {
2186 unsigned long flags;
2188 uart_report_port(drv, port);
2190 /* Power up port for set_mctrl() */
2191 uart_change_pm(state, 0);
2194 * Ensure that the modem control lines are de-activated.
2195 * keep the DTR setting that is set in uart_set_options()
2196 * We probably don't need a spinlock around this, but
2198 spin_lock_irqsave(&port->lock, flags);
2199 port->ops->set_mctrl(port, port->mctrl & TIOCM_DTR);
2200 spin_unlock_irqrestore(&port->lock, flags);
2203 * If this driver supports console, and it hasn't been
2204 * successfully registered yet, try to re-register it.
2205 * It may be that the port was not available.
2207 if (port->cons && !(port->cons->flags & CON_ENABLED))
2208 register_console(port->cons);
2211 * Power down all ports by default, except the
2212 * console if we have one.
2214 if (!uart_console(port))
2215 uart_change_pm(state, 3);
2219 #ifdef CONFIG_CONSOLE_POLL
2221 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2223 struct uart_driver *drv = driver->driver_state;
2224 struct uart_state *state = drv->state + line;
2225 struct uart_port *port;
2231 if (!state || !state->port)
2235 if (!(port->ops->poll_get_char && port->ops->poll_put_char))
2239 uart_parse_options(options, &baud, &parity, &bits, &flow);
2240 return uart_set_options(port, NULL, baud, parity, bits, flow);
2246 static int uart_poll_get_char(struct tty_driver *driver, int line)
2248 struct uart_driver *drv = driver->driver_state;
2249 struct uart_state *state = drv->state + line;
2250 struct uart_port *port;
2252 if (!state || !state->port)
2256 return port->ops->poll_get_char(port);
2259 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2261 struct uart_driver *drv = driver->driver_state;
2262 struct uart_state *state = drv->state + line;
2263 struct uart_port *port;
2265 if (!state || !state->port)
2269 port->ops->poll_put_char(port, ch);
2273 static const struct tty_operations uart_ops = {
2275 .close = uart_close,
2276 .write = uart_write,
2277 .put_char = uart_put_char,
2278 .flush_chars = uart_flush_chars,
2279 .write_room = uart_write_room,
2280 .chars_in_buffer= uart_chars_in_buffer,
2281 .flush_buffer = uart_flush_buffer,
2282 .ioctl = uart_ioctl,
2283 .throttle = uart_throttle,
2284 .unthrottle = uart_unthrottle,
2285 .send_xchar = uart_send_xchar,
2286 .set_termios = uart_set_termios,
2288 .start = uart_start,
2289 .hangup = uart_hangup,
2290 .break_ctl = uart_break_ctl,
2291 .wait_until_sent= uart_wait_until_sent,
2292 #ifdef CONFIG_PROC_FS
2293 .read_proc = uart_read_proc,
2295 .tiocmget = uart_tiocmget,
2296 .tiocmset = uart_tiocmset,
2297 #ifdef CONFIG_CONSOLE_POLL
2298 .poll_init = uart_poll_init,
2299 .poll_get_char = uart_poll_get_char,
2300 .poll_put_char = uart_poll_put_char,
2305 * uart_register_driver - register a driver with the uart core layer
2306 * @drv: low level driver structure
2308 * Register a uart driver with the core driver. We in turn register
2309 * with the tty layer, and initialise the core driver per-port state.
2311 * We have a proc file in /proc/tty/driver which is named after the
2314 * drv->port should be NULL, and the per-port structures should be
2315 * registered using uart_add_one_port after this call has succeeded.
2317 int uart_register_driver(struct uart_driver *drv)
2319 struct tty_driver *normal = NULL;
2325 * Maybe we should be using a slab cache for this, especially if
2326 * we have a large number of ports to handle.
2328 drv->state = kzalloc(sizeof(struct uart_state) * drv->nr, GFP_KERNEL);
2333 normal = alloc_tty_driver(drv->nr);
2337 drv->tty_driver = normal;
2339 normal->owner = drv->owner;
2340 normal->driver_name = drv->driver_name;
2341 normal->name = drv->dev_name;
2342 normal->major = drv->major;
2343 normal->minor_start = drv->minor;
2344 normal->type = TTY_DRIVER_TYPE_SERIAL;
2345 normal->subtype = SERIAL_TYPE_NORMAL;
2346 normal->init_termios = tty_std_termios;
2347 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2348 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2349 normal->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2350 normal->driver_state = drv;
2351 tty_set_operations(normal, &uart_ops);
2354 * Initialise the UART state(s).
2356 for (i = 0; i < drv->nr; i++) {
2357 struct uart_state *state = drv->state + i;
2359 state->close_delay = 500; /* .5 seconds */
2360 state->closing_wait = 30000; /* 30 seconds */
2362 mutex_init(&state->mutex);
2365 retval = tty_register_driver(normal);
2368 put_tty_driver(normal);
2375 * uart_unregister_driver - remove a driver from the uart core layer
2376 * @drv: low level driver structure
2378 * Remove all references to a driver from the core driver. The low
2379 * level driver must have removed all its ports via the
2380 * uart_remove_one_port() if it registered them with uart_add_one_port().
2381 * (ie, drv->port == NULL)
2383 void uart_unregister_driver(struct uart_driver *drv)
2385 struct tty_driver *p = drv->tty_driver;
2386 tty_unregister_driver(p);
2389 drv->tty_driver = NULL;
2392 struct tty_driver *uart_console_device(struct console *co, int *index)
2394 struct uart_driver *p = co->data;
2396 return p->tty_driver;
2400 * uart_add_one_port - attach a driver-defined port structure
2401 * @drv: pointer to the uart low level driver structure for this port
2402 * @port: uart port structure to use for this port.
2404 * This allows the driver to register its own uart_port structure
2405 * with the core driver. The main purpose is to allow the low
2406 * level uart drivers to expand uart_port, rather than having yet
2407 * more levels of structures.
2409 int uart_add_one_port(struct uart_driver *drv, struct uart_port *port)
2411 struct uart_state *state;
2413 struct device *tty_dev;
2415 BUG_ON(in_interrupt());
2417 if (port->line >= drv->nr)
2420 state = drv->state + port->line;
2422 mutex_lock(&port_mutex);
2423 mutex_lock(&state->mutex);
2430 state->pm_state = -1;
2432 port->cons = drv->cons;
2433 port->info = state->info;
2436 * If this port is a console, then the spinlock is already
2439 if (!(uart_console(port) && (port->cons->flags & CON_ENABLED))) {
2440 spin_lock_init(&port->lock);
2441 lockdep_set_class(&port->lock, &port_lock_key);
2444 uart_configure_port(drv, state, port);
2447 * Register the port whether it's detected or not. This allows
2448 * setserial to be used to alter this ports parameters.
2450 tty_dev = tty_register_device(drv->tty_driver, port->line, port->dev);
2451 if (likely(!IS_ERR(tty_dev))) {
2452 device_init_wakeup(tty_dev, 1);
2453 device_set_wakeup_enable(tty_dev, 0);
2455 printk(KERN_ERR "Cannot register tty device on line %d\n",
2459 * Ensure UPF_DEAD is not set.
2461 port->flags &= ~UPF_DEAD;
2464 mutex_unlock(&state->mutex);
2465 mutex_unlock(&port_mutex);
2471 * uart_remove_one_port - detach a driver defined port structure
2472 * @drv: pointer to the uart low level driver structure for this port
2473 * @port: uart port structure for this port
2475 * This unhooks (and hangs up) the specified port structure from the
2476 * core driver. No further calls will be made to the low-level code
2479 int uart_remove_one_port(struct uart_driver *drv, struct uart_port *port)
2481 struct uart_state *state = drv->state + port->line;
2482 struct uart_info *info;
2484 BUG_ON(in_interrupt());
2486 if (state->port != port)
2487 printk(KERN_ALERT "Removing wrong port: %p != %p\n",
2490 mutex_lock(&port_mutex);
2493 * Mark the port "dead" - this prevents any opens from
2494 * succeeding while we shut down the port.
2496 mutex_lock(&state->mutex);
2497 port->flags |= UPF_DEAD;
2498 mutex_unlock(&state->mutex);
2501 * Remove the devices from the tty layer
2503 tty_unregister_device(drv->tty_driver, port->line);
2506 if (info && info->tty)
2507 tty_vhangup(info->tty);
2510 * All users of this port should now be disconnected from
2511 * this driver, and the port shut down. We should be the
2512 * only thread fiddling with this port from now on.
2517 * Free the port IO and memory resources, if any.
2519 if (port->type != PORT_UNKNOWN)
2520 port->ops->release_port(port);
2523 * Indicate that there isn't a port here anymore.
2525 port->type = PORT_UNKNOWN;
2528 * Kill the tasklet, and free resources.
2531 tasklet_kill(&info->tlet);
2536 mutex_unlock(&port_mutex);
2542 * Are the two ports equivalent?
2544 int uart_match_port(struct uart_port *port1, struct uart_port *port2)
2546 if (port1->iotype != port2->iotype)
2549 switch (port1->iotype) {
2551 return (port1->iobase == port2->iobase);
2553 return (port1->iobase == port2->iobase) &&
2554 (port1->hub6 == port2->hub6);
2560 return (port1->mapbase == port2->mapbase);
2564 EXPORT_SYMBOL(uart_match_port);
2566 EXPORT_SYMBOL(uart_write_wakeup);
2567 EXPORT_SYMBOL(uart_register_driver);
2568 EXPORT_SYMBOL(uart_unregister_driver);
2569 EXPORT_SYMBOL(uart_suspend_port);
2570 EXPORT_SYMBOL(uart_resume_port);
2571 EXPORT_SYMBOL(uart_add_one_port);
2572 EXPORT_SYMBOL(uart_remove_one_port);
2574 MODULE_DESCRIPTION("Serial driver core");
2575 MODULE_LICENSE("GPL");