sh_eth: fix EESIPR values for SH77{34|63}
[linux/fpc-iii.git] / drivers / tty / serial / serial_core.c
blob9939c3d9912b3563d107e3cd4439212e291377c3
1 /*
2 * Driver core for serial ports
4 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
6 * Copyright 1999 ARM Limited
7 * Copyright (C) 2000-2001 Deep Blue Solutions Ltd.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/tty.h>
25 #include <linux/tty_flip.h>
26 #include <linux/slab.h>
27 #include <linux/init.h>
28 #include <linux/console.h>
29 #include <linux/of.h>
30 #include <linux/proc_fs.h>
31 #include <linux/seq_file.h>
32 #include <linux/device.h>
33 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
34 #include <linux/serial_core.h>
35 #include <linux/delay.h>
36 #include <linux/mutex.h>
38 #include <asm/irq.h>
39 #include <linux/uaccess.h>
42 * This is used to lock changes in serial line configuration.
44 static DEFINE_MUTEX(port_mutex);
47 * lockdep: port->lock is initialized in two places, but we
48 * want only one lock-class:
50 static struct lock_class_key port_lock_key;
52 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
54 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
55 struct ktermios *old_termios);
56 static void uart_wait_until_sent(struct tty_struct *tty, int timeout);
57 static void uart_change_pm(struct uart_state *state,
58 enum uart_pm_state pm_state);
60 static void uart_port_shutdown(struct tty_port *port);
62 static int uart_dcd_enabled(struct uart_port *uport)
64 return !!(uport->status & UPSTAT_DCD_ENABLE);
67 static inline struct uart_port *uart_port_ref(struct uart_state *state)
69 if (atomic_add_unless(&state->refcount, 1, 0))
70 return state->uart_port;
71 return NULL;
74 static inline void uart_port_deref(struct uart_port *uport)
76 if (atomic_dec_and_test(&uport->state->refcount))
77 wake_up(&uport->state->remove_wait);
80 #define uart_port_lock(state, flags) \
81 ({ \
82 struct uart_port *__uport = uart_port_ref(state); \
83 if (__uport) \
84 spin_lock_irqsave(&__uport->lock, flags); \
85 __uport; \
88 #define uart_port_unlock(uport, flags) \
89 ({ \
90 struct uart_port *__uport = uport; \
91 if (__uport) { \
92 spin_unlock_irqrestore(&__uport->lock, flags); \
93 uart_port_deref(__uport); \
94 } \
97 static inline struct uart_port *uart_port_check(struct uart_state *state)
99 lockdep_assert_held(&state->port.mutex);
100 return state->uart_port;
104 * This routine is used by the interrupt handler to schedule processing in
105 * the software interrupt portion of the driver.
107 void uart_write_wakeup(struct uart_port *port)
109 struct uart_state *state = port->state;
111 * This means you called this function _after_ the port was
112 * closed. No cookie for you.
114 BUG_ON(!state);
115 tty_port_tty_wakeup(&state->port);
118 static void uart_stop(struct tty_struct *tty)
120 struct uart_state *state = tty->driver_data;
121 struct uart_port *port;
122 unsigned long flags;
124 port = uart_port_lock(state, flags);
125 if (port)
126 port->ops->stop_tx(port);
127 uart_port_unlock(port, flags);
130 static void __uart_start(struct tty_struct *tty)
132 struct uart_state *state = tty->driver_data;
133 struct uart_port *port = state->uart_port;
135 if (port && !uart_tx_stopped(port))
136 port->ops->start_tx(port);
139 static void uart_start(struct tty_struct *tty)
141 struct uart_state *state = tty->driver_data;
142 struct uart_port *port;
143 unsigned long flags;
145 port = uart_port_lock(state, flags);
146 __uart_start(tty);
147 uart_port_unlock(port, flags);
150 static void
151 uart_update_mctrl(struct uart_port *port, unsigned int set, unsigned int clear)
153 unsigned long flags;
154 unsigned int old;
156 spin_lock_irqsave(&port->lock, flags);
157 old = port->mctrl;
158 port->mctrl = (old & ~clear) | set;
159 if (old != port->mctrl)
160 port->ops->set_mctrl(port, port->mctrl);
161 spin_unlock_irqrestore(&port->lock, flags);
164 #define uart_set_mctrl(port, set) uart_update_mctrl(port, set, 0)
165 #define uart_clear_mctrl(port, clear) uart_update_mctrl(port, 0, clear)
168 * Startup the port. This will be called once per open. All calls
169 * will be serialised by the per-port mutex.
171 static int uart_port_startup(struct tty_struct *tty, struct uart_state *state,
172 int init_hw)
174 struct uart_port *uport = uart_port_check(state);
175 unsigned long page;
176 int retval = 0;
178 if (uport->type == PORT_UNKNOWN)
179 return 1;
182 * Make sure the device is in D0 state.
184 uart_change_pm(state, UART_PM_STATE_ON);
187 * Initialise and allocate the transmit and temporary
188 * buffer.
190 if (!state->xmit.buf) {
191 /* This is protected by the per port mutex */
192 page = get_zeroed_page(GFP_KERNEL);
193 if (!page)
194 return -ENOMEM;
196 state->xmit.buf = (unsigned char *) page;
197 uart_circ_clear(&state->xmit);
200 retval = uport->ops->startup(uport);
201 if (retval == 0) {
202 if (uart_console(uport) && uport->cons->cflag) {
203 tty->termios.c_cflag = uport->cons->cflag;
204 uport->cons->cflag = 0;
207 * Initialise the hardware port settings.
209 uart_change_speed(tty, state, NULL);
212 * Setup the RTS and DTR signals once the
213 * port is open and ready to respond.
215 if (init_hw && C_BAUD(tty))
216 uart_set_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
220 * This is to allow setserial on this port. People may want to set
221 * port/irq/type and then reconfigure the port properly if it failed
222 * now.
224 if (retval && capable(CAP_SYS_ADMIN))
225 return 1;
227 return retval;
230 static int uart_startup(struct tty_struct *tty, struct uart_state *state,
231 int init_hw)
233 struct tty_port *port = &state->port;
234 int retval;
236 if (tty_port_initialized(port))
237 return 0;
239 retval = uart_port_startup(tty, state, init_hw);
240 if (retval)
241 set_bit(TTY_IO_ERROR, &tty->flags);
243 return retval;
247 * This routine will shutdown a serial port; interrupts are disabled, and
248 * DTR is dropped if the hangup on close termio flag is on. Calls to
249 * uart_shutdown are serialised by the per-port semaphore.
251 * uport == NULL if uart_port has already been removed
253 static void uart_shutdown(struct tty_struct *tty, struct uart_state *state)
255 struct uart_port *uport = uart_port_check(state);
256 struct tty_port *port = &state->port;
259 * Set the TTY IO error marker
261 if (tty)
262 set_bit(TTY_IO_ERROR, &tty->flags);
264 if (tty_port_initialized(port)) {
265 tty_port_set_initialized(port, 0);
268 * Turn off DTR and RTS early.
270 if (uport && uart_console(uport) && tty)
271 uport->cons->cflag = tty->termios.c_cflag;
273 if (!tty || C_HUPCL(tty))
274 uart_clear_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
276 uart_port_shutdown(port);
280 * It's possible for shutdown to be called after suspend if we get
281 * a DCD drop (hangup) at just the right time. Clear suspended bit so
282 * we don't try to resume a port that has been shutdown.
284 tty_port_set_suspended(port, 0);
287 * Free the transmit buffer page.
289 if (state->xmit.buf) {
290 free_page((unsigned long)state->xmit.buf);
291 state->xmit.buf = NULL;
296 * uart_update_timeout - update per-port FIFO timeout.
297 * @port: uart_port structure describing the port
298 * @cflag: termios cflag value
299 * @baud: speed of the port
301 * Set the port FIFO timeout value. The @cflag value should
302 * reflect the actual hardware settings.
304 void
305 uart_update_timeout(struct uart_port *port, unsigned int cflag,
306 unsigned int baud)
308 unsigned int bits;
310 /* byte size and parity */
311 switch (cflag & CSIZE) {
312 case CS5:
313 bits = 7;
314 break;
315 case CS6:
316 bits = 8;
317 break;
318 case CS7:
319 bits = 9;
320 break;
321 default:
322 bits = 10;
323 break; /* CS8 */
326 if (cflag & CSTOPB)
327 bits++;
328 if (cflag & PARENB)
329 bits++;
332 * The total number of bits to be transmitted in the fifo.
334 bits = bits * port->fifosize;
337 * Figure the timeout to send the above number of bits.
338 * Add .02 seconds of slop
340 port->timeout = (HZ * bits) / baud + HZ/50;
343 EXPORT_SYMBOL(uart_update_timeout);
346 * uart_get_baud_rate - return baud rate for a particular port
347 * @port: uart_port structure describing the port in question.
348 * @termios: desired termios settings.
349 * @old: old termios (or NULL)
350 * @min: minimum acceptable baud rate
351 * @max: maximum acceptable baud rate
353 * Decode the termios structure into a numeric baud rate,
354 * taking account of the magic 38400 baud rate (with spd_*
355 * flags), and mapping the %B0 rate to 9600 baud.
357 * If the new baud rate is invalid, try the old termios setting.
358 * If it's still invalid, we try 9600 baud.
360 * Update the @termios structure to reflect the baud rate
361 * we're actually going to be using. Don't do this for the case
362 * where B0 is requested ("hang up").
364 unsigned int
365 uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
366 struct ktermios *old, unsigned int min, unsigned int max)
368 unsigned int try;
369 unsigned int baud;
370 unsigned int altbaud;
371 int hung_up = 0;
372 upf_t flags = port->flags & UPF_SPD_MASK;
374 switch (flags) {
375 case UPF_SPD_HI:
376 altbaud = 57600;
377 break;
378 case UPF_SPD_VHI:
379 altbaud = 115200;
380 break;
381 case UPF_SPD_SHI:
382 altbaud = 230400;
383 break;
384 case UPF_SPD_WARP:
385 altbaud = 460800;
386 break;
387 default:
388 altbaud = 38400;
389 break;
392 for (try = 0; try < 2; try++) {
393 baud = tty_termios_baud_rate(termios);
396 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
397 * Die! Die! Die!
399 if (try == 0 && baud == 38400)
400 baud = altbaud;
403 * Special case: B0 rate.
405 if (baud == 0) {
406 hung_up = 1;
407 baud = 9600;
410 if (baud >= min && baud <= max)
411 return baud;
414 * Oops, the quotient was zero. Try again with
415 * the old baud rate if possible.
417 termios->c_cflag &= ~CBAUD;
418 if (old) {
419 baud = tty_termios_baud_rate(old);
420 if (!hung_up)
421 tty_termios_encode_baud_rate(termios,
422 baud, baud);
423 old = NULL;
424 continue;
428 * As a last resort, if the range cannot be met then clip to
429 * the nearest chip supported rate.
431 if (!hung_up) {
432 if (baud <= min)
433 tty_termios_encode_baud_rate(termios,
434 min + 1, min + 1);
435 else
436 tty_termios_encode_baud_rate(termios,
437 max - 1, max - 1);
440 /* Should never happen */
441 WARN_ON(1);
442 return 0;
445 EXPORT_SYMBOL(uart_get_baud_rate);
448 * uart_get_divisor - return uart clock divisor
449 * @port: uart_port structure describing the port.
450 * @baud: desired baud rate
452 * Calculate the uart clock divisor for the port.
454 unsigned int
455 uart_get_divisor(struct uart_port *port, unsigned int baud)
457 unsigned int quot;
460 * Old custom speed handling.
462 if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
463 quot = port->custom_divisor;
464 else
465 quot = DIV_ROUND_CLOSEST(port->uartclk, 16 * baud);
467 return quot;
470 EXPORT_SYMBOL(uart_get_divisor);
472 /* Caller holds port mutex */
473 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
474 struct ktermios *old_termios)
476 struct uart_port *uport = uart_port_check(state);
477 struct ktermios *termios;
478 int hw_stopped;
481 * If we have no tty, termios, or the port does not exist,
482 * then we can't set the parameters for this port.
484 if (!tty || uport->type == PORT_UNKNOWN)
485 return;
487 termios = &tty->termios;
488 uport->ops->set_termios(uport, termios, old_termios);
491 * Set modem status enables based on termios cflag
493 spin_lock_irq(&uport->lock);
494 if (termios->c_cflag & CRTSCTS)
495 uport->status |= UPSTAT_CTS_ENABLE;
496 else
497 uport->status &= ~UPSTAT_CTS_ENABLE;
499 if (termios->c_cflag & CLOCAL)
500 uport->status &= ~UPSTAT_DCD_ENABLE;
501 else
502 uport->status |= UPSTAT_DCD_ENABLE;
504 /* reset sw-assisted CTS flow control based on (possibly) new mode */
505 hw_stopped = uport->hw_stopped;
506 uport->hw_stopped = uart_softcts_mode(uport) &&
507 !(uport->ops->get_mctrl(uport) & TIOCM_CTS);
508 if (uport->hw_stopped) {
509 if (!hw_stopped)
510 uport->ops->stop_tx(uport);
511 } else {
512 if (hw_stopped)
513 __uart_start(tty);
515 spin_unlock_irq(&uport->lock);
518 static int uart_put_char(struct tty_struct *tty, unsigned char c)
520 struct uart_state *state = tty->driver_data;
521 struct uart_port *port;
522 struct circ_buf *circ;
523 unsigned long flags;
524 int ret = 0;
526 circ = &state->xmit;
527 if (!circ->buf)
528 return 0;
530 port = uart_port_lock(state, flags);
531 if (port && uart_circ_chars_free(circ) != 0) {
532 circ->buf[circ->head] = c;
533 circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
534 ret = 1;
536 uart_port_unlock(port, flags);
537 return ret;
540 static void uart_flush_chars(struct tty_struct *tty)
542 uart_start(tty);
545 static int uart_write(struct tty_struct *tty,
546 const unsigned char *buf, int count)
548 struct uart_state *state = tty->driver_data;
549 struct uart_port *port;
550 struct circ_buf *circ;
551 unsigned long flags;
552 int c, ret = 0;
555 * This means you called this function _after_ the port was
556 * closed. No cookie for you.
558 if (!state) {
559 WARN_ON(1);
560 return -EL3HLT;
563 circ = &state->xmit;
564 if (!circ->buf)
565 return 0;
567 port = uart_port_lock(state, flags);
568 while (port) {
569 c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
570 if (count < c)
571 c = count;
572 if (c <= 0)
573 break;
574 memcpy(circ->buf + circ->head, buf, c);
575 circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
576 buf += c;
577 count -= c;
578 ret += c;
581 __uart_start(tty);
582 uart_port_unlock(port, flags);
583 return ret;
586 static int uart_write_room(struct tty_struct *tty)
588 struct uart_state *state = tty->driver_data;
589 struct uart_port *port;
590 unsigned long flags;
591 int ret;
593 port = uart_port_lock(state, flags);
594 ret = uart_circ_chars_free(&state->xmit);
595 uart_port_unlock(port, flags);
596 return ret;
599 static int uart_chars_in_buffer(struct tty_struct *tty)
601 struct uart_state *state = tty->driver_data;
602 struct uart_port *port;
603 unsigned long flags;
604 int ret;
606 port = uart_port_lock(state, flags);
607 ret = uart_circ_chars_pending(&state->xmit);
608 uart_port_unlock(port, flags);
609 return ret;
612 static void uart_flush_buffer(struct tty_struct *tty)
614 struct uart_state *state = tty->driver_data;
615 struct uart_port *port;
616 unsigned long flags;
619 * This means you called this function _after_ the port was
620 * closed. No cookie for you.
622 if (!state) {
623 WARN_ON(1);
624 return;
627 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
629 port = uart_port_lock(state, flags);
630 if (!port)
631 return;
632 uart_circ_clear(&state->xmit);
633 if (port->ops->flush_buffer)
634 port->ops->flush_buffer(port);
635 uart_port_unlock(port, flags);
636 tty_port_tty_wakeup(&state->port);
640 * This function is used to send a high-priority XON/XOFF character to
641 * the device
643 static void uart_send_xchar(struct tty_struct *tty, char ch)
645 struct uart_state *state = tty->driver_data;
646 struct uart_port *port;
647 unsigned long flags;
649 port = uart_port_ref(state);
650 if (!port)
651 return;
653 if (port->ops->send_xchar)
654 port->ops->send_xchar(port, ch);
655 else {
656 spin_lock_irqsave(&port->lock, flags);
657 port->x_char = ch;
658 if (ch)
659 port->ops->start_tx(port);
660 spin_unlock_irqrestore(&port->lock, flags);
662 uart_port_deref(port);
665 static void uart_throttle(struct tty_struct *tty)
667 struct uart_state *state = tty->driver_data;
668 struct uart_port *port;
669 upstat_t mask = 0;
671 port = uart_port_ref(state);
672 if (!port)
673 return;
675 if (I_IXOFF(tty))
676 mask |= UPSTAT_AUTOXOFF;
677 if (C_CRTSCTS(tty))
678 mask |= UPSTAT_AUTORTS;
680 if (port->status & mask) {
681 port->ops->throttle(port);
682 mask &= ~port->status;
685 if (mask & UPSTAT_AUTORTS)
686 uart_clear_mctrl(port, TIOCM_RTS);
688 if (mask & UPSTAT_AUTOXOFF)
689 uart_send_xchar(tty, STOP_CHAR(tty));
691 uart_port_deref(port);
694 static void uart_unthrottle(struct tty_struct *tty)
696 struct uart_state *state = tty->driver_data;
697 struct uart_port *port;
698 upstat_t mask = 0;
700 port = uart_port_ref(state);
701 if (!port)
702 return;
704 if (I_IXOFF(tty))
705 mask |= UPSTAT_AUTOXOFF;
706 if (C_CRTSCTS(tty))
707 mask |= UPSTAT_AUTORTS;
709 if (port->status & mask) {
710 port->ops->unthrottle(port);
711 mask &= ~port->status;
714 if (mask & UPSTAT_AUTORTS)
715 uart_set_mctrl(port, TIOCM_RTS);
717 if (mask & UPSTAT_AUTOXOFF)
718 uart_send_xchar(tty, START_CHAR(tty));
720 uart_port_deref(port);
723 static int uart_get_info(struct tty_port *port, struct serial_struct *retinfo)
725 struct uart_state *state = container_of(port, struct uart_state, port);
726 struct uart_port *uport;
727 int ret = -ENODEV;
729 memset(retinfo, 0, sizeof(*retinfo));
732 * Ensure the state we copy is consistent and no hardware changes
733 * occur as we go
735 mutex_lock(&port->mutex);
736 uport = uart_port_check(state);
737 if (!uport)
738 goto out;
740 retinfo->type = uport->type;
741 retinfo->line = uport->line;
742 retinfo->port = uport->iobase;
743 if (HIGH_BITS_OFFSET)
744 retinfo->port_high = (long) uport->iobase >> HIGH_BITS_OFFSET;
745 retinfo->irq = uport->irq;
746 retinfo->flags = uport->flags;
747 retinfo->xmit_fifo_size = uport->fifosize;
748 retinfo->baud_base = uport->uartclk / 16;
749 retinfo->close_delay = jiffies_to_msecs(port->close_delay) / 10;
750 retinfo->closing_wait = port->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
751 ASYNC_CLOSING_WAIT_NONE :
752 jiffies_to_msecs(port->closing_wait) / 10;
753 retinfo->custom_divisor = uport->custom_divisor;
754 retinfo->hub6 = uport->hub6;
755 retinfo->io_type = uport->iotype;
756 retinfo->iomem_reg_shift = uport->regshift;
757 retinfo->iomem_base = (void *)(unsigned long)uport->mapbase;
759 ret = 0;
760 out:
761 mutex_unlock(&port->mutex);
762 return ret;
765 static int uart_get_info_user(struct tty_port *port,
766 struct serial_struct __user *retinfo)
768 struct serial_struct tmp;
770 if (uart_get_info(port, &tmp) < 0)
771 return -EIO;
773 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
774 return -EFAULT;
775 return 0;
778 static int uart_set_info(struct tty_struct *tty, struct tty_port *port,
779 struct uart_state *state,
780 struct serial_struct *new_info)
782 struct uart_port *uport = uart_port_check(state);
783 unsigned long new_port;
784 unsigned int change_irq, change_port, closing_wait;
785 unsigned int old_custom_divisor, close_delay;
786 upf_t old_flags, new_flags;
787 int retval = 0;
789 if (!uport)
790 return -EIO;
792 new_port = new_info->port;
793 if (HIGH_BITS_OFFSET)
794 new_port += (unsigned long) new_info->port_high << HIGH_BITS_OFFSET;
796 new_info->irq = irq_canonicalize(new_info->irq);
797 close_delay = msecs_to_jiffies(new_info->close_delay * 10);
798 closing_wait = new_info->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
799 ASYNC_CLOSING_WAIT_NONE :
800 msecs_to_jiffies(new_info->closing_wait * 10);
803 change_irq = !(uport->flags & UPF_FIXED_PORT)
804 && new_info->irq != uport->irq;
807 * Since changing the 'type' of the port changes its resource
808 * allocations, we should treat type changes the same as
809 * IO port changes.
811 change_port = !(uport->flags & UPF_FIXED_PORT)
812 && (new_port != uport->iobase ||
813 (unsigned long)new_info->iomem_base != uport->mapbase ||
814 new_info->hub6 != uport->hub6 ||
815 new_info->io_type != uport->iotype ||
816 new_info->iomem_reg_shift != uport->regshift ||
817 new_info->type != uport->type);
819 old_flags = uport->flags;
820 new_flags = new_info->flags;
821 old_custom_divisor = uport->custom_divisor;
823 if (!capable(CAP_SYS_ADMIN)) {
824 retval = -EPERM;
825 if (change_irq || change_port ||
826 (new_info->baud_base != uport->uartclk / 16) ||
827 (close_delay != port->close_delay) ||
828 (closing_wait != port->closing_wait) ||
829 (new_info->xmit_fifo_size &&
830 new_info->xmit_fifo_size != uport->fifosize) ||
831 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
832 goto exit;
833 uport->flags = ((uport->flags & ~UPF_USR_MASK) |
834 (new_flags & UPF_USR_MASK));
835 uport->custom_divisor = new_info->custom_divisor;
836 goto check_and_exit;
840 * Ask the low level driver to verify the settings.
842 if (uport->ops->verify_port)
843 retval = uport->ops->verify_port(uport, new_info);
845 if ((new_info->irq >= nr_irqs) || (new_info->irq < 0) ||
846 (new_info->baud_base < 9600))
847 retval = -EINVAL;
849 if (retval)
850 goto exit;
852 if (change_port || change_irq) {
853 retval = -EBUSY;
856 * Make sure that we are the sole user of this port.
858 if (tty_port_users(port) > 1)
859 goto exit;
862 * We need to shutdown the serial port at the old
863 * port/type/irq combination.
865 uart_shutdown(tty, state);
868 if (change_port) {
869 unsigned long old_iobase, old_mapbase;
870 unsigned int old_type, old_iotype, old_hub6, old_shift;
872 old_iobase = uport->iobase;
873 old_mapbase = uport->mapbase;
874 old_type = uport->type;
875 old_hub6 = uport->hub6;
876 old_iotype = uport->iotype;
877 old_shift = uport->regshift;
880 * Free and release old regions
882 if (old_type != PORT_UNKNOWN && uport->ops->release_port)
883 uport->ops->release_port(uport);
885 uport->iobase = new_port;
886 uport->type = new_info->type;
887 uport->hub6 = new_info->hub6;
888 uport->iotype = new_info->io_type;
889 uport->regshift = new_info->iomem_reg_shift;
890 uport->mapbase = (unsigned long)new_info->iomem_base;
893 * Claim and map the new regions
895 if (uport->type != PORT_UNKNOWN && uport->ops->request_port) {
896 retval = uport->ops->request_port(uport);
897 } else {
898 /* Always success - Jean II */
899 retval = 0;
903 * If we fail to request resources for the
904 * new port, try to restore the old settings.
906 if (retval) {
907 uport->iobase = old_iobase;
908 uport->type = old_type;
909 uport->hub6 = old_hub6;
910 uport->iotype = old_iotype;
911 uport->regshift = old_shift;
912 uport->mapbase = old_mapbase;
914 if (old_type != PORT_UNKNOWN) {
915 retval = uport->ops->request_port(uport);
917 * If we failed to restore the old settings,
918 * we fail like this.
920 if (retval)
921 uport->type = PORT_UNKNOWN;
924 * We failed anyway.
926 retval = -EBUSY;
929 /* Added to return the correct error -Ram Gupta */
930 goto exit;
934 if (change_irq)
935 uport->irq = new_info->irq;
936 if (!(uport->flags & UPF_FIXED_PORT))
937 uport->uartclk = new_info->baud_base * 16;
938 uport->flags = (uport->flags & ~UPF_CHANGE_MASK) |
939 (new_flags & UPF_CHANGE_MASK);
940 uport->custom_divisor = new_info->custom_divisor;
941 port->close_delay = close_delay;
942 port->closing_wait = closing_wait;
943 if (new_info->xmit_fifo_size)
944 uport->fifosize = new_info->xmit_fifo_size;
945 port->low_latency = (uport->flags & UPF_LOW_LATENCY) ? 1 : 0;
947 check_and_exit:
948 retval = 0;
949 if (uport->type == PORT_UNKNOWN)
950 goto exit;
951 if (tty_port_initialized(port)) {
952 if (((old_flags ^ uport->flags) & UPF_SPD_MASK) ||
953 old_custom_divisor != uport->custom_divisor) {
955 * If they're setting up a custom divisor or speed,
956 * instead of clearing it, then bitch about it. No
957 * need to rate-limit; it's CAP_SYS_ADMIN only.
959 if (uport->flags & UPF_SPD_MASK) {
960 dev_notice(uport->dev,
961 "%s sets custom speed on %s. This is deprecated.\n",
962 current->comm,
963 tty_name(port->tty));
965 uart_change_speed(tty, state, NULL);
967 } else {
968 retval = uart_startup(tty, state, 1);
969 if (retval > 0)
970 retval = 0;
972 exit:
973 return retval;
976 static int uart_set_info_user(struct tty_struct *tty, struct uart_state *state,
977 struct serial_struct __user *newinfo)
979 struct serial_struct new_serial;
980 struct tty_port *port = &state->port;
981 int retval;
983 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
984 return -EFAULT;
987 * This semaphore protects port->count. It is also
988 * very useful to prevent opens. Also, take the
989 * port configuration semaphore to make sure that a
990 * module insertion/removal doesn't change anything
991 * under us.
993 mutex_lock(&port->mutex);
994 retval = uart_set_info(tty, port, state, &new_serial);
995 mutex_unlock(&port->mutex);
996 return retval;
1000 * uart_get_lsr_info - get line status register info
1001 * @tty: tty associated with the UART
1002 * @state: UART being queried
1003 * @value: returned modem value
1005 static int uart_get_lsr_info(struct tty_struct *tty,
1006 struct uart_state *state, unsigned int __user *value)
1008 struct uart_port *uport = uart_port_check(state);
1009 unsigned int result;
1011 result = uport->ops->tx_empty(uport);
1014 * If we're about to load something into the transmit
1015 * register, we'll pretend the transmitter isn't empty to
1016 * avoid a race condition (depending on when the transmit
1017 * interrupt happens).
1019 if (uport->x_char ||
1020 ((uart_circ_chars_pending(&state->xmit) > 0) &&
1021 !uart_tx_stopped(uport)))
1022 result &= ~TIOCSER_TEMT;
1024 return put_user(result, value);
1027 static int uart_tiocmget(struct tty_struct *tty)
1029 struct uart_state *state = tty->driver_data;
1030 struct tty_port *port = &state->port;
1031 struct uart_port *uport;
1032 int result = -EIO;
1034 mutex_lock(&port->mutex);
1035 uport = uart_port_check(state);
1036 if (!uport)
1037 goto out;
1039 if (!tty_io_error(tty)) {
1040 result = uport->mctrl;
1041 spin_lock_irq(&uport->lock);
1042 result |= uport->ops->get_mctrl(uport);
1043 spin_unlock_irq(&uport->lock);
1045 out:
1046 mutex_unlock(&port->mutex);
1047 return result;
1050 static int
1051 uart_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)
1053 struct uart_state *state = tty->driver_data;
1054 struct tty_port *port = &state->port;
1055 struct uart_port *uport;
1056 int ret = -EIO;
1058 mutex_lock(&port->mutex);
1059 uport = uart_port_check(state);
1060 if (!uport)
1061 goto out;
1063 if (!tty_io_error(tty)) {
1064 uart_update_mctrl(uport, set, clear);
1065 ret = 0;
1067 out:
1068 mutex_unlock(&port->mutex);
1069 return ret;
1072 static int uart_break_ctl(struct tty_struct *tty, int break_state)
1074 struct uart_state *state = tty->driver_data;
1075 struct tty_port *port = &state->port;
1076 struct uart_port *uport;
1077 int ret = -EIO;
1079 mutex_lock(&port->mutex);
1080 uport = uart_port_check(state);
1081 if (!uport)
1082 goto out;
1084 if (uport->type != PORT_UNKNOWN)
1085 uport->ops->break_ctl(uport, break_state);
1086 ret = 0;
1087 out:
1088 mutex_unlock(&port->mutex);
1089 return ret;
1092 static int uart_do_autoconfig(struct tty_struct *tty,struct uart_state *state)
1094 struct tty_port *port = &state->port;
1095 struct uart_port *uport;
1096 int flags, ret;
1098 if (!capable(CAP_SYS_ADMIN))
1099 return -EPERM;
1102 * Take the per-port semaphore. This prevents count from
1103 * changing, and hence any extra opens of the port while
1104 * we're auto-configuring.
1106 if (mutex_lock_interruptible(&port->mutex))
1107 return -ERESTARTSYS;
1109 uport = uart_port_check(state);
1110 if (!uport) {
1111 ret = -EIO;
1112 goto out;
1115 ret = -EBUSY;
1116 if (tty_port_users(port) == 1) {
1117 uart_shutdown(tty, state);
1120 * If we already have a port type configured,
1121 * we must release its resources.
1123 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
1124 uport->ops->release_port(uport);
1126 flags = UART_CONFIG_TYPE;
1127 if (uport->flags & UPF_AUTO_IRQ)
1128 flags |= UART_CONFIG_IRQ;
1131 * This will claim the ports resources if
1132 * a port is found.
1134 uport->ops->config_port(uport, flags);
1136 ret = uart_startup(tty, state, 1);
1137 if (ret > 0)
1138 ret = 0;
1140 out:
1141 mutex_unlock(&port->mutex);
1142 return ret;
1145 static void uart_enable_ms(struct uart_port *uport)
1148 * Force modem status interrupts on
1150 if (uport->ops->enable_ms)
1151 uport->ops->enable_ms(uport);
1155 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1156 * - mask passed in arg for lines of interest
1157 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1158 * Caller should use TIOCGICOUNT to see which one it was
1160 * FIXME: This wants extracting into a common all driver implementation
1161 * of TIOCMWAIT using tty_port.
1163 static int uart_wait_modem_status(struct uart_state *state, unsigned long arg)
1165 struct uart_port *uport;
1166 struct tty_port *port = &state->port;
1167 DECLARE_WAITQUEUE(wait, current);
1168 struct uart_icount cprev, cnow;
1169 int ret;
1172 * note the counters on entry
1174 uport = uart_port_ref(state);
1175 if (!uport)
1176 return -EIO;
1177 spin_lock_irq(&uport->lock);
1178 memcpy(&cprev, &uport->icount, sizeof(struct uart_icount));
1179 uart_enable_ms(uport);
1180 spin_unlock_irq(&uport->lock);
1182 add_wait_queue(&port->delta_msr_wait, &wait);
1183 for (;;) {
1184 spin_lock_irq(&uport->lock);
1185 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1186 spin_unlock_irq(&uport->lock);
1188 set_current_state(TASK_INTERRUPTIBLE);
1190 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1191 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1192 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1193 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1194 ret = 0;
1195 break;
1198 schedule();
1200 /* see if a signal did it */
1201 if (signal_pending(current)) {
1202 ret = -ERESTARTSYS;
1203 break;
1206 cprev = cnow;
1208 __set_current_state(TASK_RUNNING);
1209 remove_wait_queue(&port->delta_msr_wait, &wait);
1210 uart_port_deref(uport);
1212 return ret;
1216 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1217 * Return: write counters to the user passed counter struct
1218 * NB: both 1->0 and 0->1 transitions are counted except for
1219 * RI where only 0->1 is counted.
1221 static int uart_get_icount(struct tty_struct *tty,
1222 struct serial_icounter_struct *icount)
1224 struct uart_state *state = tty->driver_data;
1225 struct uart_icount cnow;
1226 struct uart_port *uport;
1228 uport = uart_port_ref(state);
1229 if (!uport)
1230 return -EIO;
1231 spin_lock_irq(&uport->lock);
1232 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1233 spin_unlock_irq(&uport->lock);
1234 uart_port_deref(uport);
1236 icount->cts = cnow.cts;
1237 icount->dsr = cnow.dsr;
1238 icount->rng = cnow.rng;
1239 icount->dcd = cnow.dcd;
1240 icount->rx = cnow.rx;
1241 icount->tx = cnow.tx;
1242 icount->frame = cnow.frame;
1243 icount->overrun = cnow.overrun;
1244 icount->parity = cnow.parity;
1245 icount->brk = cnow.brk;
1246 icount->buf_overrun = cnow.buf_overrun;
1248 return 0;
1251 static int uart_get_rs485_config(struct uart_port *port,
1252 struct serial_rs485 __user *rs485)
1254 unsigned long flags;
1255 struct serial_rs485 aux;
1257 spin_lock_irqsave(&port->lock, flags);
1258 aux = port->rs485;
1259 spin_unlock_irqrestore(&port->lock, flags);
1261 if (copy_to_user(rs485, &aux, sizeof(aux)))
1262 return -EFAULT;
1264 return 0;
1267 static int uart_set_rs485_config(struct uart_port *port,
1268 struct serial_rs485 __user *rs485_user)
1270 struct serial_rs485 rs485;
1271 int ret;
1272 unsigned long flags;
1274 if (!port->rs485_config)
1275 return -ENOIOCTLCMD;
1277 if (copy_from_user(&rs485, rs485_user, sizeof(*rs485_user)))
1278 return -EFAULT;
1280 spin_lock_irqsave(&port->lock, flags);
1281 ret = port->rs485_config(port, &rs485);
1282 spin_unlock_irqrestore(&port->lock, flags);
1283 if (ret)
1284 return ret;
1286 if (copy_to_user(rs485_user, &port->rs485, sizeof(port->rs485)))
1287 return -EFAULT;
1289 return 0;
1293 * Called via sys_ioctl. We can use spin_lock_irq() here.
1295 static int
1296 uart_ioctl(struct tty_struct *tty, unsigned int cmd, unsigned long arg)
1298 struct uart_state *state = tty->driver_data;
1299 struct tty_port *port = &state->port;
1300 struct uart_port *uport;
1301 void __user *uarg = (void __user *)arg;
1302 int ret = -ENOIOCTLCMD;
1306 * These ioctls don't rely on the hardware to be present.
1308 switch (cmd) {
1309 case TIOCGSERIAL:
1310 ret = uart_get_info_user(port, uarg);
1311 break;
1313 case TIOCSSERIAL:
1314 down_write(&tty->termios_rwsem);
1315 ret = uart_set_info_user(tty, state, uarg);
1316 up_write(&tty->termios_rwsem);
1317 break;
1319 case TIOCSERCONFIG:
1320 down_write(&tty->termios_rwsem);
1321 ret = uart_do_autoconfig(tty, state);
1322 up_write(&tty->termios_rwsem);
1323 break;
1325 case TIOCSERGWILD: /* obsolete */
1326 case TIOCSERSWILD: /* obsolete */
1327 ret = 0;
1328 break;
1331 if (ret != -ENOIOCTLCMD)
1332 goto out;
1334 if (tty_io_error(tty)) {
1335 ret = -EIO;
1336 goto out;
1340 * The following should only be used when hardware is present.
1342 switch (cmd) {
1343 case TIOCMIWAIT:
1344 ret = uart_wait_modem_status(state, arg);
1345 break;
1348 if (ret != -ENOIOCTLCMD)
1349 goto out;
1351 mutex_lock(&port->mutex);
1352 uport = uart_port_check(state);
1354 if (!uport || tty_io_error(tty)) {
1355 ret = -EIO;
1356 goto out_up;
1360 * All these rely on hardware being present and need to be
1361 * protected against the tty being hung up.
1364 switch (cmd) {
1365 case TIOCSERGETLSR: /* Get line status register */
1366 ret = uart_get_lsr_info(tty, state, uarg);
1367 break;
1369 case TIOCGRS485:
1370 ret = uart_get_rs485_config(uport, uarg);
1371 break;
1373 case TIOCSRS485:
1374 ret = uart_set_rs485_config(uport, uarg);
1375 break;
1376 default:
1377 if (uport->ops->ioctl)
1378 ret = uport->ops->ioctl(uport, cmd, arg);
1379 break;
1381 out_up:
1382 mutex_unlock(&port->mutex);
1383 out:
1384 return ret;
1387 static void uart_set_ldisc(struct tty_struct *tty)
1389 struct uart_state *state = tty->driver_data;
1390 struct uart_port *uport;
1392 mutex_lock(&state->port.mutex);
1393 uport = uart_port_check(state);
1394 if (uport && uport->ops->set_ldisc)
1395 uport->ops->set_ldisc(uport, &tty->termios);
1396 mutex_unlock(&state->port.mutex);
1399 static void uart_set_termios(struct tty_struct *tty,
1400 struct ktermios *old_termios)
1402 struct uart_state *state = tty->driver_data;
1403 struct uart_port *uport;
1404 unsigned int cflag = tty->termios.c_cflag;
1405 unsigned int iflag_mask = IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK;
1406 bool sw_changed = false;
1408 mutex_lock(&state->port.mutex);
1409 uport = uart_port_check(state);
1410 if (!uport)
1411 goto out;
1414 * Drivers doing software flow control also need to know
1415 * about changes to these input settings.
1417 if (uport->flags & UPF_SOFT_FLOW) {
1418 iflag_mask |= IXANY|IXON|IXOFF;
1419 sw_changed =
1420 tty->termios.c_cc[VSTART] != old_termios->c_cc[VSTART] ||
1421 tty->termios.c_cc[VSTOP] != old_termios->c_cc[VSTOP];
1425 * These are the bits that are used to setup various
1426 * flags in the low level driver. We can ignore the Bfoo
1427 * bits in c_cflag; c_[io]speed will always be set
1428 * appropriately by set_termios() in tty_ioctl.c
1430 if ((cflag ^ old_termios->c_cflag) == 0 &&
1431 tty->termios.c_ospeed == old_termios->c_ospeed &&
1432 tty->termios.c_ispeed == old_termios->c_ispeed &&
1433 ((tty->termios.c_iflag ^ old_termios->c_iflag) & iflag_mask) == 0 &&
1434 !sw_changed) {
1435 goto out;
1438 uart_change_speed(tty, state, old_termios);
1439 /* reload cflag from termios; port driver may have overriden flags */
1440 cflag = tty->termios.c_cflag;
1442 /* Handle transition to B0 status */
1443 if ((old_termios->c_cflag & CBAUD) && !(cflag & CBAUD))
1444 uart_clear_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
1445 /* Handle transition away from B0 status */
1446 else if (!(old_termios->c_cflag & CBAUD) && (cflag & CBAUD)) {
1447 unsigned int mask = TIOCM_DTR;
1448 if (!(cflag & CRTSCTS) || !tty_throttled(tty))
1449 mask |= TIOCM_RTS;
1450 uart_set_mctrl(uport, mask);
1452 out:
1453 mutex_unlock(&state->port.mutex);
1457 * Calls to uart_close() are serialised via the tty_lock in
1458 * drivers/tty/tty_io.c:tty_release()
1459 * drivers/tty/tty_io.c:do_tty_hangup()
1461 static void uart_close(struct tty_struct *tty, struct file *filp)
1463 struct uart_state *state = tty->driver_data;
1464 struct tty_port *port;
1466 if (!state) {
1467 struct uart_driver *drv = tty->driver->driver_state;
1469 state = drv->state + tty->index;
1470 port = &state->port;
1471 spin_lock_irq(&port->lock);
1472 --port->count;
1473 spin_unlock_irq(&port->lock);
1474 return;
1477 port = &state->port;
1478 pr_debug("uart_close(%d) called\n", tty->index);
1480 tty_port_close(tty->port, tty, filp);
1483 static void uart_tty_port_shutdown(struct tty_port *port)
1485 struct uart_state *state = container_of(port, struct uart_state, port);
1486 struct uart_port *uport = uart_port_check(state);
1489 * At this point, we stop accepting input. To do this, we
1490 * disable the receive line status interrupts.
1492 if (WARN(!uport, "detached port still initialized!\n"))
1493 return;
1495 spin_lock_irq(&uport->lock);
1496 uport->ops->stop_rx(uport);
1497 spin_unlock_irq(&uport->lock);
1499 uart_port_shutdown(port);
1502 * It's possible for shutdown to be called after suspend if we get
1503 * a DCD drop (hangup) at just the right time. Clear suspended bit so
1504 * we don't try to resume a port that has been shutdown.
1506 tty_port_set_suspended(port, 0);
1508 uart_change_pm(state, UART_PM_STATE_OFF);
1512 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1514 struct uart_state *state = tty->driver_data;
1515 struct uart_port *port;
1516 unsigned long char_time, expire;
1518 port = uart_port_ref(state);
1519 if (!port)
1520 return;
1522 if (port->type == PORT_UNKNOWN || port->fifosize == 0) {
1523 uart_port_deref(port);
1524 return;
1528 * Set the check interval to be 1/5 of the estimated time to
1529 * send a single character, and make it at least 1. The check
1530 * interval should also be less than the timeout.
1532 * Note: we have to use pretty tight timings here to satisfy
1533 * the NIST-PCTS.
1535 char_time = (port->timeout - HZ/50) / port->fifosize;
1536 char_time = char_time / 5;
1537 if (char_time == 0)
1538 char_time = 1;
1539 if (timeout && timeout < char_time)
1540 char_time = timeout;
1543 * If the transmitter hasn't cleared in twice the approximate
1544 * amount of time to send the entire FIFO, it probably won't
1545 * ever clear. This assumes the UART isn't doing flow
1546 * control, which is currently the case. Hence, if it ever
1547 * takes longer than port->timeout, this is probably due to a
1548 * UART bug of some kind. So, we clamp the timeout parameter at
1549 * 2*port->timeout.
1551 if (timeout == 0 || timeout > 2 * port->timeout)
1552 timeout = 2 * port->timeout;
1554 expire = jiffies + timeout;
1556 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1557 port->line, jiffies, expire);
1560 * Check whether the transmitter is empty every 'char_time'.
1561 * 'timeout' / 'expire' give us the maximum amount of time
1562 * we wait.
1564 while (!port->ops->tx_empty(port)) {
1565 msleep_interruptible(jiffies_to_msecs(char_time));
1566 if (signal_pending(current))
1567 break;
1568 if (time_after(jiffies, expire))
1569 break;
1571 uart_port_deref(port);
1575 * Calls to uart_hangup() are serialised by the tty_lock in
1576 * drivers/tty/tty_io.c:do_tty_hangup()
1577 * This runs from a workqueue and can sleep for a _short_ time only.
1579 static void uart_hangup(struct tty_struct *tty)
1581 struct uart_state *state = tty->driver_data;
1582 struct tty_port *port = &state->port;
1583 struct uart_port *uport;
1584 unsigned long flags;
1586 pr_debug("uart_hangup(%d)\n", tty->index);
1588 mutex_lock(&port->mutex);
1589 uport = uart_port_check(state);
1590 WARN(!uport, "hangup of detached port!\n");
1592 if (tty_port_active(port)) {
1593 uart_flush_buffer(tty);
1594 uart_shutdown(tty, state);
1595 spin_lock_irqsave(&port->lock, flags);
1596 port->count = 0;
1597 spin_unlock_irqrestore(&port->lock, flags);
1598 tty_port_set_active(port, 0);
1599 tty_port_tty_set(port, NULL);
1600 if (uport && !uart_console(uport))
1601 uart_change_pm(state, UART_PM_STATE_OFF);
1602 wake_up_interruptible(&port->open_wait);
1603 wake_up_interruptible(&port->delta_msr_wait);
1605 mutex_unlock(&port->mutex);
1608 /* uport == NULL if uart_port has already been removed */
1609 static void uart_port_shutdown(struct tty_port *port)
1611 struct uart_state *state = container_of(port, struct uart_state, port);
1612 struct uart_port *uport = uart_port_check(state);
1615 * clear delta_msr_wait queue to avoid mem leaks: we may free
1616 * the irq here so the queue might never be woken up. Note
1617 * that we won't end up waiting on delta_msr_wait again since
1618 * any outstanding file descriptors should be pointing at
1619 * hung_up_tty_fops now.
1621 wake_up_interruptible(&port->delta_msr_wait);
1624 * Free the IRQ and disable the port.
1626 if (uport)
1627 uport->ops->shutdown(uport);
1630 * Ensure that the IRQ handler isn't running on another CPU.
1632 if (uport)
1633 synchronize_irq(uport->irq);
1636 static int uart_carrier_raised(struct tty_port *port)
1638 struct uart_state *state = container_of(port, struct uart_state, port);
1639 struct uart_port *uport;
1640 int mctrl;
1642 uport = uart_port_ref(state);
1644 * Should never observe uport == NULL since checks for hangup should
1645 * abort the tty_port_block_til_ready() loop before checking for carrier
1646 * raised -- but report carrier raised if it does anyway so open will
1647 * continue and not sleep
1649 if (WARN_ON(!uport))
1650 return 1;
1651 spin_lock_irq(&uport->lock);
1652 uart_enable_ms(uport);
1653 mctrl = uport->ops->get_mctrl(uport);
1654 spin_unlock_irq(&uport->lock);
1655 uart_port_deref(uport);
1656 if (mctrl & TIOCM_CAR)
1657 return 1;
1658 return 0;
1661 static void uart_dtr_rts(struct tty_port *port, int onoff)
1663 struct uart_state *state = container_of(port, struct uart_state, port);
1664 struct uart_port *uport;
1666 uport = uart_port_ref(state);
1667 if (!uport)
1668 return;
1670 if (onoff)
1671 uart_set_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
1672 else
1673 uart_clear_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
1675 uart_port_deref(uport);
1679 * Calls to uart_open are serialised by the tty_lock in
1680 * drivers/tty/tty_io.c:tty_open()
1681 * Note that if this fails, then uart_close() _will_ be called.
1683 * In time, we want to scrap the "opening nonpresent ports"
1684 * behaviour and implement an alternative way for setserial
1685 * to set base addresses/ports/types. This will allow us to
1686 * get rid of a certain amount of extra tests.
1688 static int uart_open(struct tty_struct *tty, struct file *filp)
1690 struct uart_driver *drv = tty->driver->driver_state;
1691 int retval, line = tty->index;
1692 struct uart_state *state = drv->state + line;
1694 tty->driver_data = state;
1696 retval = tty_port_open(&state->port, tty, filp);
1697 if (retval > 0)
1698 retval = 0;
1700 return retval;
1703 static int uart_port_activate(struct tty_port *port, struct tty_struct *tty)
1705 struct uart_state *state = container_of(port, struct uart_state, port);
1706 struct uart_port *uport;
1708 uport = uart_port_check(state);
1709 if (!uport || uport->flags & UPF_DEAD)
1710 return -ENXIO;
1712 port->low_latency = (uport->flags & UPF_LOW_LATENCY) ? 1 : 0;
1715 * Start up the serial port.
1717 return uart_startup(tty, state, 0);
1720 static const char *uart_type(struct uart_port *port)
1722 const char *str = NULL;
1724 if (port->ops->type)
1725 str = port->ops->type(port);
1727 if (!str)
1728 str = "unknown";
1730 return str;
1733 #ifdef CONFIG_PROC_FS
1735 static void uart_line_info(struct seq_file *m, struct uart_driver *drv, int i)
1737 struct uart_state *state = drv->state + i;
1738 struct tty_port *port = &state->port;
1739 enum uart_pm_state pm_state;
1740 struct uart_port *uport;
1741 char stat_buf[32];
1742 unsigned int status;
1743 int mmio;
1745 mutex_lock(&port->mutex);
1746 uport = uart_port_check(state);
1747 if (!uport)
1748 goto out;
1750 mmio = uport->iotype >= UPIO_MEM;
1751 seq_printf(m, "%d: uart:%s %s%08llX irq:%d",
1752 uport->line, uart_type(uport),
1753 mmio ? "mmio:0x" : "port:",
1754 mmio ? (unsigned long long)uport->mapbase
1755 : (unsigned long long)uport->iobase,
1756 uport->irq);
1758 if (uport->type == PORT_UNKNOWN) {
1759 seq_putc(m, '\n');
1760 goto out;
1763 if (capable(CAP_SYS_ADMIN)) {
1764 pm_state = state->pm_state;
1765 if (pm_state != UART_PM_STATE_ON)
1766 uart_change_pm(state, UART_PM_STATE_ON);
1767 spin_lock_irq(&uport->lock);
1768 status = uport->ops->get_mctrl(uport);
1769 spin_unlock_irq(&uport->lock);
1770 if (pm_state != UART_PM_STATE_ON)
1771 uart_change_pm(state, pm_state);
1773 seq_printf(m, " tx:%d rx:%d",
1774 uport->icount.tx, uport->icount.rx);
1775 if (uport->icount.frame)
1776 seq_printf(m, " fe:%d", uport->icount.frame);
1777 if (uport->icount.parity)
1778 seq_printf(m, " pe:%d", uport->icount.parity);
1779 if (uport->icount.brk)
1780 seq_printf(m, " brk:%d", uport->icount.brk);
1781 if (uport->icount.overrun)
1782 seq_printf(m, " oe:%d", uport->icount.overrun);
1784 #define INFOBIT(bit, str) \
1785 if (uport->mctrl & (bit)) \
1786 strncat(stat_buf, (str), sizeof(stat_buf) - \
1787 strlen(stat_buf) - 2)
1788 #define STATBIT(bit, str) \
1789 if (status & (bit)) \
1790 strncat(stat_buf, (str), sizeof(stat_buf) - \
1791 strlen(stat_buf) - 2)
1793 stat_buf[0] = '\0';
1794 stat_buf[1] = '\0';
1795 INFOBIT(TIOCM_RTS, "|RTS");
1796 STATBIT(TIOCM_CTS, "|CTS");
1797 INFOBIT(TIOCM_DTR, "|DTR");
1798 STATBIT(TIOCM_DSR, "|DSR");
1799 STATBIT(TIOCM_CAR, "|CD");
1800 STATBIT(TIOCM_RNG, "|RI");
1801 if (stat_buf[0])
1802 stat_buf[0] = ' ';
1804 seq_puts(m, stat_buf);
1806 seq_putc(m, '\n');
1807 #undef STATBIT
1808 #undef INFOBIT
1809 out:
1810 mutex_unlock(&port->mutex);
1813 static int uart_proc_show(struct seq_file *m, void *v)
1815 struct tty_driver *ttydrv = m->private;
1816 struct uart_driver *drv = ttydrv->driver_state;
1817 int i;
1819 seq_printf(m, "serinfo:1.0 driver%s%s revision:%s\n", "", "", "");
1820 for (i = 0; i < drv->nr; i++)
1821 uart_line_info(m, drv, i);
1822 return 0;
1825 static int uart_proc_open(struct inode *inode, struct file *file)
1827 return single_open(file, uart_proc_show, PDE_DATA(inode));
1830 static const struct file_operations uart_proc_fops = {
1831 .owner = THIS_MODULE,
1832 .open = uart_proc_open,
1833 .read = seq_read,
1834 .llseek = seq_lseek,
1835 .release = single_release,
1837 #endif
1839 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1841 * uart_console_write - write a console message to a serial port
1842 * @port: the port to write the message
1843 * @s: array of characters
1844 * @count: number of characters in string to write
1845 * @putchar: function to write character to port
1847 void uart_console_write(struct uart_port *port, const char *s,
1848 unsigned int count,
1849 void (*putchar)(struct uart_port *, int))
1851 unsigned int i;
1853 for (i = 0; i < count; i++, s++) {
1854 if (*s == '\n')
1855 putchar(port, '\r');
1856 putchar(port, *s);
1859 EXPORT_SYMBOL_GPL(uart_console_write);
1862 * Check whether an invalid uart number has been specified, and
1863 * if so, search for the first available port that does have
1864 * console support.
1866 struct uart_port * __init
1867 uart_get_console(struct uart_port *ports, int nr, struct console *co)
1869 int idx = co->index;
1871 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
1872 ports[idx].membase == NULL))
1873 for (idx = 0; idx < nr; idx++)
1874 if (ports[idx].iobase != 0 ||
1875 ports[idx].membase != NULL)
1876 break;
1878 co->index = idx;
1880 return ports + idx;
1884 * uart_parse_earlycon - Parse earlycon options
1885 * @p: ptr to 2nd field (ie., just beyond '<name>,')
1886 * @iotype: ptr for decoded iotype (out)
1887 * @addr: ptr for decoded mapbase/iobase (out)
1888 * @options: ptr for <options> field; NULL if not present (out)
1890 * Decodes earlycon kernel command line parameters of the form
1891 * earlycon=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1892 * console=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1894 * The optional form
1895 * earlycon=<name>,0x<addr>,<options>
1896 * console=<name>,0x<addr>,<options>
1897 * is also accepted; the returned @iotype will be UPIO_MEM.
1899 * Returns 0 on success or -EINVAL on failure
1901 int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr,
1902 char **options)
1904 if (strncmp(p, "mmio,", 5) == 0) {
1905 *iotype = UPIO_MEM;
1906 p += 5;
1907 } else if (strncmp(p, "mmio16,", 7) == 0) {
1908 *iotype = UPIO_MEM16;
1909 p += 7;
1910 } else if (strncmp(p, "mmio32,", 7) == 0) {
1911 *iotype = UPIO_MEM32;
1912 p += 7;
1913 } else if (strncmp(p, "mmio32be,", 9) == 0) {
1914 *iotype = UPIO_MEM32BE;
1915 p += 9;
1916 } else if (strncmp(p, "mmio32native,", 13) == 0) {
1917 *iotype = IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) ?
1918 UPIO_MEM32BE : UPIO_MEM32;
1919 p += 13;
1920 } else if (strncmp(p, "io,", 3) == 0) {
1921 *iotype = UPIO_PORT;
1922 p += 3;
1923 } else if (strncmp(p, "0x", 2) == 0) {
1924 *iotype = UPIO_MEM;
1925 } else {
1926 return -EINVAL;
1930 * Before you replace it with kstrtoull(), think about options separator
1931 * (',') it will not tolerate
1933 *addr = simple_strtoull(p, NULL, 0);
1934 p = strchr(p, ',');
1935 if (p)
1936 p++;
1938 *options = p;
1939 return 0;
1941 EXPORT_SYMBOL_GPL(uart_parse_earlycon);
1944 * uart_parse_options - Parse serial port baud/parity/bits/flow control.
1945 * @options: pointer to option string
1946 * @baud: pointer to an 'int' variable for the baud rate.
1947 * @parity: pointer to an 'int' variable for the parity.
1948 * @bits: pointer to an 'int' variable for the number of data bits.
1949 * @flow: pointer to an 'int' variable for the flow control character.
1951 * uart_parse_options decodes a string containing the serial console
1952 * options. The format of the string is <baud><parity><bits><flow>,
1953 * eg: 115200n8r
1955 void
1956 uart_parse_options(char *options, int *baud, int *parity, int *bits, int *flow)
1958 char *s = options;
1960 *baud = simple_strtoul(s, NULL, 10);
1961 while (*s >= '0' && *s <= '9')
1962 s++;
1963 if (*s)
1964 *parity = *s++;
1965 if (*s)
1966 *bits = *s++ - '0';
1967 if (*s)
1968 *flow = *s;
1970 EXPORT_SYMBOL_GPL(uart_parse_options);
1973 * uart_set_options - setup the serial console parameters
1974 * @port: pointer to the serial ports uart_port structure
1975 * @co: console pointer
1976 * @baud: baud rate
1977 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1978 * @bits: number of data bits
1979 * @flow: flow control character - 'r' (rts)
1982 uart_set_options(struct uart_port *port, struct console *co,
1983 int baud, int parity, int bits, int flow)
1985 struct ktermios termios;
1986 static struct ktermios dummy;
1989 * Ensure that the serial console lock is initialised
1990 * early.
1991 * If this port is a console, then the spinlock is already
1992 * initialised.
1994 if (!(uart_console(port) && (port->cons->flags & CON_ENABLED))) {
1995 spin_lock_init(&port->lock);
1996 lockdep_set_class(&port->lock, &port_lock_key);
1999 memset(&termios, 0, sizeof(struct ktermios));
2001 termios.c_cflag |= CREAD | HUPCL | CLOCAL;
2002 tty_termios_encode_baud_rate(&termios, baud, baud);
2004 if (bits == 7)
2005 termios.c_cflag |= CS7;
2006 else
2007 termios.c_cflag |= CS8;
2009 switch (parity) {
2010 case 'o': case 'O':
2011 termios.c_cflag |= PARODD;
2012 /*fall through*/
2013 case 'e': case 'E':
2014 termios.c_cflag |= PARENB;
2015 break;
2018 if (flow == 'r')
2019 termios.c_cflag |= CRTSCTS;
2022 * some uarts on other side don't support no flow control.
2023 * So we set * DTR in host uart to make them happy
2025 port->mctrl |= TIOCM_DTR;
2027 port->ops->set_termios(port, &termios, &dummy);
2029 * Allow the setting of the UART parameters with a NULL console
2030 * too:
2032 if (co)
2033 co->cflag = termios.c_cflag;
2035 return 0;
2037 EXPORT_SYMBOL_GPL(uart_set_options);
2038 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
2041 * uart_change_pm - set power state of the port
2043 * @state: port descriptor
2044 * @pm_state: new state
2046 * Locking: port->mutex has to be held
2048 static void uart_change_pm(struct uart_state *state,
2049 enum uart_pm_state pm_state)
2051 struct uart_port *port = uart_port_check(state);
2053 if (state->pm_state != pm_state) {
2054 if (port && port->ops->pm)
2055 port->ops->pm(port, pm_state, state->pm_state);
2056 state->pm_state = pm_state;
2060 struct uart_match {
2061 struct uart_port *port;
2062 struct uart_driver *driver;
2065 static int serial_match_port(struct device *dev, void *data)
2067 struct uart_match *match = data;
2068 struct tty_driver *tty_drv = match->driver->tty_driver;
2069 dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
2070 match->port->line;
2072 return dev->devt == devt; /* Actually, only one tty per port */
2075 int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport)
2077 struct uart_state *state = drv->state + uport->line;
2078 struct tty_port *port = &state->port;
2079 struct device *tty_dev;
2080 struct uart_match match = {uport, drv};
2082 mutex_lock(&port->mutex);
2084 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2085 if (device_may_wakeup(tty_dev)) {
2086 if (!enable_irq_wake(uport->irq))
2087 uport->irq_wake = 1;
2088 put_device(tty_dev);
2089 mutex_unlock(&port->mutex);
2090 return 0;
2092 put_device(tty_dev);
2094 /* Nothing to do if the console is not suspending */
2095 if (!console_suspend_enabled && uart_console(uport))
2096 goto unlock;
2098 uport->suspended = 1;
2100 if (tty_port_initialized(port)) {
2101 const struct uart_ops *ops = uport->ops;
2102 int tries;
2104 tty_port_set_suspended(port, 1);
2105 tty_port_set_initialized(port, 0);
2107 spin_lock_irq(&uport->lock);
2108 ops->stop_tx(uport);
2109 ops->set_mctrl(uport, 0);
2110 ops->stop_rx(uport);
2111 spin_unlock_irq(&uport->lock);
2114 * Wait for the transmitter to empty.
2116 for (tries = 3; !ops->tx_empty(uport) && tries; tries--)
2117 msleep(10);
2118 if (!tries)
2119 dev_err(uport->dev, "%s%d: Unable to drain transmitter\n",
2120 drv->dev_name,
2121 drv->tty_driver->name_base + uport->line);
2123 ops->shutdown(uport);
2127 * Disable the console device before suspending.
2129 if (uart_console(uport))
2130 console_stop(uport->cons);
2132 uart_change_pm(state, UART_PM_STATE_OFF);
2133 unlock:
2134 mutex_unlock(&port->mutex);
2136 return 0;
2139 int uart_resume_port(struct uart_driver *drv, struct uart_port *uport)
2141 struct uart_state *state = drv->state + uport->line;
2142 struct tty_port *port = &state->port;
2143 struct device *tty_dev;
2144 struct uart_match match = {uport, drv};
2145 struct ktermios termios;
2147 mutex_lock(&port->mutex);
2149 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2150 if (!uport->suspended && device_may_wakeup(tty_dev)) {
2151 if (uport->irq_wake) {
2152 disable_irq_wake(uport->irq);
2153 uport->irq_wake = 0;
2155 put_device(tty_dev);
2156 mutex_unlock(&port->mutex);
2157 return 0;
2159 put_device(tty_dev);
2160 uport->suspended = 0;
2163 * Re-enable the console device after suspending.
2165 if (uart_console(uport)) {
2167 * First try to use the console cflag setting.
2169 memset(&termios, 0, sizeof(struct ktermios));
2170 termios.c_cflag = uport->cons->cflag;
2173 * If that's unset, use the tty termios setting.
2175 if (port->tty && termios.c_cflag == 0)
2176 termios = port->tty->termios;
2178 if (console_suspend_enabled)
2179 uart_change_pm(state, UART_PM_STATE_ON);
2180 uport->ops->set_termios(uport, &termios, NULL);
2181 if (console_suspend_enabled)
2182 console_start(uport->cons);
2185 if (tty_port_suspended(port)) {
2186 const struct uart_ops *ops = uport->ops;
2187 int ret;
2189 uart_change_pm(state, UART_PM_STATE_ON);
2190 spin_lock_irq(&uport->lock);
2191 ops->set_mctrl(uport, 0);
2192 spin_unlock_irq(&uport->lock);
2193 if (console_suspend_enabled || !uart_console(uport)) {
2194 /* Protected by port mutex for now */
2195 struct tty_struct *tty = port->tty;
2196 ret = ops->startup(uport);
2197 if (ret == 0) {
2198 if (tty)
2199 uart_change_speed(tty, state, NULL);
2200 spin_lock_irq(&uport->lock);
2201 ops->set_mctrl(uport, uport->mctrl);
2202 ops->start_tx(uport);
2203 spin_unlock_irq(&uport->lock);
2204 tty_port_set_initialized(port, 1);
2205 } else {
2207 * Failed to resume - maybe hardware went away?
2208 * Clear the "initialized" flag so we won't try
2209 * to call the low level drivers shutdown method.
2211 uart_shutdown(tty, state);
2215 tty_port_set_suspended(port, 0);
2218 mutex_unlock(&port->mutex);
2220 return 0;
2223 static inline void
2224 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2226 char address[64];
2228 switch (port->iotype) {
2229 case UPIO_PORT:
2230 snprintf(address, sizeof(address), "I/O 0x%lx", port->iobase);
2231 break;
2232 case UPIO_HUB6:
2233 snprintf(address, sizeof(address),
2234 "I/O 0x%lx offset 0x%x", port->iobase, port->hub6);
2235 break;
2236 case UPIO_MEM:
2237 case UPIO_MEM16:
2238 case UPIO_MEM32:
2239 case UPIO_MEM32BE:
2240 case UPIO_AU:
2241 case UPIO_TSI:
2242 snprintf(address, sizeof(address),
2243 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2244 break;
2245 default:
2246 strlcpy(address, "*unknown*", sizeof(address));
2247 break;
2250 printk(KERN_INFO "%s%s%s%d at %s (irq = %d, base_baud = %d) is a %s\n",
2251 port->dev ? dev_name(port->dev) : "",
2252 port->dev ? ": " : "",
2253 drv->dev_name,
2254 drv->tty_driver->name_base + port->line,
2255 address, port->irq, port->uartclk / 16, uart_type(port));
2258 static void
2259 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2260 struct uart_port *port)
2262 unsigned int flags;
2265 * If there isn't a port here, don't do anything further.
2267 if (!port->iobase && !port->mapbase && !port->membase)
2268 return;
2271 * Now do the auto configuration stuff. Note that config_port
2272 * is expected to claim the resources and map the port for us.
2274 flags = 0;
2275 if (port->flags & UPF_AUTO_IRQ)
2276 flags |= UART_CONFIG_IRQ;
2277 if (port->flags & UPF_BOOT_AUTOCONF) {
2278 if (!(port->flags & UPF_FIXED_TYPE)) {
2279 port->type = PORT_UNKNOWN;
2280 flags |= UART_CONFIG_TYPE;
2282 port->ops->config_port(port, flags);
2285 if (port->type != PORT_UNKNOWN) {
2286 unsigned long flags;
2288 uart_report_port(drv, port);
2290 /* Power up port for set_mctrl() */
2291 uart_change_pm(state, UART_PM_STATE_ON);
2294 * Ensure that the modem control lines are de-activated.
2295 * keep the DTR setting that is set in uart_set_options()
2296 * We probably don't need a spinlock around this, but
2298 spin_lock_irqsave(&port->lock, flags);
2299 port->ops->set_mctrl(port, port->mctrl & TIOCM_DTR);
2300 spin_unlock_irqrestore(&port->lock, flags);
2303 * If this driver supports console, and it hasn't been
2304 * successfully registered yet, try to re-register it.
2305 * It may be that the port was not available.
2307 if (port->cons && !(port->cons->flags & CON_ENABLED))
2308 register_console(port->cons);
2311 * Power down all ports by default, except the
2312 * console if we have one.
2314 if (!uart_console(port))
2315 uart_change_pm(state, UART_PM_STATE_OFF);
2319 #ifdef CONFIG_CONSOLE_POLL
2321 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2323 struct uart_driver *drv = driver->driver_state;
2324 struct uart_state *state = drv->state + line;
2325 struct tty_port *tport;
2326 struct uart_port *port;
2327 int baud = 9600;
2328 int bits = 8;
2329 int parity = 'n';
2330 int flow = 'n';
2331 int ret = 0;
2333 if (!state)
2334 return -1;
2336 tport = &state->port;
2337 mutex_lock(&tport->mutex);
2339 port = uart_port_check(state);
2340 if (!port || !(port->ops->poll_get_char && port->ops->poll_put_char)) {
2341 ret = -1;
2342 goto out;
2345 if (port->ops->poll_init) {
2347 * We don't set initialized as we only initialized the hw,
2348 * e.g. state->xmit is still uninitialized.
2350 if (!tty_port_initialized(tport))
2351 ret = port->ops->poll_init(port);
2354 if (!ret && options) {
2355 uart_parse_options(options, &baud, &parity, &bits, &flow);
2356 ret = uart_set_options(port, NULL, baud, parity, bits, flow);
2358 out:
2359 mutex_unlock(&tport->mutex);
2360 return ret;
2363 static int uart_poll_get_char(struct tty_driver *driver, int line)
2365 struct uart_driver *drv = driver->driver_state;
2366 struct uart_state *state = drv->state + line;
2367 struct uart_port *port;
2368 int ret = -1;
2370 if (state) {
2371 port = uart_port_ref(state);
2372 if (port) {
2373 ret = port->ops->poll_get_char(port);
2374 uart_port_deref(port);
2377 return ret;
2380 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2382 struct uart_driver *drv = driver->driver_state;
2383 struct uart_state *state = drv->state + line;
2384 struct uart_port *port;
2386 if (!state)
2387 return;
2389 port = uart_port_ref(state);
2390 if (!port)
2391 return;
2393 if (ch == '\n')
2394 port->ops->poll_put_char(port, '\r');
2395 port->ops->poll_put_char(port, ch);
2396 uart_port_deref(port);
2398 #endif
2400 static const struct tty_operations uart_ops = {
2401 .open = uart_open,
2402 .close = uart_close,
2403 .write = uart_write,
2404 .put_char = uart_put_char,
2405 .flush_chars = uart_flush_chars,
2406 .write_room = uart_write_room,
2407 .chars_in_buffer= uart_chars_in_buffer,
2408 .flush_buffer = uart_flush_buffer,
2409 .ioctl = uart_ioctl,
2410 .throttle = uart_throttle,
2411 .unthrottle = uart_unthrottle,
2412 .send_xchar = uart_send_xchar,
2413 .set_termios = uart_set_termios,
2414 .set_ldisc = uart_set_ldisc,
2415 .stop = uart_stop,
2416 .start = uart_start,
2417 .hangup = uart_hangup,
2418 .break_ctl = uart_break_ctl,
2419 .wait_until_sent= uart_wait_until_sent,
2420 #ifdef CONFIG_PROC_FS
2421 .proc_fops = &uart_proc_fops,
2422 #endif
2423 .tiocmget = uart_tiocmget,
2424 .tiocmset = uart_tiocmset,
2425 .get_icount = uart_get_icount,
2426 #ifdef CONFIG_CONSOLE_POLL
2427 .poll_init = uart_poll_init,
2428 .poll_get_char = uart_poll_get_char,
2429 .poll_put_char = uart_poll_put_char,
2430 #endif
2433 static const struct tty_port_operations uart_port_ops = {
2434 .carrier_raised = uart_carrier_raised,
2435 .dtr_rts = uart_dtr_rts,
2436 .activate = uart_port_activate,
2437 .shutdown = uart_tty_port_shutdown,
2441 * uart_register_driver - register a driver with the uart core layer
2442 * @drv: low level driver structure
2444 * Register a uart driver with the core driver. We in turn register
2445 * with the tty layer, and initialise the core driver per-port state.
2447 * We have a proc file in /proc/tty/driver which is named after the
2448 * normal driver.
2450 * drv->port should be NULL, and the per-port structures should be
2451 * registered using uart_add_one_port after this call has succeeded.
2453 int uart_register_driver(struct uart_driver *drv)
2455 struct tty_driver *normal;
2456 int i, retval;
2458 BUG_ON(drv->state);
2461 * Maybe we should be using a slab cache for this, especially if
2462 * we have a large number of ports to handle.
2464 drv->state = kzalloc(sizeof(struct uart_state) * drv->nr, GFP_KERNEL);
2465 if (!drv->state)
2466 goto out;
2468 normal = alloc_tty_driver(drv->nr);
2469 if (!normal)
2470 goto out_kfree;
2472 drv->tty_driver = normal;
2474 normal->driver_name = drv->driver_name;
2475 normal->name = drv->dev_name;
2476 normal->major = drv->major;
2477 normal->minor_start = drv->minor;
2478 normal->type = TTY_DRIVER_TYPE_SERIAL;
2479 normal->subtype = SERIAL_TYPE_NORMAL;
2480 normal->init_termios = tty_std_termios;
2481 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2482 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2483 normal->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2484 normal->driver_state = drv;
2485 tty_set_operations(normal, &uart_ops);
2488 * Initialise the UART state(s).
2490 for (i = 0; i < drv->nr; i++) {
2491 struct uart_state *state = drv->state + i;
2492 struct tty_port *port = &state->port;
2494 tty_port_init(port);
2495 port->ops = &uart_port_ops;
2498 retval = tty_register_driver(normal);
2499 if (retval >= 0)
2500 return retval;
2502 for (i = 0; i < drv->nr; i++)
2503 tty_port_destroy(&drv->state[i].port);
2504 put_tty_driver(normal);
2505 out_kfree:
2506 kfree(drv->state);
2507 out:
2508 return -ENOMEM;
2512 * uart_unregister_driver - remove a driver from the uart core layer
2513 * @drv: low level driver structure
2515 * Remove all references to a driver from the core driver. The low
2516 * level driver must have removed all its ports via the
2517 * uart_remove_one_port() if it registered them with uart_add_one_port().
2518 * (ie, drv->port == NULL)
2520 void uart_unregister_driver(struct uart_driver *drv)
2522 struct tty_driver *p = drv->tty_driver;
2523 unsigned int i;
2525 tty_unregister_driver(p);
2526 put_tty_driver(p);
2527 for (i = 0; i < drv->nr; i++)
2528 tty_port_destroy(&drv->state[i].port);
2529 kfree(drv->state);
2530 drv->state = NULL;
2531 drv->tty_driver = NULL;
2534 struct tty_driver *uart_console_device(struct console *co, int *index)
2536 struct uart_driver *p = co->data;
2537 *index = co->index;
2538 return p->tty_driver;
2541 static ssize_t uart_get_attr_uartclk(struct device *dev,
2542 struct device_attribute *attr, char *buf)
2544 struct serial_struct tmp;
2545 struct tty_port *port = dev_get_drvdata(dev);
2547 uart_get_info(port, &tmp);
2548 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.baud_base * 16);
2551 static ssize_t uart_get_attr_type(struct device *dev,
2552 struct device_attribute *attr, char *buf)
2554 struct serial_struct tmp;
2555 struct tty_port *port = dev_get_drvdata(dev);
2557 uart_get_info(port, &tmp);
2558 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.type);
2560 static ssize_t uart_get_attr_line(struct device *dev,
2561 struct device_attribute *attr, char *buf)
2563 struct serial_struct tmp;
2564 struct tty_port *port = dev_get_drvdata(dev);
2566 uart_get_info(port, &tmp);
2567 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.line);
2570 static ssize_t uart_get_attr_port(struct device *dev,
2571 struct device_attribute *attr, char *buf)
2573 struct serial_struct tmp;
2574 struct tty_port *port = dev_get_drvdata(dev);
2575 unsigned long ioaddr;
2577 uart_get_info(port, &tmp);
2578 ioaddr = tmp.port;
2579 if (HIGH_BITS_OFFSET)
2580 ioaddr |= (unsigned long)tmp.port_high << HIGH_BITS_OFFSET;
2581 return snprintf(buf, PAGE_SIZE, "0x%lX\n", ioaddr);
2584 static ssize_t uart_get_attr_irq(struct device *dev,
2585 struct device_attribute *attr, char *buf)
2587 struct serial_struct tmp;
2588 struct tty_port *port = dev_get_drvdata(dev);
2590 uart_get_info(port, &tmp);
2591 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.irq);
2594 static ssize_t uart_get_attr_flags(struct device *dev,
2595 struct device_attribute *attr, char *buf)
2597 struct serial_struct tmp;
2598 struct tty_port *port = dev_get_drvdata(dev);
2600 uart_get_info(port, &tmp);
2601 return snprintf(buf, PAGE_SIZE, "0x%X\n", tmp.flags);
2604 static ssize_t uart_get_attr_xmit_fifo_size(struct device *dev,
2605 struct device_attribute *attr, char *buf)
2607 struct serial_struct tmp;
2608 struct tty_port *port = dev_get_drvdata(dev);
2610 uart_get_info(port, &tmp);
2611 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.xmit_fifo_size);
2615 static ssize_t uart_get_attr_close_delay(struct device *dev,
2616 struct device_attribute *attr, char *buf)
2618 struct serial_struct tmp;
2619 struct tty_port *port = dev_get_drvdata(dev);
2621 uart_get_info(port, &tmp);
2622 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.close_delay);
2626 static ssize_t uart_get_attr_closing_wait(struct device *dev,
2627 struct device_attribute *attr, char *buf)
2629 struct serial_struct tmp;
2630 struct tty_port *port = dev_get_drvdata(dev);
2632 uart_get_info(port, &tmp);
2633 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.closing_wait);
2636 static ssize_t uart_get_attr_custom_divisor(struct device *dev,
2637 struct device_attribute *attr, char *buf)
2639 struct serial_struct tmp;
2640 struct tty_port *port = dev_get_drvdata(dev);
2642 uart_get_info(port, &tmp);
2643 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.custom_divisor);
2646 static ssize_t uart_get_attr_io_type(struct device *dev,
2647 struct device_attribute *attr, char *buf)
2649 struct serial_struct tmp;
2650 struct tty_port *port = dev_get_drvdata(dev);
2652 uart_get_info(port, &tmp);
2653 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.io_type);
2656 static ssize_t uart_get_attr_iomem_base(struct device *dev,
2657 struct device_attribute *attr, char *buf)
2659 struct serial_struct tmp;
2660 struct tty_port *port = dev_get_drvdata(dev);
2662 uart_get_info(port, &tmp);
2663 return snprintf(buf, PAGE_SIZE, "0x%lX\n", (unsigned long)tmp.iomem_base);
2666 static ssize_t uart_get_attr_iomem_reg_shift(struct device *dev,
2667 struct device_attribute *attr, char *buf)
2669 struct serial_struct tmp;
2670 struct tty_port *port = dev_get_drvdata(dev);
2672 uart_get_info(port, &tmp);
2673 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.iomem_reg_shift);
2676 static DEVICE_ATTR(type, S_IRUSR | S_IRGRP, uart_get_attr_type, NULL);
2677 static DEVICE_ATTR(line, S_IRUSR | S_IRGRP, uart_get_attr_line, NULL);
2678 static DEVICE_ATTR(port, S_IRUSR | S_IRGRP, uart_get_attr_port, NULL);
2679 static DEVICE_ATTR(irq, S_IRUSR | S_IRGRP, uart_get_attr_irq, NULL);
2680 static DEVICE_ATTR(flags, S_IRUSR | S_IRGRP, uart_get_attr_flags, NULL);
2681 static DEVICE_ATTR(xmit_fifo_size, S_IRUSR | S_IRGRP, uart_get_attr_xmit_fifo_size, NULL);
2682 static DEVICE_ATTR(uartclk, S_IRUSR | S_IRGRP, uart_get_attr_uartclk, NULL);
2683 static DEVICE_ATTR(close_delay, S_IRUSR | S_IRGRP, uart_get_attr_close_delay, NULL);
2684 static DEVICE_ATTR(closing_wait, S_IRUSR | S_IRGRP, uart_get_attr_closing_wait, NULL);
2685 static DEVICE_ATTR(custom_divisor, S_IRUSR | S_IRGRP, uart_get_attr_custom_divisor, NULL);
2686 static DEVICE_ATTR(io_type, S_IRUSR | S_IRGRP, uart_get_attr_io_type, NULL);
2687 static DEVICE_ATTR(iomem_base, S_IRUSR | S_IRGRP, uart_get_attr_iomem_base, NULL);
2688 static DEVICE_ATTR(iomem_reg_shift, S_IRUSR | S_IRGRP, uart_get_attr_iomem_reg_shift, NULL);
2690 static struct attribute *tty_dev_attrs[] = {
2691 &dev_attr_type.attr,
2692 &dev_attr_line.attr,
2693 &dev_attr_port.attr,
2694 &dev_attr_irq.attr,
2695 &dev_attr_flags.attr,
2696 &dev_attr_xmit_fifo_size.attr,
2697 &dev_attr_uartclk.attr,
2698 &dev_attr_close_delay.attr,
2699 &dev_attr_closing_wait.attr,
2700 &dev_attr_custom_divisor.attr,
2701 &dev_attr_io_type.attr,
2702 &dev_attr_iomem_base.attr,
2703 &dev_attr_iomem_reg_shift.attr,
2704 NULL,
2707 static const struct attribute_group tty_dev_attr_group = {
2708 .attrs = tty_dev_attrs,
2712 * uart_add_one_port - attach a driver-defined port structure
2713 * @drv: pointer to the uart low level driver structure for this port
2714 * @uport: uart port structure to use for this port.
2716 * This allows the driver to register its own uart_port structure
2717 * with the core driver. The main purpose is to allow the low
2718 * level uart drivers to expand uart_port, rather than having yet
2719 * more levels of structures.
2721 int uart_add_one_port(struct uart_driver *drv, struct uart_port *uport)
2723 struct uart_state *state;
2724 struct tty_port *port;
2725 int ret = 0;
2726 struct device *tty_dev;
2727 int num_groups;
2729 BUG_ON(in_interrupt());
2731 if (uport->line >= drv->nr)
2732 return -EINVAL;
2734 state = drv->state + uport->line;
2735 port = &state->port;
2737 mutex_lock(&port_mutex);
2738 mutex_lock(&port->mutex);
2739 if (state->uart_port) {
2740 ret = -EINVAL;
2741 goto out;
2744 /* Link the port to the driver state table and vice versa */
2745 atomic_set(&state->refcount, 1);
2746 init_waitqueue_head(&state->remove_wait);
2747 state->uart_port = uport;
2748 uport->state = state;
2750 state->pm_state = UART_PM_STATE_UNDEFINED;
2751 uport->cons = drv->cons;
2752 uport->minor = drv->tty_driver->minor_start + uport->line;
2755 * If this port is a console, then the spinlock is already
2756 * initialised.
2758 if (!(uart_console(uport) && (uport->cons->flags & CON_ENABLED))) {
2759 spin_lock_init(&uport->lock);
2760 lockdep_set_class(&uport->lock, &port_lock_key);
2762 if (uport->cons && uport->dev)
2763 of_console_check(uport->dev->of_node, uport->cons->name, uport->line);
2765 uart_configure_port(drv, state, uport);
2767 port->console = uart_console(uport);
2769 num_groups = 2;
2770 if (uport->attr_group)
2771 num_groups++;
2773 uport->tty_groups = kcalloc(num_groups, sizeof(*uport->tty_groups),
2774 GFP_KERNEL);
2775 if (!uport->tty_groups) {
2776 ret = -ENOMEM;
2777 goto out;
2779 uport->tty_groups[0] = &tty_dev_attr_group;
2780 if (uport->attr_group)
2781 uport->tty_groups[1] = uport->attr_group;
2784 * Register the port whether it's detected or not. This allows
2785 * setserial to be used to alter this port's parameters.
2787 tty_dev = tty_port_register_device_attr(port, drv->tty_driver,
2788 uport->line, uport->dev, port, uport->tty_groups);
2789 if (likely(!IS_ERR(tty_dev))) {
2790 device_set_wakeup_capable(tty_dev, 1);
2791 } else {
2792 dev_err(uport->dev, "Cannot register tty device on line %d\n",
2793 uport->line);
2797 * Ensure UPF_DEAD is not set.
2799 uport->flags &= ~UPF_DEAD;
2801 out:
2802 mutex_unlock(&port->mutex);
2803 mutex_unlock(&port_mutex);
2805 return ret;
2809 * uart_remove_one_port - detach a driver defined port structure
2810 * @drv: pointer to the uart low level driver structure for this port
2811 * @uport: uart port structure for this port
2813 * This unhooks (and hangs up) the specified port structure from the
2814 * core driver. No further calls will be made to the low-level code
2815 * for this port.
2817 int uart_remove_one_port(struct uart_driver *drv, struct uart_port *uport)
2819 struct uart_state *state = drv->state + uport->line;
2820 struct tty_port *port = &state->port;
2821 struct uart_port *uart_port;
2822 struct tty_struct *tty;
2823 int ret = 0;
2825 BUG_ON(in_interrupt());
2827 mutex_lock(&port_mutex);
2830 * Mark the port "dead" - this prevents any opens from
2831 * succeeding while we shut down the port.
2833 mutex_lock(&port->mutex);
2834 uart_port = uart_port_check(state);
2835 if (uart_port != uport)
2836 dev_alert(uport->dev, "Removing wrong port: %p != %p\n",
2837 uart_port, uport);
2839 if (!uart_port) {
2840 mutex_unlock(&port->mutex);
2841 ret = -EINVAL;
2842 goto out;
2844 uport->flags |= UPF_DEAD;
2845 mutex_unlock(&port->mutex);
2848 * Remove the devices from the tty layer
2850 tty_unregister_device(drv->tty_driver, uport->line);
2852 tty = tty_port_tty_get(port);
2853 if (tty) {
2854 tty_vhangup(port->tty);
2855 tty_kref_put(tty);
2859 * If the port is used as a console, unregister it
2861 if (uart_console(uport))
2862 unregister_console(uport->cons);
2865 * Free the port IO and memory resources, if any.
2867 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
2868 uport->ops->release_port(uport);
2869 kfree(uport->tty_groups);
2872 * Indicate that there isn't a port here anymore.
2874 uport->type = PORT_UNKNOWN;
2876 mutex_lock(&port->mutex);
2877 WARN_ON(atomic_dec_return(&state->refcount) < 0);
2878 wait_event(state->remove_wait, !atomic_read(&state->refcount));
2879 state->uart_port = NULL;
2880 mutex_unlock(&port->mutex);
2881 out:
2882 mutex_unlock(&port_mutex);
2884 return ret;
2888 * Are the two ports equivalent?
2890 int uart_match_port(struct uart_port *port1, struct uart_port *port2)
2892 if (port1->iotype != port2->iotype)
2893 return 0;
2895 switch (port1->iotype) {
2896 case UPIO_PORT:
2897 return (port1->iobase == port2->iobase);
2898 case UPIO_HUB6:
2899 return (port1->iobase == port2->iobase) &&
2900 (port1->hub6 == port2->hub6);
2901 case UPIO_MEM:
2902 case UPIO_MEM16:
2903 case UPIO_MEM32:
2904 case UPIO_MEM32BE:
2905 case UPIO_AU:
2906 case UPIO_TSI:
2907 return (port1->mapbase == port2->mapbase);
2909 return 0;
2911 EXPORT_SYMBOL(uart_match_port);
2914 * uart_handle_dcd_change - handle a change of carrier detect state
2915 * @uport: uart_port structure for the open port
2916 * @status: new carrier detect status, nonzero if active
2918 * Caller must hold uport->lock
2920 void uart_handle_dcd_change(struct uart_port *uport, unsigned int status)
2922 struct tty_port *port = &uport->state->port;
2923 struct tty_struct *tty = port->tty;
2924 struct tty_ldisc *ld;
2926 lockdep_assert_held_once(&uport->lock);
2928 if (tty) {
2929 ld = tty_ldisc_ref(tty);
2930 if (ld) {
2931 if (ld->ops->dcd_change)
2932 ld->ops->dcd_change(tty, status);
2933 tty_ldisc_deref(ld);
2937 uport->icount.dcd++;
2939 if (uart_dcd_enabled(uport)) {
2940 if (status)
2941 wake_up_interruptible(&port->open_wait);
2942 else if (tty)
2943 tty_hangup(tty);
2946 EXPORT_SYMBOL_GPL(uart_handle_dcd_change);
2949 * uart_handle_cts_change - handle a change of clear-to-send state
2950 * @uport: uart_port structure for the open port
2951 * @status: new clear to send status, nonzero if active
2953 * Caller must hold uport->lock
2955 void uart_handle_cts_change(struct uart_port *uport, unsigned int status)
2957 lockdep_assert_held_once(&uport->lock);
2959 uport->icount.cts++;
2961 if (uart_softcts_mode(uport)) {
2962 if (uport->hw_stopped) {
2963 if (status) {
2964 uport->hw_stopped = 0;
2965 uport->ops->start_tx(uport);
2966 uart_write_wakeup(uport);
2968 } else {
2969 if (!status) {
2970 uport->hw_stopped = 1;
2971 uport->ops->stop_tx(uport);
2977 EXPORT_SYMBOL_GPL(uart_handle_cts_change);
2980 * uart_insert_char - push a char to the uart layer
2982 * User is responsible to call tty_flip_buffer_push when they are done with
2983 * insertion.
2985 * @port: corresponding port
2986 * @status: state of the serial port RX buffer (LSR for 8250)
2987 * @overrun: mask of overrun bits in @status
2988 * @ch: character to push
2989 * @flag: flag for the character (see TTY_NORMAL and friends)
2991 void uart_insert_char(struct uart_port *port, unsigned int status,
2992 unsigned int overrun, unsigned int ch, unsigned int flag)
2994 struct tty_port *tport = &port->state->port;
2996 if ((status & port->ignore_status_mask & ~overrun) == 0)
2997 if (tty_insert_flip_char(tport, ch, flag) == 0)
2998 ++port->icount.buf_overrun;
3001 * Overrun is special. Since it's reported immediately,
3002 * it doesn't affect the current character.
3004 if (status & ~port->ignore_status_mask & overrun)
3005 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN) == 0)
3006 ++port->icount.buf_overrun;
3008 EXPORT_SYMBOL_GPL(uart_insert_char);
3010 EXPORT_SYMBOL(uart_write_wakeup);
3011 EXPORT_SYMBOL(uart_register_driver);
3012 EXPORT_SYMBOL(uart_unregister_driver);
3013 EXPORT_SYMBOL(uart_suspend_port);
3014 EXPORT_SYMBOL(uart_resume_port);
3015 EXPORT_SYMBOL(uart_add_one_port);
3016 EXPORT_SYMBOL(uart_remove_one_port);
3018 MODULE_DESCRIPTION("Serial driver core");
3019 MODULE_LICENSE("GPL");