1 // SPDX-License-Identifier: GPL-2.0+
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.
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/gpio/consumer.h>
18 #include <linux/kernel.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/proc_fs.h>
22 #include <linux/seq_file.h>
23 #include <linux/device.h>
24 #include <linux/serial.h> /* for serial_state and serial_icounter_struct */
25 #include <linux/serial_core.h>
26 #include <linux/sysrq.h>
27 #include <linux/delay.h>
28 #include <linux/mutex.h>
29 #include <linux/math64.h>
30 #include <linux/security.h>
32 #include <linux/irq.h>
33 #include <linux/uaccess.h>
35 #include "serial_base.h"
38 * This is used to lock changes in serial line configuration.
40 static DEFINE_MUTEX(port_mutex);
43 * lockdep: port->lock is initialized in two places, but we
44 * want only one lock-class:
46 static struct lock_class_key port_lock_key;
48 #define HIGH_BITS_OFFSET ((sizeof(long)-sizeof(int))*8)
51 * Max time with active RTS before/after data is sent.
53 #define RS485_MAX_RTS_DELAY 100 /* msecs */
55 static void uart_change_pm(struct uart_state *state,
56 enum uart_pm_state pm_state);
58 static void uart_port_shutdown(struct tty_port *port);
60 static int uart_dcd_enabled(struct uart_port *uport)
62 return !!(uport->status & UPSTAT_DCD_ENABLE);
65 static inline struct uart_port *uart_port_ref(struct uart_state *state)
67 if (atomic_add_unless(&state->refcount, 1, 0))
68 return state->uart_port;
72 static inline void uart_port_deref(struct uart_port *uport)
74 if (atomic_dec_and_test(&uport->state->refcount))
75 wake_up(&uport->state->remove_wait);
78 #define uart_port_lock(state, flags) \
80 struct uart_port *__uport = uart_port_ref(state); \
82 spin_lock_irqsave(&__uport->lock, flags); \
86 #define uart_port_unlock(uport, flags) \
88 struct uart_port *__uport = uport; \
90 spin_unlock_irqrestore(&__uport->lock, flags); \
91 uart_port_deref(__uport); \
95 static inline struct uart_port *uart_port_check(struct uart_state *state)
97 lockdep_assert_held(&state->port.mutex);
98 return state->uart_port;
102 * uart_write_wakeup - schedule write processing
103 * @port: port to be processed
105 * This routine is used by the interrupt handler to schedule processing in the
106 * software interrupt portion of the driver. A driver is expected to call this
107 * function when the number of characters in the transmit buffer have dropped
110 * Locking: @port->lock should be held
112 void uart_write_wakeup(struct uart_port *port)
114 struct uart_state *state = port->state;
116 * This means you called this function _after_ the port was
117 * closed. No cookie for you.
120 tty_port_tty_wakeup(&state->port);
122 EXPORT_SYMBOL(uart_write_wakeup);
124 static void uart_stop(struct tty_struct *tty)
126 struct uart_state *state = tty->driver_data;
127 struct uart_port *port;
130 port = uart_port_lock(state, flags);
132 port->ops->stop_tx(port);
133 uart_port_unlock(port, flags);
136 static void __uart_start(struct uart_state *state)
138 struct uart_port *port = state->uart_port;
139 struct serial_port_device *port_dev;
142 if (!port || port->flags & UPF_DEAD || uart_tx_stopped(port))
145 port_dev = port->port_dev;
147 /* Increment the runtime PM usage count for the active check below */
148 err = pm_runtime_get(&port_dev->dev);
150 pm_runtime_put_noidle(&port_dev->dev);
155 * Start TX if enabled, and kick runtime PM. If the device is not
156 * enabled, serial_port_runtime_resume() calls start_tx() again
157 * after enabling the device.
159 if (!pm_runtime_enabled(port->dev) || pm_runtime_active(port->dev))
160 port->ops->start_tx(port);
161 pm_runtime_mark_last_busy(&port_dev->dev);
162 pm_runtime_put_autosuspend(&port_dev->dev);
165 static void uart_start(struct tty_struct *tty)
167 struct uart_state *state = tty->driver_data;
168 struct uart_port *port;
171 port = uart_port_lock(state, flags);
173 uart_port_unlock(port, flags);
177 uart_update_mctrl(struct uart_port *port, unsigned int set, unsigned int clear)
182 spin_lock_irqsave(&port->lock, flags);
184 port->mctrl = (old & ~clear) | set;
185 if (old != port->mctrl && !(port->rs485.flags & SER_RS485_ENABLED))
186 port->ops->set_mctrl(port, port->mctrl);
187 spin_unlock_irqrestore(&port->lock, flags);
190 #define uart_set_mctrl(port, set) uart_update_mctrl(port, set, 0)
191 #define uart_clear_mctrl(port, clear) uart_update_mctrl(port, 0, clear)
193 static void uart_port_dtr_rts(struct uart_port *uport, bool active)
196 uart_set_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
198 uart_clear_mctrl(uport, TIOCM_DTR | TIOCM_RTS);
201 /* Caller holds port mutex */
202 static void uart_change_line_settings(struct tty_struct *tty, struct uart_state *state,
203 const struct ktermios *old_termios)
205 struct uart_port *uport = uart_port_check(state);
206 struct ktermios *termios;
210 * If we have no tty, termios, or the port does not exist,
211 * then we can't set the parameters for this port.
213 if (!tty || uport->type == PORT_UNKNOWN)
216 termios = &tty->termios;
217 uport->ops->set_termios(uport, termios, old_termios);
220 * Set modem status enables based on termios cflag
222 spin_lock_irq(&uport->lock);
223 if (termios->c_cflag & CRTSCTS)
224 uport->status |= UPSTAT_CTS_ENABLE;
226 uport->status &= ~UPSTAT_CTS_ENABLE;
228 if (termios->c_cflag & CLOCAL)
229 uport->status &= ~UPSTAT_DCD_ENABLE;
231 uport->status |= UPSTAT_DCD_ENABLE;
233 /* reset sw-assisted CTS flow control based on (possibly) new mode */
234 old_hw_stopped = uport->hw_stopped;
235 uport->hw_stopped = uart_softcts_mode(uport) &&
236 !(uport->ops->get_mctrl(uport) & TIOCM_CTS);
237 if (uport->hw_stopped != old_hw_stopped) {
239 uport->ops->stop_tx(uport);
243 spin_unlock_irq(&uport->lock);
247 * Startup the port. This will be called once per open. All calls
248 * will be serialised by the per-port mutex.
250 static int uart_port_startup(struct tty_struct *tty, struct uart_state *state,
253 struct uart_port *uport = uart_port_check(state);
258 if (uport->type == PORT_UNKNOWN)
262 * Make sure the device is in D0 state.
264 uart_change_pm(state, UART_PM_STATE_ON);
267 * Initialise and allocate the transmit and temporary
270 page = get_zeroed_page(GFP_KERNEL);
274 uart_port_lock(state, flags);
275 if (!state->xmit.buf) {
276 state->xmit.buf = (unsigned char *) page;
277 uart_circ_clear(&state->xmit);
278 uart_port_unlock(uport, flags);
280 uart_port_unlock(uport, flags);
282 * Do not free() the page under the port lock, see
288 retval = uport->ops->startup(uport);
290 if (uart_console(uport) && uport->cons->cflag) {
291 tty->termios.c_cflag = uport->cons->cflag;
292 tty->termios.c_ispeed = uport->cons->ispeed;
293 tty->termios.c_ospeed = uport->cons->ospeed;
294 uport->cons->cflag = 0;
295 uport->cons->ispeed = 0;
296 uport->cons->ospeed = 0;
299 * Initialise the hardware port settings.
301 uart_change_line_settings(tty, state, NULL);
304 * Setup the RTS and DTR signals once the
305 * port is open and ready to respond.
307 if (init_hw && C_BAUD(tty))
308 uart_port_dtr_rts(uport, true);
312 * This is to allow setserial on this port. People may want to set
313 * port/irq/type and then reconfigure the port properly if it failed
316 if (retval && capable(CAP_SYS_ADMIN))
322 static int uart_startup(struct tty_struct *tty, struct uart_state *state,
325 struct tty_port *port = &state->port;
328 if (tty_port_initialized(port))
331 retval = uart_port_startup(tty, state, init_hw);
333 set_bit(TTY_IO_ERROR, &tty->flags);
339 * This routine will shutdown a serial port; interrupts are disabled, and
340 * DTR is dropped if the hangup on close termio flag is on. Calls to
341 * uart_shutdown are serialised by the per-port semaphore.
343 * uport == NULL if uart_port has already been removed
345 static void uart_shutdown(struct tty_struct *tty, struct uart_state *state)
347 struct uart_port *uport = uart_port_check(state);
348 struct tty_port *port = &state->port;
350 char *xmit_buf = NULL;
353 * Set the TTY IO error marker
356 set_bit(TTY_IO_ERROR, &tty->flags);
358 if (tty_port_initialized(port)) {
359 tty_port_set_initialized(port, false);
362 * Turn off DTR and RTS early.
364 if (uport && uart_console(uport) && tty) {
365 uport->cons->cflag = tty->termios.c_cflag;
366 uport->cons->ispeed = tty->termios.c_ispeed;
367 uport->cons->ospeed = tty->termios.c_ospeed;
370 if (!tty || C_HUPCL(tty))
371 uart_port_dtr_rts(uport, false);
373 uart_port_shutdown(port);
377 * It's possible for shutdown to be called after suspend if we get
378 * a DCD drop (hangup) at just the right time. Clear suspended bit so
379 * we don't try to resume a port that has been shutdown.
381 tty_port_set_suspended(port, false);
384 * Do not free() the transmit buffer page under the port lock since
385 * this can create various circular locking scenarios. For instance,
386 * console driver may need to allocate/free a debug object, which
387 * can endup in printk() recursion.
389 uart_port_lock(state, flags);
390 xmit_buf = state->xmit.buf;
391 state->xmit.buf = NULL;
392 uart_port_unlock(uport, flags);
394 free_page((unsigned long)xmit_buf);
398 * uart_update_timeout - update per-port frame timing information
399 * @port: uart_port structure describing the port
400 * @cflag: termios cflag value
401 * @baud: speed of the port
403 * Set the @port frame timing information from which the FIFO timeout value is
404 * derived. The @cflag value should reflect the actual hardware settings as
405 * number of bits, parity, stop bits and baud rate is taken into account here.
407 * Locking: caller is expected to take @port->lock
410 uart_update_timeout(struct uart_port *port, unsigned int cflag,
413 unsigned int size = tty_get_frame_size(cflag);
416 frame_time = (u64)size * NSEC_PER_SEC;
417 port->frame_time = DIV64_U64_ROUND_UP(frame_time, baud);
419 EXPORT_SYMBOL(uart_update_timeout);
422 * uart_get_baud_rate - return baud rate for a particular port
423 * @port: uart_port structure describing the port in question.
424 * @termios: desired termios settings
425 * @old: old termios (or %NULL)
426 * @min: minimum acceptable baud rate
427 * @max: maximum acceptable baud rate
429 * Decode the termios structure into a numeric baud rate, taking account of the
430 * magic 38400 baud rate (with spd_* flags), and mapping the %B0 rate to 9600
433 * If the new baud rate is invalid, try the @old termios setting. If it's still
434 * invalid, we try 9600 baud.
436 * The @termios structure is updated to reflect the baud rate we're actually
437 * going to be using. Don't do this for the case where B0 is requested ("hang
440 * Locking: caller dependent
443 uart_get_baud_rate(struct uart_port *port, struct ktermios *termios,
444 const struct ktermios *old, unsigned int min, unsigned int max)
448 unsigned int altbaud;
450 upf_t flags = port->flags & UPF_SPD_MASK;
470 for (try = 0; try < 2; try++) {
471 baud = tty_termios_baud_rate(termios);
474 * The spd_hi, spd_vhi, spd_shi, spd_warp kludge...
477 if (try == 0 && baud == 38400)
481 * Special case: B0 rate.
488 if (baud >= min && baud <= max)
492 * Oops, the quotient was zero. Try again with
493 * the old baud rate if possible.
495 termios->c_cflag &= ~CBAUD;
497 baud = tty_termios_baud_rate(old);
499 tty_termios_encode_baud_rate(termios,
506 * As a last resort, if the range cannot be met then clip to
507 * the nearest chip supported rate.
511 tty_termios_encode_baud_rate(termios,
514 tty_termios_encode_baud_rate(termios,
518 /* Should never happen */
522 EXPORT_SYMBOL(uart_get_baud_rate);
525 * uart_get_divisor - return uart clock divisor
526 * @port: uart_port structure describing the port
527 * @baud: desired baud rate
529 * Calculate the divisor (baud_base / baud) for the specified @baud,
530 * appropriately rounded.
532 * If 38400 baud and custom divisor is selected, return the custom divisor
535 * Locking: caller dependent
538 uart_get_divisor(struct uart_port *port, unsigned int baud)
543 * Old custom speed handling.
545 if (baud == 38400 && (port->flags & UPF_SPD_MASK) == UPF_SPD_CUST)
546 quot = port->custom_divisor;
548 quot = DIV_ROUND_CLOSEST(port->uartclk, 16 * baud);
552 EXPORT_SYMBOL(uart_get_divisor);
554 static int uart_put_char(struct tty_struct *tty, u8 c)
556 struct uart_state *state = tty->driver_data;
557 struct uart_port *port;
558 struct circ_buf *circ;
563 port = uart_port_lock(state, flags);
565 uart_port_unlock(port, flags);
569 if (port && uart_circ_chars_free(circ) != 0) {
570 circ->buf[circ->head] = c;
571 circ->head = (circ->head + 1) & (UART_XMIT_SIZE - 1);
574 uart_port_unlock(port, flags);
578 static void uart_flush_chars(struct tty_struct *tty)
583 static ssize_t uart_write(struct tty_struct *tty, const u8 *buf, size_t count)
585 struct uart_state *state = tty->driver_data;
586 struct uart_port *port;
587 struct circ_buf *circ;
592 * This means you called this function _after_ the port was
593 * closed. No cookie for you.
598 port = uart_port_lock(state, flags);
601 uart_port_unlock(port, flags);
606 c = CIRC_SPACE_TO_END(circ->head, circ->tail, UART_XMIT_SIZE);
611 memcpy(circ->buf + circ->head, buf, c);
612 circ->head = (circ->head + c) & (UART_XMIT_SIZE - 1);
619 uart_port_unlock(port, flags);
623 static unsigned int uart_write_room(struct tty_struct *tty)
625 struct uart_state *state = tty->driver_data;
626 struct uart_port *port;
630 port = uart_port_lock(state, flags);
631 ret = uart_circ_chars_free(&state->xmit);
632 uart_port_unlock(port, flags);
636 static unsigned int uart_chars_in_buffer(struct tty_struct *tty)
638 struct uart_state *state = tty->driver_data;
639 struct uart_port *port;
643 port = uart_port_lock(state, flags);
644 ret = uart_circ_chars_pending(&state->xmit);
645 uart_port_unlock(port, flags);
649 static void uart_flush_buffer(struct tty_struct *tty)
651 struct uart_state *state = tty->driver_data;
652 struct uart_port *port;
656 * This means you called this function _after_ the port was
657 * closed. No cookie for you.
662 pr_debug("uart_flush_buffer(%d) called\n", tty->index);
664 port = uart_port_lock(state, flags);
667 uart_circ_clear(&state->xmit);
668 if (port->ops->flush_buffer)
669 port->ops->flush_buffer(port);
670 uart_port_unlock(port, flags);
671 tty_port_tty_wakeup(&state->port);
675 * This function performs low-level write of high-priority XON/XOFF
676 * character and accounting for it.
678 * Requires uart_port to implement .serial_out().
680 void uart_xchar_out(struct uart_port *uport, int offset)
682 serial_port_out(uport, offset, uport->x_char);
686 EXPORT_SYMBOL_GPL(uart_xchar_out);
689 * This function is used to send a high-priority XON/XOFF character to
692 static void uart_send_xchar(struct tty_struct *tty, char ch)
694 struct uart_state *state = tty->driver_data;
695 struct uart_port *port;
698 port = uart_port_ref(state);
702 if (port->ops->send_xchar)
703 port->ops->send_xchar(port, ch);
705 spin_lock_irqsave(&port->lock, flags);
708 port->ops->start_tx(port);
709 spin_unlock_irqrestore(&port->lock, flags);
711 uart_port_deref(port);
714 static void uart_throttle(struct tty_struct *tty)
716 struct uart_state *state = tty->driver_data;
717 upstat_t mask = UPSTAT_SYNC_FIFO;
718 struct uart_port *port;
720 port = uart_port_ref(state);
725 mask |= UPSTAT_AUTOXOFF;
727 mask |= UPSTAT_AUTORTS;
729 if (port->status & mask) {
730 port->ops->throttle(port);
731 mask &= ~port->status;
734 if (mask & UPSTAT_AUTORTS)
735 uart_clear_mctrl(port, TIOCM_RTS);
737 if (mask & UPSTAT_AUTOXOFF)
738 uart_send_xchar(tty, STOP_CHAR(tty));
740 uart_port_deref(port);
743 static void uart_unthrottle(struct tty_struct *tty)
745 struct uart_state *state = tty->driver_data;
746 upstat_t mask = UPSTAT_SYNC_FIFO;
747 struct uart_port *port;
749 port = uart_port_ref(state);
754 mask |= UPSTAT_AUTOXOFF;
756 mask |= UPSTAT_AUTORTS;
758 if (port->status & mask) {
759 port->ops->unthrottle(port);
760 mask &= ~port->status;
763 if (mask & UPSTAT_AUTORTS)
764 uart_set_mctrl(port, TIOCM_RTS);
766 if (mask & UPSTAT_AUTOXOFF)
767 uart_send_xchar(tty, START_CHAR(tty));
769 uart_port_deref(port);
772 static int uart_get_info(struct tty_port *port, struct serial_struct *retinfo)
774 struct uart_state *state = container_of(port, struct uart_state, port);
775 struct uart_port *uport;
779 * Ensure the state we copy is consistent and no hardware changes
782 mutex_lock(&port->mutex);
783 uport = uart_port_check(state);
787 retinfo->type = uport->type;
788 retinfo->line = uport->line;
789 retinfo->port = uport->iobase;
790 if (HIGH_BITS_OFFSET)
791 retinfo->port_high = (long) uport->iobase >> HIGH_BITS_OFFSET;
792 retinfo->irq = uport->irq;
793 retinfo->flags = (__force int)uport->flags;
794 retinfo->xmit_fifo_size = uport->fifosize;
795 retinfo->baud_base = uport->uartclk / 16;
796 retinfo->close_delay = jiffies_to_msecs(port->close_delay) / 10;
797 retinfo->closing_wait = port->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
798 ASYNC_CLOSING_WAIT_NONE :
799 jiffies_to_msecs(port->closing_wait) / 10;
800 retinfo->custom_divisor = uport->custom_divisor;
801 retinfo->hub6 = uport->hub6;
802 retinfo->io_type = uport->iotype;
803 retinfo->iomem_reg_shift = uport->regshift;
804 retinfo->iomem_base = (void *)(unsigned long)uport->mapbase;
808 mutex_unlock(&port->mutex);
812 static int uart_get_info_user(struct tty_struct *tty,
813 struct serial_struct *ss)
815 struct uart_state *state = tty->driver_data;
816 struct tty_port *port = &state->port;
818 return uart_get_info(port, ss) < 0 ? -EIO : 0;
821 static int uart_set_info(struct tty_struct *tty, struct tty_port *port,
822 struct uart_state *state,
823 struct serial_struct *new_info)
825 struct uart_port *uport = uart_port_check(state);
826 unsigned long new_port;
827 unsigned int change_irq, change_port, closing_wait;
828 unsigned int old_custom_divisor, close_delay;
829 upf_t old_flags, new_flags;
835 new_port = new_info->port;
836 if (HIGH_BITS_OFFSET)
837 new_port += (unsigned long) new_info->port_high << HIGH_BITS_OFFSET;
839 new_info->irq = irq_canonicalize(new_info->irq);
840 close_delay = msecs_to_jiffies(new_info->close_delay * 10);
841 closing_wait = new_info->closing_wait == ASYNC_CLOSING_WAIT_NONE ?
842 ASYNC_CLOSING_WAIT_NONE :
843 msecs_to_jiffies(new_info->closing_wait * 10);
846 change_irq = !(uport->flags & UPF_FIXED_PORT)
847 && new_info->irq != uport->irq;
850 * Since changing the 'type' of the port changes its resource
851 * allocations, we should treat type changes the same as
854 change_port = !(uport->flags & UPF_FIXED_PORT)
855 && (new_port != uport->iobase ||
856 (unsigned long)new_info->iomem_base != uport->mapbase ||
857 new_info->hub6 != uport->hub6 ||
858 new_info->io_type != uport->iotype ||
859 new_info->iomem_reg_shift != uport->regshift ||
860 new_info->type != uport->type);
862 old_flags = uport->flags;
863 new_flags = (__force upf_t)new_info->flags;
864 old_custom_divisor = uport->custom_divisor;
866 if (!capable(CAP_SYS_ADMIN)) {
868 if (change_irq || change_port ||
869 (new_info->baud_base != uport->uartclk / 16) ||
870 (close_delay != port->close_delay) ||
871 (closing_wait != port->closing_wait) ||
872 (new_info->xmit_fifo_size &&
873 new_info->xmit_fifo_size != uport->fifosize) ||
874 (((new_flags ^ old_flags) & ~UPF_USR_MASK) != 0))
876 uport->flags = ((uport->flags & ~UPF_USR_MASK) |
877 (new_flags & UPF_USR_MASK));
878 uport->custom_divisor = new_info->custom_divisor;
882 if (change_irq || change_port) {
883 retval = security_locked_down(LOCKDOWN_TIOCSSERIAL);
889 * Ask the low level driver to verify the settings.
891 if (uport->ops->verify_port)
892 retval = uport->ops->verify_port(uport, new_info);
894 if ((new_info->irq >= nr_irqs) || (new_info->irq < 0) ||
895 (new_info->baud_base < 9600))
901 if (change_port || change_irq) {
905 * Make sure that we are the sole user of this port.
907 if (tty_port_users(port) > 1)
911 * We need to shutdown the serial port at the old
912 * port/type/irq combination.
914 uart_shutdown(tty, state);
918 unsigned long old_iobase, old_mapbase;
919 unsigned int old_type, old_iotype, old_hub6, old_shift;
921 old_iobase = uport->iobase;
922 old_mapbase = uport->mapbase;
923 old_type = uport->type;
924 old_hub6 = uport->hub6;
925 old_iotype = uport->iotype;
926 old_shift = uport->regshift;
929 * Free and release old regions
931 if (old_type != PORT_UNKNOWN && uport->ops->release_port)
932 uport->ops->release_port(uport);
934 uport->iobase = new_port;
935 uport->type = new_info->type;
936 uport->hub6 = new_info->hub6;
937 uport->iotype = new_info->io_type;
938 uport->regshift = new_info->iomem_reg_shift;
939 uport->mapbase = (unsigned long)new_info->iomem_base;
942 * Claim and map the new regions
944 if (uport->type != PORT_UNKNOWN && uport->ops->request_port) {
945 retval = uport->ops->request_port(uport);
947 /* Always success - Jean II */
952 * If we fail to request resources for the
953 * new port, try to restore the old settings.
956 uport->iobase = old_iobase;
957 uport->type = old_type;
958 uport->hub6 = old_hub6;
959 uport->iotype = old_iotype;
960 uport->regshift = old_shift;
961 uport->mapbase = old_mapbase;
963 if (old_type != PORT_UNKNOWN) {
964 retval = uport->ops->request_port(uport);
966 * If we failed to restore the old settings,
970 uport->type = PORT_UNKNOWN;
978 /* Added to return the correct error -Ram Gupta */
984 uport->irq = new_info->irq;
985 if (!(uport->flags & UPF_FIXED_PORT))
986 uport->uartclk = new_info->baud_base * 16;
987 uport->flags = (uport->flags & ~UPF_CHANGE_MASK) |
988 (new_flags & UPF_CHANGE_MASK);
989 uport->custom_divisor = new_info->custom_divisor;
990 port->close_delay = close_delay;
991 port->closing_wait = closing_wait;
992 if (new_info->xmit_fifo_size)
993 uport->fifosize = new_info->xmit_fifo_size;
997 if (uport->type == PORT_UNKNOWN)
999 if (tty_port_initialized(port)) {
1000 if (((old_flags ^ uport->flags) & UPF_SPD_MASK) ||
1001 old_custom_divisor != uport->custom_divisor) {
1003 * If they're setting up a custom divisor or speed,
1004 * instead of clearing it, then bitch about it.
1006 if (uport->flags & UPF_SPD_MASK) {
1007 dev_notice_ratelimited(uport->dev,
1008 "%s sets custom speed on %s. This is deprecated.\n",
1010 tty_name(port->tty));
1012 uart_change_line_settings(tty, state, NULL);
1015 retval = uart_startup(tty, state, true);
1017 tty_port_set_initialized(port, true);
1025 static int uart_set_info_user(struct tty_struct *tty, struct serial_struct *ss)
1027 struct uart_state *state = tty->driver_data;
1028 struct tty_port *port = &state->port;
1031 down_write(&tty->termios_rwsem);
1033 * This semaphore protects port->count. It is also
1034 * very useful to prevent opens. Also, take the
1035 * port configuration semaphore to make sure that a
1036 * module insertion/removal doesn't change anything
1039 mutex_lock(&port->mutex);
1040 retval = uart_set_info(tty, port, state, ss);
1041 mutex_unlock(&port->mutex);
1042 up_write(&tty->termios_rwsem);
1047 * uart_get_lsr_info - get line status register info
1048 * @tty: tty associated with the UART
1049 * @state: UART being queried
1050 * @value: returned modem value
1052 static int uart_get_lsr_info(struct tty_struct *tty,
1053 struct uart_state *state, unsigned int __user *value)
1055 struct uart_port *uport = uart_port_check(state);
1056 unsigned int result;
1058 result = uport->ops->tx_empty(uport);
1061 * If we're about to load something into the transmit
1062 * register, we'll pretend the transmitter isn't empty to
1063 * avoid a race condition (depending on when the transmit
1064 * interrupt happens).
1066 if (uport->x_char ||
1067 ((uart_circ_chars_pending(&state->xmit) > 0) &&
1068 !uart_tx_stopped(uport)))
1069 result &= ~TIOCSER_TEMT;
1071 return put_user(result, value);
1074 static int uart_tiocmget(struct tty_struct *tty)
1076 struct uart_state *state = tty->driver_data;
1077 struct tty_port *port = &state->port;
1078 struct uart_port *uport;
1081 mutex_lock(&port->mutex);
1082 uport = uart_port_check(state);
1086 if (!tty_io_error(tty)) {
1087 result = uport->mctrl;
1088 spin_lock_irq(&uport->lock);
1089 result |= uport->ops->get_mctrl(uport);
1090 spin_unlock_irq(&uport->lock);
1093 mutex_unlock(&port->mutex);
1098 uart_tiocmset(struct tty_struct *tty, unsigned int set, unsigned int clear)
1100 struct uart_state *state = tty->driver_data;
1101 struct tty_port *port = &state->port;
1102 struct uart_port *uport;
1105 mutex_lock(&port->mutex);
1106 uport = uart_port_check(state);
1110 if (!tty_io_error(tty)) {
1111 uart_update_mctrl(uport, set, clear);
1115 mutex_unlock(&port->mutex);
1119 static int uart_break_ctl(struct tty_struct *tty, int break_state)
1121 struct uart_state *state = tty->driver_data;
1122 struct tty_port *port = &state->port;
1123 struct uart_port *uport;
1126 mutex_lock(&port->mutex);
1127 uport = uart_port_check(state);
1131 if (uport->type != PORT_UNKNOWN && uport->ops->break_ctl)
1132 uport->ops->break_ctl(uport, break_state);
1135 mutex_unlock(&port->mutex);
1139 static int uart_do_autoconfig(struct tty_struct *tty, struct uart_state *state)
1141 struct tty_port *port = &state->port;
1142 struct uart_port *uport;
1145 if (!capable(CAP_SYS_ADMIN))
1149 * Take the per-port semaphore. This prevents count from
1150 * changing, and hence any extra opens of the port while
1151 * we're auto-configuring.
1153 if (mutex_lock_interruptible(&port->mutex))
1154 return -ERESTARTSYS;
1156 uport = uart_port_check(state);
1163 if (tty_port_users(port) == 1) {
1164 uart_shutdown(tty, state);
1167 * If we already have a port type configured,
1168 * we must release its resources.
1170 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
1171 uport->ops->release_port(uport);
1173 flags = UART_CONFIG_TYPE;
1174 if (uport->flags & UPF_AUTO_IRQ)
1175 flags |= UART_CONFIG_IRQ;
1178 * This will claim the ports resources if
1181 uport->ops->config_port(uport, flags);
1183 ret = uart_startup(tty, state, true);
1185 tty_port_set_initialized(port, true);
1190 mutex_unlock(&port->mutex);
1194 static void uart_enable_ms(struct uart_port *uport)
1197 * Force modem status interrupts on
1199 if (uport->ops->enable_ms)
1200 uport->ops->enable_ms(uport);
1204 * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
1205 * - mask passed in arg for lines of interest
1206 * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
1207 * Caller should use TIOCGICOUNT to see which one it was
1209 * FIXME: This wants extracting into a common all driver implementation
1210 * of TIOCMWAIT using tty_port.
1212 static int uart_wait_modem_status(struct uart_state *state, unsigned long arg)
1214 struct uart_port *uport;
1215 struct tty_port *port = &state->port;
1216 DECLARE_WAITQUEUE(wait, current);
1217 struct uart_icount cprev, cnow;
1221 * note the counters on entry
1223 uport = uart_port_ref(state);
1226 spin_lock_irq(&uport->lock);
1227 memcpy(&cprev, &uport->icount, sizeof(struct uart_icount));
1228 uart_enable_ms(uport);
1229 spin_unlock_irq(&uport->lock);
1231 add_wait_queue(&port->delta_msr_wait, &wait);
1233 spin_lock_irq(&uport->lock);
1234 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1235 spin_unlock_irq(&uport->lock);
1237 set_current_state(TASK_INTERRUPTIBLE);
1239 if (((arg & TIOCM_RNG) && (cnow.rng != cprev.rng)) ||
1240 ((arg & TIOCM_DSR) && (cnow.dsr != cprev.dsr)) ||
1241 ((arg & TIOCM_CD) && (cnow.dcd != cprev.dcd)) ||
1242 ((arg & TIOCM_CTS) && (cnow.cts != cprev.cts))) {
1249 /* see if a signal did it */
1250 if (signal_pending(current)) {
1257 __set_current_state(TASK_RUNNING);
1258 remove_wait_queue(&port->delta_msr_wait, &wait);
1259 uart_port_deref(uport);
1265 * Get counter of input serial line interrupts (DCD,RI,DSR,CTS)
1266 * Return: write counters to the user passed counter struct
1267 * NB: both 1->0 and 0->1 transitions are counted except for
1268 * RI where only 0->1 is counted.
1270 static int uart_get_icount(struct tty_struct *tty,
1271 struct serial_icounter_struct *icount)
1273 struct uart_state *state = tty->driver_data;
1274 struct uart_icount cnow;
1275 struct uart_port *uport;
1277 uport = uart_port_ref(state);
1280 spin_lock_irq(&uport->lock);
1281 memcpy(&cnow, &uport->icount, sizeof(struct uart_icount));
1282 spin_unlock_irq(&uport->lock);
1283 uart_port_deref(uport);
1285 icount->cts = cnow.cts;
1286 icount->dsr = cnow.dsr;
1287 icount->rng = cnow.rng;
1288 icount->dcd = cnow.dcd;
1289 icount->rx = cnow.rx;
1290 icount->tx = cnow.tx;
1291 icount->frame = cnow.frame;
1292 icount->overrun = cnow.overrun;
1293 icount->parity = cnow.parity;
1294 icount->brk = cnow.brk;
1295 icount->buf_overrun = cnow.buf_overrun;
1300 #define SER_RS485_LEGACY_FLAGS (SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND | \
1301 SER_RS485_RTS_AFTER_SEND | SER_RS485_RX_DURING_TX | \
1302 SER_RS485_TERMINATE_BUS)
1304 static int uart_check_rs485_flags(struct uart_port *port, struct serial_rs485 *rs485)
1306 u32 flags = rs485->flags;
1308 /* Don't return -EINVAL for unsupported legacy flags */
1309 flags &= ~SER_RS485_LEGACY_FLAGS;
1312 * For any bit outside of the legacy ones that is not supported by
1313 * the driver, return -EINVAL.
1315 if (flags & ~port->rs485_supported.flags)
1318 /* Asking for address w/o addressing mode? */
1319 if (!(rs485->flags & SER_RS485_ADDRB) &&
1320 (rs485->flags & (SER_RS485_ADDR_RECV|SER_RS485_ADDR_DEST)))
1323 /* Address given but not enabled? */
1324 if (!(rs485->flags & SER_RS485_ADDR_RECV) && rs485->addr_recv)
1326 if (!(rs485->flags & SER_RS485_ADDR_DEST) && rs485->addr_dest)
1332 static void uart_sanitize_serial_rs485_delays(struct uart_port *port,
1333 struct serial_rs485 *rs485)
1335 if (!port->rs485_supported.delay_rts_before_send) {
1336 if (rs485->delay_rts_before_send) {
1337 dev_warn_ratelimited(port->dev,
1338 "%s (%d): RTS delay before sending not supported\n",
1339 port->name, port->line);
1341 rs485->delay_rts_before_send = 0;
1342 } else if (rs485->delay_rts_before_send > RS485_MAX_RTS_DELAY) {
1343 rs485->delay_rts_before_send = RS485_MAX_RTS_DELAY;
1344 dev_warn_ratelimited(port->dev,
1345 "%s (%d): RTS delay before sending clamped to %u ms\n",
1346 port->name, port->line, rs485->delay_rts_before_send);
1349 if (!port->rs485_supported.delay_rts_after_send) {
1350 if (rs485->delay_rts_after_send) {
1351 dev_warn_ratelimited(port->dev,
1352 "%s (%d): RTS delay after sending not supported\n",
1353 port->name, port->line);
1355 rs485->delay_rts_after_send = 0;
1356 } else if (rs485->delay_rts_after_send > RS485_MAX_RTS_DELAY) {
1357 rs485->delay_rts_after_send = RS485_MAX_RTS_DELAY;
1358 dev_warn_ratelimited(port->dev,
1359 "%s (%d): RTS delay after sending clamped to %u ms\n",
1360 port->name, port->line, rs485->delay_rts_after_send);
1364 static void uart_sanitize_serial_rs485(struct uart_port *port, struct serial_rs485 *rs485)
1366 u32 supported_flags = port->rs485_supported.flags;
1368 if (!(rs485->flags & SER_RS485_ENABLED)) {
1369 memset(rs485, 0, sizeof(*rs485));
1373 /* Pick sane settings if the user hasn't */
1374 if ((supported_flags & (SER_RS485_RTS_ON_SEND|SER_RS485_RTS_AFTER_SEND)) &&
1375 !(rs485->flags & SER_RS485_RTS_ON_SEND) ==
1376 !(rs485->flags & SER_RS485_RTS_AFTER_SEND)) {
1377 dev_warn_ratelimited(port->dev,
1378 "%s (%d): invalid RTS setting, using RTS_ON_SEND instead\n",
1379 port->name, port->line);
1380 rs485->flags |= SER_RS485_RTS_ON_SEND;
1381 rs485->flags &= ~SER_RS485_RTS_AFTER_SEND;
1382 supported_flags |= SER_RS485_RTS_ON_SEND|SER_RS485_RTS_AFTER_SEND;
1385 rs485->flags &= supported_flags;
1387 uart_sanitize_serial_rs485_delays(port, rs485);
1389 /* Return clean padding area to userspace */
1390 memset(rs485->padding0, 0, sizeof(rs485->padding0));
1391 memset(rs485->padding1, 0, sizeof(rs485->padding1));
1394 static void uart_set_rs485_termination(struct uart_port *port,
1395 const struct serial_rs485 *rs485)
1397 if (!(rs485->flags & SER_RS485_ENABLED))
1400 gpiod_set_value_cansleep(port->rs485_term_gpio,
1401 !!(rs485->flags & SER_RS485_TERMINATE_BUS));
1404 static int uart_rs485_config(struct uart_port *port)
1406 struct serial_rs485 *rs485 = &port->rs485;
1407 unsigned long flags;
1410 if (!(rs485->flags & SER_RS485_ENABLED))
1413 uart_sanitize_serial_rs485(port, rs485);
1414 uart_set_rs485_termination(port, rs485);
1416 spin_lock_irqsave(&port->lock, flags);
1417 ret = port->rs485_config(port, NULL, rs485);
1418 spin_unlock_irqrestore(&port->lock, flags);
1420 memset(rs485, 0, sizeof(*rs485));
1425 static int uart_get_rs485_config(struct uart_port *port,
1426 struct serial_rs485 __user *rs485)
1428 unsigned long flags;
1429 struct serial_rs485 aux;
1431 spin_lock_irqsave(&port->lock, flags);
1433 spin_unlock_irqrestore(&port->lock, flags);
1435 if (copy_to_user(rs485, &aux, sizeof(aux)))
1441 static int uart_set_rs485_config(struct tty_struct *tty, struct uart_port *port,
1442 struct serial_rs485 __user *rs485_user)
1444 struct serial_rs485 rs485;
1446 unsigned long flags;
1448 if (!port->rs485_config)
1451 if (copy_from_user(&rs485, rs485_user, sizeof(*rs485_user)))
1454 ret = uart_check_rs485_flags(port, &rs485);
1457 uart_sanitize_serial_rs485(port, &rs485);
1458 uart_set_rs485_termination(port, &rs485);
1460 spin_lock_irqsave(&port->lock, flags);
1461 ret = port->rs485_config(port, &tty->termios, &rs485);
1463 port->rs485 = rs485;
1465 /* Reset RTS and other mctrl lines when disabling RS485 */
1466 if (!(rs485.flags & SER_RS485_ENABLED))
1467 port->ops->set_mctrl(port, port->mctrl);
1469 spin_unlock_irqrestore(&port->lock, flags);
1473 if (copy_to_user(rs485_user, &port->rs485, sizeof(port->rs485)))
1479 static int uart_get_iso7816_config(struct uart_port *port,
1480 struct serial_iso7816 __user *iso7816)
1482 unsigned long flags;
1483 struct serial_iso7816 aux;
1485 if (!port->iso7816_config)
1488 spin_lock_irqsave(&port->lock, flags);
1489 aux = port->iso7816;
1490 spin_unlock_irqrestore(&port->lock, flags);
1492 if (copy_to_user(iso7816, &aux, sizeof(aux)))
1498 static int uart_set_iso7816_config(struct uart_port *port,
1499 struct serial_iso7816 __user *iso7816_user)
1501 struct serial_iso7816 iso7816;
1503 unsigned long flags;
1505 if (!port->iso7816_config)
1508 if (copy_from_user(&iso7816, iso7816_user, sizeof(*iso7816_user)))
1512 * There are 5 words reserved for future use. Check that userspace
1513 * doesn't put stuff in there to prevent breakages in the future.
1515 for (i = 0; i < ARRAY_SIZE(iso7816.reserved); i++)
1516 if (iso7816.reserved[i])
1519 spin_lock_irqsave(&port->lock, flags);
1520 ret = port->iso7816_config(port, &iso7816);
1521 spin_unlock_irqrestore(&port->lock, flags);
1525 if (copy_to_user(iso7816_user, &port->iso7816, sizeof(port->iso7816)))
1532 * Called via sys_ioctl. We can use spin_lock_irq() here.
1535 uart_ioctl(struct tty_struct *tty, unsigned int cmd, unsigned long arg)
1537 struct uart_state *state = tty->driver_data;
1538 struct tty_port *port = &state->port;
1539 struct uart_port *uport;
1540 void __user *uarg = (void __user *)arg;
1541 int ret = -ENOIOCTLCMD;
1545 * These ioctls don't rely on the hardware to be present.
1549 down_write(&tty->termios_rwsem);
1550 ret = uart_do_autoconfig(tty, state);
1551 up_write(&tty->termios_rwsem);
1555 if (ret != -ENOIOCTLCMD)
1558 if (tty_io_error(tty)) {
1564 * The following should only be used when hardware is present.
1568 ret = uart_wait_modem_status(state, arg);
1572 if (ret != -ENOIOCTLCMD)
1575 /* rs485_config requires more locking than others */
1576 if (cmd == TIOCSRS485)
1577 down_write(&tty->termios_rwsem);
1579 mutex_lock(&port->mutex);
1580 uport = uart_port_check(state);
1582 if (!uport || tty_io_error(tty)) {
1588 * All these rely on hardware being present and need to be
1589 * protected against the tty being hung up.
1593 case TIOCSERGETLSR: /* Get line status register */
1594 ret = uart_get_lsr_info(tty, state, uarg);
1598 ret = uart_get_rs485_config(uport, uarg);
1602 ret = uart_set_rs485_config(tty, uport, uarg);
1606 ret = uart_set_iso7816_config(state->uart_port, uarg);
1610 ret = uart_get_iso7816_config(state->uart_port, uarg);
1613 if (uport->ops->ioctl)
1614 ret = uport->ops->ioctl(uport, cmd, arg);
1618 mutex_unlock(&port->mutex);
1619 if (cmd == TIOCSRS485)
1620 up_write(&tty->termios_rwsem);
1625 static void uart_set_ldisc(struct tty_struct *tty)
1627 struct uart_state *state = tty->driver_data;
1628 struct uart_port *uport;
1629 struct tty_port *port = &state->port;
1631 if (!tty_port_initialized(port))
1634 mutex_lock(&state->port.mutex);
1635 uport = uart_port_check(state);
1636 if (uport && uport->ops->set_ldisc)
1637 uport->ops->set_ldisc(uport, &tty->termios);
1638 mutex_unlock(&state->port.mutex);
1641 static void uart_set_termios(struct tty_struct *tty,
1642 const struct ktermios *old_termios)
1644 struct uart_state *state = tty->driver_data;
1645 struct uart_port *uport;
1646 unsigned int cflag = tty->termios.c_cflag;
1647 unsigned int iflag_mask = IGNBRK|BRKINT|IGNPAR|PARMRK|INPCK;
1648 bool sw_changed = false;
1650 mutex_lock(&state->port.mutex);
1651 uport = uart_port_check(state);
1656 * Drivers doing software flow control also need to know
1657 * about changes to these input settings.
1659 if (uport->flags & UPF_SOFT_FLOW) {
1660 iflag_mask |= IXANY|IXON|IXOFF;
1662 tty->termios.c_cc[VSTART] != old_termios->c_cc[VSTART] ||
1663 tty->termios.c_cc[VSTOP] != old_termios->c_cc[VSTOP];
1667 * These are the bits that are used to setup various
1668 * flags in the low level driver. We can ignore the Bfoo
1669 * bits in c_cflag; c_[io]speed will always be set
1670 * appropriately by set_termios() in tty_ioctl.c
1672 if ((cflag ^ old_termios->c_cflag) == 0 &&
1673 tty->termios.c_ospeed == old_termios->c_ospeed &&
1674 tty->termios.c_ispeed == old_termios->c_ispeed &&
1675 ((tty->termios.c_iflag ^ old_termios->c_iflag) & iflag_mask) == 0 &&
1680 uart_change_line_settings(tty, state, old_termios);
1681 /* reload cflag from termios; port driver may have overridden flags */
1682 cflag = tty->termios.c_cflag;
1684 /* Handle transition to B0 status */
1685 if (((old_termios->c_cflag & CBAUD) != B0) && ((cflag & CBAUD) == B0))
1686 uart_clear_mctrl(uport, TIOCM_RTS | TIOCM_DTR);
1687 /* Handle transition away from B0 status */
1688 else if (((old_termios->c_cflag & CBAUD) == B0) && ((cflag & CBAUD) != B0)) {
1689 unsigned int mask = TIOCM_DTR;
1691 if (!(cflag & CRTSCTS) || !tty_throttled(tty))
1693 uart_set_mctrl(uport, mask);
1696 mutex_unlock(&state->port.mutex);
1700 * Calls to uart_close() are serialised via the tty_lock in
1701 * drivers/tty/tty_io.c:tty_release()
1702 * drivers/tty/tty_io.c:do_tty_hangup()
1704 static void uart_close(struct tty_struct *tty, struct file *filp)
1706 struct uart_state *state = tty->driver_data;
1709 struct uart_driver *drv = tty->driver->driver_state;
1710 struct tty_port *port;
1712 state = drv->state + tty->index;
1713 port = &state->port;
1714 spin_lock_irq(&port->lock);
1716 spin_unlock_irq(&port->lock);
1720 pr_debug("uart_close(%d) called\n", tty->index);
1722 tty_port_close(tty->port, tty, filp);
1725 static void uart_tty_port_shutdown(struct tty_port *port)
1727 struct uart_state *state = container_of(port, struct uart_state, port);
1728 struct uart_port *uport = uart_port_check(state);
1732 * At this point, we stop accepting input. To do this, we
1733 * disable the receive line status interrupts.
1735 if (WARN(!uport, "detached port still initialized!\n"))
1738 spin_lock_irq(&uport->lock);
1739 uport->ops->stop_rx(uport);
1740 spin_unlock_irq(&uport->lock);
1742 uart_port_shutdown(port);
1745 * It's possible for shutdown to be called after suspend if we get
1746 * a DCD drop (hangup) at just the right time. Clear suspended bit so
1747 * we don't try to resume a port that has been shutdown.
1749 tty_port_set_suspended(port, false);
1752 * Free the transmit buffer.
1754 spin_lock_irq(&uport->lock);
1755 buf = state->xmit.buf;
1756 state->xmit.buf = NULL;
1757 spin_unlock_irq(&uport->lock);
1759 free_page((unsigned long)buf);
1761 uart_change_pm(state, UART_PM_STATE_OFF);
1764 static void uart_wait_until_sent(struct tty_struct *tty, int timeout)
1766 struct uart_state *state = tty->driver_data;
1767 struct uart_port *port;
1768 unsigned long char_time, expire, fifo_timeout;
1770 port = uart_port_ref(state);
1774 if (port->type == PORT_UNKNOWN || port->fifosize == 0) {
1775 uart_port_deref(port);
1780 * Set the check interval to be 1/5 of the estimated time to
1781 * send a single character, and make it at least 1. The check
1782 * interval should also be less than the timeout.
1784 * Note: we have to use pretty tight timings here to satisfy
1787 char_time = max(nsecs_to_jiffies(port->frame_time / 5), 1UL);
1789 if (timeout && timeout < char_time)
1790 char_time = timeout;
1792 if (!uart_cts_enabled(port)) {
1794 * If the transmitter hasn't cleared in twice the approximate
1795 * amount of time to send the entire FIFO, it probably won't
1796 * ever clear. This assumes the UART isn't doing flow
1797 * control, which is currently the case. Hence, if it ever
1798 * takes longer than FIFO timeout, this is probably due to a
1799 * UART bug of some kind. So, we clamp the timeout parameter at
1802 fifo_timeout = uart_fifo_timeout(port);
1803 if (timeout == 0 || timeout > 2 * fifo_timeout)
1804 timeout = 2 * fifo_timeout;
1807 expire = jiffies + timeout;
1809 pr_debug("uart_wait_until_sent(%d), jiffies=%lu, expire=%lu...\n",
1810 port->line, jiffies, expire);
1813 * Check whether the transmitter is empty every 'char_time'.
1814 * 'timeout' / 'expire' give us the maximum amount of time
1817 while (!port->ops->tx_empty(port)) {
1818 msleep_interruptible(jiffies_to_msecs(char_time));
1819 if (signal_pending(current))
1821 if (timeout && time_after(jiffies, expire))
1824 uart_port_deref(port);
1828 * Calls to uart_hangup() are serialised by the tty_lock in
1829 * drivers/tty/tty_io.c:do_tty_hangup()
1830 * This runs from a workqueue and can sleep for a _short_ time only.
1832 static void uart_hangup(struct tty_struct *tty)
1834 struct uart_state *state = tty->driver_data;
1835 struct tty_port *port = &state->port;
1836 struct uart_port *uport;
1837 unsigned long flags;
1839 pr_debug("uart_hangup(%d)\n", tty->index);
1841 mutex_lock(&port->mutex);
1842 uport = uart_port_check(state);
1843 WARN(!uport, "hangup of detached port!\n");
1845 if (tty_port_active(port)) {
1846 uart_flush_buffer(tty);
1847 uart_shutdown(tty, state);
1848 spin_lock_irqsave(&port->lock, flags);
1850 spin_unlock_irqrestore(&port->lock, flags);
1851 tty_port_set_active(port, false);
1852 tty_port_tty_set(port, NULL);
1853 if (uport && !uart_console(uport))
1854 uart_change_pm(state, UART_PM_STATE_OFF);
1855 wake_up_interruptible(&port->open_wait);
1856 wake_up_interruptible(&port->delta_msr_wait);
1858 mutex_unlock(&port->mutex);
1861 /* uport == NULL if uart_port has already been removed */
1862 static void uart_port_shutdown(struct tty_port *port)
1864 struct uart_state *state = container_of(port, struct uart_state, port);
1865 struct uart_port *uport = uart_port_check(state);
1868 * clear delta_msr_wait queue to avoid mem leaks: we may free
1869 * the irq here so the queue might never be woken up. Note
1870 * that we won't end up waiting on delta_msr_wait again since
1871 * any outstanding file descriptors should be pointing at
1872 * hung_up_tty_fops now.
1874 wake_up_interruptible(&port->delta_msr_wait);
1877 /* Free the IRQ and disable the port. */
1878 uport->ops->shutdown(uport);
1880 /* Ensure that the IRQ handler isn't running on another CPU. */
1881 synchronize_irq(uport->irq);
1885 static bool uart_carrier_raised(struct tty_port *port)
1887 struct uart_state *state = container_of(port, struct uart_state, port);
1888 struct uart_port *uport;
1891 uport = uart_port_ref(state);
1893 * Should never observe uport == NULL since checks for hangup should
1894 * abort the tty_port_block_til_ready() loop before checking for carrier
1895 * raised -- but report carrier raised if it does anyway so open will
1896 * continue and not sleep
1898 if (WARN_ON(!uport))
1900 spin_lock_irq(&uport->lock);
1901 uart_enable_ms(uport);
1902 mctrl = uport->ops->get_mctrl(uport);
1903 spin_unlock_irq(&uport->lock);
1904 uart_port_deref(uport);
1906 return mctrl & TIOCM_CAR;
1909 static void uart_dtr_rts(struct tty_port *port, bool active)
1911 struct uart_state *state = container_of(port, struct uart_state, port);
1912 struct uart_port *uport;
1914 uport = uart_port_ref(state);
1917 uart_port_dtr_rts(uport, active);
1918 uart_port_deref(uport);
1921 static int uart_install(struct tty_driver *driver, struct tty_struct *tty)
1923 struct uart_driver *drv = driver->driver_state;
1924 struct uart_state *state = drv->state + tty->index;
1926 tty->driver_data = state;
1928 return tty_standard_install(driver, tty);
1932 * Calls to uart_open are serialised by the tty_lock in
1933 * drivers/tty/tty_io.c:tty_open()
1934 * Note that if this fails, then uart_close() _will_ be called.
1936 * In time, we want to scrap the "opening nonpresent ports"
1937 * behaviour and implement an alternative way for setserial
1938 * to set base addresses/ports/types. This will allow us to
1939 * get rid of a certain amount of extra tests.
1941 static int uart_open(struct tty_struct *tty, struct file *filp)
1943 struct uart_state *state = tty->driver_data;
1946 retval = tty_port_open(&state->port, tty, filp);
1953 static int uart_port_activate(struct tty_port *port, struct tty_struct *tty)
1955 struct uart_state *state = container_of(port, struct uart_state, port);
1956 struct uart_port *uport;
1959 uport = uart_port_check(state);
1960 if (!uport || uport->flags & UPF_DEAD)
1964 * Start up the serial port.
1966 ret = uart_startup(tty, state, false);
1968 tty_port_set_active(port, true);
1973 static const char *uart_type(struct uart_port *port)
1975 const char *str = NULL;
1977 if (port->ops->type)
1978 str = port->ops->type(port);
1986 #ifdef CONFIG_PROC_FS
1988 static void uart_line_info(struct seq_file *m, struct uart_driver *drv, int i)
1990 struct uart_state *state = drv->state + i;
1991 struct tty_port *port = &state->port;
1992 enum uart_pm_state pm_state;
1993 struct uart_port *uport;
1995 unsigned int status;
1998 mutex_lock(&port->mutex);
1999 uport = uart_port_check(state);
2003 mmio = uport->iotype >= UPIO_MEM;
2004 seq_printf(m, "%d: uart:%s %s%08llX irq:%d",
2005 uport->line, uart_type(uport),
2006 mmio ? "mmio:0x" : "port:",
2007 mmio ? (unsigned long long)uport->mapbase
2008 : (unsigned long long)uport->iobase,
2011 if (uport->type == PORT_UNKNOWN) {
2016 if (capable(CAP_SYS_ADMIN)) {
2017 pm_state = state->pm_state;
2018 if (pm_state != UART_PM_STATE_ON)
2019 uart_change_pm(state, UART_PM_STATE_ON);
2020 spin_lock_irq(&uport->lock);
2021 status = uport->ops->get_mctrl(uport);
2022 spin_unlock_irq(&uport->lock);
2023 if (pm_state != UART_PM_STATE_ON)
2024 uart_change_pm(state, pm_state);
2026 seq_printf(m, " tx:%d rx:%d",
2027 uport->icount.tx, uport->icount.rx);
2028 if (uport->icount.frame)
2029 seq_printf(m, " fe:%d", uport->icount.frame);
2030 if (uport->icount.parity)
2031 seq_printf(m, " pe:%d", uport->icount.parity);
2032 if (uport->icount.brk)
2033 seq_printf(m, " brk:%d", uport->icount.brk);
2034 if (uport->icount.overrun)
2035 seq_printf(m, " oe:%d", uport->icount.overrun);
2036 if (uport->icount.buf_overrun)
2037 seq_printf(m, " bo:%d", uport->icount.buf_overrun);
2039 #define INFOBIT(bit, str) \
2040 if (uport->mctrl & (bit)) \
2041 strncat(stat_buf, (str), sizeof(stat_buf) - \
2042 strlen(stat_buf) - 2)
2043 #define STATBIT(bit, str) \
2044 if (status & (bit)) \
2045 strncat(stat_buf, (str), sizeof(stat_buf) - \
2046 strlen(stat_buf) - 2)
2050 INFOBIT(TIOCM_RTS, "|RTS");
2051 STATBIT(TIOCM_CTS, "|CTS");
2052 INFOBIT(TIOCM_DTR, "|DTR");
2053 STATBIT(TIOCM_DSR, "|DSR");
2054 STATBIT(TIOCM_CAR, "|CD");
2055 STATBIT(TIOCM_RNG, "|RI");
2059 seq_puts(m, stat_buf);
2065 mutex_unlock(&port->mutex);
2068 static int uart_proc_show(struct seq_file *m, void *v)
2070 struct tty_driver *ttydrv = m->private;
2071 struct uart_driver *drv = ttydrv->driver_state;
2074 seq_printf(m, "serinfo:1.0 driver%s%s revision:%s\n", "", "", "");
2075 for (i = 0; i < drv->nr; i++)
2076 uart_line_info(m, drv, i);
2081 static void uart_port_spin_lock_init(struct uart_port *port)
2083 spin_lock_init(&port->lock);
2084 lockdep_set_class(&port->lock, &port_lock_key);
2087 #if defined(CONFIG_SERIAL_CORE_CONSOLE) || defined(CONFIG_CONSOLE_POLL)
2089 * uart_console_write - write a console message to a serial port
2090 * @port: the port to write the message
2091 * @s: array of characters
2092 * @count: number of characters in string to write
2093 * @putchar: function to write character to port
2095 void uart_console_write(struct uart_port *port, const char *s,
2097 void (*putchar)(struct uart_port *, unsigned char))
2101 for (i = 0; i < count; i++, s++) {
2103 putchar(port, '\r');
2107 EXPORT_SYMBOL_GPL(uart_console_write);
2110 * uart_get_console - get uart port for console
2111 * @ports: ports to search in
2112 * @nr: number of @ports
2113 * @co: console to search for
2114 * Returns: uart_port for the console @co
2116 * Check whether an invalid uart number has been specified (as @co->index), and
2117 * if so, search for the first available port that does have console support.
2119 struct uart_port * __init
2120 uart_get_console(struct uart_port *ports, int nr, struct console *co)
2122 int idx = co->index;
2124 if (idx < 0 || idx >= nr || (ports[idx].iobase == 0 &&
2125 ports[idx].membase == NULL))
2126 for (idx = 0; idx < nr; idx++)
2127 if (ports[idx].iobase != 0 ||
2128 ports[idx].membase != NULL)
2137 * uart_parse_earlycon - Parse earlycon options
2138 * @p: ptr to 2nd field (ie., just beyond '<name>,')
2139 * @iotype: ptr for decoded iotype (out)
2140 * @addr: ptr for decoded mapbase/iobase (out)
2141 * @options: ptr for <options> field; %NULL if not present (out)
2143 * Decodes earlycon kernel command line parameters of the form:
2144 * * earlycon=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
2145 * * console=<name>,io|mmio|mmio16|mmio32|mmio32be|mmio32native,<addr>,<options>
2147 * The optional form:
2148 * * earlycon=<name>,0x<addr>,<options>
2149 * * console=<name>,0x<addr>,<options>
2151 * is also accepted; the returned @iotype will be %UPIO_MEM.
2153 * Returns: 0 on success or -%EINVAL on failure
2155 int uart_parse_earlycon(char *p, unsigned char *iotype, resource_size_t *addr,
2158 if (strncmp(p, "mmio,", 5) == 0) {
2161 } else if (strncmp(p, "mmio16,", 7) == 0) {
2162 *iotype = UPIO_MEM16;
2164 } else if (strncmp(p, "mmio32,", 7) == 0) {
2165 *iotype = UPIO_MEM32;
2167 } else if (strncmp(p, "mmio32be,", 9) == 0) {
2168 *iotype = UPIO_MEM32BE;
2170 } else if (strncmp(p, "mmio32native,", 13) == 0) {
2171 *iotype = IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) ?
2172 UPIO_MEM32BE : UPIO_MEM32;
2174 } else if (strncmp(p, "io,", 3) == 0) {
2175 *iotype = UPIO_PORT;
2177 } else if (strncmp(p, "0x", 2) == 0) {
2184 * Before you replace it with kstrtoull(), think about options separator
2185 * (',') it will not tolerate
2187 *addr = simple_strtoull(p, NULL, 0);
2195 EXPORT_SYMBOL_GPL(uart_parse_earlycon);
2198 * uart_parse_options - Parse serial port baud/parity/bits/flow control.
2199 * @options: pointer to option string
2200 * @baud: pointer to an 'int' variable for the baud rate.
2201 * @parity: pointer to an 'int' variable for the parity.
2202 * @bits: pointer to an 'int' variable for the number of data bits.
2203 * @flow: pointer to an 'int' variable for the flow control character.
2205 * uart_parse_options() decodes a string containing the serial console
2206 * options. The format of the string is <baud><parity><bits><flow>,
2210 uart_parse_options(const char *options, int *baud, int *parity,
2211 int *bits, int *flow)
2213 const char *s = options;
2215 *baud = simple_strtoul(s, NULL, 10);
2216 while (*s >= '0' && *s <= '9')
2225 EXPORT_SYMBOL_GPL(uart_parse_options);
2228 * uart_set_options - setup the serial console parameters
2229 * @port: pointer to the serial ports uart_port structure
2230 * @co: console pointer
2232 * @parity: parity character - 'n' (none), 'o' (odd), 'e' (even)
2233 * @bits: number of data bits
2234 * @flow: flow control character - 'r' (rts)
2236 * Locking: Caller must hold console_list_lock in order to serialize
2237 * early initialization of the serial-console lock.
2240 uart_set_options(struct uart_port *port, struct console *co,
2241 int baud, int parity, int bits, int flow)
2243 struct ktermios termios;
2244 static struct ktermios dummy;
2247 * Ensure that the serial-console lock is initialised early.
2249 * Note that the console-registered check is needed because
2250 * kgdboc can call uart_set_options() for an already registered
2251 * console via tty_find_polling_driver() and uart_poll_init().
2253 if (!uart_console_registered_locked(port) && !port->console_reinit)
2254 uart_port_spin_lock_init(port);
2256 memset(&termios, 0, sizeof(struct ktermios));
2258 termios.c_cflag |= CREAD | HUPCL | CLOCAL;
2259 tty_termios_encode_baud_rate(&termios, baud, baud);
2262 termios.c_cflag |= CS7;
2264 termios.c_cflag |= CS8;
2268 termios.c_cflag |= PARODD;
2271 termios.c_cflag |= PARENB;
2276 termios.c_cflag |= CRTSCTS;
2279 * some uarts on other side don't support no flow control.
2280 * So we set * DTR in host uart to make them happy
2282 port->mctrl |= TIOCM_DTR;
2284 port->ops->set_termios(port, &termios, &dummy);
2286 * Allow the setting of the UART parameters with a NULL console
2290 co->cflag = termios.c_cflag;
2291 co->ispeed = termios.c_ispeed;
2292 co->ospeed = termios.c_ospeed;
2297 EXPORT_SYMBOL_GPL(uart_set_options);
2298 #endif /* CONFIG_SERIAL_CORE_CONSOLE */
2301 * uart_change_pm - set power state of the port
2303 * @state: port descriptor
2304 * @pm_state: new state
2306 * Locking: port->mutex has to be held
2308 static void uart_change_pm(struct uart_state *state,
2309 enum uart_pm_state pm_state)
2311 struct uart_port *port = uart_port_check(state);
2313 if (state->pm_state != pm_state) {
2314 if (port && port->ops->pm)
2315 port->ops->pm(port, pm_state, state->pm_state);
2316 state->pm_state = pm_state;
2321 struct uart_port *port;
2322 struct uart_driver *driver;
2325 static int serial_match_port(struct device *dev, void *data)
2327 struct uart_match *match = data;
2328 struct tty_driver *tty_drv = match->driver->tty_driver;
2329 dev_t devt = MKDEV(tty_drv->major, tty_drv->minor_start) +
2332 return dev->devt == devt; /* Actually, only one tty per port */
2335 int uart_suspend_port(struct uart_driver *drv, struct uart_port *uport)
2337 struct uart_state *state = drv->state + uport->line;
2338 struct tty_port *port = &state->port;
2339 struct device *tty_dev;
2340 struct uart_match match = {uport, drv};
2342 mutex_lock(&port->mutex);
2344 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2345 if (tty_dev && device_may_wakeup(tty_dev)) {
2346 enable_irq_wake(uport->irq);
2347 put_device(tty_dev);
2348 mutex_unlock(&port->mutex);
2351 put_device(tty_dev);
2354 * Nothing to do if the console is not suspending
2355 * except stop_rx to prevent any asynchronous data
2356 * over RX line. However ensure that we will be
2357 * able to Re-start_rx later.
2359 if (!console_suspend_enabled && uart_console(uport)) {
2360 if (uport->ops->start_rx) {
2361 spin_lock_irq(&uport->lock);
2362 uport->ops->stop_rx(uport);
2363 spin_unlock_irq(&uport->lock);
2368 uport->suspended = 1;
2370 if (tty_port_initialized(port)) {
2371 const struct uart_ops *ops = uport->ops;
2375 tty_port_set_suspended(port, true);
2376 tty_port_set_initialized(port, false);
2378 spin_lock_irq(&uport->lock);
2379 ops->stop_tx(uport);
2380 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2381 ops->set_mctrl(uport, 0);
2382 /* save mctrl so it can be restored on resume */
2383 mctrl = uport->mctrl;
2385 ops->stop_rx(uport);
2386 spin_unlock_irq(&uport->lock);
2389 * Wait for the transmitter to empty.
2391 for (tries = 3; !ops->tx_empty(uport) && tries; tries--)
2394 dev_err(uport->dev, "%s: Unable to drain transmitter\n",
2397 ops->shutdown(uport);
2398 uport->mctrl = mctrl;
2402 * Disable the console device before suspending.
2404 if (uart_console(uport))
2405 console_stop(uport->cons);
2407 uart_change_pm(state, UART_PM_STATE_OFF);
2409 mutex_unlock(&port->mutex);
2413 EXPORT_SYMBOL(uart_suspend_port);
2415 int uart_resume_port(struct uart_driver *drv, struct uart_port *uport)
2417 struct uart_state *state = drv->state + uport->line;
2418 struct tty_port *port = &state->port;
2419 struct device *tty_dev;
2420 struct uart_match match = {uport, drv};
2421 struct ktermios termios;
2423 mutex_lock(&port->mutex);
2425 tty_dev = device_find_child(uport->dev, &match, serial_match_port);
2426 if (!uport->suspended && device_may_wakeup(tty_dev)) {
2427 if (irqd_is_wakeup_set(irq_get_irq_data((uport->irq))))
2428 disable_irq_wake(uport->irq);
2429 put_device(tty_dev);
2430 mutex_unlock(&port->mutex);
2433 put_device(tty_dev);
2434 uport->suspended = 0;
2437 * Re-enable the console device after suspending.
2439 if (uart_console(uport)) {
2441 * First try to use the console cflag setting.
2443 memset(&termios, 0, sizeof(struct ktermios));
2444 termios.c_cflag = uport->cons->cflag;
2445 termios.c_ispeed = uport->cons->ispeed;
2446 termios.c_ospeed = uport->cons->ospeed;
2449 * If that's unset, use the tty termios setting.
2451 if (port->tty && termios.c_cflag == 0)
2452 termios = port->tty->termios;
2454 if (console_suspend_enabled)
2455 uart_change_pm(state, UART_PM_STATE_ON);
2456 uport->ops->set_termios(uport, &termios, NULL);
2457 if (!console_suspend_enabled && uport->ops->start_rx) {
2458 spin_lock_irq(&uport->lock);
2459 uport->ops->start_rx(uport);
2460 spin_unlock_irq(&uport->lock);
2462 if (console_suspend_enabled)
2463 console_start(uport->cons);
2466 if (tty_port_suspended(port)) {
2467 const struct uart_ops *ops = uport->ops;
2470 uart_change_pm(state, UART_PM_STATE_ON);
2471 spin_lock_irq(&uport->lock);
2472 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2473 ops->set_mctrl(uport, 0);
2474 spin_unlock_irq(&uport->lock);
2475 if (console_suspend_enabled || !uart_console(uport)) {
2476 /* Protected by port mutex for now */
2477 struct tty_struct *tty = port->tty;
2479 ret = ops->startup(uport);
2482 uart_change_line_settings(tty, state, NULL);
2483 uart_rs485_config(uport);
2484 spin_lock_irq(&uport->lock);
2485 if (!(uport->rs485.flags & SER_RS485_ENABLED))
2486 ops->set_mctrl(uport, uport->mctrl);
2487 ops->start_tx(uport);
2488 spin_unlock_irq(&uport->lock);
2489 tty_port_set_initialized(port, true);
2492 * Failed to resume - maybe hardware went away?
2493 * Clear the "initialized" flag so we won't try
2494 * to call the low level drivers shutdown method.
2496 uart_shutdown(tty, state);
2500 tty_port_set_suspended(port, false);
2503 mutex_unlock(&port->mutex);
2507 EXPORT_SYMBOL(uart_resume_port);
2510 uart_report_port(struct uart_driver *drv, struct uart_port *port)
2514 switch (port->iotype) {
2516 snprintf(address, sizeof(address), "I/O 0x%lx", port->iobase);
2519 snprintf(address, sizeof(address),
2520 "I/O 0x%lx offset 0x%x", port->iobase, port->hub6);
2528 snprintf(address, sizeof(address),
2529 "MMIO 0x%llx", (unsigned long long)port->mapbase);
2532 strscpy(address, "*unknown*", sizeof(address));
2536 pr_info("%s%s%s at %s (irq = %d, base_baud = %d) is a %s\n",
2537 port->dev ? dev_name(port->dev) : "",
2538 port->dev ? ": " : "",
2540 address, port->irq, port->uartclk / 16, uart_type(port));
2542 /* The magic multiplier feature is a bit obscure, so report it too. */
2543 if (port->flags & UPF_MAGIC_MULTIPLIER)
2544 pr_info("%s%s%s extra baud rates supported: %d, %d",
2545 port->dev ? dev_name(port->dev) : "",
2546 port->dev ? ": " : "",
2548 port->uartclk / 8, port->uartclk / 4);
2552 uart_configure_port(struct uart_driver *drv, struct uart_state *state,
2553 struct uart_port *port)
2558 * If there isn't a port here, don't do anything further.
2560 if (!port->iobase && !port->mapbase && !port->membase)
2564 * Now do the auto configuration stuff. Note that config_port
2565 * is expected to claim the resources and map the port for us.
2568 if (port->flags & UPF_AUTO_IRQ)
2569 flags |= UART_CONFIG_IRQ;
2570 if (port->flags & UPF_BOOT_AUTOCONF) {
2571 if (!(port->flags & UPF_FIXED_TYPE)) {
2572 port->type = PORT_UNKNOWN;
2573 flags |= UART_CONFIG_TYPE;
2575 port->ops->config_port(port, flags);
2578 if (port->type != PORT_UNKNOWN) {
2579 unsigned long flags;
2581 uart_report_port(drv, port);
2583 /* Power up port for set_mctrl() */
2584 uart_change_pm(state, UART_PM_STATE_ON);
2587 * Ensure that the modem control lines are de-activated.
2588 * keep the DTR setting that is set in uart_set_options()
2589 * We probably don't need a spinlock around this, but
2591 spin_lock_irqsave(&port->lock, flags);
2592 port->mctrl &= TIOCM_DTR;
2593 if (!(port->rs485.flags & SER_RS485_ENABLED))
2594 port->ops->set_mctrl(port, port->mctrl);
2595 spin_unlock_irqrestore(&port->lock, flags);
2597 uart_rs485_config(port);
2600 * If this driver supports console, and it hasn't been
2601 * successfully registered yet, try to re-register it.
2602 * It may be that the port was not available.
2604 if (port->cons && !console_is_registered(port->cons))
2605 register_console(port->cons);
2608 * Power down all ports by default, except the
2609 * console if we have one.
2611 if (!uart_console(port))
2612 uart_change_pm(state, UART_PM_STATE_OFF);
2616 #ifdef CONFIG_CONSOLE_POLL
2618 static int uart_poll_init(struct tty_driver *driver, int line, char *options)
2620 struct uart_driver *drv = driver->driver_state;
2621 struct uart_state *state = drv->state + line;
2622 enum uart_pm_state pm_state;
2623 struct tty_port *tport;
2624 struct uart_port *port;
2631 tport = &state->port;
2632 mutex_lock(&tport->mutex);
2634 port = uart_port_check(state);
2635 if (!port || !(port->ops->poll_get_char && port->ops->poll_put_char)) {
2640 pm_state = state->pm_state;
2641 uart_change_pm(state, UART_PM_STATE_ON);
2643 if (port->ops->poll_init) {
2645 * We don't set initialized as we only initialized the hw,
2646 * e.g. state->xmit is still uninitialized.
2648 if (!tty_port_initialized(tport))
2649 ret = port->ops->poll_init(port);
2652 if (!ret && options) {
2653 uart_parse_options(options, &baud, &parity, &bits, &flow);
2654 console_list_lock();
2655 ret = uart_set_options(port, NULL, baud, parity, bits, flow);
2656 console_list_unlock();
2660 uart_change_pm(state, pm_state);
2661 mutex_unlock(&tport->mutex);
2665 static int uart_poll_get_char(struct tty_driver *driver, int line)
2667 struct uart_driver *drv = driver->driver_state;
2668 struct uart_state *state = drv->state + line;
2669 struct uart_port *port;
2672 port = uart_port_ref(state);
2674 ret = port->ops->poll_get_char(port);
2675 uart_port_deref(port);
2681 static void uart_poll_put_char(struct tty_driver *driver, int line, char ch)
2683 struct uart_driver *drv = driver->driver_state;
2684 struct uart_state *state = drv->state + line;
2685 struct uart_port *port;
2687 port = uart_port_ref(state);
2692 port->ops->poll_put_char(port, '\r');
2693 port->ops->poll_put_char(port, ch);
2694 uart_port_deref(port);
2698 static const struct tty_operations uart_ops = {
2699 .install = uart_install,
2701 .close = uart_close,
2702 .write = uart_write,
2703 .put_char = uart_put_char,
2704 .flush_chars = uart_flush_chars,
2705 .write_room = uart_write_room,
2706 .chars_in_buffer= uart_chars_in_buffer,
2707 .flush_buffer = uart_flush_buffer,
2708 .ioctl = uart_ioctl,
2709 .throttle = uart_throttle,
2710 .unthrottle = uart_unthrottle,
2711 .send_xchar = uart_send_xchar,
2712 .set_termios = uart_set_termios,
2713 .set_ldisc = uart_set_ldisc,
2715 .start = uart_start,
2716 .hangup = uart_hangup,
2717 .break_ctl = uart_break_ctl,
2718 .wait_until_sent= uart_wait_until_sent,
2719 #ifdef CONFIG_PROC_FS
2720 .proc_show = uart_proc_show,
2722 .tiocmget = uart_tiocmget,
2723 .tiocmset = uart_tiocmset,
2724 .set_serial = uart_set_info_user,
2725 .get_serial = uart_get_info_user,
2726 .get_icount = uart_get_icount,
2727 #ifdef CONFIG_CONSOLE_POLL
2728 .poll_init = uart_poll_init,
2729 .poll_get_char = uart_poll_get_char,
2730 .poll_put_char = uart_poll_put_char,
2734 static const struct tty_port_operations uart_port_ops = {
2735 .carrier_raised = uart_carrier_raised,
2736 .dtr_rts = uart_dtr_rts,
2737 .activate = uart_port_activate,
2738 .shutdown = uart_tty_port_shutdown,
2742 * uart_register_driver - register a driver with the uart core layer
2743 * @drv: low level driver structure
2745 * Register a uart driver with the core driver. We in turn register with the
2746 * tty layer, and initialise the core driver per-port state.
2748 * We have a proc file in /proc/tty/driver which is named after the normal
2751 * @drv->port should be %NULL, and the per-port structures should be registered
2752 * using uart_add_one_port() after this call has succeeded.
2754 * Locking: none, Interrupts: enabled
2756 int uart_register_driver(struct uart_driver *drv)
2758 struct tty_driver *normal;
2759 int i, retval = -ENOMEM;
2764 * Maybe we should be using a slab cache for this, especially if
2765 * we have a large number of ports to handle.
2767 drv->state = kcalloc(drv->nr, sizeof(struct uart_state), GFP_KERNEL);
2771 normal = tty_alloc_driver(drv->nr, TTY_DRIVER_REAL_RAW |
2772 TTY_DRIVER_DYNAMIC_DEV);
2773 if (IS_ERR(normal)) {
2774 retval = PTR_ERR(normal);
2778 drv->tty_driver = normal;
2780 normal->driver_name = drv->driver_name;
2781 normal->name = drv->dev_name;
2782 normal->major = drv->major;
2783 normal->minor_start = drv->minor;
2784 normal->type = TTY_DRIVER_TYPE_SERIAL;
2785 normal->subtype = SERIAL_TYPE_NORMAL;
2786 normal->init_termios = tty_std_termios;
2787 normal->init_termios.c_cflag = B9600 | CS8 | CREAD | HUPCL | CLOCAL;
2788 normal->init_termios.c_ispeed = normal->init_termios.c_ospeed = 9600;
2789 normal->driver_state = drv;
2790 tty_set_operations(normal, &uart_ops);
2793 * Initialise the UART state(s).
2795 for (i = 0; i < drv->nr; i++) {
2796 struct uart_state *state = drv->state + i;
2797 struct tty_port *port = &state->port;
2799 tty_port_init(port);
2800 port->ops = &uart_port_ops;
2803 retval = tty_register_driver(normal);
2807 for (i = 0; i < drv->nr; i++)
2808 tty_port_destroy(&drv->state[i].port);
2809 tty_driver_kref_put(normal);
2815 EXPORT_SYMBOL(uart_register_driver);
2818 * uart_unregister_driver - remove a driver from the uart core layer
2819 * @drv: low level driver structure
2821 * Remove all references to a driver from the core driver. The low level
2822 * driver must have removed all its ports via the uart_remove_one_port() if it
2823 * registered them with uart_add_one_port(). (I.e. @drv->port is %NULL.)
2825 * Locking: none, Interrupts: enabled
2827 void uart_unregister_driver(struct uart_driver *drv)
2829 struct tty_driver *p = drv->tty_driver;
2832 tty_unregister_driver(p);
2833 tty_driver_kref_put(p);
2834 for (i = 0; i < drv->nr; i++)
2835 tty_port_destroy(&drv->state[i].port);
2838 drv->tty_driver = NULL;
2840 EXPORT_SYMBOL(uart_unregister_driver);
2842 struct tty_driver *uart_console_device(struct console *co, int *index)
2844 struct uart_driver *p = co->data;
2846 return p->tty_driver;
2848 EXPORT_SYMBOL_GPL(uart_console_device);
2850 static ssize_t uartclk_show(struct device *dev,
2851 struct device_attribute *attr, char *buf)
2853 struct serial_struct tmp;
2854 struct tty_port *port = dev_get_drvdata(dev);
2856 uart_get_info(port, &tmp);
2857 return sprintf(buf, "%d\n", tmp.baud_base * 16);
2860 static ssize_t type_show(struct device *dev,
2861 struct device_attribute *attr, char *buf)
2863 struct serial_struct tmp;
2864 struct tty_port *port = dev_get_drvdata(dev);
2866 uart_get_info(port, &tmp);
2867 return sprintf(buf, "%d\n", tmp.type);
2870 static ssize_t line_show(struct device *dev,
2871 struct device_attribute *attr, char *buf)
2873 struct serial_struct tmp;
2874 struct tty_port *port = dev_get_drvdata(dev);
2876 uart_get_info(port, &tmp);
2877 return sprintf(buf, "%d\n", tmp.line);
2880 static ssize_t port_show(struct device *dev,
2881 struct device_attribute *attr, char *buf)
2883 struct serial_struct tmp;
2884 struct tty_port *port = dev_get_drvdata(dev);
2885 unsigned long ioaddr;
2887 uart_get_info(port, &tmp);
2889 if (HIGH_BITS_OFFSET)
2890 ioaddr |= (unsigned long)tmp.port_high << HIGH_BITS_OFFSET;
2891 return sprintf(buf, "0x%lX\n", ioaddr);
2894 static ssize_t irq_show(struct device *dev,
2895 struct device_attribute *attr, char *buf)
2897 struct serial_struct tmp;
2898 struct tty_port *port = dev_get_drvdata(dev);
2900 uart_get_info(port, &tmp);
2901 return sprintf(buf, "%d\n", tmp.irq);
2904 static ssize_t flags_show(struct device *dev,
2905 struct device_attribute *attr, char *buf)
2907 struct serial_struct tmp;
2908 struct tty_port *port = dev_get_drvdata(dev);
2910 uart_get_info(port, &tmp);
2911 return sprintf(buf, "0x%X\n", tmp.flags);
2914 static ssize_t xmit_fifo_size_show(struct device *dev,
2915 struct device_attribute *attr, char *buf)
2917 struct serial_struct tmp;
2918 struct tty_port *port = dev_get_drvdata(dev);
2920 uart_get_info(port, &tmp);
2921 return sprintf(buf, "%d\n", tmp.xmit_fifo_size);
2924 static ssize_t close_delay_show(struct device *dev,
2925 struct device_attribute *attr, char *buf)
2927 struct serial_struct tmp;
2928 struct tty_port *port = dev_get_drvdata(dev);
2930 uart_get_info(port, &tmp);
2931 return sprintf(buf, "%d\n", tmp.close_delay);
2934 static ssize_t closing_wait_show(struct device *dev,
2935 struct device_attribute *attr, char *buf)
2937 struct serial_struct tmp;
2938 struct tty_port *port = dev_get_drvdata(dev);
2940 uart_get_info(port, &tmp);
2941 return sprintf(buf, "%d\n", tmp.closing_wait);
2944 static ssize_t custom_divisor_show(struct device *dev,
2945 struct device_attribute *attr, char *buf)
2947 struct serial_struct tmp;
2948 struct tty_port *port = dev_get_drvdata(dev);
2950 uart_get_info(port, &tmp);
2951 return sprintf(buf, "%d\n", tmp.custom_divisor);
2954 static ssize_t io_type_show(struct device *dev,
2955 struct device_attribute *attr, char *buf)
2957 struct serial_struct tmp;
2958 struct tty_port *port = dev_get_drvdata(dev);
2960 uart_get_info(port, &tmp);
2961 return sprintf(buf, "%d\n", tmp.io_type);
2964 static ssize_t iomem_base_show(struct device *dev,
2965 struct device_attribute *attr, char *buf)
2967 struct serial_struct tmp;
2968 struct tty_port *port = dev_get_drvdata(dev);
2970 uart_get_info(port, &tmp);
2971 return sprintf(buf, "0x%lX\n", (unsigned long)tmp.iomem_base);
2974 static ssize_t iomem_reg_shift_show(struct device *dev,
2975 struct device_attribute *attr, char *buf)
2977 struct serial_struct tmp;
2978 struct tty_port *port = dev_get_drvdata(dev);
2980 uart_get_info(port, &tmp);
2981 return sprintf(buf, "%d\n", tmp.iomem_reg_shift);
2984 static ssize_t console_show(struct device *dev,
2985 struct device_attribute *attr, char *buf)
2987 struct tty_port *port = dev_get_drvdata(dev);
2988 struct uart_state *state = container_of(port, struct uart_state, port);
2989 struct uart_port *uport;
2990 bool console = false;
2992 mutex_lock(&port->mutex);
2993 uport = uart_port_check(state);
2995 console = uart_console_registered(uport);
2996 mutex_unlock(&port->mutex);
2998 return sprintf(buf, "%c\n", console ? 'Y' : 'N');
3001 static ssize_t console_store(struct device *dev,
3002 struct device_attribute *attr, const char *buf, size_t count)
3004 struct tty_port *port = dev_get_drvdata(dev);
3005 struct uart_state *state = container_of(port, struct uart_state, port);
3006 struct uart_port *uport;
3007 bool oldconsole, newconsole;
3010 ret = kstrtobool(buf, &newconsole);
3014 mutex_lock(&port->mutex);
3015 uport = uart_port_check(state);
3017 oldconsole = uart_console_registered(uport);
3018 if (oldconsole && !newconsole) {
3019 ret = unregister_console(uport->cons);
3020 } else if (!oldconsole && newconsole) {
3021 if (uart_console(uport)) {
3022 uport->console_reinit = 1;
3023 register_console(uport->cons);
3031 mutex_unlock(&port->mutex);
3033 return ret < 0 ? ret : count;
3036 static DEVICE_ATTR_RO(uartclk);
3037 static DEVICE_ATTR_RO(type);
3038 static DEVICE_ATTR_RO(line);
3039 static DEVICE_ATTR_RO(port);
3040 static DEVICE_ATTR_RO(irq);
3041 static DEVICE_ATTR_RO(flags);
3042 static DEVICE_ATTR_RO(xmit_fifo_size);
3043 static DEVICE_ATTR_RO(close_delay);
3044 static DEVICE_ATTR_RO(closing_wait);
3045 static DEVICE_ATTR_RO(custom_divisor);
3046 static DEVICE_ATTR_RO(io_type);
3047 static DEVICE_ATTR_RO(iomem_base);
3048 static DEVICE_ATTR_RO(iomem_reg_shift);
3049 static DEVICE_ATTR_RW(console);
3051 static struct attribute *tty_dev_attrs[] = {
3052 &dev_attr_uartclk.attr,
3053 &dev_attr_type.attr,
3054 &dev_attr_line.attr,
3055 &dev_attr_port.attr,
3057 &dev_attr_flags.attr,
3058 &dev_attr_xmit_fifo_size.attr,
3059 &dev_attr_close_delay.attr,
3060 &dev_attr_closing_wait.attr,
3061 &dev_attr_custom_divisor.attr,
3062 &dev_attr_io_type.attr,
3063 &dev_attr_iomem_base.attr,
3064 &dev_attr_iomem_reg_shift.attr,
3065 &dev_attr_console.attr,
3069 static const struct attribute_group tty_dev_attr_group = {
3070 .attrs = tty_dev_attrs,
3074 * serial_core_add_one_port - attach a driver-defined port structure
3075 * @drv: pointer to the uart low level driver structure for this port
3076 * @uport: uart port structure to use for this port.
3078 * Context: task context, might sleep
3080 * This allows the driver @drv to register its own uart_port structure with the
3081 * core driver. The main purpose is to allow the low level uart drivers to
3082 * expand uart_port, rather than having yet more levels of structures.
3083 * Caller must hold port_mutex.
3085 static int serial_core_add_one_port(struct uart_driver *drv, struct uart_port *uport)
3087 struct uart_state *state;
3088 struct tty_port *port;
3090 struct device *tty_dev;
3093 if (uport->line >= drv->nr)
3096 state = drv->state + uport->line;
3097 port = &state->port;
3099 mutex_lock(&port->mutex);
3100 if (state->uart_port) {
3105 /* Link the port to the driver state table and vice versa */
3106 atomic_set(&state->refcount, 1);
3107 init_waitqueue_head(&state->remove_wait);
3108 state->uart_port = uport;
3109 uport->state = state;
3111 state->pm_state = UART_PM_STATE_UNDEFINED;
3112 uport->cons = drv->cons;
3113 uport->minor = drv->tty_driver->minor_start + uport->line;
3114 uport->name = kasprintf(GFP_KERNEL, "%s%d", drv->dev_name,
3115 drv->tty_driver->name_base + uport->line);
3122 * If this port is in use as a console then the spinlock is already
3125 if (!uart_console_registered(uport))
3126 uart_port_spin_lock_init(uport);
3128 if (uport->cons && uport->dev)
3129 of_console_check(uport->dev->of_node, uport->cons->name, uport->line);
3131 tty_port_link_device(port, drv->tty_driver, uport->line);
3132 uart_configure_port(drv, state, uport);
3134 port->console = uart_console(uport);
3137 if (uport->attr_group)
3140 uport->tty_groups = kcalloc(num_groups, sizeof(*uport->tty_groups),
3142 if (!uport->tty_groups) {
3146 uport->tty_groups[0] = &tty_dev_attr_group;
3147 if (uport->attr_group)
3148 uport->tty_groups[1] = uport->attr_group;
3151 * Register the port whether it's detected or not. This allows
3152 * setserial to be used to alter this port's parameters.
3154 tty_dev = tty_port_register_device_attr_serdev(port, drv->tty_driver,
3155 uport->line, uport->dev, port, uport->tty_groups);
3156 if (!IS_ERR(tty_dev)) {
3157 device_set_wakeup_capable(tty_dev, 1);
3159 dev_err(uport->dev, "Cannot register tty device on line %d\n",
3164 mutex_unlock(&port->mutex);
3170 * serial_core_remove_one_port - detach a driver defined port structure
3171 * @drv: pointer to the uart low level driver structure for this port
3172 * @uport: uart port structure for this port
3174 * Context: task context, might sleep
3176 * This unhooks (and hangs up) the specified port structure from the core
3177 * driver. No further calls will be made to the low-level code for this port.
3178 * Caller must hold port_mutex.
3180 static void serial_core_remove_one_port(struct uart_driver *drv,
3181 struct uart_port *uport)
3183 struct uart_state *state = drv->state + uport->line;
3184 struct tty_port *port = &state->port;
3185 struct uart_port *uart_port;
3186 struct tty_struct *tty;
3188 mutex_lock(&port->mutex);
3189 uart_port = uart_port_check(state);
3190 if (uart_port != uport)
3191 dev_alert(uport->dev, "Removing wrong port: %p != %p\n",
3195 mutex_unlock(&port->mutex);
3198 mutex_unlock(&port->mutex);
3201 * Remove the devices from the tty layer
3203 tty_port_unregister_device(port, drv->tty_driver, uport->line);
3205 tty = tty_port_tty_get(port);
3207 tty_vhangup(port->tty);
3212 * If the port is used as a console, unregister it
3214 if (uart_console(uport))
3215 unregister_console(uport->cons);
3218 * Free the port IO and memory resources, if any.
3220 if (uport->type != PORT_UNKNOWN && uport->ops->release_port)
3221 uport->ops->release_port(uport);
3222 kfree(uport->tty_groups);
3226 * Indicate that there isn't a port here anymore.
3228 uport->type = PORT_UNKNOWN;
3229 uport->port_dev = NULL;
3231 mutex_lock(&port->mutex);
3232 WARN_ON(atomic_dec_return(&state->refcount) < 0);
3233 wait_event(state->remove_wait, !atomic_read(&state->refcount));
3234 state->uart_port = NULL;
3235 mutex_unlock(&port->mutex);
3239 * uart_match_port - are the two ports equivalent?
3240 * @port1: first port
3241 * @port2: second port
3243 * This utility function can be used to determine whether two uart_port
3244 * structures describe the same port.
3246 bool uart_match_port(const struct uart_port *port1,
3247 const struct uart_port *port2)
3249 if (port1->iotype != port2->iotype)
3252 switch (port1->iotype) {
3254 return port1->iobase == port2->iobase;
3256 return port1->iobase == port2->iobase &&
3257 port1->hub6 == port2->hub6;
3264 return port1->mapbase == port2->mapbase;
3269 EXPORT_SYMBOL(uart_match_port);
3271 static struct serial_ctrl_device *
3272 serial_core_get_ctrl_dev(struct serial_port_device *port_dev)
3274 struct device *dev = &port_dev->dev;
3276 return to_serial_base_ctrl_device(dev->parent);
3280 * Find a registered serial core controller device if one exists. Returns
3281 * the first device matching the ctrl_id. Caller must hold port_mutex.
3283 static struct serial_ctrl_device *serial_core_ctrl_find(struct uart_driver *drv,
3284 struct device *phys_dev,
3287 struct uart_state *state;
3290 lockdep_assert_held(&port_mutex);
3292 for (i = 0; i < drv->nr; i++) {
3293 state = drv->state + i;
3294 if (!state->uart_port || !state->uart_port->port_dev)
3297 if (state->uart_port->dev == phys_dev &&
3298 state->uart_port->ctrl_id == ctrl_id)
3299 return serial_core_get_ctrl_dev(state->uart_port->port_dev);
3305 static struct serial_ctrl_device *serial_core_ctrl_device_add(struct uart_port *port)
3307 return serial_base_ctrl_add(port, port->dev);
3310 static int serial_core_port_device_add(struct serial_ctrl_device *ctrl_dev,
3311 struct uart_port *port)
3313 struct serial_port_device *port_dev;
3315 port_dev = serial_base_port_add(port, ctrl_dev);
3316 if (IS_ERR(port_dev))
3317 return PTR_ERR(port_dev);
3319 port->port_dev = port_dev;
3325 * Initialize a serial core port device, and a controller device if needed.
3327 int serial_core_register_port(struct uart_driver *drv, struct uart_port *port)
3329 struct serial_ctrl_device *ctrl_dev, *new_ctrl_dev = NULL;
3332 mutex_lock(&port_mutex);
3335 * Prevent serial_port_runtime_resume() from trying to use the port
3336 * until serial_core_add_one_port() has completed
3338 port->flags |= UPF_DEAD;
3340 /* Inititalize a serial core controller device if needed */
3341 ctrl_dev = serial_core_ctrl_find(drv, port->dev, port->ctrl_id);
3343 new_ctrl_dev = serial_core_ctrl_device_add(port);
3344 if (IS_ERR(new_ctrl_dev)) {
3345 ret = PTR_ERR(new_ctrl_dev);
3348 ctrl_dev = new_ctrl_dev;
3352 * Initialize a serial core port device. Tag the port dead to prevent
3353 * serial_port_runtime_resume() trying to do anything until port has
3354 * been registered. It gets cleared by serial_core_add_one_port().
3356 ret = serial_core_port_device_add(ctrl_dev, port);
3358 goto err_unregister_ctrl_dev;
3360 ret = serial_core_add_one_port(drv, port);
3362 goto err_unregister_port_dev;
3364 port->flags &= ~UPF_DEAD;
3366 mutex_unlock(&port_mutex);
3370 err_unregister_port_dev:
3371 serial_base_port_device_remove(port->port_dev);
3373 err_unregister_ctrl_dev:
3374 serial_base_ctrl_device_remove(new_ctrl_dev);
3377 mutex_unlock(&port_mutex);
3383 * Removes a serial core port device, and the related serial core controller
3384 * device if the last instance.
3386 void serial_core_unregister_port(struct uart_driver *drv, struct uart_port *port)
3388 struct device *phys_dev = port->dev;
3389 struct serial_port_device *port_dev = port->port_dev;
3390 struct serial_ctrl_device *ctrl_dev = serial_core_get_ctrl_dev(port_dev);
3391 int ctrl_id = port->ctrl_id;
3393 mutex_lock(&port_mutex);
3395 port->flags |= UPF_DEAD;
3397 serial_core_remove_one_port(drv, port);
3399 /* Note that struct uart_port *port is no longer valid at this point */
3400 serial_base_port_device_remove(port_dev);
3402 /* Drop the serial core controller device if no ports are using it */
3403 if (!serial_core_ctrl_find(drv, phys_dev, ctrl_id))
3404 serial_base_ctrl_device_remove(ctrl_dev);
3406 mutex_unlock(&port_mutex);
3410 * uart_handle_dcd_change - handle a change of carrier detect state
3411 * @uport: uart_port structure for the open port
3412 * @active: new carrier detect status
3414 * Caller must hold uport->lock.
3416 void uart_handle_dcd_change(struct uart_port *uport, bool active)
3418 struct tty_port *port = &uport->state->port;
3419 struct tty_struct *tty = port->tty;
3420 struct tty_ldisc *ld;
3422 lockdep_assert_held_once(&uport->lock);
3425 ld = tty_ldisc_ref(tty);
3427 if (ld->ops->dcd_change)
3428 ld->ops->dcd_change(tty, active);
3429 tty_ldisc_deref(ld);
3433 uport->icount.dcd++;
3435 if (uart_dcd_enabled(uport)) {
3437 wake_up_interruptible(&port->open_wait);
3442 EXPORT_SYMBOL_GPL(uart_handle_dcd_change);
3445 * uart_handle_cts_change - handle a change of clear-to-send state
3446 * @uport: uart_port structure for the open port
3447 * @active: new clear-to-send status
3449 * Caller must hold uport->lock.
3451 void uart_handle_cts_change(struct uart_port *uport, bool active)
3453 lockdep_assert_held_once(&uport->lock);
3455 uport->icount.cts++;
3457 if (uart_softcts_mode(uport)) {
3458 if (uport->hw_stopped) {
3460 uport->hw_stopped = false;
3461 uport->ops->start_tx(uport);
3462 uart_write_wakeup(uport);
3466 uport->hw_stopped = true;
3467 uport->ops->stop_tx(uport);
3473 EXPORT_SYMBOL_GPL(uart_handle_cts_change);
3476 * uart_insert_char - push a char to the uart layer
3478 * User is responsible to call tty_flip_buffer_push when they are done with
3481 * @port: corresponding port
3482 * @status: state of the serial port RX buffer (LSR for 8250)
3483 * @overrun: mask of overrun bits in @status
3484 * @ch: character to push
3485 * @flag: flag for the character (see TTY_NORMAL and friends)
3487 void uart_insert_char(struct uart_port *port, unsigned int status,
3488 unsigned int overrun, u8 ch, u8 flag)
3490 struct tty_port *tport = &port->state->port;
3492 if ((status & port->ignore_status_mask & ~overrun) == 0)
3493 if (tty_insert_flip_char(tport, ch, flag) == 0)
3494 ++port->icount.buf_overrun;
3497 * Overrun is special. Since it's reported immediately,
3498 * it doesn't affect the current character.
3500 if (status & ~port->ignore_status_mask & overrun)
3501 if (tty_insert_flip_char(tport, 0, TTY_OVERRUN) == 0)
3502 ++port->icount.buf_overrun;
3504 EXPORT_SYMBOL_GPL(uart_insert_char);
3506 #ifdef CONFIG_MAGIC_SYSRQ_SERIAL
3507 static const u8 sysrq_toggle_seq[] = CONFIG_MAGIC_SYSRQ_SERIAL_SEQUENCE;
3509 static void uart_sysrq_on(struct work_struct *w)
3511 int sysrq_toggle_seq_len = strlen(sysrq_toggle_seq);
3513 sysrq_toggle_support(1);
3514 pr_info("SysRq is enabled by magic sequence '%*pE' on serial\n",
3515 sysrq_toggle_seq_len, sysrq_toggle_seq);
3517 static DECLARE_WORK(sysrq_enable_work, uart_sysrq_on);
3520 * uart_try_toggle_sysrq - Enables SysRq from serial line
3521 * @port: uart_port structure where char(s) after BREAK met
3522 * @ch: new character in the sequence after received BREAK
3524 * Enables magic SysRq when the required sequence is met on port
3525 * (see CONFIG_MAGIC_SYSRQ_SERIAL_SEQUENCE).
3527 * Returns: %false if @ch is out of enabling sequence and should be
3528 * handled some other way, %true if @ch was consumed.
3530 bool uart_try_toggle_sysrq(struct uart_port *port, u8 ch)
3532 int sysrq_toggle_seq_len = strlen(sysrq_toggle_seq);
3534 if (!sysrq_toggle_seq_len)
3537 BUILD_BUG_ON(ARRAY_SIZE(sysrq_toggle_seq) >= U8_MAX);
3538 if (sysrq_toggle_seq[port->sysrq_seq] != ch) {
3539 port->sysrq_seq = 0;
3543 if (++port->sysrq_seq < sysrq_toggle_seq_len) {
3544 port->sysrq = jiffies + SYSRQ_TIMEOUT;
3548 schedule_work(&sysrq_enable_work);
3553 EXPORT_SYMBOL_GPL(uart_try_toggle_sysrq);
3557 * uart_get_rs485_mode() - retrieve rs485 properties for given uart
3558 * @port: uart device's target port
3560 * This function implements the device tree binding described in
3561 * Documentation/devicetree/bindings/serial/rs485.txt.
3563 int uart_get_rs485_mode(struct uart_port *port)
3565 struct serial_rs485 *rs485conf = &port->rs485;
3566 struct device *dev = port->dev;
3569 int rx_during_tx_gpio_flag;
3571 ret = device_property_read_u32_array(dev, "rs485-rts-delay",
3574 rs485conf->delay_rts_before_send = rs485_delay[0];
3575 rs485conf->delay_rts_after_send = rs485_delay[1];
3577 rs485conf->delay_rts_before_send = 0;
3578 rs485conf->delay_rts_after_send = 0;
3581 uart_sanitize_serial_rs485_delays(port, rs485conf);
3584 * Clear full-duplex and enabled flags, set RTS polarity to active high
3585 * to get to a defined state with the following properties:
3587 rs485conf->flags &= ~(SER_RS485_RX_DURING_TX | SER_RS485_ENABLED |
3588 SER_RS485_TERMINATE_BUS |
3589 SER_RS485_RTS_AFTER_SEND);
3590 rs485conf->flags |= SER_RS485_RTS_ON_SEND;
3592 if (device_property_read_bool(dev, "rs485-rx-during-tx"))
3593 rs485conf->flags |= SER_RS485_RX_DURING_TX;
3595 if (device_property_read_bool(dev, "linux,rs485-enabled-at-boot-time"))
3596 rs485conf->flags |= SER_RS485_ENABLED;
3598 if (device_property_read_bool(dev, "rs485-rts-active-low")) {
3599 rs485conf->flags &= ~SER_RS485_RTS_ON_SEND;
3600 rs485conf->flags |= SER_RS485_RTS_AFTER_SEND;
3604 * Disabling termination by default is the safe choice: Else if many
3605 * bus participants enable it, no communication is possible at all.
3606 * Works fine for short cables and users may enable for longer cables.
3608 port->rs485_term_gpio = devm_gpiod_get_optional(dev, "rs485-term",
3610 if (IS_ERR(port->rs485_term_gpio)) {
3611 ret = PTR_ERR(port->rs485_term_gpio);
3612 port->rs485_term_gpio = NULL;
3613 return dev_err_probe(dev, ret, "Cannot get rs485-term-gpios\n");
3615 if (port->rs485_term_gpio)
3616 port->rs485_supported.flags |= SER_RS485_TERMINATE_BUS;
3618 rx_during_tx_gpio_flag = (rs485conf->flags & SER_RS485_RX_DURING_TX) ?
3619 GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
3620 port->rs485_rx_during_tx_gpio = devm_gpiod_get_optional(dev,
3621 "rs485-rx-during-tx",
3622 rx_during_tx_gpio_flag);
3623 if (IS_ERR(port->rs485_rx_during_tx_gpio)) {
3624 ret = PTR_ERR(port->rs485_rx_during_tx_gpio);
3625 port->rs485_rx_during_tx_gpio = NULL;
3626 return dev_err_probe(dev, ret, "Cannot get rs485-rx-during-tx-gpios\n");
3631 EXPORT_SYMBOL_GPL(uart_get_rs485_mode);
3633 /* Compile-time assertions for serial_rs485 layout */
3634 static_assert(offsetof(struct serial_rs485, padding) ==
3635 (offsetof(struct serial_rs485, delay_rts_after_send) + sizeof(__u32)));
3636 static_assert(offsetof(struct serial_rs485, padding1) ==
3637 offsetof(struct serial_rs485, padding[1]));
3638 static_assert((offsetof(struct serial_rs485, padding[4]) + sizeof(__u32)) ==
3639 sizeof(struct serial_rs485));
3641 MODULE_DESCRIPTION("Serial driver core");
3642 MODULE_LICENSE("GPL");