Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[cris-mirror.git] / drivers / tty / serial / serial_core.c
blobc8dde56b532b2d88fdf15f29f7e81251c39be4ff
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Driver core for serial ports
5 * Based on drivers/char/serial.c, by Linus Torvalds, Theodore Ts'o.
7 * Copyright 1999 ARM Limited
8 * Copyright (C) 2000-2001 Deep Blue Solutions Ltd.
9 */
10 #include <linux/module.h>
11 #include <linux/tty.h>
12 #include <linux/tty_flip.h>
13 #include <linux/slab.h>
14 #include <linux/sched/signal.h>
15 #include <linux/init.h>
16 #include <linux/console.h>
17 #include <linux/of.h>
18 #include <linux/proc_fs.h>
19 #include <linux/seq_file.h>
20 #include <linux/device.h>
21 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
22 #include <linux/serial_core.h>
23 #include <linux/delay.h>
24 #include <linux/mutex.h>
26 #include <linux/irq.h>
27 #include <linux/uaccess.h>
30 * This is used to lock changes in serial line configuration.
32 static DEFINE_MUTEX(port_mutex);
35 * lockdep: port->lock is initialized in two places, but we
36 * want only one lock-class:
38 static struct lock_class_key port_lock_key;
40 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
42 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
43 struct ktermios *old_termios);
44 static void uart_wait_until_sent(struct tty_struct *tty, int timeout);
45 static void uart_change_pm(struct uart_state *state,
46 enum uart_pm_state pm_state);
48 static void uart_port_shutdown(struct tty_port *port);
50 static int uart_dcd_enabled(struct uart_port *uport)
52 return !!(uport->status & UPSTAT_DCD_ENABLE);
55 static inline struct uart_port *uart_port_ref(struct uart_state *state)
57 if (atomic_add_unless(&state->refcount, 1, 0))
58 return state->uart_port;
59 return NULL;
62 static inline void uart_port_deref(struct uart_port *uport)
64 if (atomic_dec_and_test(&uport->state->refcount))
65 wake_up(&uport->state->remove_wait);
68 #define uart_port_lock(state, flags) \
69 ({ \
70 struct uart_port *__uport = uart_port_ref(state); \
71 if (__uport) \
72 spin_lock_irqsave(&__uport->lock, flags); \
73 __uport; \
76 #define uart_port_unlock(uport, flags) \
77 ({ \
78 struct uart_port *__uport = uport; \
79 if (__uport) { \
80 spin_unlock_irqrestore(&__uport->lock, flags); \
81 uart_port_deref(__uport); \
82 } \
85 static inline struct uart_port *uart_port_check(struct uart_state *state)
87 lockdep_assert_held(&state->port.mutex);
88 return state->uart_port;
92 * This routine is used by the interrupt handler to schedule processing in
93 * the software interrupt portion of the driver.
95 void uart_write_wakeup(struct uart_port *port)
97 struct uart_state *state = port->state;
99 * This means you called this function _after_ the port was
100 * closed. No cookie for you.
102 BUG_ON(!state);
103 tty_port_tty_wakeup(&state->port);
106 static void uart_stop(struct tty_struct *tty)
108 struct uart_state *state = tty->driver_data;
109 struct uart_port *port;
110 unsigned long flags;
112 port = uart_port_lock(state, flags);
113 if (port)
114 port->ops->stop_tx(port);
115 uart_port_unlock(port, flags);
118 static void __uart_start(struct tty_struct *tty)
120 struct uart_state *state = tty->driver_data;
121 struct uart_port *port = state->uart_port;
123 if (port && !uart_tx_stopped(port))
124 port->ops->start_tx(port);
127 static void uart_start(struct tty_struct *tty)
129 struct uart_state *state = tty->driver_data;
130 struct uart_port *port;
131 unsigned long flags;
133 port = uart_port_lock(state, flags);
134 __uart_start(tty);
135 uart_port_unlock(port, flags);
138 static void
139 uart_update_mctrl(struct uart_port *port, unsigned int set, unsigned int clear)
141 unsigned long flags;
142 unsigned int old;
144 spin_lock_irqsave(&port->lock, flags);
145 old = port->mctrl;
146 port->mctrl = (old & ~clear) | set;
147 if (old != port->mctrl)
148 port->ops->set_mctrl(port, port->mctrl);
149 spin_unlock_irqrestore(&port->lock, flags);
152 #define uart_set_mctrl(port, set) uart_update_mctrl(port, set, 0)
153 #define uart_clear_mctrl(port, clear) uart_update_mctrl(port, 0, clear)
155 static void uart_port_dtr_rts(struct uart_port *uport, int raise)
157 int rs485_on = uport->rs485_config &&
158 (uport->rs485.flags & SER_RS485_ENABLED);
159 int RTS_after_send = !!(uport->rs485.flags & SER_RS485_RTS_AFTER_SEND);
161 if (raise) {
162 if (rs485_on && !RTS_after_send) {
163 uart_set_mctrl(uport, TIOCM_DTR);
164 uart_clear_mctrl(uport, TIOCM_RTS);
165 } else {
166 uart_set_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
168 } else {
169 unsigned int clear = TIOCM_DTR;
171 clear |= (!rs485_on || !RTS_after_send) ? TIOCM_RTS : 0;
172 uart_clear_mctrl(uport, clear);
177 * Startup the port. This will be called once per open. All calls
178 * will be serialised by the per-port mutex.
180 static int uart_port_startup(struct tty_struct *tty, struct uart_state *state,
181 int init_hw)
183 struct uart_port *uport = uart_port_check(state);
184 unsigned long page;
185 int retval = 0;
187 if (uport->type == PORT_UNKNOWN)
188 return 1;
191 * Make sure the device is in D0 state.
193 uart_change_pm(state, UART_PM_STATE_ON);
196 * Initialise and allocate the transmit and temporary
197 * buffer.
199 if (!state->xmit.buf) {
200 /* This is protected by the per port mutex */
201 page = get_zeroed_page(GFP_KERNEL);
202 if (!page)
203 return -ENOMEM;
205 state->xmit.buf = (unsigned char *) page;
206 uart_circ_clear(&state->xmit);
209 retval = uport->ops->startup(uport);
210 if (retval == 0) {
211 if (uart_console(uport) && uport->cons->cflag) {
212 tty->termios.c_cflag = uport->cons->cflag;
213 uport->cons->cflag = 0;
216 * Initialise the hardware port settings.
218 uart_change_speed(tty, state, NULL);
221 * Setup the RTS and DTR signals once the
222 * port is open and ready to respond.
224 if (init_hw && C_BAUD(tty))
225 uart_port_dtr_rts(uport, 1);
229 * This is to allow setserial on this port. People may want to set
230 * port/irq/type and then reconfigure the port properly if it failed
231 * now.
233 if (retval && capable(CAP_SYS_ADMIN))
234 return 1;
236 return retval;
239 static int uart_startup(struct tty_struct *tty, struct uart_state *state,
240 int init_hw)
242 struct tty_port *port = &state->port;
243 int retval;
245 if (tty_port_initialized(port))
246 return 0;
248 retval = uart_port_startup(tty, state, init_hw);
249 if (retval)
250 set_bit(TTY_IO_ERROR, &tty->flags);
252 return retval;
256 * This routine will shutdown a serial port; interrupts are disabled, and
257 * DTR is dropped if the hangup on close termio flag is on. Calls to
258 * uart_shutdown are serialised by the per-port semaphore.
260 * uport == NULL if uart_port has already been removed
262 static void uart_shutdown(struct tty_struct *tty, struct uart_state *state)
264 struct uart_port *uport = uart_port_check(state);
265 struct tty_port *port = &state->port;
268 * Set the TTY IO error marker
270 if (tty)
271 set_bit(TTY_IO_ERROR, &tty->flags);
273 if (tty_port_initialized(port)) {
274 tty_port_set_initialized(port, 0);
277 * Turn off DTR and RTS early.
279 if (uport && uart_console(uport) && tty)
280 uport->cons->cflag = tty->termios.c_cflag;
282 if (!tty || C_HUPCL(tty))
283 uart_port_dtr_rts(uport, 0);
285 uart_port_shutdown(port);
289 * It's possible for shutdown to be called after suspend if we get
290 * a DCD drop (hangup) at just the right time. Clear suspended bit so
291 * we don't try to resume a port that has been shutdown.
293 tty_port_set_suspended(port, 0);
296 * Free the transmit buffer page.
298 if (state->xmit.buf) {
299 free_page((unsigned long)state->xmit.buf);
300 state->xmit.buf = NULL;
305 * uart_update_timeout - update per-port FIFO timeout.
306 * @port: uart_port structure describing the port
307 * @cflag: termios cflag value
308 * @baud: speed of the port
310 * Set the port FIFO timeout value. The @cflag value should
311 * reflect the actual hardware settings.
313 void
314 uart_update_timeout(struct uart_port *port, unsigned int cflag,
315 unsigned int baud)
317 unsigned int bits;
319 /* byte size and parity */
320 switch (cflag & CSIZE) {
321 case CS5:
322 bits = 7;
323 break;
324 case CS6:
325 bits = 8;
326 break;
327 case CS7:
328 bits = 9;
329 break;
330 default:
331 bits = 10;
332 break; /* CS8 */
335 if (cflag & CSTOPB)
336 bits++;
337 if (cflag & PARENB)
338 bits++;
341 * The total number of bits to be transmitted in the fifo.
343 bits = bits * port->fifosize;
346 * Figure the timeout to send the above number of bits.
347 * Add .02 seconds of slop
349 port->timeout = (HZ * bits) / baud + HZ/50;
352 EXPORT_SYMBOL(uart_update_timeout);
355 * uart_get_baud_rate - return baud rate for a particular port
356 * @port: uart_port structure describing the port in question.
357 * @termios: desired termios settings.
358 * @old: old termios (or NULL)
359 * @min: minimum acceptable baud rate
360 * @max: maximum acceptable baud rate
362 * Decode the termios structure into a numeric baud rate,
363 * taking account of the magic 38400 baud rate (with spd_*
364 * flags), and mapping the %B0 rate to 9600 baud.
366 * If the new baud rate is invalid, try the old termios setting.
367 * If it's still invalid, we try 9600 baud.
369 * Update the @termios structure to reflect the baud rate
370 * we're actually going to be using. Don't do this for the case
371 * where B0 is requested ("hang up").
373 unsigned int
374 uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
375 struct ktermios *old, unsigned int min, unsigned int max)
377 unsigned int try;
378 unsigned int baud;
379 unsigned int altbaud;
380 int hung_up = 0;
381 upf_t flags = port->flags & UPF_SPD_MASK;
383 switch (flags) {
384 case UPF_SPD_HI:
385 altbaud = 57600;
386 break;
387 case UPF_SPD_VHI:
388 altbaud = 115200;
389 break;
390 case UPF_SPD_SHI:
391 altbaud = 230400;
392 break;
393 case UPF_SPD_WARP:
394 altbaud = 460800;
395 break;
396 default:
397 altbaud = 38400;
398 break;
401 for (try = 0; try < 2; try++) {
402 baud = tty_termios_baud_rate(termios);
405 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
406 * Die! Die! Die!
408 if (try == 0 && baud == 38400)
409 baud = altbaud;
412 * Special case: B0 rate.
414 if (baud == 0) {
415 hung_up = 1;
416 baud = 9600;
419 if (baud >= min && baud <= max)
420 return baud;
423 * Oops, the quotient was zero. Try again with
424 * the old baud rate if possible.
426 termios->c_cflag &= ~CBAUD;
427 if (old) {
428 baud = tty_termios_baud_rate(old);
429 if (!hung_up)
430 tty_termios_encode_baud_rate(termios,
431 baud, baud);
432 old = NULL;
433 continue;
437 * As a last resort, if the range cannot be met then clip to
438 * the nearest chip supported rate.
440 if (!hung_up) {
441 if (baud <= min)
442 tty_termios_encode_baud_rate(termios,
443 min + 1, min + 1);
444 else
445 tty_termios_encode_baud_rate(termios,
446 max - 1, max - 1);
449 /* Should never happen */
450 WARN_ON(1);
451 return 0;
454 EXPORT_SYMBOL(uart_get_baud_rate);
457 * uart_get_divisor - return uart clock divisor
458 * @port: uart_port structure describing the port.
459 * @baud: desired baud rate
461 * Calculate the uart clock divisor for the port.
463 unsigned int
464 uart_get_divisor(struct uart_port *port, unsigned int baud)
466 unsigned int quot;
469 * Old custom speed handling.
471 if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
472 quot = port->custom_divisor;
473 else
474 quot = DIV_ROUND_CLOSEST(port->uartclk, 16 * baud);
476 return quot;
479 EXPORT_SYMBOL(uart_get_divisor);
481 /* Caller holds port mutex */
482 static void uart_change_speed(struct tty_struct *tty, struct uart_state *state,
483 struct ktermios *old_termios)
485 struct uart_port *uport = uart_port_check(state);
486 struct ktermios *termios;
487 int hw_stopped;
490 * If we have no tty, termios, or the port does not exist,
491 * then we can't set the parameters for this port.
493 if (!tty || uport->type == PORT_UNKNOWN)
494 return;
496 termios = &tty->termios;
497 uport->ops->set_termios(uport, termios, old_termios);
500 * Set modem status enables based on termios cflag
502 spin_lock_irq(&uport->lock);
503 if (termios->c_cflag & CRTSCTS)
504 uport->status |= UPSTAT_CTS_ENABLE;
505 else
506 uport->status &= ~UPSTAT_CTS_ENABLE;
508 if (termios->c_cflag & CLOCAL)
509 uport->status &= ~UPSTAT_DCD_ENABLE;
510 else
511 uport->status |= UPSTAT_DCD_ENABLE;
513 /* reset sw-assisted CTS flow control based on (possibly) new mode */
514 hw_stopped = uport->hw_stopped;
515 uport->hw_stopped = uart_softcts_mode(uport) &&
516 !(uport->ops->get_mctrl(uport) & TIOCM_CTS);
517 if (uport->hw_stopped) {
518 if (!hw_stopped)
519 uport->ops->stop_tx(uport);
520 } else {
521 if (hw_stopped)
522 __uart_start(tty);
524 spin_unlock_irq(&uport->lock);
527 static int uart_put_char(struct tty_struct *tty, unsigned char c)
529 struct uart_state *state = tty->driver_data;
530 struct uart_port *port;
531 struct circ_buf *circ;
532 unsigned long flags;
533 int ret = 0;
535 circ = &state->xmit;
536 if (!circ->buf)
537 return 0;
539 port = uart_port_lock(state, flags);
540 if (port && uart_circ_chars_free(circ) != 0) {
541 circ->buf[circ->head] = c;
542 circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
543 ret = 1;
545 uart_port_unlock(port, flags);
546 return ret;
549 static void uart_flush_chars(struct tty_struct *tty)
551 uart_start(tty);
554 static int uart_write(struct tty_struct *tty,
555 const unsigned char *buf, int count)
557 struct uart_state *state = tty->driver_data;
558 struct uart_port *port;
559 struct circ_buf *circ;
560 unsigned long flags;
561 int c, ret = 0;
564 * This means you called this function _after_ the port was
565 * closed. No cookie for you.
567 if (!state) {
568 WARN_ON(1);
569 return -EL3HLT;
572 circ = &state->xmit;
573 if (!circ->buf)
574 return 0;
576 port = uart_port_lock(state, flags);
577 while (port) {
578 c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
579 if (count < c)
580 c = count;
581 if (c <= 0)
582 break;
583 memcpy(circ->buf + circ->head, buf, c);
584 circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
585 buf += c;
586 count -= c;
587 ret += c;
590 __uart_start(tty);
591 uart_port_unlock(port, flags);
592 return ret;
595 static int uart_write_room(struct tty_struct *tty)
597 struct uart_state *state = tty->driver_data;
598 struct uart_port *port;
599 unsigned long flags;
600 int ret;
602 port = uart_port_lock(state, flags);
603 ret = uart_circ_chars_free(&state->xmit);
604 uart_port_unlock(port, flags);
605 return ret;
608 static int uart_chars_in_buffer(struct tty_struct *tty)
610 struct uart_state *state = tty->driver_data;
611 struct uart_port *port;
612 unsigned long flags;
613 int ret;
615 port = uart_port_lock(state, flags);
616 ret = uart_circ_chars_pending(&state->xmit);
617 uart_port_unlock(port, flags);
618 return ret;
621 static void uart_flush_buffer(struct tty_struct *tty)
623 struct uart_state *state = tty->driver_data;
624 struct uart_port *port;
625 unsigned long flags;
628 * This means you called this function _after_ the port was
629 * closed. No cookie for you.
631 if (!state) {
632 WARN_ON(1);
633 return;
636 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
638 port = uart_port_lock(state, flags);
639 if (!port)
640 return;
641 uart_circ_clear(&state->xmit);
642 if (port->ops->flush_buffer)
643 port->ops->flush_buffer(port);
644 uart_port_unlock(port, flags);
645 tty_port_tty_wakeup(&state->port);
649 * This function is used to send a high-priority XON/XOFF character to
650 * the device
652 static void uart_send_xchar(struct tty_struct *tty, char ch)
654 struct uart_state *state = tty->driver_data;
655 struct uart_port *port;
656 unsigned long flags;
658 port = uart_port_ref(state);
659 if (!port)
660 return;
662 if (port->ops->send_xchar)
663 port->ops->send_xchar(port, ch);
664 else {
665 spin_lock_irqsave(&port->lock, flags);
666 port->x_char = ch;
667 if (ch)
668 port->ops->start_tx(port);
669 spin_unlock_irqrestore(&port->lock, flags);
671 uart_port_deref(port);
674 static void uart_throttle(struct tty_struct *tty)
676 struct uart_state *state = tty->driver_data;
677 struct uart_port *port;
678 upstat_t mask = 0;
680 port = uart_port_ref(state);
681 if (!port)
682 return;
684 if (I_IXOFF(tty))
685 mask |= UPSTAT_AUTOXOFF;
686 if (C_CRTSCTS(tty))
687 mask |= UPSTAT_AUTORTS;
689 if (port->status & mask) {
690 port->ops->throttle(port);
691 mask &= ~port->status;
694 if (mask & UPSTAT_AUTORTS)
695 uart_clear_mctrl(port, TIOCM_RTS);
697 if (mask & UPSTAT_AUTOXOFF)
698 uart_send_xchar(tty, STOP_CHAR(tty));
700 uart_port_deref(port);
703 static void uart_unthrottle(struct tty_struct *tty)
705 struct uart_state *state = tty->driver_data;
706 struct uart_port *port;
707 upstat_t mask = 0;
709 port = uart_port_ref(state);
710 if (!port)
711 return;
713 if (I_IXOFF(tty))
714 mask |= UPSTAT_AUTOXOFF;
715 if (C_CRTSCTS(tty))
716 mask |= UPSTAT_AUTORTS;
718 if (port->status & mask) {
719 port->ops->unthrottle(port);
720 mask &= ~port->status;
723 if (mask & UPSTAT_AUTORTS)
724 uart_set_mctrl(port, TIOCM_RTS);
726 if (mask & UPSTAT_AUTOXOFF)
727 uart_send_xchar(tty, START_CHAR(tty));
729 uart_port_deref(port);
732 static int uart_get_info(struct tty_port *port, struct serial_struct *retinfo)
734 struct uart_state *state = container_of(port, struct uart_state, port);
735 struct uart_port *uport;
736 int ret = -ENODEV;
738 memset(retinfo, 0, sizeof(*retinfo));
741 * Ensure the state we copy is consistent and no hardware changes
742 * occur as we go
744 mutex_lock(&port->mutex);
745 uport = uart_port_check(state);
746 if (!uport)
747 goto out;
749 retinfo->type = uport->type;
750 retinfo->line = uport->line;
751 retinfo->port = uport->iobase;
752 if (HIGH_BITS_OFFSET)
753 retinfo->port_high = (long) uport->iobase >> HIGH_BITS_OFFSET;
754 retinfo->irq = uport->irq;
755 retinfo->flags = (__force int)uport->flags;
756 retinfo->xmit_fifo_size = uport->fifosize;
757 retinfo->baud_base = uport->uartclk / 16;
758 retinfo->close_delay = jiffies_to_msecs(port->close_delay) / 10;
759 retinfo->closing_wait = port->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
760 ASYNC_CLOSING_WAIT_NONE :
761 jiffies_to_msecs(port->closing_wait) / 10;
762 retinfo->custom_divisor = uport->custom_divisor;
763 retinfo->hub6 = uport->hub6;
764 retinfo->io_type = uport->iotype;
765 retinfo->iomem_reg_shift = uport->regshift;
766 retinfo->iomem_base = (void *)(unsigned long)uport->mapbase;
768 ret = 0;
769 out:
770 mutex_unlock(&port->mutex);
771 return ret;
774 static int uart_get_info_user(struct tty_port *port,
775 struct serial_struct __user *retinfo)
777 struct serial_struct tmp;
779 if (uart_get_info(port, &tmp) < 0)
780 return -EIO;
782 if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
783 return -EFAULT;
784 return 0;
787 static int uart_set_info(struct tty_struct *tty, struct tty_port *port,
788 struct uart_state *state,
789 struct serial_struct *new_info)
791 struct uart_port *uport = uart_port_check(state);
792 unsigned long new_port;
793 unsigned int change_irq, change_port, closing_wait;
794 unsigned int old_custom_divisor, close_delay;
795 upf_t old_flags, new_flags;
796 int retval = 0;
798 if (!uport)
799 return -EIO;
801 new_port = new_info->port;
802 if (HIGH_BITS_OFFSET)
803 new_port += (unsigned long) new_info->port_high << HIGH_BITS_OFFSET;
805 new_info->irq = irq_canonicalize(new_info->irq);
806 close_delay = msecs_to_jiffies(new_info->close_delay * 10);
807 closing_wait = new_info->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
808 ASYNC_CLOSING_WAIT_NONE :
809 msecs_to_jiffies(new_info->closing_wait * 10);
812 change_irq = !(uport->flags & UPF_FIXED_PORT)
813 && new_info->irq != uport->irq;
816 * Since changing the 'type' of the port changes its resource
817 * allocations, we should treat type changes the same as
818 * IO port changes.
820 change_port = !(uport->flags & UPF_FIXED_PORT)
821 && (new_port != uport->iobase ||
822 (unsigned long)new_info->iomem_base != uport->mapbase ||
823 new_info->hub6 != uport->hub6 ||
824 new_info->io_type != uport->iotype ||
825 new_info->iomem_reg_shift != uport->regshift ||
826 new_info->type != uport->type);
828 old_flags = uport->flags;
829 new_flags = (__force upf_t)new_info->flags;
830 old_custom_divisor = uport->custom_divisor;
832 if (!capable(CAP_SYS_ADMIN)) {
833 retval = -EPERM;
834 if (change_irq || change_port ||
835 (new_info->baud_base != uport->uartclk / 16) ||
836 (close_delay != port->close_delay) ||
837 (closing_wait != port->closing_wait) ||
838 (new_info->xmit_fifo_size &&
839 new_info->xmit_fifo_size != uport->fifosize) ||
840 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
841 goto exit;
842 uport->flags = ((uport->flags & ~UPF_USR_MASK) |
843 (new_flags & UPF_USR_MASK));
844 uport->custom_divisor = new_info->custom_divisor;
845 goto check_and_exit;
849 * Ask the low level driver to verify the settings.
851 if (uport->ops->verify_port)
852 retval = uport->ops->verify_port(uport, new_info);
854 if ((new_info->irq >= nr_irqs) || (new_info->irq < 0) ||
855 (new_info->baud_base < 9600))
856 retval = -EINVAL;
858 if (retval)
859 goto exit;
861 if (change_port || change_irq) {
862 retval = -EBUSY;
865 * Make sure that we are the sole user of this port.
867 if (tty_port_users(port) > 1)
868 goto exit;
871 * We need to shutdown the serial port at the old
872 * port/type/irq combination.
874 uart_shutdown(tty, state);
877 if (change_port) {
878 unsigned long old_iobase, old_mapbase;
879 unsigned int old_type, old_iotype, old_hub6, old_shift;
881 old_iobase = uport->iobase;
882 old_mapbase = uport->mapbase;
883 old_type = uport->type;
884 old_hub6 = uport->hub6;
885 old_iotype = uport->iotype;
886 old_shift = uport->regshift;
889 * Free and release old regions
891 if (old_type != PORT_UNKNOWN && uport->ops->release_port)
892 uport->ops->release_port(uport);
894 uport->iobase = new_port;
895 uport->type = new_info->type;
896 uport->hub6 = new_info->hub6;
897 uport->iotype = new_info->io_type;
898 uport->regshift = new_info->iomem_reg_shift;
899 uport->mapbase = (unsigned long)new_info->iomem_base;
902 * Claim and map the new regions
904 if (uport->type != PORT_UNKNOWN && uport->ops->request_port) {
905 retval = uport->ops->request_port(uport);
906 } else {
907 /* Always success - Jean II */
908 retval = 0;
912 * If we fail to request resources for the
913 * new port, try to restore the old settings.
915 if (retval) {
916 uport->iobase = old_iobase;
917 uport->type = old_type;
918 uport->hub6 = old_hub6;
919 uport->iotype = old_iotype;
920 uport->regshift = old_shift;
921 uport->mapbase = old_mapbase;
923 if (old_type != PORT_UNKNOWN) {
924 retval = uport->ops->request_port(uport);
926 * If we failed to restore the old settings,
927 * we fail like this.
929 if (retval)
930 uport->type = PORT_UNKNOWN;
933 * We failed anyway.
935 retval = -EBUSY;
938 /* Added to return the correct error -Ram Gupta */
939 goto exit;
943 if (change_irq)
944 uport->irq = new_info->irq;
945 if (!(uport->flags & UPF_FIXED_PORT))
946 uport->uartclk = new_info->baud_base * 16;
947 uport->flags = (uport->flags & ~UPF_CHANGE_MASK) |
948 (new_flags & UPF_CHANGE_MASK);
949 uport->custom_divisor = new_info->custom_divisor;
950 port->close_delay = close_delay;
951 port->closing_wait = closing_wait;
952 if (new_info->xmit_fifo_size)
953 uport->fifosize = new_info->xmit_fifo_size;
954 port->low_latency = (uport->flags & UPF_LOW_LATENCY) ? 1 : 0;
956 check_and_exit:
957 retval = 0;
958 if (uport->type == PORT_UNKNOWN)
959 goto exit;
960 if (tty_port_initialized(port)) {
961 if (((old_flags ^ uport->flags) & UPF_SPD_MASK) ||
962 old_custom_divisor != uport->custom_divisor) {
964 * If they're setting up a custom divisor or speed,
965 * instead of clearing it, then bitch about it.
967 if (uport->flags & UPF_SPD_MASK) {
968 dev_notice_ratelimited(uport->dev,
969 "%s sets custom speed on %s. This is deprecated.\n",
970 current->comm,
971 tty_name(port->tty));
973 uart_change_speed(tty, state, NULL);
975 } else {
976 retval = uart_startup(tty, state, 1);
977 if (retval == 0)
978 tty_port_set_initialized(port, true);
979 if (retval > 0)
980 retval = 0;
982 exit:
983 return retval;
986 static int uart_set_info_user(struct tty_struct *tty, struct uart_state *state,
987 struct serial_struct __user *newinfo)
989 struct serial_struct new_serial;
990 struct tty_port *port = &state->port;
991 int retval;
993 if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
994 return -EFAULT;
997 * This semaphore protects port->count. It is also
998 * very useful to prevent opens. Also, take the
999 * port configuration semaphore to make sure that a
1000 * module insertion/removal doesn't change anything
1001 * under us.
1003 mutex_lock(&port->mutex);
1004 retval = uart_set_info(tty, port, state, &new_serial);
1005 mutex_unlock(&port->mutex);
1006 return retval;
1010 * uart_get_lsr_info - get line status register info
1011 * @tty: tty associated with the UART
1012 * @state: UART being queried
1013 * @value: returned modem value
1015 static int uart_get_lsr_info(struct tty_struct *tty,
1016 struct uart_state *state, unsigned int __user *value)
1018 struct uart_port *uport = uart_port_check(state);
1019 unsigned int result;
1021 result = uport->ops->tx_empty(uport);
1024 * If we're about to load something into the transmit
1025 * register, we'll pretend the transmitter isn't empty to
1026 * avoid a race condition (depending on when the transmit
1027 * interrupt happens).
1029 if (uport->x_char ||
1030 ((uart_circ_chars_pending(&state->xmit) > 0) &&
1031 !uart_tx_stopped(uport)))
1032 result &= ~TIOCSER_TEMT;
1034 return put_user(result, value);
1037 static int uart_tiocmget(struct tty_struct *tty)
1039 struct uart_state *state = tty->driver_data;
1040 struct tty_port *port = &state->port;
1041 struct uart_port *uport;
1042 int result = -EIO;
1044 mutex_lock(&port->mutex);
1045 uport = uart_port_check(state);
1046 if (!uport)
1047 goto out;
1049 if (!tty_io_error(tty)) {
1050 result = uport->mctrl;
1051 spin_lock_irq(&uport->lock);
1052 result |= uport->ops->get_mctrl(uport);
1053 spin_unlock_irq(&uport->lock);
1055 out:
1056 mutex_unlock(&port->mutex);
1057 return result;
1060 static int
1061 uart_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)
1063 struct uart_state *state = tty->driver_data;
1064 struct tty_port *port = &state->port;
1065 struct uart_port *uport;
1066 int ret = -EIO;
1068 mutex_lock(&port->mutex);
1069 uport = uart_port_check(state);
1070 if (!uport)
1071 goto out;
1073 if (!tty_io_error(tty)) {
1074 uart_update_mctrl(uport, set, clear);
1075 ret = 0;
1077 out:
1078 mutex_unlock(&port->mutex);
1079 return ret;
1082 static int uart_break_ctl(struct tty_struct *tty, int break_state)
1084 struct uart_state *state = tty->driver_data;
1085 struct tty_port *port = &state->port;
1086 struct uart_port *uport;
1087 int ret = -EIO;
1089 mutex_lock(&port->mutex);
1090 uport = uart_port_check(state);
1091 if (!uport)
1092 goto out;
1094 if (uport->type != PORT_UNKNOWN)
1095 uport->ops->break_ctl(uport, break_state);
1096 ret = 0;
1097 out:
1098 mutex_unlock(&port->mutex);
1099 return ret;
1102 static int uart_do_autoconfig(struct tty_struct *tty,struct uart_state *state)
1104 struct tty_port *port = &state->port;
1105 struct uart_port *uport;
1106 int flags, ret;
1108 if (!capable(CAP_SYS_ADMIN))
1109 return -EPERM;
1112 * Take the per-port semaphore. This prevents count from
1113 * changing, and hence any extra opens of the port while
1114 * we're auto-configuring.
1116 if (mutex_lock_interruptible(&port->mutex))
1117 return -ERESTARTSYS;
1119 uport = uart_port_check(state);
1120 if (!uport) {
1121 ret = -EIO;
1122 goto out;
1125 ret = -EBUSY;
1126 if (tty_port_users(port) == 1) {
1127 uart_shutdown(tty, state);
1130 * If we already have a port type configured,
1131 * we must release its resources.
1133 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
1134 uport->ops->release_port(uport);
1136 flags = UART_CONFIG_TYPE;
1137 if (uport->flags & UPF_AUTO_IRQ)
1138 flags |= UART_CONFIG_IRQ;
1141 * This will claim the ports resources if
1142 * a port is found.
1144 uport->ops->config_port(uport, flags);
1146 ret = uart_startup(tty, state, 1);
1147 if (ret > 0)
1148 ret = 0;
1150 out:
1151 mutex_unlock(&port->mutex);
1152 return ret;
1155 static void uart_enable_ms(struct uart_port *uport)
1158 * Force modem status interrupts on
1160 if (uport->ops->enable_ms)
1161 uport->ops->enable_ms(uport);
1165 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1166 * - mask passed in arg for lines of interest
1167 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1168 * Caller should use TIOCGICOUNT to see which one it was
1170 * FIXME: This wants extracting into a common all driver implementation
1171 * of TIOCMWAIT using tty_port.
1173 static int uart_wait_modem_status(struct uart_state *state, unsigned long arg)
1175 struct uart_port *uport;
1176 struct tty_port *port = &state->port;
1177 DECLARE_WAITQUEUE(wait, current);
1178 struct uart_icount cprev, cnow;
1179 int ret;
1182 * note the counters on entry
1184 uport = uart_port_ref(state);
1185 if (!uport)
1186 return -EIO;
1187 spin_lock_irq(&uport->lock);
1188 memcpy(&cprev, &uport->icount, sizeof(struct uart_icount));
1189 uart_enable_ms(uport);
1190 spin_unlock_irq(&uport->lock);
1192 add_wait_queue(&port->delta_msr_wait, &wait);
1193 for (;;) {
1194 spin_lock_irq(&uport->lock);
1195 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1196 spin_unlock_irq(&uport->lock);
1198 set_current_state(TASK_INTERRUPTIBLE);
1200 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1201 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1202 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1203 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1204 ret = 0;
1205 break;
1208 schedule();
1210 /* see if a signal did it */
1211 if (signal_pending(current)) {
1212 ret = -ERESTARTSYS;
1213 break;
1216 cprev = cnow;
1218 __set_current_state(TASK_RUNNING);
1219 remove_wait_queue(&port->delta_msr_wait, &wait);
1220 uart_port_deref(uport);
1222 return ret;
1226 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1227 * Return: write counters to the user passed counter struct
1228 * NB: both 1->0 and 0->1 transitions are counted except for
1229 * RI where only 0->1 is counted.
1231 static int uart_get_icount(struct tty_struct *tty,
1232 struct serial_icounter_struct *icount)
1234 struct uart_state *state = tty->driver_data;
1235 struct uart_icount cnow;
1236 struct uart_port *uport;
1238 uport = uart_port_ref(state);
1239 if (!uport)
1240 return -EIO;
1241 spin_lock_irq(&uport->lock);
1242 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1243 spin_unlock_irq(&uport->lock);
1244 uart_port_deref(uport);
1246 icount->cts = cnow.cts;
1247 icount->dsr = cnow.dsr;
1248 icount->rng = cnow.rng;
1249 icount->dcd = cnow.dcd;
1250 icount->rx = cnow.rx;
1251 icount->tx = cnow.tx;
1252 icount->frame = cnow.frame;
1253 icount->overrun = cnow.overrun;
1254 icount->parity = cnow.parity;
1255 icount->brk = cnow.brk;
1256 icount->buf_overrun = cnow.buf_overrun;
1258 return 0;
1261 static int uart_get_rs485_config(struct uart_port *port,
1262 struct serial_rs485 __user *rs485)
1264 unsigned long flags;
1265 struct serial_rs485 aux;
1267 spin_lock_irqsave(&port->lock, flags);
1268 aux = port->rs485;
1269 spin_unlock_irqrestore(&port->lock, flags);
1271 if (copy_to_user(rs485, &aux, sizeof(aux)))
1272 return -EFAULT;
1274 return 0;
1277 static int uart_set_rs485_config(struct uart_port *port,
1278 struct serial_rs485 __user *rs485_user)
1280 struct serial_rs485 rs485;
1281 int ret;
1282 unsigned long flags;
1284 if (!port->rs485_config)
1285 return -ENOIOCTLCMD;
1287 if (copy_from_user(&rs485, rs485_user, sizeof(*rs485_user)))
1288 return -EFAULT;
1290 spin_lock_irqsave(&port->lock, flags);
1291 ret = port->rs485_config(port, &rs485);
1292 spin_unlock_irqrestore(&port->lock, flags);
1293 if (ret)
1294 return ret;
1296 if (copy_to_user(rs485_user, &port->rs485, sizeof(port->rs485)))
1297 return -EFAULT;
1299 return 0;
1303 * Called via sys_ioctl. We can use spin_lock_irq() here.
1305 static int
1306 uart_ioctl(struct tty_struct *tty, unsigned int cmd, unsigned long arg)
1308 struct uart_state *state = tty->driver_data;
1309 struct tty_port *port = &state->port;
1310 struct uart_port *uport;
1311 void __user *uarg = (void __user *)arg;
1312 int ret = -ENOIOCTLCMD;
1316 * These ioctls don't rely on the hardware to be present.
1318 switch (cmd) {
1319 case TIOCGSERIAL:
1320 ret = uart_get_info_user(port, uarg);
1321 break;
1323 case TIOCSSERIAL:
1324 down_write(&tty->termios_rwsem);
1325 ret = uart_set_info_user(tty, state, uarg);
1326 up_write(&tty->termios_rwsem);
1327 break;
1329 case TIOCSERCONFIG:
1330 down_write(&tty->termios_rwsem);
1331 ret = uart_do_autoconfig(tty, state);
1332 up_write(&tty->termios_rwsem);
1333 break;
1335 case TIOCSERGWILD: /* obsolete */
1336 case TIOCSERSWILD: /* obsolete */
1337 ret = 0;
1338 break;
1341 if (ret != -ENOIOCTLCMD)
1342 goto out;
1344 if (tty_io_error(tty)) {
1345 ret = -EIO;
1346 goto out;
1350 * The following should only be used when hardware is present.
1352 switch (cmd) {
1353 case TIOCMIWAIT:
1354 ret = uart_wait_modem_status(state, arg);
1355 break;
1358 if (ret != -ENOIOCTLCMD)
1359 goto out;
1361 mutex_lock(&port->mutex);
1362 uport = uart_port_check(state);
1364 if (!uport || tty_io_error(tty)) {
1365 ret = -EIO;
1366 goto out_up;
1370 * All these rely on hardware being present and need to be
1371 * protected against the tty being hung up.
1374 switch (cmd) {
1375 case TIOCSERGETLSR: /* Get line status register */
1376 ret = uart_get_lsr_info(tty, state, uarg);
1377 break;
1379 case TIOCGRS485:
1380 ret = uart_get_rs485_config(uport, uarg);
1381 break;
1383 case TIOCSRS485:
1384 ret = uart_set_rs485_config(uport, uarg);
1385 break;
1386 default:
1387 if (uport->ops->ioctl)
1388 ret = uport->ops->ioctl(uport, cmd, arg);
1389 break;
1391 out_up:
1392 mutex_unlock(&port->mutex);
1393 out:
1394 return ret;
1397 static void uart_set_ldisc(struct tty_struct *tty)
1399 struct uart_state *state = tty->driver_data;
1400 struct uart_port *uport;
1402 mutex_lock(&state->port.mutex);
1403 uport = uart_port_check(state);
1404 if (uport && uport->ops->set_ldisc)
1405 uport->ops->set_ldisc(uport, &tty->termios);
1406 mutex_unlock(&state->port.mutex);
1409 static void uart_set_termios(struct tty_struct *tty,
1410 struct ktermios *old_termios)
1412 struct uart_state *state = tty->driver_data;
1413 struct uart_port *uport;
1414 unsigned int cflag = tty->termios.c_cflag;
1415 unsigned int iflag_mask = IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK;
1416 bool sw_changed = false;
1418 mutex_lock(&state->port.mutex);
1419 uport = uart_port_check(state);
1420 if (!uport)
1421 goto out;
1424 * Drivers doing software flow control also need to know
1425 * about changes to these input settings.
1427 if (uport->flags & UPF_SOFT_FLOW) {
1428 iflag_mask |= IXANY|IXON|IXOFF;
1429 sw_changed =
1430 tty->termios.c_cc[VSTART] != old_termios->c_cc[VSTART] ||
1431 tty->termios.c_cc[VSTOP] != old_termios->c_cc[VSTOP];
1435 * These are the bits that are used to setup various
1436 * flags in the low level driver. We can ignore the Bfoo
1437 * bits in c_cflag; c_[io]speed will always be set
1438 * appropriately by set_termios() in tty_ioctl.c
1440 if ((cflag ^ old_termios->c_cflag) == 0 &&
1441 tty->termios.c_ospeed == old_termios->c_ospeed &&
1442 tty->termios.c_ispeed == old_termios->c_ispeed &&
1443 ((tty->termios.c_iflag ^ old_termios->c_iflag) & iflag_mask) == 0 &&
1444 !sw_changed) {
1445 goto out;
1448 uart_change_speed(tty, state, old_termios);
1449 /* reload cflag from termios; port driver may have overriden flags */
1450 cflag = tty->termios.c_cflag;
1452 /* Handle transition to B0 status */
1453 if ((old_termios->c_cflag & CBAUD) && !(cflag & CBAUD))
1454 uart_clear_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
1455 /* Handle transition away from B0 status */
1456 else if (!(old_termios->c_cflag & CBAUD) && (cflag & CBAUD)) {
1457 unsigned int mask = TIOCM_DTR;
1458 if (!(cflag & CRTSCTS) || !tty_throttled(tty))
1459 mask |= TIOCM_RTS;
1460 uart_set_mctrl(uport, mask);
1462 out:
1463 mutex_unlock(&state->port.mutex);
1467 * Calls to uart_close() are serialised via the tty_lock in
1468 * drivers/tty/tty_io.c:tty_release()
1469 * drivers/tty/tty_io.c:do_tty_hangup()
1471 static void uart_close(struct tty_struct *tty, struct file *filp)
1473 struct uart_state *state = tty->driver_data;
1475 if (!state) {
1476 struct uart_driver *drv = tty->driver->driver_state;
1477 struct tty_port *port;
1479 state = drv->state + tty->index;
1480 port = &state->port;
1481 spin_lock_irq(&port->lock);
1482 --port->count;
1483 spin_unlock_irq(&port->lock);
1484 return;
1487 pr_debug("uart_close(%d) called\n", tty->index);
1489 tty_port_close(tty->port, tty, filp);
1492 static void uart_tty_port_shutdown(struct tty_port *port)
1494 struct uart_state *state = container_of(port, struct uart_state, port);
1495 struct uart_port *uport = uart_port_check(state);
1498 * At this point, we stop accepting input. To do this, we
1499 * disable the receive line status interrupts.
1501 if (WARN(!uport, "detached port still initialized!\n"))
1502 return;
1504 spin_lock_irq(&uport->lock);
1505 uport->ops->stop_rx(uport);
1506 spin_unlock_irq(&uport->lock);
1508 uart_port_shutdown(port);
1511 * It's possible for shutdown to be called after suspend if we get
1512 * a DCD drop (hangup) at just the right time. Clear suspended bit so
1513 * we don't try to resume a port that has been shutdown.
1515 tty_port_set_suspended(port, 0);
1517 uart_change_pm(state, UART_PM_STATE_OFF);
1521 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1523 struct uart_state *state = tty->driver_data;
1524 struct uart_port *port;
1525 unsigned long char_time, expire;
1527 port = uart_port_ref(state);
1528 if (!port)
1529 return;
1531 if (port->type == PORT_UNKNOWN || port->fifosize == 0) {
1532 uart_port_deref(port);
1533 return;
1537 * Set the check interval to be 1/5 of the estimated time to
1538 * send a single character, and make it at least 1. The check
1539 * interval should also be less than the timeout.
1541 * Note: we have to use pretty tight timings here to satisfy
1542 * the NIST-PCTS.
1544 char_time = (port->timeout - HZ/50) / port->fifosize;
1545 char_time = char_time / 5;
1546 if (char_time == 0)
1547 char_time = 1;
1548 if (timeout && timeout < char_time)
1549 char_time = timeout;
1552 * If the transmitter hasn't cleared in twice the approximate
1553 * amount of time to send the entire FIFO, it probably won't
1554 * ever clear. This assumes the UART isn't doing flow
1555 * control, which is currently the case. Hence, if it ever
1556 * takes longer than port->timeout, this is probably due to a
1557 * UART bug of some kind. So, we clamp the timeout parameter at
1558 * 2*port->timeout.
1560 if (timeout == 0 || timeout > 2 * port->timeout)
1561 timeout = 2 * port->timeout;
1563 expire = jiffies + timeout;
1565 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1566 port->line, jiffies, expire);
1569 * Check whether the transmitter is empty every 'char_time'.
1570 * 'timeout' / 'expire' give us the maximum amount of time
1571 * we wait.
1573 while (!port->ops->tx_empty(port)) {
1574 msleep_interruptible(jiffies_to_msecs(char_time));
1575 if (signal_pending(current))
1576 break;
1577 if (time_after(jiffies, expire))
1578 break;
1580 uart_port_deref(port);
1584 * Calls to uart_hangup() are serialised by the tty_lock in
1585 * drivers/tty/tty_io.c:do_tty_hangup()
1586 * This runs from a workqueue and can sleep for a _short_ time only.
1588 static void uart_hangup(struct tty_struct *tty)
1590 struct uart_state *state = tty->driver_data;
1591 struct tty_port *port = &state->port;
1592 struct uart_port *uport;
1593 unsigned long flags;
1595 pr_debug("uart_hangup(%d)\n", tty->index);
1597 mutex_lock(&port->mutex);
1598 uport = uart_port_check(state);
1599 WARN(!uport, "hangup of detached port!\n");
1601 if (tty_port_active(port)) {
1602 uart_flush_buffer(tty);
1603 uart_shutdown(tty, state);
1604 spin_lock_irqsave(&port->lock, flags);
1605 port->count = 0;
1606 spin_unlock_irqrestore(&port->lock, flags);
1607 tty_port_set_active(port, 0);
1608 tty_port_tty_set(port, NULL);
1609 if (uport && !uart_console(uport))
1610 uart_change_pm(state, UART_PM_STATE_OFF);
1611 wake_up_interruptible(&port->open_wait);
1612 wake_up_interruptible(&port->delta_msr_wait);
1614 mutex_unlock(&port->mutex);
1617 /* uport == NULL if uart_port has already been removed */
1618 static void uart_port_shutdown(struct tty_port *port)
1620 struct uart_state *state = container_of(port, struct uart_state, port);
1621 struct uart_port *uport = uart_port_check(state);
1624 * clear delta_msr_wait queue to avoid mem leaks: we may free
1625 * the irq here so the queue might never be woken up. Note
1626 * that we won't end up waiting on delta_msr_wait again since
1627 * any outstanding file descriptors should be pointing at
1628 * hung_up_tty_fops now.
1630 wake_up_interruptible(&port->delta_msr_wait);
1633 * Free the IRQ and disable the port.
1635 if (uport)
1636 uport->ops->shutdown(uport);
1639 * Ensure that the IRQ handler isn't running on another CPU.
1641 if (uport)
1642 synchronize_irq(uport->irq);
1645 static int uart_carrier_raised(struct tty_port *port)
1647 struct uart_state *state = container_of(port, struct uart_state, port);
1648 struct uart_port *uport;
1649 int mctrl;
1651 uport = uart_port_ref(state);
1653 * Should never observe uport == NULL since checks for hangup should
1654 * abort the tty_port_block_til_ready() loop before checking for carrier
1655 * raised -- but report carrier raised if it does anyway so open will
1656 * continue and not sleep
1658 if (WARN_ON(!uport))
1659 return 1;
1660 spin_lock_irq(&uport->lock);
1661 uart_enable_ms(uport);
1662 mctrl = uport->ops->get_mctrl(uport);
1663 spin_unlock_irq(&uport->lock);
1664 uart_port_deref(uport);
1665 if (mctrl & TIOCM_CAR)
1666 return 1;
1667 return 0;
1670 static void uart_dtr_rts(struct tty_port *port, int raise)
1672 struct uart_state *state = container_of(port, struct uart_state, port);
1673 struct uart_port *uport;
1675 uport = uart_port_ref(state);
1676 if (!uport)
1677 return;
1678 uart_port_dtr_rts(uport, raise);
1679 uart_port_deref(uport);
1683 * Calls to uart_open are serialised by the tty_lock in
1684 * drivers/tty/tty_io.c:tty_open()
1685 * Note that if this fails, then uart_close() _will_ be called.
1687 * In time, we want to scrap the "opening nonpresent ports"
1688 * behaviour and implement an alternative way for setserial
1689 * to set base addresses/ports/types. This will allow us to
1690 * get rid of a certain amount of extra tests.
1692 static int uart_open(struct tty_struct *tty, struct file *filp)
1694 struct uart_driver *drv = tty->driver->driver_state;
1695 int retval, line = tty->index;
1696 struct uart_state *state = drv->state + line;
1698 tty->driver_data = state;
1700 retval = tty_port_open(&state->port, tty, filp);
1701 if (retval > 0)
1702 retval = 0;
1704 return retval;
1707 static int uart_port_activate(struct tty_port *port, struct tty_struct *tty)
1709 struct uart_state *state = container_of(port, struct uart_state, port);
1710 struct uart_port *uport;
1712 uport = uart_port_check(state);
1713 if (!uport || uport->flags & UPF_DEAD)
1714 return -ENXIO;
1716 port->low_latency = (uport->flags & UPF_LOW_LATENCY) ? 1 : 0;
1719 * Start up the serial port.
1721 return uart_startup(tty, state, 0);
1724 static const char *uart_type(struct uart_port *port)
1726 const char *str = NULL;
1728 if (port->ops->type)
1729 str = port->ops->type(port);
1731 if (!str)
1732 str = "unknown";
1734 return str;
1737 #ifdef CONFIG_PROC_FS
1739 static void uart_line_info(struct seq_file *m, struct uart_driver *drv, int i)
1741 struct uart_state *state = drv->state + i;
1742 struct tty_port *port = &state->port;
1743 enum uart_pm_state pm_state;
1744 struct uart_port *uport;
1745 char stat_buf[32];
1746 unsigned int status;
1747 int mmio;
1749 mutex_lock(&port->mutex);
1750 uport = uart_port_check(state);
1751 if (!uport)
1752 goto out;
1754 mmio = uport->iotype >= UPIO_MEM;
1755 seq_printf(m, "%d: uart:%s %s%08llX irq:%d",
1756 uport->line, uart_type(uport),
1757 mmio ? "mmio:0x" : "port:",
1758 mmio ? (unsigned long long)uport->mapbase
1759 : (unsigned long long)uport->iobase,
1760 uport->irq);
1762 if (uport->type == PORT_UNKNOWN) {
1763 seq_putc(m, '\n');
1764 goto out;
1767 if (capable(CAP_SYS_ADMIN)) {
1768 pm_state = state->pm_state;
1769 if (pm_state != UART_PM_STATE_ON)
1770 uart_change_pm(state, UART_PM_STATE_ON);
1771 spin_lock_irq(&uport->lock);
1772 status = uport->ops->get_mctrl(uport);
1773 spin_unlock_irq(&uport->lock);
1774 if (pm_state != UART_PM_STATE_ON)
1775 uart_change_pm(state, pm_state);
1777 seq_printf(m, " tx:%d rx:%d",
1778 uport->icount.tx, uport->icount.rx);
1779 if (uport->icount.frame)
1780 seq_printf(m, " fe:%d", uport->icount.frame);
1781 if (uport->icount.parity)
1782 seq_printf(m, " pe:%d", uport->icount.parity);
1783 if (uport->icount.brk)
1784 seq_printf(m, " brk:%d", uport->icount.brk);
1785 if (uport->icount.overrun)
1786 seq_printf(m, " oe:%d", uport->icount.overrun);
1788 #define INFOBIT(bit, str) \
1789 if (uport->mctrl & (bit)) \
1790 strncat(stat_buf, (str), sizeof(stat_buf) - \
1791 strlen(stat_buf) - 2)
1792 #define STATBIT(bit, str) \
1793 if (status & (bit)) \
1794 strncat(stat_buf, (str), sizeof(stat_buf) - \
1795 strlen(stat_buf) - 2)
1797 stat_buf[0] = '\0';
1798 stat_buf[1] = '\0';
1799 INFOBIT(TIOCM_RTS, "|RTS");
1800 STATBIT(TIOCM_CTS, "|CTS");
1801 INFOBIT(TIOCM_DTR, "|DTR");
1802 STATBIT(TIOCM_DSR, "|DSR");
1803 STATBIT(TIOCM_CAR, "|CD");
1804 STATBIT(TIOCM_RNG, "|RI");
1805 if (stat_buf[0])
1806 stat_buf[0] = ' ';
1808 seq_puts(m, stat_buf);
1810 seq_putc(m, '\n');
1811 #undef STATBIT
1812 #undef INFOBIT
1813 out:
1814 mutex_unlock(&port->mutex);
1817 static int uart_proc_show(struct seq_file *m, void *v)
1819 struct tty_driver *ttydrv = m->private;
1820 struct uart_driver *drv = ttydrv->driver_state;
1821 int i;
1823 seq_printf(m, "serinfo:1.0 driver%s%s revision:%s\n", "", "", "");
1824 for (i = 0; i < drv->nr; i++)
1825 uart_line_info(m, drv, i);
1826 return 0;
1829 static int uart_proc_open(struct inode *inode, struct file *file)
1831 return single_open(file, uart_proc_show, PDE_DATA(inode));
1834 static const struct file_operations uart_proc_fops = {
1835 .owner = THIS_MODULE,
1836 .open = uart_proc_open,
1837 .read = seq_read,
1838 .llseek = seq_lseek,
1839 .release = single_release,
1841 #endif
1843 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
1845 * uart_console_write - write a console message to a serial port
1846 * @port: the port to write the message
1847 * @s: array of characters
1848 * @count: number of characters in string to write
1849 * @putchar: function to write character to port
1851 void uart_console_write(struct uart_port *port, const char *s,
1852 unsigned int count,
1853 void (*putchar)(struct uart_port *, int))
1855 unsigned int i;
1857 for (i = 0; i < count; i++, s++) {
1858 if (*s == '\n')
1859 putchar(port, '\r');
1860 putchar(port, *s);
1863 EXPORT_SYMBOL_GPL(uart_console_write);
1866 * Check whether an invalid uart number has been specified, and
1867 * if so, search for the first available port that does have
1868 * console support.
1870 struct uart_port * __init
1871 uart_get_console(struct uart_port *ports, int nr, struct console *co)
1873 int idx = co->index;
1875 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
1876 ports[idx].membase == NULL))
1877 for (idx = 0; idx < nr; idx++)
1878 if (ports[idx].iobase != 0 ||
1879 ports[idx].membase != NULL)
1880 break;
1882 co->index = idx;
1884 return ports + idx;
1888 * uart_parse_earlycon - Parse earlycon options
1889 * @p: ptr to 2nd field (ie., just beyond '<name>,')
1890 * @iotype: ptr for decoded iotype (out)
1891 * @addr: ptr for decoded mapbase/iobase (out)
1892 * @options: ptr for <options> field; NULL if not present (out)
1894 * Decodes earlycon kernel command line parameters of the form
1895 * earlycon=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1896 * console=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
1898 * The optional form
1899 * earlycon=<name>,0x<addr>,<options>
1900 * console=<name>,0x<addr>,<options>
1901 * is also accepted; the returned @iotype will be UPIO_MEM.
1903 * Returns 0 on success or -EINVAL on failure
1905 int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr,
1906 char **options)
1908 if (strncmp(p, "mmio,", 5) == 0) {
1909 *iotype = UPIO_MEM;
1910 p += 5;
1911 } else if (strncmp(p, "mmio16,", 7) == 0) {
1912 *iotype = UPIO_MEM16;
1913 p += 7;
1914 } else if (strncmp(p, "mmio32,", 7) == 0) {
1915 *iotype = UPIO_MEM32;
1916 p += 7;
1917 } else if (strncmp(p, "mmio32be,", 9) == 0) {
1918 *iotype = UPIO_MEM32BE;
1919 p += 9;
1920 } else if (strncmp(p, "mmio32native,", 13) == 0) {
1921 *iotype = IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) ?
1922 UPIO_MEM32BE : UPIO_MEM32;
1923 p += 13;
1924 } else if (strncmp(p, "io,", 3) == 0) {
1925 *iotype = UPIO_PORT;
1926 p += 3;
1927 } else if (strncmp(p, "0x", 2) == 0) {
1928 *iotype = UPIO_MEM;
1929 } else {
1930 return -EINVAL;
1934 * Before you replace it with kstrtoull(), think about options separator
1935 * (',') it will not tolerate
1937 *addr = simple_strtoull(p, NULL, 0);
1938 p = strchr(p, ',');
1939 if (p)
1940 p++;
1942 *options = p;
1943 return 0;
1945 EXPORT_SYMBOL_GPL(uart_parse_earlycon);
1948 * uart_parse_options - Parse serial port baud/parity/bits/flow control.
1949 * @options: pointer to option string
1950 * @baud: pointer to an 'int' variable for the baud rate.
1951 * @parity: pointer to an 'int' variable for the parity.
1952 * @bits: pointer to an 'int' variable for the number of data bits.
1953 * @flow: pointer to an 'int' variable for the flow control character.
1955 * uart_parse_options decodes a string containing the serial console
1956 * options. The format of the string is <baud><parity><bits><flow>,
1957 * eg: 115200n8r
1959 void
1960 uart_parse_options(const char *options, int *baud, int *parity,
1961 int *bits, int *flow)
1963 const char *s = options;
1965 *baud = simple_strtoul(s, NULL, 10);
1966 while (*s >= '0' && *s <= '9')
1967 s++;
1968 if (*s)
1969 *parity = *s++;
1970 if (*s)
1971 *bits = *s++ - '0';
1972 if (*s)
1973 *flow = *s;
1975 EXPORT_SYMBOL_GPL(uart_parse_options);
1978 * uart_set_options - setup the serial console parameters
1979 * @port: pointer to the serial ports uart_port structure
1980 * @co: console pointer
1981 * @baud: baud rate
1982 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
1983 * @bits: number of data bits
1984 * @flow: flow control character - 'r' (rts)
1987 uart_set_options(struct uart_port *port, struct console *co,
1988 int baud, int parity, int bits, int flow)
1990 struct ktermios termios;
1991 static struct ktermios dummy;
1994 * Ensure that the serial console lock is initialised
1995 * early.
1996 * If this port is a console, then the spinlock is already
1997 * initialised.
1999 if (!(uart_console(port) && (port->cons->flags & CON_ENABLED))) {
2000 spin_lock_init(&port->lock);
2001 lockdep_set_class(&port->lock, &port_lock_key);
2004 memset(&termios, 0, sizeof(struct ktermios));
2006 termios.c_cflag |= CREAD | HUPCL | CLOCAL;
2007 tty_termios_encode_baud_rate(&termios, baud, baud);
2009 if (bits == 7)
2010 termios.c_cflag |= CS7;
2011 else
2012 termios.c_cflag |= CS8;
2014 switch (parity) {
2015 case 'o': case 'O':
2016 termios.c_cflag |= PARODD;
2017 /*fall through*/
2018 case 'e': case 'E':
2019 termios.c_cflag |= PARENB;
2020 break;
2023 if (flow == 'r')
2024 termios.c_cflag |= CRTSCTS;
2027 * some uarts on other side don't support no flow control.
2028 * So we set * DTR in host uart to make them happy
2030 port->mctrl |= TIOCM_DTR;
2032 port->ops->set_termios(port, &termios, &dummy);
2034 * Allow the setting of the UART parameters with a NULL console
2035 * too:
2037 if (co)
2038 co->cflag = termios.c_cflag;
2040 return 0;
2042 EXPORT_SYMBOL_GPL(uart_set_options);
2043 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
2046 * uart_change_pm - set power state of the port
2048 * @state: port descriptor
2049 * @pm_state: new state
2051 * Locking: port->mutex has to be held
2053 static void uart_change_pm(struct uart_state *state,
2054 enum uart_pm_state pm_state)
2056 struct uart_port *port = uart_port_check(state);
2058 if (state->pm_state != pm_state) {
2059 if (port && port->ops->pm)
2060 port->ops->pm(port, pm_state, state->pm_state);
2061 state->pm_state = pm_state;
2065 struct uart_match {
2066 struct uart_port *port;
2067 struct uart_driver *driver;
2070 static int serial_match_port(struct device *dev, void *data)
2072 struct uart_match *match = data;
2073 struct tty_driver *tty_drv = match->driver->tty_driver;
2074 dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
2075 match->port->line;
2077 return dev->devt == devt; /* Actually, only one tty per port */
2080 int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport)
2082 struct uart_state *state = drv->state + uport->line;
2083 struct tty_port *port = &state->port;
2084 struct device *tty_dev;
2085 struct uart_match match = {uport, drv};
2087 mutex_lock(&port->mutex);
2089 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2090 if (tty_dev && device_may_wakeup(tty_dev)) {
2091 enable_irq_wake(uport->irq);
2092 put_device(tty_dev);
2093 mutex_unlock(&port->mutex);
2094 return 0;
2096 put_device(tty_dev);
2098 /* Nothing to do if the console is not suspending */
2099 if (!console_suspend_enabled && uart_console(uport))
2100 goto unlock;
2102 uport->suspended = 1;
2104 if (tty_port_initialized(port)) {
2105 const struct uart_ops *ops = uport->ops;
2106 int tries;
2108 tty_port_set_suspended(port, 1);
2109 tty_port_set_initialized(port, 0);
2111 spin_lock_irq(&uport->lock);
2112 ops->stop_tx(uport);
2113 ops->set_mctrl(uport, 0);
2114 ops->stop_rx(uport);
2115 spin_unlock_irq(&uport->lock);
2118 * Wait for the transmitter to empty.
2120 for (tries = 3; !ops->tx_empty(uport) && tries; tries--)
2121 msleep(10);
2122 if (!tries)
2123 dev_err(uport->dev, "%s: Unable to drain transmitter\n",
2124 uport->name);
2126 ops->shutdown(uport);
2130 * Disable the console device before suspending.
2132 if (uart_console(uport))
2133 console_stop(uport->cons);
2135 uart_change_pm(state, UART_PM_STATE_OFF);
2136 unlock:
2137 mutex_unlock(&port->mutex);
2139 return 0;
2142 int uart_resume_port(struct uart_driver *drv, struct uart_port *uport)
2144 struct uart_state *state = drv->state + uport->line;
2145 struct tty_port *port = &state->port;
2146 struct device *tty_dev;
2147 struct uart_match match = {uport, drv};
2148 struct ktermios termios;
2150 mutex_lock(&port->mutex);
2152 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2153 if (!uport->suspended && device_may_wakeup(tty_dev)) {
2154 if (irqd_is_wakeup_set(irq_get_irq_data((uport->irq))))
2155 disable_irq_wake(uport->irq);
2156 put_device(tty_dev);
2157 mutex_unlock(&port->mutex);
2158 return 0;
2160 put_device(tty_dev);
2161 uport->suspended = 0;
2164 * Re-enable the console device after suspending.
2166 if (uart_console(uport)) {
2168 * First try to use the console cflag setting.
2170 memset(&termios, 0, sizeof(struct ktermios));
2171 termios.c_cflag = uport->cons->cflag;
2174 * If that's unset, use the tty termios setting.
2176 if (port->tty && termios.c_cflag == 0)
2177 termios = port->tty->termios;
2179 if (console_suspend_enabled)
2180 uart_change_pm(state, UART_PM_STATE_ON);
2181 uport->ops->set_termios(uport, &termios, NULL);
2182 if (console_suspend_enabled)
2183 console_start(uport->cons);
2186 if (tty_port_suspended(port)) {
2187 const struct uart_ops *ops = uport->ops;
2188 int ret;
2190 uart_change_pm(state, UART_PM_STATE_ON);
2191 spin_lock_irq(&uport->lock);
2192 ops->set_mctrl(uport, 0);
2193 spin_unlock_irq(&uport->lock);
2194 if (console_suspend_enabled || !uart_console(uport)) {
2195 /* Protected by port mutex for now */
2196 struct tty_struct *tty = port->tty;
2197 ret = ops->startup(uport);
2198 if (ret == 0) {
2199 if (tty)
2200 uart_change_speed(tty, state, NULL);
2201 spin_lock_irq(&uport->lock);
2202 ops->set_mctrl(uport, uport->mctrl);
2203 ops->start_tx(uport);
2204 spin_unlock_irq(&uport->lock);
2205 tty_port_set_initialized(port, 1);
2206 } else {
2208 * Failed to resume - maybe hardware went away?
2209 * Clear the "initialized" flag so we won't try
2210 * to call the low level drivers shutdown method.
2212 uart_shutdown(tty, state);
2216 tty_port_set_suspended(port, 0);
2219 mutex_unlock(&port->mutex);
2221 return 0;
2224 static inline void
2225 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2227 char address[64];
2229 switch (port->iotype) {
2230 case UPIO_PORT:
2231 snprintf(address, sizeof(address), "I/O 0x%lx", port->iobase);
2232 break;
2233 case UPIO_HUB6:
2234 snprintf(address, sizeof(address),
2235 "I/O 0x%lx offset 0x%x", port->iobase, port->hub6);
2236 break;
2237 case UPIO_MEM:
2238 case UPIO_MEM16:
2239 case UPIO_MEM32:
2240 case UPIO_MEM32BE:
2241 case UPIO_AU:
2242 case UPIO_TSI:
2243 snprintf(address, sizeof(address),
2244 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2245 break;
2246 default:
2247 strlcpy(address, "*unknown*", sizeof(address));
2248 break;
2251 pr_info("%s%s%s at %s (irq = %d, base_baud = %d) is a %s\n",
2252 port->dev ? dev_name(port->dev) : "",
2253 port->dev ? ": " : "",
2254 port->name,
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 tport = &state->port;
2334 mutex_lock(&tport->mutex);
2336 port = uart_port_check(state);
2337 if (!port || !(port->ops->poll_get_char && port->ops->poll_put_char)) {
2338 ret = -1;
2339 goto out;
2342 if (port->ops->poll_init) {
2344 * We don't set initialized as we only initialized the hw,
2345 * e.g. state->xmit is still uninitialized.
2347 if (!tty_port_initialized(tport))
2348 ret = port->ops->poll_init(port);
2351 if (!ret && options) {
2352 uart_parse_options(options, &baud, &parity, &bits, &flow);
2353 ret = uart_set_options(port, NULL, baud, parity, bits, flow);
2355 out:
2356 mutex_unlock(&tport->mutex);
2357 return ret;
2360 static int uart_poll_get_char(struct tty_driver *driver, int line)
2362 struct uart_driver *drv = driver->driver_state;
2363 struct uart_state *state = drv->state + line;
2364 struct uart_port *port;
2365 int ret = -1;
2367 port = uart_port_ref(state);
2368 if (port) {
2369 ret = port->ops->poll_get_char(port);
2370 uart_port_deref(port);
2373 return ret;
2376 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2378 struct uart_driver *drv = driver->driver_state;
2379 struct uart_state *state = drv->state + line;
2380 struct uart_port *port;
2382 port = uart_port_ref(state);
2383 if (!port)
2384 return;
2386 if (ch == '\n')
2387 port->ops->poll_put_char(port, '\r');
2388 port->ops->poll_put_char(port, ch);
2389 uart_port_deref(port);
2391 #endif
2393 static const struct tty_operations uart_ops = {
2394 .open = uart_open,
2395 .close = uart_close,
2396 .write = uart_write,
2397 .put_char = uart_put_char,
2398 .flush_chars = uart_flush_chars,
2399 .write_room = uart_write_room,
2400 .chars_in_buffer= uart_chars_in_buffer,
2401 .flush_buffer = uart_flush_buffer,
2402 .ioctl = uart_ioctl,
2403 .throttle = uart_throttle,
2404 .unthrottle = uart_unthrottle,
2405 .send_xchar = uart_send_xchar,
2406 .set_termios = uart_set_termios,
2407 .set_ldisc = uart_set_ldisc,
2408 .stop = uart_stop,
2409 .start = uart_start,
2410 .hangup = uart_hangup,
2411 .break_ctl = uart_break_ctl,
2412 .wait_until_sent= uart_wait_until_sent,
2413 #ifdef CONFIG_PROC_FS
2414 .proc_fops = &uart_proc_fops,
2415 #endif
2416 .tiocmget = uart_tiocmget,
2417 .tiocmset = uart_tiocmset,
2418 .get_icount = uart_get_icount,
2419 #ifdef CONFIG_CONSOLE_POLL
2420 .poll_init = uart_poll_init,
2421 .poll_get_char = uart_poll_get_char,
2422 .poll_put_char = uart_poll_put_char,
2423 #endif
2426 static const struct tty_port_operations uart_port_ops = {
2427 .carrier_raised = uart_carrier_raised,
2428 .dtr_rts = uart_dtr_rts,
2429 .activate = uart_port_activate,
2430 .shutdown = uart_tty_port_shutdown,
2434 * uart_register_driver - register a driver with the uart core layer
2435 * @drv: low level driver structure
2437 * Register a uart driver with the core driver. We in turn register
2438 * with the tty layer, and initialise the core driver per-port state.
2440 * We have a proc file in /proc/tty/driver which is named after the
2441 * normal driver.
2443 * drv->port should be NULL, and the per-port structures should be
2444 * registered using uart_add_one_port after this call has succeeded.
2446 int uart_register_driver(struct uart_driver *drv)
2448 struct tty_driver *normal;
2449 int i, retval;
2451 BUG_ON(drv->state);
2454 * Maybe we should be using a slab cache for this, especially if
2455 * we have a large number of ports to handle.
2457 drv->state = kzalloc(sizeof(struct uart_state) * drv->nr, GFP_KERNEL);
2458 if (!drv->state)
2459 goto out;
2461 normal = alloc_tty_driver(drv->nr);
2462 if (!normal)
2463 goto out_kfree;
2465 drv->tty_driver = normal;
2467 normal->driver_name = drv->driver_name;
2468 normal->name = drv->dev_name;
2469 normal->major = drv->major;
2470 normal->minor_start = drv->minor;
2471 normal->type = TTY_DRIVER_TYPE_SERIAL;
2472 normal->subtype = SERIAL_TYPE_NORMAL;
2473 normal->init_termios = tty_std_termios;
2474 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2475 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2476 normal->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV;
2477 normal->driver_state = drv;
2478 tty_set_operations(normal, &uart_ops);
2481 * Initialise the UART state(s).
2483 for (i = 0; i < drv->nr; i++) {
2484 struct uart_state *state = drv->state + i;
2485 struct tty_port *port = &state->port;
2487 tty_port_init(port);
2488 port->ops = &uart_port_ops;
2491 retval = tty_register_driver(normal);
2492 if (retval >= 0)
2493 return retval;
2495 for (i = 0; i < drv->nr; i++)
2496 tty_port_destroy(&drv->state[i].port);
2497 put_tty_driver(normal);
2498 out_kfree:
2499 kfree(drv->state);
2500 out:
2501 return -ENOMEM;
2505 * uart_unregister_driver - remove a driver from the uart core layer
2506 * @drv: low level driver structure
2508 * Remove all references to a driver from the core driver. The low
2509 * level driver must have removed all its ports via the
2510 * uart_remove_one_port() if it registered them with uart_add_one_port().
2511 * (ie, drv->port == NULL)
2513 void uart_unregister_driver(struct uart_driver *drv)
2515 struct tty_driver *p = drv->tty_driver;
2516 unsigned int i;
2518 tty_unregister_driver(p);
2519 put_tty_driver(p);
2520 for (i = 0; i < drv->nr; i++)
2521 tty_port_destroy(&drv->state[i].port);
2522 kfree(drv->state);
2523 drv->state = NULL;
2524 drv->tty_driver = NULL;
2527 struct tty_driver *uart_console_device(struct console *co, int *index)
2529 struct uart_driver *p = co->data;
2530 *index = co->index;
2531 return p->tty_driver;
2534 static ssize_t uart_get_attr_uartclk(struct device *dev,
2535 struct device_attribute *attr, char *buf)
2537 struct serial_struct tmp;
2538 struct tty_port *port = dev_get_drvdata(dev);
2540 uart_get_info(port, &tmp);
2541 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.baud_base * 16);
2544 static ssize_t uart_get_attr_type(struct device *dev,
2545 struct device_attribute *attr, char *buf)
2547 struct serial_struct tmp;
2548 struct tty_port *port = dev_get_drvdata(dev);
2550 uart_get_info(port, &tmp);
2551 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.type);
2553 static ssize_t uart_get_attr_line(struct device *dev,
2554 struct device_attribute *attr, char *buf)
2556 struct serial_struct tmp;
2557 struct tty_port *port = dev_get_drvdata(dev);
2559 uart_get_info(port, &tmp);
2560 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.line);
2563 static ssize_t uart_get_attr_port(struct device *dev,
2564 struct device_attribute *attr, char *buf)
2566 struct serial_struct tmp;
2567 struct tty_port *port = dev_get_drvdata(dev);
2568 unsigned long ioaddr;
2570 uart_get_info(port, &tmp);
2571 ioaddr = tmp.port;
2572 if (HIGH_BITS_OFFSET)
2573 ioaddr |= (unsigned long)tmp.port_high << HIGH_BITS_OFFSET;
2574 return snprintf(buf, PAGE_SIZE, "0x%lX\n", ioaddr);
2577 static ssize_t uart_get_attr_irq(struct device *dev,
2578 struct device_attribute *attr, char *buf)
2580 struct serial_struct tmp;
2581 struct tty_port *port = dev_get_drvdata(dev);
2583 uart_get_info(port, &tmp);
2584 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.irq);
2587 static ssize_t uart_get_attr_flags(struct device *dev,
2588 struct device_attribute *attr, char *buf)
2590 struct serial_struct tmp;
2591 struct tty_port *port = dev_get_drvdata(dev);
2593 uart_get_info(port, &tmp);
2594 return snprintf(buf, PAGE_SIZE, "0x%X\n", tmp.flags);
2597 static ssize_t uart_get_attr_xmit_fifo_size(struct device *dev,
2598 struct device_attribute *attr, char *buf)
2600 struct serial_struct tmp;
2601 struct tty_port *port = dev_get_drvdata(dev);
2603 uart_get_info(port, &tmp);
2604 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.xmit_fifo_size);
2608 static ssize_t uart_get_attr_close_delay(struct device *dev,
2609 struct device_attribute *attr, char *buf)
2611 struct serial_struct tmp;
2612 struct tty_port *port = dev_get_drvdata(dev);
2614 uart_get_info(port, &tmp);
2615 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.close_delay);
2619 static ssize_t uart_get_attr_closing_wait(struct device *dev,
2620 struct device_attribute *attr, char *buf)
2622 struct serial_struct tmp;
2623 struct tty_port *port = dev_get_drvdata(dev);
2625 uart_get_info(port, &tmp);
2626 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.closing_wait);
2629 static ssize_t uart_get_attr_custom_divisor(struct device *dev,
2630 struct device_attribute *attr, char *buf)
2632 struct serial_struct tmp;
2633 struct tty_port *port = dev_get_drvdata(dev);
2635 uart_get_info(port, &tmp);
2636 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.custom_divisor);
2639 static ssize_t uart_get_attr_io_type(struct device *dev,
2640 struct device_attribute *attr, char *buf)
2642 struct serial_struct tmp;
2643 struct tty_port *port = dev_get_drvdata(dev);
2645 uart_get_info(port, &tmp);
2646 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.io_type);
2649 static ssize_t uart_get_attr_iomem_base(struct device *dev,
2650 struct device_attribute *attr, char *buf)
2652 struct serial_struct tmp;
2653 struct tty_port *port = dev_get_drvdata(dev);
2655 uart_get_info(port, &tmp);
2656 return snprintf(buf, PAGE_SIZE, "0x%lX\n", (unsigned long)tmp.iomem_base);
2659 static ssize_t uart_get_attr_iomem_reg_shift(struct device *dev,
2660 struct device_attribute *attr, char *buf)
2662 struct serial_struct tmp;
2663 struct tty_port *port = dev_get_drvdata(dev);
2665 uart_get_info(port, &tmp);
2666 return snprintf(buf, PAGE_SIZE, "%d\n", tmp.iomem_reg_shift);
2669 static DEVICE_ATTR(type, S_IRUSR | S_IRGRP, uart_get_attr_type, NULL);
2670 static DEVICE_ATTR(line, S_IRUSR | S_IRGRP, uart_get_attr_line, NULL);
2671 static DEVICE_ATTR(port, S_IRUSR | S_IRGRP, uart_get_attr_port, NULL);
2672 static DEVICE_ATTR(irq, S_IRUSR | S_IRGRP, uart_get_attr_irq, NULL);
2673 static DEVICE_ATTR(flags, S_IRUSR | S_IRGRP, uart_get_attr_flags, NULL);
2674 static DEVICE_ATTR(xmit_fifo_size, S_IRUSR | S_IRGRP, uart_get_attr_xmit_fifo_size, NULL);
2675 static DEVICE_ATTR(uartclk, S_IRUSR | S_IRGRP, uart_get_attr_uartclk, NULL);
2676 static DEVICE_ATTR(close_delay, S_IRUSR | S_IRGRP, uart_get_attr_close_delay, NULL);
2677 static DEVICE_ATTR(closing_wait, S_IRUSR | S_IRGRP, uart_get_attr_closing_wait, NULL);
2678 static DEVICE_ATTR(custom_divisor, S_IRUSR | S_IRGRP, uart_get_attr_custom_divisor, NULL);
2679 static DEVICE_ATTR(io_type, S_IRUSR | S_IRGRP, uart_get_attr_io_type, NULL);
2680 static DEVICE_ATTR(iomem_base, S_IRUSR | S_IRGRP, uart_get_attr_iomem_base, NULL);
2681 static DEVICE_ATTR(iomem_reg_shift, S_IRUSR | S_IRGRP, uart_get_attr_iomem_reg_shift, NULL);
2683 static struct attribute *tty_dev_attrs[] = {
2684 &dev_attr_type.attr,
2685 &dev_attr_line.attr,
2686 &dev_attr_port.attr,
2687 &dev_attr_irq.attr,
2688 &dev_attr_flags.attr,
2689 &dev_attr_xmit_fifo_size.attr,
2690 &dev_attr_uartclk.attr,
2691 &dev_attr_close_delay.attr,
2692 &dev_attr_closing_wait.attr,
2693 &dev_attr_custom_divisor.attr,
2694 &dev_attr_io_type.attr,
2695 &dev_attr_iomem_base.attr,
2696 &dev_attr_iomem_reg_shift.attr,
2697 NULL,
2700 static const struct attribute_group tty_dev_attr_group = {
2701 .attrs = tty_dev_attrs,
2705 * uart_add_one_port - attach a driver-defined port structure
2706 * @drv: pointer to the uart low level driver structure for this port
2707 * @uport: uart port structure to use for this port.
2709 * This allows the driver to register its own uart_port structure
2710 * with the core driver. The main purpose is to allow the low
2711 * level uart drivers to expand uart_port, rather than having yet
2712 * more levels of structures.
2714 int uart_add_one_port(struct uart_driver *drv, struct uart_port *uport)
2716 struct uart_state *state;
2717 struct tty_port *port;
2718 int ret = 0;
2719 struct device *tty_dev;
2720 int num_groups;
2722 BUG_ON(in_interrupt());
2724 if (uport->line >= drv->nr)
2725 return -EINVAL;
2727 state = drv->state + uport->line;
2728 port = &state->port;
2730 mutex_lock(&port_mutex);
2731 mutex_lock(&port->mutex);
2732 if (state->uart_port) {
2733 ret = -EINVAL;
2734 goto out;
2737 /* Link the port to the driver state table and vice versa */
2738 atomic_set(&state->refcount, 1);
2739 init_waitqueue_head(&state->remove_wait);
2740 state->uart_port = uport;
2741 uport->state = state;
2743 state->pm_state = UART_PM_STATE_UNDEFINED;
2744 uport->cons = drv->cons;
2745 uport->minor = drv->tty_driver->minor_start + uport->line;
2746 uport->name = kasprintf(GFP_KERNEL, "%s%d", drv->dev_name,
2747 drv->tty_driver->name_base + uport->line);
2748 if (!uport->name) {
2749 ret = -ENOMEM;
2750 goto out;
2754 * If this port is a console, then the spinlock is already
2755 * initialised.
2757 if (!(uart_console(uport) && (uport->cons->flags & CON_ENABLED))) {
2758 spin_lock_init(&uport->lock);
2759 lockdep_set_class(&uport->lock, &port_lock_key);
2761 if (uport->cons && uport->dev)
2762 of_console_check(uport->dev->of_node, uport->cons->name, uport->line);
2764 uart_configure_port(drv, state, uport);
2766 port->console = uart_console(uport);
2768 num_groups = 2;
2769 if (uport->attr_group)
2770 num_groups++;
2772 uport->tty_groups = kcalloc(num_groups, sizeof(*uport->tty_groups),
2773 GFP_KERNEL);
2774 if (!uport->tty_groups) {
2775 ret = -ENOMEM;
2776 goto out;
2778 uport->tty_groups[0] = &tty_dev_attr_group;
2779 if (uport->attr_group)
2780 uport->tty_groups[1] = uport->attr_group;
2783 * Register the port whether it's detected or not. This allows
2784 * setserial to be used to alter this port's parameters.
2786 tty_dev = tty_port_register_device_attr_serdev(port, drv->tty_driver,
2787 uport->line, uport->dev, port, uport->tty_groups);
2788 if (likely(!IS_ERR(tty_dev))) {
2789 device_set_wakeup_capable(tty_dev, 1);
2790 } else {
2791 dev_err(uport->dev, "Cannot register tty device on line %d\n",
2792 uport->line);
2796 * Ensure UPF_DEAD is not set.
2798 uport->flags &= ~UPF_DEAD;
2800 out:
2801 mutex_unlock(&port->mutex);
2802 mutex_unlock(&port_mutex);
2804 return ret;
2808 * uart_remove_one_port - detach a driver defined port structure
2809 * @drv: pointer to the uart low level driver structure for this port
2810 * @uport: uart port structure for this port
2812 * This unhooks (and hangs up) the specified port structure from the
2813 * core driver. No further calls will be made to the low-level code
2814 * for this port.
2816 int uart_remove_one_port(struct uart_driver *drv, struct uart_port *uport)
2818 struct uart_state *state = drv->state + uport->line;
2819 struct tty_port *port = &state->port;
2820 struct uart_port *uart_port;
2821 struct tty_struct *tty;
2822 int ret = 0;
2824 BUG_ON(in_interrupt());
2826 mutex_lock(&port_mutex);
2829 * Mark the port "dead" - this prevents any opens from
2830 * succeeding while we shut down the port.
2832 mutex_lock(&port->mutex);
2833 uart_port = uart_port_check(state);
2834 if (uart_port != uport)
2835 dev_alert(uport->dev, "Removing wrong port: %p != %p\n",
2836 uart_port, uport);
2838 if (!uart_port) {
2839 mutex_unlock(&port->mutex);
2840 ret = -EINVAL;
2841 goto out;
2843 uport->flags |= UPF_DEAD;
2844 mutex_unlock(&port->mutex);
2847 * Remove the devices from the tty layer
2849 tty_port_unregister_device(port, drv->tty_driver, uport->line);
2851 tty = tty_port_tty_get(port);
2852 if (tty) {
2853 tty_vhangup(port->tty);
2854 tty_kref_put(tty);
2858 * If the port is used as a console, unregister it
2860 if (uart_console(uport))
2861 unregister_console(uport->cons);
2864 * Free the port IO and memory resources, if any.
2866 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
2867 uport->ops->release_port(uport);
2868 kfree(uport->tty_groups);
2869 kfree(uport->name);
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);
3019 * uart_get_rs485_mode() - retrieve rs485 properties for given uart
3020 * @dev: uart device
3021 * @rs485conf: output parameter
3023 * This function implements the device tree binding described in
3024 * Documentation/devicetree/bindings/serial/rs485.txt.
3026 void uart_get_rs485_mode(struct device *dev, struct serial_rs485 *rs485conf)
3028 u32 rs485_delay[2];
3029 int ret;
3031 ret = device_property_read_u32_array(dev, "rs485-rts-delay",
3032 rs485_delay, 2);
3033 if (!ret) {
3034 rs485conf->delay_rts_before_send = rs485_delay[0];
3035 rs485conf->delay_rts_after_send = rs485_delay[1];
3036 } else {
3037 rs485conf->delay_rts_before_send = 0;
3038 rs485conf->delay_rts_after_send = 0;
3042 * Clear full-duplex and enabled flags, set RTS polarity to active high
3043 * to get to a defined state with the following properties:
3045 rs485conf->flags &= ~(SER_RS485_RX_DURING_TX | SER_RS485_ENABLED |
3046 SER_RS485_RTS_AFTER_SEND);
3047 rs485conf->flags |= SER_RS485_RTS_ON_SEND;
3049 if (device_property_read_bool(dev, "rs485-rx-during-tx"))
3050 rs485conf->flags |= SER_RS485_RX_DURING_TX;
3052 if (device_property_read_bool(dev, "linux,rs485-enabled-at-boot-time"))
3053 rs485conf->flags |= SER_RS485_ENABLED;
3055 if (device_property_read_bool(dev, "rs485-rts-active-low")) {
3056 rs485conf->flags &= ~SER_RS485_RTS_ON_SEND;
3057 rs485conf->flags |= SER_RS485_RTS_AFTER_SEND;
3060 EXPORT_SYMBOL_GPL(uart_get_rs485_mode);
3062 MODULE_DESCRIPTION("Serial driver core");
3063 MODULE_LICENSE("GPL");