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;
563 * This means you called this function _after_ the port was
564 * closed. No cookie for you.
566 if (!state || !state->info) {
572 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
574 spin_lock_irqsave(&port->lock, flags);
575 uart_circ_clear(&state->info->xmit);
576 spin_unlock_irqrestore(&port->lock, flags);
581 * This function is used to send a high-priority XON/XOFF character to
584 static void uart_send_xchar(struct tty_struct *tty, char ch)
586 struct uart_state *state = tty->driver_data;
587 struct uart_port *port = state->port;
590 if (port->ops->send_xchar)
591 port->ops->send_xchar(port, ch);
595 spin_lock_irqsave(&port->lock, flags);
596 port->ops->start_tx(port);
597 spin_unlock_irqrestore(&port->lock, flags);
602 static void uart_throttle(struct tty_struct *tty)
604 struct uart_state *state = tty->driver_data;
607 uart_send_xchar(tty, STOP_CHAR(tty));
609 if (tty->termios->c_cflag & CRTSCTS)
610 uart_clear_mctrl(state->port, TIOCM_RTS);
613 static void uart_unthrottle(struct tty_struct *tty)
615 struct uart_state *state = tty->driver_data;
616 struct uart_port *port = state->port;
622 uart_send_xchar(tty, START_CHAR(tty));
625 if (tty->termios->c_cflag & CRTSCTS)
626 uart_set_mctrl(port, TIOCM_RTS);
629 static int uart_get_info(struct uart_state *state,
630 struct serial_struct __user *retinfo)
632 struct uart_port *port = state->port;
633 struct serial_struct tmp;
635 memset(&tmp, 0, sizeof(tmp));
637 /* Ensure the state we copy is consistent and no hardware changes
639 mutex_lock(&state->mutex);
641 tmp.type = port->type;
642 tmp.line = port->line;
643 tmp.port = port->iobase;
644 if (HIGH_BITS_OFFSET)
645 tmp.port_high = (long) port->iobase >> HIGH_BITS_OFFSET;
647 tmp.flags = port->flags;
648 tmp.xmit_fifo_size = port->fifosize;
649 tmp.baud_base = port->uartclk / 16;
650 tmp.close_delay = state->close_delay / 10;
651 tmp.closing_wait = state->closing_wait == USF_CLOSING_WAIT_NONE ?
652 ASYNC_CLOSING_WAIT_NONE :
653 state->closing_wait / 10;
654 tmp.custom_divisor = port->custom_divisor;
655 tmp.hub6 = port->hub6;
656 tmp.io_type = port->iotype;
657 tmp.iomem_reg_shift = port->regshift;
658 tmp.iomem_base = (void *)(unsigned long)port->mapbase;
660 mutex_unlock(&state->mutex);
662 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
667 static int uart_set_info(struct uart_state *state,
668 struct serial_struct __user *newinfo)
670 struct serial_struct new_serial;
671 struct uart_port *port = state->port;
672 unsigned long new_port;
673 unsigned int change_irq, change_port, closing_wait;
674 unsigned int old_custom_divisor, close_delay;
675 upf_t old_flags, new_flags;
678 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
681 new_port = new_serial.port;
682 if (HIGH_BITS_OFFSET)
683 new_port += (unsigned long) new_serial.port_high << HIGH_BITS_OFFSET;
685 new_serial.irq = irq_canonicalize(new_serial.irq);
686 close_delay = new_serial.close_delay * 10;
687 closing_wait = new_serial.closing_wait == ASYNC_CLOSING_WAIT_NONE ?
688 USF_CLOSING_WAIT_NONE : new_serial.closing_wait * 10;
691 * This semaphore protects state->count. It is also
692 * very useful to prevent opens. Also, take the
693 * port configuration semaphore to make sure that a
694 * module insertion/removal doesn't change anything
697 mutex_lock(&state->mutex);
699 change_irq = !(port->flags & UPF_FIXED_PORT)
700 && new_serial.irq != port->irq;
703 * Since changing the 'type' of the port changes its resource
704 * allocations, we should treat type changes the same as
707 change_port = !(port->flags & UPF_FIXED_PORT)
708 && (new_port != port->iobase ||
709 (unsigned long)new_serial.iomem_base != port->mapbase ||
710 new_serial.hub6 != port->hub6 ||
711 new_serial.io_type != port->iotype ||
712 new_serial.iomem_reg_shift != port->regshift ||
713 new_serial.type != port->type);
715 old_flags = port->flags;
716 new_flags = new_serial.flags;
717 old_custom_divisor = port->custom_divisor;
719 if (!capable(CAP_SYS_ADMIN)) {
721 if (change_irq || change_port ||
722 (new_serial.baud_base != port->uartclk / 16) ||
723 (close_delay != state->close_delay) ||
724 (closing_wait != state->closing_wait) ||
725 (new_serial.xmit_fifo_size &&
726 new_serial.xmit_fifo_size != port->fifosize) ||
727 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
729 port->flags = ((port->flags & ~UPF_USR_MASK) |
730 (new_flags & UPF_USR_MASK));
731 port->custom_divisor = new_serial.custom_divisor;
736 * Ask the low level driver to verify the settings.
738 if (port->ops->verify_port)
739 retval = port->ops->verify_port(port, &new_serial);
741 if ((new_serial.irq >= NR_IRQS) || (new_serial.irq < 0) ||
742 (new_serial.baud_base < 9600))
748 if (change_port || change_irq) {
752 * Make sure that we are the sole user of this port.
754 if (uart_users(state) > 1)
758 * We need to shutdown the serial port at the old
759 * port/type/irq combination.
761 uart_shutdown(state);
765 unsigned long old_iobase, old_mapbase;
766 unsigned int old_type, old_iotype, old_hub6, old_shift;
768 old_iobase = port->iobase;
769 old_mapbase = port->mapbase;
770 old_type = port->type;
771 old_hub6 = port->hub6;
772 old_iotype = port->iotype;
773 old_shift = port->regshift;
776 * Free and release old regions
778 if (old_type != PORT_UNKNOWN)
779 port->ops->release_port(port);
781 port->iobase = new_port;
782 port->type = new_serial.type;
783 port->hub6 = new_serial.hub6;
784 port->iotype = new_serial.io_type;
785 port->regshift = new_serial.iomem_reg_shift;
786 port->mapbase = (unsigned long)new_serial.iomem_base;
789 * Claim and map the new regions
791 if (port->type != PORT_UNKNOWN) {
792 retval = port->ops->request_port(port);
794 /* Always success - Jean II */
799 * If we fail to request resources for the
800 * new port, try to restore the old settings.
802 if (retval && old_type != PORT_UNKNOWN) {
803 port->iobase = old_iobase;
804 port->type = old_type;
805 port->hub6 = old_hub6;
806 port->iotype = old_iotype;
807 port->regshift = old_shift;
808 port->mapbase = old_mapbase;
809 retval = port->ops->request_port(port);
811 * If we failed to restore the old settings,
815 port->type = PORT_UNKNOWN;
821 /* Added to return the correct error -Ram Gupta */
827 port->irq = new_serial.irq;
828 if (!(port->flags & UPF_FIXED_PORT))
829 port->uartclk = new_serial.baud_base * 16;
830 port->flags = (port->flags & ~UPF_CHANGE_MASK) |
831 (new_flags & UPF_CHANGE_MASK);
832 port->custom_divisor = new_serial.custom_divisor;
833 state->close_delay = close_delay;
834 state->closing_wait = closing_wait;
835 if (new_serial.xmit_fifo_size)
836 port->fifosize = new_serial.xmit_fifo_size;
837 if (state->info->tty)
838 state->info->tty->low_latency =
839 (port->flags & UPF_LOW_LATENCY) ? 1 : 0;
843 if (port->type == PORT_UNKNOWN)
845 if (state->info->flags & UIF_INITIALIZED) {
846 if (((old_flags ^ port->flags) & UPF_SPD_MASK) ||
847 old_custom_divisor != port->custom_divisor) {
849 * If they're setting up a custom divisor or speed,
850 * instead of clearing it, then bitch about it. No
851 * need to rate-limit; it's CAP_SYS_ADMIN only.
853 if (port->flags & UPF_SPD_MASK) {
856 "%s sets custom speed on %s. This "
857 "is deprecated.\n", current->comm,
858 tty_name(state->info->tty, buf));
860 uart_change_speed(state, NULL);
863 retval = uart_startup(state, 1);
865 mutex_unlock(&state->mutex);
871 * uart_get_lsr_info - get line status register info.
872 * Note: uart_ioctl protects us against hangups.
874 static int uart_get_lsr_info(struct uart_state *state,
875 unsigned int __user *value)
877 struct uart_port *port = state->port;
880 result = port->ops->tx_empty(port);
883 * If we're about to load something into the transmit
884 * register, we'll pretend the transmitter isn't empty to
885 * avoid a race condition (depending on when the transmit
886 * interrupt happens).
889 ((uart_circ_chars_pending(&state->info->xmit) > 0) &&
890 !state->info->tty->stopped && !state->info->tty->hw_stopped))
891 result &= ~TIOCSER_TEMT;
893 return put_user(result, value);
896 static int uart_tiocmget(struct tty_struct *tty, struct file *file)
898 struct uart_state *state = tty->driver_data;
899 struct uart_port *port = state->port;
902 mutex_lock(&state->mutex);
903 if ((!file || !tty_hung_up_p(file)) &&
904 !(tty->flags & (1 << TTY_IO_ERROR))) {
905 result = port->mctrl;
907 spin_lock_irq(&port->lock);
908 result |= port->ops->get_mctrl(port);
909 spin_unlock_irq(&port->lock);
911 mutex_unlock(&state->mutex);
917 uart_tiocmset(struct tty_struct *tty, struct file *file,
918 unsigned int set, unsigned int clear)
920 struct uart_state *state = tty->driver_data;
921 struct uart_port *port = state->port;
924 mutex_lock(&state->mutex);
925 if ((!file || !tty_hung_up_p(file)) &&
926 !(tty->flags & (1 << TTY_IO_ERROR))) {
927 uart_update_mctrl(port, set, clear);
930 mutex_unlock(&state->mutex);
934 static void uart_break_ctl(struct tty_struct *tty, int break_state)
936 struct uart_state *state = tty->driver_data;
937 struct uart_port *port = state->port;
939 mutex_lock(&state->mutex);
941 if (port->type != PORT_UNKNOWN)
942 port->ops->break_ctl(port, break_state);
944 mutex_unlock(&state->mutex);
947 static int uart_do_autoconfig(struct uart_state *state)
949 struct uart_port *port = state->port;
952 if (!capable(CAP_SYS_ADMIN))
956 * Take the per-port semaphore. This prevents count from
957 * changing, and hence any extra opens of the port while
958 * we're auto-configuring.
960 if (mutex_lock_interruptible(&state->mutex))
964 if (uart_users(state) == 1) {
965 uart_shutdown(state);
968 * If we already have a port type configured,
969 * we must release its resources.
971 if (port->type != PORT_UNKNOWN)
972 port->ops->release_port(port);
974 flags = UART_CONFIG_TYPE;
975 if (port->flags & UPF_AUTO_IRQ)
976 flags |= UART_CONFIG_IRQ;
979 * This will claim the ports resources if
982 port->ops->config_port(port, flags);
984 ret = uart_startup(state, 1);
986 mutex_unlock(&state->mutex);
991 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
992 * - mask passed in arg for lines of interest
993 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
994 * Caller should use TIOCGICOUNT to see which one it was
997 uart_wait_modem_status(struct uart_state *state, unsigned long arg)
999 struct uart_port *port = state->port;
1000 DECLARE_WAITQUEUE(wait, current);
1001 struct uart_icount cprev, cnow;
1005 * note the counters on entry
1007 spin_lock_irq(&port->lock);
1008 memcpy(&cprev, &port->icount, sizeof(struct uart_icount));
1011 * Force modem status interrupts on
1013 port->ops->enable_ms(port);
1014 spin_unlock_irq(&port->lock);
1016 add_wait_queue(&state->info->delta_msr_wait, &wait);
1018 spin_lock_irq(&port->lock);
1019 memcpy(&cnow, &port->icount, sizeof(struct uart_icount));
1020 spin_unlock_irq(&port->lock);
1022 set_current_state(TASK_INTERRUPTIBLE);
1024 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1025 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1026 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1027 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1034 /* see if a signal did it */
1035 if (signal_pending(current)) {
1043 current->state = TASK_RUNNING;
1044 remove_wait_queue(&state->info->delta_msr_wait, &wait);
1050 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1051 * Return: write counters to the user passed counter struct
1052 * NB: both 1->0 and 0->1 transitions are counted except for
1053 * RI where only 0->1 is counted.
1055 static int uart_get_count(struct uart_state *state,
1056 struct serial_icounter_struct __user *icnt)
1058 struct serial_icounter_struct icount;
1059 struct uart_icount cnow;
1060 struct uart_port *port = state->port;
1062 spin_lock_irq(&port->lock);
1063 memcpy(&cnow, &port->icount, sizeof(struct uart_icount));
1064 spin_unlock_irq(&port->lock);
1066 icount.cts = cnow.cts;
1067 icount.dsr = cnow.dsr;
1068 icount.rng = cnow.rng;
1069 icount.dcd = cnow.dcd;
1070 icount.rx = cnow.rx;
1071 icount.tx = cnow.tx;
1072 icount.frame = cnow.frame;
1073 icount.overrun = cnow.overrun;
1074 icount.parity = cnow.parity;
1075 icount.brk = cnow.brk;
1076 icount.buf_overrun = cnow.buf_overrun;
1078 return copy_to_user(icnt, &icount, sizeof(icount)) ? -EFAULT : 0;
1082 * Called via sys_ioctl. We can use spin_lock_irq() here.
1085 uart_ioctl(struct tty_struct *tty, struct file *filp, unsigned int cmd,
1088 struct uart_state *state = tty->driver_data;
1089 void __user *uarg = (void __user *)arg;
1090 int ret = -ENOIOCTLCMD;
1094 * These ioctls don't rely on the hardware to be present.
1098 ret = uart_get_info(state, uarg);
1102 ret = uart_set_info(state, uarg);
1106 ret = uart_do_autoconfig(state);
1109 case TIOCSERGWILD: /* obsolete */
1110 case TIOCSERSWILD: /* obsolete */
1115 if (ret != -ENOIOCTLCMD)
1118 if (tty->flags & (1 << TTY_IO_ERROR)) {
1124 * The following should only be used when hardware is present.
1128 ret = uart_wait_modem_status(state, arg);
1132 ret = uart_get_count(state, uarg);
1136 if (ret != -ENOIOCTLCMD)
1139 mutex_lock(&state->mutex);
1141 if (tty_hung_up_p(filp)) {
1147 * All these rely on hardware being present and need to be
1148 * protected against the tty being hung up.
1151 case TIOCSERGETLSR: /* Get line status register */
1152 ret = uart_get_lsr_info(state, uarg);
1156 struct uart_port *port = state->port;
1157 if (port->ops->ioctl)
1158 ret = port->ops->ioctl(port, cmd, arg);
1163 mutex_unlock(&state->mutex);
1168 static void uart_set_ldisc(struct tty_struct *tty)
1170 struct uart_state *state = tty->driver_data;
1171 struct uart_port *port = state->port;
1173 if (port->ops->set_ldisc)
1174 port->ops->set_ldisc(port);
1177 static void uart_set_termios(struct tty_struct *tty,
1178 struct ktermios *old_termios)
1180 struct uart_state *state = tty->driver_data;
1181 unsigned long flags;
1182 unsigned int cflag = tty->termios->c_cflag;
1186 * These are the bits that are used to setup various
1187 * flags in the low level driver. We can ignore the Bfoo
1188 * bits in c_cflag; c_[io]speed will always be set
1189 * appropriately by set_termios() in tty_ioctl.c
1191 #define RELEVANT_IFLAG(iflag) ((iflag) & (IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK))
1192 if ((cflag ^ old_termios->c_cflag) == 0 &&
1193 tty->termios->c_ospeed == old_termios->c_ospeed &&
1194 tty->termios->c_ispeed == old_termios->c_ispeed &&
1195 RELEVANT_IFLAG(tty->termios->c_iflag ^ old_termios->c_iflag) == 0) {
1199 uart_change_speed(state, old_termios);
1201 /* Handle transition to B0 status */
1202 if ((old_termios->c_cflag & CBAUD) && !(cflag & CBAUD))
1203 uart_clear_mctrl(state->port, TIOCM_RTS | TIOCM_DTR);
1205 /* Handle transition away from B0 status */
1206 if (!(old_termios->c_cflag & CBAUD) && (cflag & CBAUD)) {
1207 unsigned int mask = TIOCM_DTR;
1208 if (!(cflag & CRTSCTS) ||
1209 !test_bit(TTY_THROTTLED, &tty->flags))
1211 uart_set_mctrl(state->port, mask);
1214 /* Handle turning off CRTSCTS */
1215 if ((old_termios->c_cflag & CRTSCTS) && !(cflag & CRTSCTS)) {
1216 spin_lock_irqsave(&state->port->lock, flags);
1217 tty->hw_stopped = 0;
1219 spin_unlock_irqrestore(&state->port->lock, flags);
1222 /* Handle turning on CRTSCTS */
1223 if (!(old_termios->c_cflag & CRTSCTS) && (cflag & CRTSCTS)) {
1224 spin_lock_irqsave(&state->port->lock, flags);
1225 if (!(state->port->ops->get_mctrl(state->port) & TIOCM_CTS)) {
1226 tty->hw_stopped = 1;
1227 state->port->ops->stop_tx(state->port);
1229 spin_unlock_irqrestore(&state->port->lock, flags);
1233 * No need to wake up processes in open wait, since they
1234 * sample the CLOCAL flag once, and don't recheck it.
1235 * XXX It's not clear whether the current behavior is correct
1236 * or not. Hence, this may change.....
1238 if (!(old_termios->c_cflag & CLOCAL) &&
1239 (tty->termios->c_cflag & CLOCAL))
1240 wake_up_interruptible(&state->info->open_wait);
1245 * In 2.4.5, calls to this will be serialized via the BKL in
1246 * linux/drivers/char/tty_io.c:tty_release()
1247 * linux/drivers/char/tty_io.c:do_tty_handup()
1249 static void uart_close(struct tty_struct *tty, struct file *filp)
1251 struct uart_state *state = tty->driver_data;
1252 struct uart_port *port;
1254 BUG_ON(!kernel_locked());
1256 if (!state || !state->port)
1261 pr_debug("uart_close(%d) called\n", port->line);
1263 mutex_lock(&state->mutex);
1265 if (tty_hung_up_p(filp))
1268 if ((tty->count == 1) && (state->count != 1)) {
1270 * Uh, oh. tty->count is 1, which means that the tty
1271 * structure will be freed. state->count should always
1272 * be one in these conditions. If it's greater than
1273 * one, we've got real problems, since it means the
1274 * serial port won't be shutdown.
1276 printk(KERN_ERR "uart_close: bad serial port count; tty->count is 1, "
1277 "state->count is %d\n", state->count);
1280 if (--state->count < 0) {
1281 printk(KERN_ERR "uart_close: bad serial port count for %s: %d\n",
1282 tty->name, state->count);
1289 * Now we wait for the transmit buffer to clear; and we notify
1290 * the line discipline to only process XON/XOFF characters by
1291 * setting tty->closing.
1295 if (state->closing_wait != USF_CLOSING_WAIT_NONE)
1296 tty_wait_until_sent(tty, msecs_to_jiffies(state->closing_wait));
1299 * At this point, we stop accepting input. To do this, we
1300 * disable the receive line status interrupts.
1302 if (state->info->flags & UIF_INITIALIZED) {
1303 unsigned long flags;
1304 spin_lock_irqsave(&port->lock, flags);
1305 port->ops->stop_rx(port);
1306 spin_unlock_irqrestore(&port->lock, flags);
1308 * Before we drop DTR, make sure the UART transmitter
1309 * has completely drained; this is especially
1310 * important if there is a transmit FIFO!
1312 uart_wait_until_sent(tty, port->timeout);
1315 uart_shutdown(state);
1316 uart_flush_buffer(tty);
1318 tty_ldisc_flush(tty);
1321 state->info->tty = NULL;
1323 if (state->info->blocked_open) {
1324 if (state->close_delay)
1325 msleep_interruptible(state->close_delay);
1326 } else if (!uart_console(port)) {
1327 uart_change_pm(state, 3);
1331 * Wake up anyone trying to open this port.
1333 state->info->flags &= ~UIF_NORMAL_ACTIVE;
1334 wake_up_interruptible(&state->info->open_wait);
1337 mutex_unlock(&state->mutex);
1340 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1342 struct uart_state *state = tty->driver_data;
1343 struct uart_port *port = state->port;
1344 unsigned long char_time, expire;
1346 if (port->type == PORT_UNKNOWN || port->fifosize == 0)
1352 * Set the check interval to be 1/5 of the estimated time to
1353 * send a single character, and make it at least 1. The check
1354 * interval should also be less than the timeout.
1356 * Note: we have to use pretty tight timings here to satisfy
1359 char_time = (port->timeout - HZ/50) / port->fifosize;
1360 char_time = char_time / 5;
1363 if (timeout && timeout < char_time)
1364 char_time = timeout;
1367 * If the transmitter hasn't cleared in twice the approximate
1368 * amount of time to send the entire FIFO, it probably won't
1369 * ever clear. This assumes the UART isn't doing flow
1370 * control, which is currently the case. Hence, if it ever
1371 * takes longer than port->timeout, this is probably due to a
1372 * UART bug of some kind. So, we clamp the timeout parameter at
1375 if (timeout == 0 || timeout > 2 * port->timeout)
1376 timeout = 2 * port->timeout;
1378 expire = jiffies + timeout;
1380 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1381 port->line, jiffies, expire);
1384 * Check whether the transmitter is empty every 'char_time'.
1385 * 'timeout' / 'expire' give us the maximum amount of time
1388 while (!port->ops->tx_empty(port)) {
1389 msleep_interruptible(jiffies_to_msecs(char_time));
1390 if (signal_pending(current))
1392 if (time_after(jiffies, expire))
1395 set_current_state(TASK_RUNNING); /* might not be needed */
1400 * This is called with the BKL held in
1401 * linux/drivers/char/tty_io.c:do_tty_hangup()
1402 * We're called from the eventd thread, so we can sleep for
1403 * a _short_ time only.
1405 static void uart_hangup(struct tty_struct *tty)
1407 struct uart_state *state = tty->driver_data;
1409 BUG_ON(!kernel_locked());
1410 pr_debug("uart_hangup(%d)\n", state->port->line);
1412 mutex_lock(&state->mutex);
1413 if (state->info && state->info->flags & UIF_NORMAL_ACTIVE) {
1414 uart_flush_buffer(tty);
1415 uart_shutdown(state);
1417 state->info->flags &= ~UIF_NORMAL_ACTIVE;
1418 state->info->tty = NULL;
1419 wake_up_interruptible(&state->info->open_wait);
1420 wake_up_interruptible(&state->info->delta_msr_wait);
1422 mutex_unlock(&state->mutex);
1426 * Copy across the serial console cflag setting into the termios settings
1427 * for the initial open of the port. This allows continuity between the
1428 * kernel settings, and the settings init adopts when it opens the port
1429 * for the first time.
1431 static void uart_update_termios(struct uart_state *state)
1433 struct tty_struct *tty = state->info->tty;
1434 struct uart_port *port = state->port;
1436 if (uart_console(port) && port->cons->cflag) {
1437 tty->termios->c_cflag = port->cons->cflag;
1438 port->cons->cflag = 0;
1442 * If the device failed to grab its irq resources,
1443 * or some other error occurred, don't try to talk
1444 * to the port hardware.
1446 if (!(tty->flags & (1 << TTY_IO_ERROR))) {
1448 * Make termios settings take effect.
1450 uart_change_speed(state, NULL);
1453 * And finally enable the RTS and DTR signals.
1455 if (tty->termios->c_cflag & CBAUD)
1456 uart_set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
1461 * Block the open until the port is ready. We must be called with
1462 * the per-port semaphore held.
1465 uart_block_til_ready(struct file *filp, struct uart_state *state)
1467 DECLARE_WAITQUEUE(wait, current);
1468 struct uart_info *info = state->info;
1469 struct uart_port *port = state->port;
1472 info->blocked_open++;
1475 add_wait_queue(&info->open_wait, &wait);
1477 set_current_state(TASK_INTERRUPTIBLE);
1480 * If we have been hung up, tell userspace/restart open.
1482 if (tty_hung_up_p(filp) || info->tty == NULL)
1486 * If the port has been closed, tell userspace/restart open.
1488 if (!(info->flags & UIF_INITIALIZED))
1492 * If non-blocking mode is set, or CLOCAL mode is set,
1493 * we don't want to wait for the modem status lines to
1494 * indicate that the port is ready.
1496 * Also, if the port is not enabled/configured, we want
1497 * to allow the open to succeed here. Note that we will
1498 * have set TTY_IO_ERROR for a non-existant port.
1500 if ((filp->f_flags & O_NONBLOCK) ||
1501 (info->tty->termios->c_cflag & CLOCAL) ||
1502 (info->tty->flags & (1 << TTY_IO_ERROR)))
1506 * Set DTR to allow modem to know we're waiting. Do
1507 * not set RTS here - we want to make sure we catch
1508 * the data from the modem.
1510 if (info->tty->termios->c_cflag & CBAUD)
1511 uart_set_mctrl(port, TIOCM_DTR);
1514 * and wait for the carrier to indicate that the
1515 * modem is ready for us.
1517 spin_lock_irq(&port->lock);
1518 port->ops->enable_ms(port);
1519 mctrl = port->ops->get_mctrl(port);
1520 spin_unlock_irq(&port->lock);
1521 if (mctrl & TIOCM_CAR)
1524 mutex_unlock(&state->mutex);
1526 mutex_lock(&state->mutex);
1528 if (signal_pending(current))
1531 set_current_state(TASK_RUNNING);
1532 remove_wait_queue(&info->open_wait, &wait);
1535 info->blocked_open--;
1537 if (signal_pending(current))
1538 return -ERESTARTSYS;
1540 if (!info->tty || tty_hung_up_p(filp))
1546 static struct uart_state *uart_get(struct uart_driver *drv, int line)
1548 struct uart_state *state;
1551 state = drv->state + line;
1552 if (mutex_lock_interruptible(&state->mutex)) {
1558 if (!state->port || state->port->flags & UPF_DEAD) {
1564 state->info = kzalloc(sizeof(struct uart_info), GFP_KERNEL);
1566 init_waitqueue_head(&state->info->open_wait);
1567 init_waitqueue_head(&state->info->delta_msr_wait);
1570 * Link the info into the other structures.
1572 state->port->info = state->info;
1574 tasklet_init(&state->info->tlet, uart_tasklet_action,
1575 (unsigned long)state);
1585 mutex_unlock(&state->mutex);
1587 return ERR_PTR(ret);
1591 * calls to uart_open are serialised by the BKL in
1592 * fs/char_dev.c:chrdev_open()
1593 * Note that if this fails, then uart_close() _will_ be called.
1595 * In time, we want to scrap the "opening nonpresent ports"
1596 * behaviour and implement an alternative way for setserial
1597 * to set base addresses/ports/types. This will allow us to
1598 * get rid of a certain amount of extra tests.
1600 static int uart_open(struct tty_struct *tty, struct file *filp)
1602 struct uart_driver *drv = (struct uart_driver *)tty->driver->driver_state;
1603 struct uart_state *state;
1604 int retval, line = tty->index;
1606 BUG_ON(!kernel_locked());
1607 pr_debug("uart_open(%d) called\n", line);
1610 * tty->driver->num won't change, so we won't fail here with
1611 * tty->driver_data set to something non-NULL (and therefore
1612 * we won't get caught by uart_close()).
1615 if (line >= tty->driver->num)
1619 * We take the semaphore inside uart_get to guarantee that we won't
1620 * be re-entered while allocating the info structure, or while we
1621 * request any IRQs that the driver may need. This also has the nice
1622 * side-effect that it delays the action of uart_hangup, so we can
1623 * guarantee that info->tty will always contain something reasonable.
1625 state = uart_get(drv, line);
1626 if (IS_ERR(state)) {
1627 retval = PTR_ERR(state);
1632 * Once we set tty->driver_data here, we are guaranteed that
1633 * uart_close() will decrement the driver module use count.
1634 * Any failures from here onwards should not touch the count.
1636 tty->driver_data = state;
1637 tty->low_latency = (state->port->flags & UPF_LOW_LATENCY) ? 1 : 0;
1639 state->info->tty = tty;
1642 * If the port is in the middle of closing, bail out now.
1644 if (tty_hung_up_p(filp)) {
1647 mutex_unlock(&state->mutex);
1652 * Make sure the device is in D0 state.
1654 if (state->count == 1)
1655 uart_change_pm(state, 0);
1658 * Start up the serial port.
1660 retval = uart_startup(state, 0);
1663 * If we succeeded, wait until the port is ready.
1666 retval = uart_block_til_ready(filp, state);
1667 mutex_unlock(&state->mutex);
1670 * If this is the first open to succeed, adjust things to suit.
1672 if (retval == 0 && !(state->info->flags & UIF_NORMAL_ACTIVE)) {
1673 state->info->flags |= UIF_NORMAL_ACTIVE;
1675 uart_update_termios(state);
1682 static const char *uart_type(struct uart_port *port)
1684 const char *str = NULL;
1686 if (port->ops->type)
1687 str = port->ops->type(port);
1695 #ifdef CONFIG_PROC_FS
1697 static int uart_line_info(char *buf, struct uart_driver *drv, int i)
1699 struct uart_state *state = drv->state + i;
1701 struct uart_port *port = state->port;
1703 unsigned int status;
1709 mmio = port->iotype >= UPIO_MEM;
1710 ret = sprintf(buf, "%d: uart:%s %s%08llX irq:%d",
1711 port->line, uart_type(port),
1712 mmio ? "mmio:0x" : "port:",
1713 mmio ? (unsigned long long)port->mapbase
1714 : (unsigned long long) port->iobase,
1717 if (port->type == PORT_UNKNOWN) {
1722 if (capable(CAP_SYS_ADMIN)) {
1723 mutex_lock(&state->mutex);
1724 pm_state = state->pm_state;
1726 uart_change_pm(state, 0);
1727 spin_lock_irq(&port->lock);
1728 status = port->ops->get_mctrl(port);
1729 spin_unlock_irq(&port->lock);
1731 uart_change_pm(state, pm_state);
1732 mutex_unlock(&state->mutex);
1734 ret += sprintf(buf + ret, " tx:%d rx:%d",
1735 port->icount.tx, port->icount.rx);
1736 if (port->icount.frame)
1737 ret += sprintf(buf + ret, " fe:%d",
1738 port->icount.frame);
1739 if (port->icount.parity)
1740 ret += sprintf(buf + ret, " pe:%d",
1741 port->icount.parity);
1742 if (port->icount.brk)
1743 ret += sprintf(buf + ret, " brk:%d",
1745 if (port->icount.overrun)
1746 ret += sprintf(buf + ret, " oe:%d",
1747 port->icount.overrun);
1749 #define INFOBIT(bit, str) \
1750 if (port->mctrl & (bit)) \
1751 strncat(stat_buf, (str), sizeof(stat_buf) - \
1752 strlen(stat_buf) - 2)
1753 #define STATBIT(bit, str) \
1754 if (status & (bit)) \
1755 strncat(stat_buf, (str), sizeof(stat_buf) - \
1756 strlen(stat_buf) - 2)
1760 INFOBIT(TIOCM_RTS, "|RTS");
1761 STATBIT(TIOCM_CTS, "|CTS");
1762 INFOBIT(TIOCM_DTR, "|DTR");
1763 STATBIT(TIOCM_DSR, "|DSR");
1764 STATBIT(TIOCM_CAR, "|CD");
1765 STATBIT(TIOCM_RNG, "|RI");
1768 strcat(stat_buf, "\n");
1770 ret += sprintf(buf + ret, stat_buf);
1780 static int uart_read_proc(char *page, char **start, off_t off,
1781 int count, int *eof, void *data)
1783 struct tty_driver *ttydrv = data;
1784 struct uart_driver *drv = ttydrv->driver_state;
1788 len += sprintf(page, "serinfo:1.0 driver%s%s revision:%s\n",
1790 for (i = 0; i < drv->nr && len < PAGE_SIZE - 96; i++) {
1791 l = uart_line_info(page + len, drv, i);
1793 if (len + begin > off + count)
1795 if (len + begin < off) {
1802 if (off >= len + begin)
1804 *start = page + (off - begin);
1805 return (count < begin + len - off) ? count : (begin + len - off);
1809 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1811 * uart_console_write - write a console message to a serial port
1812 * @port: the port to write the message
1813 * @s: array of characters
1814 * @count: number of characters in string to write
1815 * @write: function to write character to port
1817 void uart_console_write(struct uart_port *port, const char *s,
1819 void (*putchar)(struct uart_port *, int))
1823 for (i = 0; i < count; i++, s++) {
1825 putchar(port, '\r');
1829 EXPORT_SYMBOL_GPL(uart_console_write);
1832 * Check whether an invalid uart number has been specified, and
1833 * if so, search for the first available port that does have
1836 struct uart_port * __init
1837 uart_get_console(struct uart_port *ports, int nr, struct console *co)
1839 int idx = co->index;
1841 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
1842 ports[idx].membase == NULL))
1843 for (idx = 0; idx < nr; idx++)
1844 if (ports[idx].iobase != 0 ||
1845 ports[idx].membase != NULL)
1854 * uart_parse_options - Parse serial port baud/parity/bits/flow contro.
1855 * @options: pointer to option string
1856 * @baud: pointer to an 'int' variable for the baud rate.
1857 * @parity: pointer to an 'int' variable for the parity.
1858 * @bits: pointer to an 'int' variable for the number of data bits.
1859 * @flow: pointer to an 'int' variable for the flow control character.
1861 * uart_parse_options decodes a string containing the serial console
1862 * options. The format of the string is <baud><parity><bits><flow>,
1866 uart_parse_options(char *options, int *baud, int *parity, int *bits, int *flow)
1870 *baud = simple_strtoul(s, NULL, 10);
1871 while (*s >= '0' && *s <= '9')
1880 EXPORT_SYMBOL_GPL(uart_parse_options);
1887 static const struct baud_rates baud_rates[] = {
1888 { 921600, B921600 },
1889 { 460800, B460800 },
1890 { 230400, B230400 },
1891 { 115200, B115200 },
1903 * uart_set_options - setup the serial console parameters
1904 * @port: pointer to the serial ports uart_port structure
1905 * @co: console pointer
1907 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1908 * @bits: number of data bits
1909 * @flow: flow control character - 'r' (rts)
1912 uart_set_options(struct uart_port *port, struct console *co,
1913 int baud, int parity, int bits, int flow)
1915 struct ktermios termios;
1916 static struct ktermios dummy;
1920 * Ensure that the serial console lock is initialised
1923 spin_lock_init(&port->lock);
1924 lockdep_set_class(&port->lock, &port_lock_key);
1926 memset(&termios, 0, sizeof(struct ktermios));
1928 termios.c_cflag = CREAD | HUPCL | CLOCAL;
1931 * Construct a cflag setting.
1933 for (i = 0; baud_rates[i].rate; i++)
1934 if (baud_rates[i].rate <= baud)
1937 termios.c_cflag |= baud_rates[i].cflag;
1940 termios.c_cflag |= CS7;
1942 termios.c_cflag |= CS8;
1946 termios.c_cflag |= PARODD;
1949 termios.c_cflag |= PARENB;
1954 termios.c_cflag |= CRTSCTS;
1957 * some uarts on other side don't support no flow control.
1958 * So we set * DTR in host uart to make them happy
1960 port->mctrl |= TIOCM_DTR;
1962 port->ops->set_termios(port, &termios, &dummy);
1964 * Allow the setting of the UART parameters with a NULL console
1968 co->cflag = termios.c_cflag;
1972 EXPORT_SYMBOL_GPL(uart_set_options);
1973 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
1975 static void uart_change_pm(struct uart_state *state, int pm_state)
1977 struct uart_port *port = state->port;
1979 if (state->pm_state != pm_state) {
1981 port->ops->pm(port, pm_state, state->pm_state);
1982 state->pm_state = pm_state;
1987 struct uart_port *port;
1988 struct uart_driver *driver;
1991 static int serial_match_port(struct device *dev, void *data)
1993 struct uart_match *match = data;
1994 struct tty_driver *tty_drv = match->driver->tty_driver;
1995 dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
1998 return dev->devt == devt; /* Actually, only one tty per port */
2001 int uart_suspend_port(struct uart_driver *drv, struct uart_port *port)
2003 struct uart_state *state = drv->state + port->line;
2004 struct device *tty_dev;
2005 struct uart_match match = {port, drv};
2007 mutex_lock(&state->mutex);
2009 if (!console_suspend_enabled && uart_console(port)) {
2010 /* we're going to avoid suspending serial console */
2011 mutex_unlock(&state->mutex);
2015 tty_dev = device_find_child(port->dev, &match, serial_match_port);
2016 if (device_may_wakeup(tty_dev)) {
2017 enable_irq_wake(port->irq);
2018 put_device(tty_dev);
2019 mutex_unlock(&state->mutex);
2022 port->suspended = 1;
2024 if (state->info && state->info->flags & UIF_INITIALIZED) {
2025 const struct uart_ops *ops = port->ops;
2028 state->info->flags = (state->info->flags & ~UIF_INITIALIZED)
2031 spin_lock_irq(&port->lock);
2033 ops->set_mctrl(port, 0);
2035 spin_unlock_irq(&port->lock);
2038 * Wait for the transmitter to empty.
2040 for (tries = 3; !ops->tx_empty(port) && tries; tries--)
2043 printk(KERN_ERR "%s%s%s%d: Unable to drain "
2045 port->dev ? port->dev->bus_id : "",
2046 port->dev ? ": " : "",
2047 drv->dev_name, port->line);
2049 ops->shutdown(port);
2053 * Disable the console device before suspending.
2055 if (uart_console(port))
2056 console_stop(port->cons);
2058 uart_change_pm(state, 3);
2060 mutex_unlock(&state->mutex);
2065 int uart_resume_port(struct uart_driver *drv, struct uart_port *port)
2067 struct uart_state *state = drv->state + port->line;
2068 struct device *tty_dev;
2069 struct uart_match match = {port, drv};
2071 mutex_lock(&state->mutex);
2073 if (!console_suspend_enabled && uart_console(port)) {
2074 /* no need to resume serial console, it wasn't suspended */
2075 mutex_unlock(&state->mutex);
2079 tty_dev = device_find_child(port->dev, &match, serial_match_port);
2080 if (!port->suspended && device_may_wakeup(tty_dev)) {
2081 disable_irq_wake(port->irq);
2082 mutex_unlock(&state->mutex);
2085 port->suspended = 0;
2088 * Re-enable the console device after suspending.
2090 if (uart_console(port)) {
2091 struct ktermios termios;
2094 * First try to use the console cflag setting.
2096 memset(&termios, 0, sizeof(struct ktermios));
2097 termios.c_cflag = port->cons->cflag;
2100 * If that's unset, use the tty termios setting.
2102 if (state->info && state->info->tty && termios.c_cflag == 0)
2103 termios = *state->info->tty->termios;
2105 uart_change_pm(state, 0);
2106 port->ops->set_termios(port, &termios, NULL);
2107 console_start(port->cons);
2110 if (state->info && state->info->flags & UIF_SUSPENDED) {
2111 const struct uart_ops *ops = port->ops;
2114 uart_change_pm(state, 0);
2115 spin_lock_irq(&port->lock);
2116 ops->set_mctrl(port, 0);
2117 spin_unlock_irq(&port->lock);
2118 ret = ops->startup(port);
2120 uart_change_speed(state, NULL);
2121 spin_lock_irq(&port->lock);
2122 ops->set_mctrl(port, port->mctrl);
2123 ops->start_tx(port);
2124 spin_unlock_irq(&port->lock);
2125 state->info->flags |= UIF_INITIALIZED;
2128 * Failed to resume - maybe hardware went away?
2129 * Clear the "initialized" flag so we won't try
2130 * to call the low level drivers shutdown method.
2132 uart_shutdown(state);
2135 state->info->flags &= ~UIF_SUSPENDED;
2138 mutex_unlock(&state->mutex);
2144 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2148 switch (port->iotype) {
2150 snprintf(address, sizeof(address),
2151 "I/O 0x%x", port->iobase);
2154 snprintf(address, sizeof(address),
2155 "I/O 0x%x offset 0x%x", port->iobase, port->hub6);
2162 snprintf(address, sizeof(address),
2163 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2166 strlcpy(address, "*unknown*", sizeof(address));
2170 printk(KERN_INFO "%s%s%s%d at %s (irq = %d) is a %s\n",
2171 port->dev ? port->dev->bus_id : "",
2172 port->dev ? ": " : "",
2173 drv->dev_name, port->line, address, port->irq, uart_type(port));
2177 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2178 struct uart_port *port)
2183 * If there isn't a port here, don't do anything further.
2185 if (!port->iobase && !port->mapbase && !port->membase)
2189 * Now do the auto configuration stuff. Note that config_port
2190 * is expected to claim the resources and map the port for us.
2192 flags = UART_CONFIG_TYPE;
2193 if (port->flags & UPF_AUTO_IRQ)
2194 flags |= UART_CONFIG_IRQ;
2195 if (port->flags & UPF_BOOT_AUTOCONF) {
2196 port->type = PORT_UNKNOWN;
2197 port->ops->config_port(port, flags);
2200 if (port->type != PORT_UNKNOWN) {
2201 unsigned long flags;
2203 uart_report_port(drv, port);
2205 /* Power up port for set_mctrl() */
2206 uart_change_pm(state, 0);
2209 * Ensure that the modem control lines are de-activated.
2210 * keep the DTR setting that is set in uart_set_options()
2211 * We probably don't need a spinlock around this, but
2213 spin_lock_irqsave(&port->lock, flags);
2214 port->ops->set_mctrl(port, port->mctrl & TIOCM_DTR);
2215 spin_unlock_irqrestore(&port->lock, flags);
2218 * If this driver supports console, and it hasn't been
2219 * successfully registered yet, try to re-register it.
2220 * It may be that the port was not available.
2222 if (port->cons && !(port->cons->flags & CON_ENABLED))
2223 register_console(port->cons);
2226 * Power down all ports by default, except the
2227 * console if we have one.
2229 if (!uart_console(port))
2230 uart_change_pm(state, 3);
2234 #ifdef CONFIG_CONSOLE_POLL
2236 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2238 struct uart_driver *drv = driver->driver_state;
2239 struct uart_state *state = drv->state + line;
2240 struct uart_port *port;
2246 if (!state || !state->port)
2250 if (!(port->ops->poll_get_char && port->ops->poll_put_char))
2254 uart_parse_options(options, &baud, &parity, &bits, &flow);
2255 return uart_set_options(port, NULL, baud, parity, bits, flow);
2261 static int uart_poll_get_char(struct tty_driver *driver, int line)
2263 struct uart_driver *drv = driver->driver_state;
2264 struct uart_state *state = drv->state + line;
2265 struct uart_port *port;
2267 if (!state || !state->port)
2271 return port->ops->poll_get_char(port);
2274 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2276 struct uart_driver *drv = driver->driver_state;
2277 struct uart_state *state = drv->state + line;
2278 struct uart_port *port;
2280 if (!state || !state->port)
2284 port->ops->poll_put_char(port, ch);
2288 static const struct tty_operations uart_ops = {
2290 .close = uart_close,
2291 .write = uart_write,
2292 .put_char = uart_put_char,
2293 .flush_chars = uart_flush_chars,
2294 .write_room = uart_write_room,
2295 .chars_in_buffer= uart_chars_in_buffer,
2296 .flush_buffer = uart_flush_buffer,
2297 .ioctl = uart_ioctl,
2298 .throttle = uart_throttle,
2299 .unthrottle = uart_unthrottle,
2300 .send_xchar = uart_send_xchar,
2301 .set_termios = uart_set_termios,
2302 .set_ldisc = uart_set_ldisc,
2304 .start = uart_start,
2305 .hangup = uart_hangup,
2306 .break_ctl = uart_break_ctl,
2307 .wait_until_sent= uart_wait_until_sent,
2308 #ifdef CONFIG_PROC_FS
2309 .read_proc = uart_read_proc,
2311 .tiocmget = uart_tiocmget,
2312 .tiocmset = uart_tiocmset,
2313 #ifdef CONFIG_CONSOLE_POLL
2314 .poll_init = uart_poll_init,
2315 .poll_get_char = uart_poll_get_char,
2316 .poll_put_char = uart_poll_put_char,
2321 * uart_register_driver - register a driver with the uart core layer
2322 * @drv: low level driver structure
2324 * Register a uart driver with the core driver. We in turn register
2325 * with the tty layer, and initialise the core driver per-port state.
2327 * We have a proc file in /proc/tty/driver which is named after the
2330 * drv->port should be NULL, and the per-port structures should be
2331 * registered using uart_add_one_port after this call has succeeded.
2333 int uart_register_driver(struct uart_driver *drv)
2335 struct tty_driver *normal = NULL;
2341 * Maybe we should be using a slab cache for this, especially if
2342 * we have a large number of ports to handle.
2344 drv->state = kzalloc(sizeof(struct uart_state) * drv->nr, GFP_KERNEL);
2349 normal = alloc_tty_driver(drv->nr);
2353 drv->tty_driver = normal;
2355 normal->owner = drv->owner;
2356 normal->driver_name = drv->driver_name;
2357 normal->name = drv->dev_name;
2358 normal->major = drv->major;
2359 normal->minor_start = drv->minor;
2360 normal->type = TTY_DRIVER_TYPE_SERIAL;
2361 normal->subtype = SERIAL_TYPE_NORMAL;
2362 normal->init_termios = tty_std_termios;
2363 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2364 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2365 normal->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2366 normal->driver_state = drv;
2367 tty_set_operations(normal, &uart_ops);
2370 * Initialise the UART state(s).
2372 for (i = 0; i < drv->nr; i++) {
2373 struct uart_state *state = drv->state + i;
2375 state->close_delay = 500; /* .5 seconds */
2376 state->closing_wait = 30000; /* 30 seconds */
2378 mutex_init(&state->mutex);
2381 retval = tty_register_driver(normal);
2384 put_tty_driver(normal);
2391 * uart_unregister_driver - remove a driver from the uart core layer
2392 * @drv: low level driver structure
2394 * Remove all references to a driver from the core driver. The low
2395 * level driver must have removed all its ports via the
2396 * uart_remove_one_port() if it registered them with uart_add_one_port().
2397 * (ie, drv->port == NULL)
2399 void uart_unregister_driver(struct uart_driver *drv)
2401 struct tty_driver *p = drv->tty_driver;
2402 tty_unregister_driver(p);
2405 drv->tty_driver = NULL;
2408 struct tty_driver *uart_console_device(struct console *co, int *index)
2410 struct uart_driver *p = co->data;
2412 return p->tty_driver;
2416 * uart_add_one_port - attach a driver-defined port structure
2417 * @drv: pointer to the uart low level driver structure for this port
2418 * @port: uart port structure to use for this port.
2420 * This allows the driver to register its own uart_port structure
2421 * with the core driver. The main purpose is to allow the low
2422 * level uart drivers to expand uart_port, rather than having yet
2423 * more levels of structures.
2425 int uart_add_one_port(struct uart_driver *drv, struct uart_port *port)
2427 struct uart_state *state;
2429 struct device *tty_dev;
2431 BUG_ON(in_interrupt());
2433 if (port->line >= drv->nr)
2436 state = drv->state + port->line;
2438 mutex_lock(&port_mutex);
2439 mutex_lock(&state->mutex);
2446 state->pm_state = -1;
2448 port->cons = drv->cons;
2449 port->info = state->info;
2452 * If this port is a console, then the spinlock is already
2455 if (!(uart_console(port) && (port->cons->flags & CON_ENABLED))) {
2456 spin_lock_init(&port->lock);
2457 lockdep_set_class(&port->lock, &port_lock_key);
2460 uart_configure_port(drv, state, port);
2463 * Register the port whether it's detected or not. This allows
2464 * setserial to be used to alter this ports parameters.
2466 tty_dev = tty_register_device(drv->tty_driver, port->line, port->dev);
2467 if (likely(!IS_ERR(tty_dev))) {
2468 device_init_wakeup(tty_dev, 1);
2469 device_set_wakeup_enable(tty_dev, 0);
2471 printk(KERN_ERR "Cannot register tty device on line %d\n",
2475 * Ensure UPF_DEAD is not set.
2477 port->flags &= ~UPF_DEAD;
2480 mutex_unlock(&state->mutex);
2481 mutex_unlock(&port_mutex);
2487 * uart_remove_one_port - detach a driver defined port structure
2488 * @drv: pointer to the uart low level driver structure for this port
2489 * @port: uart port structure for this port
2491 * This unhooks (and hangs up) the specified port structure from the
2492 * core driver. No further calls will be made to the low-level code
2495 int uart_remove_one_port(struct uart_driver *drv, struct uart_port *port)
2497 struct uart_state *state = drv->state + port->line;
2498 struct uart_info *info;
2500 BUG_ON(in_interrupt());
2502 if (state->port != port)
2503 printk(KERN_ALERT "Removing wrong port: %p != %p\n",
2506 mutex_lock(&port_mutex);
2509 * Mark the port "dead" - this prevents any opens from
2510 * succeeding while we shut down the port.
2512 mutex_lock(&state->mutex);
2513 port->flags |= UPF_DEAD;
2514 mutex_unlock(&state->mutex);
2517 * Remove the devices from the tty layer
2519 tty_unregister_device(drv->tty_driver, port->line);
2522 if (info && info->tty)
2523 tty_vhangup(info->tty);
2526 * All users of this port should now be disconnected from
2527 * this driver, and the port shut down. We should be the
2528 * only thread fiddling with this port from now on.
2533 * Free the port IO and memory resources, if any.
2535 if (port->type != PORT_UNKNOWN)
2536 port->ops->release_port(port);
2539 * Indicate that there isn't a port here anymore.
2541 port->type = PORT_UNKNOWN;
2544 * Kill the tasklet, and free resources.
2547 tasklet_kill(&info->tlet);
2552 mutex_unlock(&port_mutex);
2558 * Are the two ports equivalent?
2560 int uart_match_port(struct uart_port *port1, struct uart_port *port2)
2562 if (port1->iotype != port2->iotype)
2565 switch (port1->iotype) {
2567 return (port1->iobase == port2->iobase);
2569 return (port1->iobase == port2->iobase) &&
2570 (port1->hub6 == port2->hub6);
2576 return (port1->mapbase == port2->mapbase);
2580 EXPORT_SYMBOL(uart_match_port);
2582 EXPORT_SYMBOL(uart_write_wakeup);
2583 EXPORT_SYMBOL(uart_register_driver);
2584 EXPORT_SYMBOL(uart_unregister_driver);
2585 EXPORT_SYMBOL(uart_suspend_port);
2586 EXPORT_SYMBOL(uart_resume_port);
2587 EXPORT_SYMBOL(uart_add_one_port);
2588 EXPORT_SYMBOL(uart_remove_one_port);
2590 MODULE_DESCRIPTION("Serial driver core");
2591 MODULE_LICENSE("GPL");